@hotmeshio/hotmesh 0.3.32 → 0.4.1

package/types/hotmesh.ts

@@ -1,314 +0,0 @@
-import { ILogger } from '../services/logger';
-import { HotMesh as HotMeshService } from '../services/hotmesh';
-
-import { HookRules } from './hook';
-import { StreamData, StreamDataResponse } from './stream';
-import { LogLevel } from './logger';
-import { ProviderClient, ProviderConfig, ProvidersConfig } from './provider';
-
-/**
- * the full set of entity types that are stored in the key/value store
- */
-enum KeyType {
-  APP = 'APP',
-  THROTTLE_RATE = 'THROTTLE_RATE',
-  HOOKS = 'HOOKS',
-  JOB_DEPENDENTS = 'JOB_DEPENDENTS',
-  JOB_STATE = 'JOB_STATE',
-  JOB_STATS_GENERAL = 'JOB_STATS_GENERAL',
-  JOB_STATS_MEDIAN = 'JOB_STATS_MEDIAN',
-  JOB_STATS_INDEX = 'JOB_STATS_INDEX',
-  HOTMESH = 'HOTMESH',
-  QUORUM = 'QUORUM',
-  SCHEMAS = 'SCHEMAS',
-  SIGNALS = 'SIGNALS',
-  STREAMS = 'STREAMS',
-  SUBSCRIPTIONS = 'SUBSCRIPTIONS',
-  SUBSCRIPTION_PATTERNS = 'SUBSCRIPTION_PATTERNS',
-  SYMKEYS = 'SYMKEYS',
-  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)
-  scoutType?: 'signal' | 'time' | 'activate'; //a single member of the quorum serves as the 'scout' for the group, triaging tasks for the collective
-};
-
-type HotMesh = typeof HotMeshService;
-
-type HotMeshEngine = {
-  /**
-   * set by hotmesh once the connnector service instances the provider
-   * @private
-   */
-  store?: ProviderClient;
-  /**
-   * set by hotmesh once the connnector service instances the provider
-   * @private
-   */
-  stream?: ProviderClient;
-  /**
-   * set by hotmesh once the connnector service instances the provider
-   * @private
-   */
-  sub?: ProviderClient;
-  /**
-   * set by hotmesh once the connnector service instances the provider
-   * AND if the provider requires a separate channel for publishing
-   * @private
-   */
-  pub?: ProviderClient;
-  /**
-   * set by hotmesh once the connnector service instances the provider
-   * @private
-   */
-  search?: ProviderClient;
-
-  /**
-   * redis connection options; replaced with 'connection'
-   * @deprecated
-   */
-  redis?: ProviderConfig;
-
-  /**
-   * short-form format for the connection options for the
-   * store, stream, sub, and search clients
-   */
-  connection?: ProviderConfig | ProvidersConfig;
-
-  /**
-   * long-form format for the connection options for the
-   * store, stream, sub, and search clients
-   */
-  // connections?: {
-  //   store: ProviderConfig;
-  //   stream: ProviderConfig;
-  //   sub: ProviderConfig;
-  //   pub?: ProviderConfig; //system injects if necessary (if store channel cannot be used for pub)
-  //   search?: ProviderConfig; //inherits from store if not set
-  // };
-
-  /**
-   * the number of milliseconds to wait before reclaiming a stream;
-   * depending upon the provider this may be an explicit retry event,
-   * consuming a message from the stream and re-queueing it (dlq, etc),
-   * or it may be a configurable delay before the provider exposes the
-   * message to the consumer again. It is up to the provider, but expressed
-   * in milliseconds here.
-   */
-  reclaimDelay?: number;
-
-  /**
-   * the number of times to reclaim a stream before giving up
-   * and moving the message to a dead-letter queue or other
-   * error handling mechanism
-   */
-  reclaimCount?: number;
-
-  /**
-   * if true, the engine will not route stream messages
-   * to the worker
-   * @default false
-   */
-  readonly?: boolean;
-};
-
-type HotMeshWorker = {
-  /**
-   * the topic that the worker subscribes to
-   */
-  topic: string;
-
-  /**
-   * set by hotmesh once the connnector service instances the provider
-   * AND if the provider requires a separate channel for publishing
-   * @private
-   */
-  pub?: ProviderClient;
-
-  /**
-   * set by hotmesh once the connnector service instances the provider
-   * @private
-   */
-  store?: ProviderClient;
-  /**
-   * set by hotmesh once the connnector service instances the provider
-   * @private
-   */
-  stream?: ProviderClient;
-  /**
-   * set by hotmesh once the connnector service instances the provider
-   * @private
-   */
-  sub?: ProviderClient;
-  /**
-   * set by hotmesh once the connnector service instances the provider
-   * @private
-   */
-  search?: ProviderClient;
-
-  /**
-   * redis connection options; replaced with 'connection'
-   * @deprecated
-   */
-  redis?: ProviderConfig;
-
-  /**
-   * short-form format for the connection options for the
-   * store, stream, sub, and search clients
-   */
-  connection?: ProviderConfig | ProvidersConfig;
-
-  /**
-   * long-form format for the connection options for the
-   * store, stream, sub, and search clients
-   */
-  // connections?: {
-  //   store: ProviderConfig;
-  //   stream: ProviderConfig;
-  //   sub: ProviderConfig;
-  //   pub?: ProviderConfig; //if store channel cannot be used for pub
-  //   search?: ProviderConfig; //inherits from store if not set
-  // };
-
-  /**
-   * the number of milliseconds to wait before reclaiming a stream;
-   * depending upon the provider this may be an explicit retry event,
-   * consuming a message from the stream and re-queueing it (dlq, etc),
-   * or it may be a configurable delay before the provider exposes the
-   * message to the consumer again. It is up to the provider, but expressed
-   * in milliseconds here.
-   */
-  reclaimDelay?: number;
-
-  /**
-   * the number of times to reclaim a stream before giving up
-   * and moving the message to a dead-letter queue or other
-   * error handling mechanism
-   */
-  reclaimCount?: number;
-
-  /**
-   * The callback function to execute when a message is dequeued
-   * from the target stream
-   */
-  callback: (payload: StreamData) => Promise<StreamDataResponse>;
-};
-
-type HotMeshConfig = {
-  appId: string;
-  namespace?: string;
-  name?: string;
-  guid?: string;
-  logger?: ILogger;
-  logLevel?: LogLevel;
-  engine?: HotMeshEngine;
-  workers?: HotMeshWorker[];
-};
-
-type HotMeshGraph = {
-  /**
-   * the unique topic that the graph subscribes to, creating one
-   * job for each idempotent message that is received
-   */
-  subscribes: string;
-  /**
-   * the unique topic that the graph publishes/emits to when the job completes
-   */
-  publishes?: string;
-  /**
-   * the number of seconds that the completed job should be
-   * left in the store before it is deleted
-   */
-  expire?: number;
-  /**
-   * if the graph is reentrant and has open activities, the
-   * `persistent` flag will emit the job completed  event.
-   * This allows the 'main' thread/trigger that started the job to
-   * signal to subscribers (or the parent) that the job
-   * is 'done', while still leaving the job in a
-   * state that allows for reentry (such as cyclical hooks).
-   */
-  persistent?: boolean;
-  /**
-   * the schema for the output of the graph
-   */
-  output?: {
-    schema: Record<string, any>;
-  };
-  /**
-   * the schema for the input of the graph
-   */
-  input?: {
-    schema: Record<string, any>;
-  };
-  /**
-   * the activities that define the graph
-   */
-  activities: Record<string, any>;
-  /**
-   * the transitions that define how activities are connected
-   */
-  transitions?: Record<string, any>;
-  /**
-   * the reentrant hook rules that define how to reenter a running graph
-   */
-  hooks?: HookRules;
-};
-
-type HotMeshSettings = {
-  namespace: string;
-  version: string;
-};
-
-type HotMeshManifest = {
-  app: {
-    id: string;
-    version: string;
-    settings: Record<string, any>;
-    graphs: HotMeshGraph[];
-  };
-};
-
-type VersionedFields = {
-  [K in `versions/${string}`]: any;
-};
-
-type HotMeshApp = VersionedFields & {
-  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?
-};
-
-type HotMeshApps = {
-  [appId: string]: HotMeshApp;
-};
-
-export {
-  HotMesh,
-  HotMeshEngine,
-  HotMeshWorker,
-  HotMeshSettings,
-  HotMeshApp,
-  HotMeshApps,
-  HotMeshConfig,
-  HotMeshManifest,
-  HotMeshGraph,
-  KeyType,
-  KeyStoreParams,
-};

package/types/index.ts

@@ -1,306 +0,0 @@
-export {
-  ActivityType,
-  ActivityDataType,
-  ActivityContext,
-  ActivityData,
-  ActivityDuplex,
-  ActivityLeg,
-  ActivityMetadata,
-  Consumes,
-  AwaitActivity,
-  BaseActivity,
-  CycleActivity,
-  HookActivity,
-  WorkerActivity,
-  InterruptActivity,
-  SignalActivity,
-  TriggerActivity,
-  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,
-  ClientWorkflow,
-  ContextType,
-  Connection,
-  ProxyResponseType,
-  ProxyType,
-  Registry,
-  SignalOptions,
-  FindJobsOptions,
-  FindOptions,
-  FindWhereOptions,
-  FindWhereQuery,
-  HookOptions,
-  SearchResults,
-  WorkflowConfig,
-  WorkerConfig,
-  WorkerOptions,
-  WorkflowContext,
-  WorkflowSearchOptions,
-  WorkflowSearchSchema,
-  WorkflowDataType,
-  WorkflowOptions,
-} from './meshflow';
-export {
-  MeshFlowChildErrorType,
-  MeshFlowProxyErrorType,
-  MeshFlowSleepErrorType,
-  MeshFlowWaitForAllErrorType,
-  MeshFlowWaitForErrorType,
-} from './error';
-export {
-  ActivityAction,
-  DependencyExport,
-  MeshFlowJobExport,
-  ExportCycles,
-  ExportItem,
-  ExportOptions,
-  ExportTransitions,
-  JobAction,
-  JobExport,
-  JobActionExport,
-  JobTimeline,
-} from './exporter';
-export {
-  HookCondition,
-  HookConditions,
-  HookGate,
-  HookInterface,
-  HookRule,
-  HookRules,
-  HookSignal,
-} from './hook';
-export {
-  HotMesh,
-  HotMeshEngine,
-  HotMeshWorker,
-  HotMeshSettings,
-  HotMeshApp,
-  HotMeshApps,
-  HotMeshConfig,
-  HotMeshManifest,
-  HotMeshGraph,
-  KeyType,
-  KeyStoreParams,
-} from './hotmesh';
-export { ILogger, LogLevel } from './logger';
-export {
-  ExtensionType,
-  JobCompletionOptions,
-  JobData,
-  JobsData,
-  JobInterruptOptions,
-  JobMetadata,
-  JobOutput,
-  JobState,
-  JobStatus,
-  PartialJobState,
-} from './job';
-export {
-  DB,
-  Profile,
-  Namespaces,
-  Entity,
-  EntityInstanceTypes,
-  SubClassInstance,
-  AllSubclassInstances,
-  SubclassType,
-  Namespace,
-  Instance,
-  Instances,
-  Profiles,
-} from './manifest';
-export { MappingStatements } from './map';
-export {
-  Pipe,
-  PipeContext,
-  PipeItem,
-  PipeItems,
-  PipeObject,
-  ReduceObject,
-} from './pipe';
-export {
-  ProviderClass,
-  ProviderClient,
-  ProviderConfig,
-  ProviderTransaction,
-  Providers,
-  TransactionResultList,
-  ProviderNativeClient,
-  ProviderOptions,
-} from './provider';
-export {
-  MeshCallConnectParams,
-  MeshCallExecParams,
-  MeshCallCronParams,
-  MeshCallExecOptions,
-  MeshCallCronOptions,
-  MeshCallInterruptOptions,
-  MeshCallInterruptParams,
-  MeshCallFlushParams,
-} from './meshcall';
-export {
-  CallOptions,
-  MeshDataWorkflowOptions,
-  ConnectOptions,
-  ConnectionInput,
-  ExecInput,
-} from './meshdata';
-export {
-  PostgresClassType,
-  PostgresClientOptions,
-  PostgresClientType,
-  PostgresConsumerGroup,
-  PostgresPendingMessage,
-  PostgresPoolClientType,
-  PostgresQueryConfigType,
-  PostgresQueryResultType,
-  PostgresStreamMessage,
-  PostgresStreamOptions,
-  PostgresTransaction,
-} from './postgres';
-export {
-  ActivateMessage,
-  CronMessage,
-  JobMessage,
-  JobMessageCallback,
-  PingMessage,
-  PongMessage,
-  QuorumMessage,
-  QuorumMessageCallback,
-  QuorumProfile,
-  RollCallMessage,
-  RollCallOptions,
-  SubscriptionCallback,
-  SubscriptionOptions,
-  SystemHealth,
-  ThrottleMessage,
-  ThrottleOptions,
-  WorkMessage,
-} from './quorum';
-export {
-  NatsAckPolicy,
-  NatsAckPolicyExplicitType,
-  NatsClassType,
-  NatsClientType,
-  NatsClientOptions,
-  NatsConsumerConfigType,
-  NatsJetStreamManager,
-  NatsConnection,
-  NatsJetStreamType,
-  NatsConnectionOptions,
-  NatsConsumerConfig,
-  NatsConsumerInfo,
-  NatsConsumerManager,
-  NatsDeliveryInfo,
-  NatsJetStreamOptions,
-  NatsError,
-  NatsErrorType,
-  NatsJetStreamClient,
-  NatsJsMsg,
-  NatsMessageType,
-  NatsMsgExpect,
-  NatsPubAck,
-  NatsPubAckType,
-  NatsPublishOptions,
-  NatsRetentionPolicy,
-  NatsRetentionPolicyWorkqueueType,
-  NatsSequenceInfo,
-  NatsStorageMemoryType,
-  NatsStorageType,
-  NatsStreamConfig,
-  NatsStreamInfo,
-  NatsStreamManager,
-  NatsStreamConfigType,
-  NatsStreamInfoType,
-  NatsStreamOptions,
-  NatsStreamState,
-  NatsTransaction,
-} from './nats';
-export {
-  RedisClass,
-  RedisRedisClientType,
-  RedisRedisClientOptions,
-  RedisRedisClassType,
-  IORedisClientType,
-  RedisClient,
-  RedisMulti,
-  RedisRedisMultiType,
-  IORedisClientOptions,
-  IORedisClassType,
-  IORedisMultiType,
-  RedisOptions,
-  isRedisClient,
-  isIORedisClient,
-} from './redis';
-export {
-  JSONSchema,
-  StringAnyType,
-  StringScalarType,
-  StringStringType,
-  SymbolMap,
-  SymbolMaps,
-  SymbolRanges,
-  Symbols,
-  SymbolSets,
-} from './serializer';
-export {
-  AggregatedData,
-  CountByFacet,
-  GetStatsOptions,
-  IdsData,
-  Measure,
-  MeasureIds,
-  MetricTypes,
-  StatType,
-  StatsType,
-  IdsResponse,
-  JobStats,
-  JobStatsInput,
-  JobStatsRange,
-  StatsResponse,
-  Segment,
-  TimeSegment,
-} from './stats';
-export {
-  ReclaimedMessageType,
-  RouterConfig,
-  StreamCode,
-  StreamConfig,
-  StreamData,
-  StreamDataType,
-  StreamError,
-  StreamDataResponse,
-  StreamMessage,
-  StreamMessageMetadata,
-  StreamProviderType,
-  StreamRetryPolicy,
-  StreamRole,
-  StreamStats,
-  StreamStatus,
-} from './stream';
-export {
-  context,
-  Context,
-  Counter,
-  Meter,
-  metrics,
-  propagation,
-  SpanContext,
-  Span,
-  SpanStatus,
-  SpanStatusCode,
-  SpanKind,
-  trace,
-  Tracer,
-  ValueType,
-} from './telemetry';
-export { WorkListTaskType } from './task';
-export { TransitionMatch, TransitionRule, Transitions } from './transition';