@wnlx/o2-client 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,98 @@
+import { ConnectionOptions } from "node:tls";
+//#region src/sdk/client.d.ts
+interface O2TLSOptions extends Omit<ConnectionOptions, "host" | "port"> {
+  /**
+   * TLS hostname used for certificate verification and SNI.
+   *
+   * Defaults to `host` when `host` is a hostname.
+   * When connecting by IP, set this to the hostname contained
+   * in the server certificate if necessary.
+   */
+  servername?: string;
+}
+interface O2ClientOptions {
+  host?: string;
+  port?: number;
+  keyId: string;
+  secret: string;
+  transferBufferBytes?: number;
+  /**
+   * Enable TLS for O2/TCP.
+   *
+   * - false / undefined: plain O2/TCP
+   * - true: TLS with normal CA/certificate verification
+   * - object: TLS with custom Node TLS options
+   */
+  tls?: boolean | O2TLSOptions;
+}
+interface O2ObjectInfo {
+  key: string;
+  size: number;
+}
+interface O2NamespaceInfo {
+  name: string;
+  length: number;
+}
+interface O2Metadata {
+  size: number;
+  sha256: string;
+}
+interface O2Retrieval extends AsyncIterable<Uint8Array> {
+  readonly streamId: number;
+  readonly namespace: string;
+  readonly key: string;
+  readonly size: number;
+  readonly sha256?: string;
+  cancel(): Promise<void>;
+}
+export declare class O2Error extends Error {
+  readonly streamId?: number | undefined;
+  constructor(message: string, streamId?: number | undefined);
+}
+export declare class O2Client {
+  private readonly options;
+  private socket;
+  private writer;
+  private reader;
+  private incomingWork;
+  private pendingBytes;
+  private writeBlocked;
+  private nextStreamId;
+  private connected;
+  private closing;
+  private challengeWaiter;
+  private controlWaiter;
+  private requests;
+  private transfers;
+  private readonly host;
+  private readonly port;
+  private readonly transferBufferBytes;
+  constructor(options: O2ClientOptions);
+  connect(): Promise<void>;
+  close(): Promise<void>;
+  listNamespaces(): Promise<O2NamespaceInfo[]>;
+  listObjects(namespace: string): Promise<O2ObjectInfo[]>;
+  createNamespace(namespace: string): Promise<void>;
+  deleteNamespace(namespace: string): Promise<void>;
+  metadata(namespace: string, key: string): Promise<O2Metadata>;
+  deleteObject(namespace: string, key: string): Promise<string>;
+  putObject(namespace: string, key: string, data: Uint8Array, options?: {
+    chunkSize?: number;
+  }): Promise<void>;
+  putObjectStream(namespace: string, key: string, source: AsyncIterable<Uint8Array> | Iterable<Uint8Array>): Promise<void>;
+  signObject(namespace: string, key: string, expirySeconds: number): Promise<string>;
+  retrieve(namespace: string, key: string, options?: {
+    chunkSize?: number;
+    offset?: number;
+    length?: number;
+  }): Promise<O2Retrieval>;
+  private request;
+  private handleFrame;
+  private requestOnStream;
+  private cancelTransfer;
+  private allocateStreamId;
+  private ensureConnected;
+  private failAll;
+}
+//#endregion
+export type { O2ClientOptions, O2Metadata, O2NamespaceInfo, O2ObjectInfo, O2Retrieval, O2TLSOptions };

package/dist/index.d.mts

@@ -0,0 +1,98 @@
+import { ConnectionOptions } from "node:tls";
+//#region src/sdk/client.d.ts
+interface O2TLSOptions extends Omit<ConnectionOptions, "host" | "port"> {
+  /**
+   * TLS hostname used for certificate verification and SNI.
+   *
+   * Defaults to `host` when `host` is a hostname.
+   * When connecting by IP, set this to the hostname contained
+   * in the server certificate if necessary.
+   */
+  servername?: string;
+}
+interface O2ClientOptions {
+  host?: string;
+  port?: number;
+  keyId: string;
+  secret: string;
+  transferBufferBytes?: number;
+  /**
+   * Enable TLS for O2/TCP.
+   *
+   * - false / undefined: plain O2/TCP
+   * - true: TLS with normal CA/certificate verification
+   * - object: TLS with custom Node TLS options
+   */
+  tls?: boolean | O2TLSOptions;
+}
+interface O2ObjectInfo {
+  key: string;
+  size: number;
+}
+interface O2NamespaceInfo {
+  name: string;
+  length: number;
+}
+interface O2Metadata {
+  size: number;
+  sha256: string;
+}
+interface O2Retrieval extends AsyncIterable<Uint8Array> {
+  readonly streamId: number;
+  readonly namespace: string;
+  readonly key: string;
+  readonly size: number;
+  readonly sha256?: string;
+  cancel(): Promise<void>;
+}
+export declare class O2Error extends Error {
+  readonly streamId?: number | undefined;
+  constructor(message: string, streamId?: number | undefined);
+}
+export declare class O2Client {
+  private readonly options;
+  private socket;
+  private writer;
+  private reader;
+  private incomingWork;
+  private pendingBytes;
+  private writeBlocked;
+  private nextStreamId;
+  private connected;
+  private closing;
+  private challengeWaiter;
+  private controlWaiter;
+  private requests;
+  private transfers;
+  private readonly host;
+  private readonly port;
+  private readonly transferBufferBytes;
+  constructor(options: O2ClientOptions);
+  connect(): Promise<void>;
+  close(): Promise<void>;
+  listNamespaces(): Promise<O2NamespaceInfo[]>;
+  listObjects(namespace: string): Promise<O2ObjectInfo[]>;
+  createNamespace(namespace: string): Promise<void>;
+  deleteNamespace(namespace: string): Promise<void>;
+  metadata(namespace: string, key: string): Promise<O2Metadata>;
+  deleteObject(namespace: string, key: string): Promise<string>;
+  putObject(namespace: string, key: string, data: Uint8Array, options?: {
+    chunkSize?: number;
+  }): Promise<void>;
+  putObjectStream(namespace: string, key: string, source: AsyncIterable<Uint8Array> | Iterable<Uint8Array>): Promise<void>;
+  signObject(namespace: string, key: string, expirySeconds: number): Promise<string>;
+  retrieve(namespace: string, key: string, options?: {
+    chunkSize?: number;
+    offset?: number;
+    length?: number;
+  }): Promise<O2Retrieval>;
+  private request;
+  private handleFrame;
+  private requestOnStream;
+  private cancelTransfer;
+  private allocateStreamId;
+  private ensureConnected;
+  private failAll;
+}
+//#endregion
+export type { O2ClientOptions, O2Metadata, O2NamespaceInfo, O2ObjectInfo, O2Retrieval, O2TLSOptions };