@squidcloud/client 1.0.343 → 1.0.345

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

@@ -6,8 +6,25 @@ import { SchedulerInfo } from './public-types';
  */
 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

@@ -6,9 +6,33 @@ import { SecretEntry, SecretKey, SecretValue, SetSecretRequestEntry } from './pu
  */
 export declare class SecretClient {
     private readonly rpcManager;
+    /**
+     * 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.
@@ -30,6 +54,11 @@ export declare class SecretClient {
      * @returns A promise that resolves when the deletion request is complete.
      */
     deleteMany(keys: Array<SecretKey>, force?: boolean): Promise<void>;
+    /**
+     * Provides access to API key secret management operations.
+     *
+     * @returns An instance of {@link ApiKeysSecretClient} for managing API keys.
+     */
     get apiKeys(): ApiKeysSecretClient;
 }
 /**
@@ -39,8 +68,29 @@ export declare class SecretClient {
  */
 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/squid.d.ts

@@ -12,6 +12,7 @@ import { PersonalStorageClient } from './personal-storage-client';
 import { SchedulerClient } from './scheduler-client';
 import { AdminClient } from './admin-client';
 import { AiClient } from './ai-client';
+import { WebClient } from './web-client';
 /**
  * The different options that can be used to initialize a Squid instance.
  * @category Platform
@@ -109,6 +110,7 @@ export declare class Squid {
     private readonly aiClient;
     private readonly apiClient;
     private readonly adminClient;
+    private readonly webClient;
     private readonly observabilityClient;
     private readonly queueManagerFactory;
     private readonly schedulerClient;
@@ -219,12 +221,42 @@ export declare class Squid {
      * Returns a set of functionality for interacting with API integrations.
      */
     api(): ApiClient;
+    /**
+     * Returns the AdminClient instance for performing administrative operations.
+     */
     admin(): AdminClient;
+    /**
+     * Returns a set of functionality for interacting with the web.
+     */
+    web(): WebClient;
+    /**
+     * Returns a client for accessing file storage for the current app.
+     * Defaults to the built-in storage integration if none is provided.
+     *
+     * @param integrationId The storage integration ID (default is 'built_in_storage').
+     */
     storage(integrationId?: IntegrationId): StorageClient;
+    /**
+     * Returns a client for accessing personal (user-specific) file storage.
+     *
+     * @param integrationId The storage integration ID to use.
+     */
     personalStorage(integrationId: IntegrationId): PersonalStorageClient;
+    /**
+     * Returns a client for working with structured data extraction tools.
+     */
     extraction(): ExtractionClient;
+    /**
+     * Returns the observability client for metrics.
+     */
     get observability(): ObservabilityClient;
+    /**
+     * Returns the scheduler client for managing scheduled jobs and tasks.
+     */
     get schedulers(): SchedulerClient;
+    /**
+     * Returns the application ID of the current Squid instance.
+     */
     get appId(): AppId;
     /**
      * Returns a distributed lock for the given mutex. The lock can be used to synchronize access to a shared resource.

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

@@ -2,4 +2,4 @@
  * The current version of the SquidCloud client package.
  * @category Platform
  */
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.343";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.345";

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

@@ -0,0 +1,18 @@
+import { WebAiSearchResponse } from '../../internal-common/src/public-types/web.public-types';
+/**
+ * WebClient provides methods to interact with web-related functionalities.
+ * @category Platform
+ */
+export declare class WebClient {
+    private readonly rpcManager;
+    /**
+     * Search the web using AI. Returns a response containing Markdown text and cited URLs.
+     * @param query The keywords or query string to search for.
+     */
+    aiSearch(query: string): Promise<WebAiSearchResponse>;
+    /**
+     * Fetch content from a URL.
+     * @param url The URL to fetch content from.
+     */
+    getUrlContent(url: string): Promise<string>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.343",
+  "version": "1.0.345",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",