@hotmeshio/hotmesh 0.3.32 → 0.4.1

package/types/activity.ts

@@ -1,268 +0,0 @@
-import { MetricTypes } from './stats';
-import { StreamRetryPolicy } from './stream';
-
-type ActivityExecutionType =
-  | 'trigger'
-  | 'await'
-  | 'worker'
-  | 'activity'
-  | 'emit'
-  | 'interrupt'
-  | 'cycle'
-  | 'signal'
-  | 'hook';
-
-type Consumes = Record<string, string[]>;
-
-interface BaseActivity {
-  title?: string;
-  type?: ActivityExecutionType;
-  subtype?: string;
-  statusThreshold?: number; //default is 0; set to 1 to ensure not last standing; message will be ignored as if too late to process
-  statusThresholdType?: 'stop' | 'throw' | 'stall'; //default is stop; must explicitly set to throw to throw an error or stall to stall
-  input?: Record<string, any>;
-  output?: Record<string, any>;
-  settings?: Record<string, any>;
-  job?: Record<string, any>;
-  hook?: Record<string, any>;
-  telemetry?: Record<string, any>;
-  emit?: boolean; //if true, the activity will emit a message to the `publishes` topic immediately before transitioning to adjacent activities
-  sleep?: number; //@pipe /in seconds
-  expire?: number; //-1 forever; 0 persists the flow until the parent flow that expired it is dismissed; 15 seconds is the default (copied from the YAML at compile time)
-  persistent?: boolean; //if true, the job will persist beyond completion (copied from the YAML at compile time)
-  persist?: boolean; //when true, the activity will emit the job completed event and start the `persistence countdown`, using the 'expire' value
-  retry?: StreamRetryPolicy;
-  cycle?: boolean; //if true, the `notary` will leave leg 2 open, so it can be re/cycled
-  collationInt?: number; //compiler
-  consumes?: Consumes; //compiler
-  PRODUCES?: string[]; //compiler
-  produces?: string[]; //compiler
-  publishes?: string; //compiler
-  subscribes?: string; //compiler
-  trigger?: string; //compiler
-  parent?: string; //compiler
-  ancestors?: string[]; //compiler
-}
-
-interface Measure {
-  measure: MetricTypes;
-  target: string;
-}
-
-interface TriggerActivityStats {
-  /**
-   * dependent parent job id; including this allows the parent's
-   * expiration/interruption events to cascade; set
-   * `expire` in the YAML for the dependent graph
-   * to 0 and provide the parent for dependent,
-   * cascading interruption and cleanup
-   */
-  parent?: string;
-  /**
-   * adjacent parent job id; this is the actual adjacent
-   * parent in the graph, but it is not used for cascading expiration
-   */
-  adjacent?: string;
-  id?: { [key: string]: unknown } | string;
-  key?: { [key: string]: unknown } | string;
-  /**
-   * @deprecated
-   * return 'infinity' to disable; default behavior
-   * is to always segment keys by time to ensure
-   * indexes (Redis LIST) never grow unbounded
-   * as a default behavior; for now, 5m is default
-   * and infinity can be set to override
-   */
-  granularity?: string;
-  /**
-   * @deprecated
-   * what to capture
-   */
-  measures?: Measure[];
-}
-
-interface TriggerActivity extends BaseActivity {
-  type: 'trigger';
-  stats?: TriggerActivityStats;
-}
-
-interface AwaitActivity extends BaseActivity {
-  type: 'await';
-  eventName: string;
-  timeout: number;
-  await?: boolean; //if exlicitly false do not await the response
-}
-
-interface WorkerActivity extends BaseActivity {
-  type: 'worker';
-  topic: string;
-  timeout: number;
-}
-
-interface CycleActivity extends BaseActivity {
-  type: 'cycle';
-  ancestor: string; //ancestor activity id
-}
-
-interface HookActivity extends BaseActivity {
-  type: 'hook';
-}
-
-interface SignalActivity extends BaseActivity {
-  type: 'signal'; //signal activities call hook/hookAll
-  subtype: 'one' | 'all'; //trigger: hook(One) or hookAll
-  topic: string; //e.g., 'hook.resume'
-  key_name?: string; //e.g., 'parent_job_id'
-  key_value?: string; //e.g., '1234567890'
-  scrub?: boolean; //if true, the index will be deleted after use
-  signal?: Record<string, any>; //used to define/map the signal input data (what to send/singnal into the job(s))
-  resolver?: Record<string, any>; //used to define/map the signal key resolver (the key used to lookup the job(s that are assigned to the key)
-  status?: string; //pending, success (default), error
-  code?: number; //202, 200 (default)
-}
-
-interface InterruptActivity extends BaseActivity {
-  type: 'interrupt';
-
-  /**
-   * Optional Reason; will be used as the error `message` when thrown
-   * @default 'Job Interrupted'
-   */
-  reason?: string;
-
-  /**
-   * throw JobInterrupted error upon interrupting
-   * @default true
-   */
-  throw?: boolean;
-
-  /**
-   * Interrupt child/descendant jobs
-   * @default false
-   */
-  descend?: boolean;
-
-  /**
-   * Target job id (if not present the current job will be targeted)
-   */
-  target?: string;
-
-  /**
-   * Optional topic to publish the interrupt message (if not present the current job topic will be used
-   */
-  topic?: string;
-
-  /**
-   * Optional Error Code; will be used as the error `code` when thrown
-   * @default 410
-   */
-  code?: number;
-
-  /**
-   * Optional stack trace
-   */
-  stack?: string;
-}
-
-type ActivityType =
-  | BaseActivity
-  | TriggerActivity
-  | AwaitActivity
-  | WorkerActivity
-  | InterruptActivity
-  | HookActivity
-  | SignalActivity
-  | CycleActivity;
-
-type ActivityData = Record<string, any>;
-
-/**
- * Type definition for activity metadata.
- */
-type ActivityMetadata = {
-  /**
-   * Unique identifier for the activity.
-   */
-  aid: string;
-
-  /**
-   * Type of the activity.
-   */
-  atp: string;
-
-  /**
-   * Subtype of the activity.
-   */
-  stp: string;
-
-  /**
-   * Timestamp when the activity was created, in GMT.
-   */
-  ac: string;
-
-  /**
-   * Timestamp when the activity was last updated, in GMT.
-   */
-  au: string;
-
-  /**
-   * Optional stringified JSON containing error details such as message, code, and an optional error object.
-   */
-  err?: string;
-
-  /**
-   * OpenTelemetry span context for the first leg of the activity.
-   */
-  l1s?: string;
-
-  /**
-   * OpenTelemetry span context for the second leg of the activity.
-   */
-  l2s?: string;
-
-  /**
-   * Dimensional address, used for additional metadata.
-   */
-  dad?: string;
-
-  /**
-   * Status of the activity, could be codes representing different states.
-   */
-  as?: string;
-};
-
-type ActivityContext = {
-  data?: ActivityData | null;
-  metadata: ActivityMetadata;
-  hook?: ActivityData;
-};
-
-type ActivityDuplex = 1 | 2;
-
-type ActivityDataType = {
-  data?: Record<string, unknown>;
-  metadata?: Record<string, unknown>;
-  hook?: Record<string, unknown>;
-};
-
-type ActivityLeg = 1 | 2;
-
-export {
-  ActivityContext,
-  ActivityData,
-  ActivityDataType,
-  ActivityDuplex,
-  ActivityLeg,
-  ActivityMetadata,
-  ActivityType,
-  Consumes,
-  TriggerActivityStats,
-  AwaitActivity,
-  CycleActivity,
-  HookActivity,
-  SignalActivity,
-  BaseActivity,
-  InterruptActivity,
-  TriggerActivity,
-  WorkerActivity,
-};

package/types/app.ts

@@ -1,20 +0,0 @@
-interface App {
-  name: string;
-  title: string;
-  description: string;
-}
-
-type AppVID = {
-  version: string;
-  id: string;
-};
-
-type AppTransitions = {
-  [key: string]: Record<string, unknown>;
-};
-
-type AppSubscriptions = {
-  [key: string]: string;
-};
-
-export { App, AppVID, AppTransitions, AppSubscriptions };

package/types/async.ts

@@ -1,6 +0,0 @@
-type AsyncSignal = {
-  topic: string;
-  jobId: string;
-};
-
-export { AsyncSignal };

package/types/cache.ts

@@ -1 +0,0 @@
-export type CacheMode = 'nocache' | 'cache';

package/types/collator.ts

@@ -1,9 +0,0 @@
-export type CollationStage = 'enter' | 'exit' | 'confirm';
-
-export enum CollationFaultType {
-  MISSING = 'missing', //`as` uninitialized; leg1 entry not allowed
-  DUPLICATE = 'duplicate', //1st digit < 8
-  INACTIVE = 'inactive', //3rd digit is 8
-  INVALID = 'invalid', //unknown value (corrupt for unknown reasons)
-  FORBIDDEN = 'forbidden', //leg 1 not completed; reentry (leg 2) not allowed
-}

package/types/error.ts

@@ -1,56 +0,0 @@
-export type MeshFlowChildErrorType = {
-  arguments: string[];
-  await?: boolean;
-  backoffCoefficient?: number;
-  index: number;
-  expire?: number;
-  persistent?: boolean;
-  signalIn?: boolean;
-  maximumAttempts?: number;
-  maximumInterval?: number;
-  originJobId: string | null;
-  parentWorkflowId: string;
-  workflowDimension: string;
-  workflowId: string;
-  workflowTopic: string;
-};
-
-export type MeshFlowWaitForAllErrorType = {
-  items: string[];
-  workflowId: string;
-  workflowTopic: string;
-  parentWorkflowId: string;
-  originJobId: string | null;
-  size: number;
-  index: number;
-  workflowDimension: string;
-};
-
-export type MeshFlowProxyErrorType = {
-  arguments: string[];
-  activityName: string;
-  backoffCoefficient?: number;
-  index: number;
-  expire?: number;
-  maximumAttempts?: number;
-  maximumInterval?: number;
-  originJobId: string | null;
-  parentWorkflowId: string;
-  workflowDimension: string;
-  workflowId: string;
-  workflowTopic: string;
-};
-
-export type MeshFlowWaitForErrorType = {
-  signalId: string;
-  index: number;
-  workflowDimension: string;
-  workflowId: string;
-};
-
-export type MeshFlowSleepErrorType = {
-  duration: number;
-  index: number;
-  workflowDimension: string;
-  workflowId: string;
-};

package/types/exporter.ts

@@ -1,102 +0,0 @@
-import { StringAnyType } from './serializer';
-
-export type ExportItem = [string | null, string, any];
-
-/**
- * job export data can be large, particularly transitions the timeline
- */
-export type ExportFields =
-  | 'data'
-  | 'state'
-  | 'status'
-  | 'timeline'
-  | 'transitions';
-
-export interface ExportOptions {
-  /**
-   * limit the export byte size by specifying an allowlist
-   */
-  allow?: Array<ExportFields>;
-
-  /**
-   * limit the export byte size by specifying a block list
-   */
-  block?: Array<ExportFields>;
-
-  /**
-   * If false, do not return timeline values (like child job response, proxy activity response, etc)
-   * @default true
-   */
-  values?: boolean;
-}
-
-export type JobAction = {
-  cursor: number;
-  items: ExportItem[];
-};
-
-export interface JobActionExport {
-  hooks: {
-    [key: string]: JobAction;
-  };
-  main: JobAction;
-}
-
-export interface ActivityAction {
-  action: string;
-  target: string;
-}
-
-export interface JobTimeline {
-  activity: string; //activity name
-  dimension: string; //dimensional isolate path
-  duplex: 'entry' | 'exit'; //activity entry or exit
-  timestamp: string; //actually a number but too many digits for JS
-  created?: string; //actually a number but too many digits for JS
-  updated?: string; //actually a number but too many digits for JS
-  actions?: ActivityAction[];
-}
-
-export interface DependencyExport {
-  type: string;
-  topic: string;
-  gid: string;
-  jid: string;
-}
-
-export interface ExportTransitions {
-  [key: string]: string[];
-}
-
-export interface ExportCycles {
-  [key: string]: string[];
-}
-
-export type TimelineType = {
-  key: string;
-  value: Record<string, any> | string | number | null;
-  index: number;
-  secondary?: number;
-  dimension?: string;
-};
-
-export interface TransitionType {
-  activity: string;
-  dimensions: string;
-  created: string;
-  updated: string;
-}
-
-export interface MeshFlowJobExport {
-  data?: StringAnyType;
-  state?: StringAnyType;
-  status?: number;
-  timeline?: TimelineType[];
-  transitions?: TransitionType[];
-}
-
-export interface JobExport {
-  dependencies: DependencyExport[];
-  process: StringAnyType;
-  status: string;
-}

package/types/hook.ts

@@ -1,44 +0,0 @@
-interface HookCondition {
-  expected: string;
-  actual: string;
-}
-
-enum HookGate {
-  AND = 'and',
-  OR = 'or',
-}
-
-interface HookConditions {
-  gate?: HookGate;
-  match: HookCondition[];
-}
-
-interface HookRule {
-  to: string;
-  conditions: HookConditions;
-}
-
-interface HookRules {
-  [eventName: string]: HookRule[];
-}
-
-type HookSignal = {
-  topic: string;
-  resolved: string;
-  jobId: string;
-  expire: number;
-};
-
-interface HookInterface {
-  (topic: string, data: { [key: string]: any; id: string }): Promise<void>;
-}
-
-export {
-  HookCondition,
-  HookConditions,
-  HookGate,
-  HookInterface,
-  HookRule,
-  HookRules,
-  HookSignal,
-};