@compassdigital/sdk.typescript 4.44.0 → 4.46.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.44.0",
+	"version": "4.46.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",
@@ -46,12 +46,12 @@
 	},
 	"devDependencies": {
 		"@compassdigital/review": "^7.3.0",
-		"@compassdigital/sdk.typescript.cli": "^4.16.0",
+		"@compassdigital/sdk.typescript.cli": "^4.17.1",
 		"@swc/core": "^1.4.1",
 		"@swc/jest": "^0.2.36",
 		"@types/jest": "^29.2.4",
 		"@types/node": "^20.1.0",
-		"esbuild": "^0.20.0",
+		"esbuild": "^0.21.1",
 		"jest": "^29.7.0",
 		"rimraf": "^5.0.0",
 		"typescript": "^5.0.2"

package/src/base.ts

@@ -326,7 +326,9 @@ export abstract class BaseServiceClient {
    * Combine the route and query parameters into a full url.
    */
   private build_url(route: string, service: string, { base_url, stage = "dev" }: RequestOptions, params: any): string {
-    let url = `https://api.compassdigital.org/${stage}${route}`;
+		let url = stage === 'v1'
+			? `https://api.compassdigital.org${route}`
+			: `https://${stage}.api.compassdigital.org${route}`;
     // use the base url if one was provided.
     if (base_url) {
       if (typeof base_url === 'object' && base_url[service]) base_url = base_url[service];

package/src/index.ts

@@ -953,8 +953,8 @@ import {
 } from "./interface/search";
 
 import {
-  GetAuthFlowQuery,
-  GetAuthFlowResponse,
+  PostAuthFlowBody,
+  PostAuthFlowResponse,
   GetAuthSsoConfigsQuery,
   GetAuthSsoConfigsResponse,
   PostAuthSsoConfigBody,
@@ -9593,16 +9593,16 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * GET /auth/flow - Determines the authentication flow for a user based on their email address
+   * POST /auth/flow - Determines the authentication flow for a user based on their email address
    *
+   * @param body
    * @param options - additional request options
    */
-  get_auth_flow(
-    options: {
-      query: GetAuthFlowQuery;
-    } & RequestOptions,
-  ): ResponsePromise<GetAuthFlowResponse> {
-    return this.request("auth", "get_auth_flow", "get", `/auth/flow`, null, options);
+  post_auth_flow(
+    body: PostAuthFlowBody,
+    options?: RequestOptions,
+  ): ResponsePromise<PostAuthFlowResponse> {
+    return this.request("auth", "post_auth_flow", "post", `/auth/flow`, body, options);
   }
 
   /**

package/src/interface/auth.ts

@@ -3,6 +3,12 @@
 
 import { RequestQuery, BaseRequest } from "./util";
 
+export interface SSOFlowRequestDTO {
+  email: string;
+  realm: string;
+  clientId: string;
+}
+
 export interface OIDC {
   authorizationUrl: string;
 }
@@ -12,6 +18,14 @@ export interface SSOFlowResponseDTO {
   oidc?: OIDC;
 }
 
+export interface SSOMapping {
+  id: string;
+  given_name: string;
+  family_name: string;
+  email: string;
+  updated_at: string;
+}
+
 export interface SSOConfigsResponseDTO {
   name: string;
   clientId: string;
@@ -19,6 +33,7 @@ export interface SSOConfigsResponseDTO {
   tokenEndpoint: string;
   userinfoEndpoint: string;
   realm: string;
+  mapping?: SSOMapping;
 }
 
 export interface SSOConfigRequestDTO {
@@ -30,6 +45,7 @@ export interface SSOConfigRequestDTO {
   userinfoEndpoint: string;
   realm: string;
   protocol: "OIDC" | "SAML2";
+  mapping?: SSOMapping;
 }
 
 export interface SSOConfigResponseDTO {
@@ -76,19 +92,15 @@ export interface SSOAuthResponseDTO {
   profile: Profile;
 }
 
-// GET /auth/flow - Determines the authentication flow for a user based on their email address
+// POST /auth/flow - Determines the authentication flow for a user based on their email address
 
-export interface GetAuthFlowQuery {
-  email: string;
-  realm: string;
-  clientId: string;
-  // Graphql query string
-  _query?: string;
-}
+export type PostAuthFlowBody = SSOFlowRequestDTO;
 
-export type GetAuthFlowResponse = SSOFlowResponseDTO;
+export type PostAuthFlowResponse = SSOFlowResponseDTO;
 
-export interface GetAuthFlowRequest extends BaseRequest, RequestQuery<GetAuthFlowQuery> {}
+export interface PostAuthFlowRequest extends BaseRequest {
+  body: PostAuthFlowBody;
+}
 
 // GET /auth/sso-configs - Returns all available SSO configurations
 

package/src/interface/menu.ts

@@ -343,6 +343,7 @@ export interface DraftBrandDTO {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  applied_diff_snapshot?: Record<string, any>;
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -555,6 +556,8 @@ export interface DraftItemDTO {
   id?: string;
   parent_id?: string;
   name?: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   reporting?: Record<string, any>;
@@ -571,6 +574,7 @@ export interface DraftItemDTO {
   menu_works?: Record<string, any>;
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: Record<string, any>[];
@@ -653,6 +657,8 @@ export interface DraftModifierDTO {
   id?: string;
   parent_id?: string;
   name?: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   price?: number;
@@ -671,6 +677,7 @@ export interface DraftModifierDTO {
   pre_surcharge?: number;
   post_surcharge?: number;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   changes?: ModifierChangeDTO[];
@@ -921,6 +928,8 @@ export interface PublishedItemDTO {
   id?: string;
   parent_id?: string;
   name?: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   price?: number;
@@ -935,6 +944,7 @@ export interface PublishedItemDTO {
   posid_segment?: string;
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
+  tags?: string[];
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -983,6 +993,8 @@ export interface PublishedModifierDTO {
   id?: string;
   parent_id?: string;
   name?: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   price?: number;
@@ -999,6 +1011,7 @@ export interface PublishedModifierDTO {
   pre_surcharge?: number;
   post_surcharge?: number;
   tax_tag_code?: string;
+  tags?: string[];
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -1271,6 +1284,8 @@ export interface DraftItemEntityDTO {
   deleted_at?: string;
   parent_id?: string;
   name: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   reporting: ReportingMetadataDTO;
@@ -1287,6 +1302,7 @@ export interface DraftItemEntityDTO {
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -1309,6 +1325,8 @@ export interface DraftModifierEntityDTO {
   deleted_at?: string;
   parent_id?: string;
   name: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   price: number;
@@ -1327,6 +1345,7 @@ export interface DraftModifierEntityDTO {
   pre_surcharge?: number;
   post_surcharge?: number;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -2562,6 +2581,7 @@ export interface PostMenuV3DraftBrandBody {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  applied_diff_snapshot?: Record<string, any>;
   changes?: BrandChangeDTO[];
   local_menu_group?: LocalMenuGroupDTO;
   global_menu_group?: GlobalMenuGroupDTO;
@@ -2627,6 +2647,7 @@ export interface PatchMenuV3DraftBrandBody {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  applied_diff_snapshot?: Record<string, any>;
   version?: number;
   changes?: BrandChangeDTO[];
   local_menu_group?: LocalMenuGroupDTO;
@@ -2714,6 +2735,7 @@ export type PostMenuV3DraftBrandsBody = {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  applied_diff_snapshot?: Record<string, any>;
   changes?: BrandChangeDTO[];
   local_menu_group?: LocalMenuGroupDTO;
   global_menu_group?: GlobalMenuGroupDTO;
@@ -4238,6 +4260,8 @@ export interface PostMenuV3DraftItemBody {
   modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
   parent_id?: string;
   name: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   reporting: ReportingMetadataDTO;
@@ -4254,6 +4278,7 @@ export interface PostMenuV3DraftItemBody {
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];
@@ -4306,6 +4331,8 @@ export interface PatchMenuV3DraftItemBody {
   id?: string;
   parent_id?: string;
   name?: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   reporting?: ReportingMetadataDTO;
@@ -4322,6 +4349,7 @@ export interface PatchMenuV3DraftItemBody {
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -4396,6 +4424,8 @@ export type PostMenuV3DraftItemsBody = {
   modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
   parent_id?: string;
   name: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   reporting: ReportingMetadataDTO;
@@ -4412,6 +4442,7 @@ export type PostMenuV3DraftItemsBody = {
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];
@@ -4482,6 +4513,8 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
   id?: string;
   parent_id?: string;
   name?: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   reporting?: ReportingMetadataDTO;
@@ -4498,6 +4531,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];
@@ -5495,6 +5529,8 @@ export interface PostMenuV3DraftModifierBody {
   modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
   parent_id?: string;
   name: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   price: number;
@@ -5513,6 +5549,7 @@ export interface PostMenuV3DraftModifierBody {
   pre_surcharge?: number;
   post_surcharge?: number;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   changes?: ModifierChangeDTO[];
@@ -5564,6 +5601,8 @@ export interface PatchMenuV3DraftModifierBody {
   id?: string;
   parent_id?: string;
   name?: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   price?: number;
@@ -5582,6 +5621,7 @@ export interface PatchMenuV3DraftModifierBody {
   pre_surcharge?: number;
   post_surcharge?: number;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -5655,6 +5695,8 @@ export type PostMenuV3DraftModifiersBody = {
   modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
   parent_id?: string;
   name: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   price: number;
@@ -5673,6 +5715,7 @@ export type PostMenuV3DraftModifiersBody = {
   pre_surcharge?: number;
   post_surcharge?: number;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   changes?: ModifierChangeDTO[];
@@ -5721,6 +5764,8 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
   id?: string;
   parent_id?: string;
   name?: string;
+  name_on_receipt?: string;
+  name_on_kds?: string;
   label?: string;
   description?: string;
   price?: number;
@@ -5739,6 +5784,7 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
   pre_surcharge?: number;
   post_surcharge?: number;
   tax_tag_code?: string;
+  tags?: string[];
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   changes?: ModifierChangeDTO[];

package/test/client.test.ts

@@ -28,7 +28,7 @@ describe('ServiceClient', () => {
 		expect(req).toEqual({
 			name: 'get_task',
 			service: 'task',
-			url: 'https://api.compassdigital.org/dev/task/some_id',
+			url: 'https://dev.api.compassdigital.org/task/some_id',
 			method: 'get',
 			headers: {
 				'User-Agent': 'CDL/ServiceClient',