@retailcrm/embed-ui-v1-types 0.4.5

package/README.md

@@ -0,0 +1,16 @@
+# `@retailcrm/embed-ui-v1-types`
+
+Базовые TypeScript типы, используемые в JS-расширениях RetailCRM
+
+## Установка
+
+npm:
+
+```bash
+npm i --save @retailcrm/embed-ui-v1-types
+```
+
+yarn:
+```bash
+yarn add @retailcrm/embed-ui-v1-types
+```

package/context-doc.d.ts

@@ -0,0 +1,13 @@
+import type { ContextSchema } from './context'
+import type { TranslationList } from './doc'
+
+export type ContextSchemaDescription<S extends ContextSchema> = {
+  [K in keyof S]: {
+    description: TranslationList;
+  }
+}
+
+export type ContextSchemaUsage = {
+  import: string;
+  call: string;
+}

package/context.d.ts

@@ -0,0 +1,117 @@
+import type { If, IsTilda, Maybe } from './scaffolding'
+
+export type Field<Type, Readonly extends boolean = false> = {
+  accepts (value: Type): boolean;
+  defaults (): Type;
+  readonly: Readonly;
+}
+
+export type ReadonlyField<Type = unknown> = Field<Type, true>
+
+export type TypeOf<F> = F extends Field<infer T>
+  ? T
+  : F extends ReadonlyField<infer T>
+    ? T
+    : never;
+
+export type IsReadonly<F> = F extends Field<unknown, infer R>
+  ? R
+  : F extends ReadonlyField
+    ? true
+    : false;
+
+export type ContextSchema = {
+  [key: string]: Field<unknown, boolean>;
+}
+
+export type ContextSchemaMap = {
+  [key: string]: ContextSchema;
+}
+
+export type Context<S extends ContextSchema> = {
+  [F in keyof S]: TypeOf<S[F]>;
+}
+
+export type Writable<S extends ContextSchema> = {
+  [F in keyof S as IsReadonly<S[F]> extends true ? never : F]: S[F];
+}
+
+export type EventMap<S extends ContextSchema> = {
+  [K in keyof S as K extends string ? `change:${K}` : never]: K;
+}
+
+export type EventPayloadMap<S extends ContextSchema> = {
+  [K in keyof S as K extends string ? `change:${K}` : never]: TypeOf<S[K]>;
+}
+
+export type EventHandler<
+  S extends ContextSchema,
+  E extends keyof EventPayloadMap<S>
+> = (payload: EventPayloadMap<S>[E]) => void
+
+export type ContextAccessor<M extends ContextSchemaMap = ContextSchemaMap> = {
+  get <
+    C extends keyof M,
+    F extends keyof M[C]
+  >(context: C, field: F | '~', onReject?: Maybe<RejectionHandler>): If<
+    IsTilda<typeof field>,
+    Context<M[C]>,
+    Context<M[C]>[F]
+  >;
+
+  set <
+    C extends keyof M,
+    F extends keyof Writable<M[C]>
+  >(context: C, field: F, value: Context<M[C]>[F], onReject?: Maybe<RejectionHandler>): void;
+
+  on<
+    C extends keyof M,
+    E extends keyof EventMap<M[C]>
+  >(context: C, event: E, handler: EventHandler<M[C], E>): void;
+}
+
+export type FieldAccessor<S extends ContextSchema> = {
+  get <F extends keyof S>(field: F | '~'): If<
+    IsTilda<typeof field>,
+    Context<S>,
+    Context<S>[F]
+  >;
+
+  set <F extends keyof Writable<S>>(
+    field: F,
+    value: Context<S>[F]
+  ): void;
+
+  on<E extends keyof EventMap<S>>(
+    event: E,
+    handler: EventHandler<S, E>
+  ): void;
+}
+
+export type FieldGetters<S extends ContextSchema> = {
+  [F in keyof S]: () => Context<S>[F]
+}
+
+export type FieldSetters<S extends ContextSchema> = {
+  [F in keyof Writable<S>]: (value: Context<S>[F]) => void
+}
+
+export interface Rejection {
+  message: string;
+}
+
+export interface RejectionHandler {
+  (rejection: Rejection): void;
+}
+
+export interface DomainRejection extends Rejection {
+  type: 'domain';
+}
+
+export interface LogicalRejection extends Rejection {
+  type: 'logical';
+}
+
+export interface RuntimeRejection extends Rejection {
+  type: 'runtime';
+}

package/doc.d.ts

@@ -0,0 +1,5 @@
+export type TranslationList = {
+  'en-GB': string;
+  'es-ES': string;
+  'ru-RU': string;
+}

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@retailcrm/embed-ui-v1-types",
+  "description": "Basic types declarations for RetailCRM JS API",
+  "type": "module",
+  "version": "0.4.5",
+  "license": "MIT",
+  "author": "RetailDriverLLC <integration@retailcrm.ru>",
+  "repository": "git@github.com:retailcrm/embed-ui.git",
+  "exports": {
+    ".": null,
+    "./*": "./*"
+  }
+}

package/scaffolding.d.ts

@@ -0,0 +1,12 @@
+export type IsExact<A, B> = A extends B ? (B extends A ? true : false) : false;
+export type IsTilda<A> = IsExact<A, '~'>;
+
+export type If<Condition, Then, Else> = Condition extends true ? Then : Else;
+
+export type Maybe<T> = T | null
+
+export type UnionToArray<T, U = T> = [T] extends [never]
+  ? []
+  : T extends T
+  ? [T, ...UnionToArray<Exclude<U, T>>]
+  : []