@runium/types-core 0.2.0 → 0.3.0

package/index.d.ts

@@ -5,18 +5,18 @@ declare module '@runium/core' {
 
   export function applyMacros(text: string, macros: MacrosCollection): string;
 
-  export class EventTrigger extends RuniumTrigger<EventTriggerOptions> {
+  export class EventTrigger extends RuniumTrigger<EventTriggerParams> {
     constructor(
-      options: EventTriggerOptions,
+      params: EventTriggerParams,
       project: RuniumTriggerProjectAccessible
     );
     enable(): void;
     disable(): void;
   }
 
-  export interface EventTriggerOptions extends RuniumTriggerOptions {
+  export type EventTriggerParams = RuniumTriggerParams<{
     event: string;
-  }
+  }>;
 
   export function extendProjectSchema(
     schema: object,
@@ -28,22 +28,24 @@ declare module '@runium/core' {
     WRITE_JSON = 'file-write-json',
   }
 
+  export function getProcessTreePids(pid: number): Promise<number[]>;
+
   export function getProjectSchema(): object;
 
   export const ID_REGEX: RegExp;
 
-  export class IntervalTrigger extends RuniumTrigger<IntervalTriggerOptions> {
+  export class IntervalTrigger extends RuniumTrigger<IntervalTriggerParams> {
     constructor(
-      options: IntervalTriggerOptions,
+      params: IntervalTriggerParams,
       project: RuniumTriggerProjectAccessible
     );
     enable(): void;
     disable(): void;
   }
 
-  export interface IntervalTriggerOptions extends RuniumTriggerOptions {
+  export type IntervalTriggerParams = RuniumTriggerParams<{
     interval: number;
-  }
+  }>;
 
   export function isCustomAction(
     action: ProjectAction
@@ -69,6 +71,13 @@ declare module '@runium/core' {
 
   export type JSONValue = string | number | boolean | JSONObject | JSONValue[];
 
+  export function killProcessTree(
+    pid: number,
+    signal?: NodeJS.Signals,
+    forceSignal?: NodeJS.Signals,
+    timeout?: number
+  ): Promise<void>;
+
   export type Macro = (...params: string[]) => string;
 
   export type MacrosCollection = Record<string, Macro>;
@@ -113,26 +122,37 @@ declare module '@runium/core' {
     | ProjectActionStopProject
     | ProjectActionToggleTrigger;
 
-  export interface ProjectActionEmitEvent {
+  export interface ProjectActionBase<Options = unknown> {
+    type: ProjectActionType;
+    options: Options;
+  }
+
+  export interface ProjectActionEmitEvent
+    extends ProjectActionBase<{
+      event: string;
+    }> {
     type: ProjectActionType.EMIT_EVENT;
-    event: string;
   }
 
-  export interface ProjectActionProcessTask {
+  export interface ProjectActionProcessTask
+    extends ProjectActionBase<{
+      taskId: string;
+    }> {
     type:
       | ProjectActionType.START_TASK
       | ProjectActionType.RESTART_TASK
       | ProjectActionType.STOP_TASK;
-    taskId: string;
   }
 
-  export interface ProjectActionStopProject {
+  export interface ProjectActionStopProject extends ProjectActionBase<never> {
     type: ProjectActionType.STOP_PROJECT;
   }
 
-  export interface ProjectActionToggleTrigger {
+  export interface ProjectActionToggleTrigger
+    extends ProjectActionBase<{
+      triggerId: string;
+    }> {
     type: ProjectActionType.ENABLE_TRIGGER | ProjectActionType.DISABLE_TRIGGER;
-    triggerId: string;
   }
 
   export enum ProjectActionType {
@@ -159,15 +179,11 @@ declare module '@runium/core' {
     TRIGGER_NOT_EXISTS = 'project-config-trigger-not-exists',
   }
 
-  export interface ProjectCustomAction {
-    type: string;
-    payload?: unknown;
-  }
+  export type ProjectCustomAction = ProjectActionBase;
 
-  export interface ProjectCustomTrigger extends ProjectTriggerBase {
-    type: string;
-    payload?: unknown;
-  }
+  export type ProjectCustomTrigger = ProjectTriggerBase<{
+    options: unknown;
+  }>;
 
   export interface ProjectDefaultTaskConfig
     extends ProjectTaskConfig<TaskOptions> {
@@ -203,6 +219,19 @@ declare module '@runium/core' {
     TRIGGER_TYPE_ALREADY_USED = 'project-schema-trigger-type-already-used',
   }
 
+  export interface ProjectSchemaExtension {
+    project?: ProjectSchemaExtensionProject;
+    tasks?: Record<string, ProjectSchemaExtensionTask>;
+    definitions?: Record<string, unknown>;
+    actions?: Record<string, ProjectSchemaExtensionAction>;
+    triggers?: Record<string, ProjectSchemaExtensionTrigger>;
+  }
+
+  export interface ProjectSchemaExtensionAction {
+    type: string;
+    options?: unknown;
+  }
+
   export interface ProjectSchemaExtensionProject {
     properties: unknown;
     required?: string[];
@@ -213,43 +242,9 @@ declare module '@runium/core' {
     options: unknown;
   }
 
-  export interface ProjectSchemaExtensionAction {
-    type: string;
-    payload?: unknown;
-  }
-
   export interface ProjectSchemaExtensionTrigger {
     type: string;
-    payload?: unknown;
-  }
-
-  export interface ProjectSchemaExtension {
-    project?: {
-      properties: unknown;
-      required?: string[];
-    };
-    tasks?: Record<
-      string,
-      {
-        type: string;
-        options: unknown;
-      }
-    >;
-    definitions?: Record<string, unknown>;
-    actions?: Record<
-      string,
-      {
-        type: string;
-        payload?: unknown;
-      }
-    >;
-    triggers?: Record<
-      string,
-      {
-        type: string;
-        payload?: unknown;
-      }
-    >;
+    options?: unknown;
   }
 
   export interface ProjectState {
@@ -329,26 +324,33 @@ declare module '@runium/core' {
     | ProjectTriggerTimeout
     | ProjectCustomTrigger;
 
-  interface ProjectTriggerBase {
+  interface ProjectTriggerBase<T = unknown> {
     id: string;
     type: ProjectTriggerType | string;
     action: ProjectAction;
     disabled?: boolean;
+    options: T;
   }
 
-  export interface ProjectTriggerEvent extends ProjectTriggerBase {
+  export interface ProjectTriggerEvent
+    extends ProjectTriggerBase<{
+      event: string;
+    }> {
     type: ProjectTriggerType.EVENT;
-    event: string;
   }
 
-  export interface ProjectTriggerInterval extends ProjectTriggerBase {
+  export interface ProjectTriggerInterval
+    extends ProjectTriggerBase<{
+      interval: number;
+    }> {
     type: ProjectTriggerType.INTERVAL;
-    interval: number;
   }
 
-  export interface ProjectTriggerTimeout extends ProjectTriggerBase {
+  export interface ProjectTriggerTimeout
+    extends ProjectTriggerBase<{
+      timeout: number;
+    }> {
     type: ProjectTriggerType.TIMEOUT;
-    timeout: number;
   }
 
   export enum ProjectTriggerType {
@@ -359,7 +361,7 @@ declare module '@runium/core' {
 
   export function readJsonFile<T = JSONValue>(path: string): Promise<T>;
 
-  type RuniumActionProcessor = (payload: unknown) => void;
+  type RuniumActionProcessor = (options: unknown) => void;
 
   export class RuniumError extends Error {
     code: string;
@@ -394,27 +396,29 @@ declare module '@runium/core' {
     reason?: string;
   }
 
-  export abstract class RuniumTrigger<Options extends RuniumTriggerOptions> {
+  export abstract class RuniumTrigger<Params extends RuniumTriggerParams> {
     protected project: RuniumTriggerProjectAccessible;
     protected id: string;
     protected action: ProjectAction;
     protected disabled: boolean;
-    constructor(options: Options, project: RuniumTriggerProjectAccessible);
+    constructor(params: Params, project: RuniumTriggerProjectAccessible);
     abstract enable(): void;
     abstract disable(): void;
     getId(): string;
     isDisabled(): boolean;
+    processAction(): void;
   }
 
-  export type RuniumTriggerConstructor<Options extends RuniumTriggerOptions> =
+  export type RuniumTriggerConstructor<Params extends RuniumTriggerParams> =
     new (
-      options: Options,
+      params: Params,
       project: RuniumTriggerProjectAccessible
-    ) => RuniumTrigger<Options>;
+    ) => RuniumTrigger<Params>;
 
-  export interface RuniumTriggerOptions {
+  export interface RuniumTriggerParams<Options = unknown> {
     id: string;
     action: ProjectAction;
+    options: Options;
     disabled?: boolean;
   }
 
@@ -488,18 +492,18 @@ declare module '@runium/core' {
     STOPPED = 'stopped',
   }
 
-  export class TimeoutTrigger extends RuniumTrigger<TimeoutTriggerOptions> {
+  export class TimeoutTrigger extends RuniumTrigger<TimeoutTriggerParams> {
     constructor(
-      options: TimeoutTriggerOptions,
+      params: TimeoutTriggerParams,
       project: RuniumTriggerProjectAccessible
     );
     enable(): void;
     disable(): void;
   }
 
-  export interface TimeoutTriggerOptions extends RuniumTriggerOptions {
+  export type TimeoutTriggerParams = RuniumTriggerParams<{
     timeout: number;
-  }
+  }>;
 
   export function validateProject(project: ProjectConfig, schema: object): void;
 
@@ -507,13 +511,4 @@ declare module '@runium/core' {
     path: string,
     data: T
   ): Promise<void>;
-
-  export function getProcessTreePids(pid: number): Promise<number[]>;
-
-  export function killProcessTree(
-    pid: number,
-    signal?: NodeJS.Signals,
-    forceSignal?: NodeJS.Signals,
-    timeout?: number
-  ): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runium/types-core",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "TypeScript type definitions for Runium Core",
   "author": "TheBeastApp",
   "license": "MIT",