@retailcrm/embed-ui 0.4.1-alpha.9 → 0.4.1-beta.2

package/CHANGELOG.md

@@ -1,6 +1,73 @@
 # Changelog
 
 
+## [0.4.1-beta.2](https://github.com/retailcrm/embed-ui/compare/v0.4.1-beta.1...v0.4.1-beta.2) (2024-11-29)
+
+### Features
+
+* Replaced typeCode / siteCode with type / site in order/card schema ([102124b](https://github.com/retailcrm/embed-ui/commit/102124b2a591f034a89a53976b094979985fc48a))
+## [0.4.1-beta.1](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.25...v0.4.1-beta.1) (2024-11-29)
+
+### Features
+
+* Added typeCode / siteCode to order/card schema ([c3c4a27](https://github.com/retailcrm/embed-ui/commit/c3c4a278497aceb179791a5476df08a7666d36fa))
+
+### Bug Fixes
+
+* **v1-components:** Styles of ellipsis modifier of UiLink ([c3b2189](https://github.com/retailcrm/embed-ui/commit/c3b2189712a036bec982360f1e7fcccd75038423))
+## [0.4.1-alpha.25](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.24...v0.4.1-alpha.25) (2024-11-28)
+## [0.4.1-alpha.24](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.23...v0.4.1-alpha.24) (2024-11-28)
+## [0.4.1-alpha.23](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.22...v0.4.1-alpha.23) (2024-11-28)
+## [0.4.1-alpha.22](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.21...v0.4.1-alpha.22) (2024-11-28)
+
+### Bug Fixes
+
+* **v1-components:** Added slot 'icon' to remote UiLink definition ([c15bd98](https://github.com/retailcrm/embed-ui/commit/c15bd989d0c1ed08f185b35104e09e678e90dfb6))
+## [0.4.1-alpha.21](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.20...v0.4.1-alpha.21) (2024-11-27)
+
+### Bug Fixes
+
+* **v1-components:** Missing VueI18n export ([ed6ef3a](https://github.com/retailcrm/embed-ui/commit/ed6ef3ab50a5879c18b205d24db0c3c9c9da537a))
+## [0.4.1-alpha.20](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.19...v0.4.1-alpha.20) (2024-11-27)
+
+### Bug Fixes
+
+* **v1-components:** Missing i18n plugin ([635b839](https://github.com/retailcrm/embed-ui/commit/635b839b0d533e00c04fba00e8293b4793bd0b42))
+## [0.4.1-alpha.19](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.18...v0.4.1-alpha.19) (2024-11-27)
+
+### Features
+
+* Added field 'photo' to 'user/current' context ([4d6aece](https://github.com/retailcrm/embed-ui/commit/4d6aece931d23ad74d2afa54fcfc1cc821846ca2))
+## [0.4.1-alpha.18](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.17...v0.4.1-alpha.18) (2024-11-27)
+
+### Bug Fixes
+
+* Missing components info for remote root ([ee0cf4a](https://github.com/retailcrm/embed-ui/commit/ee0cf4a33d5f9fe41462f66eb65b1715081cd8c8))
+## [0.4.1-alpha.17](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.16...v0.4.1-alpha.17) (2024-11-27)
+## [0.4.1-alpha.16](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.15...v0.4.1-alpha.16) (2024-11-27)
+
+### Bug Fixes
+
+* **v1-components:** exports configuration ([4756f47](https://github.com/retailcrm/embed-ui/commit/4756f4723afb79238c4f543bc8ddabebd55411d1))
+## [0.4.1-alpha.15](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.14...v0.4.1-alpha.15) (2024-11-26)
+
+### Bug Fixes
+
+* Types across schemas, removed artifacts from unsuccessful rebase ([d34514d](https://github.com/retailcrm/embed-ui/commit/d34514df0e6fcdd9b0e9a1a2e9c909e299138284))
+## [0.4.1-alpha.14](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.13...v0.4.1-alpha.14) (2024-11-26)
+## [0.4.1-alpha.13](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.12...v0.4.1-alpha.13) (2024-11-26)
+## [0.4.1-alpha.12](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.11...v0.4.1-alpha.12) (2024-11-26)
+## [0.4.1-alpha.11](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.10...v0.4.1-alpha.11) (2024-11-26)
+
+### Features
+
+* **v1-components:** Added links validator for UiButton and UiLink ([94788df](https://github.com/retailcrm/embed-ui/commit/94788df863f1c25d80ec5ad537fe40b2b10d27ef))
+* **v1-components:** Added UiToolbar, UiToolbarButton and UiToolbarLink ([2bba2b5](https://github.com/retailcrm/embed-ui/commit/2bba2b5ba422ced4649f4d634672b3fdf52c8b01))
+## [0.4.1-alpha.10](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.9...v0.4.1-alpha.10) (2024-11-26)
+
+### Bug Fixes
+
+* Missing import of ReadonlyField ([5a068ce](https://github.com/retailcrm/embed-ui/commit/5a068cead28bb40ee5c2b66116c4ae615b9661ad))
 ## [0.4.1-alpha.9](https://github.com/retailcrm/embed-ui/compare/v0.4.1-alpha.8...v0.4.1-alpha.9) (2024-11-26)
 
 ### Bug Fixes

package/README.md

@@ -7,47 +7,3 @@ API и компоненты для создания расширений инт
 Цели встраивания определяют места, где будет размещена разметка виджета, генерируемая расширением.
 
 https://docs.retailcrm.ru/Developers/modules/PublishingModuleMarketplace/JsModulesTargets
-
-## Контексты
-
-Предоставляют данные из системы, реактивны.
-
-### `customer/card`
-
-Данные карточки клиента
-
-```typescript
-import { useCustomerCardContext } from '@retailcrm/embed-ui'
-
-const customer = useCustomerCardContext()
-```
-
-### `customer/card:phone`
-
-Данные телефона клиента
-
-```typescript
-import { useCustomerCardPhoneContext } from '@retailcrm/embed-ui'
-
-const phone = useCustomerCardPhoneContext()
-```
-
-### `order/card`
-
-Данные карточки заказа
-
-```typescript
-import { useOrderCardContext } from '@retailcrm/embed-ui'
-
-const order = useOrderCardContext()
-```
-
-### `settings`
-
-Настройки CRM
-
-```typescript
-import { useSettingsContext } from '@retailcrm/embed-ui'
-
-const settings = useSettingsContext()
-```

package/dist/index.cjs

@@ -56,6 +56,9 @@ const defineContext = (id, schema2) => {
 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");
@@ -97,6 +100,16 @@ const schema$4 = {
     defaults: () => null,
     readonly: true
   },
+  "photo": {
+    accepts: oneOf(isString, isNull),
+    defaults: () => null,
+    readonly: true
+  },
+  "groups": {
+    accepts: arrayOf(isString),
+    defaults: () => [],
+    readonly: true
+  },
   "permissions": {
     accepts: arrayOf(isString),
     defaults: () => [],
@@ -151,15 +164,28 @@ const schema$1 = {
     defaults: () => null,
     readonly: true
   },
+  "type": {
+    accepts: oneOf(isString, isNull),
+    defaults: () => null,
+    readonly: true
+  },
+  "site": {
+    accepts: oneOf(isString, isNull),
+    defaults: () => null,
+    readonly: true
+  },
   "number": {
     accepts: oneOf(isString, isNull),
     defaults: () => null,
     readonly: true
   },
   "customer.type": {
-    accepts: oneOf(isNumber, isNull),
-    defaults: () => null,
-    readonly: false
+    accepts: oneOf(
+      isExactly("customer"),
+      isExactly("customer_corporate")
+    ),
+    defaults: () => "customer",
+    readonly: true
   },
   "customer.lastName": {
     accepts: oneOf(isString, isNull),
@@ -259,13 +285,9 @@ const schema$1 = {
 };
 const useContext$1 = defineContext("order/card", schema$1);
 const locales = ["en-GB", "es-ES", "ru-RU"];
-const isLocale = withMeta(
-  (value) => locales.includes(value),
-  locales.map((l) => `'${l}'`).join(" | ")
-);
 const schema = {
   "system.locale": {
-    accepts: isLocale,
+    accepts: oneOf(...locales.map(isExactly)),
     defaults: () => "en-GB",
     readonly: true
   }
@@ -275,11 +297,10 @@ const useField = (store, field) => {
   if (store.schema[field].readonly) {
     return vue.computed(() => store[field]);
   }
+  const set = store.set;
   return vue.computed({
     get: () => store[field],
-    set: (value) => {
-      store.set(field, value);
-    }
+    set: (value) => set(field, value)
   });
 };
 const useInternal = pinia.defineStore("@retailcrm/embed-ui/_internal", {});
@@ -298,13 +319,13 @@ const createRoot = async (channel) => {
       "UiError",
       "UiLink",
       "UiLoader",
-      "UiMenuItem",
-      "UiMenuItemGroup",
       "UiModalSidebar",
       "UiModalWindow",
       "UiModalWindowSurface",
       "UiScrollBox",
       "UiTag",
+      "UiToolbarButton",
+      "UiToolbarLink",
       "UiTransition",
       "CrmYandexMap"
     ]

package/dist/index.mjs

@@ -54,6 +54,9 @@ const defineContext = (id, schema2) => {
 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");
@@ -95,6 +98,16 @@ const schema$4 = {
     defaults: () => null,
     readonly: true
   },
+  "photo": {
+    accepts: oneOf(isString, isNull),
+    defaults: () => null,
+    readonly: true
+  },
+  "groups": {
+    accepts: arrayOf(isString),
+    defaults: () => [],
+    readonly: true
+  },
   "permissions": {
     accepts: arrayOf(isString),
     defaults: () => [],
@@ -149,15 +162,28 @@ const schema$1 = {
     defaults: () => null,
     readonly: true
   },
+  "type": {
+    accepts: oneOf(isString, isNull),
+    defaults: () => null,
+    readonly: true
+  },
+  "site": {
+    accepts: oneOf(isString, isNull),
+    defaults: () => null,
+    readonly: true
+  },
   "number": {
     accepts: oneOf(isString, isNull),
     defaults: () => null,
     readonly: true
   },
   "customer.type": {
-    accepts: oneOf(isNumber, isNull),
-    defaults: () => null,
-    readonly: false
+    accepts: oneOf(
+      isExactly("customer"),
+      isExactly("customer_corporate")
+    ),
+    defaults: () => "customer",
+    readonly: true
   },
   "customer.lastName": {
     accepts: oneOf(isString, isNull),
@@ -257,13 +283,9 @@ const schema$1 = {
 };
 const useContext$1 = defineContext("order/card", schema$1);
 const locales = ["en-GB", "es-ES", "ru-RU"];
-const isLocale = withMeta(
-  (value) => locales.includes(value),
-  locales.map((l) => `'${l}'`).join(" | ")
-);
 const schema = {
   "system.locale": {
-    accepts: isLocale,
+    accepts: oneOf(...locales.map(isExactly)),
     defaults: () => "en-GB",
     readonly: true
   }
@@ -273,11 +295,10 @@ const useField = (store, field) => {
   if (store.schema[field].readonly) {
     return computed(() => store[field]);
   }
+  const set = store.set;
   return computed({
     get: () => store[field],
-    set: (value) => {
-      store.set(field, value);
-    }
+    set: (value) => set(field, value)
   });
 };
 const useInternal = defineStore("@retailcrm/embed-ui/_internal", {});
@@ -296,13 +317,13 @@ const createRoot = async (channel) => {
       "UiError",
       "UiLink",
       "UiLoader",
-      "UiMenuItem",
-      "UiMenuItemGroup",
       "UiModalSidebar",
       "UiModalWindow",
       "UiModalWindowSurface",
       "UiScrollBox",
       "UiTag",
+      "UiToolbarButton",
+      "UiToolbarLink",
       "UiTransition",
       "CrmYandexMap"
     ]

package/dist/meta.json

@@ -1,67 +1,5 @@
 {
   "contexts": {
-    "user/current": [
-      {
-        "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": "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
-      }
-    ],
     "customer/card": [
       {
         "name": "id",
@@ -147,6 +85,26 @@
         },
         "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",
@@ -159,13 +117,13 @@
       },
       {
         "name": "customer.type",
-        "type": "number | null",
+        "type": "\"customer\" | \"customer_corporate\"",
         "description": {
           "en-GB": "Client type",
           "es-ES": "Tipo de cliente",
           "ru-RU": "Тип клиента"
         },
-        "readonly": false
+        "readonly": true
       },
       {
         "name": "customer.lastName",
@@ -358,10 +316,92 @@
         "readonly": false
       }
     ],
+    "user/current": [
+      {
+        "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
+      }
+    ],
     "settings": [
       {
         "name": "system.locale",
-        "type": "'en-GB' | 'es-ES' | 'ru-RU'",
+        "type": "\"en-GB\" | \"es-ES\" | \"ru-RU\"",
         "description": {
           "en-GB": "Current system's locale",
           "es-ES": "Configuración regional actual del sistema",
@@ -507,9 +547,9 @@
         "ru-RU": "Виджет для списка позиций заказа"
       },
       "location": {
-        "en-GB": "[Temporary unavailable]",
-        "es-ES": "[Temporalmente no disponible]",
-        "ru-RU": "[Временно недоступен]"
+        "en-GB": "Section start, right above the input fields",
+        "es-ES": "Inicio de la sección, justo encima de los campos de entrada",
+        "ru-RU": "Начало секции, над полями ввода"
       },
       "contexts": [
         "order/card",

package/index.d.ts

@@ -18,7 +18,10 @@ import type { TypeOf } from './types/context/schema'
 import type { WidgetRunner } from './types/widget'
 import type { WritableComputedRef } from 'vue'
 
-declare type Computed<S extends ContextSchema, F extends keyof S> = IsReadonly<S[F]> extends true ? ComputedRef<TypeOf<S[F]>> : WritableComputedRef<TypeOf<S[F]>>;
+declare type Computed<
+  S extends ContextSchema,
+  F extends keyof S
+> = IsReadonly<S[F]> extends true ? ComputedRef<TypeOf<S[F]>> : WritableComputedRef<TypeOf<S[F]>>;
 
 export declare const createWidgetEndpoint: (
   widget: WidgetRunner,
@@ -42,7 +45,7 @@ export type ContextStoreDefinition<
   Id extends string,
   S extends ContextSchema
 > = StoreDefinition<Id, Context<S>, {
-  schema: () => S;
+  schema(): S;
 }, {
   initialize(): Promise<void>;
   set<F extends keyof S>(field: F, value: TypeOf<S[F]>): void;
@@ -51,7 +54,7 @@ export type ContextStoreDefinition<
 export declare const useCustomerCardContext: ContextStoreDefinition<'customer/card', CustomerCardSchema>
 export declare const useCustomerCardPhoneContext: ContextStoreDefinition<'customer/card:phone', CustomerCardPhoneSchema>
 export declare const useOrderCardContext: ContextStoreDefinition<'order/card', OrderCardSchema>
-export declare const useCurrentUserContext = DefineStore<'user/current', CurrentUserSchema>
+export declare const useCurrentUserContext: ContextStoreDefinition<'user/current', CurrentUserSchema>
 export declare const useSettingsContext: ContextStoreDefinition<'settings', SettingsSchema>
 
 export declare const useField: <S extends ContextSchema, F extends keyof S>(

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@retailcrm/embed-ui",
   "type": "module",
-  "version": "0.4.1-alpha.9",
+  "version": "0.4.1-beta.2",
   "description": "API and components for creating RetailCRM UI extensions",
   "repository": "git@github.com:retailcrm/embed-ui.git",
   "author": "RetailDriverLLC <integration@retailcrm.ru>",

package/types/context/index.d.ts

@@ -1,13 +1,13 @@
-import type { Schema as CurrentUserSchema } from './user/current'
 import type { Schema as CustomerCardSchema } from './customer/card'
 import type { Schema as CustomerCardPhoneSchema } from './customer/card-phone'
 import type { Schema as OrderCardSchema } from './order/card'
+import type { Schema as CurrentUserSchema } from './user/current'
 import type { Schema as SettingsSchema } from './settings'
 
 export type SchemaList = {
-  'user/current': CurrentUserSchema;
   'customer/card': CustomerCardSchema;
   'customer/card:phone': CustomerCardPhoneSchema;
   'order/card': OrderCardSchema;
+  'user/current': CurrentUserSchema;
   'settings': SettingsSchema;
 }

package/types/context/order/card.d.ts

@@ -1,10 +1,12 @@
-import type { Field } from '../schema'
+import type { Field, ReadonlyField } from '../schema'
 
 export type Schema = {
   'id': ReadonlyField<number | null>;
   'externalId': ReadonlyField<string | null>;
+  'type': ReadonlyField<string | null>;
+  'site': ReadonlyField<string | null>;
   'number': ReadonlyField<string | null>;
-  'customer.type': ReadonlyField<number | null>;
+  'customer.type': ReadonlyField<'customer' | 'customer_corporate'>;
   'customer.lastName': Field<string | null>;
   'customer.firstName': Field<string | null>;
   'customer.patronymic': Field<string | null>;

package/types/context/settings.d.ts

@@ -1,9 +1,6 @@
 import type { ReadonlyField } from './schema'
 
 export type Locale = 'en-GB' | 'es-ES' | 'ru-RU'
-
 export type Schema = {
-  'order.templates.number.api': ReadonlyField<string>;
-  'order.templates.number.crm': ReadonlyField<string>;
   'system.locale': ReadonlyField<Locale>;
 }

package/types/context/user/current.d.ts

@@ -3,8 +3,10 @@ import type { ReadonlyField } from '../schema'
 export type Schema = {
   'id': ReadonlyField<number | null>;
   'email': ReadonlyField<string>;
-  'firstName': ReadonlyField<number | null>;
+  'firstName': ReadonlyField<string | null>;
   'lastName': ReadonlyField<string | null>;
-  'patronymic': ReadonlyField<number | null>;
+  'patronymic': ReadonlyField<string | null>;
+  'photo': ReadonlyField<string | null>;
+  'groups': ReadonlyField<string[]>;
   'permissions': ReadonlyField<string[]>;
 }