diff --git a/bdd/data/sequences/args-config-test/package.json b/bdd/data/sequences/args-config-test/package.json index dd137351a..888c312da 100644 --- a/bdd/data/sequences/args-config-test/package.json +++ b/bdd/data/sequences/args-config-test/package.json @@ -10,7 +10,7 @@ "url": "https://github.com/scramjetorg/transform-hub.git" }, "devDependencies": { - "@scramjet/types": "0.37.0" + "@scramjet/types": "0.38.0" }, "private": true } diff --git a/bdd/data/sequences/args-to-output/package.json b/bdd/data/sequences/args-to-output/package.json index 1427c78f0..e901ffb78 100644 --- a/bdd/data/sequences/args-to-output/package.json +++ b/bdd/data/sequences/args-to-output/package.json @@ -12,7 +12,7 @@ "author": "Scramjet ", "license": "ISC", "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5" }, "repository": { diff --git a/bdd/data/sequences/deploy-app/dist/package.json b/bdd/data/sequences/deploy-app/dist/package.json index 3824bd8fb..cdc97d40a 100644 --- a/bdd/data/sequences/deploy-app/dist/package.json +++ b/bdd/data/sequences/deploy-app/dist/package.json @@ -10,7 +10,7 @@ "author": "Scramjet ", "license": "ISC", "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5" }, "repository": { diff --git a/bdd/data/sequences/deploy-app/package.json b/bdd/data/sequences/deploy-app/package.json index 3824bd8fb..cdc97d40a 100644 --- a/bdd/data/sequences/deploy-app/package.json +++ b/bdd/data/sequences/deploy-app/package.json @@ -10,7 +10,7 @@ "author": "Scramjet ", "license": "ISC", "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5" }, "repository": { diff --git a/bdd/iac-test-data/sequences/infinite/package.json b/bdd/iac-test-data/sequences/infinite/package.json index fb4f9355d..35d8fa97b 100644 --- a/bdd/iac-test-data/sequences/infinite/package.json +++ b/bdd/iac-test-data/sequences/infinite/package.json @@ -9,6 +9,6 @@ "build": "si pack -o ../hello-2.tar.gz ." }, "devDependencies": { - "@scramjet/types": "^0.37.0" + "@scramjet/types": "^0.38.0" } } diff --git a/bdd/package.json b/bdd/package.json index a3205e9d8..379da42c4 100644 --- a/bdd/package.json +++ b/bdd/package.json @@ -1,13 +1,13 @@ { "name": "scramjet-bdd", - "version": "0.37.0", + "version": "0.38.0", "description": "As the \"problem scope\" of the business problem that our technology solves is quite complex, we decided to use the BDD practice to support the development process. BDD is a methodology of high automation and agility. It describes a cycle of interactions with well-defined outcomes. As a result of these activities, we obtain working, tested software that has a real value.", "main": "_cucumber.js", "dependencies": { - "@scramjet/api-client": "^0.37.0", - "@scramjet/logger": "^0.37.0", - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/sth-config": "^0.37.0", + "@scramjet/api-client": "^0.38.0", + "@scramjet/logger": "^0.38.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/sth-config": "^0.38.0", "dockerode": "^3.3.4", "find-package-json": "^1.2.0", "freeport": "^1.0.5", @@ -17,7 +17,7 @@ "devDependencies": { "@cucumber/cucumber": "^7.3.2", "@cucumber/pretty-formatter": "^1.0.0", - "@scramjet/types": "^0.37.0" + "@scramjet/types": "^0.38.0" }, "scripts": { "build:bdd": "tsc -p tsconfig.json", diff --git a/docs/api-client/classes/HostClient.md b/docs/api-client/classes/HostClient.md index d5c24668e..ac409ef3e 100644 --- a/docs/api-client/classes/HostClient.md +++ b/docs/api-client/classes/HostClient.md @@ -124,7 +124,7 @@ Promise resolving to readable stream. #### Defined in -[api-client/src/host-client.ts:209](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L209) +[api-client/src/host-client.ts:208](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L208) ___ @@ -171,7 +171,7 @@ TODO: comment. #### Defined in -[api-client/src/host-client.ts:179](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L179) +[api-client/src/host-client.ts:178](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L178) ## Constructors @@ -209,7 +209,7 @@ TODO: comment. #### Defined in -[api-client/src/host-client.ts:225](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L225) +[api-client/src/host-client.ts:224](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L224) ___ @@ -235,7 +235,7 @@ Promise resolving to delete Sequence result. #### Defined in -[api-client/src/host-client.ts:121](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L121) +[api-client/src/host-client.ts:120](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L120) ___ @@ -255,7 +255,7 @@ ___ #### Defined in -[api-client/src/host-client.ts:229](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L229) +[api-client/src/host-client.ts:228](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L228) ___ @@ -297,7 +297,7 @@ Promise resolving to Host configuration (public part). #### Defined in -[api-client/src/host-client.ts:170](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L170) +[api-client/src/host-client.ts:169](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L169) ___ @@ -321,7 +321,7 @@ InstanceClient instance. #### Defined in -[api-client/src/host-client.ts:243](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L243) +[api-client/src/host-client.ts:242](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L242) ___ @@ -345,7 +345,7 @@ Promise resolving to Instance details. #### Defined in -[api-client/src/host-client.ts:136](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L136) +[api-client/src/host-client.ts:135](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L135) ___ @@ -363,7 +363,7 @@ Promise resolving to Host load check data. #### Defined in -[api-client/src/host-client.ts:145](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L145) +[api-client/src/host-client.ts:144](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L144) ___ @@ -411,7 +411,7 @@ Promise resolving to Sequence details. #### Defined in -[api-client/src/host-client.ts:110](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L110) +[api-client/src/host-client.ts:109](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L109) ___ @@ -435,7 +435,7 @@ SequenceClient instance. #### Defined in -[api-client/src/host-client.ts:253](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L253) +[api-client/src/host-client.ts:252](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L252) ___ @@ -471,7 +471,7 @@ Returns Host status. #### Defined in -[api-client/src/host-client.ts:161](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L161) +[api-client/src/host-client.ts:160](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L160) ___ @@ -497,7 +497,7 @@ Promise resolving to readable stream. #### Defined in -[api-client/src/host-client.ts:221](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L221) +[api-client/src/host-client.ts:220](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L220) ___ @@ -511,7 +511,7 @@ ___ #### Defined in -[api-client/src/host-client.ts:233](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L233) +[api-client/src/host-client.ts:232](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L232) ___ @@ -529,7 +529,7 @@ Promise resolving to Host version. #### Defined in -[api-client/src/host-client.ts:154](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L154) +[api-client/src/host-client.ts:153](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L153) ___ @@ -589,7 +589,7 @@ ___ ### sendSequence -▸ **sendSequence**(`sequencePackage`, `requestInit?`, `update?`): `Promise`<[`SequenceClient`](SequenceClient.md)\> +▸ **sendSequence**(`sequencePackage`, `requestInit?`): `Promise`<[`SequenceClient`](SequenceClient.md)\> Uploads Sequence to Host. @@ -599,7 +599,6 @@ Uploads Sequence to Host. | :------ | :------ | :------ | | `sequencePackage` | `string` \| `Readable` | Stream with packed Sequence. | | `requestInit?` | `RequestInit` | RequestInit object to be passed to fetch. | -| `update?` | `boolean` | Send request with post or put method. | #### Returns @@ -644,4 +643,4 @@ TODO: comment. #### Defined in -[api-client/src/host-client.ts:194](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L194) +[api-client/src/host-client.ts:193](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L193) diff --git a/docs/api-client/classes/InstanceClient.md b/docs/api-client/classes/InstanceClient.md index ea7865943..75e9ca78a 100644 --- a/docs/api-client/classes/InstanceClient.md +++ b/docs/api-client/classes/InstanceClient.md @@ -304,7 +304,7 @@ ___ | :------ | :------ | | `stream` | `string` \| `Readable` | | `requestInit?` | `RequestInit` | -| `options?` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `put`: `boolean` ; `type`: `string` }\> | +| `options?` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `type`: `string` }\> | #### Returns @@ -377,7 +377,7 @@ Pipes given stream to Instance "input". | :------ | :------ | :------ | | `stream` | `string` \| `Readable` | Stream to be piped. Or string written to "stdin" stream. | | `requestInit?` | `RequestInit` | RequestInit object to be passed to fetch. | -| `options?` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `put`: `boolean` ; `type`: `string` }\> | Request options | +| `options?` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `type`: `string` }\> | Request options | #### Returns @@ -428,7 +428,7 @@ Sends stream to one of the Instance inputs. | `streamId` | [`InstanceInputStream`](../modules.md#instanceinputstream) | Target input stream. | | `stream` | `string` \| `Readable` | Stream to send. | | `requestInit?` | `RequestInit` | RequestInit object to be passed to fetch. | -| `options?` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `put`: `boolean` ; `type`: `string` }\> | Stream options. | +| `options?` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `type`: `string` }\> | Stream options. | #### Returns diff --git a/docs/cli/commands-description.md b/docs/cli/commands-description.md index c3125b073..d46d88c4f 100644 --- a/docs/cli/commands-description.md +++ b/docs/cli/commands-description.md @@ -14,15 +14,15 @@ Completion operations --- -## $ si completion bash +## $ si completion install **Description** -Print out bash completion script +Installs bash completion script **Usage** -`si completion bash [options]` +`si completion install [options]` **Options** @@ -30,15 +30,15 @@ Print out bash completion script --- -## $ si completion install +## $ si completion uninstall **Description** -Installs bash completion script in .bashrc +Uninstalls bash completion script **Usage** -`si completion install [options]` +`si completion uninstall [options]` **Options** @@ -416,15 +416,31 @@ Remove existing profile configuration --- -## $ si scope +## $ si scope | s **Description** +/This functionality is under development./ Manage scopes that store pairs of spaces and Hubs used when working + +**Usage** + +`si scope [command] [options...]` + +**Options** + +* -h, --help Display help for command + +--- +## $ si scope list | ls + +**Description** + +List all created scopes **Usage** -`si scope [options]` +`si scope list [options]` **Options** @@ -432,15 +448,31 @@ Remove existing profile configuration --- -## $ si space +## $ si scope print **Description** +See json file under the scope + +**Usage** +`si scope print [options] ` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si scope use + +**Description** + +Work on the selected scope **Usage** -`si space [options]` +`si scope use [options] ` **Options** @@ -448,6 +480,210 @@ Remove existing profile configuration --- +## $ si scope delete + +**Description** + +Delete specific scope + +**Usage** + +`si scope delete [options] ` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si space | spc + +**Description** + +Operations on grouped and separated runtime environments that allow sharing the data within them + +**Usage** + +`si space [command] [options...]` + +**Options** + +* -c, --stdout Output to stdout (ignores -o) +* -o, --output Output path - defaults to dirname +* -h, --help Display help for command + +--- + +## $ si space info + +**Description** + +Display info about the default space + +**Usage** + +`si space info [options]` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si space list | ls + +**Description** + +List all existing spaces + +**Usage** + +`si space list [options]` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si space use + +**Description** + +Use the space + +**Usage** + +`si space use [options] ` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si space audit + +**Description** + +Fetch all audit messages from spaces + +**Usage** + +`si space audit [options]` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si space logs + +**Description** + +Fetch all logs from space + +**Usage** + +`si space logs [options] []` + +**Arguments** + +* The name of the space (defaults to current space) + +**Options** + +* -h, --help Display help for command + +--- + +## $ si space version + +**Description** + +Display space version + +**Usage** + +`si space version [options]` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si space access + +**Description** + +Manages Access Keys for active Space + +**Usage** + +`si space access [options] [command]` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si space access create + +**Description** + +Create Access key for adding Hubs to active Space, i.e "Army of Darkness" + +**Usage** + +`si space access create [options] ` + +**Arguments** + +* description Key description + +**Options** + +* -h, --help Display help for command + +--- + +## $ si space access list | ls + +**Description** + +List Access Keys metadata in active Space + +**Usage** + +`si space access list [options]` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si space access revoke + +**Description** + +Revokes Access Key in active Space + +**Usage** + +`si space access revoke [options]` + +**Options** + +* --id revoke specified key +* --all Removes all access keys and disconnects all self-hosted Hubs connected to Space +* -h, --help Display help for command + +--- + ## $ si hub **Description** @@ -460,6 +696,97 @@ Allows to run programs in different data centers, computers or devices in local **Options** +* -h, --help Display help for command + +--- + +## $ si hub use + +**Description** + +Specify the default Hub you want to work with, all subsequent requests will be sent to this Hub + +**Usage** + +`si hub use [options] ` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si hub list | ls + +**Description** + +List all the Hubs in the default space + +**Usage** + +`si hub list [options]` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si hub info + +**Description** + +Display info about the default Hub + +**Usage** + +`si hub info [options]` + +**Options** + +* -h, --help Display help for command + +--- + +## $ si hub disconnect + +**Description** + +Disconnect self hosted Hubs from space + +**Usage** + +`si hub disconnect [options] ` + +**Arguments** + +* space_name The name of the Space + +**Options** + +* --id Hub Id +* --all Disconnects all self-hosted Hubs connected to Space (default: false) +* -h, --help Display help for command + +--- + +## $ si hub delete + +**Description** + +Delete self hosted Hub from space + +**Usage** + +`si hub delete [options] ` + +**Arguments** + +* id Hub Id + +**Options** + +* -f, --force Enable deleting Hubs that are not disconnected (default: false) * -h, --help Display help for command --- @@ -631,12 +958,10 @@ Send the Sequence package to the Hub **Arguments** -* package The file or directory to upload or '-' to use the last packed. If directory, it will be packed and -* sent. +* package The file or directory to upload or '-' to use the last packed. If directory, it will be packed and sent. **Options** -* --name Allows to name sequence * -h, --help Display help for command --- @@ -653,7 +978,7 @@ Update Sequence with given name **Arguments** -* query Sequence id or name to be overwritten +* query Sequence id to be overwritten * package The file to upload **Options** @@ -945,8 +1270,7 @@ Send a file to input, if no file given the data will be read directly from the c **Options** * -t, --content-type Content-Type (default: "text/plain") -* -e, --end Close the input stream of the Instance when this stream ends, "x-end-stream" header (default: -* false) +* -e, --end Close the input stream of the Instance when this stream ends, "x-end-stream" header (default: false) * -h, --help Display help for command --- @@ -969,8 +1293,7 @@ See input and output **Options** * -t,--content-type Content-Type (choices: "text/plain", "application/octet-stream", "application/x-ndjson") -* -e, --end Close the input stream of the Instance when this stream ends, "x-end-stream" header -* (default: false) +* -e, --end Close the input stream of the Instance when this stream ends, "x-end-stream" header (default: false) * -h, --help Display help for command --- @@ -1165,8 +1488,8 @@ Create topic **Options** -* -t, --content-type [content-type] Specifies type of data in topic (choices: "text/x-ndjson", "application/x-ndjson", -* "text/plain", "application/octet-stream", default: "application/x-ndjson") +* -t, --content-type [content-type] Specifies type of data in topic (choices: "text/x-ndjson", "application/x-ndjson", "text/plain", +* "application/octet-stream", default: "application/x-ndjson") * -h, --help Display help for command --- @@ -1199,8 +1522,8 @@ Get data from topic **Options** -* -t, --content-type [content-type] Specifies type of data in topic (choices: "text/x-ndjson", "application/x-ndjson", -* "text/plain", "application/octet-stream", default: "application/x-ndjson") +* -t, --content-type [content-type] Specifies type of data in topic (choices: "text/x-ndjson", "application/x-ndjson", "text/plain", +* "application/octet-stream", default: "application/x-ndjson") * -h, --help Display help for command --- @@ -1217,8 +1540,8 @@ Send data on topic from file, directory or directly through the console **Options** -* -t, --content-type [content-type] Specifies type of data in topic (choices: "text/x-ndjson", "application/x-ndjson", -* "text/plain", "application/octet-stream", default: "application/x-ndjson") +* -t, --content-type [content-type] Specifies type of data in topic (choices: "text/x-ndjson", "application/x-ndjson", "text/plain", +* "application/octet-stream", default: "application/x-ndjson") * -h, --help Display help for command --- @@ -1239,22 +1562,6 @@ List information about topics --- -## $ si store - -**Description** - - - -**Usage** - -`si store [options]` - -**Options** - -* -h, --help Display help for command - ---- - ## $ si util | u **Description** diff --git a/docs/cli/interfaces/ProfileConfigEntity.md b/docs/cli/interfaces/ProfileConfigEntity.md index 0ee562498..c0ad34b10 100644 --- a/docs/cli/interfaces/ProfileConfigEntity.md +++ b/docs/cli/interfaces/ProfileConfigEntity.md @@ -22,7 +22,7 @@ #### Defined in -[cli/src/types/index.ts:32](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L32) +[cli/src/types/index.ts:31](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L31) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[cli/src/types/index.ts:31](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L31) +[cli/src/types/index.ts:30](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L30) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[cli/src/types/index.ts:34](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L34) +[cli/src/types/index.ts:33](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L33) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[cli/src/types/index.ts:37](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L37) +[cli/src/types/index.ts:36](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L36) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[cli/src/types/index.ts:33](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L33) +[cli/src/types/index.ts:32](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L32) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -[cli/src/types/index.ts:35](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L35) +[cli/src/types/index.ts:34](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L34) ___ @@ -89,4 +89,4 @@ ___ #### Defined in -[cli/src/types/index.ts:36](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L36) +[cli/src/types/index.ts:35](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L35) diff --git a/docs/cli/interfaces/SessionConfigEntity.md b/docs/cli/interfaces/SessionConfigEntity.md index 30c9e4c4b..070d3ca6a 100644 --- a/docs/cli/interfaces/SessionConfigEntity.md +++ b/docs/cli/interfaces/SessionConfigEntity.md @@ -21,7 +21,7 @@ #### Defined in -[cli/src/types/index.ts:48](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L48) +[cli/src/types/index.ts:47](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L47) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[cli/src/types/index.ts:45](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L45) +[cli/src/types/index.ts:44](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L44) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[cli/src/types/index.ts:44](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L44) +[cli/src/types/index.ts:43](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L43) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[cli/src/types/index.ts:46](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L46) +[cli/src/types/index.ts:45](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L45) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[cli/src/types/index.ts:47](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L47) +[cli/src/types/index.ts:46](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L46) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -[cli/src/types/index.ts:49](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L49) +[cli/src/types/index.ts:48](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L48) diff --git a/docs/cli/interfaces/SiConfigEntity.md b/docs/cli/interfaces/SiConfigEntity.md index 6ddc08c30..b7591017b 100644 --- a/docs/cli/interfaces/SiConfigEntity.md +++ b/docs/cli/interfaces/SiConfigEntity.md @@ -16,4 +16,4 @@ #### Defined in -[cli/src/types/index.ts:27](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L27) +[cli/src/types/index.ts:26](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L26) diff --git a/docs/cli/modules.md b/docs/cli/modules.md index 0d3815e26..b14c958c7 100644 --- a/docs/cli/modules.md +++ b/docs/cli/modules.md @@ -64,7 +64,7 @@ ### CommandDefinition -Ƭ **CommandDefinition**: (`program`: `ComplitingCommand`) => `void` +Ƭ **CommandDefinition**: (`program`: `Command`) => `void` #### Type declaration @@ -78,7 +78,7 @@ program.args - show arguments passed by user | Name | Type | | :------ | :------ | -| `program` | `ComplitingCommand` | +| `program` | `Command` | ##### Returns @@ -86,7 +86,7 @@ program.args - show arguments passed by user #### Defined in -[cli/src/types/index.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L9) +[cli/src/types/index.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L8) ___ @@ -98,7 +98,7 @@ ExtendedHelpConfiguration is used to pass context options throughout commands #### Defined in -[cli/src/types/index.ts:14](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L14) +[cli/src/types/index.ts:13](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L13) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[cli/src/types/index.ts:16](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L16) +[cli/src/types/index.ts:15](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L15) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[cli/src/types/index.ts:21](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L21) +[cli/src/types/index.ts:20](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L20) ## Functions @@ -150,13 +150,15 @@ ___ ▸ **completion**(`program`): `void` -Initializes `completion` command. +CommandDefinition is an object from commander.js +program.opts() - show options +program.args - show arguments passed by user #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `program` | `ComplitingCommand` | Commander object. | +| Name | Type | +| :------ | :------ | +| `program` | `Command` | #### Returns @@ -164,7 +166,7 @@ Initializes `completion` command. #### Defined in -[cli/src/types/index.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L9) +[cli/src/types/index.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L8) ___ @@ -178,7 +180,7 @@ Initializes `config` command. | Name | Type | Description | | :------ | :------ | :------ | -| `program` | `ComplitingCommand` | Commander object. | +| `program` | `Command` | Commander object. | #### Returns @@ -186,7 +188,7 @@ Initializes `config` command. #### Defined in -[cli/src/types/index.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L9) +[cli/src/types/index.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L8) ___ @@ -453,7 +455,7 @@ program.args - show arguments passed by user | Name | Type | | :------ | :------ | -| `program` | `ComplitingCommand` | +| `program` | `Command` | #### Returns @@ -461,7 +463,7 @@ program.args - show arguments passed by user #### Defined in -[cli/src/types/index.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L9) +[cli/src/types/index.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L8) ___ @@ -489,7 +491,7 @@ Initializes `instance` command. | Name | Type | Description | | :------ | :------ | :------ | -| `program` | `ComplitingCommand` | Commander object. | +| `program` | `Command` | Commander object. | #### Returns @@ -497,7 +499,7 @@ Initializes `instance` command. #### Defined in -[cli/src/types/index.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L9) +[cli/src/types/index.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L8) ___ @@ -517,7 +519,7 @@ ___ #### Defined in -[cli/src/types/index.ts:17](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L17) +[cli/src/types/index.ts:16](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L16) ___ @@ -537,7 +539,7 @@ ___ #### Defined in -[cli/src/types/index.ts:22](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L22) +[cli/src/types/index.ts:21](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L21) ___ @@ -557,7 +559,7 @@ ___ #### Defined in -[cli/src/types/index.ts:18](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L18) +[cli/src/types/index.ts:17](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L17) ___ @@ -577,7 +579,7 @@ ___ #### Defined in -[cli/src/types/index.ts:23](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L23) +[cli/src/types/index.ts:22](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L22) ___ @@ -597,7 +599,7 @@ ___ #### Defined in -[cli/src/types/index.ts:24](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L24) +[cli/src/types/index.ts:23](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L23) ___ @@ -617,7 +619,7 @@ ___ #### Defined in -[cli/src/types/index.ts:19](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L19) +[cli/src/types/index.ts:18](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L18) ___ @@ -651,7 +653,7 @@ Initializes `scope` command. | Name | Type | Description | | :------ | :------ | :------ | -| `program` | `ComplitingCommand` | Commander object. | +| `program` | `Command` | Commander object. | #### Returns @@ -659,7 +661,7 @@ Initializes `scope` command. #### Defined in -[cli/src/types/index.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L9) +[cli/src/types/index.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L8) ___ @@ -673,7 +675,7 @@ Initializes `sequence` command. | Name | Type | Description | | :------ | :------ | :------ | -| `program` | `ComplitingCommand` | Commander object. | +| `program` | `Command` | Commander object. | #### Returns @@ -681,7 +683,7 @@ Initializes `sequence` command. #### Defined in -[cli/src/types/index.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L9) +[cli/src/types/index.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L8) ___ @@ -695,7 +697,7 @@ Initializes `space` command. | Name | Type | Description | | :------ | :------ | :------ | -| `program` | `ComplitingCommand` | Commander object. | +| `program` | `Command` | Commander object. | #### Returns @@ -703,7 +705,7 @@ Initializes `space` command. #### Defined in -[cli/src/types/index.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L9) +[cli/src/types/index.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L8) ___ @@ -717,7 +719,7 @@ Initializes `topic` command. | Name | Type | Description | | :------ | :------ | :------ | -| `program` | `ComplitingCommand` | Commander object. | +| `program` | `Command` | Commander object. | #### Returns @@ -725,7 +727,7 @@ Initializes `topic` command. #### Defined in -[cli/src/types/index.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L9) +[cli/src/types/index.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L8) ___ @@ -739,7 +741,7 @@ Initializes `config` command. | Name | Type | Description | | :------ | :------ | :------ | -| `program` | `ComplitingCommand` | Commander object. | +| `program` | `Command` | Commander object. | #### Returns @@ -747,7 +749,7 @@ Initializes `config` command. #### Defined in -[cli/src/types/index.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L9) +[cli/src/types/index.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/cli/src/types/index.ts#L8) ## Variables diff --git a/docs/client-utils/classes/ClientUtils.md b/docs/client-utils/classes/ClientUtils.md index dc3880601..e65610e62 100644 --- a/docs/client-utils/classes/ClientUtils.md +++ b/docs/client-utils/classes/ClientUtils.md @@ -181,7 +181,7 @@ ClientUtilsBase.getStream #### Defined in -[packages/client-utils/src/client-utils.ts:245](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/client-utils.ts#L245) +[packages/client-utils/src/client-utils.ts:248](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/client-utils.ts#L248) ___ @@ -282,7 +282,7 @@ Performs POST request for streamed data. | `url` | `string` | Request url. | | `stream` | `any` | stream to be send. | | `requestInit` | `RequestInit` | RequestInit object to be passed to fetch. | -| `options` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `put`: `boolean` ; `type`: `string` }\> | send stream options. | +| `options` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `type`: `string` }\> | send stream options. | #### Returns diff --git a/docs/client-utils/classes/ClientUtilsCustomAgent.md b/docs/client-utils/classes/ClientUtilsCustomAgent.md index d9efb2efa..085dbadba 100644 --- a/docs/client-utils/classes/ClientUtilsCustomAgent.md +++ b/docs/client-utils/classes/ClientUtilsCustomAgent.md @@ -177,7 +177,7 @@ ClientUtilsBase.getStream #### Defined in -[packages/client-utils/src/client-utils.ts:245](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/client-utils.ts#L245) +[packages/client-utils/src/client-utils.ts:248](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/client-utils.ts#L248) ___ @@ -278,7 +278,7 @@ Performs POST request for streamed data. | `url` | `string` | Request url. | | `stream` | `any` | stream to be send. | | `requestInit` | `RequestInit` | RequestInit object to be passed to fetch. | -| `options` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `put`: `boolean` ; `type`: `string` }\> | send stream options. | +| `options` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `type`: `string` }\> | send stream options. | #### Returns diff --git a/docs/client-utils/interfaces/HttpClient.md b/docs/client-utils/interfaces/HttpClient.md index c5c288c41..2ec618ec3 100644 --- a/docs/client-utils/interfaces/HttpClient.md +++ b/docs/client-utils/interfaces/HttpClient.md @@ -48,7 +48,7 @@ HttpClient.addLogger #### Defined in -[packages/client-utils/src/types/index.ts:57](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L57) +[packages/client-utils/src/types/index.ts:56](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L56) ___ @@ -79,7 +79,7 @@ HttpClient.delete #### Defined in -[packages/client-utils/src/types/index.ts:61](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L61) +[packages/client-utils/src/types/index.ts:60](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L60) ___ @@ -110,7 +110,7 @@ HttpClient.get #### Defined in -[packages/client-utils/src/types/index.ts:58](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L58) +[packages/client-utils/src/types/index.ts:57](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L57) ___ @@ -135,7 +135,7 @@ HttpClient.getStream #### Defined in -[packages/client-utils/src/types/index.ts:69](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L69) +[packages/client-utils/src/types/index.ts:68](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L68) ___ @@ -168,7 +168,7 @@ HttpClient.post #### Defined in -[packages/client-utils/src/types/index.ts:60](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L60) +[packages/client-utils/src/types/index.ts:59](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L59) ___ @@ -189,7 +189,7 @@ ___ | `url` | `string` | | `stream` | `string` \| `Readable` | | `requestInit?` | `RequestInit` | -| `options?` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `put`: `boolean` ; `type`: `string` }\> | +| `options?` | `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"text"`` \| ``"json"`` \| ``"stream"`` ; `type`: `string` }\> | #### Returns @@ -201,4 +201,4 @@ HttpClient.sendStream #### Defined in -[packages/client-utils/src/types/index.ts:70](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L70) +[packages/client-utils/src/types/index.ts:69](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L69) diff --git a/docs/client-utils/modules.md b/docs/client-utils/modules.md index d920a4aa4..638db863a 100644 --- a/docs/client-utils/modules.md +++ b/docs/client-utils/modules.md @@ -50,13 +50,13 @@ Request logger. #### Defined in -[packages/client-utils/src/types/index.ts:29](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L29) +[packages/client-utils/src/types/index.ts:28](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L28) ___ ### SendStreamOptions -Ƭ **SendStreamOptions**: `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"json"`` \| ``"text"`` \| ``"stream"`` ; `put`: `boolean` ; `type`: `string` }\> +Ƭ **SendStreamOptions**: `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"json"`` \| ``"text"`` \| ``"stream"`` ; `type`: `string` }\> Options for sending sending stream. diff --git a/docs/host/classes/CPMConnector.md b/docs/host/classes/CPMConnector.md index 0a165d7aa..daaadfcc0 100644 --- a/docs/host/classes/CPMConnector.md +++ b/docs/host/classes/CPMConnector.md @@ -85,7 +85,7 @@ Loaded certificate authority file for connecting to CPM via HTTPS #### Defined in -[packages/host/src/lib/cpm-connector.ts:145](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L145) +[packages/host/src/lib/cpm-connector.ts:147](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L147) ___ @@ -97,7 +97,7 @@ Stream used to write data to Manager. #### Defined in -[packages/host/src/lib/cpm-connector.ts:71](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L71) +[packages/host/src/lib/cpm-connector.ts:73](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L73) ___ @@ -109,7 +109,7 @@ Connector options. #### Defined in -[packages/host/src/lib/cpm-connector.ts:57](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L57) +[packages/host/src/lib/cpm-connector.ts:59](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L59) ___ @@ -121,7 +121,7 @@ Connection status indicator. #### Defined in -[packages/host/src/lib/cpm-connector.ts:64](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L64) +[packages/host/src/lib/cpm-connector.ts:66](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L66) ___ @@ -133,7 +133,7 @@ Connection object. #### Defined in -[packages/host/src/lib/cpm-connector.ts:97](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L97) +[packages/host/src/lib/cpm-connector.ts:99](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L99) ___ @@ -145,7 +145,7 @@ Connection attempts counter. #### Defined in -[packages/host/src/lib/cpm-connector.ts:114](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L114) +[packages/host/src/lib/cpm-connector.ts:116](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L116) ___ @@ -157,7 +157,7 @@ Id of Manager (e.g. "cpm-1"). #### Defined in -[packages/host/src/lib/cpm-connector.ts:126](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L126) +[packages/host/src/lib/cpm-connector.ts:128](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L128) ___ @@ -169,7 +169,7 @@ Custom id indicator. #### Defined in -[packages/host/src/lib/cpm-connector.ts:85](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L85) +[packages/host/src/lib/cpm-connector.ts:87](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L87) ___ @@ -181,7 +181,7 @@ Host info object containing host id. #### Defined in -[packages/host/src/lib/cpm-connector.ts:92](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L92) +[packages/host/src/lib/cpm-connector.ts:94](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L94) ___ @@ -193,7 +193,7 @@ Message of impending abandonment received. #### Defined in -[packages/host/src/lib/cpm-connector.ts:119](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L119) +[packages/host/src/lib/cpm-connector.ts:121](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L121) ___ @@ -205,7 +205,7 @@ Indicator for reconnection state. #### Defined in -[packages/host/src/lib/cpm-connector.ts:102](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L102) +[packages/host/src/lib/cpm-connector.ts:104](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L104) ___ @@ -217,7 +217,7 @@ Load check instance to be used to get load check data. #### Defined in -[packages/host/src/lib/cpm-connector.ts:50](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L50) +[packages/host/src/lib/cpm-connector.ts:52](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L52) ___ @@ -229,7 +229,7 @@ Reference for method called in interval and sending load check data to the Manag #### Defined in -[packages/host/src/lib/cpm-connector.ts:140](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L140) +[packages/host/src/lib/cpm-connector.ts:142](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L142) ___ @@ -241,7 +241,7 @@ Logger. #### Defined in -[packages/host/src/lib/cpm-connector.ts:78](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L78) +[packages/host/src/lib/cpm-connector.ts:80](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L80) ___ @@ -253,7 +253,7 @@ VerserClient Instance used for connecting with Verser. #### Defined in -[packages/host/src/lib/cpm-connector.ts:133](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L133) +[packages/host/src/lib/cpm-connector.ts:135](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L135) ___ @@ -265,7 +265,7 @@ True if connection to Manager has been established at least once. #### Defined in -[packages/host/src/lib/cpm-connector.ts:107](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L107) +[packages/host/src/lib/cpm-connector.ts:109](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L109) ## Methods @@ -317,7 +317,7 @@ Promise that resolves when connection is established. #### Defined in -[packages/host/src/lib/cpm-connector.ts:341](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L341) +[packages/host/src/lib/cpm-connector.ts:343](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L343) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -[packages/host/src/lib/cpm-connector.ts:329](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L329) +[packages/host/src/lib/cpm-connector.ts:331](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L331) ___ @@ -398,7 +398,7 @@ Host id. #### Defined in -[packages/host/src/lib/cpm-connector.ts:229](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L229) +[packages/host/src/lib/cpm-connector.ts:231](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L231) ___ @@ -452,7 +452,7 @@ Promise resolving to NetworkInfo object. #### Defined in -[packages/host/src/lib/cpm-connector.ts:463](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L463) +[packages/host/src/lib/cpm-connector.ts:465](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L465) ___ @@ -472,7 +472,7 @@ ___ #### Defined in -[packages/host/src/lib/cpm-connector.ts:633](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L633) +[packages/host/src/lib/cpm-connector.ts:636](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L636) ___ @@ -496,7 +496,7 @@ Promise resolving to `ReadableStream` with topic data. #### Defined in -[packages/host/src/lib/cpm-connector.ts:622](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L622) +[packages/host/src/lib/cpm-connector.ts:625](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L625) ___ @@ -517,7 +517,7 @@ ___ #### Defined in -[packages/host/src/lib/cpm-connector.ts:249](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L249) +[packages/host/src/lib/cpm-connector.ts:251](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L251) ___ @@ -531,7 +531,7 @@ ___ #### Defined in -[packages/host/src/lib/cpm-connector.ts:239](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L239) +[packages/host/src/lib/cpm-connector.ts:241](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L241) ___ @@ -554,7 +554,7 @@ Tries to reconnect. #### Defined in -[packages/host/src/lib/cpm-connector.ts:405](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L405) +[packages/host/src/lib/cpm-connector.ts:407](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L407) ___ @@ -570,7 +570,7 @@ Initializes connector. #### Defined in -[packages/host/src/lib/cpm-connector.ts:236](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L236) +[packages/host/src/lib/cpm-connector.ts:238](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L238) ___ @@ -652,7 +652,7 @@ ___ #### Defined in -[packages/host/src/lib/cpm-connector.ts:603](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L603) +[packages/host/src/lib/cpm-connector.ts:605](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L605) ___ @@ -853,7 +853,7 @@ Reconnects to Manager if maximum number of connection attempts is not reached. #### Defined in -[packages/host/src/lib/cpm-connector.ts:431](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L431) +[packages/host/src/lib/cpm-connector.ts:433](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L433) ___ @@ -973,7 +973,7 @@ ___ #### Defined in -[packages/host/src/lib/cpm-connector.ts:479](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L479) +[packages/host/src/lib/cpm-connector.ts:481](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L481) ___ @@ -1034,11 +1034,7 @@ Topic information is send via communication channel. | Name | Type | Description | | :------ | :------ | :------ | -| `data` | `Object` | Topic information. | -| `data.contentType?` | `string` | - | -| `data.provides?` | `string` | - | -| `data.requires?` | `string` | - | -| `data.topicName` | `string` | - | +| `data` | `STHTopicEventData` | Topic information. | #### Returns @@ -1058,7 +1054,7 @@ ___ | Name | Type | | :------ | :------ | -| `topics` | { `contentType?`: `string` ; `provides?`: `string` ; `requires?`: `string` ; `topicName`: `string` }[] | +| `topics` | `Omit`<`STHTopicEventData`, ``"status"``\>[] | #### Returns @@ -1088,7 +1084,7 @@ Sets up load check object to be used to get load check data. #### Defined in -[packages/host/src/lib/cpm-connector.ts:220](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L220) +[packages/host/src/lib/cpm-connector.ts:222](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L222) ___ @@ -1151,4 +1147,4 @@ TypedEmitter<Events\>.constructor #### Defined in -[packages/host/src/lib/cpm-connector.ts:154](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L154) +[packages/host/src/lib/cpm-connector.ts:156](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/cpm-connector.ts#L156) diff --git a/docs/host/classes/CSIController.md b/docs/host/classes/CSIController.md index af3949a60..63787f5ec 100644 --- a/docs/host/classes/CSIController.md +++ b/docs/host/classes/CSIController.md @@ -102,7 +102,7 @@ Handles all Instance lifecycle, exposes instance's HTTP API. #### Defined in -[packages/host/src/lib/csi-controller.ts:146](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L146) +[packages/host/src/lib/csi-controller.ts:147](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L147) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:113](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L113) +[packages/host/src/lib/csi-controller.ts:114](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L114) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:112](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L112) +[packages/host/src/lib/csi-controller.ts:113](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L113) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:94](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L94) +[packages/host/src/lib/csi-controller.ts:95](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L95) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:96](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L96) +[packages/host/src/lib/csi-controller.ts:97](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L97) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:166](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L166) +[packages/host/src/lib/csi-controller.ts:167](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L167) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:97](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L97) +[packages/host/src/lib/csi-controller.ts:98](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L98) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:136](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L136) +[packages/host/src/lib/csi-controller.ts:137](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L137) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:107](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L107) +[packages/host/src/lib/csi-controller.ts:108](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L108) ___ @@ -199,7 +199,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:106](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L106) +[packages/host/src/lib/csi-controller.ts:107](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L107) ___ @@ -209,7 +209,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:109](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L109) +[packages/host/src/lib/csi-controller.ts:110](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L110) ___ @@ -219,7 +219,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:90](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L90) +[packages/host/src/lib/csi-controller.ts:91](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L91) ___ @@ -229,7 +229,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:71](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L71) +[packages/host/src/lib/csi-controller.ts:72](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L72) ___ @@ -248,7 +248,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:99](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L99) +[packages/host/src/lib/csi-controller.ts:100](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L100) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:105](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L105) +[packages/host/src/lib/csi-controller.ts:106](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L106) ___ @@ -275,7 +275,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:126](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L126) +[packages/host/src/lib/csi-controller.ts:127](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L127) ___ @@ -287,7 +287,7 @@ Topic to which the input stream should be routed #### Defined in -[packages/host/src/lib/csi-controller.ts:123](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L123) +[packages/host/src/lib/csi-controller.ts:124](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L124) ___ @@ -297,7 +297,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:95](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L95) +[packages/host/src/lib/csi-controller.ts:96](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L96) ___ @@ -307,7 +307,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:92](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L92) +[packages/host/src/lib/csi-controller.ts:93](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L93) ___ @@ -317,7 +317,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:110](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L110) +[packages/host/src/lib/csi-controller.ts:111](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L111) ___ @@ -329,7 +329,7 @@ Logger. #### Defined in -[packages/host/src/lib/csi-controller.ts:133](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L133) +[packages/host/src/lib/csi-controller.ts:134](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L134) ___ @@ -339,7 +339,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:125](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L125) +[packages/host/src/lib/csi-controller.ts:126](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L126) ___ @@ -351,7 +351,7 @@ Topic to which the output stream should be routed #### Defined in -[packages/host/src/lib/csi-controller.ts:118](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L118) +[packages/host/src/lib/csi-controller.ts:119](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L119) ___ @@ -361,7 +361,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:102](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L102) +[packages/host/src/lib/csi-controller.ts:103](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L103) ___ @@ -371,7 +371,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:103](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L103) +[packages/host/src/lib/csi-controller.ts:104](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L104) ___ @@ -381,7 +381,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:98](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L98) +[packages/host/src/lib/csi-controller.ts:99](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L99) ___ @@ -391,7 +391,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:93](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L93) +[packages/host/src/lib/csi-controller.ts:94](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L94) ___ @@ -401,7 +401,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:100](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L100) +[packages/host/src/lib/csi-controller.ts:101](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L101) ___ @@ -411,7 +411,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:91](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L91) +[packages/host/src/lib/csi-controller.ts:92](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L92) ___ @@ -428,7 +428,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:101](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L101) +[packages/host/src/lib/csi-controller.ts:102](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L102) ## Methods @@ -473,7 +473,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:409](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L409) +[packages/host/src/lib/csi-controller.ts:410](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L410) ___ @@ -487,7 +487,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:570](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L570) +[packages/host/src/lib/csi-controller.ts:571](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L571) ___ @@ -550,7 +550,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:417](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L417) +[packages/host/src/lib/csi-controller.ts:418](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L418) ___ @@ -564,7 +564,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:782](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L782) +[packages/host/src/lib/csi-controller.ts:794](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L794) ___ @@ -578,7 +578,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:808](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L808) +[packages/host/src/lib/csi-controller.ts:820](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L820) ___ @@ -592,7 +592,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:812](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L812) +[packages/host/src/lib/csi-controller.ts:824](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L824) ___ @@ -624,7 +624,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:804](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L804) +[packages/host/src/lib/csi-controller.ts:816](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L816) ___ @@ -644,7 +644,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:527](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L527) +[packages/host/src/lib/csi-controller.ts:528](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L528) ___ @@ -664,7 +664,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:552](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L552) +[packages/host/src/lib/csi-controller.ts:553](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L553) ___ @@ -684,7 +684,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:863](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L863) +[packages/host/src/lib/csi-controller.ts:875](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L875) ___ @@ -704,7 +704,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:817](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L817) +[packages/host/src/lib/csi-controller.ts:829](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L829) ___ @@ -724,7 +724,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:836](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L836) +[packages/host/src/lib/csi-controller.ts:848](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L848) ___ @@ -738,7 +738,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:334](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L334) +[packages/host/src/lib/csi-controller.ts:335](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L335) ___ @@ -758,7 +758,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:448](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L448) +[packages/host/src/lib/csi-controller.ts:449](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L449) ___ @@ -772,7 +772,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:440](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L440) +[packages/host/src/lib/csi-controller.ts:441](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L441) ___ @@ -793,7 +793,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:760](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L760) +[packages/host/src/lib/csi-controller.ts:772](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L772) ___ @@ -867,7 +867,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:236](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L236) +[packages/host/src/lib/csi-controller.ts:237](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L237) ___ @@ -1134,7 +1134,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:871](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L871) +[packages/host/src/lib/csi-controller.ts:883](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L883) ___ @@ -1172,7 +1172,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:214](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L214) +[packages/host/src/lib/csi-controller.ts:215](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L215) ___ @@ -1186,7 +1186,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:273](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L273) +[packages/host/src/lib/csi-controller.ts:274](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L274) ## Constructors @@ -1212,7 +1212,7 @@ TypedEmitter<Events\>.constructor #### Defined in -[packages/host/src/lib/csi-controller.ts:168](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L168) +[packages/host/src/lib/csi-controller.ts:169](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L169) ## Accessors @@ -1226,7 +1226,7 @@ TypedEmitter<Events\>.constructor #### Defined in -[packages/host/src/lib/csi-controller.ts:148](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L148) +[packages/host/src/lib/csi-controller.ts:149](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L149) • `set` **endOfSequence**(`prm`): `void` @@ -1242,7 +1242,7 @@ TypedEmitter<Events\>.constructor #### Defined in -[packages/host/src/lib/csi-controller.ts:156](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L156) +[packages/host/src/lib/csi-controller.ts:157](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L157) ___ @@ -1256,7 +1256,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:138](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L138) +[packages/host/src/lib/csi-controller.ts:139](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L139) ___ @@ -1270,7 +1270,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:415](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L415) +[packages/host/src/lib/csi-controller.ts:416](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L416) ___ @@ -1284,4 +1284,4 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:80](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L80) +[packages/host/src/lib/csi-controller.ts:81](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L81) diff --git a/docs/host/classes/Host.md b/docs/host/classes/Host.md index b9f592ffb..0cf594194 100644 --- a/docs/host/classes/Host.md +++ b/docs/host/classes/Host.md @@ -61,8 +61,8 @@ Can communicate with Manager. - [handleDeleteSequence](Host.md#handledeletesequence) - [handleIncomingSequence](Host.md#handleincomingsequence) - [handleNewSequence](Host.md#handlenewsequence) -- [handleSequenceUpdate](Host.md#handlesequenceupdate) - [handleStartSequence](Host.md#handlestartsequence) +- [handleUpdateSequence](Host.md#handleupdatesequence) - [heartBeat](Host.md#heartbeat) - [identifyExistingSequences](Host.md#identifyexistingsequences) - [instanceMiddleware](Host.md#instancemiddleware) @@ -397,7 +397,7 @@ Setting up handlers for general Host API endpoints: #### Defined in -[packages/host/src/lib/host.ts:499](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L499) +[packages/host/src/lib/host.ts:502](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L502) ___ @@ -413,7 +413,7 @@ Stops running servers. #### Defined in -[packages/host/src/lib/host.ts:1229](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1229) +[packages/host/src/lib/host.ts:1239](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1239) ___ @@ -429,7 +429,7 @@ Initializes connector and connects to Manager. #### Defined in -[packages/host/src/lib/host.ts:471](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L471) +[packages/host/src/lib/host.ts:474](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L474) ___ @@ -449,7 +449,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:879](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L879) +[packages/host/src/lib/host.ts:880](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L880) ___ @@ -463,7 +463,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:282](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L282) +[packages/host/src/lib/host.ts:285](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L285) ___ @@ -481,13 +481,13 @@ List of Instances. #### Defined in -[packages/host/src/lib/host.ts:1132](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1132) +[packages/host/src/lib/host.ts:1139](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1139) ___ ### getSequence -▸ **getSequence**(`id`): `OpResponse`<`GetSequenceResponse`\> +▸ **getSequence**(`req`): `OpResponse`<`GetSequenceResponse`\> Returns Sequence information. @@ -495,7 +495,7 @@ Returns Sequence information. | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | Instance ID. | +| `req` | `ParsedMessage` | Request object that should contain id parameter inside. | #### Returns @@ -505,7 +505,7 @@ Sequence info object. #### Defined in -[packages/host/src/lib/host.ts:1144](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1144) +[packages/host/src/lib/host.ts:1151](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1151) ___ @@ -529,7 +529,7 @@ List of Instances. #### Defined in -[packages/host/src/lib/host.ts:1181](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1181) +[packages/host/src/lib/host.ts:1191](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1191) ___ @@ -547,7 +547,7 @@ List of Sequences. #### Defined in -[packages/host/src/lib/host.ts:1169](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1169) +[packages/host/src/lib/host.ts:1179](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1179) ___ @@ -565,7 +565,7 @@ Size #### Defined in -[packages/host/src/lib/host.ts:1295](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1295) +[packages/host/src/lib/host.ts:1305](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1305) ___ @@ -579,7 +579,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:1200](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1200) +[packages/host/src/lib/host.ts:1210](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1210) ___ @@ -593,7 +593,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:1194](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1194) +[packages/host/src/lib/host.ts:1204](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1204) ___ @@ -614,7 +614,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:717](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L717) +[packages/host/src/lib/host.ts:724](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L724) ___ @@ -641,19 +641,19 @@ Promise resolving to operation result object. #### Defined in -[packages/host/src/lib/host.ts:630](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L630) +[packages/host/src/lib/host.ts:633](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L633) ___ ### handleIncomingSequence -▸ **handleIncomingSequence**(`stream`, `id`): `Promise`<`OpResponse`<`SendSequenceResponse`\>\> +▸ **handleIncomingSequence**(`req`, `id`): `Promise`<`OpResponse`<`SendSequenceResponse`\>\> #### Parameters | Name | Type | | :------ | :------ | -| `stream` | `ParsedMessage` | +| `req` | `ParsedMessage` | | `id` | `string` | #### Returns @@ -662,7 +662,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:761](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L761) +[packages/host/src/lib/host.ts:768](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L768) ___ @@ -689,27 +689,7 @@ Promise resolving to operation result. #### Defined in -[packages/host/src/lib/host.ts:859](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L859) - -___ - -### handleSequenceUpdate - -▸ **handleSequenceUpdate**(`stream`): `Promise`<`OpResponse`<`SendSequenceResponse`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `stream` | `ParsedMessage` | - -#### Returns - -`Promise`<`OpResponse`<`SendSequenceResponse`\>\> - -#### Defined in - -[packages/host/src/lib/host.ts:831](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L831) +[packages/host/src/lib/host.ts:864](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L864) ___ @@ -737,7 +717,27 @@ Promise resolving to operation result object. #### Defined in -[packages/host/src/lib/host.ts:920](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L920) +[packages/host/src/lib/host.ts:921](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L921) + +___ + +### handleUpdateSequence + +▸ **handleUpdateSequence**(`req`): `Promise`<`OpResponse`<`SendSequenceResponse`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `ParsedMessage` | + +#### Returns + +`Promise`<`OpResponse`<`SendSequenceResponse`\>\> + +#### Defined in + +[packages/host/src/lib/host.ts:832](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L832) ___ @@ -751,7 +751,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:696](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L696) +[packages/host/src/lib/host.ts:703](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L703) ___ @@ -768,7 +768,7 @@ Used to recover Sequences information after restart. #### Defined in -[packages/host/src/lib/host.ts:735](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L735) +[packages/host/src/lib/host.ts:742](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L742) ___ @@ -798,7 +798,7 @@ Instance middleware. #### Defined in -[packages/host/src/lib/host.ts:567](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L567) +[packages/host/src/lib/host.ts:570](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L570) ___ @@ -818,7 +818,7 @@ Promise resolving to Instance of Host. #### Defined in -[packages/host/src/lib/host.ts:329](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L329) +[packages/host/src/lib/host.ts:332](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L332) ___ @@ -832,7 +832,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:418](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L418) +[packages/host/src/lib/host.ts:421](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L421) ___ @@ -854,7 +854,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:1302](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1302) +[packages/host/src/lib/host.ts:1312](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1312) ___ @@ -872,7 +872,7 @@ Configuration object. #### Defined in -[packages/host/src/lib/host.ts:300](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L300) +[packages/host/src/lib/host.ts:303](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L303) ___ @@ -888,7 +888,7 @@ Sets up telemetry. #### Defined in -[packages/host/src/lib/host.ts:1269](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1269) +[packages/host/src/lib/host.ts:1279](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1279) ___ @@ -912,7 +912,7 @@ Forward request to Manager the Host is connected to. #### Defined in -[packages/host/src/lib/host.ts:599](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L599) +[packages/host/src/lib/host.ts:602](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L602) ___ @@ -935,7 +935,7 @@ Creates new CSIController [CSIController](CSIController.md) object and handles i #### Defined in -[packages/host/src/lib/host.ts:1006](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1006) +[packages/host/src/lib/host.ts:1007](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1007) ___ @@ -952,7 +952,7 @@ using its CSIController [CSIController](CSIController.md) #### Defined in -[packages/host/src/lib/host.ts:1212](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1212) +[packages/host/src/lib/host.ts:1222](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1222) ## Constructors diff --git a/docs/host/classes/ServiceDiscovery.md b/docs/host/classes/ServiceDiscovery.md index d58f45083..f27f233a0 100644 --- a/docs/host/classes/ServiceDiscovery.md +++ b/docs/host/classes/ServiceDiscovery.md @@ -89,7 +89,7 @@ added topic data. #### Defined in -[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:74](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L74) +[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:87](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L87) ___ @@ -133,7 +133,7 @@ Topic details. #### Defined in -[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:113](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L113) +[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:126](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L126) ___ @@ -159,7 +159,7 @@ Topic stream. #### Defined in -[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:133](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L133) +[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:146](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L146) ___ @@ -195,7 +195,7 @@ All topics. #### Defined in -[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:98](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L98) +[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:111](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L111) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:154](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L154) +[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:168](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L168) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:141](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L141) +[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:154](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L154) ___ @@ -259,7 +259,7 @@ Sets the CPM connector. #### Defined in -[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:63](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L63) +[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:76](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L76) ___ @@ -271,11 +271,7 @@ ___ | Name | Type | | :------ | :------ | -| `data` | `Object` | -| `data.contentType` | `string` | -| `data.provides?` | `string` | -| `data.requires?` | `string` | -| `data.topicName` | `string` | +| `data` | `STHTopicEventData` | #### Returns @@ -283,4 +279,4 @@ ___ #### Defined in -[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:165](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L165) +[packages/host/src/lib/serviceDiscovery/sd-adapter.ts:180](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/serviceDiscovery/sd-adapter.ts#L180) diff --git a/docs/manager-api-client/README.md b/docs/manager-api-client/README.md index c2fbac941..8c79095be 100644 --- a/docs/manager-api-client/README.md +++ b/docs/manager-api-client/README.md @@ -166,6 +166,8 @@ There are several installations you need to perform to get STH up and running, a - ts-node - docker - pip +- wget +- jq Our hub is based on node.js, so you need to install node.js and npm, which is the default package manager for node.js. To check if you already have Node.js(v16.xx.x) and npm installed, run the following commands in your console: @@ -177,7 +179,7 @@ npm -v If none of the above commands is found, **you must proceed with the installation.** -It is recommended to use a **Node version manager** like [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to install Node.js and npm. Do it by running the install script using either of the commands bellow. +It is recommended to use a **Node version manager** like [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to install Node.js and npm. Do it by running the install script using either of the commands bellow. > Note: Make sure you replace v0.39.0 with the latest version of nvm. The actual version of nvm to install is [here](https://github.com/nvm-sh/nvm/blob/master/README.md#install--update-script). ```bash @@ -222,7 +224,7 @@ $ npm -v 8.15.0 ``` -**OK!** It looks like you have successfully installed node.js and npm. +**OK!** It looks like you have successfully installed node.js and npm. There are two more installations you need to perform, run the following commands in your console one after another: @@ -250,10 +252,22 @@ pip --version If they are not present, refer to the official installation guide for [Python](https://wiki.python.org/moin/BeginnersGuide/Download) and [Pip](https://pip.pypa.io/en/stable/installation/). +Additionally you have to have `wget` and `jq` installed: + +```bash +# Debian based distributions: +apt install wget jq + +# Mac +brew install wget jq +``` + > **If you don't want to use Docker, please skip this step!** We also work with Docker, but this is optional. Running STH is possible without Docker in the background. If you want to use Docker, you can install it by running the following commands in your console: +*On Mac u can use [Docker-Desktop](https://www.docker.com/products/docker-desktop/)* + ```bash # Install docker and docker-compose sudo apt install -y docker.io docker-compose @@ -302,8 +316,6 @@ In the meantime let me describe for you what is happening in the command you hav When both the package installation and build are complete, STH should be ready to run. - - --- ## Start STH :checkered_flag: @@ -499,7 +511,7 @@ We use our own scripts to control our monorepo. Here's a couple of helpful comma ```bash ./scripts/run-script.js [script] # Run an npm script in each package that contains that script. -./scripts/run-script.js --scope @scramjet/ +./scripts/run-script.js --scope @scramjet/ # Run script only in one package ./scripts/run-script.js --workspace packages # Run script in all packages in workspace diff --git a/docs/manager-api-client/classes/ManagerClient.md b/docs/manager-api-client/classes/ManagerClient.md index d31e37440..a2f88c916 100644 --- a/docs/manager-api-client/classes/ManagerClient.md +++ b/docs/manager-api-client/classes/ManagerClient.md @@ -137,7 +137,7 @@ ___ | Name | Type | | :------ | :------ | -| `opts` | `any` | +| `opts` | `PostDisconnectPayload` | #### Returns diff --git a/docs/middleware-api-client/classes/MiddlewareClient.md b/docs/middleware-api-client/classes/MiddlewareClient.md index 6984beac8..2fafd269a 100644 --- a/docs/middleware-api-client/classes/MiddlewareClient.md +++ b/docs/middleware-api-client/classes/MiddlewareClient.md @@ -39,7 +39,7 @@ Client for the Middleware interaction. #### Defined in -[middleware-client.ts:12](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L12) +[middleware-client.ts:11](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L11) ___ @@ -53,7 +53,7 @@ ClientProvider.client #### Defined in -[middleware-client.ts:13](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L13) +[middleware-client.ts:12](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L12) ## Constructors @@ -70,7 +70,7 @@ ClientProvider.client #### Defined in -[middleware-client.ts:15](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L15) +[middleware-client.ts:14](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L14) ## Methods @@ -92,7 +92,7 @@ ClientProvider.client #### Defined in -[middleware-client.ts:65](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L65) +[middleware-client.ts:64](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L64) ___ @@ -110,7 +110,7 @@ List of manager ids #### Defined in -[middleware-client.ts:55](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L55) +[middleware-client.ts:54](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L54) ___ @@ -135,7 +135,7 @@ ManagerClient for space management #### Defined in -[middleware-client.ts:28](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L28) +[middleware-client.ts:27](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L27) ___ @@ -153,7 +153,7 @@ List of manager ids #### Defined in -[middleware-client.ts:37](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L37) +[middleware-client.ts:36](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L36) ___ @@ -171,7 +171,7 @@ List of manager ids #### Defined in -[middleware-client.ts:46](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L46) +[middleware-client.ts:45](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L45) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -[middleware-client.ts:59](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L59) +[middleware-client.ts:58](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L58) ___ @@ -212,20 +212,19 @@ ___ #### Defined in -[middleware-client.ts:74](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L74) +[middleware-client.ts:73](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/middleware-api-client/src/middleware-client.ts#L73) ___ ### revokeAllAccessKeys -▸ **revokeAllAccessKeys**(`spaceId`, `apiKeys`): `Promise`<{ `keysRevoked`: `number` ; `message`: `string` }\> +▸ **revokeAllAccessKeys**(`spaceId`): `Promise`<{ `keysRevoked`: `number` ; `message`: `string` }\> #### Parameters | Name | Type | | :------ | :------ | | `spaceId` | `string` | -| `apiKeys` | `GetAccessKeysResponse` | #### Returns diff --git a/docs/module-loader/.nojekyll b/docs/module-loader/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/docs/module-loader/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/module-loader/README.md b/docs/module-loader/README.md index ef60f3376..a6deb8310 100644 --- a/docs/module-loader/README.md +++ b/docs/module-loader/README.md @@ -166,6 +166,8 @@ There are several installations you need to perform to get STH up and running, a - ts-node - docker - pip +- wget +- jq Our hub is based on node.js, so you need to install node.js and npm, which is the default package manager for node.js. To check if you already have Node.js(v16.xx.x) and npm installed, run the following commands in your console: @@ -177,7 +179,7 @@ npm -v If none of the above commands is found, **you must proceed with the installation.** -It is recommended to use a **Node version manager** like [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to install Node.js and npm. Do it by running the install script using either of the commands bellow. +It is recommended to use a **Node version manager** like [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to install Node.js and npm. Do it by running the install script using either of the commands bellow. > Note: Make sure you replace v0.39.0 with the latest version of nvm. The actual version of nvm to install is [here](https://github.com/nvm-sh/nvm/blob/master/README.md#install--update-script). ```bash @@ -222,7 +224,7 @@ $ npm -v 8.15.0 ``` -**OK!** It looks like you have successfully installed node.js and npm. +**OK!** It looks like you have successfully installed node.js and npm. There are two more installations you need to perform, run the following commands in your console one after another: @@ -250,10 +252,22 @@ pip --version If they are not present, refer to the official installation guide for [Python](https://wiki.python.org/moin/BeginnersGuide/Download) and [Pip](https://pip.pypa.io/en/stable/installation/). +Additionally you have to have `wget` and `jq` installed: + +```bash +# Debian based distributions: +apt install wget jq + +# Mac +brew install wget jq +``` + > **If you don't want to use Docker, please skip this step!** We also work with Docker, but this is optional. Running STH is possible without Docker in the background. If you want to use Docker, you can install it by running the following commands in your console: +*On Mac u can use [Docker-Desktop](https://www.docker.com/products/docker-desktop/)* + ```bash # Install docker and docker-compose sudo apt install -y docker.io docker-compose @@ -302,8 +316,6 @@ In the meantime let me describe for you what is happening in the command you hav When both the package installation and build are complete, STH should be ready to run. - - --- ## Start STH :checkered_flag: @@ -499,7 +511,7 @@ We use our own scripts to control our monorepo. Here's a couple of helpful comma ```bash ./scripts/run-script.js [script] # Run an npm script in each package that contains that script. -./scripts/run-script.js --scope @scramjet/ +./scripts/run-script.js --scope @scramjet/ # Run script only in one package ./scripts/run-script.js --workspace packages # Run script in all packages in workspace diff --git a/docs/monitoring-server/.nojekyll b/docs/monitoring-server/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/docs/monitoring-server/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/monitoring-server/README.md b/docs/monitoring-server/README.md index 2fb5e365b..afebf8074 100644 --- a/docs/monitoring-server/README.md +++ b/docs/monitoring-server/README.md @@ -166,6 +166,8 @@ There are several installations you need to perform to get STH up and running, a - ts-node - docker - pip +- wget +- jq Our hub is based on node.js, so you need to install node.js and npm, which is the default package manager for node.js. To check if you already have Node.js(v16.xx.x) and npm installed, run the following commands in your console: @@ -177,7 +179,7 @@ npm -v If none of the above commands is found, **you must proceed with the installation.** -It is recommended to use a **Node version manager** like [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to install Node.js and npm. Do it by running the install script using either of the commands bellow. +It is recommended to use a **Node version manager** like [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to install Node.js and npm. Do it by running the install script using either of the commands bellow. > Note: Make sure you replace v0.39.0 with the latest version of nvm. The actual version of nvm to install is [here](https://github.com/nvm-sh/nvm/blob/master/README.md#install--update-script). ```bash @@ -222,7 +224,7 @@ $ npm -v 8.15.0 ``` -**OK!** It looks like you have successfully installed node.js and npm. +**OK!** It looks like you have successfully installed node.js and npm. There are two more installations you need to perform, run the following commands in your console one after another: @@ -250,10 +252,22 @@ pip --version If they are not present, refer to the official installation guide for [Python](https://wiki.python.org/moin/BeginnersGuide/Download) and [Pip](https://pip.pypa.io/en/stable/installation/). +Additionally you have to have `wget` and `jq` installed: + +```bash +# Debian based distributions: +apt install wget jq + +# Mac +brew install wget jq +``` + > **If you don't want to use Docker, please skip this step!** We also work with Docker, but this is optional. Running STH is possible without Docker in the background. If you want to use Docker, you can install it by running the following commands in your console: +*On Mac u can use [Docker-Desktop](https://www.docker.com/products/docker-desktop/)* + ```bash # Install docker and docker-compose sudo apt install -y docker.io docker-compose @@ -302,8 +316,6 @@ In the meantime let me describe for you what is happening in the command you hav When both the package installation and build are complete, STH should be ready to run. - - --- ## Start STH :checkered_flag: @@ -499,7 +511,7 @@ We use our own scripts to control our monorepo. Here's a couple of helpful comma ```bash ./scripts/run-script.js [script] # Run an npm script in each package that contains that script. -./scripts/run-script.js --scope @scramjet/ +./scripts/run-script.js --scope @scramjet/ # Run script only in one package ./scripts/run-script.js --workspace packages # Run script in all packages in workspace diff --git a/docs/monitoring-server/classes/MonitoringServer.md b/docs/monitoring-server/classes/MonitoringServer.md index 3d2fcca6e..b12baa0b8 100644 --- a/docs/monitoring-server/classes/MonitoringServer.md +++ b/docs/monitoring-server/classes/MonitoringServer.md @@ -17,21 +17,25 @@ - [handleHealtzRequest](MonitoringServer.md#handlehealtzrequest) - [start](MonitoringServer.md#start) +### Properties + +- [serverOptions](MonitoringServer.md#serveroptions) + ## Constructors ### constructor -• **new MonitoringServer**(`options`) +• **new MonitoringServer**(`serverOptions`) #### Parameters | Name | Type | | :------ | :------ | -| `options` | `MonitoringServerOptions` | +| `serverOptions` | `MonitoringServerOptions` | #### Defined in -[monitoring-server.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L9) +[monitoring-server/src/monitoring-server.ts:11](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L11) ## Methods @@ -45,7 +49,7 @@ #### Defined in -[monitoring-server.ts:31](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L31) +[monitoring-server/src/monitoring-server.ts:46](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L46) ___ @@ -63,4 +67,14 @@ IMonitoringServer.start #### Defined in -[monitoring-server.ts:35](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L35) +[monitoring-server/src/monitoring-server.ts:50](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L50) + +## Properties + +### serverOptions + +• **serverOptions**: `MonitoringServerOptions` + +#### Defined in + +[monitoring-server/src/monitoring-server.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L8) diff --git a/docs/monitoring-server/classes/MonitoringServerConf.md b/docs/monitoring-server/classes/MonitoringServerConf.md new file mode 100644 index 000000000..85588c604 --- /dev/null +++ b/docs/monitoring-server/classes/MonitoringServerConf.md @@ -0,0 +1,310 @@ +[@scramjet/monitoring-server](../README.md) / [Exports](../modules.md) / MonitoringServerConf + +# Class: MonitoringServerConf + +## Hierarchy + +- `ReadOnlyConfig`<`MonitoringServerConfig`\> + + ↳ **`MonitoringServerConf`** + +## Table of contents + +### Accessors + +- [config](MonitoringServerConf.md#config) +- [errors](MonitoringServerConf.md#errors) +- [host](MonitoringServerConf.md#host) +- [path](MonitoringServerConf.md#path) +- [port](MonitoringServerConf.md#port) + +### Properties + +- [configuration](MonitoringServerConf.md#configuration) +- [isValidConfig](MonitoringServerConf.md#isvalidconfig) + +### Constructors + +- [constructor](MonitoringServerConf.md#constructor) + +### Methods + +- [get](MonitoringServerConf.md#get) +- [getEntry](MonitoringServerConf.md#getentry) +- [has](MonitoringServerConf.md#has) +- [isValid](MonitoringServerConf.md#isvalid) +- [validate](MonitoringServerConf.md#validate) +- [validateEntry](MonitoringServerConf.md#validateentry) +- [validateEntry](MonitoringServerConf.md#validateentry-1) + +## Accessors + +### config + +• `get` **config**(): `MonitoringServerConfig` + +#### Returns + +`MonitoringServerConfig` + +#### Defined in + +[monitoring-server/src/config/monitoringConfig.ts:23](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/config/monitoringConfig.ts#L23) + +___ + +### errors + +• `get` **errors**(): `ValidationResult`[] + +#### Returns + +`ValidationResult`[] + +#### Defined in + +[monitoring-server/src/config/monitoringConfig.ts:20](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/config/monitoringConfig.ts#L20) + +___ + +### host + +• `get` **host**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[monitoring-server/src/config/monitoringConfig.ts:14](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/config/monitoringConfig.ts#L14) + +___ + +### path + +• `get` **path**(): `undefined` \| `string` + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[monitoring-server/src/config/monitoringConfig.ts:17](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/config/monitoringConfig.ts#L17) + +___ + +### port + +• `get` **port**(): `number` + +#### Returns + +`number` + +#### Defined in + +[monitoring-server/src/config/monitoringConfig.ts:11](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/config/monitoringConfig.ts#L11) + +## Properties + +### configuration + +• `Protected` `Readonly` **configuration**: `MonitoringServerConfig` + +#### Inherited from + +ReadOnlyConfig.configuration + +#### Defined in + +[utility/src/config/readOnlyConfig.ts:7](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/utility/src/config/readOnlyConfig.ts#L7) + +___ + +### isValidConfig + +• `Protected` `Readonly` **isValidConfig**: `boolean` + +#### Inherited from + +ReadOnlyConfig.isValidConfig + +#### Defined in + +[utility/src/config/readOnlyConfig.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/utility/src/config/readOnlyConfig.ts#L8) + +## Constructors + +### constructor + +• **new MonitoringServerConf**(`configuration`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `configuration` | `MonitoringServerConfig` | + +#### Inherited from + +ReadOnlyConfig.constructor + +#### Defined in + +[utility/src/config/readOnlyConfig.ts:10](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/utility/src/config/readOnlyConfig.ts#L10) + +## Methods + +### get + +▸ **get**(): `MonitoringServerConfig` + +#### Returns + +`MonitoringServerConfig` + +#### Inherited from + +ReadOnlyConfig.get + +#### Defined in + +[utility/src/config/readOnlyConfig.ts:20](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/utility/src/config/readOnlyConfig.ts#L20) + +___ + +### getEntry + +▸ **getEntry**(`key`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | keyof `MonitoringServerConfig` | + +#### Returns + +`any` + +#### Inherited from + +ReadOnlyConfig.getEntry + +#### Defined in + +[utility/src/config/readOnlyConfig.ts:38](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/utility/src/config/readOnlyConfig.ts#L38) + +___ + +### has + +▸ **has**(`key`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | keyof `MonitoringServerConfig` | + +#### Returns + +`boolean` + +#### Inherited from + +ReadOnlyConfig.has + +#### Defined in + +[utility/src/config/readOnlyConfig.ts:34](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/utility/src/config/readOnlyConfig.ts#L34) + +___ + +### isValid + +▸ **isValid**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +ReadOnlyConfig.isValid + +#### Defined in + +[utility/src/config/readOnlyConfig.ts:30](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/utility/src/config/readOnlyConfig.ts#L30) + +___ + +### validate + +▸ **validate**(`config`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `Record`<`string`, `any`\> | + +#### Returns + +`boolean` + +#### Overrides + +ReadOnlyConfig.validate + +#### Defined in + +[monitoring-server/src/config/monitoringConfig.ts:27](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/config/monitoringConfig.ts#L27) + +___ + +### validateEntry + +▸ `Static` **validateEntry**(`key`, `value`): ``null`` \| `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `value` | `any` | + +#### Returns + +``null`` \| `boolean` + +#### Defined in + +[monitoring-server/src/config/monitoringConfig.ts:33](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/config/monitoringConfig.ts#L33) + +___ + +### validateEntry + +▸ `Protected` **validateEntry**(`key`, `value`): ``null`` \| `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `value` | `any` | + +#### Returns + +``null`` \| `boolean` + +#### Overrides + +ReadOnlyConfig.validateEntry + +#### Defined in + +[monitoring-server/src/config/monitoringConfig.ts:30](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/config/monitoringConfig.ts#L30) diff --git a/docs/monitoring-server/modules.md b/docs/monitoring-server/modules.md index dab3f4998..70fa5586e 100644 --- a/docs/monitoring-server/modules.md +++ b/docs/monitoring-server/modules.md @@ -7,3 +7,4 @@ ### Classes - [MonitoringServer](classes/MonitoringServer.md) +- [MonitoringServerConf](classes/MonitoringServerConf.md) diff --git a/docs/multi-manager-api-client/README.md b/docs/multi-manager-api-client/README.md index d5b7f713c..840bf4191 100644 --- a/docs/multi-manager-api-client/README.md +++ b/docs/multi-manager-api-client/README.md @@ -166,6 +166,8 @@ There are several installations you need to perform to get STH up and running, a - ts-node - docker - pip +- wget +- jq Our hub is based on node.js, so you need to install node.js and npm, which is the default package manager for node.js. To check if you already have Node.js(v16.xx.x) and npm installed, run the following commands in your console: @@ -177,7 +179,7 @@ npm -v If none of the above commands is found, **you must proceed with the installation.** -It is recommended to use a **Node version manager** like [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to install Node.js and npm. Do it by running the install script using either of the commands bellow. +It is recommended to use a **Node version manager** like [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to install Node.js and npm. Do it by running the install script using either of the commands bellow. > Note: Make sure you replace v0.39.0 with the latest version of nvm. The actual version of nvm to install is [here](https://github.com/nvm-sh/nvm/blob/master/README.md#install--update-script). ```bash @@ -222,7 +224,7 @@ $ npm -v 8.15.0 ``` -**OK!** It looks like you have successfully installed node.js and npm. +**OK!** It looks like you have successfully installed node.js and npm. There are two more installations you need to perform, run the following commands in your console one after another: @@ -250,10 +252,22 @@ pip --version If they are not present, refer to the official installation guide for [Python](https://wiki.python.org/moin/BeginnersGuide/Download) and [Pip](https://pip.pypa.io/en/stable/installation/). +Additionally you have to have `wget` and `jq` installed: + +```bash +# Debian based distributions: +apt install wget jq + +# Mac +brew install wget jq +``` + > **If you don't want to use Docker, please skip this step!** We also work with Docker, but this is optional. Running STH is possible without Docker in the background. If you want to use Docker, you can install it by running the following commands in your console: +*On Mac u can use [Docker-Desktop](https://www.docker.com/products/docker-desktop/)* + ```bash # Install docker and docker-compose sudo apt install -y docker.io docker-compose @@ -302,8 +316,6 @@ In the meantime let me describe for you what is happening in the command you hav When both the package installation and build are complete, STH should be ready to run. - - --- ## Start STH :checkered_flag: @@ -499,7 +511,7 @@ We use our own scripts to control our monorepo. Here's a couple of helpful comma ```bash ./scripts/run-script.js [script] # Run an npm script in each package that contains that script. -./scripts/run-script.js --scope @scramjet/ +./scripts/run-script.js --scope @scramjet/ # Run script only in one package ./scripts/run-script.js --workspace packages # Run script in all packages in workspace diff --git a/docs/types/interfaces/IMonitoringServer.md b/docs/types/interfaces/IMonitoringServer.md index 525fcdf5e..c0c55e105 100644 --- a/docs/types/interfaces/IMonitoringServer.md +++ b/docs/types/interfaces/IMonitoringServer.md @@ -20,4 +20,4 @@ #### Defined in -[packages/types/src/monitoring-server.ts:16](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L16) +[packages/types/src/monitoring-server.ts:12](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L12) diff --git a/docs/types/interfaces/IMonitoringServerConf.md b/docs/types/interfaces/IMonitoringServerConf.md new file mode 100644 index 000000000..028030fd3 --- /dev/null +++ b/docs/types/interfaces/IMonitoringServerConf.md @@ -0,0 +1,109 @@ +[@scramjet/types](../README.md) / [Exports](../modules.md) / IMonitoringServerConf + +# Interface: IMonitoringServerConf + +## Table of contents + +### Properties + +- [config](IMonitoringServerConf.md#config) +- [host](IMonitoringServerConf.md#host) +- [isValidConfig](IMonitoringServerConf.md#isvalidconfig) +- [path](IMonitoringServerConf.md#path) +- [port](IMonitoringServerConf.md#port) + +### Methods + +- [validate](IMonitoringServerConf.md#validate) +- [validateEntry](IMonitoringServerConf.md#validateentry) + +## Properties + +### config + +• **config**: [`MonitoringServerConfig`](../modules.md#monitoringserverconfig) + +#### Defined in + +[packages/types/src/monitoring-server.ts:19](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L19) + +___ + +### host + +• **host**: `string` + +#### Defined in + +[packages/types/src/monitoring-server.ts:17](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L17) + +___ + +### isValidConfig + +• **isValidConfig**: `boolean` + +#### Defined in + +[packages/types/src/monitoring-server.ts:20](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L20) + +___ + +### path + +• **path**: `string` + +#### Defined in + +[packages/types/src/monitoring-server.ts:18](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L18) + +___ + +### port + +• **port**: `number` + +#### Defined in + +[packages/types/src/monitoring-server.ts:16](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L16) + +## Methods + +### validate + +▸ **validate**(`config`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `Record`<`string`, `any`\> | + +#### Returns + +`boolean` + +#### Defined in + +[packages/types/src/monitoring-server.ts:22](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L22) + +___ + +### validateEntry + +▸ **validateEntry**(`key`, `value`): ``null`` \| `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `value` | `any` | + +#### Returns + +``null`` \| `boolean` + +#### Defined in + +[packages/types/src/monitoring-server.ts:23](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L23) diff --git a/docs/types/interfaces/IMonitoringServerConfConstructor.md b/docs/types/interfaces/IMonitoringServerConfConstructor.md new file mode 100644 index 000000000..113f4810f --- /dev/null +++ b/docs/types/interfaces/IMonitoringServerConfConstructor.md @@ -0,0 +1,25 @@ +[@scramjet/types](../README.md) / [Exports](../modules.md) / IMonitoringServerConfConstructor + +# Interface: IMonitoringServerConfConstructor + +## Table of contents + +### Constructors + +- [constructor](IMonitoringServerConfConstructor.md#constructor) + +## Constructors + +### constructor + +• **new IMonitoringServerConfConstructor**(`opts`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | [`MonitoringServerConfig`](../modules.md#monitoringserverconfig) | + +#### Defined in + +[packages/types/src/monitoring-server.ts:35](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L35) diff --git a/docs/types/interfaces/IMonitoringServerConstructor.md b/docs/types/interfaces/IMonitoringServerConstructor.md index f23f1bb4b..8e6523777 100644 --- a/docs/types/interfaces/IMonitoringServerConstructor.md +++ b/docs/types/interfaces/IMonitoringServerConstructor.md @@ -22,4 +22,4 @@ #### Defined in -[packages/types/src/monitoring-server.ts:20](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L20) +[packages/types/src/monitoring-server.ts:31](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L31) diff --git a/docs/types/modules.md b/docs/types/modules.md index 819555681..bc72663da 100644 --- a/docs/types/modules.md +++ b/docs/types/modules.md @@ -18,6 +18,8 @@ - [ILifeCycleAdapterMain](interfaces/ILifeCycleAdapterMain.md) - [ILifeCycleAdapterRun](interfaces/ILifeCycleAdapterRun.md) - [IMonitoringServer](interfaces/IMonitoringServer.md) +- [IMonitoringServerConf](interfaces/IMonitoringServerConf.md) +- [IMonitoringServerConfConstructor](interfaces/IMonitoringServerConfConstructor.md) - [IMonitoringServerConstructor](interfaces/IMonitoringServerConstructor.md) - [IObjectLogger](interfaces/IObjectLogger.md) - [ISequenceAdapter](interfaces/ISequenceAdapter.md) @@ -29,6 +31,7 @@ - [APIErrorMessage](modules.md#apierrormessage) - [AcknowledgeMessage](modules.md#acknowledgemessage) - [AcknowledgeMessageData](modules.md#acknowledgemessagedata) +- [AddSTHTopicEventData](modules.md#addsthtopiceventdata) - [ApiVersion](modules.md#apiversion) - [AppConfig](modules.md#appconfig) - [AppError](modules.md#apperror) @@ -152,6 +155,7 @@ - [ReadFunction](modules.md#readfunction) - [ReadSequence](modules.md#readsequence) - [ReadableApp](modules.md#readableapp) +- [RemoveSTHTopicEventData](modules.md#removesthtopiceventdata) - [RunnerContainerConfiguration](modules.md#runnercontainerconfiguration) - [RunnerErrorCode](modules.md#runnererrorcode) - [RunnerMessage](modules.md#runnermessage) @@ -159,6 +163,7 @@ - [STHCommandOptions](modules.md#sthcommandoptions) - [STHConfiguration](modules.md#sthconfiguration) - [STHIDMessageData](modules.md#sthidmessagedata) +- [STHTopicEventData](modules.md#sthtopiceventdata) - [SequenceAdapterErrorCode](modules.md#sequenceadaptererrorcode) - [SequenceBulkMessage](modules.md#sequencebulkmessage) - [SequenceCompleteMessage](modules.md#sequencecompletemessage) @@ -277,6 +282,16 @@ ___ ___ +### AddSTHTopicEventData + +Ƭ **AddSTHTopicEventData**: `BaseSTHTopicEventData` & { `contentType`: `string` ; `localProvider?`: `string` ; `status`: ``"add"`` } & { `provides?`: `never` ; `requires`: `string` } \| { `provides`: `string` ; `requires?`: `never` } + +#### Defined in + +[packages/types/src/messages/sth-topic.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/messages/sth-topic.ts#L8) + +___ + ### ApiVersion Ƭ **ApiVersion**: `string` @@ -1860,7 +1875,7 @@ ___ #### Defined in -[packages/types/src/monitoring-server.ts:11](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L11) +[packages/types/src/monitoring-server.ts:26](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L26) ___ @@ -2273,6 +2288,16 @@ A Readable App is an app that obtains the data by it's own means and preforms ___ +### RemoveSTHTopicEventData + +Ƭ **RemoveSTHTopicEventData**: `BaseSTHTopicEventData` & { `status`: ``"remove"`` } + +#### Defined in + +[packages/types/src/messages/sth-topic.ts:17](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/messages/sth-topic.ts#L17) + +___ + ### RunnerContainerConfiguration Ƭ **RunnerContainerConfiguration**: [`ContainerConfiguration`](modules.md#containerconfiguration) & [`ContainerConfigurationWithExposedPorts`](modules.md#containerconfigurationwithexposedports) @@ -2462,6 +2487,16 @@ ___ ___ +### STHTopicEventData + +Ƭ **STHTopicEventData**: [`AddSTHTopicEventData`](modules.md#addsthtopiceventdata) \| [`RemoveSTHTopicEventData`](modules.md#removesthtopiceventdata) + +#### Defined in + +[packages/types/src/messages/sth-topic.ts:21](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/messages/sth-topic.ts#L21) + +___ + ### SequenceAdapterErrorCode Ƭ **SequenceAdapterErrorCode**: ``"DOCKER_ERROR"`` \| ``"PRERUNNER_ERROR"`` diff --git a/package.json b/package.json index 9b8da5e28..3e7a9ea5f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/transform-hub", - "version": "0.37.0", + "version": "0.38.0", "private": true, "description": "A development repo for Scramjet Transform Hub, a container supervisor that allows deployment, execution and monitoring of any application based on a simple interface.", "main": "index.js", diff --git a/packages/adapters/package.json b/packages/adapters/package.json index e2917b6d4..fc5c9f349 100644 --- a/packages/adapters/package.json +++ b/packages/adapters/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/adapters", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. This module holds the docker adapters utilized by Scramjet Transform Hub", "main": "./src/index.ts", "scripts": { @@ -16,14 +16,14 @@ "license": "AGPL-3.0", "dependencies": { "@kubernetes/client-node": "^0.17.1", - "@scramjet/model": "^0.37.0", - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/pre-runner": "^0.37.0", - "@scramjet/python-runner": "^0.37.0", - "@scramjet/runner": "^0.37.0", - "@scramjet/sth-config": "^0.37.0", - "@scramjet/symbols": "^0.37.0", - "@scramjet/utility": "^0.37.0", + "@scramjet/model": "^0.38.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/pre-runner": "^0.38.0", + "@scramjet/python-runner": "^0.38.0", + "@scramjet/runner": "^0.38.0", + "@scramjet/sth-config": "^0.38.0", + "@scramjet/symbols": "^0.38.0", + "@scramjet/utility": "^0.38.0", "dockerode": "^3.3.4", "scramjet": "^4.36.9", "shell-escape": "^0.2.0", @@ -31,7 +31,7 @@ "ts.data.json": "^2.2.0" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/dockerode": "<=3.3.3", "@types/js-yaml": "4.0.5", "@types/node": "15.12.5", diff --git a/packages/api-client/package.json b/packages/api-client/package.json index 5f6c37b36..11ce12241 100644 --- a/packages/api-client/package.json +++ b/packages/api-client/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/api-client", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package provides the API Client for use with Scramjet Transform Hub.", "main": "./src/index.ts", "scripts": { @@ -13,14 +13,14 @@ "author": "Scramjet ", "license": "MIT", "dependencies": { - "@scramjet/client-utils": "^0.37.0", - "@scramjet/sth-config": "^0.37.0", - "@scramjet/symbols": "^0.37.0", + "@scramjet/client-utils": "^0.38.0", + "@scramjet/sth-config": "^0.38.0", + "@scramjet/symbols": "^0.38.0", "n-readlines": "^1.0.1", "scramjet": "^4.36.9" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "ava": "^3.15.0", "ts-node": "^10.9.1", diff --git a/packages/api-server/package.json b/packages/api-server/package.json index 47535e079..cc5230c1e 100644 --- a/packages/api-server/package.json +++ b/packages/api-server/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/api-server", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package provides the domain model for STH and the CLI.", "main": "./src/index.ts", "scripts": { @@ -15,15 +15,15 @@ "license": "AGPL-3.0", "dependencies": { "0http": "^3.4.1", - "@scramjet/model": "^0.37.0", - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/symbols": "^0.37.0", - "@scramjet/utility": "^0.37.0", + "@scramjet/model": "^0.38.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/symbols": "^0.38.0", + "@scramjet/utility": "^0.38.0", "http-status-codes": "^2.2.0", "scramjet": "^4.36.9" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "@types/sinon": "^10.0.13", "@types/trouter": "^3.1.1", diff --git a/packages/cli/package.json b/packages/cli/package.json index a9c13165e..dd6f5914f 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/cli", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package provides a CLI interface to communicate with Scramjet Transform Hub.", "main": "./src/index.ts", "bin": { @@ -20,11 +20,11 @@ "author": "Scramjet ", "license": "AGPL-3.0", "dependencies": { - "@scramjet/api-client": "^0.37.0", - "@scramjet/client-utils": "^0.37.0", - "@scramjet/middleware-api-client": "^0.37.0", - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/utility": "^0.37.0", + "@scramjet/api-client": "^0.38.0", + "@scramjet/client-utils": "^0.38.0", + "@scramjet/middleware-api-client": "^0.38.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/utility": "^0.38.0", "chalk": "^4.1.2", "commander": "^9.5.0", "find-package-json": "^1.2.0", @@ -34,7 +34,7 @@ "validator": "^13.7.0" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/find-package-json": "^1.2.3", "@types/minimatch": "^3.0.5", "@types/node": "15.12.5", diff --git a/packages/client-utils/package.json b/packages/client-utils/package.json index 2ee55e633..87fd9376a 100644 --- a/packages/client-utils/package.json +++ b/packages/client-utils/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/client-utils", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package provides the API Client Utils for use with Scramjet Transform Hub.", "main": "./src/index.ts", "browser": "./src/index.browser.ts", @@ -14,11 +14,11 @@ "author": "Scramjet ", "license": "MIT", "dependencies": { - "@scramjet/model": "^0.37.0", - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/sth-config": "^0.37.0", - "@scramjet/symbols": "^0.37.0", - "@scramjet/utility": "^0.37.0", + "@scramjet/model": "^0.38.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/sth-config": "^0.38.0", + "@scramjet/symbols": "^0.38.0", + "@scramjet/utility": "^0.38.0", "@types/node-fetch": "^2.6.4", "abort-controller": "^3.0.0", "n-readlines": "^1.0.1", @@ -27,7 +27,7 @@ "scramjet": "^4.36.9" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "@types/node-fetch": "^2.6.2", "ava": "^3.15.0", diff --git a/packages/host/package.json b/packages/host/package.json index d0478a91b..9b5dab72e 100644 --- a/packages/host/package.json +++ b/packages/host/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/host", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package provides the main host subsystem of STH - starts API Servers, creates adapters etc.", "main": "./src/index.ts", "scripts": { @@ -18,17 +18,17 @@ "author": "Scramjet ", "license": "AGPL-3.0", "dependencies": { - "@scramjet/adapters": "^0.37.0", - "@scramjet/api-server": "^0.37.0", - "@scramjet/load-check": "^0.37.0", - "@scramjet/model": "^0.37.0", - "@scramjet/module-loader": "^0.37.0", - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/sth-config": "^0.37.0", - "@scramjet/symbols": "^0.37.0", - "@scramjet/telemetry": "^0.37.0", - "@scramjet/utility": "^0.37.0", - "@scramjet/verser": "^0.37.0", + "@scramjet/adapters": "^0.38.0", + "@scramjet/api-server": "^0.38.0", + "@scramjet/load-check": "^0.38.0", + "@scramjet/model": "^0.38.0", + "@scramjet/module-loader": "^0.38.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/sth-config": "^0.38.0", + "@scramjet/symbols": "^0.38.0", + "@scramjet/telemetry": "^0.38.0", + "@scramjet/utility": "^0.38.0", + "@scramjet/verser": "^0.38.0", "bpmux": "^8.2.1", "ext-ip": "^0.3.9", "find-package-json": "^1.2.0", @@ -40,7 +40,7 @@ "systeminformation": "^5.21.7" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/find-package-json": "^1.2.3", "@types/jest": "^29.4.4", "@types/node": "15.12.5", diff --git a/packages/load-check/package.json b/packages/load-check/package.json index 6f30adbcf..db8eed566 100644 --- a/packages/load-check/package.json +++ b/packages/load-check/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/load-check", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package provides health info for STH.", "main": "./src/index.ts", "scripts": { @@ -14,14 +14,14 @@ "author": "Scramjet ", "license": "AGPL-3.0", "dependencies": { - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/utility": "^0.37.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/utility": "^0.38.0", "scramjet": "^4.36.9", "systeminformation": "^5.21.7", "uuid": "^8.3.2" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "@types/uuid": "^8.3.4", "ava": "^3.15.0", diff --git a/packages/logger/package.json b/packages/logger/package.json index 4bb623547..72fc6017e 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/logger", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package provides a simple logger with 100% Console Web API compatible signatures and a streaming output of any choice.", "main": "./src/index.ts", "scripts": { @@ -14,7 +14,7 @@ "author": "Scramjet ", "license": "AGPL-3.0", "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "ava": "^3.15.0", "nyc": "^15.1.0", diff --git a/packages/manager-api-client/package.json b/packages/manager-api-client/package.json index dc6679c19..7a2c53260 100644 --- a/packages/manager-api-client/package.json +++ b/packages/manager-api-client/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/manager-api-client", - "version": "0.37.0", + "version": "0.38.0", "description": "Scramjet Manager API Client", "main": "src/index.ts", "scripts": { @@ -12,11 +12,11 @@ "test:ava": "ava" }, "dependencies": { - "@scramjet/api-client": "^0.37.0", - "@scramjet/client-utils": "^0.37.0" + "@scramjet/api-client": "^0.38.0", + "@scramjet/client-utils": "^0.38.0" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "ava": "^3.15.0", "ts-node": "^10.9.1", diff --git a/packages/middleware-api-client/package.json b/packages/middleware-api-client/package.json index 6b31bd8a4..a8ced1c5e 100644 --- a/packages/middleware-api-client/package.json +++ b/packages/middleware-api-client/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/middleware-api-client", - "version": "0.37.0", + "version": "0.38.0", "description": "Scramjet Middleware API Client", "main": "src/index.ts", "scripts": { @@ -14,13 +14,13 @@ "test:ava": "ava" }, "dependencies": { - "@scramjet/api-client": "^0.37.0", - "@scramjet/client-utils": "^0.37.0", - "@scramjet/manager-api-client": "^0.37.0", - "@scramjet/multi-manager-api-client": "^0.37.0" + "@scramjet/api-client": "^0.38.0", + "@scramjet/client-utils": "^0.38.0", + "@scramjet/manager-api-client": "^0.38.0", + "@scramjet/multi-manager-api-client": "^0.38.0" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "ava": "^3.15.0", "esbuild": "^0.14.54", "ts-node": "^10.9.1", diff --git a/packages/model/package.json b/packages/model/package.json index 257396b11..df0fb4c7b 100644 --- a/packages/model/package.json +++ b/packages/model/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/model", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package provides the domain model for STH and the CLI.", "main": "./src/index.ts", "scripts": { @@ -13,13 +13,13 @@ "author": "Scramjet ", "license": "AGPL-3.0", "dependencies": { - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/symbols": "^0.37.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/symbols": "^0.38.0", "scramjet": "^4.36.9", "uuid": "^8.3.2" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "@types/uuid": "^8.3.4", "ava": "^3.15.0", diff --git a/packages/module-loader/package.json b/packages/module-loader/package.json index a5fa5345c..5aeb8ed4a 100644 --- a/packages/module-loader/package.json +++ b/packages/module-loader/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/module-loader", - "version": "0.37.0", + "version": "0.38.0", "description": "Scramjet Module Loader", "main": "src/index.ts", "scripts": { @@ -12,10 +12,10 @@ "test:ava": "# nyc ava" }, "dependencies": { - "@scramjet/obj-logger": "^0.37.0" + "@scramjet/obj-logger": "^0.38.0" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "ava": "^3.15.0", "ts-node": "^10.9.1", diff --git a/packages/monitoring-server/package.json b/packages/monitoring-server/package.json index 9f87cb6e6..60936bbce 100644 --- a/packages/monitoring-server/package.json +++ b/packages/monitoring-server/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/monitoring-server", - "version": "0.37.0", + "version": "0.38.0", "description": "Scramjet Monitoring Server", "main": "src/index.ts", "scripts": { @@ -12,10 +12,10 @@ "test:ava": "# nyc ava" }, "dependencies": { - "@scramjet/utility": "^0.37.0" + "@scramjet/utility": "^0.38.0" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "ava": "^3.15.0", "nyc": "^15.1.0", diff --git a/packages/multi-manager-api-client/package.json b/packages/multi-manager-api-client/package.json index 823e870b1..e901bcc2c 100644 --- a/packages/multi-manager-api-client/package.json +++ b/packages/multi-manager-api-client/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/multi-manager-api-client", - "version": "0.37.0", + "version": "0.38.0", "description": "Scramjet MultiManager API Client", "main": "src/index.ts", "scripts": { @@ -12,12 +12,12 @@ "test:ava": "ava" }, "dependencies": { - "@scramjet/api-client": "^0.37.0", - "@scramjet/client-utils": "^0.37.0", - "@scramjet/manager-api-client": "^0.37.0" + "@scramjet/api-client": "^0.38.0", + "@scramjet/client-utils": "^0.38.0", + "@scramjet/manager-api-client": "^0.38.0" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "ava": "^3.15.0", "ts-node": "^10.9.1", diff --git a/packages/obj-logger/package.json b/packages/obj-logger/package.json index 6463461ab..f08c3f927 100644 --- a/packages/obj-logger/package.json +++ b/packages/obj-logger/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/obj-logger", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package provides a simple logger with 100% Console Web API compatible signatures and a streaming output of any choice.", "main": "./src/index.ts", "scripts": { @@ -14,7 +14,7 @@ "author": "Scramjet ", "license": "AGPL-3.0", "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "ava": "^3.15.0", "nyc": "^15.1.0", @@ -24,7 +24,7 @@ "typescript": "~4.7.4" }, "dependencies": { - "@scramjet/utility": "^0.37.0", + "@scramjet/utility": "^0.38.0", "scramjet": "^4.36.9" }, "ava": { diff --git a/packages/pre-runner/package.json b/packages/pre-runner/package.json index 7b32b84dd..2f304aff3 100644 --- a/packages/pre-runner/package.json +++ b/packages/pre-runner/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/pre-runner", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package identifies the sequences and returns the information to back STH.", "scripts": { "build:docker": "docker build -t scramjetorg/pre-runner:$(git rev-parse HEAD) .", diff --git a/packages/python-runner/package.json b/packages/python-runner/package.json index 0153ca4b0..ec56f95b9 100644 --- a/packages/python-runner/package.json +++ b/packages/python-runner/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/python-runner", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package executes the remote runners and provides communication with them through abstraction layer provided by adapters.", "main": "./runner.py", "scripts": { diff --git a/packages/runner/package.json b/packages/runner/package.json index 93328dd0e..40cfbc5e2 100644 --- a/packages/runner/package.json +++ b/packages/runner/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/runner", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package executes the remote runners and provides communication with them through abstraction layer provided by adapters.", "main": "./src/bin/start-runner.ts", "scripts": { @@ -16,18 +16,18 @@ "author": "Scramjet ", "license": "MIT", "dependencies": { - "@scramjet/api-client": "^0.37.0", - "@scramjet/client-utils": "^0.37.0", - "@scramjet/manager-api-client": "^0.37.0", - "@scramjet/model": "^0.37.0", - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/symbols": "^0.37.0", - "@scramjet/utility": "^0.37.0", + "@scramjet/api-client": "^0.38.0", + "@scramjet/client-utils": "^0.38.0", + "@scramjet/manager-api-client": "^0.38.0", + "@scramjet/model": "^0.38.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/symbols": "^0.38.0", + "@scramjet/utility": "^0.38.0", "bpmux": "^8.2.1", "scramjet": "^4.36.9" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "@types/sinon": "^10.0.13", "ava": "^3.15.0", diff --git a/packages/sth-config/package.json b/packages/sth-config/package.json index 2489d4587..898ee33da 100644 --- a/packages/sth-config/package.json +++ b/packages/sth-config/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/sth-config", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package executes the sequences and controls the runner via the wired adapter.", "author": "Scramjet ", "homepage": "https://github.com/scramjetorg/transform-hub#readme", @@ -39,10 +39,10 @@ "url": "https://github.com/scramjetorg/transform-hub/issues" }, "dependencies": { - "@scramjet/utility": "^0.37.0" + "@scramjet/utility": "^0.38.0" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "ava": "^3.15.0", "typedoc": "0.23.17", "typedoc-plugin-markdown": "3.13.6" diff --git a/packages/sth-config/src/image-config.json b/packages/sth-config/src/image-config.json index e9f61bdd0..99c5d31b9 100644 --- a/packages/sth-config/src/image-config.json +++ b/packages/sth-config/src/image-config.json @@ -1,7 +1,7 @@ { - "prerunner": "scramjetorg/pre-runner:0.37.0", + "prerunner": "scramjetorg/pre-runner:0.38.0", "runner": { - "node": "scramjetorg/runner:0.37.0", - "python3": "scramjetorg/runner-py:0.37.0" + "node": "scramjetorg/runner:0.38.0", + "python3": "scramjetorg/runner-py:0.38.0" } } diff --git a/packages/sth/package.json b/packages/sth/package.json index 5b9a0bbb7..9f0213aea 100644 --- a/packages/sth/package.json +++ b/packages/sth/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/sth", - "version": "0.37.0", + "version": "0.38.0", "description": "Scramjet Transform Hub is a deployment and execution platform. Once installed on a server, it will allow you to start your programs and keep them running on a remote machine. You will be able to start programs in the background or connect to them and see their output directly on your terminal. You will be able to pipe your local data to the program as if it was running from your terminal. You can start your server in AWS, Google Cloud or Azure, start it on your local machine, install it on a Raspberry Pi or wherever else you'd like.", "main": "src/index.ts", "bin": { @@ -20,15 +20,15 @@ "author": "Scramjet ", "license": "AGPL-3.0", "dependencies": { - "@scramjet/host": "^0.37.0", - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/sth-config": "^0.37.0", - "@scramjet/utility": "^0.37.0", + "@scramjet/host": "^0.38.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/sth-config": "^0.38.0", + "@scramjet/utility": "^0.38.0", "commander": "^8.3.0" }, "devDependencies": { - "@scramjet/model": "^0.37.0", - "@scramjet/types": "^0.37.0", + "@scramjet/model": "^0.38.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "ava": "^3.15.0", "ts-node": "^10.9.1", diff --git a/packages/symbols/package.json b/packages/symbols/package.json index c15832061..58f9ba0d4 100644 --- a/packages/symbols/package.json +++ b/packages/symbols/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/symbols", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package holds the symbols and enumerations for STH.", "main": "./src/index.ts", "scripts": { diff --git a/packages/telemetry/package.json b/packages/telemetry/package.json index 88efbb288..02ea87e6f 100644 --- a/packages/telemetry/package.json +++ b/packages/telemetry/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/telemetry", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package provides modules for gathering analytics data.", "author": "Scramjet ", "homepage": "https://github.com/scramjetorg/transform-hub#readme", @@ -32,13 +32,13 @@ "url": "https://github.com/scramjetorg/transform-hub/issues" }, "dependencies": { - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/utility": "^0.37.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/utility": "^0.38.0", "winston": "^3.8.2", "winston-loki": "^6.0.6" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "ava": "^3.15.0", "typedoc": "0.23.17", "typedoc-plugin-markdown": "3.13.6" diff --git a/packages/types/package.json b/packages/types/package.json index 194366198..cdb4a712a 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/types", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package holds the typescript definitions for all common STH interfaces.", "main": "./src/index.ts", "scripts": { @@ -14,7 +14,7 @@ "author": "Scramjet ", "license": "AGPL-3.0", "dependencies": { - "@scramjet/symbols": "^0.37.0", + "@scramjet/symbols": "^0.38.0", "http-status-codes": "^2.2.0" }, "devDependencies": { diff --git a/packages/utility/package.json b/packages/utility/package.json index dfeb604ae..ff260e9be 100644 --- a/packages/utility/package.json +++ b/packages/utility/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/utility", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package holds utility functions used in places around Scramjet Transform Hub.", "author": "Scramjet ", "homepage": "https://github.com/scramjetorg/transform-hub#readme", @@ -33,7 +33,7 @@ "url": "https://github.com/scramjetorg/transform-hub/issues" }, "devDependencies": { - "@scramjet/types": "^0.37.0", + "@scramjet/types": "^0.38.0", "ava": "^4.3.3", "typed-emitter": "^1.4.0", "typedoc": "0.23.17", diff --git a/packages/verser/package.json b/packages/verser/package.json index 9fc7d7086..af8e28475 100644 --- a/packages/verser/package.json +++ b/packages/verser/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/verser", - "version": "0.37.0", + "version": "0.38.0", "description": "This package is part of Scramjet Transform Hub. The package provides a reverse server functionality used among Scramjet modules.", "main": "./src/index.ts", "scripts": { @@ -14,13 +14,13 @@ "author": "Scramjet ", "license": "AGPL-3.0", "dependencies": { - "@scramjet/obj-logger": "^0.37.0", - "@scramjet/utility": "^0.37.0", + "@scramjet/obj-logger": "^0.38.0", + "@scramjet/utility": "^0.38.0", "bpmux": "^8.2.1" }, "devDependencies": { - "@scramjet/api-server": "^0.37.0", - "@scramjet/types": "^0.37.0", + "@scramjet/api-server": "^0.38.0", + "@scramjet/types": "^0.38.0", "@types/node": "15.12.5", "ava": "^3.15.0", "ts-node": "^10.9.1",