@squidcloud/client 1.0.344 → 1.0.346

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

@@ -421,6 +421,8 @@ export type AiSessionOptions = Partial<{
     clientId: string;
     /** The ID of the AI agent involved in the session, if specified. */
     agentId: string;
+    /** The ID of the AI agent involved in starting the session, if specified. */
+    rootAgentId: string;
 }>;
 /**
  * The generic options type. When no generic is provided,
@@ -566,16 +568,10 @@ export interface FileContextRequest extends BaseContextRequest {
     type: 'file';
     /** Whether to extract images from the file; defaults to false. */
     extractImages?: boolean;
-    /** The minimum width for extracted images, if applicable. */
-    minImageWidth?: number;
-    /** The minimum height for extracted images, if applicable. */
-    minImageHeight?: number;
-    /** Whether to treat the full page as an image; defaults to false. */
-    fullPageAsImage?: boolean;
+    /** The minimum size for extracted images, if applicable. */
+    imageMinSizePixels?: number;
     /** The AI model to use for extraction, if specified. */
     extractionModel?: AiChatModelName;
-    /** An optional password to access the file, if encrypted. */
-    password?: string;
 }
 /**
  * @category AI

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

@@ -1,62 +1,86 @@
 /**
- * @category Storage
+ * Options for customizing how data is extracted from a document.
  */
-export type DocumentFileDataType = 'image';
-/**
- * Options for extracting data from a document file stored in the storage system.
- * @category Storage
- */
-export interface ExtractDataFromDocumentFileOptions {
-    /** An optional password required to access the document file, if encrypted. */
-    password?: string;
+export interface ExtractDataFromDocumentOptions {
+    /**
+     * Minimum width/height (in pixels) of images to extract. Smaller images will be ignored.
+     */
+    imageMinSizePixels?: number;
+    /**
+     * Whether to extract embedded images from the document.
+     */
+    extractImages?: boolean;
+    /**
+     * Specific page indexes to extract from the document (0-based). If omitted, all pages are extracted.
+     */
+    pageIndexes?: number[];
 }
 /**
- * Represents metadata for a file embedded within a document in the storage system.
- * @category Storage
+ * Request payload for extracting data from a document via URL.
  */
-export interface DocumentFileData {
-    /** The type of the embedded file (e.g., 'image'). */
-    type: DocumentFileDataType;
-    /** The storage path of the file within the bucket. */
-    pathInBucket: string;
+export interface ExtractDataFromDocumentUrlRequest {
+    /**
+     * The publicly accessible URL pointing to the document file.
+     */
+    url: string;
+    /**
+     * Optional parameters to control how the extraction is performed.
+     */
+    options?: ExtractDataFromDocumentOptions;
 }
 /**
- * Represents data for a single page within a document in the storage system.
- * @category Storage
+ * Request payload for extracting data from a document file (uploaded directly).
  */
-export interface DocumentPageData {
-    /** An optional title for the page. */
-    title?: string;
-    /** The text content extracted from the page. */
-    text: string;
-    /** An array of file data objects embedded in the page. */
-    fileDataList: DocumentFileData[];
+export interface ExtractDataFromDocumentFileRequest {
+    /**
+     * Optional parameters to control how the extraction is performed.
+     */
+    options?: ExtractDataFromDocumentOptions;
 }
 /**
- * Response structure for data extracted from a document in the storage system.
- * @category Storage
+ * Representation of an image extracted from a document, for use in generated content.
  */
-export interface ExtractDataFromDocumentResponse {
-    /** The storage path of the document within the bucket, if available. */
-    documentPathInBucket?: string;
-    /** An array of page data extracted from the document. */
-    pages: DocumentPageData[];
+export interface ExtractDataFromDocumentImage {
+    /**
+     * A unique identifier for the image.
+     */
+    id: string;
+    /**
+     * A placeholder or marker in the content where this image should be inserted.
+     */
+    textToReplaceInContent: string;
+    /**
+     * The base64-encoded image data, prefixed with its MIME type (e.g., data:image/png;base64,...).
+     */
+    imageBase64Url: string;
 }
 /**
- * Represents text-only data for a single page in a document.
- * @category Storage
+ * A single extracted page from the document, including structured content and images.
  */
-export interface TextOnlyPageData {
-    /** The text content of the page. */
-    text: string;
-    /** An optional title for the page. */
+export interface ExtractDataFromDocumentPage {
+    /**
+     * Optional title for the page (e.g., sheet name or section heading).
+     */
     title?: string;
+    /**
+     * Page index in the original document (0-based).
+     */
+    index: number;
+    /**
+     * Extracted textual content or CSV representation of the page.
+     */
+    content: string;
+    /**
+     * List of images extracted from this page.
+     */
+    images: Array<ExtractDataFromDocumentImage>;
 }
 /**
- * Response structure containing text-only data extracted from a document.
- * @category Storage
+ * The full result of extracting data from a document, including all pages and any extracted images.
  */
-export interface DocumentTextDataResponse {
-    /** An array of text-only page data extracted from the document. */
-    pages: TextOnlyPageData[];
+export interface ExtractDataFromDocumentResponse {
+    /**
+     * Array of pages containing extracted data.
+     */
+    pages: Array<ExtractDataFromDocumentPage>;
 }

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

@@ -96,13 +96,18 @@ export interface Query<Doc extends DocumentData = any> {
     /** The maximum number of records to return. */
     limit: number;
     /** Optional configuration to limit results by specific fields with custom sorting. */
-    limitBy?: {
-        /** The maximum number of records to return for this limit configuration. */
-        limit: number;
-        /** The fields to apply the limit to. */
-        fields: Array<FieldName<Doc>>;
-        /** Indicates whether to reverse the sort order for this limit. */
-        reverseSort: boolean;
-    };
+    limitBy?: LimitBy<Doc>;
+}
+/**
+ * A configuration object used to apply additional field-based limits to a query.
+ * @category Database
+ */
+export interface LimitBy<Doc extends DocumentData = any> {
+    /** The maximum number of records to return for this limit configuration. */
+    limit: number;
+    /** The fields to apply the limit to. */
+    fields: Array<FieldName<Doc>>;
+    /** Indicates whether to reverse the sort order for this limit. */
+    reverseSort: boolean;
 }
 export {};

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

@@ -24,12 +24,7 @@ export type SerializedJoinQuery = {
     /** Indicates whether references should be dereferenced during query execution. */
     dereference: boolean;
     /** The root table configuration for the join operation. */
-    root: {
-        /** The alias for the root table in the join operation. */
-        alias: Alias;
-        /** The query object defining the root table's operation. */
-        query: Query;
-    };
+    root: RootTableDetails;
     /** A mapping of aliases to their dependent aliases, defining the join order from left to right. */
     leftToRight: Record<Alias, Alias[]>;
     /** A mapping of aliases to their corresponding queries for joined tables. */
@@ -37,6 +32,17 @@ export type SerializedJoinQuery = {
     /** A mapping of aliases to their join conditions. */
     joinConditions: Record<Alias, JoinCondition>;
 };
+/**
+ * Configuration details for the root table used in a join query.
+ * The root table serves as the entry point for evaluating joined data across multiple tables.
+ * @category Database
+ */
+export interface RootTableDetails {
+    /** The alias for the root table in the join operation. */
+    alias: Alias;
+    /** The query object defining the root table's operation. */
+    query: Query;
+}
 /**
  * Represents a serialized merged query structure combining multiple queries for database operations.
  * @category Database

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/extraction-client.d.ts

@@ -1,4 +1,4 @@
-import { DocumentTextDataResponse, ExtractDataFromDocumentFileOptions } from '../../internal-common/src/public-types/extraction.public-types';
+import { ExtractDataFromDocumentOptions, ExtractDataFromDocumentResponse } from '../../internal-common/src/public-types/extraction.public-types';
 /**
  * ExtractionClient provides methods for extracting structured data
  * from document files using AI-driven processing.
@@ -13,5 +13,13 @@ export declare class ExtractionClient {
      * @param options - (Optional) Extraction options such as parsing hints or preprocessing flags.
      * @returns A promise that resolves with the extracted document data.
      */
-    extractDataFromDocumentFile(file: File, options?: ExtractDataFromDocumentFileOptions): Promise<DocumentTextDataResponse>;
+    extractDataFromDocumentFile(file: File, options?: ExtractDataFromDocumentOptions): Promise<ExtractDataFromDocumentResponse>;
+    /**
+     * Extracts structured text data from a document at a remote URL using AI.
+     *
+     * @param url - The URL of the document to extract data from.
+     * @param options - (Optional) Extraction options such as parsing hints or preprocessing flags.
+     * @returns A promise that resolves with the extracted document data.
+     */
+    extractDataFromDocumentUrl(url: string, options?: ExtractDataFromDocumentOptions): Promise<ExtractDataFromDocumentResponse>;
 }

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/personal-storage-client.d.ts

@@ -1,5 +1,4 @@
 import { AiContextMetadata } from '../../internal-common/src/public-types/ai-agent.public-types';
-import { DocumentTextDataResponse } from '../../internal-common/src/public-types/extraction.public-types';
 /**
  * Response to a request to get the access token for a personal storage service.
  * @category Personal Storage
@@ -55,13 +54,6 @@ export declare class PersonalStorageClient {
      * @returns A promise that resolves with the access token and expiration time.
      */
     getAccessToken(identifier: string): Promise<PsGetAccessTokenResponse>;
-    /**
-     * Extracts text data from a document.
-     * @param documentId - The ID of the document to extract text data from.
-     * @param identifier - A user-provided identifier (usually a user ID) that is associated with the document.
-     * @returns A promise that resolves with the extracted text data.
-     */
-    extractDataFromDocument(documentId: string, identifier: string): Promise<DocumentTextDataResponse>;
     /**
      * Indexes a document or folder for AI processing.
      *

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.346";

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.346",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",