@squidcloud/client 1.0.344 → 1.0.345

package/dist/internal-common/src/public-types/web.public-types.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Request to search the web.
+ */
+export interface WebAiSearchRequest {
+    /** The search query. */
+    query: string;
+}
+/**
+ * Represents a cited URL in the search response.
+ */
+export interface WebAiSearchCitedUrl {
+    /** The URL of the cited resource. */
+    url: string;
+    /** The title of the cited resource. */
+    title: string;
+}
+/**
+ * Response from a web search.
+ */
+export interface WebAiSearchResponse {
+    /** The search result content in Markdown format. */
+    markdownText: string;
+    /** A list of cited URLs included in the search response. */
+    citedUrls: Array<WebAiSearchCitedUrl>;
+}
+/**
+ * Request to fetch content from a URL.
+ */
+export interface WebGetUrlContentRequest {
+    /** The URL to fetch content from. */
+    url: string;
+}
+/**
+ * Response from fetching content from a URL.
+ */
+export interface WebGetUrlContentResponse {
+    /** The content fetched from the URL in Markdown format. */
+    markdownText: string;
+}

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

@@ -53,3 +53,4 @@ export * from './ai-client';
 export * from './agent/ai-agent-client';
 export * from './agent/ai-agent-client.types';
 export * from './agent/ai-agent-client-reference';
+export * from './web-client';

package/dist/typescript-client/src/public-types.d.ts

@@ -21,3 +21,4 @@ export * from '../../internal-common/src/public-types/typescript.public-types';
 export * from '../../internal-common/src/public-types/extraction.public-types';
 export * from '../../internal-common/src/public-types/ai-matchmaking.types';
 export * from '../../internal-common/src/public-types/backend.public-types';
+export * from '../../internal-common/src/public-types/web.public-types';

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

@@ -81,6 +81,10 @@ export declare class ApiKeysSecretClient {
      * @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.

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;
@@ -223,6 +225,10 @@ export declare class Squid {
      * 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.

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.344";
+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.344",
+  "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",