@hotmeshio/hotmesh 0.0.19 → 0.0.21

package/types/activity.ts

@@ -70,14 +70,16 @@ interface HookActivity extends BaseActivity {
 }
 
 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
-  resolver?: Record<string, any>; //used to define/map the signal key resolver
+  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 IterateActivity extends BaseActivity {

package/types/durable.ts

@@ -15,9 +15,10 @@ type WorkflowSearchOptions = {
 }
 
 type WorkflowOptions = {
+  namespace?: string;   //'durable' is the default namespace if not provided; similar to setting `appid` in the YAML
   taskQueue: string;
   args: any[];          //input arguments to pass in
-  workflowId: string;   //execution id (the job id)
+  workflowId?: string;   //execution id (the job id)
   workflowName?: string; //the name of the user's workflow function
   parentWorkflowId?: string;  //system reserved; the id of the parent; if present the flow will not self-clean until the parent that spawned it self-cleans
   workflowTrace?: string;
@@ -26,6 +27,16 @@ type WorkflowOptions = {
   config?: WorkflowConfig;
 }
 
+type HookOptions = {
+  namespace?: string;   //'durable' is the default namespace if not provided; similar to setting `appid` in the YAML
+  taskQueue: string;
+  args: any[];          //input arguments to pass into the hook
+  workflowId: string;   //execution id (the job id to hook into)
+  workflowName?: string; //the name of the user's hook function
+  search?: WorkflowSearchOptions //bind additional search terms immediately before hook reentry
+  config?: WorkflowConfig; //hook function constraints (backoffCoefficient, maximumAttempts, maximumInterval, initialInterval)
+}
+
 type SignalOptions = {
   taskQueue: string;
   data: Record<string, any>; //input data (any serializable object)
@@ -71,6 +82,7 @@ type WorkerConfig = {
 }
 
 type WorkerOptions = {
+  logLevel?: string; //debug, info, warn, error
   maxSystemRetries?: number; //1-3 (10ms, 100ms, 1_000ms)
   backoffCoefficient?: number; //2-10ish
 }
@@ -107,6 +119,7 @@ export {
   ProxyType,
   Registry,
   SignalOptions,
+  HookOptions,
   WorkerConfig,
   WorkflowConfig,
   WorkerOptions,

package/types/hook.ts

@@ -16,7 +16,6 @@ interface HookConditions {
 
 interface HookRule {
   to: string;
-  keep_alive?: boolean; //if true, the hook will not be deleted after use
   conditions: HookConditions;
 }
 

package/types/index.ts

@@ -37,6 +37,7 @@ export {
     NativeConnection,
     ProxyType,
     Registry,
+    HookOptions,
     WorkflowConfig,
     WorkerConfig,
     WorkerOptions,