@retailcrm/embed-ui-v1-contexts 0.4.4

package/dist/meta.json

@@ -0,0 +1,442 @@
+{
+  "customer/card": {
+    "fields": [
+      {
+        "name": "id",
+        "type": "number | null",
+        "description": {
+          "en-GB": "Customer ID",
+          "es-ES": "ID del cliente",
+          "ru-RU": "ID клиента"
+        },
+        "readonly": true
+      },
+      {
+        "name": "externalId",
+        "type": "string",
+        "description": {
+          "en-GB": "Customer external ID",
+          "es-ES": "ID externo del cliente",
+          "ru-RU": "Внешний ID клиента"
+        },
+        "readonly": true
+      },
+      {
+        "name": "email",
+        "type": "string",
+        "description": {
+          "en-GB": "Customer email",
+          "es-ES": "Correo electrónico del cliente",
+          "ru-RU": "Email клиента"
+        },
+        "readonly": true
+      },
+      {
+        "name": "phones",
+        "type": "Array<string>",
+        "description": {
+          "en-GB": "Customer phone list",
+          "es-ES": "Lista de teléfonos del cliente",
+          "ru-RU": "Список телефонов клиента"
+        },
+        "readonly": true
+      }
+    ],
+    "usage": {
+      "import": "import { useContext } from '@retailcrm/embed-ui-v1-contexts/remote/customer/card'",
+      "call": "const customer = useContext()"
+    }
+  },
+  "customer/card:phone": {
+    "fields": [
+      {
+        "name": "value",
+        "type": "string",
+        "description": {
+          "en-GB": "Customer phone",
+          "es-ES": "Teléfono del cliente",
+          "ru-RU": "Телефон клиента"
+        },
+        "readonly": true
+      },
+      {
+        "name": "index",
+        "type": "number",
+        "description": {
+          "en-GB": "Serial number of the phone in the list",
+          "es-ES": "Número de serie del teléfono en la lista",
+          "ru-RU": "Порядковый номер телефона в списке"
+        },
+        "readonly": true
+      }
+    ],
+    "usage": {
+      "import": "import { useContext } from '@retailcrm/embed-ui-v1-contexts/remote/customer/card-phone'",
+      "call": "const phone = useContext()"
+    }
+  },
+  "order/card": {
+    "fields": [
+      {
+        "name": "id",
+        "type": "number | null",
+        "description": {
+          "en-GB": "Order ID in CRM",
+          "es-ES": "ID del pedido en CRM",
+          "ru-RU": "Идентификатор заказа в CRM"
+        },
+        "readonly": true
+      },
+      {
+        "name": "externalId",
+        "type": "string | null",
+        "description": {
+          "en-GB": "The order ID in the external source system",
+          "es-ES": "El ID del pedido en el sistema de origen externo",
+          "ru-RU": "Идентифкатор заказа во внешней системе источника"
+        },
+        "readonly": true
+      },
+      {
+        "name": "type",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Order type code",
+          "es-ES": "Código del tipo de pedido",
+          "ru-RU": "Код типа заказа"
+        },
+        "readonly": true
+      },
+      {
+        "name": "site",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Store code associated with the order",
+          "es-ES": "Código de la tienda asociado al pedido",
+          "ru-RU": "Код магазина, к которому относится заказ"
+        },
+        "readonly": true
+      },
+      {
+        "name": "number",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Displayed order number",
+          "es-ES": "Número de pedido mostrado",
+          "ru-RU": "Отображаемый номер заказа"
+        },
+        "readonly": true
+      },
+      {
+        "name": "customer.type",
+        "type": "\"customer\" | \"customer_corporate\"",
+        "description": {
+          "en-GB": "Client type",
+          "es-ES": "Tipo de cliente",
+          "ru-RU": "Тип клиента"
+        },
+        "readonly": true
+      },
+      {
+        "name": "customer.lastName",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Client last name",
+          "es-ES": "Apellido del cliente",
+          "ru-RU": "Фамилия клиента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "customer.firstName",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Client name",
+          "es-ES": "Nombre del cliente",
+          "ru-RU": "Имя клиента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "customer.patronymic",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Patronymic of the client",
+          "es-ES": "Patronímico del cliente",
+          "ru-RU": "Отчество клиента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "customer.phone",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Customer phone",
+          "es-ES": "Teléfono del cliente",
+          "ru-RU": "Телефон клиента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "customer.email",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Customer email",
+          "es-ES": "Correo electrónico del cliente",
+          "ru-RU": "Email клиента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "country",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Character code of the country",
+          "es-ES": "Código de caracteres del país",
+          "ru-RU": "Символьный код страны"
+        },
+        "readonly": true
+      },
+      {
+        "name": "currency",
+        "type": "string",
+        "description": {
+          "en-GB": "Currency code",
+          "es-ES": "Código de moneda",
+          "ru-RU": "Символьный код валюты"
+        },
+        "readonly": true
+      },
+      {
+        "name": "status",
+        "type": "string",
+        "description": {
+          "en-GB": "Order status",
+          "es-ES": "Estado del pedido",
+          "ru-RU": "Статус заказа"
+        },
+        "readonly": true
+      },
+      {
+        "name": "company.name",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Company's name",
+          "es-ES": "Nombre de la empresa",
+          "ru-RU": "Название компании"
+        },
+        "readonly": false
+      },
+      {
+        "name": "company.legalName",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Full name of the company",
+          "es-ES": "Nombre completo de la empresa",
+          "ru-RU": "Полное наименование компании"
+        },
+        "readonly": false
+      },
+      {
+        "name": "company.legalAddress",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Company's registration address",
+          "es-ES": "Dirección de registro de la empresa",
+          "ru-RU": "Адрес регистрации компании"
+        },
+        "readonly": false
+      },
+      {
+        "name": "company.INN",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Counterparty's INN",
+          "es-ES": "INN del contraparte",
+          "ru-RU": "ИНН контрагента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "company.OKPO",
+        "type": "string | null",
+        "description": {
+          "en-GB": "OKPO of the counterparty",
+          "es-ES": "OKPO del contraparte",
+          "ru-RU": "ОКПО контрагента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "company.BIK",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Counterparty's BIC",
+          "es-ES": "BIC del contraparte",
+          "ru-RU": "БИК контрагента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "company.bank",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Counterparty's bank",
+          "es-ES": "Banco del contraparte",
+          "ru-RU": "Банк контрагента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "company.bankAddress",
+        "type": "string | null",
+        "description": {
+          "en-GB": "The address of the counterparty's bank",
+          "es-ES": "Dirección del banco del contraparte",
+          "ru-RU": "Адрес банка контрагента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "company.corrAccount",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Correspondent account of the counterparty",
+          "es-ES": "Cuenta corresponsal del contraparte",
+          "ru-RU": "Корреспондентский счет контрагента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "company.bankAccount",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Counterparty's current account",
+          "es-ES": "Cuenta corriente del contraparte",
+          "ru-RU": "Расчетный счет контрагента"
+        },
+        "readonly": false
+      },
+      {
+        "name": "delivery.address",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Delivery address",
+          "es-ES": "Dirección de entrega",
+          "ru-RU": "Адрес доставки"
+        },
+        "readonly": false
+      }
+    ],
+    "usage": {
+      "import": "import { useContext } from '@retailcrm/embed-ui-v1-contexts/remote/order/card'",
+      "call": "const order = useContext()"
+    }
+  },
+  "user/current": {
+    "fields": [
+      {
+        "name": "id",
+        "type": "number | null",
+        "description": {
+          "en-GB": "User ID",
+          "es-ES": "ID del usuario",
+          "ru-RU": "ID пользователя"
+        },
+        "readonly": true
+      },
+      {
+        "name": "email",
+        "type": "string",
+        "description": {
+          "en-GB": "User email",
+          "es-ES": "Correo electrónico del usuario",
+          "ru-RU": "Email пользователя"
+        },
+        "readonly": true
+      },
+      {
+        "name": "firstName",
+        "type": "string | null",
+        "description": {
+          "en-GB": "User name",
+          "es-ES": "Nombre del usuario",
+          "ru-RU": "Имя пользователя"
+        },
+        "readonly": true
+      },
+      {
+        "name": "lastName",
+        "type": "string | null",
+        "description": {
+          "en-GB": "User last name",
+          "es-ES": "Apellido del usuario",
+          "ru-RU": "Фамилия пользователя"
+        },
+        "readonly": true
+      },
+      {
+        "name": "patronymic",
+        "type": "string | null",
+        "description": {
+          "en-GB": "Patronymic of the user",
+          "es-ES": "Patronímico del usuario",
+          "ru-RU": "Отчество пользователя"
+        },
+        "readonly": true
+      },
+      {
+        "name": "photo",
+        "type": "string | null",
+        "description": {
+          "en-GB": "User photo",
+          "es-ES": "Foto del usuario",
+          "ru-RU": "Фото пользователя"
+        },
+        "readonly": true
+      },
+      {
+        "name": "groups",
+        "type": "Array<string>",
+        "description": {
+          "en-GB": "Symbolic codes of the groups the user belongs to",
+          "es-ES": "Códigos simbólicos de los grupos a los que pertenece el usuario",
+          "ru-RU": "Символьные коды групп, в которых состоит пользователь"
+        },
+        "readonly": true
+      },
+      {
+        "name": "permissions",
+        "type": "Array<string>",
+        "description": {
+          "en-GB": "Character codes of available user permissions",
+          "es-ES": "Códigos de caracteres de los permisos disponibles para el usuario",
+          "ru-RU": "Символьные коды доступных пользователю разрешений"
+        },
+        "readonly": true
+      }
+    ],
+    "usage": {
+      "import": "import { useContext } from '@retailcrm/embed-ui-v1-contexts/remote/user/current'",
+      "call": "const user = useContext()"
+    }
+  },
+  "settings": {
+    "fields": [
+      {
+        "name": "system.locale",
+        "type": "\"en-GB\" | \"es-ES\" | \"ru-RU\"",
+        "description": {
+          "en-GB": "Current system's locale",
+          "es-ES": "Configuración regional actual del sistema",
+          "ru-RU": "Текущая локаль системы"
+        },
+        "readonly": true
+      }
+    ],
+    "usage": {
+      "import": "import { useContext } from '@retailcrm/embed-ui-v1-contexts/remote/settings'",
+      "call": "const settings = useContext()"
+    }
+  }
+}

package/dist/predicates.cjs.js

@@ -0,0 +1,28 @@
+"use strict";
+const withMeta = (predicate, type) => {
+  return Object.assign(predicate, { type });
+};
+const isExactly = (expected) => {
+  return withMeta((value) => value === expected, JSON.stringify(expected));
+};
+const isNull = withMeta((value) => value === null, "null");
+const isNumber = withMeta((value) => typeof value === "number", "number");
+const isString = withMeta((value) => typeof value === "string", "string");
+const arrayOf = (predicate) => withMeta(
+  (value) => {
+    return Array.isArray(value) && value.every(predicate);
+  },
+  `Array<${predicate.type}>`
+);
+const oneOf = (...predicates) => withMeta(
+  (value) => {
+    return predicates.some((predicate) => predicate(value));
+  },
+  predicates.map((p) => p.type).join(" | ")
+);
+exports.arrayOf = arrayOf;
+exports.isExactly = isExactly;
+exports.isNull = isNull;
+exports.isNumber = isNumber;
+exports.isString = isString;
+exports.oneOf = oneOf;

package/dist/predicates.d.ts

@@ -0,0 +1,11 @@
+export type Predicate<T = unknown> = (value: unknown) => value is T;
+export type PredicateWithMeta<T = unknown> = Predicate<T> & {
+    type: string;
+};
+export declare const withMeta: <T>(predicate: Predicate<T>, type: string) => PredicateWithMeta<T>;
+export declare const isExactly: <T extends string | number>(expected: T) => PredicateWithMeta<T>;
+export declare const isNull: PredicateWithMeta<null>;
+export declare const isNumber: PredicateWithMeta<number>;
+export declare const isString: PredicateWithMeta<string>;
+export declare const arrayOf: <T>(predicate: PredicateWithMeta<T>) => PredicateWithMeta<T[]>;
+export declare const oneOf: (...predicates: PredicateWithMeta[]) => PredicateWithMeta<unknown>;

package/dist/predicates.es.js

@@ -0,0 +1,29 @@
+const withMeta = (predicate, type) => {
+  return Object.assign(predicate, { type });
+};
+const isExactly = (expected) => {
+  return withMeta((value) => value === expected, JSON.stringify(expected));
+};
+const isNull = withMeta((value) => value === null, "null");
+const isNumber = withMeta((value) => typeof value === "number", "number");
+const isString = withMeta((value) => typeof value === "string", "string");
+const arrayOf = (predicate) => withMeta(
+  (value) => {
+    return Array.isArray(value) && value.every(predicate);
+  },
+  `Array<${predicate.type}>`
+);
+const oneOf = (...predicates) => withMeta(
+  (value) => {
+    return predicates.some((predicate) => predicate(value));
+  },
+  predicates.map((p) => p.type).join(" | ")
+);
+export {
+  arrayOf as a,
+  isNull as b,
+  isNumber as c,
+  isExactly as d,
+  isString as i,
+  oneOf as o
+};

package/dist/remote/customer/card-phone.cjs

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const remote = require("../../remote.cjs");
+const predicates = require("../../predicates.cjs.js");
+const id = "customer/card:phone";
+const schema = {
+  value: {
+    accepts: predicates.isString,
+    defaults: () => "",
+    readonly: true
+  },
+  index: {
+    accepts: predicates.isNumber,
+    defaults: () => 0,
+    readonly: true
+  }
+};
+const useContext = remote.defineContext(id, schema);
+exports.schema = schema;
+exports.useContext = useContext;

package/dist/remote/customer/card-phone.d.ts

@@ -0,0 +1,12 @@
+import { schema } from '../../common/customer/card-phone';
+import { StoreDefinition } from 'pinia';
+import { Context, TypeOf, RejectionHandler } from '@retailcrm/embed-ui-v1-types/context';
+import { Schema } from '../../../types/customer/card-phone';
+import { Maybe } from '@retailcrm/embed-ui-v1-types/scaffolding';
+export { schema };
+export declare const useContext: StoreDefinition<"customer/card:phone", Context<Schema>, {
+    schema: () => Schema;
+}, {
+    initialize(): Promise<void>;
+    set<F extends never>(field: F, value: TypeOf< Schema[F]>, onReject?: Maybe<RejectionHandler>): void;
+}>;

package/dist/remote/customer/card-phone.js

@@ -0,0 +1,20 @@
+import { defineContext } from "../../remote.js";
+import { i as isString, c as isNumber } from "../../predicates.es.js";
+const id = "customer/card:phone";
+const schema = {
+  value: {
+    accepts: isString,
+    defaults: () => "",
+    readonly: true
+  },
+  index: {
+    accepts: isNumber,
+    defaults: () => 0,
+    readonly: true
+  }
+};
+const useContext = defineContext(id, schema);
+export {
+  schema,
+  useContext
+};

package/dist/remote/customer/card.cjs

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const remote = require("../../remote.cjs");
+const predicates = require("../../predicates.cjs.js");
+const id = "customer/card";
+const schema = {
+  "id": {
+    accepts: predicates.oneOf(predicates.isNumber, predicates.isNull),
+    defaults: () => null,
+    readonly: true
+  },
+  "externalId": {
+    accepts: predicates.isString,
+    defaults: () => null,
+    readonly: true
+  },
+  "email": {
+    accepts: predicates.isString,
+    defaults: () => "",
+    readonly: true
+  },
+  "phones": {
+    accepts: predicates.arrayOf(predicates.isString),
+    defaults: () => [],
+    readonly: true
+  }
+};
+const useContext = remote.defineContext(id, schema);
+exports.schema = schema;
+exports.useContext = useContext;

package/dist/remote/customer/card.d.ts

@@ -0,0 +1,12 @@
+import { schema } from '../../common/customer/card';
+import { StoreDefinition } from 'pinia';
+import { Context, TypeOf, RejectionHandler } from '@retailcrm/embed-ui-v1-types/context';
+import { Schema } from '../../../types/customer/card';
+import { Maybe } from '@retailcrm/embed-ui-v1-types/scaffolding';
+export { schema };
+export declare const useContext: StoreDefinition<"customer/card", Context<Schema>, {
+    schema: () => Schema;
+}, {
+    initialize(): Promise<void>;
+    set<F extends never>(field: F, value: TypeOf< Schema[F]>, onReject?: Maybe<RejectionHandler>): void;
+}>;

package/dist/remote/customer/card.js

@@ -0,0 +1,30 @@
+import { defineContext } from "../../remote.js";
+import { o as oneOf, i as isString, a as arrayOf, b as isNull, c as isNumber } from "../../predicates.es.js";
+const id = "customer/card";
+const schema = {
+  "id": {
+    accepts: oneOf(isNumber, isNull),
+    defaults: () => null,
+    readonly: true
+  },
+  "externalId": {
+    accepts: isString,
+    defaults: () => null,
+    readonly: true
+  },
+  "email": {
+    accepts: isString,
+    defaults: () => "",
+    readonly: true
+  },
+  "phones": {
+    accepts: arrayOf(isString),
+    defaults: () => [],
+    readonly: true
+  }
+};
+const useContext = defineContext(id, schema);
+export {
+  schema,
+  useContext
+};