@squidcloud/slack-client 1.0.409

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;
+}

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

@@ -0,0 +1,51 @@
+import { IntegrationId } from './communication.public-types';
+/** List of all integration types supported by Squid. */
+export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack", "mcp", "a2a", "legend"];
+/**
+ * @category Database
+ */
+export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "sap_hana", "snowflake", "elasticsearch", "legend"];
+/**
+ * @category Auth
+ */
+export declare const AUTH_INTEGRATION_TYPES: readonly ["auth0", "jwt_rsa", "jwt_hmac", "cognito", "okta", "descope", "firebase_auth"];
+/** Supported integration types for GraphQL-based services. */
+export declare const GRAPHQL_INTEGRATION_TYPES: readonly ["graphql", "linear"];
+/** Supported integration types for HTTP-based services. */
+export declare const HTTP_INTEGRATION_TYPES: readonly ["api"];
+/** Represents a supported integration type identifier, such as 'postgres', 'auth0', or 's3'. */
+export type IntegrationType = (typeof INTEGRATION_TYPES)[number];
+/** Supported schema types for integrations */
+export declare const INTEGRATION_SCHEMA_TYPES: readonly ["data", "api", "graphql"];
+/** Describes the type of schema the integration provides, such as data, API, or GraphQL schema. */
+export type IntegrationSchemaType = (typeof INTEGRATION_SCHEMA_TYPES)[number];
+/**
+ * @category Database
+ */
+export declare const BUILT_IN_DB_INTEGRATION_ID: IntegrationId;
+/**
+ * @category Queue
+ */
+export declare const BUILT_IN_QUEUE_INTEGRATION_ID: IntegrationId;
+/**
+ * ID for the cloud specific storage integration: s3 (built_in_s3) or gcs (built_in_gcs).
+ * @category
+ */
+export declare const BUILT_IN_STORAGE_INTEGRATION_ID: IntegrationId;
+/** Metadata describing a configured integration, including its ID, type, timestamps, and optional configuration object. */
+export interface IntegrationInfo<ConfigurationType = Record<string, any> | undefined> {
+    /** The unique identifier of the integration instance. */
+    id: IntegrationId;
+    /** The type of the integration (e.g., postgres, auth0, s3). */
+    type: IntegrationType;
+    /** The date when the integration was created. */
+    creationDate?: Date;
+    /** The date when the integration was last updated. */
+    updateDate?: Date;
+    /** The configuration object for the integration, if any. */
+    configuration: ConfigurationType;
+}
+/** Integration IDs used for built-in integrations by Squid. */
+export declare const SQUID_BUILT_IN_INTEGRATION_IDS: readonly [string, string, string];
+/** Returns true if ID is a built-in integration ID in Squid. */
+export declare function isBuiltInIntegrationId(id: unknown): id is (typeof SQUID_BUILT_IN_INTEGRATION_IDS)[number];

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

@@ -0,0 +1,59 @@
+/**
+ * Represents a unique identifier for a job.
+ */
+export type JobId = string;
+/** Represents a request to get an asynchronous job by its ID. */
+export interface GetJobRequest {
+    /** The unique identifier of the job to retrieve */
+    jobId: JobId;
+}
+/**
+ * Represents a request to get an asynchronous job by its ID.
+ */
+export interface GetJobResponse {
+    /** The job details */
+    job: AsyncJob | undefined;
+}
+/**
+ * Represents a request to subscribe to job updates.
+ * This allows clients to receive real-time updates about the job's status.
+ */
+export interface SubscribeToJobRequest {
+    /** The unique identifier of the job to subscribe to */
+    jobId: JobId;
+}
+/**
+ * Represents an asynchronous job
+ */
+export interface AsyncJob<T = any> {
+    /**
+     * The unique identifier of the job.
+     */
+    id: JobId;
+    /**
+     * The timestamp when the job was created.
+     */
+    createdAt: Date;
+    /**
+     * The timestamp when the job was last updated.
+     */
+    updatedAt: Date;
+    /**
+     * The current status of the job.
+     * Can be one of the following:
+     * - 'in_progress': The job is currently being processed.
+     * - 'completed': The job has finished successfully.
+     * - 'failed': The job has failed.
+     */
+    status: 'in_progress' | 'completed' | 'failed';
+    /**
+     * The result of the job, if available.
+     * This is of type `T` and is optional.
+     */
+    result?: T;
+    /**
+     * The error message, if the job has failed.
+     * This is optional.
+     */
+    error?: string;
+}

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

@@ -0,0 +1,51 @@
+/**
+ * A type alias for an ApiKey.
+ * @category Secret
+ */
+export type ApiKey = string;
+/**
+ * The secret key, an alias for a string.
+ * @category Secret
+ */
+export type SecretKey = string;
+/**
+ * The secret value.
+ * @category Secret
+ */
+export type SecretValue = string | number | boolean;
+/**
+ * Metadata for a secret, including its key and last updated timestamp.
+ * @category Secret
+ */
+export interface SecretMetadata {
+    /** The key identifying the secret. */
+    key: SecretKey;
+    /** The timestamp (in milliseconds) when the secret was last updated. */
+    lastUpdated: number;
+}
+/**
+ * A secret entry combining metadata with a typed value.
+ * @category Secret
+ */
+export interface SecretEntry<T extends SecretValue = SecretValue> extends SecretMetadata {
+    /** The value of the secret, constrained to the specified type. */
+    value: T;
+}
+/**
+ * An API key entry combining metadata with a string value.
+ * @category Secret
+ */
+export interface ApiKeyEntry extends SecretMetadata {
+    /** The string value of the API key. */
+    value: string;
+}
+/**
+ * A request structure for setting a secret with a key-value pair.
+ * @category Secret
+ */
+export interface SetSecretRequestEntry {
+    /** The key identifying the secret to set. */
+    key: SecretKey;
+    /** The value to assign to the secret. */
+    value: SecretValue;
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@squidcloud/slack-client",
+  "version": "1.0.409",
+  "description": "Squid Slack Client",
+  "main": "dist/index.js",
+  "types": "dist/client/src/index.d.ts",
+  "scripts": {
+    "prebuild": "del-cli dist",
+    "build": "webpack --mode=production",
+    "lint": "eslint",
+    "publish:public": "npm run build && npm publish --access public"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "assertic": "^1.3.0",
+    "lodash": "^4.17.21",
+    "@squidcloud/client": "^1.0.409",
+    "@slack/bolt": "^4.5.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}