@squidcloud/client 1.0.337 → 1.0.339

package/dist/typescript-client/src/query/query-builder.factory.d.ts

@@ -4,7 +4,8 @@ import { DocumentData, FieldName, FieldSort, Operator, PrimitiveFieldType, Query
 import { Pagination, PaginationOptions } from './pagination';
 import { SnapshotEmitter } from './snapshot-emitter';
 /**
- * Interface used solely for @inheritDoc
+ * Interface used solely for inheritDoc
+ * @category Database
  */
 export interface HasDereference {
     /**
@@ -16,6 +17,7 @@ export interface HasDereference {
 }
 /**
  *  Query builder base class.
+ *  @category Database
  */
 export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
     /**
@@ -129,7 +131,6 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * @returns The query builder.
      */
     arrayNotIncludes(fieldName: (keyof MyDocType & FieldName) | string, values: Array<PrimitiveFieldType>): this;
-    throwIfInvalidLikePattern(pattern: string): void;
     /**
      * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
      * if none is provided.
@@ -149,8 +150,12 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * Returns the query object built by this query builder.
      */
     abstract build(): Query;
+    private throwIfInvalidLikePattern;
 }
-/** A query builder that can be used to build a query that returns a list of documents. */
+/**
+ * A query builder that can be used to build a query that returns a list of documents.
+ * @category Database
+ */
 export declare class QueryBuilder<DocumentType extends DocumentData> extends BaseQueryBuilder<DocumentType> implements SnapshotEmitter<DocumentReference<DocumentType>>, HasDereference {
     private readonly collectionName;
     private readonly integrationId;
@@ -209,7 +214,10 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     serialize(): SerializedSimpleQuery;
     paginate(options?: Partial<PaginationOptions>): Pagination<DocumentReference<DocumentType>>;
 }
-/** Describes the changes to a query result. */
+/**
+ * Describes the changes to a query result.
+ * @category Database
+ */
 export declare class Changes<DocumentType extends DocumentData> {
     /** The newly inserted documents to the query result */
     readonly inserts: Array<DocumentReference<DocumentType>>;

package/dist/typescript-client/src/query/query-subscription.manager.d.ts

@@ -1,2 +1 @@
-export declare const FETCH_BEYOND_LIMIT = 100;
-export declare const LIMIT_UNDERFLOW_TRIGGER = 20;
+export {};

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

@@ -1,60 +1,16 @@
-import { BehaviorSubject, Observable, ReplaySubject } from 'rxjs';
-import { Alias, ClientRequestId, JoinCondition, Query, SquidDocument } from '../public-types';
+import { Alias, SquidDocument } from '../public-types';
 /**
- * Defines the state and behavior of an ongoing query, including
- * query dependencies, data streaming, join conditions, and limit
- * underflow handling for dynamic data fetching.
+ * Represents a collection of documents associated with a specific alias
+ * in a query, typically used in joined query results.
+ * @category Database
  */
-export interface OngoingQuery {
-    clientRequestId: ClientRequestId;
-    query: Query;
-    supportedQueries: Array<OngoingQuery>;
-    supportingOngoingQuery?: OngoingQuery;
-    gotInitialResponse: boolean;
-    activated: boolean;
-    joinCondition?: JoinCondition;
-    alias: Alias;
-    dataSubject: BehaviorSubject<Array<SquidDocument> | null>;
-    queryRegistered: BehaviorSubject<boolean>;
-    /**
-     * In case that this query is a parent of another query (that is, the other query is a subset of this query), this
-     * query should not be unsubscribed from the server until we registered the child query in the server.
-     */
-    unsubscribeBlockerCount: BehaviorSubject<number>;
-    subscribe: boolean;
-    /**
-     * In case of joins, and if this ongoing query is the root, this field emits all the supported observables
-     * for example `A.join(B, {...some join condition...}).join(C, {...some join condition}`.
-     * This field will emit [A.subject.pipe(), B.subject.pipe(), C.subject.pipe()]. Any new supported queries will be
-     * added here.
-     */
-    allObservables?: ReplaySubject<Array<Observable<DocsAndAlias>>>;
-    isEmptyForJoin: boolean;
+export interface DocsAndAlias {
     /**
-     * If the query is a supporting query (right side of the join) and the query has '==' condition on the join column,
-     * there is no need to emit a new query when additional values are added to the left side of the join since the right
-     * side will not change.
+     * An array of documents retrieved as part of the query.
      */
-    canExpandForJoin: boolean;
-    done: boolean;
-    isInFlight: boolean;
-    forceFetchFromServer: boolean;
+    docs: Array<SquidDocument>;
     /**
-     * If there's a limit, we request `limit + FETCH_BEYOND_LIMIT` documents from the server.
-     * If we got that many documents, that means there may be even more. In that case, if our result set goes below
-     * `limit + LIMIT_UNDERFLOW_TRIGGER` documents (due to local or remote deletions), we need to resend the query to the
-     * server to potentially get more documents.
-     * If the number of documents is less than `limit + FETCH_BEYOND_LIMIT`, that means there are not that many documents
-     * on the server, so we don't need to resend the query regardless of how small our result size is or becomes.
+     * The alias associated with the documents in a joined query context.
      */
-    limitUnderflowState: LimitUnderflowState;
-}
-export declare enum LimitUnderflowState {
-    UNKNOWN = 0,
-    DISABLED = 1,
-    ENABLED = 2
-}
-export interface DocsAndAlias {
-    docs: Array<SquidDocument>;
     alias: Alias;
 }

package/dist/typescript-client/src/query/snapshot-emitter.d.ts

@@ -1,6 +1,11 @@
 import { Observable } from 'rxjs';
 import { SerializedQuery } from '../../../internal-common/src/public-types/serialized-query.public-types';
 import { Pagination, PaginationOptions } from './pagination';
+/**
+ * Interface for emitting query results in a reactive manner,
+ * supporting both synchronous and asynchronous access.
+ * @category Database
+ */
 export interface SnapshotEmitter<ReturnType> {
     /**
      * Returns a promise that resolves to the query results.

package/dist/typescript-client/src/query-utils.d.ts

@@ -1,6 +1,9 @@
 import { DocumentData } from '../../internal-common/src/public-types/document.public-types';
 import { QueryBuilder } from './query/query-builder.factory';
-/** Result of the `visitQueryResults` function. */
+/**
+ * Result of the `visitQueryResults` function.
+ * @category Database
+ */
 export interface VisitQueryResultsStats {
     /** Count of documents visited. */
     count: number;
@@ -10,5 +13,6 @@ export interface VisitQueryResultsStats {
 /**
  * Reads all objects from the query in a safe way (with pagination) and calls callback() on every object.
  * The iteration is interrupted if error is thrown.
+ * @category Database
  */
 export declare function visitQueryResults<T extends DocumentData>(query: QueryBuilder<T>, callback: (t: T) => Promise<unknown>, pageSize?: number): Promise<VisitQueryResultsStats>;

package/dist/typescript-client/src/queue.manager.d.ts

@@ -1,4 +1,9 @@
 import { Observable } from 'rxjs';
+/**
+ * Interface defining the operations available for a queue manager.
+ * Allows producing and consuming messages from a queue.
+ * @category Queue
+ */
 export interface QueueManager<T> {
     /** Publish messages to the queue */
     produce(messages: T[]): Promise<void>;

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

@@ -2,6 +2,7 @@ import { SchedulerInfo } from './public-types';
 /**
  * SchedulerClient provides methods to manage schedulers,
  * including listing, enabling, and disabling scheduled tasks.
+ * @category Platform
  */
 export declare class SchedulerClient {
     private readonly rpcManager;

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

@@ -2,6 +2,7 @@ import { SecretEntry, SecretKey, SecretValue, SetSecretRequestEntry } from './pu
 /**
  * SecretClient provides methods for managing secrets, including retrieval,
  * update, and deletion of stored secrets and API keys.
+ * @category Secret
  */
 export declare class SecretClient {
     private readonly rpcManager;
@@ -34,6 +35,7 @@ export declare class SecretClient {
 /**
  * ApiKeysSecretClient manages API key secrets, providing methods
  * for retrieval, creation, and deletion of API keys.
+ * @category Secret
  */
 export declare class ApiKeysSecretClient {
     private readonly rpcManager;

package/dist/typescript-client/src/squid-http-client.d.ts

@@ -1,7 +1,11 @@
 /** A response object with type T for the body. */
 export interface HttpResponse<BodyType = unknown> {
+    /** HTTP status code of the response. */
     status: number;
+    /** HTTP status text of the response. */
     statusText: string;
+    /** Headers included in the response. */
     headers: Record<string, string>;
+    /** Response body, typed as `BodyType`. */
     body: BodyType;
 }

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

@@ -12,7 +12,10 @@ import { PersonalStorageClient } from './personal-storage-client';
 import { SchedulerClient } from './scheduler-client';
 import { AdminClient } from './admin-client';
 import { AiClient } from './ai-client';
-/** The different options that can be used to initialize a Squid instance. */
+/**
+ * The different options that can be used to initialize a Squid instance.
+ * @category Platform
+ */
 export interface SquidOptions {
     /**
      * A function that can be used to wrap messages coming from Squid to the application. This is useful for
@@ -54,7 +57,10 @@ export interface SquidOptions {
      */
     squidDeveloperId?: SquidDeveloperId;
 }
-/** Authentication data provider for Squid requests. */
+/**
+ * Authentication data provider for Squid requests.
+ * @category Authentication
+ */
 export interface SquidAuthProvider {
     /**
      * Returns a valid AccessToken or undefined if there is no active authorized session.
@@ -75,6 +81,8 @@ export interface SquidAuthProvider {
  * capabilities.
  * All public Squid functions are bound to `this` and can be used with a destructuring patterns,
  * like `const {setAuthProvider} = useSquid()`
+ *
+ * @category Platform
  */
 export declare class Squid {
     readonly options: SquidOptions;
@@ -171,7 +179,8 @@ export declare class Squid {
      * {@link https://docs.getsquid.ai/docs/backend/executables/ documentation}.
      *
      * Files support:
-     * - To send a file to the backend, simply include it as one of the parameters; it will be received as a {@link SquidFile}.
+     * - To send a file to the backend, simply include it as one of the parameters; it will be received as a `SquidFile`
+     * on the backend.
      * - Arrays of files can also be passed directly as parameters.
      *
      * @param functionName - The name of the backend function to execute.
@@ -179,7 +188,7 @@ export declare class Squid {
      * @returns A promise that resolves to the result of the backend function.
      * @typeParam T - The expected type of the result returned by the backend function.
      */
-    executeFunction<T = any>(functionName: string, ...params: any[]): Promise<T>;
+    executeFunction<T = any>(functionName: string, ...params: Array<any | File>): Promise<T>;
     /**
      * Executes a native relational query with the given parameters and returns a promise with the result.
      * See https://docs.getsquid.ai/docs/client-sdk/database/native-queries.
@@ -206,6 +215,9 @@ export declare class Squid {
      * @returns A set of AI specific clients.
      */
     ai(): AiClient;
+    /**
+     * Returns a set of functionality for interacting with API integrations.
+     */
     api(): ApiClient;
     admin(): AdminClient;
     storage(integrationId?: IntegrationId): StorageClient;

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

@@ -1,47 +1,98 @@
 import { IntegrationId } from '../../internal-common/src/public-types/communication.public-types';
+/**
+ * Represents a request to upload a file to a specified directory within the storage bucket.
+ * @category Storage
+ */
 export interface StorageFileUploadRequest {
+    /** The ID of the integration where the file will be uploaded. */
     integrationId: IntegrationId;
+    /** The directory path within the bucket where the file should be stored. */
     dirPathInBucket: string;
+    /** Optional expiration time in seconds for the uploaded file. */
     expirationInSeconds?: number;
 }
+/**
+ * Represents a request to retrieve metadata for a specific file stored in the bucket.
+ * @category Storage
+ */
 export interface GetFileMetadataRequest {
+    /** The ID of the integration where the file is stored. */
     integrationId: IntegrationId;
+    /** The path of the file within the bucket. */
     filePathInBucket: string;
 }
+/**
+ * Represents the metadata details of a file stored in the bucket.
+ * @category Storage
+ */
 export interface GetFileMetadataResponse {
+    /** The name of the file. */
     filename: string;
+    /** The size of the file in bytes. */
     size: number;
+    /** The last modified timestamp of the file. */
     lastModified: Date;
+    /** Additional metadata associated with the file. */
     metadata: Record<string, string>;
 }
+/**
+ * Represents a request to generate a temporary download URL for a file.
+ * @category Storage
+ */
 export interface GetDownloadUrlRequest {
+    /** The ID of the integration where the file is stored. */
     integrationId: IntegrationId;
+    /** The path of the file within the bucket. */
     filePathInBucket: string;
+    /** Optional expiration time in seconds for the generated URL. */
     urlExpirationInSeconds?: number;
 }
+/**
+ * Represents the response containing a generated download URL for a file.
+ * @category Storage
+ */
 export interface GetDownloadUrlResponse {
+    /** The temporary URL for downloading the file. */
     url: string;
 }
+/**
+ * Represents a request to delete multiple files from the storage bucket.
+ * @category Storage
+ */
 export interface DeleteFilesRequest {
+    /** The ID of the integration where the files are stored. */
     integrationId: IntegrationId;
+    /** An array of file paths within the bucket to be deleted. */
     filePathsInBucket: Array<string>;
 }
-export interface ListDirectoryContentsRequest {
-    integrationId: IntegrationId;
-    dirPathInBucket: string;
-}
+/**
+ * Represents details of a file within a directory in the storage bucket.
+ * @category Storage
+ */
 export interface FileInDirectory {
+    /** The name of the file. */
     filename: string;
+    /** The absolute path of the file within the bucket. */
     absoluteFilePathInBucket: string;
+    /** The size of the file in bytes. */
     size: number;
+    /** The last modified timestamp of the file. */
     lastModified: Date;
 }
+/**
+ * Represents the response containing a list of directories and files within a specified directory in the storage
+ * bucket.
+ * @category Storage
+ */
 export interface ListDirectoryContentsResponse {
+    /** An array of directory names present in the specified directory. */
     directories: Array<string>;
+    /** An array of files present in the specified directory. */
     files: Array<FileInDirectory>;
 }
 /**
  * StorageClient provides methods for managing files in a storage system (like S3).
+ * @category Storage
  */
 export declare class StorageClient {
     private readonly integrationId;

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

@@ -1,2 +1,5 @@
-/** A transactionId - alias for string */
+/**
+ * A transactionId - alias for string
+ * @category Database
+ */
 export type TransactionId = string;

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.337",
+  "version": "1.0.339",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",
@@ -24,7 +24,9 @@
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e": "jest --config ./test/jest-e2e.json",
     "publish:public": "npm run build && npm publish --access public",
-    "full-bundle-size-report": "cross-env BUILD_FULL_BUNDLE_SIZE_REPORT=1 webpack --mode=production"
+    "full-bundle-size-report": "cross-env BUILD_FULL_BUNDLE_SIZE_REPORT=1 webpack --mode=production",
+    "generate-docs-html": "typedoc",
+    "generate-docs-markdown": "typedoc --plugin typedoc-plugin-markdown --readme none --out ./generated-docs/markdown"
   },
   "keywords": [
     "typescript",
@@ -48,6 +50,8 @@
     "rxjs": ">=7.5.7 <8.0.0"
   },
   "devDependencies": {
+    "typedoc": "^0.28.0",
+    "typedoc-plugin-markdown": "^4.5.2",
     "@supercharge/promise-pool": "^3.2.0",
     "@webpack-cli/generators": "^3.0.7",
     "copy-webpack-plugin": "^12.0.2",

package/dist/internal-common/src/metric-name.d.ts

@@ -1,9 +0,0 @@
-/**
- * Names of the Squid metrics.
- * Should be in sync with MetricName.kt.
- * See MetricName.kt for documentation on each value.
- */
-export declare const ALL_SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time", "squid_aiChatbotContext_size", "squid_aiChatbotChatInputTokens_count", "squid_aiChatbotChatOutputTokens_count", "squid_aiChatbotChatOutcome_count", "squid_aiImageGeneration_count", "squid_aiImageGeneration_time", "squid_aiRemoveBackground_count", "squid_aiRemoveBackground_time", "squid_aiAudioTranscribe_count", "squid_aiAudioTranscribe_time", "squid_aiAudioCreateSpeech_count", "squid_aiAudioCreateSpeech_time", "squid_aiIntegrationData_count", "squid_aiIntegrationData_time", "squid_aiIntegrationApi_count", "squid_aiIntegrationApi_time", "squid_apiControllerCall_count", "squid_apiControllerCall_time", "squid_built_in_db_size", "squid_codeInitialization_count", "squid_codeInitialization_time", "squid_deleteApiKey_count", "squid_deleteApiKey_time", "squid_deleteSecret_count", "squid_deleteSecret_time", "squid_discoverGraphQLConnectionSchema_count", "squid_discoverGraphQLConnectionSchema_time", "squid_discoverOpenApiSchema_count", "squid_discoverOpenApiSchema_time", "squid_discoverOpenApiSchemaFromFile_count", "squid_discoverOpenApiSchemaFromFile_time", "squid_executeBackendFunction_count", "squid_executeBackendFunction_time", "squid_getAiChatbotProfiles_count", "squid_getAiChatbotProfiles_time", "squid_getAllApiKeys_count", "squid_getAllApiKeys_time", "squid_getAllSecrets_count", "squid_getAllSecrets_time", "squid_getAppApiKey_count", "squid_getAppApiKey_time", "squid_getSecret_count", "squid_getSecret_time", "squid_graphql_count", "squid_graphql_time", "squid_graphqlQuery_count", "squid_graphqlQuery_time", "squid_integrationCount_value", "squid_acquireLock_count", "squid_releaseLock_count", "squid_mutate_count", "squid_mutate_time", "squid_metricQuery_count", "squid_metricQuery_time", "squid_metricReport_count", "squid_metricReport_time", "squid_nativeQuery_count", "squid_nativeQuery_time", "squid_openapi_count", "squid_openapi_time", "squid_produceTopicMessage_count", "squid_produceTopicMessage_time", "squid_query_count", "squid_query_time", "squid_registerQuery_count", "squid_registerQuery_time", "squid_rerankChunks_count", "squid_rerankChunks_time", "squid_schedulerJob_count", "squid_schedulerJob_time", "squid_schema_size", "squid_secrets_entries", "squid_storageDeleteFiles_count", "squid_storageDeleteFiles_time", "squid_storageGetDownloadUrl_count", "squid_storageGetDownloadUrl_time", "squid_storageGetFileMetadata_count", "squid_storageGetFileMetadata_time", "squid_storageListDirectoryContents_count", "squid_storageListDirectoryContents_time", "squid_storageUploadFile_count", "squid_storageUploadFile_time", "squid_subscribeToTopic_count", "squid_subscribeToTopic_time", "squid_testGraphQLConnection_count", "squid_testGraphQLConnection_time", "squid_trigger_count", "squid_trigger_time", "squid_upsertApiKey_count", "squid_upsertApiKey_time", "squid_upsertSecret_count", "squid_upsertSecret_time", "squid_vectorChunks_count", "squid_vectorChunks_time", "squid_webhook_count", "squid_webhook_time"];
-export type MetricName = (typeof ALL_SQUID_METRIC_NAMES)[number];
-/** Common prefix for all Squid metrics. */
-export declare const SQUID_METRIC_NAME_PREFIX = "squid_";

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

@@ -1,94 +0,0 @@
-/** A type alias for a string that represents a webhook. */
-export type WebhookId = string;
-/** A type alias for a string that represents a trigger id. */
-export type TriggerId = string;
-/** A type alias for a string that represents a scheduler id. */
-export type SchedulerId = string;
-/** The supported cron expression string. */
-export type CronExpressionString = `${string} ${string} ${string} ${string} ${string}` | `${string} ${string} ${string} ${string}`;
-/** A set of predefined cron expressions. */
-export declare enum CronExpression {
-    EVERY_SECOND = "* * * * * *",
-    EVERY_5_SECONDS = "*/5 * * * * *",
-    EVERY_10_SECONDS = "*/10 * * * * *",
-    EVERY_30_SECONDS = "*/30 * * * * *",
-    EVERY_MINUTE = "*/1 * * * *",
-    EVERY_5_MINUTES = "0 */5 * * * *",
-    EVERY_10_MINUTES = "0 */10 * * * *",
-    EVERY_30_MINUTES = "0 */30 * * * *",
-    EVERY_HOUR = "0 0-23/1 * * *",
-    EVERY_2_HOURS = "0 0-23/2 * * *",
-    EVERY_3_HOURS = "0 0-23/3 * * *",
-    EVERY_4_HOURS = "0 0-23/4 * * *",
-    EVERY_5_HOURS = "0 0-23/5 * * *",
-    EVERY_6_HOURS = "0 0-23/6 * * *",
-    EVERY_7_HOURS = "0 0-23/7 * * *",
-    EVERY_8_HOURS = "0 0-23/8 * * *",
-    EVERY_9_HOURS = "0 0-23/9 * * *",
-    EVERY_10_HOURS = "0 0-23/10 * * *",
-    EVERY_11_HOURS = "0 0-23/11 * * *",
-    EVERY_12_HOURS = "0 0-23/12 * * *",
-    EVERY_DAY_AT_1AM = "0 01 * * *",
-    EVERY_DAY_AT_2AM = "0 02 * * *",
-    EVERY_DAY_AT_3AM = "0 03 * * *",
-    EVERY_DAY_AT_4AM = "0 04 * * *",
-    EVERY_DAY_AT_5AM = "0 05 * * *",
-    EVERY_DAY_AT_6AM = "0 06 * * *",
-    EVERY_DAY_AT_7AM = "0 07 * * *",
-    EVERY_DAY_AT_8AM = "0 08 * * *",
-    EVERY_DAY_AT_9AM = "0 09 * * *",
-    EVERY_DAY_AT_10AM = "0 10 * * *",
-    EVERY_DAY_AT_11AM = "0 11 * * *",
-    EVERY_DAY_AT_NOON = "0 12 * * *",
-    EVERY_DAY_AT_1PM = "0 13 * * *",
-    EVERY_DAY_AT_2PM = "0 14 * * *",
-    EVERY_DAY_AT_3PM = "0 15 * * *",
-    EVERY_DAY_AT_4PM = "0 16 * * *",
-    EVERY_DAY_AT_5PM = "0 17 * * *",
-    EVERY_DAY_AT_6PM = "0 18 * * *",
-    EVERY_DAY_AT_7PM = "0 19 * * *",
-    EVERY_DAY_AT_8PM = "0 20 * * *",
-    EVERY_DAY_AT_9PM = "0 21 * * *",
-    EVERY_DAY_AT_10PM = "0 22 * * *",
-    EVERY_DAY_AT_11PM = "0 23 * * *",
-    EVERY_DAY_AT_MIDNIGHT = "0 0 * * *",
-    EVERY_WEEK = "0 0 * * 7",
-    EVERY_WEEKDAY = "0 0 * * 1-5",
-    EVERY_WEEKEND = "0 0 * * 6,7",
-    EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT = "0 0 1 * *",
-    EVERY_1ST_DAY_OF_MONTH_AT_NOON = "0 12 1 * *",
-    EVERY_2ND_HOUR = "0 */2 * * *",
-    EVERY_2ND_HOUR_FROM_1AM_THROUGH_11PM = "0 1-23/2 * * *",
-    EVERY_2ND_MONTH = "0 0 1 */2 *",
-    EVERY_QUARTER = "0 0 1 */3 *",
-    EVERY_6_MONTHS = "0 0 1 */6 *",
-    EVERY_YEAR = "0 0 1 1 *",
-    EVERY_30_MINUTES_BETWEEN_9AM_AND_5PM = "0 */30 9-17 * * *",
-    EVERY_30_MINUTES_BETWEEN_9AM_AND_6PM = "0 */30 9-18 * * *",
-    EVERY_30_MINUTES_BETWEEN_10AM_AND_7PM = "0 */30 10-19 * * *",
-    MONDAY_TO_FRIDAY_AT_1AM = "0 0 01 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_2AM = "0 0 02 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_3AM = "0 0 03 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_4AM = "0 0 04 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_5AM = "0 0 05 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_6AM = "0 0 06 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_7AM = "0 0 07 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_8AM = "0 0 08 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_9AM = "0 0 09 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_09_30AM = "0 30 09 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_10AM = "0 0 10 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_11AM = "0 0 11 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_11_30AM = "0 30 11 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_12PM = "0 0 12 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_1PM = "0 0 13 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_2PM = "0 0 14 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_3PM = "0 0 15 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_4PM = "0 0 16 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_5PM = "0 0 17 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_6PM = "0 0 18 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_7PM = "0 0 19 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_8PM = "0 0 20 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_9PM = "0 0 21 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_10PM = "0 0 22 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_11PM = "0 0 23 * * 1-5"
-}

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

@@ -1,33 +0,0 @@
-import { IntegrationType } from './integration.public-types';
-/** The different types of actions that can be performed on a database. */
-export type DatabaseActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
-/** The different types of actions that can be performed for storage. */
-export type StorageActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
-/** The different types of actions that can be performed on a topic. */
-export type TopicActionType = 'read' | 'write' | 'all';
-/** The different type of actions for metrics. */
-export type MetricActionType = 'write' | 'all';
-export type AiFunctionParamType = 'string' | 'number' | 'boolean' | 'date';
-export interface AiFunctionParam {
-    name: string;
-    description: string;
-    type: AiFunctionParamType;
-    required: boolean;
-}
-/** Additional optional readonly  metadata for AI function. */
-export interface AiFunctionAttributes {
-    /**
-     * Type of integration this function is used for.
-     * Functions with defined 'integrationType' require 'integrationId' to be passed as part of the function context.
-     */
-    integrationType?: Array<IntegrationType>;
-}
-export type TopicName = string;
-export type FunctionName = string;
-/** Function name with the contextual data. The data must be a serializable JSON. */
-export interface FunctionNameWithContext {
-    name: FunctionName;
-    context: Record<string, unknown>;
-}
-export type ServiceName = string;
-export type ServiceFunctionName = `${ServiceName}:${FunctionName}`;

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

@@ -1,54 +0,0 @@
-import { SquidDocIdObj } from './document.public-types';
-interface BaseMutation {
-    type: MutationType;
-    squidDocIdObj: SquidDocIdObj;
-}
-/** A mutation on a document. */
-export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
-/** The mutation type. */
-export declare const MUTATION_TYPES: readonly ["insert", "update", "delete"];
-export type MutationType = (typeof MUTATION_TYPES)[number];
-export interface DeleteMutation extends BaseMutation {
-    type: 'delete';
-}
-export interface UpdateMutation<T = any> extends BaseMutation {
-    type: 'update';
-    /** The updated properties */
-    properties: {
-        [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
-    };
-}
-export interface InsertMutation<T = any> extends BaseMutation {
-    type: 'insert';
-    /** The inserted document */
-    properties: T;
-}
-/** A representation of a single property update */
-export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
-/** A value update property mutation */
-export interface ValueUpdatePropertyMutation<Value = any> {
-    type: 'update';
-    value: Value;
-}
-/** Applying a numeric function to a property */
-export interface ApplyNumericFnPropertyMutation {
-    type: 'applyNumericFn';
-    fn: 'increment';
-    value: number;
-}
-/** A property update that removes a property from a document */
-export interface RemovePropertyMutation {
-    type: 'removeProperty';
-}
-interface ApplyExtendString {
-    type: 'applyStringFn';
-    fn: 'extendString';
-    value: string;
-}
-interface ApplyTrimString {
-    type: 'applyStringFn';
-    fn: 'trim';
-}
-/** A property mutation that modifies a string */
-export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
-export {};

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

@@ -1,9 +0,0 @@
-import { IntegrationId } from './communication.public-types';
-import { StorageActionType } from './bundle-data.public-types';
-export type StorageFunctionality = 'fileUpload' | 'getFileMetadata' | 'getDownloadUrl' | 'deleteFiles' | 'listDirectoryContents';
-export interface StorageContext {
-    integrationId: IntegrationId;
-    pathsInBucket: Array<string>;
-    action: StorageActionType;
-    functionality: StorageFunctionality;
-}

package/dist/internal-common/src/public-types-backend/api-call.public-context.d.ts

@@ -1,21 +0,0 @@
-import { ApiEndpointId, HttpMethod } from '../public-types/integrations/api.public-types';
-import { IntegrationId } from '../public-types/communication.public-types';
-import { ApiOptions } from '../public-types/api-client.public-types';
-/** The headers of an API call. */
-export type ApiHeaders = Record<string, string | number | boolean>;
-/** The context of an API call. */
-export declare class ApiCallContext {
-    readonly integrationId: IntegrationId;
-    readonly endpointId: ApiEndpointId;
-    readonly url: string;
-    readonly method: HttpMethod;
-    readonly body: unknown;
-    readonly options: ApiOptions;
-}
-export interface CallApiRequest<BodyType = any> {
-    integrationId: IntegrationId;
-    endpointId: ApiEndpointId;
-    body?: BodyType;
-    overrideMethod?: HttpMethod;
-    options: ApiOptions;
-}