From 8cd3d7457e53cc47139b29c661ee6497afd30636 Mon Sep 17 00:00:00 2001 From: Alicja Gruzdz Date: Mon, 27 Nov 2023 13:47:52 +0000 Subject: [PATCH 1/2] Changelog and docs update --- CHANGELOG.md | 34 ++++ .../adapters/classes/DockerInstanceAdapter.md | 47 +++--- .../adapters/classes/DockerodeDockerHelper.md | 37 ++--- .../classes/KubernetesInstanceAdapter.md | 45 ++++-- .../classes/ProcessInstanceAdapter.md | 8 +- docs/adapters/interfaces/IDockerHelper.md | 37 ++--- docs/adapters/modules.md | 17 +- docs/api-client/classes/HostClient.md | 28 ++-- docs/cli/commands-description.md | 32 ++-- docs/host/classes/CSIController.md | 42 ++--- docs/host/classes/Host.md | 58 +++---- docs/obj-logger/classes/ObjLogger.md | 28 ++-- docs/runner/classes/Runner.md | 30 ++-- docs/types/classes/HostClient.md | 152 ++++++++++++++++-- docs/types/interfaces/APIBase.md | 14 +- docs/types/interfaces/APIError.md | 6 +- docs/types/interfaces/APIExpose.md | 22 +-- docs/types/interfaces/APIRoute.md | 16 +- docs/types/modules.md | 46 ++++-- docs/utility/modules.md | 42 +++++ docs/verser/classes/VerserConnection.md | 8 +- 21 files changed, 500 insertions(+), 249 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 771113560..168e03f7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,40 @@ This is the changelog for Scramjet Transform Hub. It holds only notable commits, others are grouped without commit info. +## [0.37.0] - 2023-11-27 + +## Features + +* VDM-1493 [TEST CLI] Feat/Instance restart by @karoltylenda in https://github.com/scramjetorg/transform-hub/pull/965 +* [CLI] Add `si seq start --inst-id` to CLI command by @a-tylenda in https://github.com/scramjetorg/transform-hub/pull/966 +* Add option to provide file with arguments to start/deploy sequence by @patuwwy in https://github.com/scramjetorg/transform-hub/pull/971 +* Feat/cli yaml config by @piotrek6641 in https://github.com/scramjetorg/transform-hub/pull/980 +* Example configs by @a-tylenda in https://github.com/scramjetorg/transform-hub/pull/968 +* add create and remove new profile by @karoltylenda in https://github.com/scramjetorg/transform-hub/pull/975 +* GPU in Python Runner (docker) by @patuwwy in https://github.com/scramjetorg/transform-hub/pull/928 +* [CLI]add path option to si init by @karoltylenda in https://github.com/scramjetorg/transform-hub/pull/989 +* Pagination-support by @gzukowski in https://github.com/scramjetorg/transform-hub/pull/949 +* [CLI TEST] VDM-1507 si init by @karoltylenda in https://github.com/scramjetorg/transform-hub/pull/990 +* Set default runner envs with `--runner-envs` STH param by @piotrek6641 in https://github.com/scramjetorg/transform-hub/pull/986 + +## Fixed + +* [FIX] Instance ID replacement in `si inst restart -` by @a-tylenda in https://github.com/scramjetorg/transform-hub/pull/963 +* Bump @babel/traverse from 7.20.13 to 7.23.2 by @dependabot in https://github.com/scramjetorg/transform-hub/pull/964 +* fix variable name by @piotrek6641 in https://github.com/scramjetorg/transform-hub/pull/967 +* [CLI] Remove session configs with write access by @patuwwy in https://github.com/scramjetorg/transform-hub/pull/970 +* Show Node version on Host start by @patuwwy in https://github.com/scramjetorg/transform-hub/pull/974 +* Auto set contenty-type in PANG by @patuwwy in https://github.com/scramjetorg/transform-hub/pull/972 +* Fix ObjLogger arguments reference by @patuwwy in https://github.com/scramjetorg/transform-hub/pull/973 +* Fix logging circular args by @patuwwy in https://github.com/scramjetorg/transform-hub/pull/977 +* Set Node to 18 in STH and Runner Dockerfiles by @patuwwy in https://github.com/scramjetorg/transform-hub/pull/979 +* VDM-1516 change node in workflow and as defualt input from 16 to 18 by @tomekcrm in https://github.com/scramjetorg/transform-hub/pull/981 +* [FIX] Add missing hostClient types by @a-tylenda in https://github.com/scramjetorg/transform-hub/pull/982 +* Fix linting and duplicated code by @patuwwy in https://github.com/scramjetorg/transform-hub/pull/984 +* [FIX] VDM-1507 add missed description by @karoltylenda in https://github.com/scramjetorg/transform-hub/pull/992 +* Change in makeRequest method by @patuwwy in https://github.com/scramjetorg/transform-hub/pull/991 +* Small cleanup in host and runner logs by @patuwwy in https://github.com/scramjetorg/transform-hub/pull/995 + ## [0.36.1] - 2023-10-02 ## Fixed diff --git a/docs/adapters/classes/DockerInstanceAdapter.md b/docs/adapters/classes/DockerInstanceAdapter.md index e45e74408..7f21cfc5d 100644 --- a/docs/adapters/classes/DockerInstanceAdapter.md +++ b/docs/adapters/classes/DockerInstanceAdapter.md @@ -20,6 +20,7 @@ Adapter for running Instance by Runner executed in Docker container. - [id](DockerInstanceAdapter.md#id) - [logger](DockerInstanceAdapter.md#logger) - [resources](DockerInstanceAdapter.md#resources) +- [sthConfig](DockerInstanceAdapter.md#sthconfig) ### Methods @@ -60,7 +61,7 @@ ___ #### Defined in -[docker-instance-adapter.ts:39](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L39) +[docker-instance-adapter.ts:40](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L40) ___ @@ -84,7 +85,7 @@ ILifeCycleAdapterMain.id #### Defined in -[docker-instance-adapter.ts:35](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L35) +[docker-instance-adapter.ts:36](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L36) ___ @@ -98,7 +99,7 @@ ILifeCycleAdapterMain.logger #### Defined in -[docker-instance-adapter.ts:37](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L37) +[docker-instance-adapter.ts:38](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L38) ___ @@ -110,6 +111,16 @@ ___ [docker-instance-adapter.ts:34](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L34) +___ + +### sthConfig + +• `Private` **sthConfig**: `STHConfiguration` + +#### Defined in + +[docker-instance-adapter.ts:35](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L35) + ## Methods ### cleanup @@ -129,7 +140,7 @@ ILifeCycleAdapterMain.cleanup #### Defined in -[docker-instance-adapter.ts:249](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L249) +[docker-instance-adapter.ts:254](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L254) ___ @@ -147,7 +158,7 @@ ILifeCycleAdapterMain.getCrashLog #### Defined in -[docker-instance-adapter.ts:278](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L278) +[docker-instance-adapter.ts:283](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L283) ___ @@ -161,7 +172,7 @@ ___ #### Defined in -[docker-instance-adapter.ts:133](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L133) +[docker-instance-adapter.ts:135](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L135) ___ @@ -186,7 +197,7 @@ Configuration for exposing and binding ports in Docker container. #### Defined in -[docker-instance-adapter.ts:97](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L97) +[docker-instance-adapter.ts:99](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L99) ___ @@ -204,7 +215,7 @@ ILifeCycleAdapterMain.init #### Defined in -[docker-instance-adapter.ts:52](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L52) +[docker-instance-adapter.ts:54](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L54) ___ @@ -228,7 +239,7 @@ ILifeCycleAdapterRun.monitorRate #### Defined in -[docker-instance-adapter.ts:261](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L261) +[docker-instance-adapter.ts:266](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L266) ___ @@ -254,7 +265,7 @@ Promise resolving with map of ports mapping. #### Defined in -[docker-instance-adapter.ts:66](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L66) +[docker-instance-adapter.ts:68](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L68) ___ @@ -274,7 +285,7 @@ ILifeCycleAdapterMain.remove #### Defined in -[docker-instance-adapter.ts:268](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L268) +[docker-instance-adapter.ts:273](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L273) ___ @@ -300,7 +311,7 @@ ILifeCycleAdapterRun.run #### Defined in -[docker-instance-adapter.ts:171](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L171) +[docker-instance-adapter.ts:173](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L173) ___ @@ -328,24 +339,24 @@ ILifeCycleAdapterRun.stats #### Defined in -[docker-instance-adapter.ts:114](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L114) +[docker-instance-adapter.ts:116](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L116) ## Constructors ### constructor -• **new DockerInstanceAdapter**(`_sthConfig`, `id?`) +• **new DockerInstanceAdapter**(`sthConfig`, `id?`) #### Parameters | Name | Type | Default value | | :------ | :------ | :------ | -| `_sthConfig` | `STHConfiguration` | `undefined` | +| `sthConfig` | `STHConfiguration` | `undefined` | | `id` | `string` | `""` | #### Defined in -[docker-instance-adapter.ts:44](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L44) +[docker-instance-adapter.ts:45](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L45) ## Accessors @@ -363,7 +374,7 @@ ILifeCycleAdapterRun.limits #### Defined in -[docker-instance-adapter.ts:41](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L41) +[docker-instance-adapter.ts:42](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L42) • `set` **limits**(`value`): `void` @@ -383,4 +394,4 @@ ILifeCycleAdapterRun.limits #### Defined in -[docker-instance-adapter.ts:42](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L42) +[docker-instance-adapter.ts:43](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-instance-adapter.ts#L43) diff --git a/docs/adapters/classes/DockerodeDockerHelper.md b/docs/adapters/classes/DockerodeDockerHelper.md index 14a6f1d9e..b8bb998b7 100644 --- a/docs/adapters/classes/DockerodeDockerHelper.md +++ b/docs/adapters/classes/DockerodeDockerHelper.md @@ -65,7 +65,7 @@ Object with container's standard I/O streams. #### Defined in -[dockerode-docker-helper.ts:291](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L291) +[dockerode-docker-helper.ts:302](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L302) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[dockerode-docker-helper.ts:383](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L383) +[dockerode-docker-helper.ts:395](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L395) ___ @@ -110,6 +110,7 @@ Creates container based on provided parameters. | `containerCfg.command?` | `string`[] | - | | `containerCfg.dockerImage` | `string` | - | | `containerCfg.envs` | `string`[] | - | +| `containerCfg.gpu?` | `boolean` | - | | `containerCfg.labels` | `Object` | - | | `containerCfg.maxMem` | `number` | - | | `containerCfg.networkMode?` | `string` | - | @@ -153,7 +154,7 @@ ___ #### Defined in -[dockerode-docker-helper.ts:387](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L387) +[dockerode-docker-helper.ts:399](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L399) ___ @@ -181,7 +182,7 @@ IDockerHelper.createVolume #### Defined in -[dockerode-docker-helper.ts:255](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L255) +[dockerode-docker-helper.ts:266](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L266) ___ @@ -205,7 +206,7 @@ ___ #### Defined in -[dockerode-docker-helper.ts:369](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L369) +[dockerode-docker-helper.ts:381](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L381) ___ @@ -219,7 +220,7 @@ ___ #### Defined in -[dockerode-docker-helper.ts:395](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L395) +[dockerode-docker-helper.ts:407](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L407) ___ @@ -239,7 +240,7 @@ ___ #### Defined in -[dockerode-docker-helper.ts:191](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L191) +[dockerode-docker-helper.ts:202](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L202) ___ @@ -257,7 +258,7 @@ ___ #### Defined in -[dockerode-docker-helper.ts:364](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L364) +[dockerode-docker-helper.ts:376](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L376) ___ @@ -279,7 +280,7 @@ IDockerHelper.listVolumes #### Defined in -[dockerode-docker-helper.ts:276](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L276) +[dockerode-docker-helper.ts:287](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L287) ___ @@ -306,7 +307,7 @@ Fetches the image from repo #### Defined in -[dockerode-docker-helper.ts:197](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L197) +[dockerode-docker-helper.ts:208](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L208) ___ @@ -334,7 +335,7 @@ IDockerHelper.removeContainer #### Defined in -[dockerode-docker-helper.ts:177](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L177) +[dockerode-docker-helper.ts:188](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L188) ___ @@ -362,7 +363,7 @@ IDockerHelper.removeVolume #### Defined in -[dockerode-docker-helper.ts:272](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L272) +[dockerode-docker-helper.ts:283](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L283) ___ @@ -390,7 +391,7 @@ IDockerHelper.run #### Defined in -[dockerode-docker-helper.ts:301](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L301) +[dockerode-docker-helper.ts:312](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L312) ___ @@ -418,7 +419,7 @@ IDockerHelper.startContainer #### Defined in -[dockerode-docker-helper.ts:148](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L148) +[dockerode-docker-helper.ts:159](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L159) ___ @@ -446,7 +447,7 @@ IDockerHelper.stats #### Defined in -[dockerode-docker-helper.ts:187](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L187) +[dockerode-docker-helper.ts:198](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L198) ___ @@ -474,7 +475,7 @@ IDockerHelper.stopContainer #### Defined in -[dockerode-docker-helper.ts:158](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L158) +[dockerode-docker-helper.ts:169](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L169) ___ @@ -533,7 +534,7 @@ Container exit code. #### Defined in -[dockerode-docker-helper.ts:358](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L358) +[dockerode-docker-helper.ts:370](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L370) ## Constructors @@ -577,4 +578,4 @@ ___ #### Defined in -[dockerode-docker-helper.ts:195](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L195) +[dockerode-docker-helper.ts:206](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/dockerode-docker-helper.ts#L206) diff --git a/docs/adapters/classes/KubernetesInstanceAdapter.md b/docs/adapters/classes/KubernetesInstanceAdapter.md index 65edac248..3aa8d8974 100644 --- a/docs/adapters/classes/KubernetesInstanceAdapter.md +++ b/docs/adapters/classes/KubernetesInstanceAdapter.md @@ -20,6 +20,7 @@ Adapter for running Instance by Runner executed in separate process. - [adapterConfig](KubernetesInstanceAdapter.md#adapterconfig) - [logger](KubernetesInstanceAdapter.md#logger) - [name](KubernetesInstanceAdapter.md#name) +- [sthConfig](KubernetesInstanceAdapter.md#sthconfig) ### Methods @@ -50,7 +51,7 @@ Adapter for running Instance by Runner executed in separate process. #### Defined in -[kubernetes-instance-adapter.ts:35](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L35) +[kubernetes-instance-adapter.ts:36](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L36) ___ @@ -60,7 +61,7 @@ ___ #### Defined in -[kubernetes-instance-adapter.ts:38](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L38) +[kubernetes-instance-adapter.ts:39](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L39) ___ @@ -70,7 +71,7 @@ ___ #### Defined in -[kubernetes-instance-adapter.ts:34](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L34) +[kubernetes-instance-adapter.ts:35](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L35) ___ @@ -80,7 +81,7 @@ ___ #### Defined in -[kubernetes-instance-adapter.ts:37](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L37) +[kubernetes-instance-adapter.ts:38](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L38) ___ @@ -106,6 +107,16 @@ ___ [kubernetes-instance-adapter.ts:32](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L32) +___ + +### sthConfig + +• `Private` **sthConfig**: `STHConfiguration` + +#### Defined in + +[kubernetes-instance-adapter.ts:34](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L34) + ## Methods ### cleanup @@ -122,7 +133,7 @@ ILifeCycleAdapterMain.cleanup #### Defined in -[kubernetes-instance-adapter.ts:182](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L182) +[kubernetes-instance-adapter.ts:187](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L187) ___ @@ -140,7 +151,7 @@ ILifeCycleAdapterMain.getCrashLog #### Defined in -[kubernetes-instance-adapter.ts:207](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L207) +[kubernetes-instance-adapter.ts:212](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L212) ___ @@ -158,7 +169,7 @@ ILifeCycleAdapterMain.init #### Defined in -[kubernetes-instance-adapter.ts:64](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L64) +[kubernetes-instance-adapter.ts:67](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L67) ___ @@ -182,7 +193,7 @@ ILifeCycleAdapterRun.monitorRate #### Defined in -[kubernetes-instance-adapter.ts:187](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L187) +[kubernetes-instance-adapter.ts:192](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L192) ___ @@ -206,7 +217,7 @@ ILifeCycleAdapterMain.remove #### Defined in -[kubernetes-instance-adapter.ts:196](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L196) +[kubernetes-instance-adapter.ts:201](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L201) ___ @@ -232,7 +243,7 @@ ILifeCycleAdapterRun.run #### Defined in -[kubernetes-instance-adapter.ts:91](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L91) +[kubernetes-instance-adapter.ts:94](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L94) ___ @@ -256,7 +267,7 @@ ILifeCycleAdapterRun.stats #### Defined in -[kubernetes-instance-adapter.ts:71](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L71) +[kubernetes-instance-adapter.ts:74](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L74) ___ @@ -276,7 +287,7 @@ ___ #### Defined in -[kubernetes-instance-adapter.ts:191](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L191) +[kubernetes-instance-adapter.ts:196](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L196) ## Constructors @@ -292,7 +303,7 @@ ___ #### Defined in -[kubernetes-instance-adapter.ts:43](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L43) +[kubernetes-instance-adapter.ts:44](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L44) ## Accessors @@ -306,7 +317,7 @@ ___ #### Defined in -[kubernetes-instance-adapter.ts:56](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L56) +[kubernetes-instance-adapter.ts:59](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L59) ___ @@ -324,7 +335,7 @@ ILifeCycleAdapterRun.limits #### Defined in -[kubernetes-instance-adapter.ts:40](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L40) +[kubernetes-instance-adapter.ts:41](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L41) • `set` **limits**(`value`): `void` @@ -344,7 +355,7 @@ ILifeCycleAdapterRun.limits #### Defined in -[kubernetes-instance-adapter.ts:41](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L41) +[kubernetes-instance-adapter.ts:42](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L42) ___ @@ -367,4 +378,4 @@ ___ #### Defined in -[kubernetes-instance-adapter.ts:78](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L78) +[kubernetes-instance-adapter.ts:81](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-instance-adapter.ts#L81) diff --git a/docs/adapters/classes/ProcessInstanceAdapter.md b/docs/adapters/classes/ProcessInstanceAdapter.md index e826d05fe..5ec01411a 100644 --- a/docs/adapters/classes/ProcessInstanceAdapter.md +++ b/docs/adapters/classes/ProcessInstanceAdapter.md @@ -113,7 +113,7 @@ ILifeCycleAdapterMain.cleanup #### Defined in -[process-instance-adapter.ts:177](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/process-instance-adapter.ts#L177) +[process-instance-adapter.ts:178](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/process-instance-adapter.ts#L178) ___ @@ -131,7 +131,7 @@ ILifeCycleAdapterMain.getCrashLog #### Defined in -[process-instance-adapter.ts:193](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/process-instance-adapter.ts#L193) +[process-instance-adapter.ts:194](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/process-instance-adapter.ts#L194) ___ @@ -213,7 +213,7 @@ ILifeCycleAdapterRun.monitorRate #### Defined in -[process-instance-adapter.ts:182](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/process-instance-adapter.ts#L182) +[process-instance-adapter.ts:183](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/process-instance-adapter.ts#L183) ___ @@ -233,7 +233,7 @@ ILifeCycleAdapterMain.remove #### Defined in -[process-instance-adapter.ts:189](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/process-instance-adapter.ts#L189) +[process-instance-adapter.ts:190](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/process-instance-adapter.ts#L190) ___ diff --git a/docs/adapters/interfaces/IDockerHelper.md b/docs/adapters/interfaces/IDockerHelper.md index ccec094cc..736e7f559 100644 --- a/docs/adapters/interfaces/IDockerHelper.md +++ b/docs/adapters/interfaces/IDockerHelper.md @@ -50,7 +50,7 @@ #### Defined in -[types.ts:301](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L301) +[types.ts:304](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L304) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[types.ts:303](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L303) +[types.ts:306](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L306) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[types.ts:299](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L299) +[types.ts:302](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L302) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[types.ts:297](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L297) +[types.ts:300](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L300) ___ @@ -127,7 +127,7 @@ Fetches the image from repo #### Defined in -[types.ts:295](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L295) +[types.ts:298](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L298) ___ @@ -150,13 +150,13 @@ Waits until container exits #### Defined in -[types.ts:287](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L287) +[types.ts:290](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L290) ## Properties ### createContainer -• **createContainer**: (`containerCfg`: { `autoRemove`: `boolean` ; `binds`: `string`[] ; `dockerImage`: `string` ; `envs`: `string`[] ; `labels`: { `[key: string]`: `string`; } ; `maxMem`: `number` ; `networkMode?`: `string` ; `ports`: `any` ; `publishAllPorts`: `boolean` ; `volumes`: [`DockerAdapterVolumeConfig`](../modules.md#dockeradaptervolumeconfig)[] }) => `Promise`<`string`\> +• **createContainer**: (`containerCfg`: { `autoRemove`: `boolean` ; `binds`: `string`[] ; `dockerImage`: `string` ; `envs`: `string`[] ; `gpu`: `boolean` ; `labels`: { `[key: string]`: `string`; } ; `maxMem`: `number` ; `networkMode?`: `string` ; `ports`: `any` ; `publishAllPorts`: `boolean` ; `volumes`: [`DockerAdapterVolumeConfig`](../modules.md#dockeradaptervolumeconfig)[] }) => `Promise`<`string`\> #### Type declaration @@ -173,6 +173,7 @@ Creates Docker container from provided image with attached volumes and local dir | `containerCfg.binds` | `string`[] | | `containerCfg.dockerImage` | `string` | | `containerCfg.envs` | `string`[] | +| `containerCfg.gpu` | `boolean` | | `containerCfg.labels` | `Object` | | `containerCfg.maxMem` | `number` | | `containerCfg.networkMode?` | `string` | @@ -188,7 +189,7 @@ Created container. #### Defined in -[types.ts:201](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L201) +[types.ts:203](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L203) ___ @@ -216,7 +217,7 @@ Created volume. #### Defined in -[types.ts:260](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L260) +[types.ts:263](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L263) ___ @@ -238,7 +239,7 @@ List of existing volumes #### Defined in -[types.ts:251](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L251) +[types.ts:254](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L254) ___ @@ -248,7 +249,7 @@ ___ #### Defined in -[types.ts:179](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L179) +[types.ts:181](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L181) ___ @@ -274,7 +275,7 @@ Removes container. #### Defined in -[types.ts:244](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L244) +[types.ts:247](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L247) ___ @@ -300,7 +301,7 @@ Removes volume. #### Defined in -[types.ts:269](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L269) +[types.ts:272](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L272) ___ @@ -326,7 +327,7 @@ Executes command in container. #### Defined in -[types.ts:278](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L278) +[types.ts:281](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L281) ___ @@ -352,7 +353,7 @@ Starts container. #### Defined in -[types.ts:225](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L225) +[types.ts:228](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L228) ___ @@ -376,7 +377,7 @@ ___ #### Defined in -[types.ts:236](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L236) +[types.ts:239](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L239) ___ @@ -402,7 +403,7 @@ Stops container. #### Defined in -[types.ts:234](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L234) +[types.ts:237](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L237) ___ @@ -430,4 +431,4 @@ DockerHelper volume configuration. #### Defined in -[types.ts:188](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L188) +[types.ts:190](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L190) diff --git a/docs/adapters/modules.md b/docs/adapters/modules.md index 1bec42d72..d5707d3e9 100644 --- a/docs/adapters/modules.md +++ b/docs/adapters/modules.md @@ -67,7 +67,7 @@ #### Defined in -[types.ts:147](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L147) +[types.ts:149](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L149) ___ @@ -85,6 +85,7 @@ Configuration used to run command in container. | `binds?` | `string`[] | **`Property`** Directories mount configuration. | | `command?` | `string`[] | Command with optional parameters. **`Property`** Command to be executed. | | `envs?` | `string`[] | **`Property`** A list of environment variables to set inside the container in the form ```["VAR=value", ...]``` | +| `gpu?` | `boolean` | - | | `imageName` | `string` | **`Property`** Image name. | | `labels?` | { `[key: string]`: `string`; } | - | | `maxMem?` | `number` | **`Property`** Container memory limit (bytes). | @@ -132,7 +133,7 @@ Result of running command in container. #### Defined in -[types.ts:161](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L161) +[types.ts:163](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L163) ___ @@ -152,7 +153,7 @@ Standard streams connected with container. #### Defined in -[types.ts:126](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L126) +[types.ts:128](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L128) ___ @@ -180,7 +181,7 @@ ___ #### Defined in -[types.ts:154](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L154) +[types.ts:156](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L156) ___ @@ -266,7 +267,7 @@ ___ #### Defined in -[types.ts:143](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L143) +[types.ts:145](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L145) ___ @@ -282,7 +283,7 @@ ___ #### Defined in -[types.ts:306](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L306) +[types.ts:309](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L309) ___ @@ -303,7 +304,7 @@ ___ #### Defined in -[types.ts:310](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L310) +[types.ts:313](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L313) ___ @@ -313,7 +314,7 @@ ___ #### Defined in -[types.ts:319](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L319) +[types.ts:322](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/types.ts#L322) ## Variables diff --git a/docs/api-client/classes/HostClient.md b/docs/api-client/classes/HostClient.md index 58337a84c..d5c24668e 100644 --- a/docs/api-client/classes/HostClient.md +++ b/docs/api-client/classes/HostClient.md @@ -155,13 +155,13 @@ Topics are a part of Service Discovery feature enabling data exchange through To ##### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `topic` | `string` | Topic name. | -| `stream` | `string` \| `Readable` | Stream to be piped to topic. | -| `requestInit?` | `RequestInit` | RequestInit object to be passed to fetch. | -| `contentType?` | `string` | Content type to be set in headers. | -| `end?` | `boolean` | Indicates if "end" event from stream should be passed to topic. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `topic` | `string` | `undefined` | Topic name. | +| `stream` | `string` \| `Readable` | `undefined` | Stream to be piped to topic. | +| `requestInit?` | `RequestInit` | `undefined` | RequestInit object to be passed to fetch. | +| `contentType?` | `string` | `"application/x-ndjson"` | Content type to be set in headers. | +| `end?` | `boolean` | `undefined` | Indicates if "end" event from stream should be passed to topic. | ##### Returns @@ -628,13 +628,13 @@ Topics are a part of Service Discovery feature enabling data exchange through To #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `topic` | `string` | Topic name. | -| `stream` | `string` \| `Readable` | Stream to be piped to topic. | -| `requestInit?` | `RequestInit` | RequestInit object to be passed to fetch. | -| `contentType?` | `string` | Content type to be set in headers. | -| `end?` | `boolean` | Indicates if "end" event from stream should be passed to topic. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `topic` | `string` | `undefined` | Topic name. | +| `stream` | `string` \| `Readable` | `undefined` | Stream to be piped to topic. | +| `requestInit?` | `RequestInit` | `undefined` | RequestInit object to be passed to fetch. | +| `contentType?` | `string` | `"application/x-ndjson"` | Content type to be set in headers. | +| `end?` | `boolean` | `undefined` | Indicates if "end" event from stream should be passed to topic. | #### Returns diff --git a/docs/cli/commands-description.md b/docs/cli/commands-description.md index 18660da70..c3125b073 100644 --- a/docs/cli/commands-description.md +++ b/docs/cli/commands-description.md @@ -631,7 +631,8 @@ 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** @@ -677,11 +678,13 @@ Start the Sequence with or without given arguments **Options** -* -f, --config-file Path to configuration file in JSON format to be passed to the Instance context +* -f, --config-file Path to configuration file in JSON or YAML format to be passed to the Instance context * -s, --config-string Configuration in JSON format to be passed to the Instance context +* --inst-id Start Sequence with a custom Instance Id. Should consist of 36 characters * --output-topic Topic to which the output stream should be routed * --input-topic Topic to which the input stream should be routed * --args Arguments to be passed to the first function in the Sequence +* --startup-config Path to startup config (JSON or YAML) * --limits Instance limits * -h, --help Display help for command @@ -700,9 +703,14 @@ Pack (if needed), send and start the Sequence **Options** * -o, --output Output path - defaults to dirname -* -f, --config-file Path to configuration file in JSON format to be passed to the Instance context +* -f, --config-file Path to configuration file in JSON or YAML format to be passed to the Instance context * -s, --config-string Configuration in JSON format to be passed to the Instance context +* --inst-id Start Sequence with a custom Instance Id. Should consist of 36 characters +* --output-topic Topic to which the output stream should be routed +* --input-topic Topic to which the input stream should be routed * --args Arguments to be passed to the first function in the Sequence +* --startup-config Path to startup config (JSON or YAML) +* --limits Instance limits * -h, --help Display help for command --- @@ -937,7 +945,8 @@ 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 --- @@ -960,7 +969,8 @@ 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 --- @@ -1155,8 +1165,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 --- @@ -1189,8 +1199,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 --- @@ -1207,8 +1217,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 --- diff --git a/docs/host/classes/CSIController.md b/docs/host/classes/CSIController.md index 8d386161b..af3949a60 100644 --- a/docs/host/classes/CSIController.md +++ b/docs/host/classes/CSIController.md @@ -473,7 +473,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:408](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L408) +[packages/host/src/lib/csi-controller.ts:409](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L409) ___ @@ -487,7 +487,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:569](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L569) +[packages/host/src/lib/csi-controller.ts:570](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L570) ___ @@ -550,7 +550,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:416](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L416) +[packages/host/src/lib/csi-controller.ts:417](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L417) ___ @@ -564,7 +564,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:781](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L781) +[packages/host/src/lib/csi-controller.ts:782](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L782) ___ @@ -578,7 +578,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:807](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L807) +[packages/host/src/lib/csi-controller.ts:808](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L808) ___ @@ -592,7 +592,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:811](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L811) +[packages/host/src/lib/csi-controller.ts:812](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L812) ___ @@ -624,7 +624,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:803](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L803) +[packages/host/src/lib/csi-controller.ts:804](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L804) ___ @@ -644,7 +644,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:526](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L526) +[packages/host/src/lib/csi-controller.ts:527](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L527) ___ @@ -664,7 +664,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:551](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L551) +[packages/host/src/lib/csi-controller.ts:552](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L552) ___ @@ -684,7 +684,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:862](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L862) +[packages/host/src/lib/csi-controller.ts:863](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L863) ___ @@ -704,7 +704,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:816](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L816) +[packages/host/src/lib/csi-controller.ts:817](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L817) ___ @@ -724,7 +724,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:835](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L835) +[packages/host/src/lib/csi-controller.ts:836](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L836) ___ @@ -738,7 +738,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:333](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L333) +[packages/host/src/lib/csi-controller.ts:334](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L334) ___ @@ -758,7 +758,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:447](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L447) +[packages/host/src/lib/csi-controller.ts:448](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L448) ___ @@ -772,7 +772,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:439](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L439) +[packages/host/src/lib/csi-controller.ts:440](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L440) ___ @@ -793,7 +793,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:759](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L759) +[packages/host/src/lib/csi-controller.ts:760](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L760) ___ @@ -867,7 +867,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:235](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L235) +[packages/host/src/lib/csi-controller.ts:236](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L236) ___ @@ -1134,7 +1134,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:870](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L870) +[packages/host/src/lib/csi-controller.ts:871](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L871) ___ @@ -1172,7 +1172,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:213](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L213) +[packages/host/src/lib/csi-controller.ts:214](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L214) ___ @@ -1186,7 +1186,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:272](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L272) +[packages/host/src/lib/csi-controller.ts:273](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L273) ## Constructors @@ -1270,7 +1270,7 @@ ___ #### Defined in -[packages/host/src/lib/csi-controller.ts:414](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L414) +[packages/host/src/lib/csi-controller.ts:415](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/csi-controller.ts#L415) ___ diff --git a/docs/host/classes/Host.md b/docs/host/classes/Host.md index 43ad39695..b9f592ffb 100644 --- a/docs/host/classes/Host.md +++ b/docs/host/classes/Host.md @@ -397,7 +397,7 @@ Setting up handlers for general Host API endpoints: #### Defined in -[packages/host/src/lib/host.ts:497](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L497) +[packages/host/src/lib/host.ts:499](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L499) ___ @@ -413,7 +413,7 @@ Stops running servers. #### Defined in -[packages/host/src/lib/host.ts:1215](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1215) +[packages/host/src/lib/host.ts:1229](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1229) ___ @@ -429,7 +429,7 @@ Initializes connector and connects to Manager. #### Defined in -[packages/host/src/lib/host.ts:469](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L469) +[packages/host/src/lib/host.ts:471](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L471) ___ @@ -449,7 +449,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:877](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L877) +[packages/host/src/lib/host.ts:879](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L879) ___ @@ -463,7 +463,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:280](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L280) +[packages/host/src/lib/host.ts:282](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L282) ___ @@ -481,7 +481,7 @@ List of Instances. #### Defined in -[packages/host/src/lib/host.ts:1118](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1118) +[packages/host/src/lib/host.ts:1132](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1132) ___ @@ -505,7 +505,7 @@ Sequence info object. #### Defined in -[packages/host/src/lib/host.ts:1130](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1130) +[packages/host/src/lib/host.ts:1144](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1144) ___ @@ -529,7 +529,7 @@ List of Instances. #### Defined in -[packages/host/src/lib/host.ts:1167](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1167) +[packages/host/src/lib/host.ts:1181](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1181) ___ @@ -547,7 +547,7 @@ List of Sequences. #### Defined in -[packages/host/src/lib/host.ts:1155](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1155) +[packages/host/src/lib/host.ts:1169](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1169) ___ @@ -565,7 +565,7 @@ Size #### Defined in -[packages/host/src/lib/host.ts:1281](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1281) +[packages/host/src/lib/host.ts:1295](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1295) ___ @@ -579,7 +579,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:1186](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1186) +[packages/host/src/lib/host.ts:1200](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1200) ___ @@ -593,7 +593,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:1180](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1180) +[packages/host/src/lib/host.ts:1194](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1194) ___ @@ -614,7 +614,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:715](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L715) +[packages/host/src/lib/host.ts:717](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L717) ___ @@ -641,7 +641,7 @@ Promise resolving to operation result object. #### Defined in -[packages/host/src/lib/host.ts:628](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L628) +[packages/host/src/lib/host.ts:630](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L630) ___ @@ -662,7 +662,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:759](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L759) +[packages/host/src/lib/host.ts:761](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L761) ___ @@ -689,7 +689,7 @@ Promise resolving to operation result. #### Defined in -[packages/host/src/lib/host.ts:857](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L857) +[packages/host/src/lib/host.ts:859](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L859) ___ @@ -709,7 +709,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:829](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L829) +[packages/host/src/lib/host.ts:831](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L831) ___ @@ -737,7 +737,7 @@ Promise resolving to operation result object. #### Defined in -[packages/host/src/lib/host.ts:918](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L918) +[packages/host/src/lib/host.ts:920](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L920) ___ @@ -751,7 +751,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:694](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L694) +[packages/host/src/lib/host.ts:696](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L696) ___ @@ -768,7 +768,7 @@ Used to recover Sequences information after restart. #### Defined in -[packages/host/src/lib/host.ts:733](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L733) +[packages/host/src/lib/host.ts:735](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L735) ___ @@ -798,7 +798,7 @@ Instance middleware. #### Defined in -[packages/host/src/lib/host.ts:565](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L565) +[packages/host/src/lib/host.ts:567](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L567) ___ @@ -818,7 +818,7 @@ Promise resolving to Instance of Host. #### Defined in -[packages/host/src/lib/host.ts:327](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L327) +[packages/host/src/lib/host.ts:329](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L329) ___ @@ -832,7 +832,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:416](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L416) +[packages/host/src/lib/host.ts:418](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L418) ___ @@ -854,7 +854,7 @@ ___ #### Defined in -[packages/host/src/lib/host.ts:1288](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1288) +[packages/host/src/lib/host.ts:1302](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1302) ___ @@ -872,7 +872,7 @@ Configuration object. #### Defined in -[packages/host/src/lib/host.ts:298](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L298) +[packages/host/src/lib/host.ts:300](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L300) ___ @@ -888,7 +888,7 @@ Sets up telemetry. #### Defined in -[packages/host/src/lib/host.ts:1255](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1255) +[packages/host/src/lib/host.ts:1269](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1269) ___ @@ -912,7 +912,7 @@ Forward request to Manager the Host is connected to. #### Defined in -[packages/host/src/lib/host.ts:597](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L597) +[packages/host/src/lib/host.ts:599](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L599) ___ @@ -935,7 +935,7 @@ Creates new CSIController [CSIController](CSIController.md) object and handles i #### Defined in -[packages/host/src/lib/host.ts:1004](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1004) +[packages/host/src/lib/host.ts:1006](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1006) ___ @@ -952,7 +952,7 @@ using its CSIController [CSIController](CSIController.md) #### Defined in -[packages/host/src/lib/host.ts:1198](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1198) +[packages/host/src/lib/host.ts:1212](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/host/src/lib/host.ts#L1212) ## Constructors diff --git a/docs/obj-logger/classes/ObjLogger.md b/docs/obj-logger/classes/ObjLogger.md index ec4c80f1b..9efe02d4b 100644 --- a/docs/obj-logger/classes/ObjLogger.md +++ b/docs/obj-logger/classes/ObjLogger.md @@ -223,7 +223,7 @@ Logging levels hierarchy. #### Defined in -[obj-logger/src/obj-logger.ts:183](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L183) +[obj-logger/src/obj-logger.ts:193](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L193) ## Methods @@ -247,7 +247,7 @@ IObjectLogger.addObjectLoggerSource #### Defined in -[obj-logger/src/obj-logger.ts:199](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L199) +[obj-logger/src/obj-logger.ts:209](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L209) ___ @@ -271,7 +271,7 @@ IObjectLogger.addOutput #### Defined in -[obj-logger/src/obj-logger.ts:149](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L149) +[obj-logger/src/obj-logger.ts:159](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L159) ___ @@ -295,7 +295,7 @@ IObjectLogger.addSerializedLoggerSource #### Defined in -[obj-logger/src/obj-logger.ts:206](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L206) +[obj-logger/src/obj-logger.ts:216](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L216) ___ @@ -320,7 +320,7 @@ IObjectLogger.debug #### Defined in -[obj-logger/src/obj-logger.ts:165](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L165) +[obj-logger/src/obj-logger.ts:175](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L175) ___ @@ -338,7 +338,7 @@ IObjectLogger.end #### Defined in -[obj-logger/src/obj-logger.ts:271](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L271) +[obj-logger/src/obj-logger.ts:281](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L281) ___ @@ -363,7 +363,7 @@ IObjectLogger.error #### Defined in -[obj-logger/src/obj-logger.ts:161](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L161) +[obj-logger/src/obj-logger.ts:171](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L171) ___ @@ -388,7 +388,7 @@ IObjectLogger.fatal #### Defined in -[obj-logger/src/obj-logger.ts:169](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L169) +[obj-logger/src/obj-logger.ts:179](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L179) ___ @@ -413,7 +413,7 @@ IObjectLogger.info #### Defined in -[obj-logger/src/obj-logger.ts:157](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L157) +[obj-logger/src/obj-logger.ts:167](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L167) ___ @@ -445,7 +445,7 @@ IObjectLogger.pipe #### Defined in -[obj-logger/src/obj-logger.ts:221](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L221) +[obj-logger/src/obj-logger.ts:231](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L231) ___ @@ -470,7 +470,7 @@ IObjectLogger.trace #### Defined in -[obj-logger/src/obj-logger.ts:153](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L153) +[obj-logger/src/obj-logger.ts:163](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L163) ___ @@ -504,7 +504,7 @@ IObjectLogger.unpipe #### Defined in -[obj-logger/src/obj-logger.ts:249](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L249) +[obj-logger/src/obj-logger.ts:259](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L259) ___ @@ -528,7 +528,7 @@ IObjectLogger.updateBaseLog #### Defined in -[obj-logger/src/obj-logger.ts:177](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L177) +[obj-logger/src/obj-logger.ts:187](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L187) ___ @@ -553,7 +553,7 @@ IObjectLogger.warn #### Defined in -[obj-logger/src/obj-logger.ts:173](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L173) +[obj-logger/src/obj-logger.ts:183](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/obj-logger/src/obj-logger.ts#L183) ___ diff --git a/docs/runner/classes/Runner.md b/docs/runner/classes/Runner.md index 962d8bf2f..3ce471137 100644 --- a/docs/runner/classes/Runner.md +++ b/docs/runner/classes/Runner.md @@ -66,7 +66,7 @@ reacts to control messages such as stopping etc. #### Defined in -[runner.ts:250](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L250) +[runner.ts:251](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L251) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[runner.ts:376](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L376) +[runner.ts:377](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L377) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[runner.ts:161](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L161) +[runner.ts:162](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L162) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[runner.ts:187](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L187) +[runner.ts:188](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L188) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[runner.ts:469](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L469) +[runner.ts:470](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L470) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[runner.ts:236](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L236) +[runner.ts:237](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L237) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[runner.ts:210](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L210) +[runner.ts:211](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L211) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[runner.ts:617](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L617) +[runner.ts:618](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L618) ___ @@ -199,7 +199,7 @@ set up streams process.stdin, process.stdout, process.stderr, fifo downstream, f #### Defined in -[runner.ts:422](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L422) +[runner.ts:423](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L423) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -[runner.ts:288](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L288) +[runner.ts:289](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L289) ___ @@ -234,7 +234,7 @@ ___ #### Defined in -[runner.ts:487](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L487) +[runner.ts:488](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L488) ___ @@ -248,7 +248,7 @@ ___ #### Defined in -[runner.ts:457](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L457) +[runner.ts:458](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L458) ___ @@ -268,7 +268,7 @@ ___ #### Defined in -[runner.ts:197](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L197) +[runner.ts:198](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L198) ___ @@ -282,7 +282,7 @@ ___ #### Defined in -[runner.ts:463](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L463) +[runner.ts:464](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L464) ## Constructors @@ -320,7 +320,7 @@ ___ #### Defined in -[runner.ts:151](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L151) +[runner.ts:152](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/runner/src/runner.ts#L152) ## Properties diff --git a/docs/types/classes/HostClient.md b/docs/types/classes/HostClient.md index 23ea33c98..2224dc586 100644 --- a/docs/types/classes/HostClient.md +++ b/docs/types/classes/HostClient.md @@ -15,7 +15,9 @@ ### Methods +- [createTopic](HostClient.md#createtopic) - [deleteSequence](HostClient.md#deletesequence) +- [deleteTopic](HostClient.md#deletetopic) - [getAuditStream](HostClient.md#getauditstream) - [getConfig](HostClient.md#getconfig) - [getInstanceClient](HostClient.md#getinstanceclient) @@ -25,7 +27,9 @@ - [getNamedData](HostClient.md#getnameddata) - [getSequence](HostClient.md#getsequence) - [getSequenceClient](HostClient.md#getsequenceclient) +- [getSequenceId](HostClient.md#getsequenceid) - [getStatus](HostClient.md#getstatus) +- [getTopic](HostClient.md#gettopic) - [getTopics](HostClient.md#gettopics) - [getVersion](HostClient.md#getversion) - [listEntities](HostClient.md#listentities) @@ -33,6 +37,7 @@ - [listSequences](HostClient.md#listsequences) - [sendNamedData](HostClient.md#sendnameddata) - [sendSequence](HostClient.md#sendsequence) +- [sendTopic](HostClient.md#sendtopic) ## Properties @@ -73,6 +78,27 @@ ___ ## Methods +### createTopic + +▸ **createTopic**(`topic`, `contentType`): `Promise`<{ `topicName`: `string` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `topic` | `string` | +| `contentType` | `string` | + +#### Returns + +`Promise`<{ `topicName`: `string` }\> + +#### Defined in + +[packages/types/src/api-client/host-client.ts:73](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L73) + +___ + ### deleteSequence ▸ **deleteSequence**(`sequenceId`, `opts?`): `Promise`<[`DeleteSequenceResponse`](../modules/STHRestAPI.md#deletesequenceresponse)\> @@ -91,7 +117,27 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:62](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L62) +[packages/types/src/api-client/host-client.ts:63](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L63) + +___ + +### deleteTopic + +▸ **deleteTopic**(`topic`): `Promise`<{ `message`: `string` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `topic` | `string` | + +#### Returns + +`Promise`<{ `message`: `string` }\> + +#### Defined in + +[packages/types/src/api-client/host-client.ts:74](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L74) ___ @@ -111,7 +157,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:58](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L58) +[packages/types/src/api-client/host-client.ts:59](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L59) ___ @@ -125,7 +171,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:67](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L67) +[packages/types/src/api-client/host-client.ts:68](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L68) ___ @@ -145,7 +191,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:71](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L71) +[packages/types/src/api-client/host-client.ts:76](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L76) ___ @@ -165,7 +211,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:63](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L63) +[packages/types/src/api-client/host-client.ts:64](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L64) ___ @@ -179,7 +225,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:64](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L64) +[packages/types/src/api-client/host-client.ts:65](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L65) ___ @@ -199,7 +245,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:59](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L59) +[packages/types/src/api-client/host-client.ts:60](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L60) ___ @@ -220,7 +266,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:69](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L69) +[packages/types/src/api-client/host-client.ts:71](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L71) ___ @@ -240,7 +286,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:61](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L61) +[packages/types/src/api-client/host-client.ts:62](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L62) ___ @@ -260,7 +306,27 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:72](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L72) +[packages/types/src/api-client/host-client.ts:77](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L77) + +___ + +### getSequenceId + +▸ **getSequenceId**(`sequenceName`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `sequenceName` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Defined in + +[packages/types/src/api-client/host-client.ts:56](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L56) ___ @@ -274,7 +340,29 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:66](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L66) +[packages/types/src/api-client/host-client.ts:67](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L67) + +___ + +### getTopic + +▸ **getTopic**(`topic`, `requestInit?`, `contentType?`): `Promise`<`Readable`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `topic` | `string` | +| `requestInit?` | `RequestInit` | +| `contentType?` | `string` | + +#### Returns + +`Promise`<`Readable`\> + +#### Defined in + +[packages/types/src/api-client/host-client.ts:72](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L72) ___ @@ -288,7 +376,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:70](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L70) +[packages/types/src/api-client/host-client.ts:75](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L75) ___ @@ -302,7 +390,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:65](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L65) +[packages/types/src/api-client/host-client.ts:66](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L66) ___ @@ -316,7 +404,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:57](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L57) +[packages/types/src/api-client/host-client.ts:58](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L58) ___ @@ -330,7 +418,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:56](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L56) +[packages/types/src/api-client/host-client.ts:57](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L57) ___ @@ -374,7 +462,7 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:68](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L68) +[packages/types/src/api-client/host-client.ts:69](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L69) ___ @@ -396,4 +484,34 @@ ___ #### Defined in -[packages/types/src/api-client/host-client.ts:60](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L60) +[packages/types/src/api-client/host-client.ts:61](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L61) + +___ + +### sendTopic + +▸ **sendTopic**<`T`\>(`topic`, `stream`, `requestInit?`, `contentType?`, `end?`): `Promise`<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `topic` | `string` | +| `stream` | `any` | +| `requestInit?` | `RequestInit` | +| `contentType?` | `string` | +| `end?` | `boolean` | + +#### Returns + +`Promise`<`T`\> + +#### Defined in + +[packages/types/src/api-client/host-client.ts:70](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-client/host-client.ts#L70) diff --git a/docs/types/interfaces/APIBase.md b/docs/types/interfaces/APIBase.md index aac14a7c4..fdb14e1a2 100644 --- a/docs/types/interfaces/APIBase.md +++ b/docs/types/interfaces/APIBase.md @@ -43,7 +43,7 @@ A method that allows to consume incoming stream from the specified path on the A #### Defined in -[packages/types/src/api-expose.ts:130](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L130) +[packages/types/src/api-expose.ts:134](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L134) ___ @@ -66,7 +66,7 @@ Allows to handle dual direction (duplex) streams. #### Defined in -[packages/types/src/api-expose.ts:138](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L138) +[packages/types/src/api-expose.ts:142](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L142) ___ @@ -96,7 +96,7 @@ Simple GET request hook for static data in monitoring stream. #### Defined in -[packages/types/src/api-expose.ts:104](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L104) +[packages/types/src/api-expose.ts:108](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L108) ▸ **get**(`path`, `msg`): `void` @@ -115,7 +115,7 @@ Alternative GET request hook with dynamic resolution #### Defined in -[packages/types/src/api-expose.ts:112](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L112) +[packages/types/src/api-expose.ts:116](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L116) ___ @@ -155,7 +155,7 @@ router.op("post", `${this.apiBase}/start`, (req) => this.handleStartRequest(req) #### Defined in -[packages/types/src/api-expose.ts:89](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L89) +[packages/types/src/api-expose.ts:93](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L93) ___ @@ -179,7 +179,7 @@ A method that allows to pass a stream to the specified path on the API server #### Defined in -[packages/types/src/api-expose.ts:121](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L121) +[packages/types/src/api-expose.ts:125](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L125) ___ @@ -202,4 +202,4 @@ Allows to register middlewares for specific paths, for all HTTP methods. #### Defined in -[packages/types/src/api-expose.ts:146](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L146) +[packages/types/src/api-expose.ts:150](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L150) diff --git a/docs/types/interfaces/APIError.md b/docs/types/interfaces/APIError.md index 4bf200ee7..c2e889a94 100644 --- a/docs/types/interfaces/APIError.md +++ b/docs/types/interfaces/APIError.md @@ -27,7 +27,7 @@ #### Defined in -[packages/types/src/api-expose.ts:71](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L71) +[packages/types/src/api-expose.ts:75](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L75) ___ @@ -39,7 +39,7 @@ Http status code to be outputted #### Defined in -[packages/types/src/api-expose.ts:63](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L63) +[packages/types/src/api-expose.ts:67](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L67) ___ @@ -51,7 +51,7 @@ The message that will be sent in reason line #### Defined in -[packages/types/src/api-expose.ts:67](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L67) +[packages/types/src/api-expose.ts:71](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L71) ___ diff --git a/docs/types/interfaces/APIExpose.md b/docs/types/interfaces/APIExpose.md index d7d032490..061aee51c 100644 --- a/docs/types/interfaces/APIExpose.md +++ b/docs/types/interfaces/APIExpose.md @@ -45,7 +45,7 @@ #### Defined in -[packages/types/src/api-expose.ts:156](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L156) +[packages/types/src/api-expose.ts:160](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L160) ___ @@ -73,7 +73,7 @@ A method that allows to consume incoming stream from the specified path on the A #### Defined in -[packages/types/src/api-expose.ts:130](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L130) +[packages/types/src/api-expose.ts:134](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L134) ___ @@ -100,7 +100,7 @@ Allows to handle dual direction (duplex) streams. #### Defined in -[packages/types/src/api-expose.ts:138](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L138) +[packages/types/src/api-expose.ts:142](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L142) ___ @@ -134,7 +134,7 @@ Simple GET request hook for static data in monitoring stream. #### Defined in -[packages/types/src/api-expose.ts:104](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L104) +[packages/types/src/api-expose.ts:108](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L108) ▸ **get**(`path`, `msg`): `void` @@ -157,7 +157,7 @@ Alternative GET request hook with dynamic resolution #### Defined in -[packages/types/src/api-expose.ts:112](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L112) +[packages/types/src/api-expose.ts:116](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L116) ___ @@ -201,7 +201,7 @@ router.op("post", `${this.apiBase}/start`, (req) => this.handleStartRequest(req) #### Defined in -[packages/types/src/api-expose.ts:89](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L89) +[packages/types/src/api-expose.ts:93](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L93) ___ @@ -229,7 +229,7 @@ A method that allows to pass a stream to the specified path on the API server #### Defined in -[packages/types/src/api-expose.ts:121](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L121) +[packages/types/src/api-expose.ts:125](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L125) ___ @@ -256,7 +256,7 @@ Allows to register middlewares for specific paths, for all HTTP methods. #### Defined in -[packages/types/src/api-expose.ts:146](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L146) +[packages/types/src/api-expose.ts:150](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L150) ## Properties @@ -266,7 +266,7 @@ Allows to register middlewares for specific paths, for all HTTP methods. #### Defined in -[packages/types/src/api-expose.ts:154](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L154) +[packages/types/src/api-expose.ts:158](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L158) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[packages/types/src/api-expose.ts:155](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L155) +[packages/types/src/api-expose.ts:159](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L159) ___ @@ -288,4 +288,4 @@ The raw HTTP server #### Defined in -[packages/types/src/api-expose.ts:153](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L153) +[packages/types/src/api-expose.ts:157](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L157) diff --git a/docs/types/interfaces/APIRoute.md b/docs/types/interfaces/APIRoute.md index e73218503..ce7395218 100644 --- a/docs/types/interfaces/APIRoute.md +++ b/docs/types/interfaces/APIRoute.md @@ -49,7 +49,7 @@ A method that allows to consume incoming stream from the specified path on the A #### Defined in -[packages/types/src/api-expose.ts:130](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L130) +[packages/types/src/api-expose.ts:134](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L134) ___ @@ -76,7 +76,7 @@ Allows to handle dual direction (duplex) streams. #### Defined in -[packages/types/src/api-expose.ts:138](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L138) +[packages/types/src/api-expose.ts:142](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L142) ___ @@ -110,7 +110,7 @@ Simple GET request hook for static data in monitoring stream. #### Defined in -[packages/types/src/api-expose.ts:104](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L104) +[packages/types/src/api-expose.ts:108](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L108) ▸ **get**(`path`, `msg`): `void` @@ -133,7 +133,7 @@ Alternative GET request hook with dynamic resolution #### Defined in -[packages/types/src/api-expose.ts:112](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L112) +[packages/types/src/api-expose.ts:116](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L116) ___ @@ -177,7 +177,7 @@ router.op("post", `${this.apiBase}/start`, (req) => this.handleStartRequest(req) #### Defined in -[packages/types/src/api-expose.ts:89](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L89) +[packages/types/src/api-expose.ts:93](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L93) ___ @@ -205,7 +205,7 @@ A method that allows to pass a stream to the specified path on the API server #### Defined in -[packages/types/src/api-expose.ts:121](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L121) +[packages/types/src/api-expose.ts:125](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L125) ___ @@ -232,7 +232,7 @@ Allows to register middlewares for specific paths, for all HTTP methods. #### Defined in -[packages/types/src/api-expose.ts:146](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L146) +[packages/types/src/api-expose.ts:150](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L150) ## Properties @@ -242,4 +242,4 @@ Allows to register middlewares for specific paths, for all HTTP methods. #### Defined in -[packages/types/src/api-expose.ts:160](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L160) +[packages/types/src/api-expose.ts:164](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L164) diff --git a/docs/types/modules.md b/docs/types/modules.md index 8b77e9aa4..819555681 100644 --- a/docs/types/modules.md +++ b/docs/types/modules.md @@ -174,6 +174,7 @@ - [SequencePackageJSONScramjetSection](modules.md#sequencepackagejsonscramjetsection) - [SequenceStoppedMessageData](modules.md#sequencestoppedmessagedata) - [StartSequenceDTO](modules.md#startsequencedto) +- [StartSequenceEndpointPayloadDTO](modules.md#startsequenceendpointpayloaddto) - [StatusMessage](modules.md#statusmessage) - [StatusMessageData](modules.md#statusmessagedata) - [StopHandler](modules.md#stophandler) @@ -584,7 +585,7 @@ ___ #### Defined in -[packages/types/src/api-expose.ts:22](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L22) +[packages/types/src/api-expose.ts:26](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L26) ___ @@ -921,7 +922,7 @@ ___ #### Defined in -[packages/types/src/api-expose.ts:16](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L16) +[packages/types/src/api-expose.ts:20](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L20) ___ @@ -1049,7 +1050,7 @@ ___ #### Defined in -[packages/types/src/api-expose.ts:10](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L10) +[packages/types/src/api-expose.ts:14](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L14) ___ @@ -1212,6 +1213,7 @@ ___ | Name | Type | | :------ | :------ | +| `gpu?` | `boolean` | | `memory?` | `number` | #### Defined in @@ -1677,7 +1679,7 @@ ___ #### Defined in -[packages/types/src/api-expose.ts:21](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L21) +[packages/types/src/api-expose.ts:25](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L25) ___ @@ -1963,7 +1965,7 @@ ___ #### Defined in -[packages/types/src/api-expose.ts:20](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L20) +[packages/types/src/api-expose.ts:24](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L24) ___ @@ -1979,7 +1981,7 @@ ___ #### Defined in -[packages/types/src/api-expose.ts:18](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L18) +[packages/types/src/api-expose.ts:22](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L22) ___ @@ -2028,7 +2030,7 @@ ___ #### Defined in -[packages/types/src/api-expose.ts:17](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L17) +[packages/types/src/api-expose.ts:21](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L21) ___ @@ -2068,7 +2070,7 @@ ___ ### ParsedMessage -Ƭ **ParsedMessage**: `IncomingMessage` & { `body?`: `any` ; `params?`: { `[key: string]`: `any`; } } +Ƭ **ParsedMessage**: `IncomingMessage` & { `body?`: `any` ; `params?`: { `[key: string]`: `any`; } ; `query?`: { `[key: string]`: `any`; } } #### Defined in @@ -2172,7 +2174,7 @@ ___ #### Defined in -[packages/types/src/sth-configuration.ts:277](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/sth-configuration.ts#L277) +[packages/types/src/sth-configuration.ts:279](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/sth-configuration.ts#L279) ___ @@ -2368,6 +2370,7 @@ ___ | `port` | `number` | | `prerunnerImage` | `string` | | `prerunnerMaxMem` | `number` | +| `runnerEnvs?` | `string` | | `runnerImage` | `string` | | `runnerMaxMem` | `number` | | `runnerPyImage` | `string` | @@ -2425,6 +2428,7 @@ ___ | `platform.apiVersion` | `string` | - | | `platform.hostType` | ``"hub"`` \| ``"federation"`` | - | | `platform.space` | `string` | - | +| `runnerEnvs?` | `Record`<`string`, `string`\> | - | | `runtimeAdapter` | `string` | Which sequence and instance adapters should STH use. One of 'docker', 'process', 'kubernetes', 'detect' | | `safeOperationLimit` | `number` | The amount of memory that must remain free. In megabytes. | | `sequencesRoot` | `string` | Only used when `noDocker` is true Where should ProcessSequenceAdapter save new Sequences | @@ -2688,6 +2692,24 @@ ___ ___ +### StartSequenceEndpointPayloadDTO + +Ƭ **StartSequenceEndpointPayloadDTO**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `appConfig?` | [`AppConfig`](modules.md#appconfig) | +| `args?` | `string`[] | +| `instanceId?` | `string` | + +#### Defined in + +[packages/types/src/dto/start-sequence.ts:10](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/dto/start-sequence.ts#L10) + +___ + ### StatusMessage Ƭ **StatusMessage**: { `msgCode`: `RunnerMessageCode.STATUS` } & [`StatusMessageData`](modules.md#statusmessagedata) @@ -2799,7 +2821,7 @@ Configuration options for streaming endpoints #### Defined in -[packages/types/src/api-expose.ts:27](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L27) +[packages/types/src/api-expose.ts:31](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L31) ___ @@ -2809,7 +2831,7 @@ ___ #### Defined in -[packages/types/src/api-expose.ts:12](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L12) +[packages/types/src/api-expose.ts:16](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L16) ___ @@ -2819,7 +2841,7 @@ ___ #### Defined in -[packages/types/src/api-expose.ts:15](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L15) +[packages/types/src/api-expose.ts:19](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/api-expose.ts#L19) ___ diff --git a/docs/utility/modules.md b/docs/utility/modules.md index cf6a89425..b83ec85a0 100644 --- a/docs/utility/modules.md +++ b/docs/utility/modules.md @@ -48,12 +48,14 @@ - [isLogLevel](modules.md#isloglevel) - [isPort](modules.md#isport) - [isStartSequenceDTO](modules.md#isstartsequencedto) +- [isStartSequenceEndpointPayloadDTO](modules.md#isstartsequenceendpointpayloaddto) - [isUrlPath](modules.md#isurlpath) - [logLevelValidator](modules.md#loglevelvalidator) - [merge](modules.md#merge) - [normalizeUrl](modules.md#normalizeurl) - [optionalValidator](modules.md#optionalvalidator) - [portValidator](modules.md#portvalidator) +- [processCommanderRunnerEnvs](modules.md#processcommanderrunnerenvs) - [promiseTimeout](modules.md#promisetimeout) - [readJsonFile](modules.md#readjsonfile) - [readStreamedJSON](modules.md#readstreamedjson) @@ -574,6 +576,26 @@ arg is StartSequenceDTO ___ +### isStartSequenceEndpointPayloadDTO + +▸ **isStartSequenceEndpointPayloadDTO**(`arg`): arg is StartSequenceEndpointPayloadDTO + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `arg` | `any` | + +#### Returns + +arg is StartSequenceEndpointPayloadDTO + +#### Defined in + +[packages/utility/src/typeguards/dto/sequence-start.ts:25](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/utility/src/typeguards/dto/sequence-start.ts#L25) + +___ + ### isUrlPath ▸ **isUrlPath**(`url`): url is string @@ -742,6 +764,26 @@ ___ ___ +### processCommanderRunnerEnvs + +▸ **processCommanderRunnerEnvs**(`envString`): `Record`<`string`, `string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `envString` | `string` | + +#### Returns + +`Record`<`string`, `string`\> + +#### Defined in + +[packages/utility/src/process-env.ts:1](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/utility/src/process-env.ts#L1) + +___ + ### promiseTimeout ▸ **promiseTimeout**<`T`\>(`promise`, `timeout`): `Promise`<`T`\> diff --git a/docs/verser/classes/VerserConnection.md b/docs/verser/classes/VerserConnection.md index 294e35c21..3c9d2279e 100644 --- a/docs/verser/classes/VerserConnection.md +++ b/docs/verser/classes/VerserConnection.md @@ -69,7 +69,7 @@ Closes the connection by sending FIN packet. #### Defined in -[packages/verser/src/lib/verser-connection.ts:243](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/verser/src/lib/verser-connection.ts#L243) +[packages/verser/src/lib/verser-connection.ts:250](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/verser/src/lib/verser-connection.ts#L250) ___ @@ -96,7 +96,7 @@ Duplex stream. #### Defined in -[packages/verser/src/lib/verser-connection.ts:196](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/verser/src/lib/verser-connection.ts#L196) +[packages/verser/src/lib/verser-connection.ts:203](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/verser/src/lib/verser-connection.ts#L203) ___ @@ -159,7 +159,7 @@ ___ #### Defined in -[packages/verser/src/lib/verser-connection.ts:250](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/verser/src/lib/verser-connection.ts#L250) +[packages/verser/src/lib/verser-connection.ts:257](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/verser/src/lib/verser-connection.ts#L257) ___ @@ -239,7 +239,7 @@ ___ #### Defined in -[packages/verser/src/lib/verser-connection.ts:202](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/verser/src/lib/verser-connection.ts#L202) +[packages/verser/src/lib/verser-connection.ts:209](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/verser/src/lib/verser-connection.ts#L209) ___ From d94b7a1936d9d8ccb16421c156e7a5d0758a2ff8 Mon Sep 17 00:00:00 2001 From: Alicja Gruzdz Date: Mon, 27 Nov 2023 13:48:52 +0000 Subject: [PATCH 2/2] v0.37.0 --- .../sequences/args-config-test/package.json | 2 +- .../sequences/args-to-output/package.json | 2 +- .../sequences/deploy-app/dist/package.json | 2 +- bdd/data/sequences/deploy-app/package.json | 2 +- .../sequences/infinite/package.json | 2 +- bdd/package.json | 12 ++++----- package.json | 2 +- packages/adapters/package.json | 20 +++++++------- packages/api-client/package.json | 10 +++---- packages/api-server/package.json | 12 ++++----- packages/cli/package.json | 14 +++++----- packages/client-utils/package.json | 14 +++++----- packages/host/package.json | 26 +++++++++---------- packages/load-check/package.json | 8 +++--- packages/logger/package.json | 4 +-- packages/manager-api-client/package.json | 8 +++--- packages/middleware-api-client/package.json | 12 ++++----- packages/model/package.json | 8 +++--- packages/module-loader/package.json | 6 ++--- packages/monitoring-server/package.json | 4 +-- .../multi-manager-api-client/package.json | 10 +++---- packages/obj-logger/package.json | 6 ++--- packages/pre-runner/package.json | 2 +- packages/python-runner/package.json | 2 +- packages/runner/package.json | 18 ++++++------- packages/sth-config/package.json | 6 ++--- packages/sth-config/src/image-config.json | 6 ++--- packages/sth/package.json | 14 +++++----- packages/symbols/package.json | 2 +- packages/telemetry/package.json | 8 +++--- packages/types/package.json | 4 +-- packages/utility/package.json | 4 +-- packages/verser/package.json | 10 +++---- 33 files changed, 131 insertions(+), 131 deletions(-) diff --git a/bdd/data/sequences/args-config-test/package.json b/bdd/data/sequences/args-config-test/package.json index 44835de96..dd137351a 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.36.1" + "@scramjet/types": "0.37.0" }, "private": true } diff --git a/bdd/data/sequences/args-to-output/package.json b/bdd/data/sequences/args-to-output/package.json index 17559d2a0..1427c78f0 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.36.1", + "@scramjet/types": "^0.37.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 977486414..3824bd8fb 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.36.1", + "@scramjet/types": "^0.37.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 977486414..3824bd8fb 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.36.1", + "@scramjet/types": "^0.37.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 e4e93264e..fb4f9355d 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.36.1" + "@scramjet/types": "^0.37.0" } } diff --git a/bdd/package.json b/bdd/package.json index 866fc5eed..a3205e9d8 100644 --- a/bdd/package.json +++ b/bdd/package.json @@ -1,13 +1,13 @@ { "name": "scramjet-bdd", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/logger": "^0.36.1", - "@scramjet/obj-logger": "^0.36.1", - "@scramjet/sth-config": "^0.36.1", + "@scramjet/api-client": "^0.37.0", + "@scramjet/logger": "^0.37.0", + "@scramjet/obj-logger": "^0.37.0", + "@scramjet/sth-config": "^0.37.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.36.1" + "@scramjet/types": "^0.37.0" }, "scripts": { "build:bdd": "tsc -p tsconfig.json", diff --git a/package.json b/package.json index 4cca35def..7cc51f6fa 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/transform-hub", - "version": "0.36.1", + "version": "0.37.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 852059d2c..e2917b6d4 100644 --- a/packages/adapters/package.json +++ b/packages/adapters/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/adapters", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/obj-logger": "^0.36.1", - "@scramjet/pre-runner": "^0.36.1", - "@scramjet/python-runner": "^0.36.1", - "@scramjet/runner": "^0.36.1", - "@scramjet/sth-config": "^0.36.1", - "@scramjet/symbols": "^0.36.1", - "@scramjet/utility": "^0.36.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", "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.36.1", + "@scramjet/types": "^0.37.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 11bc44f21..5f6c37b36 100644 --- a/packages/api-client/package.json +++ b/packages/api-client/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/api-client", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/sth-config": "^0.36.1", - "@scramjet/symbols": "^0.36.1", + "@scramjet/client-utils": "^0.37.0", + "@scramjet/sth-config": "^0.37.0", + "@scramjet/symbols": "^0.37.0", "n-readlines": "^1.0.1", "scramjet": "^4.36.9" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 15950b04a..47535e079 100644 --- a/packages/api-server/package.json +++ b/packages/api-server/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/api-server", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/obj-logger": "^0.36.1", - "@scramjet/symbols": "^0.36.1", - "@scramjet/utility": "^0.36.1", + "@scramjet/model": "^0.37.0", + "@scramjet/obj-logger": "^0.37.0", + "@scramjet/symbols": "^0.37.0", + "@scramjet/utility": "^0.37.0", "http-status-codes": "^2.2.0", "scramjet": "^4.36.9" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 3b42c1ed2..9879168ec 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/cli", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/client-utils": "^0.36.1", - "@scramjet/middleware-api-client": "^0.36.1", - "@scramjet/obj-logger": "^0.36.1", - "@scramjet/utility": "^0.36.1", + "@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", "chalk": "^4.1.2", "commander": "^9.5.0", "commander-completion": "^1.0.1", @@ -35,7 +35,7 @@ "validator": "^13.7.0" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 782e4a415..2ee55e633 100644 --- a/packages/client-utils/package.json +++ b/packages/client-utils/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/client-utils", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/obj-logger": "^0.36.1", - "@scramjet/sth-config": "^0.36.1", - "@scramjet/symbols": "^0.36.1", - "@scramjet/utility": "^0.36.1", + "@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", "@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.36.1", + "@scramjet/types": "^0.37.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 e4f96b120..d0478a91b 100644 --- a/packages/host/package.json +++ b/packages/host/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/host", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/api-server": "^0.36.1", - "@scramjet/load-check": "^0.36.1", - "@scramjet/model": "^0.36.1", - "@scramjet/module-loader": "^0.36.1", - "@scramjet/obj-logger": "^0.36.1", - "@scramjet/sth-config": "^0.36.1", - "@scramjet/symbols": "^0.36.1", - "@scramjet/telemetry": "^0.36.1", - "@scramjet/utility": "^0.36.1", - "@scramjet/verser": "^0.36.1", + "@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", "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.36.1", + "@scramjet/types": "^0.37.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 f62b20132..6f30adbcf 100644 --- a/packages/load-check/package.json +++ b/packages/load-check/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/load-check", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/utility": "^0.36.1", + "@scramjet/obj-logger": "^0.37.0", + "@scramjet/utility": "^0.37.0", "scramjet": "^4.36.9", "systeminformation": "^5.21.7", "uuid": "^8.3.2" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 0820161a1..4bb623547 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/logger", - "version": "0.36.1", + "version": "0.37.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.36.1", + "@scramjet/types": "^0.37.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 77173aa48..dc6679c19 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.36.1", + "version": "0.37.0", "description": "Scramjet Manager API Client", "main": "src/index.ts", "scripts": { @@ -12,11 +12,11 @@ "test:ava": "ava" }, "dependencies": { - "@scramjet/api-client": "^0.36.1", - "@scramjet/client-utils": "^0.36.1" + "@scramjet/api-client": "^0.37.0", + "@scramjet/client-utils": "^0.37.0" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 38f0ed861..6b31bd8a4 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.36.1", + "version": "0.37.0", "description": "Scramjet Middleware API Client", "main": "src/index.ts", "scripts": { @@ -14,13 +14,13 @@ "test:ava": "ava" }, "dependencies": { - "@scramjet/api-client": "^0.36.1", - "@scramjet/client-utils": "^0.36.1", - "@scramjet/manager-api-client": "^0.36.1", - "@scramjet/multi-manager-api-client": "^0.36.1" + "@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" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 eca2ff6b4..257396b11 100644 --- a/packages/model/package.json +++ b/packages/model/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/model", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/symbols": "^0.36.1", + "@scramjet/obj-logger": "^0.37.0", + "@scramjet/symbols": "^0.37.0", "scramjet": "^4.36.9", "uuid": "^8.3.2" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 c8de34077..a5fa5345c 100644 --- a/packages/module-loader/package.json +++ b/packages/module-loader/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/module-loader", - "version": "0.36.1", + "version": "0.37.0", "description": "Scramjet Module Loader", "main": "src/index.ts", "scripts": { @@ -12,10 +12,10 @@ "test:ava": "# nyc ava" }, "dependencies": { - "@scramjet/obj-logger": "^0.36.1" + "@scramjet/obj-logger": "^0.37.0" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 d112ef424..47a33550f 100644 --- a/packages/monitoring-server/package.json +++ b/packages/monitoring-server/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/monitoring-server", - "version": "0.36.1", + "version": "0.37.0", "description": "Scramjet Monitoring Server", "main": "src/index.ts", "scripts": { @@ -12,7 +12,7 @@ "test:ava": "# nyc ava" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 3097a738a..823e870b1 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.36.1", + "version": "0.37.0", "description": "Scramjet MultiManager API Client", "main": "src/index.ts", "scripts": { @@ -12,12 +12,12 @@ "test:ava": "ava" }, "dependencies": { - "@scramjet/api-client": "^0.36.1", - "@scramjet/client-utils": "^0.36.1", - "@scramjet/manager-api-client": "^0.36.1" + "@scramjet/api-client": "^0.37.0", + "@scramjet/client-utils": "^0.37.0", + "@scramjet/manager-api-client": "^0.37.0" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 9167c2819..6463461ab 100644 --- a/packages/obj-logger/package.json +++ b/packages/obj-logger/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/obj-logger", - "version": "0.36.1", + "version": "0.37.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.36.1", + "@scramjet/types": "^0.37.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.36.1", + "@scramjet/utility": "^0.37.0", "scramjet": "^4.36.9" }, "ava": { diff --git a/packages/pre-runner/package.json b/packages/pre-runner/package.json index 428f1774a..7b32b84dd 100644 --- a/packages/pre-runner/package.json +++ b/packages/pre-runner/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/pre-runner", - "version": "0.36.1", + "version": "0.37.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 0c90a2fc8..0153ca4b0 100644 --- a/packages/python-runner/package.json +++ b/packages/python-runner/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/python-runner", - "version": "0.36.1", + "version": "0.37.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 fba52ce0c..93328dd0e 100644 --- a/packages/runner/package.json +++ b/packages/runner/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/runner", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/client-utils": "^0.36.1", - "@scramjet/manager-api-client": "^0.36.1", - "@scramjet/model": "^0.36.1", - "@scramjet/obj-logger": "^0.36.1", - "@scramjet/symbols": "^0.36.1", - "@scramjet/utility": "^0.36.1", + "@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", "bpmux": "^8.2.1", "scramjet": "^4.36.9" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 a048f3078..2489d4587 100644 --- a/packages/sth-config/package.json +++ b/packages/sth-config/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/sth-config", - "version": "0.36.1", + "version": "0.37.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.36.1" + "@scramjet/utility": "^0.37.0" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 81e3a5379..e9f61bdd0 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.36.1", + "prerunner": "scramjetorg/pre-runner:0.37.0", "runner": { - "node": "scramjetorg/runner:0.36.1", - "python3": "scramjetorg/runner-py:0.36.1" + "node": "scramjetorg/runner:0.37.0", + "python3": "scramjetorg/runner-py:0.37.0" } } diff --git a/packages/sth/package.json b/packages/sth/package.json index 5bf2e85c6..5b9a0bbb7 100644 --- a/packages/sth/package.json +++ b/packages/sth/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/sth", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/obj-logger": "^0.36.1", - "@scramjet/sth-config": "^0.36.1", - "@scramjet/utility": "^0.36.1", + "@scramjet/host": "^0.37.0", + "@scramjet/obj-logger": "^0.37.0", + "@scramjet/sth-config": "^0.37.0", + "@scramjet/utility": "^0.37.0", "commander": "^8.3.0" }, "devDependencies": { - "@scramjet/model": "^0.36.1", - "@scramjet/types": "^0.36.1", + "@scramjet/model": "^0.37.0", + "@scramjet/types": "^0.37.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 5654f9103..c15832061 100644 --- a/packages/symbols/package.json +++ b/packages/symbols/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/symbols", - "version": "0.36.1", + "version": "0.37.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 5d93b49de..88efbb288 100644 --- a/packages/telemetry/package.json +++ b/packages/telemetry/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/telemetry", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/utility": "^0.36.1", + "@scramjet/obj-logger": "^0.37.0", + "@scramjet/utility": "^0.37.0", "winston": "^3.8.2", "winston-loki": "^6.0.6" }, "devDependencies": { - "@scramjet/types": "^0.36.1", + "@scramjet/types": "^0.37.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 655b7a591..194366198 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/types", - "version": "0.36.1", + "version": "0.37.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.36.1", + "@scramjet/symbols": "^0.37.0", "http-status-codes": "^2.2.0" }, "devDependencies": { diff --git a/packages/utility/package.json b/packages/utility/package.json index d652cc962..dfeb604ae 100644 --- a/packages/utility/package.json +++ b/packages/utility/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/utility", - "version": "0.36.1", + "version": "0.37.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.36.1", + "@scramjet/types": "^0.37.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 d14b475e6..9fc7d7086 100644 --- a/packages/verser/package.json +++ b/packages/verser/package.json @@ -1,6 +1,6 @@ { "name": "@scramjet/verser", - "version": "0.36.1", + "version": "0.37.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.36.1", - "@scramjet/utility": "^0.36.1", + "@scramjet/obj-logger": "^0.37.0", + "@scramjet/utility": "^0.37.0", "bpmux": "^8.2.1" }, "devDependencies": { - "@scramjet/api-server": "^0.36.1", - "@scramjet/types": "^0.36.1", + "@scramjet/api-server": "^0.37.0", + "@scramjet/types": "^0.37.0", "@types/node": "15.12.5", "ava": "^3.15.0", "ts-node": "^10.9.1",