From e37d4133784d8b8cfe94762c1ff92c180a6ca802 Mon Sep 17 00:00:00 2001
From: Wade Baglin <wade.baglin@makerx.com.au>
Date: Thu, 11 Aug 2022 10:06:03 +1000
Subject: [PATCH] chore: refactor proxy builder name

BREAKING CHANGE: roll the next major to cause a clean cutover
---
 README.md                              | 4 ++--
 src/data-builder.ts                    | 8 ++++----
 src/index.ts                           | 2 +-
 test/builder/mongoose-model-builder.ts | 4 ++--
 test/builder/shape-builder.ts          | 4 ++--
 website-generator.json                 | 2 +-
 6 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index eb4cb69..4a57c5a 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@ Then define a builder for that model
 
 ```ts
 import { randomElement, randomNumberBetween, randomString } from '@makerx/ts-dossier'
-import { DataBuilder, proxyBuilder } from '@makerx/ts-dossier'
+import { DataBuilder, dossierProxy } from '@makerx/ts-dossier'
 import { Shape } from './shape'
 
 class ShapeBuilder extends DataBuilder<Shape> {
@@ -49,7 +49,7 @@ class ShapeBuilder extends DataBuilder<Shape> {
   }
 }
 
-export const shapeBuilder = proxyBuilder<ShapeBuilder, Shape>(ShapeBuilder)
+export const shapeBuilder = dossierProxy<ShapeBuilder, Shape>(ShapeBuilder)
 ```
 
 Then define a mother to build known models for testing
diff --git a/src/data-builder.ts b/src/data-builder.ts
index 048f133..805ce02 100644
--- a/src/data-builder.ts
+++ b/src/data-builder.ts
@@ -1,7 +1,7 @@
 import { deepClone } from './deep-clone'
 
 /**
- * Data builder is an abstract class builders can inherit to make working with the {@linkplain proxyBuilder} easier.
+ * Data builder is an abstract class builders can inherit to make working with the {@linkplain dossierProxy} easier.
  *
  * ```typescript
  * export class ShapeBuilder extends DataBuilder<Shape> {
@@ -18,7 +18,7 @@ import { deepClone } from './deep-clone'
  *   }
  * }
  *
- * export const shapeBuilder = proxyBuilder<ShapeBuilder, Shape>(ShapeBuilder)
+ * export const shapeBuilder = dossierProxy<ShapeBuilder, Shape>(ShapeBuilder)
  * ```
  */
 export abstract class DataBuilder<T> {
@@ -89,7 +89,7 @@ type DynamicDataBuilder<TDataBuilder, TData extends object> = TDataBuilder & Wit
  *   }
  * }
  *
- * const shapeBuilder = proxyBuilder<ShapeBuilder, Shape>(ShapeBuilder)
+ * const shapeBuilder = dossierProxy<ShapeBuilder, Shape>(ShapeBuilder)
  *
  * const shape = shapeBuilder().withName('Square').withSides(4).withColour('Red').build()
  *
@@ -97,7 +97,7 @@ type DynamicDataBuilder<TDataBuilder, TData extends object> = TDataBuilder & Wit
  * ```
  * @param builder The constructor to call to create a new instance of the builder.
  */
-export function proxyBuilder<TDataBuilder, TData extends object>(builder: {
+export function dossierProxy<TDataBuilder, TData extends object>(builder: {
   new (): TDataBuilder
 }): () => DynamicDataBuilder<TDataBuilder, TData> {
   // eslint-disable-next-line @typescript-eslint/no-unsafe-return
diff --git a/src/index.ts b/src/index.ts
index 2ee3eb9..b25a55b 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,4 +1,4 @@
-export { DataBuilder, proxyBuilder } from './data-builder'
+export { DataBuilder, dossierProxy } from './data-builder'
 export {
   randomDate,
   randomDateBetween,
diff --git a/test/builder/mongoose-model-builder.ts b/test/builder/mongoose-model-builder.ts
index 884bd20..daffc75 100644
--- a/test/builder/mongoose-model-builder.ts
+++ b/test/builder/mongoose-model-builder.ts
@@ -1,4 +1,4 @@
-import { DataBuilder, proxyBuilder, randomString } from '../../src'
+import { DataBuilder, dossierProxy, randomString } from '../../src'
 import { MongooseModel } from '../model/mongoose-model'
 import { Types } from 'mongoose'
 
@@ -15,4 +15,4 @@ export class MongooseModelBuilder extends DataBuilder<MongooseModel> {
   }
 }
 
-export const mongooseModelBuilder = proxyBuilder<MongooseModelBuilder, MongooseModel>(MongooseModelBuilder)
+export const mongooseModelBuilder = dossierProxy<MongooseModelBuilder, MongooseModel>(MongooseModelBuilder)
diff --git a/test/builder/shape-builder.ts b/test/builder/shape-builder.ts
index 2ddd4d0..8bd1963 100644
--- a/test/builder/shape-builder.ts
+++ b/test/builder/shape-builder.ts
@@ -1,4 +1,4 @@
-import { DataBuilder, proxyBuilder, randomElement, randomNumberBetween, randomString } from '../../src'
+import { DataBuilder, dossierProxy, randomElement, randomNumberBetween, randomString } from '../../src'
 import { Shape } from '../model/shape'
 
 export class ShapeBuilder extends DataBuilder<Shape> {
@@ -15,4 +15,4 @@ export class ShapeBuilder extends DataBuilder<Shape> {
   }
 }
 
-export const shapeBuilder = proxyBuilder<ShapeBuilder, Shape>(ShapeBuilder)
+export const shapeBuilder = dossierProxy<ShapeBuilder, Shape>(ShapeBuilder)
diff --git a/website-generator.json b/website-generator.json
index aa355ce..7488221 100644
--- a/website-generator.json
+++ b/website-generator.json
@@ -8,7 +8,7 @@
   "name": null,
   "description": null,
   "gitHubUrl": null,
-  "soeTags": ["MakerX", "Dossier", "TypeScript", "TS", "Object-Mother", "Data-Builder"],
+  "soeTags": null,
   "miscellaneousPages": null,
   "codeDocs": {
     "path": "/code-docs"