@squidcloud/backend 1.0.0 → 1.0.2

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

@@ -1,6 +1,8 @@
 import { JSONSchema } from 'json-schema-typed';
 export type FieldPlaceholder = '__SQUID_SERVER_TIMESTAMP__' | '__SQUID_CLIENT_IP__' | '__SQUID_USER_ID__' | '__SQUID_API_KEY__';
-export type SupportedFieldType = 'string' | 'integer' | 'number' | 'date' | 'boolean' | 'map' | 'array' | 'any';
+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>>;
@@ -13,6 +15,7 @@ type ConvertDeep<T extends JSONSchema> = Exclude<T, boolean> & {
      */
     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.
@@ -24,6 +27,22 @@ type ConvertDeep<T extends JSONSchema> = Exclude<T, 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>;

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

@@ -18,7 +18,15 @@ export interface SecretEntry extends SecretMetadata {
     value: SecretValue;
 }
 export type SetCustomSecretRequest = Omit<SecretEntry, 'lastUpdated'>;
-export type DeleteCustomSecretRequest = Pick<SecretMetadata, 'key'>;
+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[];

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

@@ -1,5 +1,5 @@
 import { ClientId, ClientRequestId, IntegrationId } from './communication.types';
-import { CollectionName, DocTimestamp, DocType, FullDocIdStr } from './document.types';
+import { CollectionName, DocTimestamp, SquidDocId, SquidDocument } from './document.types';
 import { MutationType } from './mutation.types';
 export type MessageId = string;
 export type MessageFromClientType = 'acknowledge' | 'catchup' | 'kill';
@@ -47,14 +47,14 @@ export interface MutationsMessageToClient extends BaseMessageToClient {
     payload: Array<MutationResultData>;
 }
 export interface MutationResultData {
-    fullDocIdStr: FullDocIdStr;
+    squidDocId: SquidDocId;
     clientRequestId: ClientRequestId;
     mutationType: MutationType;
     mutationTimestamp: DocTimestamp;
-    doc: DocType | undefined;
+    doc: SquidDocument | undefined;
 }
 export interface QueryResultData {
-    docs: Array<DocType>;
+    docs: Array<SquidDocument>;
     integrationId: IntegrationId;
     collectionName: CollectionName;
     clientRequestId: ClientRequestId;

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

@@ -1,14 +1,12 @@
 import { ServiceFunctionName } from './bundle-data.types';
 import { AppId } from './communication.types';
-import { Auth } from './context.types';
-import { DocType, FullDocIdStr } from './document.types';
+import { SquidDocId, SquidDocument } from './document.types';
 import { MutationType } from './mutation.types';
 export interface DocTriggerParams {
-    fullDocId: FullDocIdStr;
+    squidDocId: SquidDocId;
     mutationType: MutationType;
-    docBefore?: DocType;
-    docAfter?: DocType;
-    auth: Auth | undefined;
+    docBefore?: SquidDocument;
+    docAfter?: SquidDocument;
 }
 export interface TriggerMessage {
     params: DocTriggerParams;

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

@@ -1,6 +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 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 validateTruthy<T>(value: T, message: string, statusCode?: StatusCode, details?: Record<string, any>): NonNullable<T>;

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

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

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

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

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

@@ -1,4 +1,6 @@
-export declare function getInPath(obj: any, path: string): any;
-export declare function setInPath(obj: any, path: string, value: any): void;
-export declare function deleteInPath(obj: any, path: string): void;
+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

@@ -3,3 +3,4 @@ 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

@@ -0,0 +1,18 @@
+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 +1 @@
-export declare function getApplicationUrl(baseUrl: string, appId: string): string;
+export declare function getApplicationUrl(regionPrefix: string, appId: string): string;