cribl-mgmt-plane 0.0.2

package/.devcontainer/README.md

@@ -0,0 +1,30 @@
+
+> **Remember to shutdown a GitHub Codespace when it is not in use!**
+
+# Dev Containers Quick Start
+
+The default location for usage snippets is the `samples` directory.
+
+## Running a Usage Sample
+
+A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
+
+```
+ts-node root.ts
+```
+
+## Generating Additional Usage Samples
+
+The speakeasy CLI allows you to generate more usage snippets. Here's how:
+
+- To generate a sample for a specific operation by providing an operation ID, use:
+
+```
+speakeasy generate usage -s .speakeasy/out.openapi.yaml -l typescript -i {INPUT_OPERATION_ID} -o ./samples
+```
+
+- To generate samples for an entire namespace (like a tag or group name), use:
+
+```
+speakeasy generate usage -s .speakeasy/out.openapi.yaml -l typescript -n {INPUT_TAG_NAME} -o ./samples
+```

package/.devcontainer/devcontainer.json

@@ -0,0 +1,45 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/images/tree/main/src/typescript-node
+{
+    "name": "TypeScript",
+    "image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
+    // Features to add to the dev container. More info: https://containers.dev/features.
+    // "features": {},
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+    // Use 'postCreateCommand' to run commands after the container is created.
+    "postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-vscode.vscode-typescript-tslint-plugin",
+                "esbenp.prettier-vscode",
+                "github.vscode-pull-request-github"
+            ],
+            "settings": {
+                "files.eol": "\n",
+                "editor.formatOnSave": true,
+                "typescript.tsc.autoDetect": "on",
+                "typescript.updateImportsOnFileMove.enabled": "always",
+                "typescript.preferences.importModuleSpecifier": "relative",
+                "[typescript]": {
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports": true
+                    }
+                },
+                "[typescriptreact]": {
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports": true
+                    }
+                }
+            }
+        },
+        "codespaces": {
+            "openFiles": [
+                ".devcontainer/README.md"
+            ]
+        }
+    }
+    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+    // "remoteUser": "root"
+}

package/FUNCTIONS.md

@@ -0,0 +1,88 @@
+# Standalone Functions
+
+> [!NOTE]
+> This section is useful if you are using a bundler and targetting browsers and
+> runtimes where the size of an application affects performance and load times. 
+
+Every method in this SDK is also available as a standalone function. This
+alternative API is suitable when targetting the browser or serverless runtimes
+and using a bundler to build your application since all unused functionality
+will be tree-shaken away. This includes code for unused methods, Zod schemas,
+encoding helpers and response handlers. The result is dramatically smaller
+impact on the application's final bundle size which grows very slowly as you use
+more and more functionality from this SDK.
+
+Calling methods through the main SDK class remains a valid and generally more
+more ergonomic option. Standalone functions represent an optimisation for a
+specific category of applications.
+
+## Example
+
+```typescript
+import { CriblMgmtPlaneCore } from "cribl-mgmt-plane/core.js";
+import { dummyServiceStatus } from "cribl-mgmt-plane/funcs/dummyServiceStatus.js";
+
+// Use `CriblMgmtPlaneCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const criblMgmtPlane = new CriblMgmtPlaneCore({
+  serverURL: "https://api.example.com",
+  bearerAuth: process.env["CRIBLMGMTPLANE_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  const res = await dummyServiceStatus(criblMgmtPlane);
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("dummyServiceStatus failed:", res.error);
+  }
+}
+
+run();
+```
+
+## Result types
+
+Standalone functions differ from SDK methods in that they return a
+`Result<Value, Error>` type to capture _known errors_ and document them using
+the type system. By avoiding throwing errors, application code maintains clear
+control flow and error-handling become part of the regular flow of application
+code.
+
+> We use the term "known errors" because standalone functions, and JavaScript
+> code in general, can still throw unexpected errors such as `TypeError`s,
+> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
+> something this SDK addresses in the future. Nevertheless, there is still a lot
+> of benefit from capturing most errors and turning them into values.
+
+The second reason for this style of programming is because these functions will
+typically be used in front-end applications where exception throwing is
+sometimes discouraged or considered unidiomatic. React and similar ecosystems
+and libraries tend to promote this style of programming so that components
+render useful content under all states (loading, success, error and so on).
+
+The general pattern when calling standalone functions looks like this:
+
+```typescript
+import { Core } from "<sdk-package-name>";
+import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
+
+const client = new Core();
+
+async function run() {
+  const result = await fetchSomething(client, { id: "123" });
+  if (!result.ok) {
+    // You can throw the error or handle it. It's your choice now.
+    throw result.error;
+  }
+
+  console.log(result.value);
+}
+
+run();
+```
+
+Notably, `result.error` above will have an explicit type compared to a try-catch
+variation where the error in the catch block can only be of type `unknown` (or
+`any` depending on your TypeScript settings).

package/README.md

@@ -0,0 +1,342 @@
+# cribl-cloud-management-sdk-typescript
+<!-- Start Summary [summary] -->
+## Summary
+
+Cribl Cloud Management API: Lorem Ipsum
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [cribl-cloud-management-sdk-typescript](#cribl-cloud-management-sdk-typescript)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Authentication](#authentication)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Debugging](#debugging)
+
+<!-- End Table of Contents [toc] -->
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
+### NPM
+
+```bash
+npm add cribl-mgmt-plane
+```
+
+### PNPM
+
+```bash
+pnpm add cribl-mgmt-plane
+```
+
+### Bun
+
+```bash
+bun add cribl-mgmt-plane
+```
+
+### Yarn
+
+```bash
+yarn add cribl-mgmt-plane zod
+
+# Note that Yarn does not install peer dependencies automatically. You will need
+# to install zod as shown above.
+```
+
+> [!NOTE]
+> This package is published with CommonJS and ES Modules (ESM) support.
+<!-- End SDK Installation [installation] -->
+
+<!-- Start Requirements [requirements] -->
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+<!-- End Requirements [requirements] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
+
+### Example
+
+```typescript
+import { CriblMgmtPlane } from "cribl-mgmt-plane";
+
+const criblMgmtPlane = new CriblMgmtPlane({
+  serverURL: "https://api.example.com",
+  bearerAuth: process.env["CRIBLMGMTPLANE_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  await criblMgmtPlane.dummyServiceStatus();
+}
+
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name         | Type | Scheme      | Environment Variable         |
+| ------------ | ---- | ----------- | ---------------------------- |
+| `bearerAuth` | http | HTTP Bearer | `CRIBLMGMTPLANE_BEARER_AUTH` |
+
+To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
+```typescript
+import { CriblMgmtPlane } from "cribl-mgmt-plane";
+
+const criblMgmtPlane = new CriblMgmtPlane({
+  serverURL: "https://api.example.com",
+  bearerAuth: process.env["CRIBLMGMTPLANE_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  await criblMgmtPlane.dummyServiceStatus();
+}
+
+run();
+
+```
+<!-- End Authentication [security] -->
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
+
+### [CriblMgmtPlane SDK](docs/sdks/criblmgmtplane/README.md)
+
+* [dummyServiceStatus](docs/sdks/criblmgmtplane/README.md#dummyservicestatus) - Service status
+
+</details>
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Standalone functions [standalone-funcs] -->
+## Standalone functions
+
+All the methods listed above are available as standalone functions. These
+functions are ideal for use in applications running in the browser, serverless
+runtimes or other environments where application bundle size is a primary
+concern. When using a bundler to build your application, all unused
+functionality will be either excluded from the final bundle or tree-shaken away.
+
+To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [`dummyServiceStatus`](docs/sdks/criblmgmtplane/README.md#dummyservicestatus) - Service status
+
+</details>
+<!-- End Standalone functions [standalone-funcs] -->
+
+<!-- Start Retries [retries] -->
+## Retries
+
+Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { CriblMgmtPlane } from "cribl-mgmt-plane";
+
+const criblMgmtPlane = new CriblMgmtPlane({
+  serverURL: "https://api.example.com",
+  bearerAuth: process.env["CRIBLMGMTPLANE_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  await criblMgmtPlane.dummyServiceStatus({
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
+}
+
+run();
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+import { CriblMgmtPlane } from "cribl-mgmt-plane";
+
+const criblMgmtPlane = new CriblMgmtPlane({
+  serverURL: "https://api.example.com",
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
+    },
+    retryConnectionErrors: false,
+  },
+  bearerAuth: process.env["CRIBLMGMTPLANE_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  await criblMgmtPlane.dummyServiceStatus();
+}
+
+run();
+
+```
+<!-- End Retries [retries] -->
+
+<!-- Start Error Handling [errors] -->
+## Error Handling
+
+[`CriblMgmtPlaneError`](./src/models/errors/criblmgmtplaneerror.ts) is the base class for all HTTP error responses. It has the following properties:
+
+| Property            | Type       | Description                                            |
+| ------------------- | ---------- | ------------------------------------------------------ |
+| `error.message`     | `string`   | Error message                                          |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                     |
+| `error.headers`     | `Headers`  | HTTP response headers                                  |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned. |
+| `error.rawResponse` | `Response` | Raw HTTP response                                      |
+
+### Example
+```typescript
+import { CriblMgmtPlane } from "cribl-mgmt-plane";
+import * as errors from "cribl-mgmt-plane/models/errors";
+
+const criblMgmtPlane = new CriblMgmtPlane({
+  serverURL: "https://api.example.com",
+  bearerAuth: process.env["CRIBLMGMTPLANE_BEARER_AUTH"] ?? "",
+});
+
+async function run() {
+  try {
+    await criblMgmtPlane.dummyServiceStatus();
+  } catch (error) {
+    if (error instanceof errors.CriblMgmtPlaneError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
+    }
+  }
+}
+
+run();
+
+```
+
+### Error Classes
+**Primary error:**
+* [`CriblMgmtPlaneError`](./src/models/errors/criblmgmtplaneerror.ts): The base class for HTTP error responses.
+
+<details><summary>Less common errors (6)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`CriblMgmtPlaneError`](./src/models/errors/criblmgmtplaneerror.ts)**:
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
+<!-- End Error Handling [errors] -->
+
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
+
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
+client is a thin wrapper around `fetch` and provides the ability to attach hooks
+around the request lifecycle that can be used to modify the request or handle
+errors and response.
+
+The `HTTPClient` constructor takes an optional `fetcher` argument that can be
+used to integrate a third-party HTTP client or when writing tests to mock out
+the HTTP client and feed in fixtures.
+
+The following example shows how to use the `"beforeRequest"` hook to to add a
+custom header and a timeout to requests and how to use the `"requestError"` hook
+to log errors:
+
+```typescript
+import { CriblMgmtPlane } from "cribl-mgmt-plane";
+import { HTTPClient } from "cribl-mgmt-plane/lib/http";
+
+const httpClient = new HTTPClient({
+  // fetcher takes a function that has the same signature as native `fetch`.
+  fetcher: (request) => {
+    return fetch(request);
+  }
+});
+
+httpClient.addHook("beforeRequest", (request) => {
+  const nextRequest = new Request(request, {
+    signal: request.signal || AbortSignal.timeout(5000)
+  });
+
+  nextRequest.headers.set("x-custom-header", "custom value");
+
+  return nextRequest;
+});
+
+httpClient.addHook("requestError", (error, request) => {
+  console.group("Request Error");
+  console.log("Reason:", `${error}`);
+  console.log("Endpoint:", `${request.method} ${request.url}`);
+  console.groupEnd();
+});
+
+const sdk = new CriblMgmtPlane({ httpClient });
+```
+<!-- End Custom HTTP Client [http-client] -->
+
+<!-- Start Debugging [debug] -->
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass a logger that matches `console`'s interface as an SDK option.
+
+> [!WARNING]
+> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
+
+```typescript
+import { CriblMgmtPlane } from "cribl-mgmt-plane";
+
+const sdk = new CriblMgmtPlane({ debugLogger: console });
+```
+
+You can also enable a default debug logger by setting an environment variable `CRIBLMGMTPLANE_DEBUG` to true.
+<!-- End Debugging [debug] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->

package/RUNTIMES.md

@@ -0,0 +1,48 @@
+# Supported JavaScript runtimes
+
+This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
+
+* [Web Fetch API][web-fetch]
+* [Web Streams API][web-streams] and in particular `ReadableStream`
+* [Async iterables][async-iter] using `Symbol.asyncIterator`
+
+[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
+[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
+
+Runtime environments that are explicitly supported are:
+
+- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
+- Node.js active and maintenance LTS releases
+  - Currently, this is v18 and v20
+- Bun v1 and above
+- Deno v1.39
+  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
+
+[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
+
+## Recommended TypeScript compiler options
+
+The following `tsconfig.json` options are recommended for projects using this
+SDK in order to get static type support for features like async iterables,
+streams and `fetch`-related APIs ([`for await...of`][for-await-of], 
+[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
+so on):
+
+[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
+[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
+
+```jsonc
+{
+  "compilerOptions": {
+    "target": "es2020", // or higher
+    "lib": ["es2020", "dom", "dom.iterable"],
+  }
+}
+```
+
+While `target` can be set to older ECMAScript versions, it may result in extra,
+unnecessary compatibility code being generated if you are not targeting old
+runtimes.

package/dist/commonjs/__tests__/assertions.d.ts

@@ -0,0 +1,2 @@
+export declare function assertDefined(value: any): any;
+//# sourceMappingURL=assertions.d.ts.map

package/dist/commonjs/__tests__/assertions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertions.d.ts","sourceRoot":"","sources":["../../../src/__tests__/assertions.ts"],"names":[],"mappings":"AAMA,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,CAM7C"}

package/dist/commonjs/__tests__/assertions.js

@@ -0,0 +1,14 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertDefined = assertDefined;
+const assert_1 = require("assert");
+function assertDefined(value) {
+    if (value === undefined) {
+        (0, assert_1.fail)("value is undefined");
+    }
+    return value;
+}
+//# sourceMappingURL=assertions.js.map

package/dist/commonjs/__tests__/assertions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertions.js","sourceRoot":"","sources":["../../../src/__tests__/assertions.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAIH,sCAMC;AARD,mCAA8B;AAE9B,SAAgB,aAAa,CAAC,KAAU;IACtC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,IAAA,aAAI,EAAC,oBAAoB,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/commonjs/__tests__/criblmgmtplane.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=criblmgmtplane.test.d.ts.map

package/dist/commonjs/__tests__/criblmgmtplane.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"criblmgmtplane.test.d.ts","sourceRoot":"","sources":["../../../src/__tests__/criblmgmtplane.test.ts"],"names":[],"mappings":""}

package/dist/commonjs/__tests__/criblmgmtplane.test.js

@@ -0,0 +1,18 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const index_js_1 = require("../index.js");
+const testclient_js_1 = require("./testclient.js");
+(0, vitest_1.test)("Criblmgmtplane Dummy Service Status", async () => {
+    const testHttpClient = (0, testclient_js_1.createTestHTTPClient)("dummyServiceStatus");
+    const criblMgmtPlane = new index_js_1.CriblMgmtPlane({
+        serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+        httpClient: testHttpClient,
+        bearerAuth: process.env["CRIBLMGMTPLANE_BEARER_AUTH"] ?? "value",
+    });
+    await criblMgmtPlane.dummyServiceStatus();
+});
+//# sourceMappingURL=criblmgmtplane.test.js.map

package/dist/commonjs/__tests__/criblmgmtplane.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"criblmgmtplane.test.js","sourceRoot":"","sources":["../../../src/__tests__/criblmgmtplane.test.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAEH,mCAA8B;AAC9B,0CAA6C;AAC7C,mDAAuD;AAEvD,IAAA,aAAI,EAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;IACrD,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,oBAAoB,CAAC,CAAC;IAElE,MAAM,cAAc,GAAG,IAAI,yBAAc,CAAC;QACxC,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,IAAI,OAAO;KACjE,CAAC,CAAC;IAEH,MAAM,cAAc,CAAC,kBAAkB,EAAE,CAAC;AAC5C,CAAC,CAAC,CAAC"}

package/dist/commonjs/__tests__/files.d.ts

@@ -0,0 +1,6 @@
+export declare function filesToStream(filePath: string): ReadableStream<Uint8Array>;
+export declare function filesToByteArray(filePath: string): Promise<Uint8Array>;
+export declare function filesToString(filePath: string): Promise<string>;
+export declare function streamToByteArray(stream?: ReadableStream<Uint8Array>): Promise<Buffer>;
+export declare function bytesToStream(bytes: Uint8Array): ReadableStream<Uint8Array>;
+//# sourceMappingURL=files.d.ts.map

package/dist/commonjs/__tests__/files.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../../src/__tests__/files.ts"],"names":[],"mappings":"AAQA,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,CAAC,UAAU,CAAC,CAI1E;AAED,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAE5E;AAED,wBAAsB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAErE;AAED,wBAAsB,iBAAiB,CACrC,MAAM,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,GAClC,OAAO,CAAC,MAAM,CAAC,CAkBjB;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,CAW3E"}

package/dist/commonjs/__tests__/files.js

@@ -0,0 +1,51 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filesToStream = filesToStream;
+exports.filesToByteArray = filesToByteArray;
+exports.filesToString = filesToString;
+exports.streamToByteArray = streamToByteArray;
+exports.bytesToStream = bytesToStream;
+const node_fs_1 = require("node:fs");
+const promises_1 = require("node:fs/promises");
+const node_stream_1 = require("node:stream");
+function filesToStream(filePath) {
+    return node_stream_1.Readable.toWeb((0, node_fs_1.createReadStream)(filePath));
+}
+async function filesToByteArray(filePath) {
+    return new Uint8Array(await (0, promises_1.readFile)(filePath));
+}
+async function filesToString(filePath) {
+    return (0, promises_1.readFile)(filePath, "utf8");
+}
+async function streamToByteArray(stream) {
+    if (!stream) {
+        return Buffer.from("");
+    }
+    const chunks = [];
+    const reader = stream.getReader();
+    let done = false;
+    while (!done) {
+        const res = await reader.read();
+        done = res.done;
+        if (res.value) {
+            chunks.push(res.value);
+        }
+    }
+    return Buffer.concat(chunks);
+}
+function bytesToStream(bytes) {
+    return new ReadableStream({
+        start(controller) {
+            controller.enqueue(bytes);
+        },
+        pull(controller) {
+            controller.close();
+        },
+        cancel() {
+        },
+    });
+}
+//# sourceMappingURL=files.js.map

package/dist/commonjs/__tests__/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../../../src/__tests__/files.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAMH,sCAIC;AAED,4CAEC;AAED,sCAEC;AAED,8CAoBC;AAED,sCAWC;AAnDD,qCAA2C;AAC3C,+CAA4C;AAC5C,6CAAuC;AAEvC,SAAgB,aAAa,CAAC,QAAgB;IAC5C,OAAO,sBAAQ,CAAC,KAAK,CACnB,IAAA,0BAAgB,EAAC,QAAQ,CAAC,CACc,CAAC;AAC7C,CAAC;AAEM,KAAK,UAAU,gBAAgB,CAAC,QAAgB;IACrD,OAAO,IAAI,UAAU,CAAC,MAAM,IAAA,mBAAQ,EAAC,QAAQ,CAAC,CAAC,CAAC;AAClD,CAAC;AAEM,KAAK,UAAU,aAAa,CAAC,QAAgB;IAClD,OAAO,IAAA,mBAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACpC,CAAC;AAEM,KAAK,UAAU,iBAAiB,CACrC,MAAmC;IAEnC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;IAED,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;IAElC,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,OAAO,CAAC,IAAI,EAAE,CAAC;QACb,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QAChB,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC;AAED,SAAgB,aAAa,CAAC,KAAiB;IAC7C,OAAO,IAAI,cAAc,CAAC;QACxB,KAAK,CAAC,UAAU;YACd,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,UAAU;YACb,UAAU,CAAC,KAAK,EAAE,CAAC;QACrB,CAAC;QACD,MAAM;QACN,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}