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

package/context.d.ts

@@ -24,10 +24,12 @@ export type ContextSchema = {
   [key: string]: Field<unknown, boolean>;
 }
 
-export type ContextSchemaMap = {
+export type ContextSchemaList = {
   [key: string]: ContextSchema;
 }
 
+export type ContextSchemaMap = ContextSchemaList
+
 export type Context<S extends ContextSchema> = {
   [F in keyof S]: TypeOf<S[F]>;
 }
@@ -49,7 +51,7 @@ export type EventHandler<
   E extends keyof EventPayloadMap<S>
 > = (payload: EventPayloadMap<S>[E]) => void
 
-export type ContextAccessor<M extends ContextSchemaMap = ContextSchemaMap> = {
+export type ContextAccessor<M extends ContextSchemaList = ContextSchemaList> = {
   get <
     C extends keyof M,
     F extends keyof M[C]
@@ -115,3 +117,97 @@ export interface LogicalRejection extends Rejection {
 export interface RuntimeRejection extends Rejection {
   type: 'runtime';
 }
+
+export type CustomDictionary = CustomDictionaryItem[]
+export type CustomDictionaryItem = {
+  code: string;
+  text: string;
+  cursor: string;
+}
+
+export type CustomDictionaryFilter = {
+  after?: string;
+  first?: number;
+}
+
+export interface BasicCustomField<K extends string, T> {
+  kind: K;
+  code: string;
+  readonly: boolean;
+  initial: T;
+}
+
+export interface DictionaryCustomField extends BasicCustomField<'dictionary', string | null> {
+  dictionaryCode: string;
+}
+
+export interface MultiselectDictionaryCustomField extends BasicCustomField<'multiselect_dictionary', string[]> {
+  dictionaryCode: string;
+}
+
+export type CustomField<K extends CustomFieldKind = CustomFieldKind> = CustomFieldList[K]
+
+export type CustomFieldType = TypeOfCustom<CustomFieldKind>
+export type CustomFieldKind = keyof CustomFieldList
+export type CustomFieldList = {
+  'boolean': BasicCustomField<'boolean', boolean | null>;
+  'date': BasicCustomField<'date', string | null>;
+  'datetime': BasicCustomField<'datetime', string | null>;
+  'dictionary': DictionaryCustomField;
+  'multiselect_dictionary': MultiselectDictionaryCustomField;
+  'email': BasicCustomField<'email', string | null>;
+  'integer': BasicCustomField<'integer', number | null>;
+  'numeric': BasicCustomField<'numeric', number | null>;
+  'string': BasicCustomField<'string', string | null>;
+  'text': BasicCustomField<'text', string | null>;
+}
+
+export type TypeOfCustom<K extends string> = K extends CustomFieldKind
+  ? CustomFieldList[K] extends BasicCustomField<string, infer T> ? T : never
+  : unknown;
+
+export type CustomContextSchema = {
+  entity: string;
+  fields: CustomField[];
+}
+
+export type CustomContext = {
+  [code: string]: CustomFieldType
+}
+
+export type CustomContextAccessor = {
+  getCustomSchema (entity: string, onReject?: Maybe<RejectionHandler>): CustomContextSchema | null;
+
+  getCustomDictionary (
+    code: string,
+    filter?: CustomDictionaryFilter,
+    onReject?: Maybe<RejectionHandler>
+  ): Promise<CustomDictionary>;
+
+  getCustomField (entity: string, code: string, onReject?: Maybe<RejectionHandler>): unknown;
+  setCustomField (
+    entity: string,
+    code: string,
+    value: CustomFieldType,
+    onReject?: Maybe<RejectionHandler>
+  ): void;
+
+  onCustomFieldChange (
+    entity: string,
+    code: string,
+    handler: (value: CustomFieldType) => void,
+    onReject?: Maybe<RejectionHandler>
+  ): void | (() => void);
+}
+
+export type CustomFieldAccessor = {
+  readonly schema: CustomContextSchema;
+
+  get (code: string): unknown;
+  set (code: string, value: CustomFieldType): void;
+
+  onChange (
+    code: string,
+    handler: (value: CustomFieldType) => void
+  ): void | (() => void);
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@retailcrm/embed-ui-v1-types",
   "description": "Basic types declarations 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",