@squidcloud/client 1.0.145 → 1.0.146-beta

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

@@ -0,0 +1,71 @@
+import { IntegrationId } from './communication.public-types';
+/**
+ * Represents a primitive data type used in database fields.
+ * @category Database
+ */
+export type PrimitiveFieldType = string | number | boolean | null | Date;
+/**
+ * Represents a recursive field type structure for database documents, including primitives, arrays, and nested objects.
+ * @category Database
+ */
+export type FieldType = PrimitiveFieldType | Array<FieldType> | {
+    [key: string]: FieldType;
+};
+/**
+ * A type alias for a field name.
+ * @category Database
+ */
+export type FieldName<T = any> = string & keyof T;
+/**
+ * A type alias for a document id as string.
+ * @category Database
+ */
+export type DocId = string;
+/**
+ * A type alias for a document id object when the ID is a composite of primary keys.
+ * @category Database
+ */
+export type DocIdObj = Record<FieldName, any>;
+/**
+ * A type alias for a document id or a document id object.
+ * @category Database
+ */
+export type DocIdOrDocIdObj = DocId | DocIdObj;
+/**
+ * A type alias for a collection name.
+ * @category Database
+ */
+export type CollectionName = string;
+/**
+ * A generic document data type.
+ * @category Database
+ */
+export type DocumentData = Record<FieldName, any | undefined>;
+/**
+ * A type alias for timestamp field..
+ * @category Database
+ */
+export type DocTimestamp = number;
+/**
+ * The structure of a Squid Document with metadata and dynamic fields.
+ * @category Database
+ */
+export interface SquidDocument {
+    [fieldName: string]: FieldType | undefined;
+    /** The unique identifier of the document. */
+    __docId__: DocId;
+    /** The timestamp of the document, typically in milliseconds. */
+    __ts__: DocTimestamp;
+}
+/**
+ * The full document identifier, combining collection name, document ID, and integration ID.
+ * @category Database
+ */
+export interface SquidDocIdObj {
+    /** The name of the collection containing the document. */
+    collectionName: CollectionName;
+    /** The unique identifier of the document within the collection. */
+    docId: DocId;
+    /** The ID of the integration associated with the document. */
+    integrationId: IntegrationId;
+}

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

@@ -0,0 +1,39 @@
+import { IntegrationId } from '../communication.public-types';
+/**
+ * Configuration for identifying a user's external auth connection.
+ * @category ExternalAuth
+ */
+export interface ExternalAuthConfig {
+    /** The integration ID (e.g., 'google-calendar', 'microsoft-teams'). */
+    integrationId: IntegrationId;
+    /** User-specific identifier to distinguish between different users' tokens. */
+    identifier: string;
+}
+/**
+ * Request to save an authorization code and exchange it for tokens.
+ * @category ExternalAuth
+ */
+export interface SaveAuthCodeRequest {
+    /** The authorization code from the auth provider. */
+    authCode: string;
+    /** Configuration identifying the user and integration. */
+    externalAuthConfig: ExternalAuthConfig;
+}
+/**
+ * Request to get a valid access token for an integration.
+ * @category ExternalAuth
+ */
+export interface GetAccessTokenRequest {
+    /** Configuration identifying the user and integration. */
+    externalAuthConfig: ExternalAuthConfig;
+}
+/**
+ * Response containing a valid access token and expiration time.
+ * @category ExternalAuth
+ */
+export interface GetAccessTokenResponse {
+    /** Valid access token for making API calls. */
+    accessToken: string;
+    /** When the access token expires. */
+    expirationTime: Date;
+}

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

@@ -0,0 +1,183 @@
+/**
+ * The extraction method to use for processing documents.
+ */
+export type DocumentExtractionMethod = 'mistral_ocr' | 'legacy';
+/**
+ * Options for customizing how data is extracted from a document.
+ */
+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[];
+    /**
+     * The preferred method for extracting data from the document.
+     */
+    preferredExtractionMethod?: DocumentExtractionMethod;
+    /**
+     * Whether Squid keeps or discards the original file.
+     *
+     * Keeping the original file allows reprocessing and the ability for the user to download it later.
+     *
+     * Defaults to false.
+     */
+    discardOriginalFile?: boolean;
+}
+/**
+ * Request payload for extracting data from a document via URL.
+ */
+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;
+}
+/**
+ * Request payload for extracting data from a document file (uploaded directly).
+ */
+export interface ExtractDataFromDocumentFileRequest {
+    /**
+     * Optional parameters to control how the extraction is performed.
+     */
+    options?: ExtractDataFromDocumentOptions;
+}
+/**
+ * Representation of an image extracted from a document, for use in generated content.
+ */
+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;
+}
+/**
+ * A single extracted page from the document, including structured content and images.
+ */
+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>;
+}
+/**
+ * The full result of extracting data from a document, including all pages and any extracted images.
+ */
+export interface ExtractDataFromDocumentResponse {
+    /**
+     * Array of pages containing extracted data.
+     */
+    pages: Array<ExtractDataFromDocumentPage>;
+    /**
+     * Path to the original file in cloud storage, if applicable.
+     */
+    longTermStoragePath?: string;
+}
+/**
+ * Create PDF request type.
+ */
+export type CreatePdfType = 'html' | 'url';
+/** The type of output options to apply when creating a PDF document. */
+export type CreatePdfOutputOptionsType = 'format' | 'dimensions';
+/** Base interface for PDF output options. This is used to define the type of output options. */
+export interface BaseCreatePdfOutputOptions {
+    /** The type of output options, either 'format' or 'dimensions'. */
+    type: CreatePdfOutputOptionsType;
+}
+/** Output options by format */
+export interface CreatePdfOutputFormatOptions extends BaseCreatePdfOutputOptions {
+    /** The type of output options, always 'format' for this interface. */
+    type: 'format';
+    /** The type of formatting, always 'format' for this interface. */
+    format: 'letter' | 'legal' | 'tabloid' | 'ledger' | 'a0' | 'a1' | 'a2' | 'a3' | 'a4' | 'a5' | 'a6';
+}
+/** Output options by custom dimensions */
+export interface CreatePdfOutputDimensionsOptions extends BaseCreatePdfOutputOptions {
+    /** The type of formatting, always 'dimensions' for this interface. */
+    type: 'dimensions';
+    /** The width of the PDF document in pixels. */
+    width: number;
+    /** The height of the PDF document in pixels. */
+    height: number;
+}
+/** Combined formatting options for creating a PDF document. */
+export type CreatePdfOutputOptions = CreatePdfOutputFormatOptions | CreatePdfOutputDimensionsOptions;
+/**
+ * Base request for creating a PDF document.
+ */
+export interface BaseCreatePdfRequest {
+    /**
+     * The type of PDF creation to perform, either from HTML or a URL.
+     */
+    type: CreatePdfType;
+    /** The formatting options for the PDF document. Can be either a predefined format (like 'letter') or custom dimensions. */
+    outputOptions?: CreatePdfOutputOptions;
+    /** Optional title for the PDF document. */
+    title?: string;
+}
+/**
+ * Request payload for creating a PDF from a URL.
+ */
+export interface CreatePdfFromUrlRequest extends BaseCreatePdfRequest {
+    /** The type of PDF creation, always 'url' for this request. */
+    type: 'url';
+    /**
+     * The URL of the webpage to convert into a PDF.
+     */
+    url: string;
+}
+/**
+ * Request payload for creating a PDF from HTML content.
+ */
+export interface CreatePdfFromHtmlRequest extends BaseCreatePdfRequest {
+    /** The type of PDF creation, always 'html' for this request. */
+    type: 'html';
+    /** The HTML content to convert into a PDF. Should not contain <html>, <body>, <head>, should just include the inner HTML */
+    innerHtml: string;
+    /** Optional URL for CSS styles to apply to the HTML content. */
+    cssUrl?: string;
+}
+/**
+ * Combined request type for creating a PDF, which can be either from a URL or HTML content.
+ */
+export type CreatePdfRequest = CreatePdfFromUrlRequest | CreatePdfFromHtmlRequest;
+/**
+ * Response type for the PDF creation operation, containing the URL of the generated PDF.
+ */
+export interface CreatePdfResponse {
+    /** The publicly accessible URL where the generated PDF can be downloaded. */
+    url: string;
+    /** The generated filename. */
+    fileName?: string;
+}