@compassdigital/sdk.typescript 4.117.0 → 4.118.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.117.0",
+	"version": "4.118.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",
@@ -49,7 +49,7 @@
 	},
 	"devDependencies": {
 		"@compassdigital/review": "^7.3.0",
-		"@compassdigital/sdk.typescript.cli": "^4.39.0",
+		"@compassdigital/sdk.typescript.cli": "^4.40.1",
 		"@swc/core": "^1.4.1",
 		"@swc/jest": "^0.2.36",
 		"@types/jest": "^29.2.4",

package/src/base.ts

@@ -325,26 +325,33 @@ export abstract class BaseServiceClient {
 	}
 
 	/**
-	 * Combine the path and query parameters into a full url.
+	 * Determine the base url to use.
 	 */
-	private build_url(
-		path: string,
-		service: string,
-		{ base_url, stage }: RequestOptions,
-		params: any,
-	): string {
-		if (!stage) {
-			throw new Error('stage not specified');
-		}
-		let url =
-			stage === 'v1'
-				? `https://api.compassdigital.org${path}`
-				: `https://${stage}.api.compassdigital.org${path}`;
+	private base_url(service: string, { base_url, stage }: RequestOptions): string {
 		// use the base url if one was provided.
-		if (base_url) {
-			if (typeof base_url === 'object' && base_url[service]) base_url = base_url[service];
-			if (typeof base_url === 'string') url = `${this.clean_url(base_url)}${path}`;
+		if (typeof base_url === 'string') {
+			return this.clean_url(base_url);
+		}
+		if (typeof base_url === 'object' && base_url[service]) {
+			return this.clean_url(base_url[service]);
 		}
+		switch (stage) {
+			case 'dev':
+			case 'staging':
+				return `https://${stage}.api.compassdigital.org`;
+			case 'v1':
+			case 'prod':
+				return `https://api.compassdigital.org`;
+			default:
+				throw new Error(`ServiceClient was not provided a valid stage: '${stage}'`);
+		}
+	}
+
+	/**
+	 * Combine the path and query parameters into a full url.
+	 */
+	private build_url(path: string, service: string, options: RequestOptions, params: any): string {
+		let url = this.base_url(service, options) + path;
 		// add query parameters.
 		const query: string[] = [];
 		for (const [name, values] of Object.entries(params)) {

package/src/index.ts

@@ -931,8 +931,6 @@ import {
 	PostMenuV4BrandCategoryDuplicateResponse,
 	PostMenuV4BrandMenuDuplicateBody,
 	PostMenuV4BrandMenuDuplicateResponse,
-	PostMenuV4CategoryAttachmentQuery,
-	PostMenuV4CategoryAttachmentResponse,
 	PostMenuV4ItemAttachmentQuery,
 	PostMenuV4ItemAttachmentResponse,
 	PostMenuV4ItemBody,
@@ -948,6 +946,8 @@ import {
 	PatchMenuV4ItemsBulkUpdateResponse,
 	PostMenuV4ItemDuplicateBody,
 	PostMenuV4ItemDuplicateResponse,
+	DeleteMenuV4ItemModifierGroupsDetachBody,
+	DeleteMenuV4ItemModifierGroupsDetachResponse,
 	PostMenuV4ModifierBody,
 	PostMenuV4ModifierResponse,
 	GetMenuV4ModifierQuery,
@@ -973,6 +973,8 @@ import {
 	PostMenuV4ModifierGroupDuplicateQuery,
 	PostMenuV4ModifierGroupDuplicateBody,
 	PostMenuV4ModifierGroupDuplicateResponse,
+	DeleteMenuV4ModifierGroupModifiersDetachBody,
+	DeleteMenuV4ModifierGroupModifiersDetachResponse,
 	PatchMenuV4StockBusinessUnitBody,
 	PatchMenuV4StockBusinessUnitResponse,
 	PatchMenuV4StockBody,
@@ -991,6 +993,10 @@ import {
 	PostMenuV4ScheduleMenuResponse,
 	PostMenuV4UnscheduleMenuBody,
 	PostMenuV4UnscheduleMenuResponse,
+	PostMenuV4CategoryAttachmentQuery,
+	PostMenuV4CategoryAttachmentResponse,
+	DeleteMenuV4CategoryDetachItemsBody,
+	DeleteMenuV4CategoryDetachItemsResponse,
 } from './interface/menu';
 
 import {
@@ -10107,30 +10113,6 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
-	/**
-	 * POST /menu/v4/category/{id}/attachment/{name}
-	 *
-	 * @param id
-	 * @param name
-	 * @param options - additional request options
-	 */
-	post_menu_v4_category_attachment(
-		id: string,
-		name: 'thumbnail',
-		options?: {
-			query?: PostMenuV4CategoryAttachmentQuery;
-		} & RequestOptions,
-	): ResponsePromise<PostMenuV4CategoryAttachmentResponse> {
-		return this.request(
-			'menu',
-			'/menu/v4/category/{id}/attachment/{name}',
-			'post',
-			`/menu/v4/category/${id}/attachment/${name}`,
-			null,
-			options,
-		);
-	}
-
 	/**
 	 * POST /menu/v4/item/{id}/attachment/{name}
 	 *
@@ -10287,6 +10269,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * DELETE /menu/v4/item/{id}/modifier-groups/detach
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	delete_menu_v4_item_modifier_groups_detach(
+		id: string,
+		body: DeleteMenuV4ItemModifierGroupsDetachBody,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteMenuV4ItemModifierGroupsDetachResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/item/{id}/modifier-groups/detach',
+			'delete',
+			`/menu/v4/item/${id}/modifier-groups/detach`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/modifier
 	 *
@@ -10560,6 +10564,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * DELETE /menu/v4/modifier-group/{id}/modifiers/detach
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	delete_menu_v4_modifier_group_modifiers_detach(
+		id: string,
+		body: DeleteMenuV4ModifierGroupModifiersDetachBody,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteMenuV4ModifierGroupModifiersDetachResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier-group/{id}/modifiers/detach',
+			'delete',
+			`/menu/v4/modifier-group/${id}/modifiers/detach`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * PATCH /menu/v4/stock/business-unit
 	 *
@@ -10746,6 +10772,52 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /menu/v4/category/{id}/attachment/{name}
+	 *
+	 * @param id
+	 * @param name
+	 * @param options - additional request options
+	 */
+	post_menu_v4_category_attachment(
+		id: string,
+		name: 'thumbnail',
+		options?: {
+			query?: PostMenuV4CategoryAttachmentQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostMenuV4CategoryAttachmentResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/category/{id}/attachment/{name}',
+			'post',
+			`/menu/v4/category/${id}/attachment/${name}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * DELETE /menu/v4/category/{id}/detach-items
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	delete_menu_v4_category_detach_items(
+		id: string,
+		body: DeleteMenuV4CategoryDetachItemsBody,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteMenuV4CategoryDetachItemsResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/category/{id}/detach-items',
+			'delete',
+			`/menu/v4/category/${id}/detach-items`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /notification - Get all notifications
 	 *

package/src/interface/menu.ts

@@ -8027,27 +8027,6 @@ export interface PostMenuV4BrandMenuDuplicateRequest
 	body: PostMenuV4BrandMenuDuplicateBody;
 }
 
-// POST /menu/v4/category/{id}/attachment/{name}
-
-export interface PostMenuV4CategoryAttachmentPath {
-	id: string;
-	name: 'thumbnail';
-}
-
-export interface PostMenuV4CategoryAttachmentQuery {
-	'body.data'?: string;
-	'body.brand_id'?: string;
-}
-
-export interface PostMenuV4CategoryAttachmentResponse {
-	status?: string;
-}
-
-export interface PostMenuV4CategoryAttachmentRequest
-	extends BaseRequest,
-		RequestQuery<PostMenuV4CategoryAttachmentQuery>,
-		PostMenuV4CategoryAttachmentPath {}
-
 // POST /menu/v4/item/{id}/attachment/{name}
 
 export interface PostMenuV4ItemAttachmentPath {
@@ -8610,6 +8589,45 @@ export interface PostMenuV4ItemDuplicateRequest extends BaseRequest, PostMenuV4I
 	body: PostMenuV4ItemDuplicateBody;
 }
 
+// DELETE /menu/v4/item/{id}/modifier-groups/detach
+
+export interface DeleteMenuV4ItemModifierGroupsDetachPath {
+	id: string;
+}
+
+export type DeleteMenuV4ItemModifierGroupsDetachBody = {
+	parent?: DraftItemToModifierGroupRelationshipDTO;
+	children?: DraftItemToModifierGroupRelationshipDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	modifier_group_id: string;
+	item_id: string;
+	brand_id: string;
+	sequence?: number;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	item?: DraftItemDTO;
+	modifier_group?: DraftModifierGroupDTO;
+	brand?: DraftBrandDTO;
+	changes?: ItemToModifierGroupRelationshipChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}[];
+
+export interface DeleteMenuV4ItemModifierGroupsDetachResponse {
+	status?: string;
+}
+
+export interface DeleteMenuV4ItemModifierGroupsDetachRequest
+	extends BaseRequest,
+		DeleteMenuV4ItemModifierGroupsDetachPath {
+	body: DeleteMenuV4ItemModifierGroupsDetachBody;
+}
+
 // POST /menu/v4/modifier
 
 export interface PostMenuV4ModifierBody {
@@ -9398,6 +9416,45 @@ export interface PostMenuV4ModifierGroupDuplicateRequest
 	body: PostMenuV4ModifierGroupDuplicateBody;
 }
 
+// DELETE /menu/v4/modifier-group/{id}/modifiers/detach
+
+export interface DeleteMenuV4ModifierGroupModifiersDetachPath {
+	id: string;
+}
+
+export type DeleteMenuV4ModifierGroupModifiersDetachBody = {
+	parent?: DraftModifierGroupToModifierRelationshipDTO;
+	children?: DraftModifierGroupToModifierRelationshipDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	modifier_id: string;
+	modifier_group_id: string;
+	brand_id: string;
+	sequence?: number;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	modifier?: DraftModifierDTO;
+	modifier_group?: DraftModifierGroupDTO;
+	brand?: DraftBrandDTO;
+	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}[];
+
+export interface DeleteMenuV4ModifierGroupModifiersDetachResponse {
+	status?: string;
+}
+
+export interface DeleteMenuV4ModifierGroupModifiersDetachRequest
+	extends BaseRequest,
+		DeleteMenuV4ModifierGroupModifiersDetachPath {
+	body: DeleteMenuV4ModifierGroupModifiersDetachBody;
+}
+
 // PATCH /menu/v4/stock/business-unit
 
 export interface PatchMenuV4StockBusinessUnitBody {
@@ -9633,3 +9690,63 @@ export interface PostMenuV4UnscheduleMenuResponse {
 export interface PostMenuV4UnscheduleMenuRequest extends BaseRequest {
 	body: PostMenuV4UnscheduleMenuBody;
 }
+
+// POST /menu/v4/category/{id}/attachment/{name}
+
+export interface PostMenuV4CategoryAttachmentPath {
+	id: string;
+	name: 'thumbnail';
+}
+
+export interface PostMenuV4CategoryAttachmentQuery {
+	'body.data'?: string;
+	'body.brand_id'?: string;
+}
+
+export interface PostMenuV4CategoryAttachmentResponse {
+	status?: string;
+}
+
+export interface PostMenuV4CategoryAttachmentRequest
+	extends BaseRequest,
+		RequestQuery<PostMenuV4CategoryAttachmentQuery>,
+		PostMenuV4CategoryAttachmentPath {}
+
+// DELETE /menu/v4/category/{id}/detach-items
+
+export interface DeleteMenuV4CategoryDetachItemsPath {
+	id: string;
+}
+
+export type DeleteMenuV4CategoryDetachItemsBody = {
+	parent?: DraftCategoryToItemRelationshipDTO;
+	children?: DraftCategoryToItemRelationshipDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	item_id: string;
+	category_id: string;
+	brand_id: string;
+	sequence?: number;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	category?: DraftCategoryDTO;
+	item?: DraftItemDTO;
+	brand?: DraftBrandDTO;
+	changes?: CategoryToItemRelationshipChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}[];
+
+export interface DeleteMenuV4CategoryDetachItemsResponse {
+	status?: string;
+}
+
+export interface DeleteMenuV4CategoryDetachItemsRequest
+	extends BaseRequest,
+		DeleteMenuV4CategoryDetachItemsPath {
+	body: DeleteMenuV4CategoryDetachItemsBody;
+}

package/test/client.test.ts

@@ -49,7 +49,7 @@ describe('ServiceClient', () => {
 	test('headers get merged', async () => {
 		const intercept = jest.fn(interceptor(200));
 		const api = new ServiceClient({
-			stage: 'test',
+			stage: 'dev',
 			intercept,
 			headers: {
 				a: 'a from constructor',
@@ -114,6 +114,11 @@ describe('ServiceClient', () => {
 		expect(query).toEqual({ foo: 'test', things: ['1', '2', '3'] });
 	});
 
+	test('client throws if invalid stage is passed', async () => {
+		const api = new ServiceClient({ stage: 'invalid', intercept: interceptor(500) });
+		await expect(api.get_task('')).rejects.toBeInstanceOf(Error);
+	});
+
 	describe('ServiceError', () => {
 		// see: https://github.com/microsoft/TypeScript/issues/13965
 		test('is instance of itself', async () => {