@compassdigital/sdk.typescript 4.119.0 → 4.121.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.119.0",
+	"version": "4.121.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.40.1",
+		"@compassdigital/sdk.typescript.cli": "^4.42.0",
 		"@swc/core": "^1.4.1",
 		"@swc/jest": "^0.2.36",
 		"@types/jest": "^29.2.4",

package/src/base.ts

@@ -149,6 +149,14 @@ interface ErrorConstructor {
 	captureStackTrace?(target: object, constructorOpt?: Function): void;
 }
 
+/**
+ * A set of constraints that are used to validate service errors.
+ */
+export interface ServiceErrorIsOptions {
+	status?: number;
+	code?: number;
+}
+
 /**
  * An error returned from an api service.
  */
@@ -187,6 +195,22 @@ export class ServiceError extends Error {
 		return -1;
 	}
 
+	/**
+	 * Returns true if err is an instance of ServiceError and matches the specified options.
+	 */
+	static is(err: any, options?: ServiceErrorIsOptions): err is ServiceError {
+		if (!(err instanceof ServiceError)) {
+			return false;
+		}
+		if (options?.status !== undefined && err.status !== options.status) {
+			return false;
+		}
+		if (options?.code !== undefined && err.code !== options.code) {
+			return false;
+		}
+		return true;
+	}
+
 	/**
 	 * Returns a promise that resolves to null if http status code
 	 * or service error code matches one of the provided codes.
@@ -490,9 +514,11 @@ export abstract class BaseServiceClient {
 		if (url.startsWith('https://')) options.agent ??= this.agent();
 		const headers: Record<string, string> = {
 			'User-Agent': 'CDL/ServiceClient',
-			'Content-Type': 'application/json',
 			...options.headers,
 		};
+		if (body) {
+			headers['Content-Type'] = 'application/json';
+		}
 		if (options.internal) {
 			headers['X-Request-Type'] = 'internal';
 		}

package/src/index.ts

@@ -948,6 +948,8 @@ import {
 	PostMenuV4ItemDuplicateResponse,
 	DeleteMenuV4ItemModifierGroupsDetachBody,
 	DeleteMenuV4ItemModifierGroupsDetachResponse,
+	PostMenuV4ItemAttachModifierGroupsBody,
+	PostMenuV4ItemAttachModifierGroupsResponse,
 	PostMenuV4ModifierBody,
 	PostMenuV4ModifierResponse,
 	GetMenuV4ModifierQuery,
@@ -1187,6 +1189,8 @@ import {
 import {
 	PostAuthFlowBody,
 	PostAuthFlowResponse,
+	GetAuthSsoConfigQuery,
+	GetAuthSsoConfigResponse,
 	GetAuthSsoConfigsQuery,
 	GetAuthSsoConfigsResponse,
 	PostAuthSsoConfigBody,
@@ -10291,6 +10295,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /menu/v4/item/{id}/attach-modifier-groups
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_item_attach_modifier_groups(
+		id: string,
+		body: PostMenuV4ItemAttachModifierGroupsBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4ItemAttachModifierGroupsResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/item/{id}/attach-modifier-groups',
+			'post',
+			`/menu/v4/item/${id}/attach-modifier-groups`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/modifier
 	 *
@@ -12449,6 +12475,28 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('auth', '/auth/flow', 'post', `/auth/flow`, body, options);
 	}
 
+	/**
+	 * GET /auth/sso-config/{name} - Return sso client-id based on lookup values
+	 *
+	 * @param name
+	 * @param options - additional request options
+	 */
+	get_auth_sso_config(
+		name: string,
+		options: {
+			query: GetAuthSsoConfigQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetAuthSsoConfigResponse> {
+		return this.request(
+			'auth',
+			'/auth/sso-config/{name}',
+			'get',
+			`/auth/sso-config/${name}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /auth/sso-configs - Returns all available SSO configurations
 	 *

package/src/interface/auth.ts

@@ -126,6 +126,20 @@ export type PostAuthFlowBody = SSOFlowRequestDTO;
 
 export type PostAuthFlowResponse = SSOFlowResponseDTO;
 
+// GET /auth/sso-config/{name} - Return sso client-id based on lookup values
+
+export interface GetAuthSsoConfigPath {
+	name: string;
+}
+
+export interface GetAuthSsoConfigQuery {
+	realm: string;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetAuthSsoConfigResponse = string;
+
 // GET /auth/sso-configs - Returns all available SSO configurations
 
 export interface GetAuthSsoConfigsQuery {

package/src/interface/centricos.ts

@@ -222,7 +222,7 @@ export interface CentricDiscountStatus {
 
 export interface CentricVoucherifyMetaData {
 	// The type of the voucherify discount
-	type: Record<string, any>;
+	type: 'AMOUNT_OFF' | 'PERCENT_OFF';
 	// The numeric value of discount for amount off
 	amountOff?: number;
 	// The percentage value of discount for percent off

package/src/interface/menu.ts

@@ -8628,6 +8628,40 @@ export interface DeleteMenuV4ItemModifierGroupsDetachRequest
 	body: DeleteMenuV4ItemModifierGroupsDetachBody;
 }
 
+// POST /menu/v4/item/{id}/attach-modifier-groups
+
+export interface PostMenuV4ItemAttachModifierGroupsPath {
+	id: string;
+}
+
+export type PostMenuV4ItemAttachModifierGroupsBody = {
+	parent?: DraftItemToModifierGroupRelationshipDTO;
+	children?: DraftItemToModifierGroupRelationshipDTO[];
+	parent_id?: string;
+	modifier_group_id: string;
+	item_id: string;
+	brand_id: string;
+	sequence?: number;
+	applied_diff_snapshot?: Record<string, any>;
+	item?: DraftItemDTO;
+	modifier_group?: DraftModifierGroupDTO;
+	brand?: DraftBrandDTO;
+	changes?: ItemToModifierGroupRelationshipChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}[];
+
+export interface PostMenuV4ItemAttachModifierGroupsResponse {
+	status?: string;
+}
+
+export interface PostMenuV4ItemAttachModifierGroupsRequest
+	extends BaseRequest,
+		PostMenuV4ItemAttachModifierGroupsPath {
+	body: PostMenuV4ItemAttachModifierGroupsBody;
+}
+
 // POST /menu/v4/modifier
 
 export interface PostMenuV4ModifierBody {

package/test/client.test.ts

@@ -32,7 +32,6 @@ describe('ServiceClient', () => {
 			method: 'get',
 			headers: {
 				'User-Agent': 'CDL/ServiceClient',
-				'Content-Type': 'application/json',
 			},
 		});
 	});
@@ -65,13 +64,26 @@ describe('ServiceClient', () => {
 		const req = intercept.mock.calls[0][0];
 		expect(req.headers).toEqual({
 			'User-Agent': 'CDL/ServiceClient',
-			'Content-Type': 'application/json',
 			a: 'a from constructor',
 			b: 'b from method',
 			c: 'c from method',
 		});
 	});
 
+	test('Content-Type header is added to headers if body exists', async () => {
+		const intercept = jest.fn(interceptor(200));
+		const api = new ServiceClient({
+			stage: 'dev',
+			intercept,
+		});
+		await api.post_discount({ name: 'test', createdBy: 'test' }, {});
+		const req = intercept.mock.calls[0][0];
+		expect(req.headers).toEqual({
+			'User-Agent': 'CDL/ServiceClient',
+			'Content-Type': 'application/json',
+		});
+	});
+
 	test('client retries on bad status codes', async () => {
 		const intercept = jest.fn(async () => {
 			if (intercept.mock.calls.length === 3) {