@hotmeshio/hotmesh 0.0.1

package/LICENSE

@@ -0,0 +1,214 @@
+HotMesh Source Available License
+Version 1.0, Apr 2023
+
+Terms and Conditions for Use, Reproduction, and Distribution
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 10 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+  10. Commercial Service Restrictions.
+      You are not permitted to use the Work, or any modified or derivative
+      version of the Work, for the purpose of offering the Work, or any
+      product that includes the Work or any part of it, as a commercial
+      service to third parties, or in any other commercial context where
+      you derive direct or indirect financial benefit from the use of the
+      Work. This includes, but is not limited to, providing 
+      routing-as-a-service, bpm-as-a-service, workflow-as-a-service,
+      integration-as-a-service, operational-data-as-a-service
+      or any other similar service that would compete with 
+      HotMesh's commercial offering of workflow and routing services.
+      Any such use requires explicit written permission from the
+      Licensor.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the HotMesh Source Available License to your work.
+
+   To apply the HotMesh Source Available License to your work,
+   attach the following boilerplate notice, with the fields enclosed by
+   brackets "[]" replaced with your own identifying information. (Don't
+   include the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the HotMesh Source Available License;
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+   https://github.com/hotmeshio/hotmesh/blob/main/LICENSE
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,241 @@
+# HotMesh
+![alpha release](https://img.shields.io/badge/release-alpha-yellow)
+
+Build sophisticated, durable workflows without the overhead of a dedicated server cluster. With HotMesh, your code remains front and center using [infrastructure](./docs/faq.md#what-is-hotmesh) you already own.
+
+## Install
+[![npm version](https://badge.fury.io/js/%40hotmesh%2Fhotmesh.svg)](https://badge.fury.io/js/%40hotmesh%2Fhotmesh)
+
+```sh
+npm install @hotmeshio/hotmesh
+```
+
+## Design
+HotMesh's TypeScript SDK is modeled after [Temporal IO's](https://github.com/temporalio) developer-friendly approach. Design and deploy durable workflows using familiar paradigms that keep your code delightful to maintain. Deploying Temporal's [hello-world tutorial](https://github.com/temporalio/samples-typescript/tree/main/hello-world/src), for example, requires few changes beyond using the HotMesh SDK and saving to Redis.
+
+**./activities.ts**
+```javascript
+export async function greet(name: string): Promise<string> {
+  return `Hello, ${name}!`;
+}
+```
+
+**./workflows.ts**
+```javascript
+import { Durable } from '@hotmeshio/hotmesh';
+import type * as activities from './activities';
+
+const { greet } = Durable.workflow.proxyActivities<typeof activities>();
+
+export async function example(name: string): Promise<string> {
+  return await greet(name);
+}
+```
+
+**./worker.ts**
+```javascript
+import { Durable } from '@hotmeshio/hotmesh';
+import Redis from 'ioredis'; //OR `import * as Redis from 'redis';`
+import * as activities from './activities';
+
+async function run() {
+  const connection = await Durable.NativeConnection.connect({
+    class: Redis,
+    options: {
+      host: 'localhost',
+      port: 6379,
+    },
+  });
+  const worker = await Durable.Worker.create({
+    connection,
+    namespace: 'default',
+    taskQueue: 'hello-world',
+    workflowsPath: require.resolve('./workflows'),
+    activities,
+  });
+  await worker.run();
+}
+
+run().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
+```
+
+**./client.ts**
+```javascript
+import { Durable } from '@hotmeshio/hotmesh';
+import Redis from 'ioredis';
+import { nanoid } from 'nanoid';
+
+async function run() {
+  const connection = await Durable.Connection.connect({
+    class: Redis,
+    options: {
+      host: 'localhost',
+      port: 6379,
+    },
+  });
+
+  const client = new Durable.Client({
+    connection,
+  });
+
+  const handle = await client.workflow.start({
+    args: ['HotMesh'],
+    taskQueue: 'hello-world',
+    workflowName: 'example',
+    workflowId: 'workflow-' + nanoid(),
+  });
+
+  console.log(`Started workflow ${handle.workflowId}`);
+  console.log(await handle.result());
+}
+
+run().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
+```
+
+>HotMesh delivers durable function execution using a swarm of [distributed engines](./docs/distributed_orchestration.md). The design  consumes leftover CPU on your microservices to execute workflows without the cost and complexity of a central server.
+
+## Advanced Design
+HotMesh's TypeScript SDK is the easiest way to make your functions durable. But if you need full control over your function lifecycles (including high-volume, high-speed use cases), you can use HotMesh's underlying YAML models to optimize your durable workflows. The following model depicts a sequence of activities orchestrated by HotMesh. Any function you associate with a `topic` in your YAML definition is guaranteed to be durable.
+
+```yaml
+app:
+  id: sandbox
+  version: '1'
+  graphs:
+    - subscribes: sandbox.work.do
+      publishes: sandbox.work.done
+
+      activities:
+        gateway:
+          type: trigger
+        servicec:
+          type: worker
+          topic: sandbox.work.do.servicec
+        serviced:
+          type: worker
+          topic: sandbox.work.do.serviced
+        sforcecloud:
+          type: worker
+          topic: sandbox.work.do.sforcecloud
+
+      transitions:
+        gateway:
+          - to: servicec
+        servicec:
+          - to: serviced
+        serviced:
+          - to: sforcecloud
+```
+
+### Initialize
+Provide your chosen Redis instance and configuration options to start a HotMesh Client. *HotMesh supports both `ioredis` and `redis` clients interchangeably.*
+
+```javascript
+import { HotMesh } from '@hotmeshio/hotmesh';
+import Redis from 'ioredis'; //OR `import * as Redis from 'redis';`
+
+const hotMesh = await HotMesh.init({
+  appId: 'sandbox',
+  engine: {
+    redis: {
+      class: Redis,
+      options: { host, port, password, db } //per your chosen Redis client
+    }
+  }
+});
+```
+
+A HotMesh Client can be used to trigger worfkows and subscribe to results.
+
+### Trigger a Workflow
+Call `pub` to initiate a workflow. This function returns a job ID that allows you to monitor the progress of the workflow.
+
+```javascript
+const topic = 'sandbox.work.do';
+const payload = { };
+const jobId = await hotMesh.pub(topic, payload);
+```
+
+### Subscribe to Events
+Call `sub` to subscribe to all workflow results for a given topic.
+
+```javascript
+await hotMesh.sub('sandbox.work.done', (topic, jobOutput) => {
+  // use jobOutput.data
+});
+```
+
+### Trigger and Wait
+Call `pubsub` to start a workflow and *wait for the response*. HotMesh establishes a one-time subscription and delivers the job result once the workflow concludes.
+
+```javascript
+const jobOutput = await hotMesh.pubsub(topic, payload);
+```
+
+>The `pubsub` method is a convenience function that merges pub and sub into a single call. Opt for HotMesh's queue-driven engine over fragile HTTP requests to develop resilient solutions.
+
+### Link Worker Functions
+Link worker functions to a topic of your choice. When a workflow activity in the YAML definition with a corresponding topic runs, HotMesh will invoke your function, retrying as configured until it succeeds.
+
+```javascript
+import { HotMesh } from '@hotmeshio/hotmesh';
+import Redis from 'ioredis';
+
+const hotMesh = await HotMesh.init({
+  appId: 'sandbox',
+  workers: [
+    { 
+      topic: 'sandbox.work.do.servicec',
+      redis: {
+        class: Redis,
+        options: { host, port, password, db }
+      }
+      callback: async (data: StreamData) => {
+        return {
+          metadata: { ...data.metadata },
+          data: { }
+        };
+      }
+    }
+  ]
+};
+```
+
+### Observability
+Workflows and activities are run according to the rules you define, offering [Graph-Oriented](./docs/system_lifecycle.md#telemetry) telemetry insights into your legacy function executions.
+
+## FAQ
+Refer to the [FAQ](./docs/faq.md) for terminology, definitions, and an exploration of how HotMesh facilitates orchestration use cases.
+
+## Quick Start
+Refer to the [Quick Start](./docs/quickstart.md) for sample flows you can easily copy, paste, and modify to get started.
+
+## Developer Guide
+For more details on the complete development process, including information about schemas, APIs, and deployment, consult the [Developer Guide](./docs/developer_guide.md).
+
+## Model Driven Development
+[Model Driven Development](./docs/model_driven_development.md) is an established strategy for managing process-oriented tasks. Check out this guide to understand its foundational principles.
+
+## Data Mapping
+Exchanging data between activities is central to HotMesh. For detailed information on supported functions and the functional mapping syntax (@pipes), see the [Data Mapping Overview](./docs/data_mapping.md).
+
+## Composition
+While the simplest graphs are linear, detailing a consistent sequence of non-cyclical activities, graphs can be layered to represent intricate business scenarios. Some can even be designed to accommodate long-lasting workflows that span months. For more details, check out the [Composable Workflow Guide](./docs/composable_workflow.md).
+
+## Architectural First Principles
+For a deep dive into HotMesh's distributed orchestration philosophy, refer to the [Architectural First Principles Overview](./docs/architecture.md).
+
+## Distributed Orchestration
+HotMesh is a distributed orchestration engine. Refer to the [Distributed Orchestration Guide](./docs/distributed_orchestration.md) for a detailed breakdown of the approach.
+
+## System Lifecycle
+Gain insight into the HotMesh's monitoring, exception handling, and alarm configurations via the [System Lifecycle Guide](./docs/system_lifecycle.md).
+
+## Alpha Release
+So what exacty is an [alpha release](./docs/alpha.md)?!

package/build/index.d.ts

@@ -0,0 +1,4 @@
+import { Durable } from './services/durable';
+import { HotMeshService as HotMesh } from './services/hotmesh';
+import { HotMeshConfig } from './types/hotmesh';
+export { Durable, HotMesh, HotMeshConfig };

package/build/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HotMesh = exports.Durable = void 0;
+const durable_1 = require("./services/durable");
+Object.defineProperty(exports, "Durable", { enumerable: true, get: function () { return durable_1.Durable; } });
+const hotmesh_1 = require("./services/hotmesh");
+Object.defineProperty(exports, "HotMesh", { enumerable: true, get: function () { return hotmesh_1.HotMeshService; } });

package/build/modules/errors.d.ts

@@ -0,0 +1,28 @@
+import { ActivityDuplex } from "../types/activity";
+import { CollationFaultType, CollationStage } from "../types/collator";
+declare class GetStateError extends Error {
+    constructor();
+}
+declare class SetStateError extends Error {
+    constructor();
+}
+declare class MapDataError extends Error {
+    constructor();
+}
+declare class RegisterTimeoutError extends Error {
+    constructor();
+}
+declare class DuplicateJobError extends Error {
+    constructor(jobId: string);
+}
+declare class ExecActivityError extends Error {
+    constructor();
+}
+declare class CollationError extends Error {
+    status: number;
+    leg: ActivityDuplex;
+    stage: CollationStage;
+    fault: CollationFaultType;
+    constructor(status: number, leg: ActivityDuplex, stage: CollationStage, fault?: CollationFaultType);
+}
+export { CollationError, DuplicateJobError, GetStateError, SetStateError, MapDataError, RegisterTimeoutError, ExecActivityError };

package/build/modules/errors.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExecActivityError = exports.RegisterTimeoutError = exports.MapDataError = exports.SetStateError = exports.GetStateError = exports.DuplicateJobError = exports.CollationError = void 0;
+class GetStateError extends Error {
+    constructor() {
+        super("Error occurred while getting job state");
+    }
+}
+exports.GetStateError = GetStateError;
+class SetStateError extends Error {
+    constructor() {
+        super("Error occurred while setting job state");
+    }
+}
+exports.SetStateError = SetStateError;
+class MapDataError extends Error {
+    constructor() {
+        super("Error occurred while mapping data");
+    }
+}
+exports.MapDataError = MapDataError;
+class RegisterTimeoutError extends Error {
+    constructor() {
+        super("Error occurred while registering activity timeout");
+    }
+}
+exports.RegisterTimeoutError = RegisterTimeoutError;
+class DuplicateJobError extends Error {
+    constructor(jobId) {
+        super("Duplicate job");
+        this.message = `Duplicate job: ${jobId}`;
+    }
+}
+exports.DuplicateJobError = DuplicateJobError;
+class ExecActivityError extends Error {
+    constructor() {
+        super("Error occurred while executing activity");
+    }
+}
+exports.ExecActivityError = ExecActivityError;
+class CollationError extends Error {
+    constructor(status, leg, stage, fault) {
+        super("collation-error");
+        this.leg = leg;
+        this.status = status;
+        this.stage = stage;
+        this.fault = fault;
+    }
+}
+exports.CollationError = CollationError;

package/build/modules/key.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Keys
+ *
+ * hmsh ->                                            {hash}    hotmesh config {version: "0.0.1", namespace: "hmsh"}
+ * hmsh:a:<appid> ->                                  {hash}    app profile { "id": "appid", "version": "2", "versions/1": "GMT", "versions/2": "GMT"}
+ * hmsh:<appid>:e:<engineId> ->                       {string}  setnx to ensure only one engine of given id
+ * hmsh:<appid>:w: ->                                 {zset}    work items/tasks an engine must do like garbage collect or hook a set of matching records (hookAll)
+ * hmsh:<appid>:t: ->                                 {zset}    an ordered set of list (work lists) ids
+ * hmsh:<appid>:t:<timeValue?> ->                     {list}    a worklist of `jobId+activityId` items that should be awakened
+ * hmsh:<appid>:q: ->                                 {hash}    quorum-wide messages
+ * hmsh:<appid>:q:<ngnid> ->                          {hash}    engine-targeted messages (targeted quorum-oriented message)
+ * hmsh:<appid>:j:<jobid> ->                          {hash}    job data
+ * hmsh:<appid>:j:<jobid>:<activityid>  ->            {hash}    job activity data (a1)
+ * hmsh:<appid>:s:<jobkey>:<dateTime> ->              {hash}    job stats (general)
+ * hmsh:<appid>:s:<jobkey>:<dateTime>:mdn:<field/path>:<fieldvalue> ->      {zset}    job stats (median)
+ * hmsh:<appid>:s:<jobkey>:<dateTime>:index:<field/path>:<fieldvalue> ->    {list}    job stats (index of jobid[])
+ * hmsh:<appid>:v:<version>:activities ->             {hash}    schemas [cache]
+ * hmsh:<appid>:v:<version>:transitions ->            {hash}    transitions [cache]
+ * hmsh:<appid>:v:<version>:subscriptions ->          {hash}    subscriptions [cache]
+ * hmsh:<appid>:x: ->                                 {xstream} when an engine is sent or reads a buffered task (engines read from their custom topic)
+ * hmsh:<appid>:x:<topic> ->                          {xstream} when a worker is sent or reads a buffered task (workers read from their custom topic)
+ * hmsh:<appid>:hooks ->                              {hash}    hook patterns/rules; set at compile time
+ * hmsh:<appid>:signals ->                            {hash}    dynamic hook signals (hget/hdel) when resolving (always self-clean); added/removed at runtime
+ * hmsh:<appid>:sym:keys: ->                          {hash}    list of symbol ranges and :cursor assigned at version deploy time for job keys
+ * hmsh:<appid>:sym:keys:<activityid|$subscribes> ->  {hash}    list of symbols based upon schema enums (initially) and adaptively optimized (later) during runtime; if '$subscribes' is used as the activityid, it is a top-level `job` symbol set (for job keys)
+ * hmsh:<appid>:sym:vals: ->                          {hash}    list of symbols for job values across all app versions
+ */
+declare const PSNS = "hmsh";
+declare enum KeyType {
+    APP = 0,
+    ENGINE_ID = 1,
+    HOOKS = 2,
+    JOB_STATE = 3,
+    JOB_STATS_GENERAL = 4,
+    JOB_STATS_MEDIAN = 5,
+    JOB_STATS_INDEX = 6,
+    HOTMESH = 7,
+    QUORUM = 8,
+    SCHEMAS = 9,
+    SIGNALS = 10,
+    STREAMS = 11,
+    SUBSCRIPTIONS = 12,
+    SUBSCRIPTION_PATTERNS = 13,
+    SYMKEYS = 14,
+    SYMVALS = 15,
+    TIME_RANGE = 16,
+    WORK_ITEMS = 17
+}
+type KeyStoreParams = {
+    appId?: string;
+    engineId?: string;
+    appVersion?: string;
+    jobId?: string;
+    activityId?: string;
+    jobKey?: string;
+    dateTime?: string;
+    facet?: string;
+    topic?: string;
+    timeValue?: number;
+};
+declare class KeyService {
+    /**
+     * returns a key that can be used to access a value in the key/value store
+     * appropriate for the given key type; the keys have an implicit hierarchy
+     * and are used to organize data in the store in a tree-like structure
+     * via the use of colons as separators. The top-level entity is the hmsh manifest.
+     * This file will reveal the full scope of what is on the server (apps, versions, etc)
+     * @param namespace
+     * @param keyType
+     * @param params
+     * @returns {string}
+     */
+    static mintKey(namespace: string, keyType: KeyType, params: KeyStoreParams): string;
+}
+export { KeyService, KeyType, KeyStoreParams, PSNS };