@squidcloud/backend 1.0.2 → 1.0.4

package/dist/backend/src/actions.d.ts

@@ -1,13 +1,13 @@
-import { ActionMethodDecorator, ActionType, ApiEndpointId, CollectionName, CronExpression, ExecutableAction, IntegrationId, QueryName, SchedulerAction, SchedulerId, SecureApiAction, SecureDatabaseAction, SecureExecutableAction, SecureGraphQLAction, SecureNamedQueryAction, TransformDatabaseAction, TriggerAction, TriggerId, WebhookAction, WebhookId } from '@squidcloud/common';
+import { ActionMethodDecorator, ActionType, ApiEndpointId, CollectionName, CronExpression, CronExpressionString, ExecutableAction, IntegrationId, QueryName, SchedulerAction, SchedulerId, SecureApiAction, SecureDatabaseAction, SecureExecutableAction, SecureGraphQLAction, SecureNamedQueryAction, TransformDatabaseAction, TriggerAction, TriggerId, WebhookAction, WebhookId } from '@squidcloud/common';
 export declare function secureDatabase<T extends ActionType>(type: T, integrationId?: IntegrationId): ActionMethodDecorator<SecureDatabaseAction<T>>;
 export declare function secureCollection<T extends ActionType>(collectionName: CollectionName, type: T, integrationId?: IntegrationId): ActionMethodDecorator<SecureDatabaseAction<T>>;
 export declare function secureExecutable(executable: string): ActionMethodDecorator<SecureExecutableAction>;
-export declare function secureApi<T extends SecureApiAction>(endpointId: ApiEndpointId, integrationId: IntegrationId): ActionMethodDecorator<SecureApiAction>;
+export declare function secureApi<T extends SecureApiAction>(integrationId: IntegrationId, endpointId?: ApiEndpointId): ActionMethodDecorator<SecureApiAction>;
 export declare function secureGraphQL<T extends SecureGraphQLAction>(integrationId: IntegrationId): ActionMethodDecorator<SecureGraphQLAction>;
 export declare function transformCollection<T extends ActionType>(collectionName: CollectionName, type: T, integrationId?: IntegrationId): ActionMethodDecorator<TransformDatabaseAction<T>>;
 export declare function executable(): ActionMethodDecorator<ExecutableAction>;
 export declare function trigger(id: TriggerId, collectionName: CollectionName, integrationId?: IntegrationId): ActionMethodDecorator<TriggerAction>;
-export declare function scheduler(id: SchedulerId, cronExpression: CronExpression): ActionMethodDecorator<SchedulerAction>;
+export declare function scheduler(id: SchedulerId, cronExpression: CronExpression | CronExpressionString): ActionMethodDecorator<SchedulerAction>;
 export declare function webhook(id: WebhookId): ActionMethodDecorator<WebhookAction>;
 export declare function namedQuery(integrationId: string, name: string): any;
 export declare function secureNamedQuery<T extends SecureNamedQueryAction>(integrationId: IntegrationId, queryName: QueryName): ActionMethodDecorator<SecureNamedQueryAction>;

package/dist/backend/src/metadata.d.ts

@@ -1,4 +1,4 @@
-import { ActionType, ApiEndpointId, ApplicationBundleData, CollectionName, CronExpression, FunctionName, IntegrationId, QueryName, SchedulerId, ServiceFunctionName, TriggerId, WebhookId } from '@squidcloud/common';
+import { ActionType, ApiEndpointId, ApplicationBundleData, CollectionName, FunctionName, IntegrationId, QueryName, SchedulerId, ServiceFunctionName, TriggerId, WebhookId } from '@squidcloud/common';
 declare class Meta {
     data: ApplicationBundleData;
     /**
@@ -55,7 +55,7 @@ declare class Meta {
      */
     secureExecutable(executable: FunctionName, serviceFunction: ServiceFunctionName): void;
     /**
-     * @secureApi("myEndpoint", "ExampleIntegration")
+     * @secureApi("ExampleIntegration", "myEndpoint")
      *
      * Applying the decorator above to the myMethod method on the MyService
      * class will generate the following metadata:
@@ -70,7 +70,7 @@ declare class Meta {
      *   }
      * }
      */
-    secureApi(endpointId: ApiEndpointId, integrationId: IntegrationId, serviceFunction: ServiceFunctionName): void;
+    secureApi(integrationId: IntegrationId, endpointId: ApiEndpointId | undefined, serviceFunction: ServiceFunctionName): void;
     /**
      * @secureGraphQL("ExampleIntegration")
      *
@@ -177,7 +177,7 @@ declare class Meta {
      *   }
      * }
      */
-    scheduler(id: SchedulerId, cronExpression: CronExpression, serviceFunction: ServiceFunctionName): void;
+    scheduler(id: SchedulerId, cronExpression: string, serviceFunction: ServiceFunctionName): void;
     /**
      * @webhook("my-webhook")
      *

package/dist/backend/src/service.d.ts

@@ -1,5 +1,5 @@
 import { Squid } from '@squidcloud/client';
-import { AuthWithApiKey, AuthWithBearer, Logger, RunContext, SecretKey, SecretValue, ServiceConfig, SquidRegion } from '@squidcloud/common';
+import { AuthWithApiKey, AuthWithBearer, Logger, RunContext, SecretKey, SecretValue, ServiceConfig, SquidRegion, WebhookResponse } from '@squidcloud/common';
 export declare class SquidService {
     readonly secrets: Record<SecretKey, SecretValue>;
     readonly logger: Logger;
@@ -14,4 +14,5 @@ export declare class SquidService {
     getUserAuth(): AuthWithBearer | undefined;
     getApiKeyAuth(): AuthWithApiKey | undefined;
     isAuthenticated(): boolean;
+    createWebhookResponse(body?: any, statusCode?: number, headers?: Record<string, any>): WebhookResponse;
 }

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

@@ -6,7 +6,92 @@ export type WebhookId = string;
 export type QueryName = string;
 export type TriggerId = string;
 export type SchedulerId = string;
-export type CronExpression = string;
+export type CronExpressionString = `${string} ${string} ${string} ${string} ${string}` | `${string} ${string} ${string} ${string}`;
+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 * * 0",
+    EVERY_WEEKDAY = "0 0 * * 1-5",
+    EVERY_WEEKEND = "0 0 * * 6,0",
+    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 0 *",
+    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"
+}
 export type OpenIdProviderType = 'auth0';
 export type CodeUrl = string;
 export interface TriggerConfig {
@@ -16,7 +101,7 @@ export interface TriggerConfig {
 }
 export interface SchedulerConfig {
     functionName: ServiceFunctionName;
-    cronExpression: CronExpression;
+    cronExpression: string;
 }
 export interface WebhookConfig {
     functionName: ServiceFunctionName;

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

@@ -8,7 +8,9 @@ export type FunctionName = string;
 export type ServiceFunctionName = `${ServiceName}:${FunctionName}`;
 export interface ApplicationBundleData {
     databases: Record<IntegrationId, DatabaseMetadata>;
-    apis: Record<ApiEndpointId, ApiMetadata>;
+    apis: Record<IntegrationId, {
+        endpoints: Record<ApiEndpointId, ApiMetadata>;
+    } & ApiMetadata>;
     graphql: Record<IntegrationId, GraphQLMetadata>;
     executables: Record<FunctionName, ExecutableMetadata>;
     triggers: Record<TriggerId, TriggerConfig>;

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

@@ -27,3 +27,9 @@ 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;

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

@@ -1,13 +1,17 @@
+export * from './api-call.context';
 export * from './api.types';
 export * from './application.schemas';
 export * from './application.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 './document.types';
+export * from './executable.context';
+export * from './graphql.context';
 export * from './graphql.types';
 export * from './http-status.enum';
 export * from './integration.types';
@@ -15,12 +19,9 @@ export * from './logger.types';
 export * from './metrics.schemas';
 export * from './metrics.types';
 export * from './mutation.context';
-export * from './named-query.context';
-export * from './graphql.context';
-export * from './executable.context';
-export * from './api-call.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';
@@ -34,16 +35,16 @@ export * from './socket.schemas';
 export * from './socket.types';
 export * from './time-units';
 export * from './trigger.types';
-export * from './backend-run.types';
 export * from './types';
 export * from './utils/array';
 export * from './utils/assert';
 export * from './utils/error';
 export * from './utils/id';
-export * from './utils/isDefined';
 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/mutation.types.d.ts

@@ -10,7 +10,9 @@ export interface ExecuteMutationsResponse {
     idResolutionMap?: IdResolutionMap;
     afterDocs: Record<SquidDocId, SquidDocument>;
 }
-export type MutateResponse = Omit<ExecuteMutationsResponse, 'afterDocs'>;
+export interface MutateResponse extends Omit<ExecuteMutationsResponse, 'afterDocs'> {
+    refreshList: Array<SquidDocId>;
+}
 export type IdResolutionMap = Record<SquidDocId, SquidDocId>;
 export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
 export type MutationType = 'insert' | 'update' | 'delete';

package/dist/common/src/query/query-context.d.ts

@@ -1,7 +1,7 @@
 import { IntegrationId } from '../communication.types';
 import { CollectionName, FieldName } from '../document.types';
 import { AllOperators, ContextCondition, ContextConditions, FieldSort, GeneralCondition, GeneralConditions, GenericValue, Query } from '../query.types';
-import { Paths } from '../types';
+import { PartialBy, Paths } from '../types';
 export declare class QueryContext<T = any> {
     readonly query: Query<T>;
     private readonly parsedConditions;
@@ -9,8 +9,8 @@ export declare class QueryContext<T = any> {
     get integrationId(): IntegrationId;
     get collectionName(): CollectionName;
     get limit(): number;
-    includesSorts(sorts: Array<FieldSort<T>>): boolean;
-    matchesSorts(sorts: Array<FieldSort<T>>): boolean;
+    sortedBy(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
+    sortedByExact(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
     includes<F extends FieldName<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O>): boolean;
     includesCondition(condition: ContextCondition<T>): boolean;
     includesConditions(conditions: GeneralConditions<T>): boolean;

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

@@ -7,6 +7,7 @@ export declare const SUPPORTED_FIELD_TYPES_ARRAY: Array<SupportedFieldType>;
 type ConvertDeep<T extends JSONSchema> = Exclude<T, boolean> & {
     properties?: Record<string, ConvertDeep<JSONSchema>>;
     patternProperties?: Record<string, ConvertDeep<JSONSchema>>;
+    nullable?: boolean;
     /**
      * The default value will be applied (default to 'empty'):
      * 'always' - no matter what the client sent, both on update and insert. In case of readOnly - applies only on insert.

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

@@ -5,3 +5,4 @@ export interface Grouped<T> {
     [key: string]: T[];
 }
 export declare function asyncGroupBy<T>(arr: T[], groupNamer: (element: T) => Promise<string>): Promise<Grouped<T>>;
+export declare const arrayMergeCustomizer: (a: any, b: any) => Array<any> | undefined;

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

@@ -1,8 +1,8 @@
 import { StatusCode } from './validation';
 export type AssertErrorProvider = () => Error | string;
 export declare function assertTruthy(value: unknown, error?: string | Error | AssertErrorProvider): asserts value;
-export declare function assertDefined(value: unknown, error?: string | Error | AssertErrorProvider): asserts value;
+export declare function assertNotNullish(value: unknown, error?: string | Error | AssertErrorProvider): asserts value;
 export declare function assertValidateTruthy(value: unknown, message: string, statusCode?: StatusCode, details?: Record<string, any>): asserts value;
 export declare function truthy<T>(value: T, error?: string | Error | AssertErrorProvider): NonNullable<T>;
-export declare function defined<T>(value: T, error?: string | Error | AssertErrorProvider): NonNullable<T>;
+export declare function notNullish<T>(value: T, error?: string | Error | AssertErrorProvider): NonNullable<T>;
 export declare function validateTruthy<T>(value: T, message: string, statusCode?: StatusCode, details?: Record<string, any>): NonNullable<T>;

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

@@ -0,0 +1 @@
+export declare function isNotNullish<T>(t: T | undefined | null): t is T;

package/dist/common/src/webhook-response.d.ts

@@ -0,0 +1,7 @@
+export interface WebhookResponse {
+    headers: Record<string, any>;
+    body: any;
+    statusCode: number;
+    __isWebhookResponse__: true;
+}
+export declare function isWebhookResponse(response: any): response is WebhookResponse;