@compassdigital/sdk.typescript 4.527.0 → 4.528.1-alpha.2

package/src/interface/menu.ts

@@ -719,6 +719,7 @@ export interface LocalMenuGroupDTO {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -1937,6 +1938,31 @@ export interface BusinessUnitDTO {
 	[index: string]: any;
 }
 
+export interface MenuWorksProductDTO {
+	mrn: string;
+	product_type?: string;
+	name?: string;
+	short_name?: string;
+	[index: string]: any;
+}
+
+export interface ProductsSyncStatusResponseDTO {
+	status: string;
+	items_ingested_count: number;
+	total_available?: number;
+	last_success_at?: string | string;
+	last_failure_at?: string | string;
+	started_at?: string | string;
+	message?: string;
+	[index: string]: any;
+}
+
+export interface ConflictErrorDTO {
+	number: number;
+	message: string;
+	[index: string]: any;
+}
+
 export interface UniversalItemWithoutIdDTO {
 	barcode: string;
 	name: string;
@@ -2713,6 +2739,7 @@ export interface PostMenuV3LocalMenuGroupBody {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	vendor_metadata?: VendorMetadataDTO[];
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -2728,6 +2755,7 @@ export interface PostMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2769,6 +2797,7 @@ export interface GetMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2800,6 +2829,7 @@ export interface PatchMenuV3LocalMenuGroupBody {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id?: string;
 	version?: number;
 	vendor_metadata?: VendorMetadataDTO[];
@@ -2817,6 +2847,7 @@ export interface PatchMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2854,6 +2885,7 @@ export interface DeleteMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2910,6 +2942,7 @@ export type PostMenuV3LocalMenuGroupsBody = {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	vendor_metadata?: VendorMetadataDTO[];
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -7790,6 +7823,54 @@ export interface GetMenuV3MenuworksBusinessUnitsResponse {
 
 export interface GetMenuV3MenuworksBusinessUnitsRequest extends BaseRequest {}
 
+// GET /menu/v3/menuworks/business_units/{unit_id}/products
+
+export interface GetMenuV3MenuworksBusinessUnitsProductsPath {
+	unit_id: string;
+}
+
+export interface GetMenuV3MenuworksBusinessUnitsProductsQuery {
+	q?: string;
+	// Number of records to load per page
+	limit?: number;
+	page?: number;
+	// If specified, only the selected fields will be returned
+	select?: string[];
+	// List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
+	relationships?: string[];
+	// A field to sort the results based on
+	sort_by?: string;
+	sort_order?: 'DESC' | 'ASC';
+	// How soft deleted records should be shown in the list
+	soft_deleted?: 'include' | 'exclude' | 'only';
+}
+
+export interface GetMenuV3MenuworksBusinessUnitsProductsResponse {
+	results: MenuWorksProductDTO[];
+	sync_status?: ProductsSyncStatusResponseDTO;
+	meta?: ListResponseMetadataDTO;
+	[index: string]: any;
+}
+
+export interface GetMenuV3MenuworksBusinessUnitsProductsRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV3MenuworksBusinessUnitsProductsQuery>,
+		GetMenuV3MenuworksBusinessUnitsProductsPath {}
+
+// POST /menu/v3/menuworks/business_units/{unit_id}/products/sync
+
+export interface PostMenuV3MenuworksBusinessUnitsProductsSyncPath {
+	unit_id: string;
+}
+
+export interface PostMenuV3MenuworksBusinessUnitsProductsSyncResponse {
+	triggered?: boolean;
+}
+
+export interface PostMenuV3MenuworksBusinessUnitsProductsSyncRequest
+	extends BaseRequest,
+		PostMenuV3MenuworksBusinessUnitsProductsSyncPath {}
+
 // GET /menu/v3/universal-items
 
 export interface GetMenuV3UniversalItemsQuery {

package/src/interface/user.ts

@@ -316,6 +316,27 @@ export interface PingResponse {
 	service?: string;
 }
 
+export interface HealthResponse {
+	status: 'healthy' | 'unhealthy';
+	timestamp: string;
+	version: string;
+	dependencies: HealthDependency[];
+	metadata: HealthMetadata;
+}
+
+export interface HealthDependency {
+	name: string;
+	status: 'healthy' | 'unhealthy';
+	responseTimeMs: number;
+	// Error or status details when unhealthy, null when healthy
+	details?: string;
+}
+
+export interface HealthMetadata {
+	region: string;
+	service: string;
+}
+
 // GET /user/auth - Gets the JWT token for a user
 
 export interface GetUserAuthQuery {
@@ -808,3 +829,9 @@ export interface GetUserProfileRequest extends BaseRequest, RequestQuery<GetUser
 export type GetUserPingResponse = PingResponse;
 
 export interface GetUserPingRequest extends BaseRequest {}
+
+// GET /user/health - User Service health check with dependency validation
+
+export type GetUserHealthResponse = HealthResponse;
+
+export interface GetUserHealthRequest extends BaseRequest {}

package/src/messages/events/AuditEvent.ts

@@ -0,0 +1,52 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface AuditActor {
+	id: string;
+	display_name: string;
+	type: 'human' | 'service' | 'system';
+}
+
+export interface AuditEntityRef {
+	type: string;
+	id: string;
+}
+
+export interface AuditResource {
+	type: string;
+	id: string;
+	name: string;
+}
+
+export interface AuditChanges {
+	// Sparse — only changed fields. For removed items, key present only here.
+	old?: Record<string, any>;
+	// Sparse — only changed fields. For added items, key present only here.
+	new?: Record<string, any>;
+}
+
+export interface AuditEvent {
+	// UUID, producer-assigned. Stable across EventBridge retries — used for deduplication.
+	id: string;
+	type: 'AuditEvent';
+	version: '0.0.1';
+	// ISO 8601 — when the action occurred, not when emitted
+	timestamp: string;
+	traceContext: {
+		traceId: string;
+	};
+	payload: {
+		// e.g. calendar_created, calendar_updated, calendar_deleted
+		action: string;
+		actor: AuditActor;
+		outcome: 'success' | 'failure';
+		// Present when outcome is failure
+		error_message?: string;
+		// Primary entity plus known ancestors (e.g. calendar, brand, location)
+		entity_refs: AuditEntityRef[];
+		resource: AuditResource;
+		changes?: AuditChanges;
+		correlation_id?: string;
+	};
+	// Producer service name (e.g. calendar-service)
+	source: string;
+}

package/src/messages/events/DiscountCreatedEvent.ts

@@ -102,6 +102,7 @@ export interface ItemLevelConfig {
 	globalMenuGroupId?: string;
 	globalMenuGroupName?: string;
 	sectorName?: string;
+	bundlePriority?: number;
 	details: ItemLevelConfigDetails[];
 }
 

package/src/messages/events/DiscountPublishedEvent.ts

@@ -102,6 +102,7 @@ export interface ItemLevelConfig {
 	globalMenuGroupId?: string;
 	globalMenuGroupName?: string;
 	sectorName?: string;
+	bundlePriority?: number;
 	details: ItemLevelConfigDetails[];
 }
 

package/src/messages/events/DiscountUpdatedEvent.ts

@@ -102,6 +102,7 @@ export interface ItemLevelConfig {
 	globalMenuGroupId?: string;
 	globalMenuGroupName?: string;
 	sectorName?: string;
+	bundlePriority?: number;
 	details: ItemLevelConfigDetails[];
 }
 

package/src/messages/events/FrictionlessOrderFailureEvent.ts

@@ -0,0 +1,34 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface FrictionlessOrderFailureEvent {
+	id: string;
+	type: 'FrictionlessOrderFailureEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		// The frictionless checkin identifier
+		checkinID: string;
+		// Shopping cart ID of the failed transaction
+		shoppingCartID: string;
+		// Order ID when available
+		orderID?: string;
+		// User ID of the failed transaction
+		userID: string;
+		// User email
+		userEmail: string;
+		// Meal plan ID when payment was mealplan
+		mealPlanID?: string;
+		// Site ID of the transaction
+		siteID: string;
+		// Brand ID of the transaction
+		brandID: string;
+		// Human-readable failure reason e.g. INSUFFICIENT_BALANCE, PAYMENT_DID_NOT_GO_THROUGH, PROCESSING_FAILED
+		failReason: string;
+		// Unpaid balance amount for insufficient balance failures
+		unpaidAmount: number;
+	};
+	source: string;
+}

package/src/messages/events/index.ts

@@ -1,5 +1,7 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+export { AuditEvent } from './AuditEvent';
+
 export { DiscountCreatedEvent } from './DiscountCreatedEvent';
 
 export { DiscountDeactivatedEvent } from './DiscountDeactivatedEvent';
@@ -16,6 +18,8 @@ export { ExternalRewardRedeemedEvent } from './ExternalRewardRedeemedEvent';
 
 export { FakeEvent } from './FakeEvent';
 
+export { FrictionlessOrderFailureEvent } from './FrictionlessOrderFailureEvent';
+
 export { LocationBrandCreatedEvent } from './LocationBrandCreatedEvent';
 
 export { LocationBrandUpdatedEvent } from './LocationBrandUpdatedEvent';

package/test/client.test.ts

@@ -84,6 +84,29 @@ describe('ServiceClient', () => {
 		});
 	});
 
+	test('loyalty client methods use path-style names', async () => {
+		const intercept = jest.fn(interceptor(200, { data: [] }));
+		const api = new ServiceClient({ stage: 'dev', intercept });
+
+		await api.get_loyalty_rewards({
+			query: {
+				realm: 'boost',
+				status: 'active',
+			},
+		} as any);
+
+		const req = intercept.mock.calls[0][0];
+		expect(req).toEqual({
+			route: '/loyalty/rewards',
+			service: 'loyalty',
+			url: 'https://dev.api.compassdigital.org/loyalty/rewards?realm=boost&status=active',
+			method: 'GET',
+			headers: {
+				'user-agent': 'CDL/ServiceClient',
+			},
+		});
+	});
+
 	test('user specified headers take priority', async () => {
 		const intercept = jest.fn(interceptor(200));
 		const api = new ServiceClient({