@hotmeshio/hotmesh 0.4.0 → 0.4.2

package/types/quorum.ts

@@ -1,167 +0,0 @@
-import { JobOutput } from './job';
-import { StringAnyType } from './serializer';
-
-interface CPULoad {
-  [cpu: string]: string;
-}
-
-interface NetworkStat {
-  iface: string;
-  operstate: string;
-  rx_bytes: number;
-  rx_dropped: number;
-  rx_errors: number;
-  tx_bytes: number;
-  tx_dropped: number;
-  tx_errors: number;
-  rx_sec: number;
-  tx_sec: number;
-  ms: number;
-}
-
-/** reveals: memory, cpu, network */
-export interface SystemHealth {
-  TotalMemoryGB: string;
-  FreeMemoryGB: string;
-  UsedMemoryGB: string;
-  CPULoad: CPULoad[];
-  NetworkStats: NetworkStat[];
-}
-
-export type ThrottleOptions = {
-  /** target an engine OR worker by GUID */
-  guid?: string;
-  /** target a worker quorum */
-  topic?: string;
-  /** entity/noun */
-  entity?: string;
-  /** in milliseconds; set to -1 for indefinite throttle */
-  throttle: number;
-  /** namespace */
-  namespace?: string;
-};
-
-export interface QuorumProfile {
-  namespace: string;
-  app_id: string;
-  engine_id: string;
-  entity?: string;
-  worker_topic?: string;
-  stream?: string;
-  stream_depth?: number;
-  counts?: Record<string, number>;
-  inited?: string;
-  timestamp?: string;
-  throttle?: number;
-  reclaimDelay?: number;
-  reclaimCount?: number;
-  system?: SystemHealth;
-  signature?: string; //stringified function
-}
-
-interface QuorumMessageBase {
-  entity?: string;
-  guid?: string;
-  topic?: string;
-  type?: string;
-}
-
-// Messages extending QuorumMessageBase
-export interface PingMessage extends QuorumMessageBase {
-  type: 'ping';
-  originator: string; //guid
-  details?: boolean; //if true, all endpoints will include their profile
-}
-
-export interface WorkMessage extends QuorumMessageBase {
-  type: 'work';
-  originator: string; //guid
-}
-
-export interface CronMessage extends QuorumMessageBase {
-  type: 'cron';
-  originator: string; //guid
-}
-
-export interface PongMessage extends QuorumMessageBase {
-  type: 'pong';
-  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
-}
-
-export interface ActivateMessage extends QuorumMessageBase {
-  type: 'activate';
-  cache_mode: 'nocache' | 'cache';
-  until_version: string;
-}
-
-export interface UserMessage extends QuorumMessageBase {
-  type: 'user';
-  topic: string;
-  message: StringAnyType;
-}
-
-export interface JobMessage extends QuorumMessageBase {
-  type: 'job';
-  entity?: string;
-  topic: string; //this comes from the 'publishes' field in the YAML
-  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)
-  throttle: number; //0-n; millis
-}
-
-export interface RollCallMessage extends QuorumMessageBase {
-  type: 'rollcall';
-  guid?: string; //target the engine quorum
-  entity?: string;
-  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
-}
-
-export interface JobMessageCallback {
-  (topic: string, message: JobOutput): void;
-}
-
-export interface SubscriptionCallback {
-  (topic: string, message: Record<string, any>): void;
-}
-
-export interface QuorumMessageCallback {
-  (topic: string, message: QuorumMessage): void;
-}
-
-export type RollCallOptions = {
-  delay?: number;
-  namespace?: string;
-};
-
-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
-  | UserMessage;

package/types/redis.ts

@@ -1,404 +0,0 @@
-import {
-  ProviderClient,
-  ProviderConfig,
-  ProviderTransaction,
-} from './provider';
-import { StringStringType } from './serializer';
-import { ReclaimedMessageType } from './stream';
-
-/**
- * Redis types
- */
-interface ConnectionOptions {
-  //[key: string]: any;
-  host?: string;
-  port?: number;
-  path?: string; // Creates unix socket connection to path. If this option is specified, host and port are ignored.
-  socket?: any; // Establish secure connection on a given socket rather than creating a new socket
-  NPNProtocols?: string[] | Buffer[]; // Defaults to []
-  ALPNProtocols?: string[] | Buffer[]; // Defaults to []
-  servername?: string; // SNI TLS Extension
-  checkServerIdentity?: (servername: string, cert: Buffer) => Error | undefined;
-  session?: Buffer;
-  minDHSize?: number;
-  secureContext?: any; // If not provided, the entire ConnectionOptions object will be passed to tls.createSecureContext()
-  secureProtocol?: string; // The SSL method to use, e.g., SSLv3_method
-  ciphers?: string;
-  honorCipherOrder?: boolean;
-  requestCert?: boolean;
-  rejectUnauthorized?: boolean;
-  maxVersion?: 'TLSv1.3' | 'TLSv1.2' | 'TLSv1.1' | 'TLSv1';
-  minVersion?: 'TLSv1.3' | 'TLSv1.2' | 'TLSv1.1' | 'TLSv1';
-}
-
-interface RedisRedisClientOptions {
-  url?: string;
-  socket?: {
-    host?: string;
-    port?: number;
-    tls?: boolean;
-    servername?: string;
-    //[key: string]: any;
-  };
-  username?: string;
-  password?: string;
-  database?: number;
-  name?: string;
-  readonly?: boolean;
-  legacyMode?: boolean;
-  commandsQueueMaxLength?: number;
-  disableOfflineQueue?: boolean;
-  connectTimeout?: number;
-  autoResubscribe?: boolean;
-  autoResendUnfulfilledCommands?: boolean;
-  lazyConnect?: boolean;
-  tls?: boolean | ConnectionOptions;
-  enableReadyCheck?: boolean;
-  keepAlive?: number;
-  family?: 'IPv4' | 'IPv6';
-  keyPrefix?: string;
-  retry?: {
-    maxReconnectionAttempts?: number;
-    initialReconnectionDelay?: number;
-    reconnectionBackoffFactor?: number;
-    totalReconnectionTimeout?: number;
-    maxRetryCount?: number;
-  };
-  stringNumbers?: boolean;
-}
-
-interface RedisRedisMultiType extends ProviderTransaction {
-  sendCommand(command: string, ...args: string[]): Promise<any>;
-  exec: () => Promise<unknown[]>;
-
-  DEL(key: string): this;
-  EXISTS(key: string): this;
-  EXPIRE(key: string, seconds: number): this;
-  HDEL(key: string, fields: string[] | string): this;
-  HGET(key: string, itemId: string): this;
-  HGETALL(key: string): this;
-  HINCRBYFLOAT(key: string, itemId: string, value: number): this;
-  HMPUSH(key: string, values: Record<string, string>): this;
-  RPUSH(key: string, items: string[]): this;
-  HMGET(key: string, itemIds: string[]): this;
-  HSET(key: string, values: Record<string, string>): this;
-  LPUSH(key: string, items: string[]): this;
-  LRANGE(key: string, start: number, end: number): this;
-  RPUSH(key: string, items: string[]): this;
-  SET(key: string, value: string): this;
-  XADD(key: string, id: string, fields: any): this;
-  XACK(key: string, group: string, id: string): this;
-  XACK(key: string, group: string, ...ids: string[]): this;
-  XDEL(key: string, id: string): this;
-  XDEL(key: string, ...ids: string[]): this;
-  XCLAIM(
-    key: string,
-    group: string,
-    consumer: string,
-    minIdleTime: number,
-    id: string,
-    ...args: string[]
-  ): this;
-  XLEN(key: string): this;
-  XGROUP(
-    command: 'CREATE' | string,
-    key: string,
-    groupName: string,
-    id: string,
-    mkStream?: 'MKSTREAM',
-  ): this;
-  XPENDING(
-    key: string,
-    group: string,
-    start?: string,
-    end?: string,
-    count?: number,
-    consumer?: string,
-  ): this;
-  ZADD(
-    key: string,
-    values: { score: string; value: string },
-    opts?: { NX: boolean },
-  ): this;
-  ZRANGE_WITHSCORES(key: string, start: number, end: number): this;
-  ZRANK(key: string, member: string): this;
-  ZSCORE(key: string, value: string): this;
-}
-
-interface RedisRedisClientType extends ProviderClient {
-  multi(): Partial<RedisRedisMultiType>;
-  connect(): Promise<void>;
-  sendCommand(args: any[]): Promise<any>;
-  exec(): Promise<unknown[]>;
-  flushDb(): Promise<string>;
-  quit(): Promise<string>;
-  disconnect(): void;
-  duplicate(): RedisRedisClientType;
-  on(event: string, callback: (...args: any[]) => void): void;
-  publish(channel: string, message: string): Promise<number>;
-  pSubscribe(
-    pattern: string,
-    callback: (channel: string, message: string) => void,
-  ): Promise<void>;
-  pUnsubscribe(pattern: string): Promise<void>;
-  subscribe(
-    channel: string,
-    callback: (channel: string, message: string) => void,
-  ): Promise<void>;
-  unsubscribe(channel: string): Promise<void>;
-  punsubscribe(channel: string): void;
-  get(key: string): Promise<string | null>;
-  set(key: string, value: string): Promise<string>;
-
-  DEL(key: string): Promise<number>;
-  EXISTS(key: string): Promise<number>;
-  HDEL(key: string, fields: string[] | string): Promise<number>;
-  HGET(key: string, itemId: string): Promise<string | null>;
-  HGETALL(key: string): Promise<StringStringType>;
-  HINCRBYFLOAT(key: string, itemId: string, value: number): Promise<number>;
-  HMGET(key: string, itemIds: string[]): Promise<string[]>;
-  HSET(key: string, values: Record<string, string>): Promise<number>;
-  LPUSH(key: string, items: string[]): Promise<number>;
-  LRANGE(key: string, start: number, end: number): Promise<string[]>;
-  RPUSH(key: string, items: string[]): Promise<number>;
-  SET(key: string, value: string): Promise<string>;
-  XADD(key: string, id: string, fields: any): Promise<string>;
-  XACK(key: string, group: string, ...ids: string[]): Promise<number>;
-  XACK(key: string, group: string, id: string): Promise<number>;
-  XCLAIM(
-    key: string,
-    group: string,
-    consumer: string,
-    minIdleTime: number,
-    id: string,
-    ...args: string[]
-  ): Promise<ReclaimedMessageType>;
-  XDEL(key: string, id: string): Promise<number>;
-  XDEL(key: string, ...ids: string[]): Promise<number>;
-  xGroupDestroy(key: string, groupName: string): Promise<boolean>;
-  XINFO(command: 'GROUPS' | string, key: string): Promise<unknown>;
-  XINFO_GROUPS(key: string): Promise<unknown>;
-  XLEN(key: string): Promise<number>;
-  XPENDING(
-    key: string,
-    group: string,
-    start?: string,
-    end?: string,
-    count?: number,
-    consumer?: string,
-  ): this;
-  ZADD(
-    key: string,
-    values: { score: string; value: string },
-    opts?: { NX: boolean },
-  ): Promise<number>;
-  ZRANGE_WITHSCORES(
-    key: string,
-    start: number,
-    end: number,
-  ): Promise<{ score: number; value: string }>;
-  ZRANK(key: string, member: string): Promise<number>;
-  ZSCORE(key: string, value: string): Promise<number>;
-}
-
-interface RedisRedisClassType {
-  createClient(options: RedisRedisClientOptions): Partial<RedisRedisClientType>;
-}
-
-/**
- * IORedis types
- */
-interface IORedisClientOptions {
-  port?: number;
-  host?: string;
-  family?: 'IPv4' | 'IPv6';
-  path?: string;
-  keepAlive?: number;
-  noDelay?: boolean;
-  connectionName?: string;
-  db?: number;
-  password?: string;
-  username?: string;
-  sentinels?: Array<{ host: string; port: number }>;
-  name?: string;
-  readOnly?: boolean;
-  keyPrefix?: string;
-  reconnectOnError?: (err: Error) => boolean;
-}
-
-interface IORedisClient extends ProviderClient {
-  multi(): IORedisMultiType;
-  exec(): Promise<unknown[]>;
-  sendCommand(args: any[]): Promise<any>;
-  call(command: string, ...args: any[]): Promise<any>;
-  quit(): Promise<string>;
-  flushdb(): Promise<string>;
-
-  publish(channel: string, message: string): Promise<number>;
-  psubscribe(
-    pattern: string,
-    callback: (channel: string, message: string) => void,
-  ): Promise<void>;
-  punsubscribe(pattern: string): Promise<number>;
-  subscribe(
-    channel: string,
-    callback: (channel: string, message: string) => void,
-  ): Promise<void>;
-  unsubscribe(channel: string): Promise<number>;
-  punsubscribe(channel: string): Promise<number>;
-
-  xadd(key: string, id: string, fields: any, message?: string): Promise<string>;
-  xack(key: string, group: string, id: string): Promise<number>;
-  xack(key: string, group: string, ...ids: string[]): Promise<number>;
-  xdel(key: string, id: string): Promise<number>;
-  xdel(key: string, ...ids: string[]): Promise<number>;
-  xlen(key: string): Promise<number>;
-  xpending(
-    key: string,
-    group: string,
-    start?: string,
-    end?: string,
-    count?: number,
-    consumer?: string,
-  ): Promise<
-    | [string, string, number, [string, number][]][]
-    | [string, string, number, number]
-    | unknown[]
-  >;
-  xclaim(
-    key: string,
-    group: string,
-    consumer: string,
-    minIdleTime: number,
-    id: string,
-    ...args: string[]
-  ): Promise<ReclaimedMessageType>;
-  xinfo(command: 'GROUPS' | string, key: string): Promise<unknown>;
-  xrange(key: string, start: string, end: string): Promise<string[][]>;
-  xreadgroup(
-    command: 'GROUP',
-    groupName: string,
-    consumerName: string,
-    blockOption: string,
-    blockTime: number,
-    streamsOption: string,
-    streamName: string,
-    key: string,
-  ): Promise<string[][]>;
-  del(key: string): Promise<number>;
-  exists(key: string): Promise<number>;
-  get(key: string): Promise<string | null>;
-  hdel(key: string, ...fields: string[]): Promise<number>;
-  hget(key: string, itemId: string): Promise<string | null>;
-  hgetall(key: string): Promise<StringStringType>;
-  hincrbyfloat(key: string, itemId: string, value: number): Promise<number>;
-  hmget(key: string, itemIds: string[]): Promise<string[]>;
-  hset(key: string, values: Record<string, string>): Promise<number>;
-  lpush(key: string, ...args: string[]): Promise<number>;
-  lrange(key: string, start: number, end: number): Promise<string[]>;
-  on(event: string, callback: (...args: any[]) => void): void;
-  rpush(key: string, ...args: string[]): Promise<number>;
-  set(key: string, value: string): Promise<string>;
-  zadd(...args: Array<string | number>): Promise<number>;
-  zrange(
-    key: string,
-    start: number,
-    end: number,
-    withScores?: 'WITHSCORES',
-  ): Promise<string[]>;
-  zrank(key: string, member: string): Promise<number>;
-  zscore(key: string, value: string): Promise<number>;
-  xgroup(
-    command: 'CREATE' | 'DESTROY' | string,
-    key: string,
-    groupName: string,
-    id?: string,
-    mkStream?: 'MKSTREAM',
-  ): Promise<string | number>;
-}
-
-type IORedisClassType = new (
-  options: IORedisClientOptions,
-  ...args: any[]
-) => IORedisClient;
-interface IORedisMultiType extends ProviderTransaction {
-  xadd(key: string, id: string, fields: any, message?: string): this;
-  xack(key: string, group: string, id: string): this;
-  xack(key: string, group: string, ...ids: string[]): this;
-  xdel(key: string, id: string): this;
-  xdel(key: string, ...ids: string[]): this;
-  xlen(key: string): this;
-  xpending(
-    key: string,
-    group: string,
-    start?: string,
-    end?: string,
-    count?: number,
-    consumer?: string,
-  ): this;
-  xclaim(
-    key: string,
-    group: string,
-    consumer: string,
-    minIdleTime: number,
-    id: string,
-    ...args: string[]
-  ): this;
-  del(key: string): this;
-  expire(key: string, seconds: number): this;
-  hdel(key: string, itemId: string): this;
-  hget(key: string, itemId: string): this;
-  hgetall(key: string): this;
-  hincrbyfloat(key: string, itemId: string, value: number): this;
-  hmget(key: string, itemIds: string[]): this;
-  hset(key: string, values: Record<string, string>): this;
-  lrange(key: string, start: number, end: number): this;
-  rpush(key: string, value: string): this;
-  zadd(...args: Array<string | number>): this;
-  xgroup(
-    command: 'CREATE',
-    key: string,
-    groupName: string,
-    id: string,
-    mkStream?: 'MKSTREAM',
-  ): this;
-
-  sendCommand(command: string[]): Promise<any>;
-  exec: () => Promise<unknown[]>;
-}
-
-type RedisClass = RedisRedisClassType | IORedisClassType;
-type RedisClient = RedisRedisClientType | IORedisClient;
-type RedisOptions = RedisRedisClientOptions | IORedisClientOptions;
-type RedisMulti = RedisRedisMultiType | IORedisMultiType;
-
-function isRedisClient(client: RedisClient): client is RedisRedisClientType {
-  return 'sendCommand' in client;
-}
-
-function isIORedisClient(client: RedisClient): client is IORedisClient {
-  return 'pipeline' in client;
-}
-
-interface RedisConfig extends ProviderConfig {
-  class: Partial<RedisClass>;
-  options: Partial<RedisOptions>;
-}
-
-export {
-  RedisClass,
-  RedisConfig,
-  RedisRedisClientType,
-  RedisRedisClientOptions,
-  RedisRedisClassType,
-  IORedisClient as IORedisClientType,
-  RedisClient,
-  RedisMulti,
-  RedisRedisMultiType,
-  IORedisClientOptions,
-  IORedisClassType,
-  IORedisMultiType,
-  RedisOptions,
-  isRedisClient,
-  isIORedisClient,
-};

package/types/serializer.ts

@@ -1,40 +0,0 @@
-export interface JSONSchema {
-  type?: string;
-  enum?: string[];
-  examples?: any[];
-  properties?: { [key: string]: JSONSchema };
-  items?: JSONSchema;
-  description?: string;
-  'x-train'?: boolean; //extension property to mark item `values` as not being trainable (ssn, dob, guids are examples of fields that should never have their `values` trained)
-}
-
-export type SymbolRanges = {
-  //keyname is <ns>:<app>:symbols:
-  [key: string]: number; //eg: {"$": 0, "a1": 26, "a2" 39, "$metadata_cursor": 39, "$data_cursor": 2704} (job ($) holds range 0-26; every other activity has a number that increments by 13; up to 200+ unique activities may be modeled; the :cursor fields are used by the sytem to track the next reserved tranche using hincrby
-};
-
-export type Symbols = {
-  //keyname is <ns>:<app>:symbols:<aid> (where aid can be $ for job or a1, a2, etc. for activities)
-  [key: string]: string; //eg: {"operation/name": "26", "a2" 39, ":cursor": 39} (job holds range 0-26; every other activity has a number that increments by 13; up to 200 activity ranges may be listed; one field called $count is used by the sytem to track the next reserved tranche using hincrby; job always seeds with 26
-};
-
-export type SymbolSets = {
-  [key: string]: {
-    [key: string]: string;
-  };
-};
-
-export type StringStringType = {
-  [key: string]: string;
-};
-
-export type StringAnyType = {
-  [key: string]: any;
-};
-
-export type StringScalarType = {
-  [key: string]: boolean | number | string;
-};
-
-export type SymbolMap = Map<string, string>;
-export type SymbolMaps = Map<string, SymbolMap>;