@squidcloud/client 1.0.46 → 1.0.48

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

@@ -1,6 +1,7 @@
 import { ClientId, ClientRequestId, IntegrationId } from './communication.types';
 import { ApiEndpointId, HttpMethod } from './integration.types';
 export type ApiHeaders = Record<string, string | number | boolean>;
+export type ApiQueryParams = Record<string, string | number | boolean>;
 export interface CallApiRequest {
     integrationId: IntegrationId;
     clientId: ClientId;
@@ -11,7 +12,7 @@ export interface CallApiRequest {
 }
 export interface ExtractedApiParams {
     headers: ApiHeaders;
-    queryParams: Record<string, string | number | boolean>;
+    queryParams: ApiQueryParams;
     body: Record<string, any>;
     pathParams: Record<string, string>;
 }

package/dist/common/src/backend-run.types.d.ts

@@ -22,7 +22,7 @@ export interface LoadJsPayload {
     codeUrl: string;
 }
 export declare const executeFunctionSecureAnnotationType: Array<ExecuteFunctionAnnotationType>;
-export type ExecuteFunctionSecureAnnotationType = 'secureQuery' | 'secureMutation' | 'secureNamedQuery' | 'secureGraphQL' | 'secureApi';
+export type ExecuteFunctionSecureAnnotationType = 'secureDistributedLock' | 'secureQuery' | 'secureMutation' | 'secureNamedQuery' | 'secureGraphQL' | 'secureApi';
 export type ExecuteFunctionAnnotationType = 'executable' | 'webhook' | 'scheduler' | 'trigger' | 'transformRead' | 'transformWrite' | 'metadata' | ExecuteFunctionSecureAnnotationType;
 export interface ExecuteFunctionPayload {
     functionName: string;

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

@@ -9,6 +9,7 @@ import { SecretKey } from './secret.types';
 import { ApiCallContext } from './api-call.context';
 import { NamedQueryContext } from './named-query.context';
 import { GraphqlContext } from './graphql.context';
+import { DistributedLockContext } from './distributed-lock.context';
 export type DocHash = string;
 export type SecurityResponse = {
     docsToHash: Record<SquidDocId, DocHash | undefined>;
@@ -27,6 +28,7 @@ export interface ServiceConfig {
 export type SecureDatabaseAction<T extends ActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'read' ? (context?: QueryContext) => boolean | Promise<boolean> : (context?: MutationContext) => boolean | Promise<boolean>;
 export type SecureApiAction = (context?: ApiCallContext) => boolean | Promise<boolean>;
 export type SecureNamedQueryAction = (context?: NamedQueryContext) => boolean | Promise<boolean>;
+export type SecureDistributedLockAction = (context?: DistributedLockContext) => boolean | Promise<boolean>;
 export type SecureGraphQLAction = (context?: GraphqlContext) => boolean | Promise<boolean>;
 export type TransformDatabaseAction<T extends ActionType> = T extends 'read' ? (request?: TransformDatabaseReadRequest) => TransformDatabaseReadResponse | Promise<TransformDatabaseReadResponse> : (request?: TransformDatabaseWriteRequest) => TransformDatabaseWriteResponse | Promise<TransformDatabaseWriteResponse>;
 export interface TransformDatabaseReadRequest {

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

@@ -17,6 +17,12 @@ export interface ApplicationBundleData {
     schedulers: Record<SchedulerId, SchedulerConfig>;
     webhooks: Record<WebhookId, WebhookConfig>;
     namedQueries: Record<IntegrationId, Record<QueryName, NamedQueryMetadata>>;
+    distributedLocks: {
+        security?: Array<ServiceFunctionName>;
+        mutexes?: Record<string, {
+            security?: Array<ServiceFunctionName>;
+        }>;
+    };
 }
 export interface DatabaseMetadata {
     collections: Record<CollectionName, CollectionMetadata>;

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

@@ -0,0 +1,5 @@
+export declare class DistributedLockContext {
+    readonly mutex: string;
+    readonly exclusive: boolean;
+    constructor(mutex: string, exclusive: boolean);
+}

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

@@ -1,6 +1,6 @@
 import { IntegrationId } from './communication.types';
 export type FieldName<T = any> = string & keyof T;
-export type PrimitiveFieldType = string | number | boolean | null;
+export type PrimitiveFieldType = string | number | boolean | null | Date;
 export type FieldType = PrimitiveFieldType | Array<FieldType> | {
     [key: string]: FieldType;
 };

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

@@ -1,9 +1,5 @@
 import { IntrospectionQuery } from 'graphql';
-import { ApiHeaders } from './api.types';
 export { ExecutionResult, IntrospectionQuery } from 'graphql';
-export interface ExtractedGraphQLParams {
-    headers: ApiHeaders;
-}
 export interface GraphQLRequest {
     operationName?: string;
     query?: string;
@@ -11,6 +7,5 @@ export interface GraphQLRequest {
 }
 export interface SecureGraphQLRequest extends GraphQLRequest {
     isGraphiQL: boolean;
-    headers: ApiHeaders;
 }
 export declare const EmptyIntrospection: IntrospectionQuery;

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

@@ -9,6 +9,7 @@ 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';
@@ -38,12 +39,13 @@ 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/http';
+export * from './utils/url';
 export * from './utils/validation';
 export * from './webhook-response';

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

@@ -58,7 +58,9 @@ export interface PostgresConnectionOptions {
 }
 export interface GraphQLConnectionOptions {
     baseUrl: string;
+    injectionSchema?: ApiInjectionSchema;
 }
+export type ApiInjectionSchema = Record<FieldName, ApiInjectionField>;
 export interface OpenApiDiscoveryOptions {
     openApiSpecUrl: string;
 }
@@ -74,6 +76,11 @@ export interface SnowflakeConnectionOptions {
     warehouse: string;
     role: string;
 }
+export declare enum IntegrationCategory {
+    'database' = "database",
+    'api' = "api",
+    'observability' = "observability"
+}
 export declare enum IntegrationType {
     'built_in_db' = "built_in_db",
     'mongo' = "mongo",
@@ -96,12 +103,11 @@ export interface IntegrationDataSchema {
 }
 export interface IntegrationGraphQLSchema {
     introspection: IntrospectionQuery;
-    injectionSchema?: Record<FieldName, ApiInjectionField>;
 }
 export interface IntegrationApiSchema {
     baseUrl: string;
     endpoints: IntegrationApiEndpoints;
-    injectionSchema?: Record<FieldName, ApiInjectionField>;
+    injectionSchema?: ApiInjectionSchema;
 }
 export type IntegrationApiEndpoints = Record<ApiEndpointId, ApiEndpoint>;
 export type IntegrationSchema = IntegrationDataSchema | IntegrationGraphQLSchema;
@@ -143,7 +149,7 @@ export type HttpMethod = 'post' | 'get' | 'delete' | 'patch' | 'put';
 export type ApiEndpointId = string;
 export type ApiParameterLocation = 'query' | 'body' | 'header' | 'path';
 export type ApiResponseParameterLocation = 'header' | 'body';
-export type ApiInjectionParameterLocation = 'header';
+export type ApiInjectionParameterLocation = 'header' | 'query';
 export type FieldPath = string;
 export interface ApiRequestField {
     location: ApiParameterLocation;
@@ -163,7 +169,7 @@ export interface ApiEndpoint {
     method: HttpMethod;
     requestSchema?: Record<FieldName, ApiRequestField>;
     responseSchema?: Record<FieldPath, ApiResponseField>;
-    injectionSchema?: Record<FieldName, ApiInjectionField>;
+    injectionSchema?: ApiInjectionSchema;
 }
 export interface ApiIntegrationConfig extends BaseIntegrationConfig {
     type: IntegrationType.api;
@@ -269,7 +275,14 @@ interface TestCockroachDataConnectionRequest {
         connectionOptions: PostgresConnectionOptions;
     };
 }
+export interface TestGraphQLDataConnectionRequest {
+    type: IntegrationType.graphql;
+    configuration: {
+        connectionOptions: GraphQLConnectionOptions;
+    };
+}
 export type TestDataConnectionRequest = TestMongoDataConnectionRequest | TestMysqlDataConnectionRequest | TestMssqlDataConnectionRequest | TestCockroachDataConnectionRequest | TestPostgresDataConnectionRequest | TestSnowflakeDataConnectionRequest;
+export type TestConnectionRequest = TestDataConnectionRequest | TestGraphQLDataConnectionRequest;
 export interface DiscoverDataConnectionSchemaResponse {
     schema: IntegrationDataSchema;
 }

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

@@ -2,7 +2,7 @@ import { ClientId, ClientRequestId, IntegrationId } from './communication.types'
 import { CollectionName, DocTimestamp, SquidDocId, SquidDocument } from './document.types';
 import { MutationType } from './mutation.types';
 export type MessageId = string;
-export type MessageFromClientType = 'acknowledge' | 'catchup' | 'kill';
+export type MessageFromClientType = 'acknowledge' | 'catchup' | 'kill' | 'acquireLock' | 'releaseLock';
 interface BaseMessageFromClient {
     type: MessageFromClientType;
     payload?: unknown;
@@ -17,8 +17,23 @@ export interface CatchupMessage extends BaseMessageFromClient {
 export interface KillMessage extends BaseMessageFromClient {
     type: 'kill';
 }
-export type MessageFromClient = AcknowledgeMessage | CatchupMessage | KillMessage;
-export type MessageToClientType = 'mutations' | 'query' | 'backendFunction' | 'api' | 'namedQuery';
+export interface AcquireLockMessage extends BaseMessageFromClient {
+    type: 'acquireLock';
+    payload: {
+        mutex: string;
+        exclusive: boolean;
+        clientRequestId: ClientRequestId;
+    };
+}
+export interface ReleaseLockMessage extends BaseMessageFromClient {
+    type: 'releaseLock';
+    payload: {
+        lockId: string;
+        clientRequestId: ClientRequestId;
+    };
+}
+export type MessageFromClient = AcknowledgeMessage | CatchupMessage | KillMessage | AcquireLockMessage | ReleaseLockMessage;
+export type MessageToClientType = 'mutations' | 'query' | 'backendFunction' | 'api' | 'namedQuery' | 'lockAcquired' | 'lockReleased';
 interface BaseMessageToClient {
     type: MessageToClientType;
     messageId: MessageId;
@@ -41,7 +56,22 @@ export interface ApiResponseMessageToClient extends BaseMessageToClient {
     httpStatus: number;
     payload: string;
 }
-export type MessageToClient = MutationsMessageToClient | QueryResultMessageToClient | BackendFunctionMessageToClient | NamedQueryMessageToClient | ApiResponseMessageToClient;
+export interface LockAcquiredResponseMessageToClient extends BaseMessageToClient {
+    type: 'lockAcquired';
+    payload: {
+        clientRequestId: ClientRequestId;
+        lockId: string | undefined;
+        error?: string;
+    };
+}
+export interface LockReleasedResponseMessageToClient extends BaseMessageToClient {
+    type: 'lockReleased';
+    payload: {
+        clientRequestId: ClientRequestId;
+        lockId: string;
+    };
+}
+export type MessageToClient = MutationsMessageToClient | QueryResultMessageToClient | BackendFunctionMessageToClient | NamedQueryMessageToClient | ApiResponseMessageToClient | LockAcquiredResponseMessageToClient | LockReleasedResponseMessageToClient;
 export interface MutationsMessageToClient extends BaseMessageToClient {
     type: 'mutations';
     payload: Array<MutationResultData>;

package/dist/common/src/utils/url.d.ts

@@ -0,0 +1 @@
+export declare function appendQueryParams(url: string, queryParams: Record<string, any>): string;