@squidcloud/client 1.0.64 → 1.0.66

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

@@ -1,59 +1,4 @@
-import { QueryName, SchedulerConfig, SchedulerId, TriggerConfig, TriggerId, WebhookConfig, WebhookId } from './application.types';
-import { IntegrationId } from './communication.types';
-import { CollectionName } from './document.types';
-import { ApiEndpointId } from './integrations';
-export type DatabaseActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
-export type AiAssistantActionType = 'chat' | 'mutate' | 'all';
-export type ServiceName = string;
-export type FunctionName = string;
-export type ServiceFunctionName = `${ServiceName}:${FunctionName}`;
-export interface ApplicationBundleData {
-    databases: Record<IntegrationId, DatabaseMetadata>;
-    apis: Record<IntegrationId, {
-        endpoints: Record<ApiEndpointId, ApiMetadata>;
-    } & ApiMetadata>;
-    graphql: Record<IntegrationId, GraphQLMetadata>;
-    executables: Record<FunctionName, ExecutableMetadata>;
-    triggers: Record<TriggerId, TriggerConfig>;
-    schedulers: Record<SchedulerId, SchedulerConfig>;
-    webhooks: Record<WebhookId, WebhookConfig>;
-    namedQueries: Record<IntegrationId, Record<QueryName, NamedQueryMetadata>>;
-    distributedLocks: {
-        security?: Array<ServiceFunctionName>;
-        mutexes?: Record<string, {
-            security?: Array<ServiceFunctionName>;
-        }>;
-    };
-    aiAssistants: Record<IntegrationId, {
-        profiles: Record<string, AiAssistantMetadata>;
-    } & AiAssistantMetadata>;
-}
-export interface DatabaseMetadata {
-    collections: Record<CollectionName, CollectionMetadata>;
-    security?: Record<DatabaseActionType, Array<ServiceFunctionName>>;
-    transform?: Record<DatabaseActionType, DatabaseTransformMetadata>;
-}
-export interface CollectionMetadata {
-    security?: Record<DatabaseActionType, Array<ServiceFunctionName>>;
-    transform?: Record<DatabaseActionType, DatabaseTransformMetadata>;
-}
-export interface DatabaseTransformMetadata {
-    serviceFunction: ServiceFunctionName;
-}
-export interface ExecutableMetadata {
-    serviceFunction: ServiceFunctionName;
-}
-export interface NamedQueryMetadata {
-    security?: Array<ServiceFunctionName>;
-    queryString: string;
-}
-export interface ApiMetadata {
-    security: Array<ServiceFunctionName>;
-}
-interface GraphQLMetadata {
-    security: Array<ServiceFunctionName>;
-}
-export interface AiAssistantMetadata {
-    security: Record<AiAssistantActionType, Array<ServiceFunctionName>>;
-}
-export {};
+/** 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 on an AI assistant. */
+export type AiAssistantActionType = 'chat' | 'mutate' | 'all';

package/dist/common/src/communication.types.d.ts

@@ -1,4 +1,22 @@
-export type AppId = string;
-export type IntegrationId = string;
-export type ClientId = string;
-export type ClientRequestId = string;
+/**
+ * The appId is the unique identifier of an application.
+ * It is the combination of the application id (as shown in the console), environment id (dev, prod) and the
+ * developer id (if exists). For example - "fdgfd90ds_dev_1234567890abcdef"
+ */
+/** A type alias for an application id. */
+export type AppId = string;
+export type EnvironmentId = 'prod' | 'dev';
+export declare const allEnvironmentIds: Array<EnvironmentId>;
+/** A type alias for an integration id. */
+export type IntegrationId = string;
+export type SquidDeveloperId = string;
+export interface ParsedAppId {
+    appId: AppId;
+    environmentId: EnvironmentId;
+    squidDeveloperId?: SquidDeveloperId;
+}
+export declare function parseAppId(appId: AppId): ParsedAppId;
+export declare function appIdWithEnvironmentId(appId: AppId, environmentId: EnvironmentId | undefined): AppId;
+export declare function validateEnvironment(appId: AppId): ParsedAppId;
+export declare function verifyWithSquidDevId(appId: AppId): void;
+export declare function omitSquidDevId(appId: AppId): AppId;

package/dist/common/src/context.types.d.ts

@@ -1,32 +1,32 @@
-export type AuthType = 'Bearer' | 'ApiKey';
-/**
- * The payload of a JWT token in case an auth token was used.
- */
-export interface AuthWithBearer {
-    type: 'Bearer';
-    userId: string;
-    expiration: number;
-    attributes: Record<string, any>;
-}
-/**
- * The authentication object for the current request in case an API key is used.
- */
-export interface AuthWithApiKey {
-    type: 'ApiKey';
-    apiKey: string;
-}
-/** The authentication object for the current request. */
-export type Auth = AuthWithBearer | AuthWithApiKey;
-export interface AuthToken {
-    type: AuthType;
-    token: string;
-    integrationId?: string;
-}
-/**
- * The context of a request to a service.
- */
-export interface RunContext {
-    appId: string;
-    sourceIp?: string;
-    headers?: Record<string, any>;
-}
+export type AuthType = 'Bearer' | 'ApiKey';
+/**
+ * The payload of a JWT token in case an auth token was used.
+ */
+export interface AuthWithBearer {
+    type: 'Bearer';
+    userId: string;
+    expiration: number;
+    attributes: Record<string, any>;
+}
+/**
+ * The authentication object for the current request in case an API key is used.
+ */
+export interface AuthWithApiKey {
+    type: 'ApiKey';
+    apiKey: string;
+}
+/** The authentication object for the current request. */
+export type Auth = AuthWithBearer | AuthWithApiKey;
+export interface AuthToken {
+    type: AuthType;
+    token: string;
+    integrationId?: string;
+}
+/**
+ * The context of a request to a service.
+ */
+export interface RunContext {
+    appId: string;
+    sourceIp?: string;
+    headers?: Record<string, any>;
+}

package/dist/common/src/distributed-lock.context.d.ts

@@ -1,5 +1,5 @@
-export declare class DistributedLockContext {
-    readonly mutex: string;
-    readonly exclusive: boolean;
-    constructor(mutex: string, exclusive: boolean);
-}
+/** The context provided to a secure distributed lock function. */
+export declare class DistributedLockContext {
+    readonly mutex: string;
+    readonly exclusive: boolean;
+}

package/dist/common/src/document.types.d.ts

@@ -1,37 +1,22 @@
-import { IntegrationId } from './communication.types';
-export type FieldName<T = any> = string & keyof T;
-export type PrimitiveFieldType = string | number | boolean | null | Date;
-export type FieldType = PrimitiveFieldType | Array<FieldType> | {
-    [key: string]: FieldType;
-};
-export type DocId = string;
-export type DocIdObj = Record<FieldName, any>;
-export type CollectionName = string;
-/** The collection name with the db name or schema depends on the database type (e.g, mySchema.myTable)  */
-export type FullCollectionName = string;
-export type DocTimestamp = number;
-export interface SquidDocIdObj {
-    collectionName: CollectionName;
-    docId: DocId;
-    integrationId: IntegrationId;
-}
-export interface BeforeAndAfterDocs<T = SquidDocument> {
-    before: T | undefined;
-    after: T | undefined;
-}
-export type SquidDocId = string;
-export interface SquidDocument {
-    __docId__: DocId;
-    __ts__: DocTimestamp;
-    [fieldName: string]: FieldType | undefined;
-}
-export type DocumentData = Record<FieldName, any | undefined>;
-export declare function parseSquidDocId(squidDocId: SquidDocId): SquidDocIdObj;
-export declare function getSquidDocId(squidDocIdObj: SquidDocIdObj): SquidDocId;
-export declare function getSquidDocId(docId: DocId, collectionName: CollectionName, integrationId: IntegrationId): SquidDocId;
-/**
- * Determines whether a beforeDoc and an afterDoc have the same properties.
- * Our internal properties such as __docId__ and __ts__ are excluded from the
- * comparison, as well as any primary keys changes.
- */
-export declare function hasDocumentDiff(beforeDoc: SquidDocument | undefined, afterDoc: SquidDocument | undefined): boolean;
+import { IntegrationId } from './communication.types';
+/** A type alias for a field name. */
+export type FieldName<T = any> = string & keyof T;
+/** A type alias for a document id as string. */
+export type DocId = string;
+/** A type alias for a document id object when the ID is a composite of primary keys. */
+export type DocIdObj = Record<FieldName, any>;
+/** A type alias for a collection name. */
+export type CollectionName = string;
+/** The full document id, including the collection name and the integration id. */
+export interface SquidDocIdObj {
+    collectionName: CollectionName;
+    docId: DocId;
+    integrationId: IntegrationId;
+}
+/** The before and after documents of a document change. */
+export interface BeforeAndAfterDocs<T = SquidDocument> {
+    before: T | undefined;
+    after: T | undefined;
+}
+/** A generic document data type. */
+export type DocumentData = Record<FieldName, any | undefined>;

package/dist/common/src/graphql.context.d.ts

@@ -1,6 +1,7 @@
-export declare class GraphqlContext {
-    readonly isGraphiQL: boolean;
-    readonly query: string | undefined;
-    readonly variables: string | Record<string, any> | undefined;
-    readonly operationName: string | undefined;
-}
+/** The context provided to a secure GraphQL function. */
+export declare class GraphqlContext {
+    readonly isGraphiQL: boolean;
+    readonly query: string | undefined;
+    readonly variables: string | Record<string, any> | undefined;
+    readonly operationName: string | undefined;
+}

package/dist/common/src/graphql.types.d.ts

@@ -1,11 +1,9 @@
-import { IntrospectionQuery } from 'graphql';
-export { ExecutionResult, IntrospectionQuery } from 'graphql';
-export interface GraphQLRequest {
-    operationName?: string;
-    query?: string;
-    variables?: string | Record<string, any>;
-}
-export interface SecureGraphQLRequest extends GraphQLRequest {
-    isGraphiQL: boolean;
-}
-export declare const EmptyIntrospection: IntrospectionQuery;
+export { ExecutionResult, IntrospectionQuery } from 'graphql';
+export interface GraphQLRequest {
+    operationName?: string;
+    query?: string;
+    variables?: string | Record<string, any>;
+}
+export interface SecureGraphQLRequest extends GraphQLRequest {
+    isGraphiQL: boolean;
+}

package/dist/common/src/http-status.enum.d.ts

@@ -1,50 +1,50 @@
-export declare enum HttpStatus {
-    CONTINUE = 100,
-    SWITCHING_PROTOCOLS = 101,
-    PROCESSING = 102,
-    EARLYHINTS = 103,
-    OK = 200,
-    CREATED = 201,
-    ACCEPTED = 202,
-    NON_AUTHORITATIVE_INFORMATION = 203,
-    NO_CONTENT = 204,
-    RESET_CONTENT = 205,
-    PARTIAL_CONTENT = 206,
-    AMBIGUOUS = 300,
-    MOVED_PERMANENTLY = 301,
-    FOUND = 302,
-    SEE_OTHER = 303,
-    NOT_MODIFIED = 304,
-    TEMPORARY_REDIRECT = 307,
-    PERMANENT_REDIRECT = 308,
-    BAD_REQUEST = 400,
-    UNAUTHORIZED = 401,
-    PAYMENT_REQUIRED = 402,
-    FORBIDDEN = 403,
-    NOT_FOUND = 404,
-    METHOD_NOT_ALLOWED = 405,
-    NOT_ACCEPTABLE = 406,
-    PROXY_AUTHENTICATION_REQUIRED = 407,
-    REQUEST_TIMEOUT = 408,
-    CONFLICT = 409,
-    GONE = 410,
-    LENGTH_REQUIRED = 411,
-    PRECONDITION_FAILED = 412,
-    PAYLOAD_TOO_LARGE = 413,
-    URI_TOO_LONG = 414,
-    UNSUPPORTED_MEDIA_TYPE = 415,
-    REQUESTED_RANGE_NOT_SATISFIABLE = 416,
-    EXPECTATION_FAILED = 417,
-    I_AM_A_TEAPOT = 418,
-    MISDIRECTED = 421,
-    UNPROCESSABLE_ENTITY = 422,
-    FAILED_DEPENDENCY = 424,
-    PRECONDITION_REQUIRED = 428,
-    TOO_MANY_REQUESTS = 429,
-    INTERNAL_SERVER_ERROR = 500,
-    NOT_IMPLEMENTED = 501,
-    BAD_GATEWAY = 502,
-    SERVICE_UNAVAILABLE = 503,
-    GATEWAY_TIMEOUT = 504,
-    HTTP_VERSION_NOT_SUPPORTED = 505
-}
+export declare enum HttpStatus {
+    CONTINUE = 100,
+    SWITCHING_PROTOCOLS = 101,
+    PROCESSING = 102,
+    EARLYHINTS = 103,
+    OK = 200,
+    CREATED = 201,
+    ACCEPTED = 202,
+    NON_AUTHORITATIVE_INFORMATION = 203,
+    NO_CONTENT = 204,
+    RESET_CONTENT = 205,
+    PARTIAL_CONTENT = 206,
+    AMBIGUOUS = 300,
+    MOVED_PERMANENTLY = 301,
+    FOUND = 302,
+    SEE_OTHER = 303,
+    NOT_MODIFIED = 304,
+    TEMPORARY_REDIRECT = 307,
+    PERMANENT_REDIRECT = 308,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    NOT_ACCEPTABLE = 406,
+    PROXY_AUTHENTICATION_REQUIRED = 407,
+    REQUEST_TIMEOUT = 408,
+    CONFLICT = 409,
+    GONE = 410,
+    LENGTH_REQUIRED = 411,
+    PRECONDITION_FAILED = 412,
+    PAYLOAD_TOO_LARGE = 413,
+    URI_TOO_LONG = 414,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    REQUESTED_RANGE_NOT_SATISFIABLE = 416,
+    EXPECTATION_FAILED = 417,
+    I_AM_A_TEAPOT = 418,
+    MISDIRECTED = 421,
+    UNPROCESSABLE_ENTITY = 422,
+    FAILED_DEPENDENCY = 424,
+    PRECONDITION_REQUIRED = 428,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_SERVER_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504,
+    HTTP_VERSION_NOT_SUPPORTED = 505
+}

package/dist/common/src/index.d.ts

@@ -1,54 +1,54 @@
-export * from './ai-assistant.schemas';
-export * from './ai-assistant.types';
-export * from './api-call.context';
-export * from './api.types';
-export * from './application.schemas';
-export * from './application.types';
-export * from './auth.types';
-export * from './backend-function.schemas';
-export * from './backend-function.types';
-export * from './backend-run.types';
-export * from './bundle-api.types';
-export * from './bundle-data.types';
-export * from './communication.types';
-export * from './context.types';
-export * from './distributed-lock.context';
-export * from './document.types';
-export * from './graphql.context';
-export * from './graphql.types';
-export * from './http-status.enum';
-export * from './integrations';
-export * from './logger.types';
-export * from './metrics.types';
-export * from './mutation.context';
-export * from './mutation.schemas';
-export * from './mutation.types';
-export * from './named-query.context';
-export * from './named-query.schemas';
-export * from './named-query.types';
-export * from './query';
-export * from './query.schemas';
-export * from './query.types';
-export * from './regions';
-export * from './schema/schema.types';
-export * from './secret.schemas';
-export * from './secret.types';
-export * from './security.types';
-export * from './socket.schemas';
-export * from './socket.types';
-export * from './time-units';
-export * from './trigger.types';
-export * from './types';
-export * from './utils/array';
-export * from './utils/assert';
-export * from './utils/error';
-export * from './utils/http';
-export * from './utils/id';
-export * from './utils/lock.manager';
-export * from './utils/nullish';
-export * from './utils/object';
-export * from './utils/serialization';
-export * from './utils/transforms';
-export * from './utils/url';
-export * from './utils/validation';
-export * from './webhook-response';
+export * from './ai-assistant.schemas';
+export * from './ai-assistant.types';
+export * from './api-call.context';
+export * from './api.types';
+export * from './application.schemas';
+export * from './application.types';
+export * from './auth.types';
+export * from './backend-function.schemas';
+export * from './backend-function.types';
+export * from './backend-run.types';
+export * from './bundle-api.types';
+export * from './bundle-data.types';
+export * from './communication.types';
+export * from './context.types';
+export * from './distributed-lock.context';
+export * from './document.types';
+export * from './graphql.context';
+export * from './graphql.types';
+export * from './http-status.enum';
+export * from './integrations';
+export * from './logger.types';
+export * from './metrics.types';
+export * from './mutation.context';
+export * from './mutation.schemas';
+export * from './mutation.types';
+export * from './named-query.context';
+export * from './named-query.schemas';
+export * from './named-query.types';
+export * from './query';
+export * from './query.schemas';
+export * from './query.types';
+export * from './regions';
+export * from './schema/schema.types';
+export * from './secret.schemas';
+export * from './secret.types';
+export * from './security.types';
+export * from './socket.schemas';
+export * from './socket.types';
+export * from './time-units';
+export * from './trigger.types';
+export * from './types';
+export * from './utils/array';
+export * from './utils/assert';
+export * from './utils/error';
+export * from './utils/http';
+export * from './utils/id';
+export * from './utils/lock.manager';
+export * from './utils/nullish';
+export * from './utils/object';
+export * from './utils/serialization';
+export * from './utils/transforms';
+export * from './utils/url';
+export * from './utils/validation';
+export * from './webhook-response';

package/dist/common/src/integrations/ai_assistant.types.d.ts

@@ -1,30 +1,30 @@
-import { BaseIntegrationConfig, IntegrationType } from './index';
-import { IntegrationId } from '../communication.types';
-export interface AiAssistantIntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.ai_assistant;
-    configuration: AiAssistantConfiguration;
-    schema: IntegrationAiAssistantSchema;
-}
-export type AiAssistantConfiguration = {
-    apiKey?: string;
-};
-export type AiAssistantProfile = {
-    modelName: string;
-    strictContext: boolean;
-    instructions: Record<string, string>;
-    contexts: Record<string, AiAssistantContext>;
-};
-export type AiAssistantContext = {
-    title: string;
-    text: string;
-    preview: boolean;
-};
-export interface IntegrationAiAssistantSchema {
-    profiles: Record<string, AiAssistantProfile>;
-}
-export interface DiscoverAiAssistantSchemaRequest {
-    integrationId: IntegrationId;
-}
-export interface DiscoverAiAssistantSchemaResponse {
-    schema: IntegrationAiAssistantSchema;
-}
+import { BaseIntegrationConfig, IntegrationType } from './index';
+import { IntegrationId } from '../communication.types';
+export interface AiAssistantIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.ai_assistant;
+    configuration: AiAssistantConfiguration;
+    schema: IntegrationAiAssistantSchema;
+}
+export type AiAssistantConfiguration = {
+    apiKey?: string;
+};
+export type AiAssistantProfile = {
+    modelName: string;
+    strictContext: boolean;
+    instructions: Record<string, string>;
+    contexts: Record<string, AiAssistantContext>;
+};
+export type AiAssistantContext = {
+    title: string;
+    text: string;
+    preview: boolean;
+};
+export interface IntegrationAiAssistantSchema {
+    profiles: Record<string, AiAssistantProfile>;
+}
+export interface DiscoverAiAssistantSchemaRequest {
+    integrationId: IntegrationId;
+}
+export interface DiscoverAiAssistantSchemaResponse {
+    schema: IntegrationAiAssistantSchema;
+}