squid/dist/schema.d.ts

Provides SQL tagged template strings and a schema definition function.

export declare enum ColumnType {
    Any = "any",
    Array = "array",
    Boolean = "boolean",
    Date = "date",
    Enum = "enum",
    JSON = "json",
    Number = "number",
    Object = "object",
    String = "string"
}
interface ObjectShape {
    [propName: string]: ColumnDescription<any, any, any, any>;
}
export interface ColumnDescription<Type extends ColumnType, SubType extends ColumnDescription<any, any, any, any>, EnumValues extends string | number, ObjectProps extends ObjectShape> {
    type: Type;
    subtype?: SubType;
    enum?: EnumValues[];
    props?: ObjectProps;
    hasDefault?: boolean;
    nullable?: boolean;
}
export declare type ColumnDescriptor = ColumnDescription<any, any, any, any>;
export interface TableSchemaDescriptor {
    [columnName: string]: ColumnDescriptor;
}
export interface TableSchema<Columns extends TableSchemaDescriptor> {
    name: string;
    columns: Columns;
}
declare type DeriveBuiltinTypeByColumnType<Column extends ColumnDescription<any, any, any, any>> = Column extends {
    type: infer Col;
} ? (Col extends ColumnType.Any ? any : Col extends ColumnType.Boolean ? boolean : Col extends ColumnType.Date ? string : Col extends ColumnType.Number ? number : Col extends ColumnType.String ? string : Col extends ColumnType.Enum ? (Column extends ColumnDescription<ColumnType.Enum, any, infer EnumValues, any> ? EnumValues : never) : any) : never;
declare type DeriveComplexBuiltinType<Column extends ColumnDescription<any, any, any, any>> = Column extends ColumnDescription<ColumnType.Array, infer ItemType, any, any> ? Array<DeriveBuiltinTypeByColumnType<ItemType>> : Column extends ColumnDescription<ColumnType.JSON, infer JSONType, any, any> ? DeriveBuiltinTypeByColumnType<JSONType> : Column extends ColumnDescription<ColumnType.Object, any, any, infer ObjectProps> ? {
    [propName in keyof ObjectProps]: DeriveBuiltinType<ObjectProps[propName]>;
} : DeriveBuiltinTypeByColumnType<Column>;
declare type DeriveBuiltinType<Column extends ColumnDescription<any, any, any, any>> = Column extends {
    nullable: true;
} ? DeriveComplexBuiltinType<Column> | null : DeriveComplexBuiltinType<Column>;
declare type MandatoryColumnsNames<Columns extends TableSchemaDescriptor> = {
    [columnName in keyof Columns]: Columns[columnName] extends {
        hasDefault: true;
    } ? never : columnName;
}[keyof Columns];
declare type ColumnsWithDefaultsNames<Columns extends TableSchemaDescriptor> = {
    [columnName in keyof Columns]: Columns[columnName] extends {
        hasDefault: true;
    } ? columnName : never;
}[keyof Columns];
export declare type TableRow<ConcreteTableSchema extends TableSchema<any>> = ConcreteTableSchema extends TableSchema<infer Columns> ? {
    [columnName in keyof Columns]: DeriveBuiltinType<Columns[columnName]>;
} : never;
export declare type NewTableRow<ConcreteTableSchema extends TableSchema<any>> = ConcreteTableSchema extends TableSchema<infer Columns> ? {
    [columnName in MandatoryColumnsNames<Columns>]: DeriveBuiltinType<Columns[columnName]>;
} & {
    [columnName in ColumnsWithDefaultsNames<Columns>]?: DeriveBuiltinType<Columns[columnName]>;
} : never;
interface SchemaTypes {
    /** Placeholder. Can stand for any random data type. Avoid using it. */
    Any: {
        type: ColumnType.Any;
    };
    /** Data type for BOOLEAN columns. */
    Boolean: {
        type: ColumnType.Boolean;
    };
    /** Data type for DATE, DATETIME, TIMESTAMP columns. */
    Date: {
        type: ColumnType.Date;
    };
    /** Data type for INTEGER, SMALLINT, BIGINT, FLOAT, REAL, NUMERIC columns. */
    Number: {
        type: ColumnType.Number;
    };
    /** Data type for CHAR, VARCHAR, TEXT columns. */
    String: {
        type: ColumnType.String;
    };
    /** Data type for array columns. Pass the data type of the array elements. */
    Array<SubType extends ColumnDescription<any, any, any, any>>(subtype: SubType): ColumnDescription<ColumnType.Array, SubType, any, any>;
    /** Data type for ENUM columns. Pass an array of possible values. */
    Enum<T extends string | number>(values: T[]): ColumnDescription<ColumnType.Enum, any, T, any>;
    /**
     * Data type for JSON, JSONB columns. Pass Schema.Object(), Schema.Array(), ..., Schema.Any
     * to declare the content of the JSON(B) column.
     */
    JSON<SubType extends ColumnDescription<any, any, any, any>>(subtype: SubType): ColumnDescription<ColumnType.JSON, SubType, any, any>;
    /** Pseudo data type to describe the shape of objects stored in a Schema.JSON() column. */
    Object<Props extends ObjectShape>(props: Props): ColumnDescription<ColumnType.Object, any, any, Props>;
    /** Declare that this column has a DEFAULT value. Pass the actual schema definition. */
    default<Column extends ColumnDescription<any, any, any, any>>(column: Column): Column & {
        hasDefault: true;
    };
    /** Declare that this column allows NULL values. Implies DEFAULT NULL. */
    nullable<Column extends ColumnDescription<any, any, any, any>>(column: Column): Column & {
        hasDefault: true;
        nullable: true;
    };
}
/**
 * Schema types to declare the data type of table columns.
 */
export declare const Schema: SchemaTypes;
/**
 * Declare a table's schema. Registers the schema globally.
 */
export declare function defineTable<Columns extends TableSchemaDescriptor>(tableName: string, schema: Columns): TableSchema<Columns>;
/**
 * Return an array of all defined table schemas.
 */
export declare function getAllTableSchemas(): TableSchema<any>[];
export {};