@retailcrm/embed-ui-v1-contexts 0.5.2 → 0.5.3

package/dist/host.cjs

@@ -81,26 +81,89 @@ const createContextAccessor = (accessors, onError = null) => {
     }
   };
 };
+const createCustomContextAccessor = (accessors, queryDictionary = null, onError = null) => {
+  const _accessors = accessors.reduce((all, a) => {
+    all[a.schema.entity] = a;
+    return all;
+  }, {});
+  const guard = (entity) => {
+    if (!(entity in _accessors)) {
+      throw new LogicalError(`No custom context for entity ${String(entity)}`);
+    }
+  };
+  return {
+    getCustomSchema(entity, onReject = null) {
+      return run(() => {
+        guard(entity);
+        return _accessors[entity].schema;
+      }, onReject, onError) ?? null;
+    },
+    async getCustomDictionary(code, parameters, onReject) {
+      return await runAsync(() => {
+        if (!queryDictionary) {
+          throw new LogicalError("No dictionary source provided");
+        }
+        return queryDictionary(code, parameters);
+      }, onReject, onError) ?? [];
+    },
+    getCustomField(entity, code, onReject = null) {
+      return run(() => {
+        guard(entity);
+        return _accessors[entity].get(code);
+      }, onReject, onError) ?? null;
+    },
+    setCustomField(entity, code, value, onReject = null) {
+      return run(() => {
+        guard(entity);
+        _accessors[entity].set(code, value);
+      }, onReject, onError);
+    },
+    onCustomFieldChange(entity, code, handler, onReject = null) {
+      return run(() => {
+        guard(entity);
+        return _accessors[entity].onChange(code, handler);
+      }, onReject, onError);
+    }
+  };
+};
 function run(fn, onReject = null, onError = null) {
   rpc.retain(onReject);
   try {
     return fn();
   } catch (e) {
-    if (onReject) {
-      onReject(e instanceof HostError ? e.rejection : { message: String(e) });
+    handle(e, onReject, onError);
+    if (!onError) {
+      throw e;
     }
-    if (onError) {
-      onError(e);
-      return;
+  } finally {
+    rpc.release(onReject);
+  }
+}
+async function runAsync(fn, onReject = null, onError = null) {
+  rpc.retain(onReject);
+  try {
+    return await fn();
+  } catch (e) {
+    handle(e, onReject, onError);
+    if (!onError) {
+      throw e;
     }
-    throw e;
   } finally {
     rpc.release(onReject);
   }
 }
+function handle(e, onReject = null, onError = null) {
+  if (onReject) {
+    onReject(e instanceof HostError ? e.rejection : { message: String(e) });
+  }
+  if (onError) {
+    onError(e);
+  }
+}
 exports.HostError = HostError;
 exports.LogicalError = LogicalError;
 exports.RuntimeError = RuntimeError;
 exports.createContextAccessor = createContextAccessor;
+exports.createCustomContextAccessor = createCustomContextAccessor;
 exports.createGetter = createGetter;
 exports.createSetter = createSetter;

package/dist/host.d.ts

@@ -1,4 +1,4 @@
-import { ContextAccessor, ContextSchema, ContextSchemaMap, FieldAccessor, FieldGetters, FieldSetters, LogicalRejection, Rejection, RuntimeRejection } from '@retailcrm/embed-ui-v1-types/context';
+import { ContextAccessor, ContextSchema, ContextSchemaList, CustomContextAccessor, CustomDictionary, CustomDictionaryFilter, CustomFieldAccessor, FieldAccessor, FieldGetters, FieldSetters, LogicalRejection, Rejection, RuntimeRejection } from '@retailcrm/embed-ui-v1-types/context';
 import { Maybe } from '@retailcrm/embed-ui-v1-types/scaffolding';
 export declare class HostError extends Error {
     constructor(message: string, previous?: Error | undefined);
@@ -12,5 +12,6 @@ export declare class RuntimeError extends HostError {
 }
 export declare const createGetter: <S extends ContextSchema>(id: string, getters: FieldGetters<S>) => FieldAccessor<S>["get"];
 export declare const createSetter: <S extends ContextSchema>(id: string, setters: FieldSetters<S>) => FieldAccessor<S>["set"];
-export declare const createContextAccessor: <M extends ContextSchemaMap>(accessors: { [K in keyof M]: FieldAccessor<M[K]>; }, onError?: Maybe<ErrorHandler>) => ContextAccessor<M>;
+export declare const createContextAccessor: <M extends ContextSchemaList>(accessors: { [K in keyof M]: FieldAccessor<M[K]>; }, onError?: Maybe<ErrorHandler>) => ContextAccessor<M>;
+export declare const createCustomContextAccessor: (accessors: CustomFieldAccessor[], queryDictionary?: Maybe<(code: string, filter?: CustomDictionaryFilter) => Promise<CustomDictionary>>, onError?: Maybe<ErrorHandler>) => CustomContextAccessor;
 export type ErrorHandler = (e: unknown) => void;

package/dist/host.js

@@ -79,28 +79,91 @@ const createContextAccessor = (accessors, onError = null) => {
     }
   };
 };
+const createCustomContextAccessor = (accessors, queryDictionary = null, onError = null) => {
+  const _accessors = accessors.reduce((all, a) => {
+    all[a.schema.entity] = a;
+    return all;
+  }, {});
+  const guard = (entity) => {
+    if (!(entity in _accessors)) {
+      throw new LogicalError(`No custom context for entity ${String(entity)}`);
+    }
+  };
+  return {
+    getCustomSchema(entity, onReject = null) {
+      return run(() => {
+        guard(entity);
+        return _accessors[entity].schema;
+      }, onReject, onError) ?? null;
+    },
+    async getCustomDictionary(code, parameters, onReject) {
+      return await runAsync(() => {
+        if (!queryDictionary) {
+          throw new LogicalError("No dictionary source provided");
+        }
+        return queryDictionary(code, parameters);
+      }, onReject, onError) ?? [];
+    },
+    getCustomField(entity, code, onReject = null) {
+      return run(() => {
+        guard(entity);
+        return _accessors[entity].get(code);
+      }, onReject, onError) ?? null;
+    },
+    setCustomField(entity, code, value, onReject = null) {
+      return run(() => {
+        guard(entity);
+        _accessors[entity].set(code, value);
+      }, onReject, onError);
+    },
+    onCustomFieldChange(entity, code, handler, onReject = null) {
+      return run(() => {
+        guard(entity);
+        return _accessors[entity].onChange(code, handler);
+      }, onReject, onError);
+    }
+  };
+};
 function run(fn, onReject = null, onError = null) {
   retain(onReject);
   try {
     return fn();
   } catch (e) {
-    if (onReject) {
-      onReject(e instanceof HostError ? e.rejection : { message: String(e) });
+    handle(e, onReject, onError);
+    if (!onError) {
+      throw e;
     }
-    if (onError) {
-      onError(e);
-      return;
+  } finally {
+    release(onReject);
+  }
+}
+async function runAsync(fn, onReject = null, onError = null) {
+  retain(onReject);
+  try {
+    return await fn();
+  } catch (e) {
+    handle(e, onReject, onError);
+    if (!onError) {
+      throw e;
     }
-    throw e;
   } finally {
     release(onReject);
   }
 }
+function handle(e, onReject = null, onError = null) {
+  if (onReject) {
+    onReject(e instanceof HostError ? e.rejection : { message: String(e) });
+  }
+  if (onError) {
+    onError(e);
+  }
+}
 export {
   HostError,
   LogicalError,
   RuntimeError,
   createContextAccessor,
+  createCustomContextAccessor,
   createGetter,
   createSetter
 };

package/dist/remote/custom.cjs

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const pinia = require("pinia");
+const CustomContextAccessorKey = Symbol("CustomContextAccessor");
+const injectAccessor = (endpoint) => {
+  return (context) => {
+    context.store[CustomContextAccessorKey] = endpoint.call;
+  };
+};
+const isTypeOf = (field, type) => {
+  return field.kind === type;
+};
+const defineContext = (entity) => pinia.defineStore(`custom/${entity}`, {
+  state() {
+    return {
+      schema: null,
+      values: {}
+    };
+  },
+  getters: {
+    entity: () => entity
+  },
+  actions: {
+    async initialize(onReject = null) {
+      const accessor = this[CustomContextAccessorKey];
+      const schema = await accessor.getCustomSchema(entity, onReject);
+      if (!schema) {
+        return null;
+      }
+      this.schema = schema;
+      this.values = schema.fields.reduce((state, field) => {
+        state[field.code] = Array.isArray(field.initial) ? [...field.initial] : field.initial;
+        return state;
+      }, {});
+      schema.fields.forEach((field) => {
+        accessor.onCustomFieldChange(entity, field.code, (value) => {
+          this.values[field.code] = value;
+        });
+      });
+      return schema;
+    },
+    set(code, value, onReject = null) {
+      if (!this.schema) {
+        throw new Error(`[crm:embed:remote] Custom context for entity=${entity} is not initialized`);
+      }
+      const field = this.schema.fields.find((f) => f.code === code);
+      if (!field) {
+        throw new Error(`[crm:embed:remote] Custom context for entity=${entity} does not contain field with code ${code}`);
+      }
+      guardReadonly(entity, field);
+      guardType(entity, field, value);
+      this[CustomContextAccessorKey].setCustomField(entity, code, value, onReject);
+    }
+  }
+});
+const useContext = (entity) => defineContext(entity)();
+function guardReadonly(entity, field) {
+  if (field.readonly) {
+    throw new Error(`[crm:embed:remote] Field with code ${field.code} is not writable according to schema for entity=${entity}`);
+  }
+}
+function guardType(entity, field, value) {
+  if (!accepts(field, value)) {
+    throw new Error(`[crm:embed:remote] Invalid value for field kind ${field.kind} with code ${field.code} in entity=${entity}`);
+  }
+}
+function accepts(field, value) {
+  switch (field.kind) {
+    case "boolean":
+      return typeof value === "boolean";
+    case "date":
+      return typeof value === "string" || value === null;
+    case "datetime":
+      return typeof value === "string" || value === null;
+    case "dictionary":
+      return typeof value === "string" || value === null;
+    case "multiselect_dictionary":
+      return Array.isArray(value) && (value.length === 0 || value.every((v) => typeof v === "string"));
+    case "email":
+      return typeof value === "string" || value === null;
+    case "integer":
+      return typeof value === "number" && Number.isInteger(value) || value === null;
+    case "numeric":
+      return typeof value === "number" || value === null;
+    case "string":
+    case "text":
+      return typeof value === "string" || value === null;
+    default:
+      return false;
+  }
+}
+const useDictionary = pinia.defineStore("@retailcrm/embed-ui/_dictionary", {
+  actions: {
+    async query(code, parameters = {}) {
+      const accessor = this[CustomContextAccessorKey];
+      return new Promise((resolve, reject) => {
+        let rejection = null;
+        accessor.getCustomDictionary(code, parameters, (r) => rejection = r).then((dictionary) => {
+          if (!rejection) {
+            resolve(dictionary);
+          } else {
+            reject(rejection);
+          }
+        });
+      });
+    }
+  }
+});
+exports.CustomContextAccessorKey = CustomContextAccessorKey;
+exports.defineContext = defineContext;
+exports.injectAccessor = injectAccessor;
+exports.isTypeOf = isTypeOf;
+exports.useContext = useContext;
+exports.useDictionary = useDictionary;

package/dist/remote/custom.d.ts

@@ -0,0 +1,38 @@
+import { CustomField, CustomFieldKind, CustomFieldType, CustomContext, CustomContextAccessor, CustomContextSchema, CustomDictionary, RejectionHandler } from '@retailcrm/embed-ui-v1-types/context';
+import { Endpoint } from '@remote-ui/rpc';
+import { Maybe } from '@retailcrm/embed-ui-v1-types/scaffolding';
+import { PiniaPluginContext, StoreDefinition, Store } from 'pinia';
+export declare const CustomContextAccessorKey: unique symbol;
+declare module 'pinia' {
+    interface PiniaCustomProperties {
+        [CustomContextAccessorKey]: Endpoint<CustomContextAccessor>['call'];
+    }
+}
+export declare const injectAccessor: (endpoint: Endpoint<CustomContextAccessor>) => (context: PiniaPluginContext) => void;
+export declare const isTypeOf: <T extends CustomFieldKind>(field: CustomField, type: T) => field is CustomField<T>;
+export declare const defineContext: <T extends string>(entity: T) => StoreDefinition<`custom/${T}`, {
+    schema: CustomContextSchema | null;
+    values: CustomContext;
+}, {
+    entity: () => T;
+}, {
+    initialize(onReject?: Maybe<RejectionHandler>): Promise<CustomContextSchema | null>;
+    set(code: string, value: CustomFieldType, onReject?: Maybe<RejectionHandler>): void;
+}>;
+export declare const useContext: <T extends string>(entity: T) => Store<`custom/${T}`, {
+    schema: CustomContextSchema | null;
+    values: CustomContext;
+}, {
+    entity: () => T;
+}, {
+    initialize(onReject?: Maybe<RejectionHandler>): Promise<CustomContextSchema | null>;
+    set(code: string, value: CustomFieldType, onReject?: Maybe<RejectionHandler>): void;
+}>;
+export type CustomContextStore<T extends string> = ReturnType<CustomContextStoreDefinition<T>>;
+export type CustomContextStoreDefinition<T extends string> = ReturnType<typeof defineContext<T>>;
+export declare const useDictionary: StoreDefinition<"@retailcrm/embed-ui/_dictionary", {}, {}, {
+    query(code: string, parameters?: {
+        after?: string;
+        first?: number;
+    }): Promise<CustomDictionary>;
+}>;

package/dist/remote/custom.js

@@ -0,0 +1,114 @@
+import { defineStore } from "pinia";
+const CustomContextAccessorKey = Symbol("CustomContextAccessor");
+const injectAccessor = (endpoint) => {
+  return (context) => {
+    context.store[CustomContextAccessorKey] = endpoint.call;
+  };
+};
+const isTypeOf = (field, type) => {
+  return field.kind === type;
+};
+const defineContext = (entity) => defineStore(`custom/${entity}`, {
+  state() {
+    return {
+      schema: null,
+      values: {}
+    };
+  },
+  getters: {
+    entity: () => entity
+  },
+  actions: {
+    async initialize(onReject = null) {
+      const accessor = this[CustomContextAccessorKey];
+      const schema = await accessor.getCustomSchema(entity, onReject);
+      if (!schema) {
+        return null;
+      }
+      this.schema = schema;
+      this.values = schema.fields.reduce((state, field) => {
+        state[field.code] = Array.isArray(field.initial) ? [...field.initial] : field.initial;
+        return state;
+      }, {});
+      schema.fields.forEach((field) => {
+        accessor.onCustomFieldChange(entity, field.code, (value) => {
+          this.values[field.code] = value;
+        });
+      });
+      return schema;
+    },
+    set(code, value, onReject = null) {
+      if (!this.schema) {
+        throw new Error(`[crm:embed:remote] Custom context for entity=${entity} is not initialized`);
+      }
+      const field = this.schema.fields.find((f) => f.code === code);
+      if (!field) {
+        throw new Error(`[crm:embed:remote] Custom context for entity=${entity} does not contain field with code ${code}`);
+      }
+      guardReadonly(entity, field);
+      guardType(entity, field, value);
+      this[CustomContextAccessorKey].setCustomField(entity, code, value, onReject);
+    }
+  }
+});
+const useContext = (entity) => defineContext(entity)();
+function guardReadonly(entity, field) {
+  if (field.readonly) {
+    throw new Error(`[crm:embed:remote] Field with code ${field.code} is not writable according to schema for entity=${entity}`);
+  }
+}
+function guardType(entity, field, value) {
+  if (!accepts(field, value)) {
+    throw new Error(`[crm:embed:remote] Invalid value for field kind ${field.kind} with code ${field.code} in entity=${entity}`);
+  }
+}
+function accepts(field, value) {
+  switch (field.kind) {
+    case "boolean":
+      return typeof value === "boolean";
+    case "date":
+      return typeof value === "string" || value === null;
+    case "datetime":
+      return typeof value === "string" || value === null;
+    case "dictionary":
+      return typeof value === "string" || value === null;
+    case "multiselect_dictionary":
+      return Array.isArray(value) && (value.length === 0 || value.every((v) => typeof v === "string"));
+    case "email":
+      return typeof value === "string" || value === null;
+    case "integer":
+      return typeof value === "number" && Number.isInteger(value) || value === null;
+    case "numeric":
+      return typeof value === "number" || value === null;
+    case "string":
+    case "text":
+      return typeof value === "string" || value === null;
+    default:
+      return false;
+  }
+}
+const useDictionary = defineStore("@retailcrm/embed-ui/_dictionary", {
+  actions: {
+    async query(code, parameters = {}) {
+      const accessor = this[CustomContextAccessorKey];
+      return new Promise((resolve, reject) => {
+        let rejection = null;
+        accessor.getCustomDictionary(code, parameters, (r) => rejection = r).then((dictionary) => {
+          if (!rejection) {
+            resolve(dictionary);
+          } else {
+            reject(rejection);
+          }
+        });
+      });
+    }
+  }
+});
+export {
+  CustomContextAccessorKey,
+  defineContext,
+  injectAccessor,
+  isTypeOf,
+  useContext,
+  useDictionary
+};

package/dist/remote.d.ts

@@ -1,4 +1,4 @@
-import { Context, ContextAccessor, ContextSchema, ContextSchemaMap, RejectionHandler, TypeOf, Writable } from '@retailcrm/embed-ui-v1-types/context';
+import { Context, ContextAccessor, ContextSchema, ContextSchemaList, RejectionHandler, TypeOf, Writable } from '@retailcrm/embed-ui-v1-types/context';
 import { Endpoint } from '@remote-ui/rpc';
 import { Maybe } from '@retailcrm/embed-ui-v1-types/scaffolding';
 import { PiniaPluginContext, StoreDefinition } from 'pinia';
@@ -7,7 +7,7 @@ declare module 'pinia' {
         endpoint: Endpoint<ContextAccessor>;
     }
 }
-export declare const injectEndpoint: <M extends ContextSchemaMap, A extends ContextAccessor<M> = ContextAccessor<M>>(endpoint: Endpoint<A>) => (context: PiniaPluginContext) => void;
+export declare const injectEndpoint: <M extends ContextSchemaList, A extends ContextAccessor<M> = ContextAccessor<M>>(endpoint: Endpoint<A>) => (context: PiniaPluginContext) => void;
 export declare const defineContext: <Id extends string, S extends ContextSchema>(id: Id, schema: S) => StoreDefinition<Id, Context<S>, {
     schema: () => S;
 }, {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@retailcrm/embed-ui-v1-contexts",
   "description": "Reactive contexts for RetailCRM JS API",
   "type": "module",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "license": "MIT",
   "author": "RetailDriverLLC <integration@retailcrm.ru>",
   "repository": "git@github.com:retailcrm/embed-ui.git",
@@ -50,6 +50,12 @@
       "require": "./dist/remote/settings.cjs",
       "default": "./dist/remote/settings.js"
     },
+    "./remote/custom": {
+      "types": "./dist/remote/custom.d.ts",
+      "import": "./dist/remote/custom.js",
+      "require": "./dist/remote/custom.cjs",
+      "default": "./dist/remote/custom.js"
+    },
     "./*": "./*"
   },
   "typesVersions": {
@@ -74,6 +80,9 @@
       ],
       "remote/settings": [
         "./dist/remote/settings.d.ts"
+      ],
+      "remote/custom": [
+        "./dist/remote/custom.d.ts"
       ]
     }
   },
@@ -93,10 +102,10 @@
     "pinia": "^2.2"
   },
   "dependencies": {
-    "@retailcrm/embed-ui-v1-types": "^0.5.2"
+    "@retailcrm/embed-ui-v1-types": "^0.5.3"
   },
   "devDependencies": {
-    "@retailcrm/embed-ui-v1-testing": "^0.5.2",
+    "@retailcrm/embed-ui-v1-testing": "^0.5.3",
     "tsx": "^4.19.2",
     "typescript": "^5.6.3",
     "vite": "^5.4.11",