@hotmeshio/hotmesh 0.0.60 → 0.1.0

package/types/durable.ts

@@ -7,19 +7,19 @@ import { StreamData, StreamError } from './stream';
  * Type definition for workflow configuration.
  */
 type WorkflowConfig = {
-  /** 
+  /**
    * Backoff coefficient for retry mechanism.
    * @default 10 (HMSH_DURABLE_EXP_BACKOFF)
    */
   backoffCoefficient?: number;
 
-  /** 
+  /**
    * Maximum number of attempts for retries.
    * @default 5 (HMSH_DURABLE_MAX_ATTEMPTS)
    */
   maximumAttempts?: number;
 
-  /** 
+  /**
    * Maximum interval between retries.
    * @default 120s (HMSH_DURABLE_MAX_INTERVAL)
    */
@@ -32,10 +32,9 @@ type WorkflowConfig = {
    * @default true
    */
   throwOnError?: boolean;
-}
+};
 
 type WorkflowContext = {
-
   /**
    * can the workflow be retried if an error occurs
    */
@@ -46,7 +45,7 @@ type WorkflowContext = {
      * the reentrant semaphore parent counter object for object reference during increment
      */
     counter: number;
-  }
+  };
 
   /**
    * the reentrant semaphore, incremented in real-time as idempotent statements are re-traversed upon reentry. Indicates the current semaphore count.
@@ -83,7 +82,7 @@ type WorkflowContext = {
    */
   workflowId: string;
 
-  /** 
+  /**
    * the dimensional isolation for the reentrant hook, expressed in the format `0,0`, `0,1`, etc
    */
   workflowDimension: string;
@@ -107,134 +106,134 @@ type WorkflowContext = {
    * the native HotMesh message that encapsulates the arguments, metadata, and raw data for the workflow
    */
   raw: StreamData;
-}
+};
 
 type WorkflowSearchOptions = {
-
   /** FT index name (myapp:myindex) */
   index?: string;
 
   /** FT prefixes (['myapp:myindex:prefix1', 'myapp:myindex:prefix2']) */
   prefix?: string[];
 
-  /** 
+  /**
    * Schema mapping each field. Each field is a key-value pair where the key is the field name
    * and the value is a record of field options. If the fieldName is provided,
    * it will be used as the indexed field name. If not provided
    * key will be used as the indexed field name with an underscore prefix.
-   * 
-   */
-  schema?: Record<string, {
-    /**
-     * The FT.SEARCH field type. One of: TEXT, NUMERIC, TAG. TEXT is
-     * most expensive, but also most expressive.
-     */
-    type: 'TEXT' | 'NUMERIC' | 'TAG';
-
-    /**
-     * FT.SEARCH SORTABLE field. If true, results may be sorted according to this field
-     * @default false
-     */
-    sortable?: boolean;
-
-    /**
-     * FT.SEARCH NOSTEM field. applies to TEXT fields types.
-     * If true, the text field index will not stem words
-     * @default false
-     */
-    nostem?: boolean;
-
-    /**
-     * FT.SEARCH NOINDEX field. If true and if the field is sortable, the field will aid
-     * in sorting results but not be directly indexed as a standalone
-     * @default false
-     */
-    noindex?: boolean;
-
-    /**
-     * if true, the field is indexed and searchable within the FT.SEARCH index
-     * This is different from `noindex` which is FT.SEARCH specific and relates
-     * to sorting and indexing. This is a general flag for the field that will
-     * enable or disable indexing and searching entirely. Use for fields with
-     * absolutely no meaning to query or sorting but which are important
-     * nonetheless as part of the data record that is saved and returned.
-     * @default true
-     */
-    indexed?: boolean;
-
-    /**
-     * An array of possible values for the field
-     */
-    examples?: string[];
-
-    /**
-     * The 'nilable' setting may NOT be set to `true` for 
-     * NUMBER types as it causes an indexing error;
-     * consider a custom (e.g., negative number) value to represent
-     * `null` if desired for a NUMERIC field.
-     * Set to true only if the field is a TEXT or TAG type and
-     * you wish to save the string `null` as a value to search
-     * on (the tag, {null}, or the string, (null)
-     * @default false
-     */
-    nilable?: boolean;
-
-    /**
-     * possible scalar/primitive types for the field. Use when
-     * serializing and restoring data to ensure the field is
-     * properly typed. If not provided, the field will be
-     * treated as a string.
-     */
-    primitive?: 'string' | 'number' | 'boolean' | 'array' | 'object';
-
-    /**
-     * if true, the field is required to be present in the data record
-     * @default false
-     */
-    required?: boolean;
-
-    /**
-     * an enumerated list of allowed values; if field is nilable, it is implied
-     * and therefore not necessary to include `null` in the list
-     * @default []
-     */
-    enum?: string[];
-
-    /**
-     * a regular expression pattern for the field
-     * @default '.*'
-     * @example '^[a-zA-Z0-9_]*$'
-     */
-    pattern?: string;
-
-    /**
-     * literal value to use for the indexed field name (without including the standard underscore (_) prefix isolate)
-     */
-    fieldName?: string;
-  }>;
+   *
+   */
+  schema?: Record<
+    string,
+    {
+      /**
+       * The FT.SEARCH field type. One of: TEXT, NUMERIC, TAG. TEXT is
+       * most expensive, but also most expressive.
+       */
+      type: 'TEXT' | 'NUMERIC' | 'TAG';
+
+      /**
+       * FT.SEARCH SORTABLE field. If true, results may be sorted according to this field
+       * @default false
+       */
+      sortable?: boolean;
+
+      /**
+       * FT.SEARCH NOSTEM field. applies to TEXT fields types.
+       * If true, the text field index will not stem words
+       * @default false
+       */
+      nostem?: boolean;
+
+      /**
+       * FT.SEARCH NOINDEX field. If true and if the field is sortable, the field will aid
+       * in sorting results but not be directly indexed as a standalone
+       * @default false
+       */
+      noindex?: boolean;
+
+      /**
+       * if true, the field is indexed and searchable within the FT.SEARCH index
+       * This is different from `noindex` which is FT.SEARCH specific and relates
+       * to sorting and indexing. This is a general flag for the field that will
+       * enable or disable indexing and searching entirely. Use for fields with
+       * absolutely no meaning to query or sorting but which are important
+       * nonetheless as part of the data record that is saved and returned.
+       * @default true
+       */
+      indexed?: boolean;
+
+      /**
+       * An array of possible values for the field
+       */
+      examples?: string[];
+
+      /**
+       * The 'nilable' setting may NOT be set to `true` for
+       * NUMBER types as it causes an indexing error;
+       * consider a custom (e.g., negative number) value to represent
+       * `null` if desired for a NUMERIC field.
+       * Set to true only if the field is a TEXT or TAG type and
+       * you wish to save the string `null` as a value to search
+       * on (the tag, {null}, or the string, (null)
+       * @default false
+       */
+      nilable?: boolean;
+
+      /**
+       * possible scalar/primitive types for the field. Use when
+       * serializing and restoring data to ensure the field is
+       * properly typed. If not provided, the field will be
+       * treated as a string.
+       */
+      primitive?: 'string' | 'number' | 'boolean' | 'array' | 'object';
+
+      /**
+       * if true, the field is required to be present in the data record
+       * @default false
+       */
+      required?: boolean;
+
+      /**
+       * an enumerated list of allowed values; if field is nilable, it is implied
+       * and therefore not necessary to include `null` in the list
+       * @default []
+       */
+      enum?: string[];
+
+      /**
+       * a regular expression pattern for the field
+       * @default '.*'
+       * @example '^[a-zA-Z0-9_]*$'
+       */
+      pattern?: string;
+
+      /**
+       * literal value to use for the indexed field name (without including the standard underscore (_) prefix isolate)
+       */
+      fieldName?: string;
+    }
+  >;
 
   /** Additional data as a key-value record */
   data?: StringStringType;
-}
-
+};
 
 type SearchResults = {
   /**
    * the total number of results
    */
-  count: number,
+  count: number;
   /**
    * the raw FT.SEARCH query string
    */
-  query: string,
+  query: string;
   /**
    * the raw FT.SEARCH results as an array of objects
    */
-  data: StringStringType[]
+  data: StringStringType[];
 };
 
 type WorkflowOptions = {
-
   /**
    * the namespace for the workflow; `durable` is the default namespace if not provided
    */
@@ -288,12 +287,12 @@ type WorkflowOptions = {
   /**
    * the full-text-search (RediSearch) options for the workflow
    */
-  search?: WorkflowSearchOptions
+  search?: WorkflowSearchOptions;
 
   /**
    * marker data (begins with a -)
    */
-  marker?: StringStringType
+  marker?: StringStringType;
 
   /**
    * the workflow configuration object
@@ -309,9 +308,9 @@ type WorkflowOptions = {
    * default is true; if false, will not await the execution
    */
   await?: boolean;
-}
+};
 
-/** 
+/**
  * Options for setting up a hook.
  * 'durable' is the default namespace if not provided; similar to setting `appid` in the YAML
  */
@@ -324,80 +323,80 @@ type HookOptions = {
 
   /** Input arguments to pass into the hook */
   args: any[];
-     
+
   /**
    * Optional entity name. If provided, applies as the workflowName,
    * taskQueue, and prefix. This scopes the FT.SEARCH index appropriately.
    * This is a convenience method but limits options.
    */
   entity?: string;
-  
+
   /** Execution ID, also known as the job ID to hook into */
   workflowId?: string;
-  
+
   /** The name of the user's hook function */
   workflowName?: string;
-  
+
   /** Bind additional search terms immediately before hook reentry */
-  search?: WorkflowSearchOptions
-  
+  search?: WorkflowSearchOptions;
+
   /** Hook function constraints (backoffCoefficient, maximumAttempts, maximumInterval) */
-  config?: WorkflowConfig; 
-}
+  config?: WorkflowConfig;
+};
 
-/** 
+/**
  * Options for sending signals in a workflow.
  */
 type SignalOptions = {
-  /** 
-   * Task queue associated with the workflow 
+  /**
+   * Task queue associated with the workflow
    */
   taskQueue: string;
 
-  /** 
-   * Input data for the signal (any serializable object) 
+  /**
+   * Input data for the signal (any serializable object)
    */
-  data: StringAnyType; 
+  data: StringAnyType;
 
-  /** 
-   * Execution ID, also known as the job ID 
+  /**
+   * Execution ID, also known as the job ID
    */
   workflowId: string;
 
-  /** 
-   * Optional name of the user's workflow function 
+  /**
+   * Optional name of the user's workflow function
    */
   workflowName?: string;
-}
+};
 
 type ActivityWorkflowDataType = {
   activityName: string;
   arguments: any[];
   workflowId: string;
   workflowTopic: string;
-}
+};
 
 type WorkflowDataType = {
   arguments: any[];
   workflowId: string;
   workflowTopic: string;
   workflowDimension?: string; //is present if hook (not main workflow)
-  originJobId?: string;       //is present if there is an originating ancestor job (should rename to originJobId)
+  originJobId?: string; //is present if there is an originating ancestor job (should rename to originJobId)
   canRetry?: boolean;
-}
+};
 
 type ConnectionConfig = {
   class: Partial<RedisClass>;
   options: Partial<RedisOptions>;
-}
-type Connection =  ConnectionConfig;
+};
+type Connection = ConnectionConfig;
 
 type ClientConfig = {
   connection: Connection;
-}
+};
 
-type Registry  = {
-  [key: string]: Function
+type Registry = {
+  [key: string]: Function;
 };
 type WorkerConfig = {
   /** Connection configuration for the worker */
@@ -420,15 +419,14 @@ type WorkerConfig = {
 
   /** Search options for workflow execution details */
   search?: WorkflowSearchOptions;
-}
-
+};
 
 type FindWhereQuery = {
   field: string;
   is: '=' | '==' | '>=' | '<=' | '[]';
   value: string | boolean | number | [number, number];
   type?: string; //default is TEXT
-}
+};
 
 type FindOptions = {
   workflowName?: string; //also the function name
@@ -436,7 +434,7 @@ type FindOptions = {
   namespace?: string;
   index?: string;
   search?: WorkflowSearchOptions;
-}
+};
 
 type FindWhereOptions = {
   options?: FindOptions;
@@ -444,10 +442,10 @@ type FindWhereOptions = {
   query: FindWhereQuery[];
   return?: string[];
   limit?: {
-    start: number,
-    size: number
-  }
-}
+    start: number;
+    size: number;
+  };
+};
 
 type FindJobsOptions = {
   /** The workflow name; include an asterisk for wilcard search; refer to Redis SCAN for the allowed format */
@@ -464,7 +462,7 @@ type FindJobsOptions = {
 
   /** The start cursor; defaults to 0 */
   cursor?: string;
-}
+};
 
 type WorkerOptions = {
   /** Log level: debug, info, warn, error */
@@ -478,14 +476,16 @@ type WorkerOptions = {
 
   /** Maximum interval between retries, default 120s (HMSH_DURABLE_MAX_INTERVAL) */
   maximumInterval?: string;
-}
+};
 
 type ContextType = {
-  workflowId: string
-  workflowTopic: string
+  workflowId: string;
+  workflowTopic: string;
 };
 
-type FunctionSignature<T> = T extends (...args: infer A) => infer R ? (...args: A) => R : never;
+type FunctionSignature<T> = T extends (...args: infer A) => infer R
+  ? (...args: A) => R
+  : never;
 type ProxyType<ACT> = {
   [K in keyof ACT]: FunctionSignature<ACT[K]>;
 };
@@ -517,22 +517,22 @@ type ActivityConfig = {
  * The proxy response object returned from the activity proxy flow
  */
 type ProxyResponseType<T> = {
-  data?: T,             //expected data
-  $error?: StreamError,
-  done?: boolean,       //non-existent if error was thrown in transition (not during execution)
-  jc: string,
-  ju: string
+  data?: T; //expected data
+  $error?: StreamError;
+  done?: boolean; //non-existent if error was thrown in transition (not during execution)
+  jc: string;
+  ju: string;
 };
 
 /**
  * The child flow response object returned from the  main flow during recursion
  */
 type ChildResponseType<T> = {
-  data?: T,             //expected data
-  $error?: StreamError,
-  done?: boolean,       //non-existent if error was thrown in transition (not during execution)
-  jc: string,
-  ju: string
+  data?: T; //expected data
+  $error?: StreamError;
+  done?: boolean; //non-existent if error was thrown in transition (not during execution)
+  jc: string;
+  ju: string;
 };
 
 export {
@@ -543,7 +543,7 @@ export {
   ContextType,
   ConnectionConfig,
   Connection,
-  ProxyResponseType,  
+  ProxyResponseType,
   ProxyType,
   Registry,
   SignalOptions,

package/types/error.ts

@@ -1,52 +1,52 @@
 export type DurableChildErrorType = {
-  arguments: string[],
-  await?: boolean,
-  backoffCoefficient?: number,
-  index: number,
-  maximumAttempts?: number,
-  maximumInterval?: number,
-  originJobId: string | null,
-  parentWorkflowId: string,
-  workflowDimension: string,
-  workflowId: string,
-  workflowTopic: string,
+  arguments: string[];
+  await?: boolean;
+  backoffCoefficient?: number;
+  index: number;
+  maximumAttempts?: number;
+  maximumInterval?: number;
+  originJobId: string | null;
+  parentWorkflowId: string;
+  workflowDimension: string;
+  workflowId: string;
+  workflowTopic: string;
 };
 
 export type DurableWaitForAllErrorType = {
-  items: string[],
-  workflowId: string,
-  workflowTopic: string,
-  parentWorkflowId: string,
-  originJobId: string | null,
-  size: number,
-  index: number,
-  workflowDimension: string
+  items: string[];
+  workflowId: string;
+  workflowTopic: string;
+  parentWorkflowId: string;
+  originJobId: string | null;
+  size: number;
+  index: number;
+  workflowDimension: string;
 };
 
 export type DurableProxyErrorType = {
-  arguments: string[],
-  activityName: string,
-  backoffCoefficient?: number,
-  index: number,
-  maximumAttempts?: number,
-  maximumInterval?: number,
-  originJobId: string | null,
-  parentWorkflowId: string,
-  workflowDimension: string,
-  workflowId: string,
-  workflowTopic: string,
+  arguments: string[];
+  activityName: string;
+  backoffCoefficient?: number;
+  index: number;
+  maximumAttempts?: number;
+  maximumInterval?: number;
+  originJobId: string | null;
+  parentWorkflowId: string;
+  workflowDimension: string;
+  workflowId: string;
+  workflowTopic: string;
 };
 
 export type DurableWaitForErrorType = {
-  signalId: string,
-  index: number,
-  workflowDimension: string
+  signalId: string;
+  index: number;
+  workflowDimension: string;
   workflowId: string;
 };
 
 export type DurableSleepErrorType = {
-  duration: number,
-  index: number,
-  workflowDimension: string,
-  workflowId: string,
+  duration: number;
+  index: number;
+  workflowDimension: string;
+  workflowId: string;
 };

package/types/exporter.ts

@@ -1,11 +1,16 @@
-import { StringAnyType } from "./serializer";
+import { StringAnyType } from './serializer';
 
-export type ExportItem = [(string | null), string, any];
+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 type ExportFields =
+  | 'data'
+  | 'state'
+  | 'status'
+  | 'timeline'
+  | 'transitions';
 
 export interface ExportOptions {
   /**
@@ -23,7 +28,7 @@ export interface ExportOptions {
    * @default true
    */
   values?: boolean;
-};
+}
 
 export type JobAction = {
   cursor: number;
@@ -35,7 +40,7 @@ export interface JobActionExport {
     [key: string]: JobAction;
   };
   main: JobAction;
-};
+}
 
 export interface ActivityAction {
   action: string;
@@ -61,11 +66,11 @@ export interface DependencyExport {
 
 export interface ExportTransitions {
   [key: string]: string[];
-};
+}
 
 export interface ExportCycles {
   [key: string]: string[];
-};
+}
 
 export type TimelineType = {
   key: string;
@@ -88,10 +93,10 @@ export interface DurableJobExport {
   status?: number;
   timeline?: TimelineType[];
   transitions?: TransitionType[];
-};
+}
 
 export interface JobExport {
   dependencies: DependencyExport[];
   process: StringAnyType;
   status: string;
-};
+}