feat(v-contexts): ref #102071 Context for embed targets of the order form in chats

Author: cmath10

packages/v1-contexts/package.json

@@ -72,6 +72,12 @@
       "remote/order/card-settings": [
         "./dist/remote/order/card-settings.d.ts"
       ],
+      "remote/order/mg": [
+        "./dist/remote/order/mg.d.ts"
+      ],
+      "remote/order/mg-settings": [
+        "./dist/remote/order/mg-settings.d.ts"
+      ],
       "remote/user/current": [
         "./dist/remote/user/current.d.ts"
       ],

packages/v1-contexts/scripts/build.meta.ts

@@ -20,16 +20,20 @@ import { keysOf } from '@/utilities'
 
 import * as customer from '@/common/customer/card'
 import * as customerPhone from '@/common/customer/card-phone'
-import * as order from '@/common/order/card'
-import * as orderSettings from '@/common/order/card-settings'
+import * as orderCard from '@/common/order/card'
+import * as orderCardSettings from '@/common/order/card-settings'
+import * as orderMg from '@/common/order/mg'
+import * as orderMgSettings from '@/common/order/mg-settings'
 import * as user from '@/common/user/current'
 import * as settings from '@/common/settings'
 
 const schema: SchemaList = {
   [customer.id]: customer.schema,
   [customerPhone.id]: customerPhone.schema,
-  [order.id]: order.schema,
-  [orderSettings.id]: orderSettings.schema,
+  [orderCard.id]: orderCard.schema,
+  [orderCardSettings.id]: orderCardSettings.schema,
+  [orderMg.id]: orderMg.schema,
+  [orderMgSettings.id]: orderMgSettings.schema,
   [user.id]: user.schema,
   [settings.id]: settings.schema,
 }
@@ -39,8 +43,10 @@ const description: {
 } = {
   [customer.id]: customer.description,
   [customerPhone.id]: customerPhone.description,
-  [order.id]: order.description,
-  [orderSettings.id]: orderSettings.description,
+  [orderCard.id]: orderCard.description,
+  [orderCardSettings.id]: orderCardSettings.description,
+  [orderMg.id]: orderMg.description,
+  [orderMgSettings.id]: orderMgSettings.description,
   [user.id]: user.description,
   [settings.id]: settings.description,
 }
@@ -50,20 +56,24 @@ const usage: {
 } = {
   [customer.id]: customer.usage,
   [customerPhone.id]: customerPhone.usage,
-  [order.id]: order.usage,
-  [orderSettings.id]: orderSettings.usage,
+  [orderCard.id]: orderCard.usage,
+  [orderCardSettings.id]: orderCardSettings.usage,
+  [orderMg.id]: orderMg.usage,
+  [orderMgSettings.id]: orderMgSettings.usage,
   [user.id]: user.usage,
   [settings.id]: settings.usage,
 }
 
 const actions: ActionSchemaList = {
-  [order.id]: order.actions,
+  [orderCard.id]: orderCard.actions,
+  [orderMg.id]: orderMg.actions,
 }
 
 const actionsDescription: {
   [K in keyof ActionSchemaList]: ObjectDescription<ActionSchemaList[K]>;
 } = {
-  [order.id]: order.actionsDescription,
+  [orderCard.id]: orderCard.actionsDescription,
+  [orderMg.id]: orderMg.actionsDescription,
 }
 
 const __dirname = dirname(fileURLToPath(import.meta.url))
@@ -153,21 +163,29 @@ const types: ObjectMeta[] = [{
 }]
 
 fs.writeFileSync(join(dist, 'meta.json'), JSON.stringify({
-  types: [...keysOf(order.typesDescription).reduce((meta, name) => {
-    const types = order.types[name]
-    const descriptions = order.typesDescription[name]
-
-    meta.push({
-      name,
-      fields: keysOf(descriptions).map(field => ({
-        name: field,
-        type: types[field],
-        description: descriptions[field],
-      })),
-    })
-
-    return meta
-  }, [] as Array<{ name: string; fields: ObjectFieldMeta[]; }>), ...types],
+  types: [
+    ...keysOf({
+      ...orderCard.typesDescription,
+      ...orderMg.typesDescription,
+    }).reduce((meta, name) => {
+      const types = { ...orderCard.types, ...orderMg.types }[name] as Record<string, string>
+      const descriptions = {
+        ...orderCard.typesDescription,
+        ...orderMg.typesDescription,
+      }[name]
+
+      meta.push({
+        name: name,
+        fields: keysOf(descriptions).map(field => ({
+          name: field as string,
+          type: types[field as string],
+          description: descriptions[field],
+        })),
+      })
+
+      return meta
+    }, [] as Array<{ name: string; fields: ObjectFieldMeta[]; }>), ...types,
+  ],
   actions: keysOf(actions).reduce((meta, scope) => {
     meta[scope] = keysOf(actions[scope]).map(name => ({
       name,

packages/v1-contexts/scripts/generate.known-types.ts

@@ -24,6 +24,11 @@ type SchemaName = string
 const schemas: Record<SchemaName, Path[]> = {
   'order/card': [
     path.resolve(__root, 'types/order/card.d.ts'),
+    path.resolve(__root, 'types/order/common.d.ts'),
+  ],
+  'order/mg': [
+    path.resolve(__root, 'types/order/mg.d.ts'),
+    path.resolve(__root, 'types/order/common.d.ts'),
   ],
 }
 

packages/v1-contexts/src/common/order/card.ts

@@ -6,7 +6,7 @@ import type {
   ContextSchemaUsage,
 } from '@retailcrm/embed-ui-v1-types/context-doc'
 
-import type { KnownTypes } from '~generated/order/card'
+import type { KnownTypes } from '~generated/order/card.d.ts'
 import type { MethodList } from '~types/order/card'
 import type { Schema } from '~types/order/card'
 
@@ -15,22 +15,26 @@ import {
   cortegeOf,
   isExactly,
   isNull,
-  isNumber, isShape,
+  isNumber,
+  isShape,
   isString,
   isVoid,
   oneOf,
 } from '@/predicates'
 
 import {
-  isCreateOrderItemInput,
-  isDiscount,
-  isItem,
   isOffer,
   isPriceType,
   isProduct,
   isProductGroup,
   isProperty,
   isStatus,
+} from '@/predicates/order/common'
+
+import {
+  isCreateOrderItemInput,
+  isDiscount,
+  isItem,
 } from '@/predicates/order/card'
 
 export const id = 'order/card'
@@ -613,6 +617,58 @@ export const typesDescription: {
       'ru-RU': 'Размер скидки',
     },
   },
+  'Offer': {
+    'id': {
+      'en-GB': 'ID',
+      'es-ES': 'ID',
+      'ru-RU': 'Идентификатор',
+    },
+    'name': {
+      'en-GB': 'Name',
+      'es-ES': 'Nombre',
+      'ru-RU': 'Наименование',
+    },
+    'image': {
+      'en-GB': 'Image URL',
+      'es-ES': 'URL de la imagen',
+      'ru-RU': 'URL изображения',
+    },
+    'dimensions': {
+      'en-GB': 'Product dimensions L - length, W - width, H - height',
+      'es-ES': 'Dimensiones del producto L - longitud, W - ancho, H - altura',
+      'ru-RU': 'Размеры товара L - длина, W - ширина, H - высота',
+    },
+    'weight': {
+      'en-GB': 'Weight',
+      'es-ES': 'Peso',
+      'ru-RU': 'Вес',
+    },
+    'article': {
+      'en-GB': 'Article',
+      'es-ES': 'Artículo',
+      'ru-RU': 'Артикул',
+    },
+    'barcode': {
+      'en-GB': 'Barcode',
+      'es-ES': 'Código de barras',
+      'ru-RU': 'Штрих-код',
+    },
+    'properties': {
+      'en-GB': 'Array of custom properties',
+      'es-ES': 'Matriz de propiedades personalizadas',
+      'ru-RU': 'Массив пользовательских свойств',
+    },
+    'unit': {
+      'en-GB': 'Unit of quantity measurement, if not specified (null), will be set to "pcs."',
+      'es-ES': 'Unidad de medida de cantidad, si no se especifica (null), se establecerá en "pcs."',
+      'ru-RU': 'Единица измерения количества, если не указана (null), будет указано "шт."',
+    },
+    'purchasePrice': {
+      'en-GB': 'Purchase price, value + currency',
+      'es-ES': 'Precio de compra, valor + moneda',
+      'ru-RU': 'Закупочная цена, значение + валюта',
+    },
+  },
   'PriceType': {
     'id': {
       'en-GB': 'ID',
@@ -726,58 +782,6 @@ export const typesDescription: {
       'ru-RU': 'Наименование',
     },
   },
-  'Offer': {
-    'id': {
-      'en-GB': 'ID',
-      'es-ES': 'ID',
-      'ru-RU': 'Идентификатор',
-    },
-    'name': {
-      'en-GB': 'Name',
-      'es-ES': 'Nombre',
-      'ru-RU': 'Наименование',
-    },
-    'image': {
-      'en-GB': 'Image URL',
-      'es-ES': 'URL de la imagen',
-      'ru-RU': 'URL изображения',
-    },
-    'dimensions': {
-      'en-GB': 'Product dimensions L - length, W - width, H - height',
-      'es-ES': 'Dimensiones del producto L - longitud, W - ancho, H - altura',
-      'ru-RU': 'Размеры товара L - длина, W - ширина, H - высота',
-    },
-    'weight': {
-      'en-GB': 'Weight',
-      'es-ES': 'Peso',
-      'ru-RU': 'Вес',
-    },
-    'article': {
-      'en-GB': 'Article',
-      'es-ES': 'Artículo',
-      'ru-RU': 'Артикул',
-    },
-    'barcode': {
-      'en-GB': 'Barcode',
-      'es-ES': 'Código de barras',
-      'ru-RU': 'Штрих-код',
-    },
-    'properties': {
-      'en-GB': 'Array of custom properties',
-      'es-ES': 'Matriz de propiedades personalizadas',
-      'ru-RU': 'Массив пользовательских свойств',
-    },
-    'unit': {
-      'en-GB': 'Unit of quantity measurement, if not specified (null), will be set to "pcs."',
-      'es-ES': 'Unidad de medida de cantidad, si no se especifica (null), se establecerá en "pcs."',
-      'ru-RU': 'Единица измерения количества, если не указана (null), будет указано "шт."',
-    },
-    'purchasePrice': {
-      'en-GB': 'Purchase price, value + currency',
-      'es-ES': 'Precio de compra, valor + moneda',
-      'ru-RU': 'Закупочная цена, значение + валюта',
-    },
-  },
   'OrderItem': {
     'id': {
       'en-GB': 'ID',

packages/v1-contexts/src/common/order/mg-settings.ts

@@ -0,0 +1,86 @@
+import type { ContextSchemaDescription } from '@retailcrm/embed-ui-v1-types/context-doc'
+import type { ContextSchemaUsage } from '@retailcrm/embed-ui-v1-types/context-doc'
+import type { Schema } from '~types/order/mg-settings'
+
+import {
+  arrayOf,
+  isBoolean,
+  isNull,
+  isString,
+  oneOf,
+} from '@/predicates'
+
+import { isStatus } from '@/predicates/order/common'
+
+export const id = 'order/mg:settings'
+
+export const schema: Schema = {
+  'defaultUnit': {
+    accepts: oneOf(isString, isNull),
+    defaults: () => null,
+    readonly: true,
+  },
+  'duplicatesAllowed': {
+    accepts: isBoolean,
+    defaults: () => false,
+    readonly: true,
+  },
+  'quantityIsFractional': {
+    accepts: isBoolean,
+    defaults: () => false,
+    readonly: true,
+  },
+  'priceEditable': {
+    accepts: isBoolean,
+    defaults: () => false,
+    readonly: true,
+  },
+  'availableStatuses': {
+    accepts: arrayOf(isStatus),
+    defaults: () => [],
+    readonly: true,
+  },
+}
+
+export const description: ContextSchemaDescription<Schema> = {
+  'defaultUnit': {
+    description: {
+      'en-GB': 'Default quantity unit of measurement',
+      'es-ES': 'Unidad de medida de cantidad predeterminada',
+      'ru-RU': 'Единица измерения количества по-умолчанию',
+    },
+  },
+  'duplicatesAllowed': {
+    description: {
+      'en-GB': 'Possibility of adding the same SKUs to the order as different items',
+      'es-ES': 'La posibilidad de añadir las mismas variantes como diferentes productos al pedido',
+      'ru-RU': 'Возможность добавлять в заказ одинаковые торговые предложения как разные позиции',
+    },
+  },
+  'quantityIsFractional': {
+    description: {
+      'en-GB': 'Integer or fractional quantity of items',
+      'es-ES': 'Cantidad entera o fraccionada de productos',
+      'ru-RU': 'Целое или дробное количество товара',
+    },
+  },
+  'priceEditable': {
+    description: {
+      'en-GB': 'Ability to edit item prices',
+      'es-ES': 'Capacidad de editar precios de artículos',
+      'ru-RU': 'Возможность редактировать цену товарных позиций',
+    },
+  },
+  'availableStatuses': {
+    description: {
+      'en-GB': 'List of available order item statuses',
+      'es-ES': 'Lista de estados disponibles de los artículos del pedido',
+      'ru-RU': 'Доступные статусы товарных позиций заказа',
+    },
+  },
+}
+
+export const usage: ContextSchemaUsage = {
+  import: 'import { useContext } from \'@retailcrm/embed-ui-v1-contexts/remote/order/mg-settings\'',
+  call: 'const orderSettings = useContext()',
+}