@hotmeshio/hotmesh 0.0.59 → 0.1.0

package/types/hook.ts

@@ -1,4 +1,3 @@
-
 interface HookCondition {
   expected: string;
   actual: string;
@@ -23,10 +22,18 @@ interface HookRules {
   [eventName: string]: HookRule[];
 }
 
-type HookSignal = { topic: string, resolved: string, jobId: string};
+type HookSignal = { topic: string; resolved: string; jobId: string };
 
 interface HookInterface {
-  (topic: string, data: { [key: string]: any, id: string }): Promise<void>;
+  (topic: string, data: { [key: string]: any; id: string }): Promise<void>;
 }
 
-export { HookCondition, HookConditions, HookGate, HookInterface, HookRule, HookRules, HookSignal };
+export {
+  HookCondition,
+  HookConditions,
+  HookGate,
+  HookInterface,
+  HookRule,
+  HookRules,
+  HookSignal,
+};

package/types/hotmesh.ts

@@ -1,5 +1,6 @@
 import { ILogger } from '../services/logger';
 import { HotMeshService } from '../services/hotmesh';
+
 import { HookRules } from './hook';
 import { RedisClass, RedisClient, RedisOptions } from './redis';
 import { StreamData, StreamDataResponse } from './stream';
@@ -28,22 +29,22 @@ enum KeyType {
   SYMVALS = 'SYMVALS',
   TIME_RANGE = 'TIME_RANGE',
   WORK_ITEMS = 'WORK_ITEMS',
-};
+}
 
 /**
  * minting keys, requires one or more of the following parameters
  */
 type KeyStoreParams = {
-  appId?: string;       //app id is a uuid for a hotmesh app
-  engineId?: string;    //unique auto-generated guid for an ephemeral engine instance
-  appVersion?: string;  //(e.g. "1.0.0", "1", "1.0")
-  jobId?: string;       //a customer-defined id for job; must be unique for the entire app
-  activityId?: string;  //activity id is a uuid for a given hotmesh app
-  jobKey?: string;      //a customer-defined label for a job that serves to categorize events 
-  dateTime?: string;    //UTC date time: YYYY-MM-DDTHH:MM (20203-04-12T00:00); serves as a time-series bucket for the job_key
-  facet?: string;       //data path starting at root with values separated by colons (e.g. "object/type:bar")
-  topic?: string;       //topic name (e.g., "foo" or "" for top-level)
-  timeValue?: number;   //time value (rounded to minute) (for delete range)
+  appId?: string; //app id is a uuid for a hotmesh app
+  engineId?: string; //unique auto-generated guid for an ephemeral engine instance
+  appVersion?: string; //(e.g. "1.0.0", "1", "1.0")
+  jobId?: string; //a customer-defined id for job; must be unique for the entire app
+  activityId?: string; //activity id is a uuid for a given hotmesh app
+  jobKey?: string; //a customer-defined label for a job that serves to categorize events
+  dateTime?: string; //UTC date time: YYYY-MM-DDTHH:MM (20203-04-12T00:00); serves as a time-series bucket for the job_key
+  facet?: string; //data path starting at root with values separated by colons (e.g. "object/type:bar")
+  topic?: string; //topic name (e.g., "foo" or "" for top-level)
+  timeValue?: number; //time value (rounded to minute) (for delete range)
   scoutType?: 'signal' | 'time' | 'activate'; //a single member of the quorum serves as the 'scout' for the group, triaging tasks for the collective
 };
 
@@ -52,27 +53,27 @@ type HotMesh = typeof HotMeshService;
 type RedisConfig = {
   class: Partial<RedisClass>;
   options: Partial<RedisOptions>;
-}
+};
 
 type HotMeshEngine = {
-  store?: RedisClient;  //set by hotmesh using instanced `redis` class
+  store?: RedisClient; //set by hotmesh using instanced `redis` class
   stream?: RedisClient; //set by hotmesh using instanced `redis` class
-  sub?: RedisClient;    //set by hotmesh using instanced `redis` class
+  sub?: RedisClient; //set by hotmesh using instanced `redis` class
   redis?: RedisConfig;
   reclaimDelay?: number; //milliseconds
   reclaimCount?: number;
-}
+};
 
 type HotMeshWorker = {
   topic: string;
-  store?: RedisClient;  //set by hotmesh using instanced `redis` class
+  store?: RedisClient; //set by hotmesh using instanced `redis` class
   stream?: RedisClient; //set by hotmesh using instanced `redis` class
-  sub?: RedisClient;    //set by hotmesh using instanced `redis` class
+  sub?: RedisClient; //set by hotmesh using instanced `redis` class
   redis?: RedisConfig;
   reclaimDelay?: number; //milliseconds
   reclaimCount?: number; //max number of times to reclaim a stream
-  callback: (payload: StreamData) => Promise<StreamDataResponse|void>;
-}
+  callback: (payload: StreamData) => Promise<StreamDataResponse | void>;
+};
 
 type HotMeshConfig = {
   appId: string;
@@ -82,7 +83,7 @@ type HotMeshConfig = {
   logLevel?: LogLevel;
   engine?: HotMeshEngine;
   workers?: HotMeshWorker[];
-}
+};
 
 type HotMeshGraph = {
   subscribes: string;
@@ -118,10 +119,10 @@ type VersionedFields = {
 };
 
 type HotMeshApp = VersionedFields & {
-  id: string;        // customer's chosen app id
-  version: string;   // customer's chosen version scheme (semver, etc)
+  id: string; // customer's chosen app id
+  version: string; // customer's chosen version scheme (semver, etc)
   settings?: string; // stringified JSON for app settings
-  active?: boolean;  // is the app active?
+  active?: boolean; // is the app active?
 };
 
 type HotMeshApps = {
@@ -134,8 +135,8 @@ export {
   RedisConfig,
   HotMeshWorker,
   HotMeshSettings,
-  HotMeshApp,    //a single app in the db
-  HotMeshApps,   //object array of all apps in the db
+  HotMeshApp, //a single app in the db
+  HotMeshApps, //object array of all apps in the db
   HotMeshConfig, //customer config
   HotMeshManifest,
   HotMeshGraph,

package/types/index.ts

@@ -15,50 +15,45 @@ export {
   InterruptActivity,
   SignalActivity,
   TriggerActivity,
-  TriggerActivityStats } from './activity';
-export {
-  App,
-  AppVID,
-  AppTransitions,
-  AppSubscriptions
-} from './app';
+  TriggerActivityStats,
+} from './activity';
+export { App, AppVID, AppTransitions, AppSubscriptions } from './app';
 export { AsyncSignal } from './async';
 export { CacheMode } from './cache';
-export {
-  CollationFaultType,
-  CollationStage } from './collator';
-export {
-    ActivityConfig,
-    ActivityWorkflowDataType,
-    ChildResponseType,
-    ClientConfig,
-    ContextType,
-    ConnectionConfig,
-    Connection,
-    ProxyResponseType,
-    ProxyType,
-    Registry,
-    SignalOptions,
-    FindJobsOptions,
-    FindOptions,
-    FindWhereOptions,
-    FindWhereQuery,
-    HookOptions,
-    SearchResults,
-    WorkflowConfig,
-    WorkerConfig,
-    WorkerOptions,
-    WorkflowContext,
-    WorkflowSearchOptions,
-    WorkflowDataType,
-    WorkflowOptions,
-  } from './durable';
+export { CollationFaultType, CollationStage } from './collator';
+export {
+  ActivityConfig,
+  ActivityWorkflowDataType,
+  ChildResponseType,
+  ClientConfig,
+  ContextType,
+  ConnectionConfig,
+  Connection,
+  ProxyResponseType,
+  ProxyType,
+  Registry,
+  SignalOptions,
+  FindJobsOptions,
+  FindOptions,
+  FindWhereOptions,
+  FindWhereQuery,
+  HookOptions,
+  SearchResults,
+  WorkflowConfig,
+  WorkerConfig,
+  WorkerOptions,
+  WorkflowContext,
+  WorkflowSearchOptions,
+  WorkflowDataType,
+  WorkflowOptions,
+} from './durable';
 export {
   DurableChildErrorType,
   DurableProxyErrorType,
   DurableSleepErrorType,
   DurableWaitForAllErrorType,
-  DurableWaitForErrorType } from "./error";
+  DurableWaitForErrorType,
+} from './error';
 export {
   ActivityAction,
   DependencyExport,
@@ -70,7 +65,8 @@ export {
   JobAction,
   JobExport,
   JobActionExport,
-  JobTimeline } from './exporter';
+  JobTimeline,
+} from './exporter';
 export {
   HookCondition,
   HookConditions,
@@ -78,7 +74,7 @@ export {
   HookInterface,
   HookRule,
   HookRules,
-  HookSignal
+  HookSignal,
 } from './hook';
 export { ILogger } from './logger';
 export {
@@ -91,7 +87,8 @@ export {
   JobOutput,
   JobState,
   JobStatus,
-  PartialJobState } from './job';
+  PartialJobState,
+} from './job';
 export { MappingStatements } from './map';
 export {
   Pipe,
@@ -99,7 +96,8 @@ export {
   PipeItem,
   PipeItems,
   PipeObject,
-  ReduceObject } from './pipe';
+  ReduceObject,
+} from './pipe';
 export {
   HotMesh,
   HotMeshApp,
@@ -112,7 +110,8 @@ export {
   HotMeshSettings,
   HotMeshWorker,
   KeyStoreParams,
-  KeyType } from './hotmesh';
+  KeyType,
+} from './hotmesh';
 export {
   ActivateMessage,
   CronMessage,
@@ -130,7 +129,8 @@ export {
   SystemHealth,
   ThrottleMessage,
   ThrottleOptions,
-  WorkMessage } from './quorum';
+  WorkMessage,
+} from './quorum';
 export {
   RedisClass,
   RedisRedisClientType,
@@ -157,7 +157,8 @@ export {
   SymbolMaps,
   SymbolRanges,
   Symbols,
-  SymbolSets } from './serializer';
+  SymbolSets,
+} from './serializer';
 export {
   AggregatedData,
   CountByFacet,
@@ -174,7 +175,8 @@ export {
   JobStatsRange,
   StatsResponse,
   Segment,
-  TimeSegment } from './stats';
+  TimeSegment,
+} from './stats';
 export {
   ReclaimedMessageType,
   StreamCode,
@@ -185,7 +187,8 @@ export {
   StreamDataResponse,
   StreamRetryPolicy,
   StreamRole,
-  StreamStatus } from './stream';
+  StreamStatus,
+} from './stream';
 export {
   context,
   Context,
@@ -200,10 +203,7 @@ export {
   SpanKind,
   trace,
   Tracer,
-  ValueType } from './telemetry';
-export {
-  WorkListTaskType } from './task'
-export {
-  TransitionMatch,
-  TransitionRule,
-  Transitions } from './transition';
+  ValueType,
+} from './telemetry';
+export { WorkListTaskType } from './task';
+export { TransitionMatch, TransitionRule, Transitions } from './transition';

package/types/job.ts

@@ -1,6 +1,6 @@
-import { StringStringType } from "./serializer";
+import { StringStringType } from './serializer';
 
-type JobData = Record<string, unknown|Record<string, unknown>>;
+type JobData = Record<string, unknown | Record<string, unknown>>;
 type JobsData = Record<string, unknown>;
 
 type ActivityData = {
@@ -11,75 +11,75 @@ type ActivityData = {
 type JobMetadata = {
   /** job_key */
   key?: string;
-  
+
   /** system assigned guid that corresponds to the transition message guid that spawned reentry */
   guid?: string;
-  
+
   /** system assigned guid; ensured created/deleted/created jobs are unique */
   gid: string;
-  
+
   /** job_id (jid+dad+aid) is composite key for activity */
   jid: string;
-  
+
   /** dimensional address for the activity (,0,0,1) */
   dad: string;
-  
+
   /** activity_id as in the YAML file */
   aid: string;
-  
+
   /** parent_job_id (pj+pd+pa) is composite key for parent activity */
   pj?: string;
-  
+
   /** parent_generational_id (system assigned at trigger inception); pg is the parent job's gid (just in case user created/deleted/created a job with same jid) */
   pg?: string;
-  
+
   /** parent_dimensional_address */
   pd?: string;
-  
+
   /** parent_activity_id */
   pa?: string;
-  
+
   /** sever the dependency chain if true (startChild/vs/execChild) */
   px?: boolean;
-  
+
   /** engine guid (one time subscriptions) */
   ngn?: string;
-  
+
   /** app_id */
   app: string;
-  
+
   /** app version */
   vrs: string;
-  
+
   /** subscription topic */
   tpc: string;
-  
+
   /** 201203120005 (slice of time) //time series */
   ts: string;
-  
+
   /** GMT created //job_created */
   jc: string;
-  
+
   /** GMT updated //job_updated */
   ju: string;
-  
+
   js: JobStatus;
-  
+
   /** activity_type */
   atp: string;
-  
+
   /** activity_subtype */
   stp: string;
-  
+
   /** open telemetry span context */
   spn: string;
-  
+
   /** open telemetry trace context */
   trc: string;
-  
+
   /** stringified job error json: {message: string, code: number, error?} */
   err?: string;
-  
+
   /** process data expire policy */
   expire?: number;
 };
@@ -106,7 +106,7 @@ type ExtensionType = {
    * the initial data set.
    */
   marker?: StringStringType;
-}
+};
 
 /**
  * job_status semaphore
@@ -126,19 +126,19 @@ type JobState = {
 };
 
 type JobInterruptOptions = {
-  /** 
+  /**
    * 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
    */
@@ -157,7 +157,7 @@ type JobInterruptOptions = {
    */
   expire?: number;
 
-  /** 
+  /**
    * Optional Error Code; will be used as the error `code` when thrown
    * @default 410
    */
@@ -188,10 +188,10 @@ type PartialJobState = {
 type JobCompletionOptions = {
   /** default false */
   emit?: boolean;
-  
+
   /** default undefined */
   interrupt?: boolean;
-  
+
   /**
    * in seconds to wait before deleting/expiring job hash
    * @default 1 second

package/types/logger.ts

@@ -3,6 +3,6 @@ export interface ILogger {
   error(message: string, ...meta: any[]): void;
   warn(message: string, ...meta: any[]): void;
   debug(message: string, ...meta: any[]): void;
-};
+}
 
 export type LogLevel = 'silly' | 'debug' | 'info' | 'warn' | 'error' | 'silent';

package/types/map.ts

@@ -2,4 +2,4 @@ type MappingStatements = {
   [activityId: string]: string[];
 };
 
-export { MappingStatements };
+export { MappingStatements };

package/types/pipe.ts

@@ -1,4 +1,4 @@
-/** 
+/**
  * Represents a single cell value in a pipeline row
  * If the value is a string, the value will be a literal OR mapping expression
  */
@@ -22,20 +22,20 @@ type PipeObject = { '@pipe': Array<PipeItem[] | PipeObject | ReduceObject> };
  * But it also iterates and produces output. The context variables,
  * `$input`, `$output`, `$item`, `$key`, and `$index` are available.
  * @example
- * 
+ *
  * // Example of a reduce expression. The optional object is empty and
  * // serves as the $output during iteration. The last step in the iteration
  * // sets $output. if ther are no more iterations, the $output is returned
- * // and provided to the next step in the pipeline. 
- * 
+ * // and provided to the next step in the pipeline.
+ *
  * // If data is:
  * // { response: ['a', 'b', 'c'] }
- * 
+ *
  * // The reduced/transformed expression will be:
  * // { 'a': 0, 'b': 1, 'c': 2 }
- * 
+ *
  * // Arrays and objects may be iterated over and transformed.
- * 
+ *
  * //YAML
  * '@pipe':
  *   - ['{data.response}', {}]
@@ -48,7 +48,9 @@ type PipeObject = { '@pipe': Array<PipeItem[] | PipeObject | ReduceObject> };
  *           - ['{$index}']
  *       - ['{@object.set}']
  */
-type ReduceObject = { '@reduce': Array<PipeItem[] | PipeObject | ReduceObject> };
+type ReduceObject = {
+  '@reduce': Array<PipeItem[] | PipeObject | ReduceObject>;
+};
 
 /**
  * Represents a sequence in the pipeline that can include arrays of `PipeItem`, `PipeObject`, or `ReduceObject`.

package/types/quorum.ts

@@ -1,4 +1,4 @@
-import { JobOutput } from "./job";
+import { JobOutput } from './job';
 
 interface CPULoad {
   [cpu: string]: string;
@@ -71,7 +71,7 @@ interface QuorumMessageBase {
 export interface PingMessage extends QuorumMessageBase {
   type: 'ping';
   originator: string; //guid
-  details?: boolean;  //if true, all endpoints will include their profile
+  details?: boolean; //if true, all endpoints will include their profile
 }
 
 export interface WorkMessage extends QuorumMessageBase {
@@ -86,9 +86,9 @@ export interface CronMessage extends QuorumMessageBase {
 
 export interface PongMessage extends QuorumMessageBase {
   type: 'pong';
-  guid: string;            //call initiator
-  originator: string;      //clone of originator guid passed in ping
-  entity?: string;         //optional entity
+  guid: string; //call initiator
+  originator: string; //clone of originator guid passed in ping
+  entity?: string; //optional entity
   profile?: QuorumProfile; //contains details about the engine/worker
 }
 
@@ -102,25 +102,25 @@ export interface JobMessage extends QuorumMessageBase {
   type: 'job';
   entity?: string;
   topic: string; //this comes from the 'publishes' field in the YAML
-  job: JobOutput
+  job: JobOutput;
 }
 
 export interface ThrottleMessage extends QuorumMessageBase {
   type: 'throttle';
   guid?: string; //target engine AND workers with this guid
   entity?: string;
-  topic?: string;  //target worker(s) matching this topic (pass null to only target the engine, pass undefined to target engine and workers)
+  topic?: string; //target worker(s) matching this topic (pass null to only target the engine, pass undefined to target engine and workers)
   throttle: number; //0-n; millis
 }
 
 export interface RollCallMessage extends QuorumMessageBase {
   type: 'rollcall';
-  guid?: string;    //target the engine quorum
+  guid?: string; //target the engine quorum
   entity?: string;
-  topic?: string | null;   //target a worker if string; suppress if `null`;
+  topic?: string | null; //target a worker if string; suppress if `null`;
   interval: number; //every 'n' seconds
-  max?: number;     //max broadcasts
-  signature?: boolean; //include bound worker function in broadcast   
+  max?: number; //max broadcasts
+  signature?: boolean; //include bound worker function in broadcast
 }
 
 export interface JobMessageCallback {
@@ -144,11 +144,18 @@ export type SubscriptionOptions = {
   namespace?: string;
 };
 
-
 /**
  * The types in this file are used to define those messages that are sent
  * to hotmesh client instances when a new version is about to be activated.
  * These messages serve to coordinate the cache invalidation and switch-over
  * to the new version without any downtime and a coordinating parent server.
  */
-export type QuorumMessage = PingMessage | PongMessage | ActivateMessage | WorkMessage | JobMessage | ThrottleMessage | RollCallMessage | CronMessage;
+export type QuorumMessage =
+  | PingMessage
+  | PongMessage
+  | ActivateMessage
+  | WorkMessage
+  | JobMessage
+  | ThrottleMessage
+  | RollCallMessage
+  | CronMessage;