@labdigital/commercetools-mock 2.66.0 → 3.0.0-beta.0

package/src/repositories/subscription.test.ts

@@ -12,7 +12,7 @@ describe("Subscription Repository", () => {
 	const config: Config = { storage, strict: false };
 	const repository = new SubscriptionRepository(config);
 
-	test("create subscription with SQS destination", () => {
+	test("create subscription with SQS destination", async () => {
 		const draft: SubscriptionDraft = {
 			key: "test-subscription",
 			destination: {
@@ -30,7 +30,7 @@ describe("Subscription Repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const result = repository.create(ctx, draft);
+		const result = await repository.create(ctx, draft);
 
 		expect(result.id).toBeDefined();
 		expect(result.version).toBe(1);
@@ -43,12 +43,12 @@ describe("Subscription Repository", () => {
 		expect(result.events).toEqual([]);
 
 		// Test that the subscription is stored
-		const items = repository.query(ctx);
+		const items = await repository.query(ctx);
 		expect(items.count).toBe(1);
 		expect(items.results[0].id).toBe(result.id);
 	});
 
-	test("create subscription with Google Cloud Pub/Sub destination", () => {
+	test("create subscription with Google Cloud Pub/Sub destination", async () => {
 		const draft: SubscriptionDraft = {
 			key: "pubsub-subscription",
 			destination: {
@@ -69,7 +69,7 @@ describe("Subscription Repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const result = repository.create(ctx, draft);
+		const result = await repository.create(ctx, draft);
 
 		expect(result.id).toBeDefined();
 		expect(result.key).toBe(draft.key);
@@ -79,7 +79,7 @@ describe("Subscription Repository", () => {
 		expect(result.status).toBe("Healthy");
 	});
 
-	test("create subscription with Azure Event Grid destination", () => {
+	test("create subscription with Azure Event Grid destination", async () => {
 		const draft: SubscriptionDraft = {
 			key: "azure-subscription",
 			destination: {
@@ -96,7 +96,7 @@ describe("Subscription Repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const result = repository.create(ctx, draft);
+		const result = await repository.create(ctx, draft);
 
 		expect(result.id).toBeDefined();
 		expect(result.key).toBe(draft.key);
@@ -105,7 +105,7 @@ describe("Subscription Repository", () => {
 		expect(result.status).toBe("Healthy");
 	});
 
-	test("create subscription with Azure Service Bus destination", () => {
+	test("create subscription with Azure Service Bus destination", async () => {
 		const draft: SubscriptionDraft = {
 			key: "servicebus-subscription",
 			destination: {
@@ -116,7 +116,7 @@ describe("Subscription Repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const result = repository.create(ctx, draft);
+		const result = await repository.create(ctx, draft);
 
 		expect(result.id).toBeDefined();
 		expect(result.key).toBe(draft.key);
@@ -124,7 +124,7 @@ describe("Subscription Repository", () => {
 		expect(result.status).toBe("Healthy");
 	});
 
-	test("create subscription fails with invalid SQS account ID", () => {
+	test("create subscription fails with invalid SQS account ID", async () => {
 		const draft: SubscriptionDraft = {
 			key: "invalid-subscription",
 			destination: {
@@ -138,12 +138,12 @@ describe("Subscription Repository", () => {
 
 		const ctx = { projectKey: "dummy" };
 
-		expect(() => {
-			repository.create(ctx, draft);
-		}).toThrow("A test message could not be delivered to this destination");
+		await expect(repository.create(ctx, draft)).rejects.toThrow(
+			"A test message could not be delivered to this destination",
+		);
 	});
 
-	test("update subscription - setKey", () => {
+	test("update subscription - setKey", async () => {
 		const draft: SubscriptionDraft = {
 			key: "test-subscription-update",
 			destination: {
@@ -154,9 +154,9 @@ describe("Subscription Repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const subscription = repository.create(ctx, draft);
+		const subscription = await repository.create(ctx, draft);
 
-		const result = repository.processUpdateActions(
+		const result = await repository.processUpdateActions(
 			ctx,
 			subscription,
 			subscription.version,
@@ -172,7 +172,7 @@ describe("Subscription Repository", () => {
 		expect(result.version).toBe(subscription.version + 1);
 	});
 
-	test("get and delete subscription", () => {
+	test("get and delete subscription", async () => {
 		const draft: SubscriptionDraft = {
 			key: "delete-test",
 			destination: {
@@ -183,25 +183,25 @@ describe("Subscription Repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const subscription = repository.create(ctx, draft);
+		const subscription = await repository.create(ctx, draft);
 
 		// Test get
-		const retrieved = repository.get(ctx, subscription.id);
+		const retrieved = await repository.get(ctx, subscription.id);
 		expect(retrieved).toBeDefined();
 		expect(retrieved?.id).toBe(subscription.id);
 
 		// Test getByKey
-		const retrievedByKey = repository.getByKey(ctx, subscription.key!);
+		const retrievedByKey = await repository.getByKey(ctx, subscription.key!);
 		expect(retrievedByKey).toBeDefined();
 		expect(retrievedByKey?.key).toBe(subscription.key);
 
 		// Test delete
-		const deleted = repository.delete(ctx, subscription.id);
+		const deleted = await repository.delete(ctx, subscription.id);
 		expect(deleted).toBeDefined();
 		expect(deleted?.id).toBe(subscription.id);
 
 		// Verify it's deleted
-		const notFound = repository.get(ctx, subscription.id);
+		const notFound = await repository.get(ctx, subscription.id);
 		expect(notFound).toBeNull();
 	});
 });

package/src/repositories/subscription.ts

@@ -7,6 +7,7 @@ import type {
 } from "@commercetools/platform-sdk";
 import type { Config } from "#src/config.ts";
 import { CommercetoolsError } from "#src/exceptions.ts";
+import { SubscriptionDraftSchema } from "#src/schemas/generated/subscription.ts";
 import { getBaseResourceProperties } from "../helpers.ts";
 import type { Writable } from "../types.ts";
 import type { RepositoryContext, UpdateHandlerInterface } from "./abstract.ts";
@@ -19,9 +20,13 @@ export class SubscriptionRepository extends AbstractResourceRepository<"subscrip
 	constructor(config: Config) {
 		super("subscription", config);
 		this.actions = new SubscriptionUpdateHandler(config.storage);
+		this.draftSchema = SubscriptionDraftSchema;
 	}
 
-	create(context: RepositoryContext, draft: SubscriptionDraft): Subscription {
+	async create(
+		context: RepositoryContext,
+		draft: SubscriptionDraft,
+	): Promise<Subscription> {
 		// TODO: We could actually test this here by using the aws sdk. For now
 		// hardcode a failed check when account id is 0000000000
 		if (draft.destination.type === "SQS") {
@@ -40,7 +45,7 @@ export class SubscriptionRepository extends AbstractResourceRepository<"subscrip
 		}
 
 		const resource: Subscription = {
-			...getBaseResourceProperties(),
+			...getBaseResourceProperties(context.clientId),
 			changes: draft.changes || [],
 			destination: draft.destination,
 			format: draft.format || {
@@ -51,7 +56,7 @@ export class SubscriptionRepository extends AbstractResourceRepository<"subscrip
 			status: "Healthy",
 			events: draft.events || [],
 		};
-		return this.saveNew(context, resource);
+		return await this.saveNew(context, resource);
 	}
 }
 

package/src/repositories/tax-category/index.ts

@@ -4,6 +4,7 @@ import type {
 } from "@commercetools/platform-sdk";
 import type { Config } from "#src/config.ts";
 import { getBaseResourceProperties } from "#src/helpers.ts";
+import { TaxCategoryDraftSchema } from "#src/schemas/generated/tax-category.ts";
 import type { RepositoryContext } from "../abstract.ts";
 import { AbstractResourceRepository } from "../abstract.ts";
 import { TaxCategoryUpdateHandler } from "./actions.ts";
@@ -13,14 +14,18 @@ export class TaxCategoryRepository extends AbstractResourceRepository<"tax-categ
 	constructor(config: Config) {
 		super("tax-category", config);
 		this.actions = new TaxCategoryUpdateHandler(this._storage);
+		this.draftSchema = TaxCategoryDraftSchema;
 	}
 
-	create(context: RepositoryContext, draft: TaxCategoryDraft): TaxCategory {
+	async create(
+		context: RepositoryContext,
+		draft: TaxCategoryDraft,
+	): Promise<TaxCategory> {
 		const resource: TaxCategory = {
-			...getBaseResourceProperties(),
+			...getBaseResourceProperties(context.clientId),
 			...draft,
 			rates: draft.rates?.map(taxRateFromTaxRateDraft) || [],
 		};
-		return this.saveNew(context, resource);
+		return await this.saveNew(context, resource);
 	}
 }

package/src/repositories/type/actions.ts

@@ -47,7 +47,13 @@ export class TypeUpdateHandler
 				) {
 					field.type.elementType.values.push(value);
 				} else {
-					throw new Error("Type is not a Enum (or Set of Enum)");
+					throw new CommercetoolsError<InvalidOperationError>(
+						{
+							code: "InvalidOperation",
+							message: "Type is not a Enum (or Set of Enum)",
+						},
+						400,
+					);
 				}
 			}
 		});
@@ -85,7 +91,13 @@ export class TypeUpdateHandler
 						}
 					});
 				} else {
-					throw new Error("Type is not a Enum (or Set of Enum)");
+					throw new CommercetoolsError<InvalidOperationError>(
+						{
+							code: "InvalidOperation",
+							message: "Type is not a Enum (or Set of Enum)",
+						},
+						400,
+					);
 				}
 			}
 		});
@@ -105,7 +117,13 @@ export class TypeUpdateHandler
 		fieldNames.forEach((fieldName) => {
 			const field = fields.get(fieldName);
 			if (field === undefined) {
-				throw new Error("New field");
+				throw new CommercetoolsError<InvalidOperationError>(
+					{
+						code: "InvalidOperation",
+						message: "Adding new field definitions is not fully supported yet",
+					},
+					400,
+				);
 			}
 			result.push(field);
 

package/src/repositories/type/index.ts

@@ -1,6 +1,7 @@
 import type { Type, TypeDraft } from "@commercetools/platform-sdk";
 import type { Config } from "#src/config.ts";
 import { getBaseResourceProperties } from "#src/helpers.ts";
+import { TypeDraftSchema } from "#src/schemas/generated/type.ts";
 import type { RepositoryContext } from "../abstract.ts";
 import { AbstractResourceRepository } from "../abstract.ts";
 import { TypeUpdateHandler } from "./actions.ts";
@@ -9,17 +10,18 @@ export class TypeRepository extends AbstractResourceRepository<"type"> {
 	constructor(config: Config) {
 		super("type", config);
 		this.actions = new TypeUpdateHandler(config.storage);
+		this.draftSchema = TypeDraftSchema;
 	}
 
-	create(context: RepositoryContext, draft: TypeDraft): Type {
+	async create(context: RepositoryContext, draft: TypeDraft): Promise<Type> {
 		const resource: Type = {
-			...getBaseResourceProperties(),
+			...getBaseResourceProperties(context.clientId),
 			key: draft.key,
 			name: draft.name,
 			resourceTypeIds: draft.resourceTypeIds,
 			fieldDefinitions: draft.fieldDefinitions || [],
 			description: draft.description,
 		};
-		return this.saveNew(context, resource);
+		return await this.saveNew(context, resource);
 	}
 }

package/src/repositories/zone.test.ts

@@ -16,7 +16,7 @@ describe("Zone Repository", () => {
 	const config: Config = { storage, strict: false };
 	const repository = new ZoneRepository(config);
 
-	test("create zone", () => {
+	test("create zone", async () => {
 		const draft: ZoneDraft = {
 			key: "europe-zone",
 			name: "Europe Zone",
@@ -32,7 +32,7 @@ describe("Zone Repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const result = repository.create(ctx, draft);
+		const result = await repository.create(ctx, draft);
 
 		expect(result.id).toBeDefined();
 		expect(result.version).toBe(1);
@@ -42,18 +42,18 @@ describe("Zone Repository", () => {
 		expect(result.locations).toEqual(draft.locations);
 
 		// Test that the zone is stored
-		const items = repository.query(ctx);
+		const items = await repository.query(ctx);
 		expect(items.count).toBe(1);
 		expect(items.results[0].id).toBe(result.id);
 	});
 
-	test("create zone without optional fields", () => {
+	test("create zone without optional fields", async () => {
 		const draft: ZoneDraft = {
 			name: "Simple Zone",
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const result = repository.create(ctx, draft);
+		const result = await repository.create(ctx, draft);
 
 		expect(result.id).toBeDefined();
 		expect(result.name).toBe(draft.name);
@@ -62,67 +62,82 @@ describe("Zone Repository", () => {
 		expect(result.locations).toEqual([]);
 	});
 
-	test("update zone - changeName", () => {
+	test("update zone - changeName", async () => {
 		const draft: ZoneDraft = {
 			key: "test-zone",
 			name: "Test Zone",
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const zone = repository.create(ctx, draft);
+		const zone = await repository.create(ctx, draft);
 
-		const result = repository.processUpdateActions(ctx, zone, zone.version, [
-			{
-				action: "changeName",
-				name: "Updated Test Zone",
-			} as ZoneChangeNameAction,
-		]);
+		const result = await repository.processUpdateActions(
+			ctx,
+			zone,
+			zone.version,
+			[
+				{
+					action: "changeName",
+					name: "Updated Test Zone",
+				} as ZoneChangeNameAction,
+			],
+		);
 
 		expect(result.name).toBe("Updated Test Zone");
 		expect(result.version).toBe(zone.version + 1);
 	});
 
-	test("update zone - setKey", () => {
+	test("update zone - setKey", async () => {
 		const draft: ZoneDraft = {
 			key: "test-zone-2",
 			name: "Test Zone 2",
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const zone = repository.create(ctx, draft);
+		const zone = await repository.create(ctx, draft);
 
-		const result = repository.processUpdateActions(ctx, zone, zone.version, [
-			{
-				action: "setKey",
-				key: "new-zone-key",
-			} as ZoneSetKeyAction,
-		]);
+		const result = await repository.processUpdateActions(
+			ctx,
+			zone,
+			zone.version,
+			[
+				{
+					action: "setKey",
+					key: "new-zone-key",
+				} as ZoneSetKeyAction,
+			],
+		);
 
 		expect(result.key).toBe("new-zone-key");
 		expect(result.version).toBe(zone.version + 1);
 	});
 
-	test("update zone - setDescription", () => {
+	test("update zone - setDescription", async () => {
 		const draft: ZoneDraft = {
 			key: "test-zone-3",
 			name: "Test Zone 3",
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const zone = repository.create(ctx, draft);
+		const zone = await repository.create(ctx, draft);
 
-		const result = repository.processUpdateActions(ctx, zone, zone.version, [
-			{
-				action: "setDescription",
-				description: "New zone description",
-			} as ZoneSetDescriptionAction,
-		]);
+		const result = await repository.processUpdateActions(
+			ctx,
+			zone,
+			zone.version,
+			[
+				{
+					action: "setDescription",
+					description: "New zone description",
+				} as ZoneSetDescriptionAction,
+			],
+		);
 
 		expect(result.description).toBe("New zone description");
 		expect(result.version).toBe(zone.version + 1);
 	});
 
-	test("update zone - addLocation", () => {
+	test("update zone - addLocation", async () => {
 		const draft: ZoneDraft = {
 			key: "test-zone-4",
 			name: "Test Zone 4",
@@ -134,16 +149,21 @@ describe("Zone Repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const zone = repository.create(ctx, draft);
+		const zone = await repository.create(ctx, draft);
 
-		const result = repository.processUpdateActions(ctx, zone, zone.version, [
-			{
-				action: "addLocation",
-				location: {
-					country: "FR",
-				},
-			} as ZoneAddLocationAction,
-		]);
+		const result = await repository.processUpdateActions(
+			ctx,
+			zone,
+			zone.version,
+			[
+				{
+					action: "addLocation",
+					location: {
+						country: "FR",
+					},
+				} as ZoneAddLocationAction,
+			],
+		);
 
 		expect(result.locations).toHaveLength(2);
 		expect(result.locations).toContainEqual({ country: "DE" });
@@ -151,7 +171,7 @@ describe("Zone Repository", () => {
 		expect(result.version).toBe(zone.version + 1);
 	});
 
-	test("update zone - addLocation with state", () => {
+	test("update zone - addLocation with state", async () => {
 		const draft: ZoneDraft = {
 			key: "test-zone-5",
 			name: "Test Zone 5",
@@ -159,24 +179,29 @@ describe("Zone Repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const zone = repository.create(ctx, draft);
+		const zone = await repository.create(ctx, draft);
 
-		const result = repository.processUpdateActions(ctx, zone, zone.version, [
-			{
-				action: "addLocation",
-				location: {
-					country: "US",
-					state: "CA",
-				},
-			} as ZoneAddLocationAction,
-		]);
+		const result = await repository.processUpdateActions(
+			ctx,
+			zone,
+			zone.version,
+			[
+				{
+					action: "addLocation",
+					location: {
+						country: "US",
+						state: "CA",
+					},
+				} as ZoneAddLocationAction,
+			],
+		);
 
 		expect(result.locations).toHaveLength(1);
 		expect(result.locations[0]).toEqual({ country: "US", state: "CA" });
 		expect(result.version).toBe(zone.version + 1);
 	});
 
-	test("update zone - removeLocation", () => {
+	test("update zone - removeLocation", async () => {
 		const draft: ZoneDraft = {
 			key: "test-zone-6",
 			name: "Test Zone 6",
@@ -195,16 +220,21 @@ describe("Zone Repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const zone = repository.create(ctx, draft);
+		const zone = await repository.create(ctx, draft);
 
-		const result = repository.processUpdateActions(ctx, zone, zone.version, [
-			{
-				action: "removeLocation",
-				location: {
-					country: "FR",
-				},
-			} as ZoneRemoveLocationAction,
-		]);
+		const result = await repository.processUpdateActions(
+			ctx,
+			zone,
+			zone.version,
+			[
+				{
+					action: "removeLocation",
+					location: {
+						country: "FR",
+					},
+				} as ZoneRemoveLocationAction,
+			],
+		);
 
 		expect(result.locations).toHaveLength(2);
 		expect(result.locations).toContainEqual({ country: "DE" });
@@ -213,7 +243,7 @@ describe("Zone Repository", () => {
 		expect(result.version).toBe(zone.version + 1);
 	});
 
-	test("update zone - removeLocation with state", () => {
+	test("update zone - removeLocation with state", async () => {
 		const draft: ZoneDraft = {
 			key: "test-zone-7",
 			name: "Test Zone 7",
@@ -230,49 +260,54 @@ describe("Zone Repository", () => {
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const zone = repository.create(ctx, draft);
+		const zone = await repository.create(ctx, draft);
 
-		const result = repository.processUpdateActions(ctx, zone, zone.version, [
-			{
-				action: "removeLocation",
-				location: {
-					country: "US",
-					state: "CA",
-				},
-			} as ZoneRemoveLocationAction,
-		]);
+		const result = await repository.processUpdateActions(
+			ctx,
+			zone,
+			zone.version,
+			[
+				{
+					action: "removeLocation",
+					location: {
+						country: "US",
+						state: "CA",
+					},
+				} as ZoneRemoveLocationAction,
+			],
+		);
 
 		expect(result.locations).toHaveLength(1);
 		expect(result.locations[0]).toEqual({ country: "US", state: "NY" });
 		expect(result.version).toBe(zone.version + 1);
 	});
 
-	test("get and delete zone", () => {
+	test("get and delete zone", async () => {
 		const draft: ZoneDraft = {
 			key: "delete-test",
 			name: "Delete Test Zone",
 		};
 
 		const ctx = { projectKey: "dummy" };
-		const zone = repository.create(ctx, draft);
+		const zone = await repository.create(ctx, draft);
 
 		// Test get
-		const retrieved = repository.get(ctx, zone.id);
+		const retrieved = await repository.get(ctx, zone.id);
 		expect(retrieved).toBeDefined();
 		expect(retrieved?.id).toBe(zone.id);
 
 		// Test getByKey
-		const retrievedByKey = repository.getByKey(ctx, zone.key!);
+		const retrievedByKey = await repository.getByKey(ctx, zone.key!);
 		expect(retrievedByKey).toBeDefined();
 		expect(retrievedByKey?.key).toBe(zone.key);
 
 		// Test delete
-		const deleted = repository.delete(ctx, zone.id);
+		const deleted = await repository.delete(ctx, zone.id);
 		expect(deleted).toBeDefined();
 		expect(deleted?.id).toBe(zone.id);
 
 		// Verify it's deleted
-		const notFound = repository.get(ctx, zone.id);
+		const notFound = await repository.get(ctx, zone.id);
 		expect(notFound).toBeNull();
 	});
 });

package/src/repositories/zone.ts

@@ -9,6 +9,7 @@ import type {
 	ZoneUpdateAction,
 } from "@commercetools/platform-sdk";
 import type { Config } from "#src/config.ts";
+import { ZoneDraftSchema } from "#src/schemas/generated/zone.ts";
 import { getBaseResourceProperties } from "../helpers.ts";
 import type { Writable } from "../types.ts";
 import type { RepositoryContext, UpdateHandlerInterface } from "./abstract.ts";
@@ -21,17 +22,18 @@ export class ZoneRepository extends AbstractResourceRepository<"zone"> {
 	constructor(config: Config) {
 		super("zone", config);
 		this.actions = new ZoneUpdateHandler(config.storage);
+		this.draftSchema = ZoneDraftSchema;
 	}
 
-	create(context: RepositoryContext, draft: ZoneDraft): Zone {
+	async create(context: RepositoryContext, draft: ZoneDraft): Promise<Zone> {
 		const resource: Zone = {
-			...getBaseResourceProperties(),
+			...getBaseResourceProperties(context.clientId),
 			key: draft.key,
 			locations: draft.locations || [],
 			name: draft.name,
 			description: draft.description,
 		};
-		return this.saveNew(context, resource);
+		return await this.saveNew(context, resource);
 	}
 }
 

package/src/schemas/generated/associate-role.ts

@@ -0,0 +1,13 @@
+// This file is auto-generated by scripts/generate-schemas.ts
+// Do not edit manually.
+
+import { z } from "zod";
+import { CustomFieldsDraftSchema, PermissionSchema } from "./common.ts";
+
+export const AssociateRoleDraftSchema = z.object({
+	key: z.string(),
+	name: z.string().optional(),
+	buyerAssignable: z.boolean().optional(),
+	permissions: z.array(PermissionSchema).optional(),
+	custom: CustomFieldsDraftSchema.optional(),
+});