@squidcloud/client 1.0.64 → 1.0.66

package/dist/common/src/query/simple-query-builder.d.ts

@@ -1,137 +1,137 @@
-import { IntegrationId } from '../communication.types';
-import { CollectionName, DocumentData, FieldName, PrimitiveFieldType } from '../document.types';
-import { Operator, Query } from '../query.types';
-/** Base interface for a query builder. */
-export interface BaseQueryBuilderInterface<MyDocType extends DocumentData> {
-    /**
-     * Adds a condition to the query.
-     * @param fieldName The name of the field to query.
-     * @param operator The operator to use.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, '==', value)
-     *
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '!=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, 'in', value)
-     * @param fieldName The name of the field to query.
-     * @param value An array of values to compare against.
-     * @returns The query builder.
-     */
-    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, 'not in', value)
-     * @param fieldName The name of the field to query.
-     * @param value An array of values to compare against.
-     * @returns The query builder.
-     */
-    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, '>', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '>=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '<', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '<=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, 'like', pattern).
-     *
-     * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
-     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
-     * @returns The query builder.
-     */
-    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /**
-     * A shortcut for where(fieldName, 'not like', pattern).
-     *
-     * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
-     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
-     * @returns The query builder.
-     */
-    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /**
-     * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
-     * if none is provided.
-     * @param limit The limit to set.
-     * @returns The query builder.
-     */
-    limit(limit: number): this;
-    /**
-     * Adds a sort order to the query. You can add multiple sort orders to the query. The order in which you add them
-     * determines the order in which they are applied.
-     * @param fieldName The name of the field to sort by.
-     * @param asc Whether to sort in ascending order. Defaults to true.
-     * @returns The query builder.
-     */
-    sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
-}
-/** A query builder that can be used to build a query that returns a list of documents. */
-export declare class SimpleQueryBuilder<MyDocType extends DocumentData> implements BaseQueryBuilderInterface<MyDocType> {
-    protected readonly collectionName: CollectionName;
-    protected readonly integrationId: IntegrationId;
-    protected readonly query: Query<MyDocType>;
-    /** @inheritDoc */
-    where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
-    /** @inheritDoc */
-    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /** @inheritDoc */
-    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /** @inheritDoc */
-    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /** @inheritDoc */
-    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /** @inheritDoc */
-    limit(limit: number): this;
-    /** @inheritDoc */
-    sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
-    private mergeConditions;
-}
+import { IntegrationId } from '../communication.types';
+import { CollectionName, DocumentData, FieldName, PrimitiveFieldType } from '../document.types';
+import { Operator, Query } from '../query.types';
+/** Base interface for a query builder. */
+export interface BaseQueryBuilderInterface<MyDocType extends DocumentData> {
+    /**
+     * Adds a condition to the query.
+     * @param fieldName The name of the field to query.
+     * @param operator The operator to use.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, '==', value)
+     *
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '!=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, 'in', value)
+     * @param fieldName The name of the field to query.
+     * @param value An array of values to compare against.
+     * @returns The query builder.
+     */
+    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, 'not in', value)
+     * @param fieldName The name of the field to query.
+     * @param value An array of values to compare against.
+     * @returns The query builder.
+     */
+    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, '>', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '>=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '<', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '<=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, 'like', pattern).
+     *
+     * @param fieldName The name of the field to query.
+     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
+     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
+     * @returns The query builder.
+     */
+    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /**
+     * A shortcut for where(fieldName, 'not like', pattern).
+     *
+     * @param fieldName The name of the field to query.
+     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
+     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
+     * @returns The query builder.
+     */
+    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /**
+     * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
+     * if none is provided.
+     * @param limit The limit to set.
+     * @returns The query builder.
+     */
+    limit(limit: number): this;
+    /**
+     * Adds a sort order to the query. You can add multiple sort orders to the query. The order in which you add them
+     * determines the order in which they are applied.
+     * @param fieldName The name of the field to sort by.
+     * @param asc Whether to sort in ascending order. Defaults to true.
+     * @returns The query builder.
+     */
+    sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
+}
+/** A query builder that can be used to build a query that returns a list of documents. */
+export declare class SimpleQueryBuilder<MyDocType extends DocumentData> implements BaseQueryBuilderInterface<MyDocType> {
+    protected readonly collectionName: CollectionName;
+    protected readonly integrationId: IntegrationId;
+    protected readonly query: Query<MyDocType>;
+    /** @inheritDoc */
+    where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
+    /** @inheritDoc */
+    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /** @inheritDoc */
+    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /** @inheritDoc */
+    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /** @inheritDoc */
+    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /** @inheritDoc */
+    limit(limit: number): this;
+    /** @inheritDoc */
+    sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
+    private mergeConditions;
+}

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

@@ -1,5 +1 @@
-import { JSONSchemaType } from 'ajv';
-import { Query, QueryRequest, QueryUnsubscribeRequest } from './query.types';
-export declare const QuerySchema: JSONSchemaType<Query>;
-export declare const QueryRequestSchema: JSONSchemaType<QueryRequest>;
-export declare const QueryUnsubscribeRequestSchema: JSONSchemaType<QueryUnsubscribeRequest>;
+export {};

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

@@ -1,118 +1,51 @@
-import { TriggerId } from './application.types';
-import { AppId, ClientId, ClientRequestId, IntegrationId } from './communication.types';
-import { CollectionName, FieldName, PrimitiveFieldType, SquidDocument } from './document.types';
-export type Conditions<Doc = any, F extends FieldName<Doc> = any> = Array<Condition<Doc, F>>;
-export interface Condition<Doc = any, F extends FieldName<Doc> = any> {
-    fieldName: F;
-    operator: Operator;
-    value: Doc[F] | null;
-}
-export type Operator = '==' | '>=' | '<=' | '>' | '<' | '!=' | 'like' | 'not like' | 'like_cs' | 'not like_cs';
-export type ContextConditions<Doc = any, F extends FieldName<Doc> = any> = Array<ContextCondition<Doc, F>>;
-export type GenericValue<Doc = any, F extends FieldName<Doc> = any, O extends AllOperators = any> = O extends 'in' ? Array<Doc[F]> | null : O extends 'not in' ? Array<Doc[F]> | null : Doc[F] | null;
-export type ContextCondition<Doc = any, F extends FieldName<Doc> = any> = InContextCondition<Doc, F> | NotInContextCondition<Doc, F> | OtherContextCondition<Doc, F>;
-interface InContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
-    operator: 'in';
-    value: Array<Doc[F]>;
-}
-interface NotInContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
-    operator: 'not in';
-    value: Array<Doc[F]>;
-}
-interface OtherContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator'> {
-    operator: Exclude<ContextOperator, 'in' | 'not in'>;
-}
-export interface GeneralCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
-    operator: AllOperators;
-    value: any;
-}
-export type GeneralConditions<Doc = any, F extends FieldName<Doc> = any> = Array<GeneralCondition<Doc, F>>;
-export type ContextOperator = Exclude<Operator, '==' | '!='> | 'in' | 'not in';
-export type AllOperators = Operator | 'in' | 'not in';
-export interface FieldSort<Doc> {
-    fieldName: FieldName<Doc>;
-    asc: boolean;
-}
-interface RegularQueryKey {
-    queryType: 'query';
-    clientId: string;
-    clientRequestId: string;
-}
-interface TriggerKey {
-    queryType: 'trigger';
-    triggerId: TriggerId;
-}
-export type QueryKey = RegularQueryKey | TriggerKey;
-export interface Query<Doc = any> {
-    collectionName: CollectionName;
-    integrationId: string;
-    conditions: Conditions<Doc>;
-    sortOrder: Array<FieldSort<Doc>>;
-    limit: number;
-}
-export type QuerySubscriptionId = `${ClientId}_${ClientRequestId}`;
-export interface QueryRequest {
-    clientId: ClientId;
-    clientRequestId: ClientRequestId;
-    query: Query;
-    subscribe: boolean;
-}
-export interface QueryUnsubscribeRequest {
-    clientId: ClientId;
-    clientRequestId: ClientRequestId;
-}
-interface QueryMetadata {
-    condCount: number;
-}
-/**
- * Example query mapping:
- * {
- *   unconditional: ['cid_123'],
- *   conditional: {
- *     age: {
- *       '==': {
- *         10: ['cid2_321'],
- *         11: ['cid2_321'],
- *         12: ['cid2_321'],
- *       },
- *       '>': {
- *         20: ['cid_456']
- *       }
- *     }
- *   },
- *   queriesMetadata: {
- *     'cid_123': {
- *       condCount: 0
- *     },
- *     'cid2_321': {
- *       condCount: 1
- *     },
- *     'cid2_456': {
- *       condCount: 1
- *     }
- *   }
- * }
- */
-export type QueryMapping<T extends string> = {
-    unconditional: Array<T>;
-    conditional: Record<FieldName, Record<Operator, Record<PrimitiveFieldType & string, Array<T>>>>;
-    queriesMetadata: Record<T, QueryMetadata>;
-};
-export declare abstract class QueryMappingManager<T> {
-    abstract addQuery(appId: AppId, query: Query, key: T): Promise<void>;
-    abstract removeQuery(appId: AppId, key: T): Promise<Query | undefined>;
-    abstract findQueriesForDocument(appId: AppId, doc: SquidDocument, collectionName: CollectionName, integrationId: IntegrationId): Promise<Array<T> | undefined>;
-}
-export declare abstract class SimpleQueryMappingManager<T extends string> extends QueryMappingManager<T> {
-    abstract getMapping(appId: AppId, collectionName: CollectionName, integrationId: IntegrationId): Promise<QueryMapping<T> | undefined> | (QueryMapping<T> | undefined);
-    findQueriesForDocument(appId: AppId, doc: SquidDocument, collectionName: CollectionName, integrationId: IntegrationId): Promise<Array<T>>;
-}
-export declare function findQueriesForDocumentSync<T extends string>(mapping: QueryMapping<T>, doc: SquidDocument): Array<T>;
-export declare function compareOperator(conditionValue: PrimitiveFieldType, valueInDocument: PrimitiveFieldType, operator: Operator): boolean;
-/** Returns a unique identifier for the query which includes both the client id and the client request id. */
-export declare function getQuerySubscriptionId(clientId: string, clientRequestId: string): QuerySubscriptionId;
-export declare function parseQuerySubscriptionId(querySubscriptionId: QuerySubscriptionId): {
-    clientId: string;
-    clientRequestId: string;
-};
-export {};
+import { CollectionName, FieldName } from './document.types';
+/** A list of query conditions. */
+export type Conditions<Doc = any, F extends FieldName<Doc> = any> = Array<Condition<Doc, F>>;
+/** A single query condition. */
+export interface Condition<Doc = any, F extends FieldName<Doc> = any> {
+    fieldName: F;
+    operator: Operator;
+    value: Doc[F] | null;
+}
+/** An operator in a query condition. */
+export type Operator = '==' | '>=' | '<=' | '>' | '<' | '!=' | 'like' | 'not like' | 'like_cs' | 'not like_cs';
+/** A list of context conditions */
+export type ContextConditions<Doc = any, F extends FieldName<Doc> = any> = Array<ContextCondition<Doc, F>>;
+/** A generic value that can exist in a query. */
+export type GenericValue<Doc = any, F extends FieldName<Doc> = any, O extends AllOperators = any> = O extends 'in' ? Array<Doc[F]> | null : O extends 'not in' ? Array<Doc[F]> | null : Doc[F] | null;
+/** A Context condition - a condition that replaces multiple '==' or '!=' conditions with 'in' and 'not in'. */
+export type ContextCondition<Doc = any, F extends FieldName<Doc> = any> = InContextCondition<Doc, F> | NotInContextCondition<Doc, F> | OtherContextCondition<Doc, F>;
+interface InContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
+    operator: 'in';
+    value: Array<Doc[F]>;
+}
+interface NotInContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
+    operator: 'not in';
+    value: Array<Doc[F]>;
+}
+interface OtherContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator'> {
+    operator: Exclude<ContextOperator, 'in' | 'not in'>;
+}
+/** A condition that includes the 'in' and 'not in' operators. */
+export interface GeneralCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
+    operator: AllOperators;
+    value: any;
+}
+/** A list of general conditions. */
+export type GeneralConditions<Doc = any, F extends FieldName<Doc> = any> = Array<GeneralCondition<Doc, F>>;
+export type ContextOperator = Exclude<Operator, '==' | '!='> | 'in' | 'not in';
+export type AllOperators = Operator | 'in' | 'not in';
+/** A definition of a sort by a filed. */
+export interface FieldSort<Doc> {
+    fieldName: FieldName<Doc>;
+    asc: boolean;
+}
+/** A query object. */
+export interface Query<Doc = any> {
+    collectionName: CollectionName;
+    integrationId: string;
+    conditions: Conditions<Doc>;
+    sortOrder: Array<FieldSort<Doc>>;
+    limit: number;
+}
+export {};

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

@@ -1,22 +1 @@
-export type SquidCloudId = 'aws' | 'gcp' | 'azure';
-/** The list of supported Squid regions. */
-export type SupportedSquidRegion = 'us-east-1.aws' | 'local';
-export declare const supportedSquidRegions: Array<SupportedSquidRegion>;
-export interface SquidCloudRegion {
-    id: string;
-    name: string;
-}
-export interface SquidSupportedCloud {
-    id: SquidCloudId;
-    name: string;
-    icon: string;
-    regions: Array<SquidCloudRegion>;
-    tooltip?: string;
-}
-export declare const squidSupportedRegionMap: Record<SupportedSquidRegion, SquidCloudRegion>;
-export declare function getSquidSupportedCloudMap(isLocal?: boolean): Record<SquidCloudId, SquidSupportedCloud>;
-export declare function convertToSquidRegion(cloudId: SquidCloudId, region: string): SupportedSquidRegion;
-export declare function convertFromSquidRegion(regionAndCloud: SupportedSquidRegion): {
-    cloudId: SquidCloudId;
-    region: string;
-};
+export type SupportedSquidRegion = (typeof SupportedSquidRegions)[number];

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

@@ -1,54 +1,54 @@
-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 = Omit<ConvertDeep<JSONSchema>, 'properties'> & {
-    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 {};
+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' | 'objectId';
+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 = Omit<ConvertDeep<JSONSchema>, 'properties'> & {
+    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 +1 @@
-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>;
+export {};