@squidcloud/client 1.0.145 → 1.0.146-beta

package/dist/typescript-client/src/rpc.manager.d.ts

@@ -1,30 +1 @@
-import { SupportedSquidRegion } from '@squidcloud/common';
-import { AuthManager } from './auth.manager';
-import { ClientIdService } from './client-id.service';
-import { DestructManager } from './destruct.manager';
-import { BlobAndFilename } from './types';
-export declare class RpcManager {
-    private readonly region;
-    private readonly appId;
-    private readonly authManager;
-    private readonly clientIdService;
-    private readonly staticHeaders;
-    private readonly onGoingRpcCounter;
-    private readonly rateLimiters;
-    constructor(region: SupportedSquidRegion, appId: string, destructManager: DestructManager, headers: Record<string, string> | undefined, authManager: AuthManager, clientIdService: ClientIdService);
-    private getAuthHeaders;
-    awaitAllSettled(): Promise<void>;
-    setStaticHeader(key: string, value: string): void;
-    deleteStaticHeader(key: string): void;
-    getStaticHeaders(): Record<string, string>;
-    post<T>(path: string, message: any, files?: Array<File | BlobAndFilename>, filesFieldName?: string): Promise<T>;
-    private tryDeserializing;
-    private getRateLimiterBucket;
-}
-export declare class RpcError extends Error {
-    readonly statusCode: number;
-    readonly statusText: string;
-    readonly headers: Headers;
-    readonly url: string;
-    constructor(statusCode: number, statusText: string, headers: Headers, url: string, message?: string);
-}
+export {};

package/dist/typescript-client/src/scheduler-client.d.ts

@@ -0,0 +1,31 @@
+import { SchedulerInfo } from './public-types';
+/**
+ * SchedulerClient provides methods to manage schedulers,
+ * including listing, enabling, and disabling scheduled tasks.
+ * @category Platform
+ */
+export declare class SchedulerClient {
+    private readonly rpcManager;
+    /**
+     * Lists all configured schedulers.
+     *
+     * @returns A promise resolving to an array of scheduler metadata.
+     */
+    list(): Promise<SchedulerInfo[]>;
+    /**
+     * Enables one or more schedulers by their IDs.
+     *
+     * @param schedulerId A single scheduler ID or an array of scheduler IDs to enable.
+     * @returns A promise that resolves once the update is complete.
+     */
+    enable(schedulerId: string | string[]): Promise<void>;
+    /**
+     * Disables one or more schedulers by their IDs.
+     *
+     * @param schedulerId A single scheduler ID or an array of scheduler IDs to disable.
+     * @returns A promise that resolves once the update is complete.
+     */
+    disable(schedulerId: string | string[]): Promise<void>;
+    private update;
+    private createUpdateSchedulerOptions;
+}

package/dist/typescript-client/src/secret.client.d.ts

@@ -1,22 +1,96 @@
-import { SecretEntry, SecretKey, SecretValue, SetSecretRequestEntry } from '@squidcloud/common';
-import { RpcManager } from './rpc.manager';
-export declare class SecretClient {
-    private readonly rpcManager;
-    constructor(rpcManager: RpcManager);
-    get(key: SecretKey): Promise<SecretEntry | undefined>;
-    getAll(): Promise<Record<SecretKey, SecretEntry>>;
-    upsert(key: SecretKey, value: SecretValue): Promise<SecretEntry>;
-    upsertMany(entries: Array<SetSecretRequestEntry>): Promise<Array<SecretEntry>>;
-    delete(key: SecretKey): Promise<void>;
-    deleteMany(keys: Array<SecretKey>): Promise<void>;
-    get apiKeys(): ApiKeysSecretClient;
-}
-declare class ApiKeysSecretClient {
-    private readonly rpcManager;
-    constructor(rpcManager: RpcManager);
-    get(key: SecretKey): Promise<SecretEntry | undefined>;
-    getAll(): Promise<Record<SecretKey, SecretEntry>>;
-    upsert(key: SecretKey): Promise<SecretEntry>;
-    delete(key: SecretKey): Promise<void>;
-}
-export {};
+import { SecretEntry, SecretKey, SecretValue, SetSecretRequestEntry } from './public-types';
+/**
+ * SecretClient provides methods for managing secrets, including retrieval,
+ * update, and deletion of stored secrets and API keys.
+ * @category Secret
+ */
+export declare class SecretClient {
+    private readonly rpcManager;
+    /**
+     * Provides access to API key secret management operations.
+     *
+     * @returns An instance of {@link ApiKeysSecretClient} for managing API keys.
+     */
+    get apiKeys(): ApiKeysSecretClient;
+    /**
+     * Retrieves a stored custom secret by its key.
+     *
+     * @param key The key of the secret to retrieve.
+     * @returns A promise resolving to the secret entry if found, or `undefined` if not found.
+     */
+    get(key: SecretKey): Promise<SecretEntry | undefined>;
+    /**
+     * Retrieves all stored custom secrets.
+     *
+     * @returns A promise resolving to a record of secret entries keyed by their secret keys.
+     */
+    getAll(): Promise<Record<SecretKey, SecretEntry>>;
+    /**
+     * Creates or updates a single secret entry.
+     *
+     * @param key The secret key to upsert.
+     * @param value The value associated with the secret.
+     * @returns A promise resolving to the created or updated secret entry.
+     */
+    upsert(key: SecretKey, value: SecretValue): Promise<SecretEntry>;
+    /**
+     * Creates or updates multiple secret entries at once.
+     *
+     * @param entries An array of secret entries to set, each containing a key and value.
+     * @returns A promise resolving to an array of created or updated secret entries.
+     */
+    upsertMany(entries: Array<SetSecretRequestEntry>): Promise<Array<SecretEntry>>;
+    /**
+     * Deletes a specified secret key.
+     * If the secret is missing, it will be ignored, and the operation will proceed without failure.
+     *
+     * @param key - The secret key to delete.
+     * @param force - If set to true, forces deletion regardless of the secret's usage status across any enabled
+     *   integrations. Default is false.
+     * @returns A promise that resolves when the deletion request is complete.
+     */
+    delete(key: SecretKey, force?: boolean): Promise<void>;
+    /**
+     * Deletes a list of specified secret keys.
+     * If any secret in the list is missing, it will be ignored, and the operation will proceed without failure.
+     *
+     * @param keys - An array of secret keys to delete.
+     * @param force - If set to true, forces deletion regardless of the secret's usage status across any enabled
+     *   integrations. Default is false.
+     * @returns A promise that resolves when the deletion request is complete.
+     */
+    deleteMany(keys: Array<SecretKey>, force?: boolean): Promise<void>;
+}
+/**
+ * ApiKeysSecretClient manages API key secrets, providing methods
+ * for retrieval, creation, and deletion of API keys.
+ * @category Secret
+ */
+export declare class ApiKeysSecretClient {
+    private readonly rpcManager;
+    /**
+     * Retrieves a stored API key by its key.
+     *
+     * @param key The API key to retrieve.
+     * @returns A promise resolving to the secret entry or undefined if not found.
+     */
+    get(key: SecretKey): Promise<SecretEntry | undefined>;
+    /**
+     * Retrieves all secrets.
+     *
+     * @returns A promise resolving to a record of all stored secret entries.
+     */
+    getAll(): Promise<Record<SecretKey, SecretEntry>>;
+    /**
+     * Inserts a new API key or updates an existing one with a new autogenerated value.
+     * Returns the created secret.
+     */
+    upsert(key: SecretKey): Promise<SecretEntry>;
+    /**
+     * Deletes a specified API key.
+     *
+     * @param key The key of the API key to delete.
+     * @returns A promise resolving once deletion is complete.
+     */
+    delete(key: SecretKey): Promise<void>;
+}

package/dist/typescript-client/src/socket.manager.d.ts

@@ -1,43 +1 @@
-import { MessageFromClient, MessageToClient, SupportedSquidRegion } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-import { AuthManager } from './auth.manager';
-import { ClientIdService } from './client-id.service';
-import { DestructManager } from './destruct.manager';
-export declare class SocketManager {
-    private readonly clientIdService;
-    private readonly region;
-    private readonly appId;
-    private readonly messageNotificationWrapper;
-    private readonly destructManager;
-    private readonly authManager;
-    private readonly webSocketObserver;
-    private readonly allMessagesObserver;
-    private readonly connectionReady;
-    private readonly seenMessageIds;
-    private socket;
-    private destructSubject;
-    private lastTick;
-    /**
-     * On a client disconnecting, we wait for a bit to see if the client reconnects,
-     * if no reconnect happens within the timeout, we consider the client to be too old.
-     * This value means we wait for 5 minutes before considering the client to be too old.
-     * Note: we make this a function so that we can easily override it in tests.
-     */
-    private clientTooOldThreshold;
-    private tickInterval;
-    constructor(clientIdService: ClientIdService, region: SupportedSquidRegion, appId: string, messageNotificationWrapper: (fn: () => any) => any, destructManager: DestructManager, authManager: AuthManager);
-    refreshClient(): void;
-    tick(): void;
-    observeNotifications<T extends MessageToClient>(): Observable<T>;
-    observeConnectionReady(): Observable<boolean>;
-    sendMessage(message: MessageFromClient): void;
-    private sendMessageAsync;
-    /**  Sends 'kill' message ignoring 'connectionReady' observable. */
-    private sendKillMessage;
-    private connect;
-    disconnect(): void;
-    private onConnectionReady;
-    private onMessage;
-    private setupMessageAcknowledgments;
-    private destruct;
-}
+export {};

package/dist/typescript-client/src/squid-http-client.d.ts

@@ -0,0 +1,11 @@
+/** A response object with type T for the body. */
+export interface HttpResponse<BodyType = unknown> {
+    /** HTTP status code of the response. */
+    status: number;
+    /** HTTP status text of the response. */
+    statusText: string;
+    /** Headers included in the response. */
+    headers: Record<string, string>;
+    /** Response body, typed as `BodyType`. */
+    body: BodyType;
+}