@flipdish/events 1.25352.0 → 1.26007.0

package/oom/online.ordering.common.js

@@ -13,4 +13,5 @@ export const OnlineOrderingCommonPropertiesSchema = z.object({
     menuRevisionId: z.number().int(),
     legacyMenuId: z.number().int(),
     referencePriceDispatchType: z.string(),
+    publishedAt: z.string().datetime(),
 });

package/oom/online.ordering.common.ts

@@ -15,6 +15,7 @@ export const OnlineOrderingCommonPropertiesSchema = z.object({
   menuRevisionId: z.number().int(),
   legacyMenuId: z.number().int(),
   referencePriceDispatchType: z.string(),
+  publishedAt: z.string().datetime(),
 });
 
 export type OnlineOrderingCommonProperties = z.infer<typeof OnlineOrderingCommonPropertiesSchema>;

package/oom/online.ordering.menus.preprocess.ts

@@ -347,12 +347,10 @@ export type OnlineOrderingMenuPreprocessSuccessItemPricingProfileV1 = z.infer<
   typeof ItemPricingProfileSchema
 >;
 
-// Preprocess Success
 export type OnlineOrderingMenuPreprocessSuccessV1 = z.infer<
   typeof OnlineOrderingMenuPreprocessSuccessV1Schema
 >;
 
-// Preprocess Failed
 export type OnlineOrderingMenuPreprocessFailedV1 = z.infer<
   typeof OnlineOrderingMenuPreprocessFailedV1Schema
 >;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flipdish/events",
-  "version": "1.25352.0",
+  "version": "1.26007.0",
   "type": "module",
   "scripts": {
     "test": "node --max-old-space-size=4096 --max-semi-space-size=512 ./node_modules/.bin/jest --config=jest.config.ts --verbose",

package/rms/menus/events/constants.js

@@ -1,3 +1,4 @@
 export const eventTypes = {
     MENU_PUBLISHED_V1: 'menu.published.v1',
+    MENU_VALIDATION_FAILED_V1: 'menu.validation.failed.v1',
 };

package/rms/menus/events/constants.ts

@@ -1,3 +1,4 @@
 export const eventTypes = {
   MENU_PUBLISHED_V1: 'menu.published.v1',
+  MENU_VALIDATION_FAILED_V1: 'menu.validation.failed.v1',
 } as const;

package/rms/menus/events/index.js

@@ -1,7 +1,10 @@
 import { eventTypes } from './constants.js';
 import { MenuEventBaseSchema } from './menu.published.v1.js';
+import { MenuValidationFailedEventBaseSchema } from './menu.validation.failed.v1.js';
 export * from './constants.js';
 export * from './menu.published.v1.js';
+export * from './menu.validation.failed.v1.js';
 export const eventSchemaMap = Object.fromEntries([
     [eventTypes.MENU_PUBLISHED_V1, MenuEventBaseSchema],
+    [eventTypes.MENU_VALIDATION_FAILED_V1, MenuValidationFailedEventBaseSchema],
 ]);

package/rms/menus/events/index.ts

@@ -1,9 +1,12 @@
 import { eventTypes } from './constants.js';
 import { MenuEventBaseSchema } from './menu.published.v1.js';
+import { MenuValidationFailedEventBaseSchema } from './menu.validation.failed.v1.js';
 
 export * from './constants.js';
 export * from './menu.published.v1.js';
+export * from './menu.validation.failed.v1.js';
 
 export const eventSchemaMap = Object.fromEntries([
   [eventTypes.MENU_PUBLISHED_V1, MenuEventBaseSchema],
+  [eventTypes.MENU_VALIDATION_FAILED_V1, MenuValidationFailedEventBaseSchema],
 ]);

package/rms/menus/events/menu.validation.failed.v1.js

@@ -0,0 +1,58 @@
+import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
+import { z } from 'zod';
+import { orgIdSchema, propertyIdSchema } from '../../../common-schemas.js';
+import { metadataSchema } from '../../../metadata.js';
+import { menuIdSchema, menuPublishIdSchema, revisionIdSchema } from '../schemas/common-schemas.js';
+import { eventTypes } from './constants.js';
+import { MENU_VALIDATION_FAILED_V1_WEBHOOK_EXAMPLE } from './webhook-examples.js';
+// This must be called before defining any schemas
+extendZodWithOpenApi(z);
+// Event properties schema for menu validation failed events
+export const MenuValidationFailedEventPropertiesSchema = z
+    .object({
+    orgId: orgIdSchema,
+    brandId: z.string().openapi({
+        description: 'Unique ID of the client’s Brand that owns this menu. This ID remains the same for subsequent updates / revisions of the same menu.',
+        example: 'br456',
+    }),
+    propertyId: propertyIdSchema,
+    salesChannelId: z.string().openapi({
+        description: 'Unique ID of a Sales Channel, a digital channel tied to a Property and Brand (e.g., kiosk, web, mobile app). This ID remains the same for subsequent updates / revisions of the same menu.',
+        example: 'sc123',
+    }),
+    menuId: menuIdSchema,
+    menuRevisionId: revisionIdSchema,
+    menuPublishId: menuPublishIdSchema,
+    error: z.string().openapi({
+        description: 'The error message from the menu validation',
+        example: 'Menu validation failed',
+    }),
+})
+    .openapi('MenuValidationFailedEventPropertiesSchema', {
+    description: 'Properties included with menu validation failed events.',
+});
+// =============================================================================
+// MENU VALIDATION FAILED EVENT SCHEMAS
+// =============================================================================
+// EventBridge envelope schema for menu events
+export const MenuValidationFailedEventBaseSchema = z
+    .object({
+    source: z.string().openapi({
+        description: 'Source of the event',
+        example: 'rms',
+    }),
+    'detail-type': z.literal(eventTypes.MENU_VALIDATION_FAILED_V1),
+    detail: z.object({
+        properties: MenuValidationFailedEventPropertiesSchema,
+        metadata: metadataSchema,
+    }),
+})
+    .openapi({
+    description: 'Emitted when a menu validation fails after a menu publish.',
+    'x-webhook-group': 'Menu Validation',
+    'x-example': MENU_VALIDATION_FAILED_V1_WEBHOOK_EXAMPLE,
+});
+export default {
+    MenuValidationFailedEventBaseSchema,
+    MenuValidationFailedEventPropertiesSchema,
+};

package/rms/menus/events/menu.validation.failed.v1.ts

@@ -0,0 +1,70 @@
+import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
+import { z } from 'zod';
+import { orgIdSchema, propertyIdSchema } from '../../../common-schemas.js';
+import { metadataSchema } from '../../../metadata.js';
+import { menuIdSchema, menuPublishIdSchema, revisionIdSchema } from '../schemas/common-schemas.js';
+import { eventTypes } from './constants.js';
+import { MENU_VALIDATION_FAILED_V1_WEBHOOK_EXAMPLE } from './webhook-examples.js';
+
+// This must be called before defining any schemas
+extendZodWithOpenApi(z);
+
+// Event properties schema for menu validation failed events
+export const MenuValidationFailedEventPropertiesSchema = z
+  .object({
+    orgId: orgIdSchema,
+    brandId: z.string().openapi({
+      description:
+        'Unique ID of the client’s Brand that owns this menu. This ID remains the same for subsequent updates / revisions of the same menu.',
+      example: 'br456',
+    }),
+    propertyId: propertyIdSchema,
+    salesChannelId: z.string().openapi({
+      description:
+        'Unique ID of a Sales Channel, a digital channel tied to a Property and Brand (e.g., kiosk, web, mobile app). This ID remains the same for subsequent updates / revisions of the same menu.',
+      example: 'sc123',
+    }),
+    menuId: menuIdSchema,
+    menuRevisionId: revisionIdSchema,
+    menuPublishId: menuPublishIdSchema,
+    error: z.string().openapi({
+      description: 'The error message from the menu validation',
+      example: 'Menu validation failed',
+    }),
+  })
+  .openapi('MenuValidationFailedEventPropertiesSchema', {
+    description: 'Properties included with menu validation failed events.',
+  });
+export type MenuValidationFailedEventPropertiesType = z.infer<
+  typeof MenuValidationFailedEventPropertiesSchema
+>;
+
+// =============================================================================
+// MENU VALIDATION FAILED EVENT SCHEMAS
+// =============================================================================
+
+// EventBridge envelope schema for menu events
+export const MenuValidationFailedEventBaseSchema = z
+  .object({
+    source: z.string().openapi({
+      description: 'Source of the event',
+      example: 'rms',
+    }),
+    'detail-type': z.literal(eventTypes.MENU_VALIDATION_FAILED_V1),
+    detail: z.object({
+      properties: MenuValidationFailedEventPropertiesSchema,
+      metadata: metadataSchema,
+    }),
+  })
+  .openapi({
+    description: 'Emitted when a menu validation fails after a menu publish.',
+    'x-webhook-group': 'Menu Validation',
+    'x-example': MENU_VALIDATION_FAILED_V1_WEBHOOK_EXAMPLE,
+  });
+
+export type MenuValidationFailedEventBaseType = z.infer<typeof MenuValidationFailedEventBaseSchema>;
+
+export default {
+  MenuValidationFailedEventBaseSchema,
+  MenuValidationFailedEventPropertiesSchema,
+};

package/rms/menus/events/webhook-examples.js

@@ -357,3 +357,13 @@ export const MENU_PUBLISHED_V1_WEBHOOK_EXAMPLE = {
     menu: MENU_EXAMPLE,
     priceBandId: '13a85f64-5717-4562-b3fc-2c963f66afb6',
 };
+export const MENU_VALIDATION_FAILED_V1_WEBHOOK_EXAMPLE = {
+    orgId: 'org123',
+    brandId: 'br456',
+    propertyId: 'p789',
+    salesChannelId: 'sc123',
+    menuId: '123e4567-e89b-12d3-a456-426614174000',
+    menuPublishId: '123e4567-e89b-12d3-a456-426614174000',
+    menuRevisionId: 1,
+    error: 'Menu validation failed',
+};

package/rms/menus/events/webhook-examples.ts

@@ -361,3 +361,14 @@ export const MENU_PUBLISHED_V1_WEBHOOK_EXAMPLE = {
   menu: MENU_EXAMPLE,
   priceBandId: '13a85f64-5717-4562-b3fc-2c963f66afb6',
 };
+
+export const MENU_VALIDATION_FAILED_V1_WEBHOOK_EXAMPLE = {
+  orgId: 'org123',
+  brandId: 'br456',
+  propertyId: 'p789',
+  salesChannelId: 'sc123',
+  menuId: '123e4567-e89b-12d3-a456-426614174000',
+  menuPublishId: '123e4567-e89b-12d3-a456-426614174000',
+  menuRevisionId: 1,
+  error: 'Menu validation failed',
+};

package/rms/menus/index.js

@@ -1,6 +1,7 @@
 import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
 import { z } from 'zod';
 import MenuEventSchemas from './events/menu.published.v1.js';
+import MenuValidationFailedEventSchemas from './events/menu.validation.failed.v1.js';
 import CategoryGroupSchemas from './schemas/category-group.js';
 import CategorySchemas from './schemas/category.js';
 import ChargeSchemas from './schemas/charge.js';
@@ -27,5 +28,6 @@ export const Schemas = {
     ...TaxConfigSchemas,
     ...MenuSchemas,
     ...MenuEventSchemas,
+    ...MenuValidationFailedEventSchemas,
 };
 export default Schemas;

package/rms/menus/index.ts

@@ -1,6 +1,7 @@
 import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
 import { z } from 'zod';
 import MenuEventSchemas from './events/menu.published.v1.js';
+import MenuValidationFailedEventSchemas from './events/menu.validation.failed.v1.js';
 import CategoryGroupSchemas from './schemas/category-group.js';
 import CategorySchemas from './schemas/category.js';
 import ChargeSchemas from './schemas/charge.js';
@@ -30,6 +31,7 @@ export const Schemas = {
   ...TaxConfigSchemas,
   ...MenuSchemas,
   ...MenuEventSchemas,
+  ...MenuValidationFailedEventSchemas,
 };
 
 export default Schemas;

package/webhooks/index.js

@@ -3,6 +3,7 @@ import { eventSchemaMap as rmsSalesEventSchemaMap, eventTypes as rmsSalesEvents,
 import { eventSchemaMap as rmsSnoozeEventSchemaMap, eventTypes as rmsSnoozeEvents, } from '../rms/snoozes/index.js';
 export const webhookEventTypes = [
     rmsMenuEvents.MENU_PUBLISHED_V1,
+    rmsMenuEvents.MENU_VALIDATION_FAILED_V1,
     rmsSnoozeEvents.MENU_ITEM_SNOOZED_V1,
     rmsSnoozeEvents.MENU_ITEM_UNSNOOZED_V1,
     rmsSnoozeEvents.SALES_CHANNEL_SNOOZED_V1,

package/webhooks/index.ts

@@ -13,6 +13,7 @@ import {
 
 export const webhookEventTypes = [
   rmsMenuEvents.MENU_PUBLISHED_V1,
+  rmsMenuEvents.MENU_VALIDATION_FAILED_V1,
   rmsSnoozeEvents.MENU_ITEM_SNOOZED_V1,
   rmsSnoozeEvents.MENU_ITEM_UNSNOOZED_V1,
   rmsSnoozeEvents.SALES_CHANNEL_SNOOZED_V1,