feat: rename Custom Type-related methods to include "CustomType" (#2)

prismicio · Mar 17, 2022 · 999b3f7 · 999b3f7
1 parent 38a8ded
commit 999b3f7
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 24 deletions.
diff --git a/src/client.ts b/src/client.ts
@@ -129,6 +129,12 @@ export class CustomTypesClient {
 		}
 	}
 
+	/**
+	 * @deprecated Renamed to `getAllCustomTypes`.
+	 */
+	// TODO: Remove in v1.
+	getAll = this.getAllCustomTypes.bind(this);
+
 	/**
 	 * Returns all Custom Types models from the Prismic repository.
 	 *
@@ -138,12 +144,18 @@ export class CustomTypesClient {
 	 * @returns All Custom Type models from the Prismic repository.
 	 * @throws {@link ForbiddenError} Thrown if the client is unauthorized to make requests.
 	 */
-	async getAll<TCustomType extends prismicT.CustomTypeModel>(
+	async getAllCustomTypes<TCustomType extends prismicT.CustomTypeModel>(
 		params?: CustomTypesClientMethodParams,
 	): Promise<TCustomType[]> {
 		return await this.fetch<TCustomType[]>("", params);
 	}
 
+	/**
+	 * @deprecated Renamed to `getCustomTypeByID`.
+	 */
+	// TODO: Remove in v1.
+	getByID = this.getCustomTypeByID.bind(this);
+
 	/**
 	 * Returns a Custom Type model with a given ID from the Prismic repository.
 	 *
@@ -156,13 +168,19 @@ export class CustomTypesClient {
 	 * @throws {@link NotFoundError} Thrown if a Custom Type with the given ID
 	 *   cannot be found.
 	 */
-	async getByID<TCustomType extends prismicT.CustomTypeModel>(
+	async getCustomTypeByID<TCustomType extends prismicT.CustomTypeModel>(
 		id: string,
 		params?: CustomTypesClientMethodParams,
 	): Promise<TCustomType> {
 		return await this.fetch<TCustomType>(id, params);
 	}
 
+	/**
+	 * @deprecated Renamed to `insertCustomType`.
+	 */
+	// TODO: Remove in v1.
+	insert = this.insertCustomType.bind(this);
+
 	/**
 	 * Inserts a Custom Type model to the Prismic repository.
 	 *
@@ -176,7 +194,7 @@ export class CustomTypesClient {
 	 * @throws {@link ConflictError} Thrown if a Custom Type with the given ID
 	 *   already exists.
 	 */
-	async insert<TCustomType extends prismicT.CustomTypeModel>(
+	async insertCustomType<TCustomType extends prismicT.CustomTypeModel>(
 		customType: TCustomType,
 		params?: CustomTypesClientMethodParams,
 	): Promise<TCustomType> {
@@ -189,6 +207,12 @@ export class CustomTypesClient {
 		return customType;
 	}
 
+	/**
+	 * @deprecated Renamed to `updateCustomType`.
+	 */
+	// TODO: Remove in v1.
+	update = this.updateCustomType.bind(this);
+
 	/**
 	 * Updates a Custom Type model from the Prismic repository.
 	 *
@@ -202,7 +226,7 @@ export class CustomTypesClient {
 	 * @throws {@link NotFoundError} Thrown if a Custom Type with the given ID
 	 *   cannot be found.
 	 */
-	async update<TCustomType extends prismicT.CustomTypeModel>(
+	async updateCustomType<TCustomType extends prismicT.CustomTypeModel>(
 		customType: TCustomType,
 		params?: CustomTypesClientMethodParams,
 	): Promise<TCustomType> {
@@ -215,6 +239,12 @@ export class CustomTypesClient {
 		return customType;
 	}
 
+	/**
+	 * @deprecated Renamed to `removeCustomType`.
+	 */
+	// TODO: Remove in v1.
+	remove = this.removeCustomType.bind(this);
+
 	/**
 	 * Removes a Custom Type model from the Prismic repository.
 	 *
@@ -225,7 +255,7 @@ export class CustomTypesClient {
 	 * @returns The ID of the removed Custom Type.
 	 * @throws {@link ForbiddenError} Thrown if the client is unauthorized to make requests.
 	 */
-	async remove<TCustomTypeID extends string>(
+	async removeCustomType<TCustomTypeID extends string>(
 		id: TCustomTypeID,
 		params?: CustomTypesClientMethodParams,
 	): Promise<TCustomTypeID> {

diff --git a/test/client-getAll.test.ts → test/client-getAllCustomTypes.test.ts b/test/client-getAll.test.ts → test/client-getAllCustomTypes.test.ts
@@ -29,7 +29,7 @@ test("returns all Custom Types", async (t) => {
 		}),
 	);
 
-	const res = await client.getAll();
+	const res = await client.getAllCustomTypes();
 
 	t.deepEqual(res, queryResponse);
 });
@@ -56,7 +56,7 @@ test("uses params if provided", async (t) => {
 		}),
 	);
 
-	const res = await client.getAll(params);
+	const res = await client.getAllCustomTypes(params);
 
 	t.deepEqual(res, queryResponse);
 });
diff --git a/test/client-getByID.test.ts → test/client-getCustomTypeByID.test.ts b/test/client-getByID.test.ts → test/client-getCustomTypeByID.test.ts
@@ -33,7 +33,7 @@ test("returns a Custom Type by ID", async (t) => {
 		),
 	);
 
-	const res = await client.getByID(customType.id);
+	const res = await client.getCustomTypeByID(customType.id);
 
 	t.deepEqual(res, customType);
 });
@@ -63,7 +63,7 @@ test("uses params if provided", async (t) => {
 		),
 	);
 
-	const res = await client.getByID(customType.id, params);
+	const res = await client.getCustomTypeByID(customType.id, params);
 
 	t.deepEqual(res, customType);
 });
@@ -88,7 +88,10 @@ test("throws NotFoundError if a matching Custom Type was not found", async (t) =
 		),
 	);
 
-	await t.throwsAsync(async () => await client.getByID(customType.id), {
-		instanceOf: prismicCustomTypes.NotFoundError,
-	});
+	await t.throwsAsync(
+		async () => await client.getCustomTypeByID(customType.id),
+		{
+			instanceOf: prismicCustomTypes.NotFoundError,
+		},
+	);
 });
diff --git a/test/client-insert.test.ts → test/client-insertCustomType.test.ts b/test/client-insert.test.ts → test/client-insertCustomType.test.ts
@@ -33,7 +33,7 @@ test("inserts a Custom Type", async (t) => {
 		}),
 	);
 
-	const res = await client.insert(customType);
+	const res = await client.insertCustomType(customType);
 
 	t.deepEqual(res, customType);
 });
@@ -62,7 +62,7 @@ test("uses params if provided", async (t) => {
 		}),
 	);
 
-	const res = await client.insert(customType, params);
+	const res = await client.insertCustomType(customType, params);
 
 	t.deepEqual(res, customType);
 });
@@ -86,7 +86,7 @@ test("throws ConflictError if a Custom Type with the same ID already exists", as
 		}),
 	);
 
-	await t.throwsAsync(async () => await client.insert(customType), {
+	await t.throwsAsync(async () => await client.insertCustomType(customType), {
 		instanceOf: prismicCustomTypes.ConflictError,
 	});
 });
@@ -111,7 +111,7 @@ test("throws InvalidPayloadError if an invalid Custom Type is sent", async (t) =
 		}),
 	);
 
-	await t.throwsAsync(async () => await client.insert(customType), {
+	await t.throwsAsync(async () => await client.insertCustomType(customType), {
 		instanceOf: prismicCustomTypes.InvalidPayloadError,
 		message,
 	});

diff --git a/test/client-remove.test.ts → test/client-removeCustomType.test.ts b/test/client-remove.test.ts → test/client-removeCustomType.test.ts
@@ -33,7 +33,7 @@ test("removes a Custom Type", async (t) => {
 		),
 	);
 
-	const res = await client.remove(customType.id);
+	const res = await client.removeCustomType(customType.id);
 
 	t.deepEqual(res, customType.id);
 });
@@ -63,7 +63,7 @@ test("uses params if provided", async (t) => {
 		),
 	);
 
-	const res = await client.remove(customType.id, params);
+	const res = await client.removeCustomType(customType.id, params);
 
 	t.deepEqual(res, customType.id);
 });

diff --git a/test/client-update.test.ts → test/client-updateCustomType.test.ts b/test/client-update.test.ts → test/client-updateCustomType.test.ts
@@ -33,7 +33,7 @@ test("updates a Custom Type", async (t) => {
 		}),
 	);
 
-	const res = await client.update(customType);
+	const res = await client.updateCustomType(customType);
 
 	t.deepEqual(res, customType);
 });
@@ -62,7 +62,7 @@ test("uses params if provided", async (t) => {
 		}),
 	);
 
-	const res = await client.update(customType, params);
+	const res = await client.updateCustomType(customType, params);
 
 	t.deepEqual(res, customType);
 });
@@ -86,7 +86,7 @@ test("throws NotFoundError if a matching Custom Type was not found", async (t) =
 		}),
 	);
 
-	await t.throwsAsync(async () => await client.update(customType), {
+	await t.throwsAsync(async () => await client.updateCustomType(customType), {
 		instanceOf: prismicCustomTypes.NotFoundError,
 	});
 });
@@ -111,7 +111,7 @@ test("throws InvalidPayloadError if an invalid Custom Type is sent", async (t) =
 		}),
 	);
 
-	await t.throwsAsync(async () => await client.update(customType), {
+	await t.throwsAsync(async () => await client.updateCustomType(customType), {
 		instanceOf: prismicCustomTypes.InvalidPayloadError,
 		message,
 	});

diff --git a/test/client.test.ts b/test/client.test.ts
@@ -92,7 +92,7 @@ test("throws ForbiddenError if unauthorized", async (t) => {
 		}),
 	);
 
-	await t.throwsAsync(async () => await client.getAll(), {
+	await t.throwsAsync(async () => await client.getAllCustomTypes(), {
 		instanceOf: prismicCustomTypes.ForbiddenError,
 	});
 });
@@ -108,7 +108,7 @@ test("throws PrismicError if an unsupported response is returned", async (t) =>
 		}),
 	);
 
-	await t.throwsAsync(async () => await client.getAll(), {
+	await t.throwsAsync(async () => await client.getAllCustomTypes(), {
 		instanceOf: prismicCustomTypes.PrismicError,
 	});
 });