@skychameleon/workflow 1.0.0

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@skychameleon/workflow",
+  "version": "1.0.0",
+  "description": "Everything about workflow",
+  "license": "ISC",
+  "type": "module",
+  "scripts": {
+    "format": "npx prettier --write ."
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@skychameleon/core": "^1.0.3"
+  },
+  "exports": {
+    "./workflow.schema": "./workflow/workflow.schema.d.ts"
+  }
+}

package/workflow/blocks/base.schema.d.ts

@@ -0,0 +1,19 @@
+import type { EntranceHandler, ExitHandler } from "./shared/general.types";
+
+type ChatBotBlockTypes = "send_file" | "send_msg" | "input-text" | "input-file";
+
+type MainBlockTypes = "start" | "var_set" | "run_code";
+
+type BlockTypes = MainBlockTypes | ChatBotBlockTypes;
+
+export interface BaseBlockSchema<T extends BlockTypes> {
+  _id: string;
+  type: T;
+  label: string;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  entrance: EntranceHandler;
+  exit: ExitHandler;
+}

package/workflow/blocks/chat_bot/input-file.schema.ts

@@ -0,0 +1,16 @@
+import type { BaseBlockSchema } from "../base.schema";
+import type { VarSetBlockSchema } from "../general/var-set.schema";
+import type {
+  AdditionalOptions,
+  InputVarChatBotType,
+  SendText,
+} from "../shared/general.types";
+
+/**
+ * Блок отвечающий за получения файла
+ */
+export interface InputFileChatBotBlockSchema extends BaseBlockSchema<"input-file"> {
+  sendText: SendText;
+  varSet: Omit<VarSetBlockSchema<InputVarChatBotType>, "code">;
+  additionalOptions: Pick<AdditionalOptions, "back_button" | "skip_button">;
+}

package/workflow/blocks/chat_bot/input-text.schema.ts

@@ -0,0 +1,35 @@
+import type { BaseBlockSchema } from "../base.schema";
+import type { VarSetBlockSchema } from "../general/var-set.schema";
+import type {
+  AdditionalOptions,
+  CodeExpression,
+  InputVarChatBotType,
+  SendText,
+} from "../shared/general.types";
+
+/**
+ * Типы для составления клавиатуры
+ * Если создается кодом - KeyboardCode, то он должен вернуть объекта типа KeyboardConstructor
+ */
+export type KeyboardCode = CodeExpression;
+export type KeyboardConstructor = {
+  text:
+    | string
+    | {
+        useCodeExpression: boolean;
+        code: CodeExpression;
+      };
+  callback_data: string;
+}[];
+
+/**
+ * Блок отвечающий за получения текстового сообщения
+ */
+export interface InputTextChatBotBlockSchema extends BaseBlockSchema<"input-text"> {
+  sendText: SendText;
+  validator: false | CodeExpression; // валидирует полученное сообщение, в случае не сопаставление можно выдать ошибку
+  convertor: false | CodeExpression; // конвертирует полученное сообщение в другое значение&тип
+  varSet: Omit<VarSetBlockSchema<InputVarChatBotType>, "code">;
+  keyboard: false | KeyboardConstructor | KeyboardCode;
+  additionalOptions: Pick<AdditionalOptions, "back_button" | "skip_button">;
+}

package/workflow/blocks/chat_bot/send-file.schema.ts

@@ -0,0 +1,19 @@
+import type { BaseBlockSchema } from "../base.schema";
+import type { VarSetBlockSchema } from "../general/var-set.schema";
+import type {
+  AdditionalOptions,
+  CodeExpression,
+  VarType,
+  SendText,
+} from "../shared/general.types";
+
+/**
+ * Блок отвечающий за отправление файлов
+ */
+export interface SendFileChatBotBlockSchema extends BaseBlockSchema<"send_file"> {
+  several: boolean;
+  sendText: SendText;
+  varSet: Omit<VarSetBlockSchema<VarType.BOOLEAN>, "code">;
+  errorText: string;
+  additionalOptions: Pick<AdditionalOptions, "send_other_chat">;
+}

package/workflow/blocks/chat_bot/send-msg.schema.d.ts

@@ -0,0 +1,11 @@
+import type { BaseBlockSchema } from "../base.schema";
+import type { AdditionalOptions, SendText } from "../shared/general.types";
+
+/**
+ * Блок отвечающий за отправление текстового сообщения
+ */
+export interface SendMsgChatBotBlockSchema extends BaseBlockSchema<"send_msg"> {
+  markdown: boolean;
+  sendText: SendText;
+  additionalOptions: Pick<AdditionalOptions, "send_other_chat">;
+}

package/workflow/blocks/general/run-code.schema.d.ts

@@ -0,0 +1,8 @@
+import type { BaseBlockSchema } from "../base.schema";
+
+/**
+ * Блок отвечающий за запуск кода
+ */
+export interface RunCodeBlockSchema extends BaseBlockSchema<"run_code"> {
+  code: string;
+}

package/workflow/blocks/general/start.schema.d.ts

@@ -0,0 +1,10 @@
+import type { BaseBlockSchema } from "../base.schema";
+import type { VarType } from "../shared/general.types";
+import type { VarSetBlockSchema } from "./var-set.schema";
+
+/**
+ * Блок отвечающий за запуск сценария и содержащий все необходимые переменные для работы
+ */
+export interface StartBlockSchema extends BaseBlockSchema<"start"> {
+  vars: VarSetBlockSchema<VarType>[];
+}

package/workflow/blocks/general/var-set.schema.d.ts

@@ -0,0 +1,25 @@
+import type { BaseBlockSchema } from "../base.schema";
+import type { VarType, InputVarChatBotType } from "../shared/general.types";
+
+type CompletionTypes = `function` | `variable`;
+
+/**
+ * Блок отвечающий за создание переменной в контексте клиента
+ */
+export interface VarSetBlockSchema<
+  Type extends VarType | InputVarChatBotType,
+> extends BaseBlockSchema<"var_set"> {
+  name: string;
+  varType: Type;
+  code: string;
+  completion:
+    | false
+    | {
+        // для подсказки в редакторе-codemirror
+        label?: string;
+        type?: CompletionTypes;
+        detail?: string;
+        info?: string;
+        apply?: string;
+      };
+}

package/workflow/blocks/registry.ts

@@ -0,0 +1,18 @@
+import type { RunCodeBlockSchema } from "./general/run-code.schema.d.ts";
+import type { StartBlockSchema } from "./general/start.schema.d.ts";
+import type { VarSetBlockSchema } from "./general/var-set.schema.d.ts";
+import type { InputVarChatBotType, VarType } from "./shared/general.types.d.ts";
+import type { SendMsgChatBotBlockSchema } from "./chat_bot/send-msg.schema.d.ts";
+import type { SendFileChatBotBlockSchema } from "./chat_bot/send-file.schema.d.ts";
+import type { InputTextChatBotBlockSchema } from "./chat_bot/input-text.schema.d.ts";
+import type { InputFileChatBotBlockSchema } from "./chat_bot/input-file.schema.d.ts";
+
+export type GeneralBlockSchema =
+  | StartBlockSchema
+  | VarSetBlockSchema<VarType | InputVarChatBotType>
+  | RunCodeBlockSchema;
+export type ChatBotBlockSchema =
+  | SendMsgChatBotBlockSchema
+  | SendFileChatBotBlockSchema
+  | InputTextChatBotBlockSchema
+  | InputFileChatBotBlockSchema;

package/workflow/blocks/shared/general.types.d.ts

@@ -0,0 +1,63 @@
+export type CodeExpression = string;
+/**
+ * Обработчик блока после выхода из основной логики бота
+ */
+export type ExitHandler =
+  | false
+  | {
+      code: string;
+    };
+/**
+ * Обработчик блока перед входом в основную логику бота
+ */
+export type EntranceHandler =
+  | false
+  | {
+      code: string;
+    };
+
+interface DynamicText {
+  useCodeExpression: boolean;
+  code: CodeExpression;
+}
+export type SendText = string | DynamicText;
+export type ChatID = number;
+/**
+ * Дополнительные опции для чат-ботов
+ */
+export type AdditionalOptions = {
+  back_button:
+    | false
+    | string
+    | {
+        useCodeExpression: boolean;
+        code: CodeExpression;
+      };
+  skip_button:
+    | false
+    | string
+    | {
+        useCodeExpression: boolean;
+        code: CodeExpression;
+      };
+  send_other_chat: false | ChatID;
+};
+
+/**
+ * Типы переменных
+ *
+ * Типы для полученных сообщений из чат-ботов
+ * Общие типы
+ */
+export enum InputVarChatBotType {
+  FILE = "file",
+}
+export enum VarType {
+  STRING = "string",
+  NUMBER = "number",
+  BOOLEAN = "boolean",
+  OBJECT = "object",
+  ARRAY = "array",
+  FUNCTION = "function",
+  ANY = "any",
+}

package/workflow/edges/base.schema.d.ts

@@ -0,0 +1,9 @@
+export type EdgeTypes = "query-rule";
+
+export interface BaseEdgeSchema<Type extends EdgeTypes, Guard> {
+  label?: string;
+  type: Type;
+  priority: number;
+  to: string;
+  guards: Guard;
+}

package/workflow/edges/query-rule.schema.d.ts

@@ -0,0 +1,38 @@
+import type { VarType } from "../blocks/shared/general.types";
+import type { BaseEdgeSchema } from "./base.schema";
+
+export enum LogicOperator {
+  AND = "and",
+  OR = "or",
+}
+export enum ConditionList {
+  EMPTY = "empty",
+  NOT_EMPTY = "not_empty",
+  EQUAL = "equal",
+  NOT_EQUAL = "not_equal",
+  LESS = "less",
+  LESS_OR_EQUAL = "less_or_equal",
+  GREATER = "greater",
+  GREATER_OR_EQUAL = "greater_or_equal",
+  IS_NULL = "is_null",
+  IS_NOT_NULL = "is_not_null",
+}
+
+export interface SingleRuleGuard {
+  var: string;
+  typeVar: VarType;
+  /*--*/
+  condition: ConditionList;
+  /*--*/
+  valueMode: {
+    mode: "value" | "variable" | "expression";
+    value: string;
+  };
+}
+
+export interface RuleGuardGroup {
+  operator: LogicOperator;
+  guards: (SingleRuleGuard | RuleGuardGroup)[];
+}
+
+export type QueryRuleEdgeSchema = BaseEdgeSchema<"query-rule", RuleGuardGroup>;

package/workflow/workflow.schema.d.ts

@@ -0,0 +1,18 @@
+import type { ChatBotBlockSchema, GeneralBlockSchema } from "./blocks/registry";
+import type { QueryRuleEdgeSchema } from "./edges/query-rule.schema";
+
+export interface Metadata {
+  name: string;
+  description: string;
+  exportedAt: string;
+}
+
+interface WorkflowSchema {
+  states: {
+    blocks: (GeneralBlockSchema | ChatBotBlockSchema)[];
+    edges: QueryRuleEdgeSchema[];
+  };
+  metadata: Metadata;
+}
+
+export default WorkflowSchema;