Merge pull request #776 from scramjetorg/devel

Prepare v0.31.4

Author: alicja-gruzdz

docs/api-client/README.md

@@ -0,0 +1,239 @@
+[@scramjet/api-client](../README.md) / [Exports](../modules.md) / SequenceClient
+
+# Class: SequenceClient
+
+Sequence client.
+Provides methods to interact with Sequence.
+
+## Table of contents
+
+### Properties
+
+- [\_id](SequenceClient.md#_id)
+- [host](SequenceClient.md#host)
+- [sequenceURL](SequenceClient.md#sequenceurl)
+
+### Accessors
+
+- [clientUtils](SequenceClient.md#clientutils)
+- [id](SequenceClient.md#id)
+
+### Constructors
+
+- [constructor](SequenceClient.md#constructor)
+
+### Methods
+
+- [from](SequenceClient.md#from)
+- [getInfo](SequenceClient.md#getinfo)
+- [getInstance](SequenceClient.md#getinstance)
+- [listInstances](SequenceClient.md#listinstances)
+- [overwrite](SequenceClient.md#overwrite)
+- [start](SequenceClient.md#start)
+
+## Properties
+
+### \_id
+
+• `Private` **\_id**: `string`
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:12](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L12)
+
+___
+
+### host
+
+• `Private` **host**: `ClientProvider`
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:14](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L14)
+
+___
+
+### sequenceURL
+
+• `Private` **sequenceURL**: `string`
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:13](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L13)
+
+## Accessors
+
+### clientUtils
+
+• `Private` `get` **clientUtils**(): `HttpClientNode`
+
+#### Returns
+
+`HttpClientNode`
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:23](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L23)
+
+___
+
+### id
+
+• `get` **id**(): `string`
+
+Sequence id.
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:19](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L19)
+
+## Constructors
+
+### constructor
+
+• `Private` **new SequenceClient**(`id`, `host`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+| `host` | `ClientProvider` |
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:38](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L38)
+
+## Methods
+
+### from
+
+▸ `Static` **from**(`id`, `host`): [`SequenceClient`](SequenceClient.md)
+
+Creates SequenceClient instance for Sequence with given id and host.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `string` | Sequence id |
+| `host` | `ClientProvider` | Host client |
+
+#### Returns
+
+[`SequenceClient`](SequenceClient.md)
+
+Sequence client
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:34](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L34)
+
+___
+
+### getInfo
+
+▸ **getInfo**(): `Promise`<`GetSequenceResponse`\>
+
+Returns Sequence details.
+
+#### Returns
+
+`Promise`<`GetSequenceResponse`\>
+
+Promise resolving to Sequence info.
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:94](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L94)
+
+___
+
+### getInstance
+
+▸ **getInstance**(`id`, `host`): `Promise`<[`InstanceClient`](InstanceClient.md)\>
+
+Return Instance Client for given Instance id.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `string` | Instance id. |
+| `host` | `ClientProvider` | Host client. |
+
+#### Returns
+
+`Promise`<[`InstanceClient`](InstanceClient.md)\>
+
+Instance client.
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:85](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L85)
+
+___
+
+### listInstances
+
+▸ **listInstances**(): `Promise`<`string`[]\>
+
+Returns list of all Instances created from Sequence.
+
+#### Returns
+
+`Promise`<`string`[]\>
+
+Promise resolving to list of Instances.
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:74](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L74)
+
+___
+
+### overwrite
+
+▸ **overwrite**(`stream`): `Promise`<[`SequenceClient`](SequenceClient.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `stream` | `Readable` |
+
+#### Returns
+
+`Promise`<[`SequenceClient`](SequenceClient.md)\>
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:98](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L98)
+
+___
+
+### start
+
+▸ **start**(`payload`): `Promise`<[`InstanceClient`](InstanceClient.md)\>
+
+Starts Sequence.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `payload` | `StartSequencePayload` | App start configuration. |
+
+#### Returns
+
+`Promise`<[`InstanceClient`](InstanceClient.md)\>
+
+Promise resolving to Instance Client.
+
+#### Defined in
+
+[api-client/src/sequence-client.ts:54](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/sequence-client.ts#L54)

docs/api-client/classes/HostClient.md

@@ -1,64 +1,36 @@
-[@scramjet/client-utils](README.md) / Exports
+[@scramjet/api-client](README.md) / Exports
 
-# @scramjet/client-utils
+# @scramjet/api-client
 
 ## Table of contents
 
 ### Classes
 
-- [ClientError](classes/ClientError.md)
-- [ClientUtils](classes/ClientUtils.md)
+- [HostClient](classes/HostClient.md)
+- [InstanceClient](classes/InstanceClient.md)
+- [SequenceClient](classes/SequenceClient.md)
 
 ### Type Aliases
 
-- [ClientErrorCode](modules.md#clienterrorcode)
-- [RequestLogger](modules.md#requestlogger)
-- [SendStreamOptions](modules.md#sendstreamoptions)
-
-### Interfaces
-
-- [ClientProvider](interfaces/ClientProvider.md)
-- [HttpClient](interfaces/HttpClient.md)
+- [InstanceInputStream](modules.md#instanceinputstream)
+- [InstanceOutputStream](modules.md#instanceoutputstream)
 
 ## Type Aliases
 
-### ClientErrorCode
+### InstanceInputStream
 
-Ƭ **ClientErrorCode**: ``"GENERAL_ERROR"`` \| ``"BAD_PARAMETERS"`` \| ``"NEED_AUTHENTICATION"`` \| ``"NOT_AUTHORIZED"`` \| ``"NOT_FOUND"`` \| ``"GONE"`` \| ``"SERVER_ERROR"`` \| ``"REQUEST_ERROR"`` \| ``"UNKNOWN_ERROR"`` \| ``"CANNOT_CONNECT"`` \| ``"INVALID_RESPONSE"`` \| ``"INSUFFICIENT_RESOURCES"`` \| ``"UNPROCESSABLE_ENTITY"``
+Ƭ **InstanceInputStream**: ``"stdin"`` \| ``"input"``
 
 #### Defined in
 
-[packages/client-utils/src/client-error.ts:32](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/client-error.ts#L32)
+[api-client/src/instance-client.ts:5](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/instance-client.ts#L5)
 
 ___
 
-### RequestLogger
-
-Ƭ **RequestLogger**: `Object`
-
-Request logger.
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `end` | (...`req`: `any`) => `void` |
-| `error` | (`res`: [`ClientError`](classes/ClientError.md)) => `void` |
-| `ok` | (`res`: `any`) => `void` |
-| `request` | (...`req`: `any`) => `void` |
-
-#### Defined in
-
-[packages/client-utils/src/types/index.ts:22](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L22)
-
-___
-
-### SendStreamOptions
-
-Ƭ **SendStreamOptions**: `Partial`<{ `end`: `boolean` ; `parseResponse?`: ``"json"`` \| ``"text"`` \| ``"stream"`` ; `put`: `boolean` ; `type`: `string`  }\>
+### InstanceOutputStream
 
-Options for sending sending stream.
+Ƭ **InstanceOutputStream**: ``"stdout"`` \| ``"stderr"`` \| ``"output"`` \| ``"log"``
 
 #### Defined in
 
-[packages/client-utils/src/types/index.ts:7](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/client-utils/src/types/index.ts#L7)
+[api-client/src/instance-client.ts:6](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/instance-client.ts#L6)

docs/api-client/classes/InstanceClient.md

@@ -35,6 +35,15 @@ export class HostClient implements ClientProvider {
         return this.client.get<STHRestAPI.GetInstancesResponse>("instances");
     }
 
+    /**
+     * Returns list of all entities on Host.
+     *
+     * @returns {Promise<STHRestAPI.GetEntitiesResponse>} Promise resolving to list of entities.
+     */
+    async listEntities() {
+        return this.client.get<STHRestAPI.GetEntitiesResponse>("entities");
+    }
+
     /**
      * Returns Host log stream.
      *
@@ -185,4 +194,8 @@ export class HostClient implements ClientProvider {
     getSequenceClient(id: string) {
         return SequenceClient.from(id, this);
     }
+
+    getEntities(): Promise<STHRestAPI.GetEntitiesResponse> {
+        return this.client.get("entities");
+    }
 }

docs/api-client/classes/SequenceClient.md

@@ -51,7 +51,7 @@ export const sequence: CommandDefinition = (program) => {
 
     sequenceCmd
         .command("send")
-        .argument("<package>", "The file or directory to upload or '-' to use the last packed. If directory, it will be packed and send.")
+        .argument("<package>", "The file or directory to upload or '-' to use the last packed. If directory, it will be packed and sent.")
         .option("--name <name>", "Allows to name sequence")
         .description("Send the Sequence package to the Hub")
         .action(

docs/api-client/modules.md

@@ -33,7 +33,7 @@ export const store: CommandDefinition = (program) => {
 
     storeCmd
         .command("send")
-        .argument("<package>", "The file or directory to upload. If directory, it will be packed and send.")
+        .argument("<package>", "The file or directory to upload. If directory, it will be packed and sent.")
         .option("--name <name>", "Allows to name sequence")
         .description("Send the Sequence package to the Store")
         .action(async (sequencePackage: string, { name }) => {

packages/api-client/src/host-client.ts

@@ -1,5 +1,7 @@
 import { ClientError, QueryError } from "./client-error";
 import { Headers, HttpClient, RequestLogger, SendStreamOptions, RequestConfig } from "./types";
+import { Agent as HTTPAgent } from "http";
+import { Agent as HTTPSAgent } from "https";
 
 /**
  * Provides HTTP communication methods.
@@ -10,6 +12,8 @@ export abstract class ClientUtilsBase implements HttpClient {
 
     static headers: Headers = {};
 
+    public agent: HTTPAgent | HTTPSAgent = new HTTPAgent();
+
     constructor(
         public apiBase: string,
         private fetch: any,
@@ -48,7 +52,7 @@ export abstract class ClientUtilsBase implements HttpClient {
         const AbortController = globalThis.AbortController || (await import("abort-controller")).AbortController;
         const abortController = new AbortController();
 
-        const fetchInit: RequestInit = { signal: abortController.signal, ...init };
+        const fetchInit: RequestInit & { agent?: HTTPAgent } = { signal: abortController.signal, ...init };
 
         fetchInit.headers = { ...ClientUtilsBase.headers, ...fetchInit.headers };