@runium/core 0.0.9 → 0.1.0

package/src/project-schema.ts

@@ -1,767 +0,0 @@
-import {
-  ProjectActionType,
-  ProjectTaskRestartPolicyType,
-  ProjectTaskStartMode,
-  ProjectTaskType,
-  ProjectTriggerType,
-} from './project-config';
-import { TaskStatus } from './task';
-import { RuniumError } from './error';
-
-interface ProjectSchema {
-  properties: {
-    tasks: {
-      items: {
-        oneOf: { $ref: string }[];
-      };
-    };
-  };
-  required?: string[];
-  $defs: Record<string, ProjectSchemaTask | ProjectSchemaAction | unknown> & {
-    Runium_Action: {
-      oneOf: { $ref: string }[];
-    };
-    Runium_Trigger: {
-      oneOf: { $ref: string }[];
-    };
-  };
-}
-
-interface ProjectSchemaTask {
-  properties: {
-    type: {
-      const: string;
-    };
-  };
-}
-
-interface ProjectSchemaAction {
-  properties: {
-    type: {
-      const?: string;
-      enum?: string[];
-    };
-  };
-}
-
-export interface ProjectSchemaExtensionProject {
-  properties: unknown;
-  required?: string[];
-}
-
-export interface ProjectSchemaExtensionTask {
-  type: string;
-  options: unknown;
-}
-
-export interface ProjectSchemaExtensionAction {
-  type: string;
-  payload?: unknown;
-}
-
-export interface ProjectSchemaExtensionTrigger {
-  type: string;
-  payload?: unknown;
-}
-
-export interface ProjectSchemaExtension {
-  project?: ProjectSchemaExtensionProject;
-  tasks?: Record<string, ProjectSchemaExtensionTask>;
-  definitions?: Record<string, unknown>;
-  actions?: Record<string, ProjectSchemaExtensionAction>;
-  triggers?: Record<string, ProjectSchemaExtensionTrigger>;
-}
-
-export enum ProjectSchemaErrorCode {
-  ACTION_TYPE_ALREADY_USED = 'project-schema-action-type-already-used',
-  TASK_TYPE_ALREADY_USED = 'project-schema-task-type-already-used',
-  TRIGGER_TYPE_ALREADY_USED = 'project-schema-trigger-type-already-used',
-}
-
-export const ID_REGEX = /^[a-zA-Z0-9_-]+$/;
-
-/**
- * Task common properties
- */
-const TASK_COMMON_PROPERTIES = {
-  id: {
-    type: 'string',
-    pattern: ID_REGEX.source,
-  },
-  name: {
-    type: 'string',
-  },
-  type: {
-    type: 'string',
-  },
-  mode: {
-    $ref: '#/$defs/Runium_TaskStartMode',
-  },
-  dependencies: {
-    type: 'array',
-    items: {
-      $ref: '#/$defs/Runium_TaskDependency',
-    },
-  },
-  handlers: {
-    type: 'array',
-    items: {
-      $ref: '#/$defs/Runium_TaskHandler',
-    },
-  },
-  restart: {
-    $ref: '#/$defs/Runium_TaskRestartPolicy',
-  },
-};
-
-/**
- * Trigger common properties
- */
-const TRIGGER_COMMON_PROPERTIES = {
-  id: {
-    type: 'string',
-    pattern: ID_REGEX.source,
-  },
-  action: {
-    $ref: '#/$defs/Runium_Action',
-  },
-  disabled: {
-    type: 'boolean',
-  },
-};
-
-/**
- * Create task schema
- * @param type
- * @param options
- */
-function createTaskSchema(type: string, options: unknown): object {
-  return {
-    type: 'object',
-    properties: {
-      ...structuredClone(TASK_COMMON_PROPERTIES),
-      type: {
-        const: type,
-      },
-      options: {
-        ...structuredClone(options as object),
-      },
-    },
-    required: ['id', 'options'],
-    additionalProperties: false,
-  };
-}
-
-/**
- * Create action schema
- * @param type
- * @param payload
- */
-function createActionSchema(type: string, payload?: unknown): object {
-  const payloadProp = payload ? { payload } : {};
-  const payloadRequired = payload ? ['payload'] : [];
-  return {
-    type: 'object',
-    properties: {
-      type: {
-        type: 'string',
-        const: type,
-      },
-      ...payloadProp,
-    },
-    required: ['type', ...payloadRequired],
-    additionalProperties: false,
-  };
-}
-
-/**
- * Create trigger schema
- * @param type
- * @param payload
- */
-function createTriggerSchema(type: string, payload?: unknown): object {
-  const payloadProp = payload ? { payload } : {};
-  const payloadRequired = payload ? ['payload'] : [];
-  return {
-    type: 'object',
-    properties: {
-      ...structuredClone(TRIGGER_COMMON_PROPERTIES),
-      type: {
-        type: 'string',
-        const: type,
-      },
-      ...payloadProp,
-    },
-    required: ['id', 'type', 'action', ...payloadRequired],
-    additionalProperties: false,
-  };
-}
-
-/**
- * Get project schema
- */
-export function getProjectSchema(): object {
-  const schema = {
-    $schema: 'https://json-schema.org/draft/2020-12/schema',
-    $id: 'https://example.com/schemas/project.json',
-    title: 'Project',
-    type: 'object',
-    properties: {
-      id: {
-        type: 'string',
-        pattern: ID_REGEX.source,
-      },
-      name: {
-        type: 'string',
-      },
-      tasks: {
-        type: 'array',
-        items: {
-          oneOf: [
-            {
-              $ref: '#/$defs/Runium_TaskConfig',
-            },
-          ],
-        },
-        minItems: 1,
-        uniqueItemProperties: ['id'],
-      },
-      triggers: {
-        type: 'array',
-        items: {
-          $ref: '#/$defs/Runium_Trigger',
-        },
-        uniqueItemProperties: ['id'],
-      },
-    },
-    required: ['id', 'tasks'],
-    additionalProperties: false,
-    $defs: {
-      Runium_EnvValue: {
-        type: ['string', 'number', 'boolean'],
-      },
-      Runium_Env: {
-        type: 'object',
-        additionalProperties: {
-          $ref: '#/$defs/Runium_EnvValue',
-        },
-      },
-      Runium_TaskStartMode: {
-        type: 'string',
-        enum: Object.values(ProjectTaskStartMode),
-      },
-      Runium_TaskHandler: {
-        type: 'object',
-        properties: {
-          action: {
-            $ref: '#/$defs/Runium_Action',
-          },
-          condition: {
-            $ref: '#/$defs/Runium_TaskStateCondition',
-          },
-        },
-        required: ['action', 'condition'],
-        additionalProperties: false,
-      },
-      Runium_TaskStateCondition: {
-        oneOf: [
-          {
-            type: 'string',
-          },
-          {
-            type: 'boolean',
-          },
-          {
-            $ref: '#/$defs/Runium_TaskState',
-          },
-        ],
-      },
-      Runium_TaskState: {
-        type: 'object',
-        properties: {
-          status: {
-            $ref: '#/$defs/Runium_TaskStatus',
-          },
-          iteration: {
-            type: 'number',
-            minimum: 0,
-          },
-          exitCode: {
-            type: 'number',
-            minimum: 0,
-          },
-          reason: {
-            type: 'string',
-          },
-        },
-        additionalProperties: false,
-      },
-      Runium_TaskStatus: {
-        type: 'string',
-        enum: Object.values(TaskStatus),
-      },
-      Runium_TaskDependency: {
-        type: 'object',
-        properties: {
-          taskId: {
-            type: 'string',
-          },
-          condition: {
-            $ref: '#/$defs/Runium_TaskStateCondition',
-          },
-        },
-        required: ['taskId', 'condition'],
-        additionalProperties: false,
-      },
-      Runium_Trigger: {
-        oneOf: [
-          {
-            $ref: '#/$defs/Runium_TriggerEvent',
-          },
-          {
-            $ref: '#/$defs/Runium_TriggerInterval',
-          },
-          {
-            $ref: '#/$defs/Runium_TriggerTimeout',
-          },
-        ],
-      },
-      Runium_TriggerEvent: {
-        type: 'object',
-        properties: {
-          ...structuredClone(TRIGGER_COMMON_PROPERTIES),
-          type: {
-            const: ProjectTriggerType.EVENT,
-          },
-          event: {
-            type: 'string',
-          },
-        },
-        required: ['id', 'type', 'event', 'action'],
-        additionalProperties: false,
-      },
-      Runium_TriggerInterval: {
-        type: 'object',
-        properties: {
-          ...structuredClone(TRIGGER_COMMON_PROPERTIES),
-          type: {
-            const: ProjectTriggerType.INTERVAL,
-          },
-          interval: {
-            type: 'number',
-            minimum: 0,
-          },
-        },
-        required: ['id', 'type', 'interval', 'action'],
-        additionalProperties: false,
-      },
-      Runium_TriggerTimeout: {
-        type: 'object',
-        properties: {
-          ...structuredClone(TRIGGER_COMMON_PROPERTIES),
-          type: {
-            const: ProjectTriggerType.TIMEOUT,
-          },
-          timeout: {
-            type: 'number',
-            minimum: 0,
-          },
-        },
-        required: ['id', 'type', 'timeout', 'action'],
-        additionalProperties: false,
-      },
-      Runium_Action: {
-        oneOf: [
-          {
-            $ref: '#/$defs/Runium_ActionEmitEvent',
-          },
-          {
-            $ref: '#/$defs/Runium_ActionProcessTask',
-          },
-          {
-            $ref: '#/$defs/Runium_ActionStopProject',
-          },
-          {
-            $ref: '#/$defs/Runium_ActionToggleTrigger',
-          },
-        ],
-      },
-      Runium_ActionEmitEvent: {
-        type: 'object',
-        properties: {
-          type: {
-            type: 'string',
-            const: ProjectActionType.EMIT_EVENT,
-          },
-          event: {
-            type: 'string',
-          },
-        },
-        required: ['type', 'event'],
-        additionalProperties: false,
-      },
-      Runium_ActionProcessTask: {
-        type: 'object',
-        properties: {
-          type: {
-            type: 'string',
-            enum: [
-              ProjectActionType.START_TASK,
-              ProjectActionType.RESTART_TASK,
-              ProjectActionType.STOP_TASK,
-            ],
-          },
-          taskId: {
-            type: 'string',
-          },
-        },
-        required: ['type', 'taskId'],
-        additionalProperties: false,
-      },
-      Runium_ActionStopProject: {
-        type: 'object',
-        properties: {
-          type: {
-            type: 'string',
-            const: ProjectActionType.STOP_PROJECT,
-          },
-        },
-        required: ['type'],
-        additionalProperties: false,
-      },
-      Runium_ActionToggleTrigger: {
-        type: 'object',
-        properties: {
-          type: {
-            type: 'string',
-            enum: [
-              ProjectActionType.ENABLE_TRIGGER,
-              ProjectActionType.DISABLE_TRIGGER,
-            ],
-          },
-          triggerId: {
-            type: 'string',
-          },
-        },
-        required: ['type', 'triggerId'],
-        additionalProperties: false,
-      },
-      Runium_TaskConfig: {
-        ...createTaskSchema(ProjectTaskType.DEFAULT, {
-          $ref: '#/$defs/Runium_TaskOptions',
-        }),
-      },
-      Runium_TaskOptions: {
-        type: 'object',
-        properties: {
-          command: {
-            type: 'string',
-          },
-          arguments: {
-            type: 'array',
-            items: {
-              type: 'string',
-            },
-          },
-          shell: {
-            type: 'boolean',
-          },
-          cwd: {
-            type: 'string',
-          },
-          env: {
-            $ref: '#/$defs/Runium_Env',
-          },
-          ttl: {
-            type: 'number',
-          },
-          log: {
-            $ref: '#/$defs/Runium_TaskLog',
-          },
-          stopSignal: {
-            type: 'string',
-          },
-        },
-        required: ['command'],
-        additionalProperties: false,
-      },
-      Runium_TaskRestartPolicy: {
-        oneOf: [
-          {
-            $ref: '#/$defs/Runium_TaskRestartPolicyAlways',
-          },
-          {
-            $ref: '#/$defs/Runium_TaskRestartPolicyOnFailure',
-          },
-        ],
-      },
-      Runium_TaskRestartPolicyAlways: {
-        type: 'object',
-        required: ['policy'],
-        properties: {
-          policy: {
-            const: ProjectTaskRestartPolicyType.ALWAYS,
-          },
-          delay: {
-            type: 'number',
-          },
-        },
-        additionalProperties: false,
-      },
-      Runium_TaskRestartPolicyOnFailure: {
-        type: 'object',
-        required: ['policy'],
-        properties: {
-          policy: {
-            const: ProjectTaskRestartPolicyType.ON_FAILURE,
-          },
-          delay: {
-            type: 'number',
-          },
-          maxRetries: {
-            type: 'number',
-          },
-        },
-        additionalProperties: false,
-      },
-      Runium_TaskLog: {
-        type: 'object',
-        properties: {
-          stdout: {
-            type: ['string', 'null'],
-          },
-          stderr: {
-            type: ['string', 'null'],
-          },
-        },
-        additionalProperties: false,
-      },
-    },
-  };
-
-  return Object.freeze(schema as object);
-}
-
-/**
- * Extend project schema
- * @param schema
- * @param extensions
- */
-export function extendProjectSchema(
-  schema: object,
-  extensions: ProjectSchemaExtension
-): object {
-  let result = structuredClone(schema) as ProjectSchema;
-
-  // extend project properties
-  if (extensions.project) {
-    result = extendProjectPropertiesSchema(result, extensions.project);
-  }
-
-  // extend definitions
-  if (extensions.definitions) {
-    result = extendDefinitionsSchema(result, extensions.definitions);
-  }
-
-  // extend tasks
-  if (extensions.tasks) {
-    result = extendTasksSchema(result, extensions.tasks);
-  }
-
-  // extend actions
-  if (extensions.actions) {
-    result = extendActionsSchema(result, extensions.actions);
-  }
-
-  // extend triggers
-  if (extensions.triggers) {
-    result = extendTriggersSchema(result, extensions.triggers);
-  }
-
-  return Object.freeze(result as object);
-}
-
-/**
- * Extend project properties schema
- * @param schema
- * @param extension
- */
-function extendProjectPropertiesSchema(
-  schema: ProjectSchema,
-  extension: ProjectSchemaExtension['project']
-): ProjectSchema {
-  if (extension) {
-    schema.properties = {
-      ...(extension.properties || {}),
-      ...schema.properties,
-    };
-    schema.required = Array.from(
-      new Set([...(schema.required ?? []), ...(extension.required ?? [])])
-    );
-  }
-  return schema;
-}
-
-/**
- * Extend definitions schema
- * @param schema
- * @param extension
- */
-function extendDefinitionsSchema(
-  schema: ProjectSchema,
-  extension: ProjectSchemaExtension['definitions']
-): ProjectSchema {
-  if (extension) {
-    schema.$defs = {
-      ...(extension as Record<string, unknown>),
-      ...schema.$defs,
-    };
-  }
-  return schema;
-}
-
-/**
- * Extend tasks schema
- * @param schema
- * @param extension
- */
-function extendTasksSchema(
-  schema: ProjectSchema,
-  extension: ProjectSchemaExtension['tasks']
-): ProjectSchema {
-  if (extension) {
-    // check types uniqueness
-    const taskTypes = new Set(
-      schema.properties.tasks.items.oneOf.map(task => {
-        const taskDef = task.$ref.split('/').pop() || '';
-        return (
-          (schema.$defs[taskDef] as ProjectSchemaTask)?.properties?.type
-            ?.const || ProjectTaskType.DEFAULT
-        );
-      })
-    );
-
-    const tasks: Record<string, object> = {};
-    for (const [key, value] of Object.entries(extension)) {
-      if (taskTypes.has(value.type)) {
-        throw new RuniumError(
-          `Task type "${value.type}" already used in project schema`,
-          ProjectSchemaErrorCode.TASK_TYPE_ALREADY_USED,
-          {
-            type: value.type,
-          }
-        );
-      }
-      tasks[key] = createTaskSchema(value.type, value.options);
-
-      schema.properties.tasks.items.oneOf.push({
-        $ref: `#/$defs/${key}`,
-      });
-
-      taskTypes.add(value.type);
-    }
-    schema.$defs = {
-      ...tasks,
-      ...schema.$defs,
-    };
-  }
-  return schema;
-}
-
-/**
- * Extend actions schema
- * @param schema
- * @param extension
- */
-function extendActionsSchema(
-  schema: ProjectSchema,
-  extension: ProjectSchemaExtension['actions']
-): ProjectSchema {
-  if (extension) {
-    // check types uniqueness
-    const actionTypes = new Set(
-      schema.$defs.Runium_Action.oneOf
-        .map(action => {
-          const actionDef = action.$ref.split('/').pop() || '';
-          const actionType = (schema.$defs[actionDef] as ProjectSchemaAction)
-            ?.properties?.type;
-          return actionType?.enum || [actionType?.const];
-        })
-        .flat()
-    );
-
-    const actions: Record<string, object> = {};
-    for (const [key, value] of Object.entries(extension)) {
-      if (actionTypes.has(value.type)) {
-        throw new RuniumError(
-          `Action type "${value.type}" already used in project schema`,
-          ProjectSchemaErrorCode.ACTION_TYPE_ALREADY_USED,
-          {
-            type: value.type,
-          }
-        );
-      }
-
-      actions[key] = createActionSchema(value.type, value.payload);
-
-      schema.$defs.Runium_Action.oneOf.push({
-        $ref: `#/$defs/${key}`,
-      });
-
-      actionTypes.add(value.type);
-    }
-    schema.$defs = {
-      ...actions,
-      ...schema.$defs,
-    };
-  }
-  return schema;
-}
-
-/**
- * Extend triggers schema
- * @param schema
- * @param extension
- */
-function extendTriggersSchema(
-  schema: ProjectSchema,
-  extension: ProjectSchemaExtension['triggers']
-): ProjectSchema {
-  if (extension) {
-    // check types uniqueness
-    const triggerTypes = new Set(
-      schema.$defs.Runium_Trigger.oneOf.map(trigger => {
-        const triggerDef = trigger.$ref.split('/').pop() || '';
-        const triggerType = (schema.$defs[triggerDef] as ProjectSchemaAction)
-          ?.properties?.type;
-        return triggerType?.const;
-      })
-    );
-
-    const triggers: Record<string, object> = {};
-    for (const [key, value] of Object.entries(extension)) {
-      if (triggerTypes.has(value.type)) {
-        throw new RuniumError(
-          `Trigger type "${value.type}" already used in project schema`,
-          ProjectSchemaErrorCode.TRIGGER_TYPE_ALREADY_USED,
-          {
-            type: value.type,
-          }
-        );
-      }
-
-      triggers[key] = createTriggerSchema(value.type, value.payload);
-
-      schema.$defs.Runium_Trigger.oneOf.push({
-        $ref: `#/$defs/${key}`,
-      });
-
-      triggerTypes.add(value.type);
-    }
-    schema.$defs = {
-      ...triggers,
-      ...schema.$defs,
-    };
-  }
-  return schema;
-}