@squidcloud/backend 1.0.8 → 1.0.9

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

@@ -1,54 +0,0 @@
-import { JSONSchema } from 'json-schema-typed';
-export type FieldPlaceholder = '__SQUID_SERVER_TIMESTAMP__' | '__SQUID_CLIENT_IP__' | '__SQUID_USER_ID__' | '__SQUID_API_KEY__';
-export type BasicFieldType = 'string' | 'integer' | 'number' | 'boolean' | 'map' | 'array' | 'any';
-export type CustomFieldType = 'date' | 'json';
-export type SupportedFieldType = BasicFieldType | CustomFieldType;
-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.
-     * 'empty' - only if the value of the filed is empty (undefined)
-     * 'updateOrEmpty' - no matter what the client sent, updating the record will use the default value
-     */
-    applyDefaultValueOn?: 'always' | 'empty' | 'updateOrEmpty';
-    isDate?: boolean;
-    isJSON?: boolean;
-    /**
-     * Applies to the top level schema, a record in a nested object, or a regular property.
-     * Basically, whether this property can participate in an insert mutation.
-     */
-    insertable?: boolean;
-    /** Applies to the top level schema or a record in a nested object. */
-    deletable?: boolean;
-};
-export type PropertySchema = ConvertDeep<JSONSchema>;
-export type TopLevelPropertySchema = PropertySchema & {
-    primaryKey?: boolean;
-    /**
-     * Whether the property is computed based on other properties or some formula.
-     * If true, readonly also needs to be true and this field should not be part of an insert statement.
-     */
-    isComputed?: boolean;
-    /**
-     * Whether the default value generated by the database. CURRENT_DATE is something generated by the database vs
-     * 'Hello' which is a constant.
-     */
-    isDefaultComputed?: boolean;
-    /**
-     * The database data type that is represented by this property. This is often different from the actual property
-     * type, with is a Javascript primitive. For example, for a SMALLINT the dataType would be 'smallint', but the type
-     * would be 'integer'.
-     */
-    dataType?: string;
-};
-export type CollectionSchema = ConvertDeep<JSONSchema> & {
-    properties?: Record<string, TopLevelPropertySchema>;
-};
-export declare function compileSchema<S extends CollectionSchema>(schema: S): any;
-export declare function validateSchema<S extends CollectionSchema>(schema: S, data: any, updatedPaths?: Array<string>, dataBefore?: any): void;
-export declare function findMatchingPropertiesForKey<S extends CollectionSchema | PropertySchema>(schema: S, key: string): Array<PropertySchema>;
-export {};

package/dist/common/src/secret.schemas.d.ts

@@ -1,6 +0,0 @@
-import { JSONSchemaType } from 'ajv';
-import { DeleteApiKeyRequest, DeleteCustomSecretRequest, GenerateNewApiKeyRequest, SetCustomSecretRequest } from './secret.types';
-export declare const SetCustomSecretRequestSchema: JSONSchemaType<SetCustomSecretRequest>;
-export declare const DeleteCustomSecretRequestSchema: JSONSchemaType<DeleteCustomSecretRequest>;
-export declare const DeleteApiKeyRequestSchema: JSONSchemaType<DeleteApiKeyRequest>;
-export declare const GenerateNewApiKeyRequestSchema: JSONSchemaType<GenerateNewApiKeyRequest>;

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

@@ -1,38 +0,0 @@
-export type SecretKey = string;
-export type SecretValue = string | number | boolean;
-export type SecretTimestamp = number;
-export type ApiKeyName = string;
-export type ApiKey = string;
-export interface ApplicationSecrets {
-    custom: Record<SecretKey, SecretEntry>;
-    apiKeys: Record<SecretKey, SecretEntry>;
-}
-export interface SystemSecrets {
-    sharedMongo: Record<SecretKey, SecretValue>;
-}
-export interface SecretMetadata {
-    key: SecretKey;
-    lastUpdated: SecretTimestamp;
-}
-export interface SecretEntry extends SecretMetadata {
-    value: SecretValue;
-}
-export type SetCustomSecretRequest = Omit<SecretEntry, 'lastUpdated'>;
-export interface DeleteCustomSecretRequest {
-    key: SecretKey;
-}
-export interface GetApiKeyRequest {
-    apiKeyName: ApiKeyName;
-}
-export interface GetApiKeyResponse {
-    apiKey: string | undefined;
-}
-export type DeleteApiKeyRequest = Pick<SecretMetadata, 'key'>;
-export interface ListApplicationSecretMetadataResponse {
-    custom: SecretMetadata[];
-    apiKeys: SecretMetadata[];
-}
-export type GenerateNewApiKeyRequest = Pick<SecretMetadata, 'key'>;
-export interface GenerateNewApiKeyResponse {
-    apiKey: string;
-}

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

@@ -1,3 +0,0 @@
-import { JSONSchemaType } from 'ajv';
-import { MessageFromClient } from './socket.types';
-export declare const MessageFromClientSchema: JSONSchemaType<MessageFromClient>;

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

@@ -1,68 +0,0 @@
-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';
-interface BaseMessageFromClient {
-    type: MessageFromClientType;
-    payload?: unknown;
-}
-export interface AcknowledgeMessage extends BaseMessageFromClient {
-    type: 'acknowledge';
-    payload: Array<MessageId>;
-}
-export interface CatchupMessage extends BaseMessageFromClient {
-    type: 'catchup';
-}
-export interface KillMessage extends BaseMessageFromClient {
-    type: 'kill';
-}
-export type MessageFromClient = AcknowledgeMessage | CatchupMessage | KillMessage;
-export type MessageToClientType = 'mutations' | 'query' | 'backendFunction' | 'api' | 'namedQuery';
-interface BaseMessageToClient {
-    type: MessageToClientType;
-    messageId: MessageId;
-    payload: unknown;
-}
-export interface BackendFunctionMessageToClient extends BaseMessageToClient {
-    type: 'backendFunction';
-    clientRequestId: ClientRequestId;
-    payload: string;
-}
-export interface NamedQueryMessageToClient extends BaseMessageToClient {
-    type: 'namedQuery';
-    clientRequestId: ClientRequestId;
-    payload: string;
-}
-export interface ApiResponseMessageToClient extends BaseMessageToClient {
-    type: 'api';
-    clientRequestId: ClientRequestId;
-    success: boolean;
-    httpStatus: number;
-    payload: string;
-}
-export type MessageToClient = MutationsMessageToClient | QueryResultMessageToClient | BackendFunctionMessageToClient | NamedQueryMessageToClient | ApiResponseMessageToClient;
-export interface MutationsMessageToClient extends BaseMessageToClient {
-    type: 'mutations';
-    payload: Array<MutationResultData>;
-}
-export interface MutationResultData {
-    squidDocId: SquidDocId;
-    clientRequestId: ClientRequestId;
-    mutationType: MutationType;
-    mutationTimestamp: DocTimestamp;
-    doc: SquidDocument | undefined;
-}
-export interface QueryResultData {
-    docs: Array<SquidDocument>;
-    integrationId: IntegrationId;
-    collectionName: CollectionName;
-    clientRequestId: ClientRequestId;
-}
-export interface QueryResultMessageToClient extends BaseMessageToClient {
-    type: 'query';
-    payload: QueryResultData;
-}
-export type PendingMessage = Omit<MessageToClient, 'messageId'>;
-export type PendingMessages = Record<ClientId, Array<PendingMessage>>;
-export {};

package/dist/common/src/time-units.d.ts

@@ -1,5 +0,0 @@
-export declare const SECONDS_PER_MINUTE = 60;
-export declare const SECONDS_PER_HOUR: number;
-export declare const SECONDS_PER_DAY: number;
-export declare const SECONDS_PER_WEEK: number;
-export declare const SECONDS_PER_MONTH: number;

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

@@ -1,15 +0,0 @@
-import { ServiceFunctionName } from './bundle-data.types';
-import { AppId } from './communication.types';
-import { SquidDocId, SquidDocument } from './document.types';
-import { MutationType } from './mutation.types';
-export interface DocTriggerParams {
-    squidDocId: SquidDocId;
-    mutationType: MutationType;
-    docBefore?: SquidDocument;
-    docAfter?: SquidDocument;
-}
-export interface TriggerMessage {
-    params: DocTriggerParams;
-    functionName: ServiceFunctionName;
-    appId: AppId;
-}

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

@@ -1,15 +0,0 @@
-export interface Type<T> extends Function {
-    new (...args: any[]): T;
-}
-export type Replace<TypeToBeChecked, KeyToBeReplaced extends keyof TypeToBeChecked, NewValueToUse> = Omit<TypeToBeChecked, KeyToBeReplaced> & {
-    [P in KeyToBeReplaced]: NewValueToUse;
-};
-export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-export type WithRequired<T, K extends keyof T> = T & {
-    [P in K]-?: T[P];
-};
-type Pred = [0, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
-export type Paths<T, RemainingDepth extends number & keyof Pred = 5, Prefix extends string = ''> = RemainingDepth extends 0 ? `${Prefix}${string}` : {
-    [k in keyof T]-?: k extends string | number ? `${Prefix}${k}` | (Required<T>[k] extends any[] ? never : Required<T>[k] extends object ? Paths<Required<T>[k], Pred[RemainingDepth], `${Prefix}${k}.`> : never) : never;
-}[keyof T];
-export {};

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

@@ -1,8 +0,0 @@
-export declare function binarySearch<T>(arr: T[], key: T, comparator?: (a: T, b: T) => number, low?: number, high?: number): number;
-export declare function insertSorted<T>(arr: T[], key: T, comparator?: (a: T, b: T) => number): void;
-export declare function removeSorted<T>(arr: T[], key: T, comparator?: (a: T, b: T) => number): void;
-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 +0,0 @@
-import { StatusCode } from './validation';
-export type AssertErrorProvider = () => Error | string;
-export declare function assertTruthy(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 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/error.d.ts

@@ -1,4 +0,0 @@
-export declare class CodeExecutionError extends Error {
-    readonly details?: string | undefined;
-    constructor(error: string, details?: string | undefined);
-}

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

@@ -1 +0,0 @@
-export declare function generateId(): string;

package/dist/common/src/utils/lock.manager.d.ts

@@ -1,14 +0,0 @@
-type LockMutex = string;
-/**
- * A simple lock manager that locks a list of mutexes.
- * When locking a list of mutexes, the lock will start only when all the mutexes are available - preventing partial lock
- * and potential deadlocks.
- */
-export declare class LockManager {
-    private readonly locks;
-    lock(...mutexes: LockMutex[]): Promise<void>;
-    release(...mutexes: LockMutex[]): void;
-    canGetLock(...mutexes: LockMutex[]): boolean;
-    lockSync(...mutexes: LockMutex[]): void;
-}
-export {};

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

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

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

@@ -1,6 +0,0 @@
-export declare function getInPath(obj: any, path: string, delimiter?: string): any;
-export declare function setInPath(obj: any, path: string, value: any, delimiter?: string): void;
-export declare function deleteInPath(obj: any, path: string, delimiter?: string): void;
-export declare function deepReplace(obj: any, keyName: string, replacer: (from: any) => any): void;
-export declare function replaceKeyInMap<K, T>(map: Map<K, T | undefined>, a: K, b: K): void;
-export declare function replaceKeyInRecord<K extends keyof any, T>(record: Record<K, T>, a: K, b: K): void;

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

@@ -1,6 +0,0 @@
-export declare function normalizeJsonAsString(json: any): string;
-export declare function serializeObj(obj: any): string;
-export declare function deserializeObj<T = any>(serializedObj: string): T;
-export declare function encodeValueForMapping(value: any): string;
-export declare function decodeValueForMapping(encodedString: string): any;
-export declare function recodeValue(value: any): any;

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

@@ -1,18 +0,0 @@
-export declare function unchanged(any: any): any;
-export declare function booleanToInt(boolean: boolean): number;
-export declare function intToBoolean(int: number): boolean;
-export declare function stringToNumber(string: string): number;
-export declare function numberToString(number: number): string;
-export declare function bufferToString(buffer: ArrayBuffer): string;
-export declare function stringToBuffer(string: string): ArrayBuffer;
-export declare function stringToJSON(string: string): JSON;
-export declare function JSONToString(json: JSON): string;
-export declare function moneyStringToNumber(money: string): number;
-export declare function daysPastEpochToDate(days: number): Date;
-export declare function msToDate(ms: number): Date;
-export declare function isoStringToDate(string: string): Date;
-export declare function base64ToString(string: string): string;
-export declare function base64ToBinary(string: string): string;
-export declare function debeziumStringToInterval(string: string): Record<string, number>;
-export declare function msPastMidnightToTimeString(ms: number): string;
-export declare function dateToTimeString(date: Date): string;

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

@@ -1 +0,0 @@
-export declare function getApplicationUrl(regionPrefix: string, appId: string): string;

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

@@ -1,30 +0,0 @@
-/**
- * This file contains general validators for the different objects being received from the client. The parameters are
- * usually of type 'any' to make sure there are no assumptions that the object has the correct type.
- * Also, this file should avoid importing from other files that are not for validation to avoid circular deps.
- */
-import { OpenIdProvider } from '../application.types';
-import { HttpStatus } from '../http-status.enum';
-export type StatusCode = HttpStatus.BAD_REQUEST | HttpStatus.NOT_FOUND | HttpStatus.FORBIDDEN | HttpStatus.UNAUTHORIZED;
-export declare class ValidationError extends Error {
-    readonly statusCode: StatusCode;
-    readonly details?: any;
-    constructor(error: string, statusCode: StatusCode, details?: Record<string, any>);
-}
-export declare function validateFieldSort(fieldSort: any): void;
-export declare function validateOpenIdProvider(openIdProvider: OpenIdProvider | undefined): OpenIdProvider;
-export declare function validateOpenIdProviderType(providerType: any): void;
-export declare function validateMutations(mutations: any): void;
-export declare function validateQueryLimit(limit: any): void;
-/** Returns true if the value is not an empty string (undefined/null are considered empty). */
-export declare function isNotEmpty(value: string | undefined | null): value is string;
-/**
- * All type names returned by 'typeof' supported by JavaScript:
- * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/typeof.
- * and a few other supported types.
- */
-export type JavascriptTypeName = 'undefined' | 'object' | 'boolean' | 'number' | 'bigint' | 'string' | 'symbol' | 'function';
-/** Returns true if 'typeof' of the 'value' is 'type' or 'type[]'. */
-export declare function isRightType(value: unknown, type: JavascriptTypeName): boolean;
-/** Returns true if 'obj' has only keys listed in the 'keys'. Object can't be an array. */
-export declare function hasOnlyKeys(obj: object, keys: string[]): boolean;

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

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

package/dist/index.js.LICENSE.txt

@@ -1,38 +0,0 @@
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-
-/**
- * @license
- * Lodash <https://lodash.com/>
- * Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
- * Released under MIT license <https://lodash.com/license>
- * Based on Underscore.js 1.8.3 <http://underscorejs.org/LICENSE>
- * Copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
- */
-
-/**
- * Wrapper for built-in http.js to emulate the browser XMLHttpRequest object.
- *
- * This can be used with JS designed for browsers to improve reuse of code and
- * allow the use of existing libraries.
- *
- * Usage: include("XMLHttpRequest.js") and use XMLHttpRequest per W3C specs.
- *
- * @author Dan DeFelippi <dan@driverdan.com>
- * @contributor David Ellis <d.f.ellis@ieee.org>
- * @license MIT
- */
-
-/** @license URI.js v4.4.1 (c) 2011 Gary Court. License: http://github.com/garycourt/uri-js */