@blitznocode/blitz-orm 0.10.15 → 0.10.17

package/dist/index.d.ts

@@ -1,693 +0,0 @@
-import { TypeDBDriver, TypeDBSession } from 'typedb-driver';
-import { Surreal } from 'surrealdb.js';
-
-interface TypeDBProvider extends CommonProvider {
-    provider: 'typeDB';
-    url: string;
-}
-interface TypeDBClusterProvider extends CommonProvider {
-    provider: 'typeDBCluster';
-    addresses: string[];
-    username: string;
-    password: string;
-    tlsRootCAPath?: string;
-}
-type TypeDBHandles = Map<string, {
-    client: TypeDBDriver;
-    session: TypeDBSession;
-}>;
-
-interface SurrealDBProviderObject extends CommonProvider {
-    provider: 'surrealDB';
-    url: string;
-    namespace: string;
-    username: string;
-    password: string;
-}
-type SurrealDBHandles = Map<string, {
-    client: Surreal;
-}>;
-
-type QueryConfig = {
-    noMetadata?: boolean;
-    returnNulls?: boolean;
-    simplifiedLinks?: boolean;
-    debugger?: boolean;
-};
-type MutationConfig = {
-    noMetadata?: boolean;
-    preQuery?: boolean;
-    ignoreNonexistingThings?: boolean;
-    context?: Record<string, any>;
-};
-type BormConfig = {
-    server: {
-        provider: 'blitz-orm-js';
-    };
-    query?: QueryConfig;
-    mutation?: MutationConfig;
-    dbConnectors: [Provider, ...Provider[]];
-};
-type Provider = TypeDBProvider | TypeDBClusterProvider | SurrealDBProviderObject;
-interface CommonProvider {
-    id: string;
-    dbName: string;
-}
-type DBConnector = {
-    id: string;
-    subs?: string;
-    path?: string;
-    as?: string;
-};
-type AllDbHandles = {
-    typeDB: TypeDBHandles;
-    surrealDB: SurrealDBHandles;
-};
-type AtLeastOne<T, U = {
-    [K in keyof T]: Pick<T, K>;
-}> = Partial<T> & U[keyof U];
-type DBHandles = AtLeastOne<AllDbHandles>;
-type DBHandleKey = keyof DBHandles;
-
-type ThingType = 'entity' | 'relation';
-type BormMetadata = {
-    $id: string;
-    $op?: string;
-    $entity?: string;
-    $relation?: string;
-    $tempId?: string;
-};
-type WithBormMetadata<T> = T extends any[] ? T[number] extends object ? Array<WithBormMetadataObject<T[number]>> : T : T extends object ? WithBormMetadataObject<T> : T;
-type WithBormMetadataObject<T> = {
-    [K in keyof T]: WithBormMetadata<T[K]>;
-} & BormMetadata;
-type BQLResponseSingle = Record<string | symbol, any>;
-type BQLResponseMulti = BQLResponseSingle[];
-type BQLResponse = BQLResponseSingle | BQLResponseMulti;
-
-type BormSchema = {
-    entities: {
-        [s: string]: BormEntity;
-    };
-    relations: {
-        [s: string]: BormRelation;
-    };
-};
-type BormEntity = {
-    extends: string;
-    idFields?: readonly string[];
-    defaultDBConnector: DBConnector;
-    dataFields?: readonly DataField[];
-    linkFields?: readonly LinkField[];
-    hooks?: Hooks;
-} | {
-    idFields: readonly string[];
-    defaultDBConnector: DBConnector;
-    dataFields?: readonly DataField[];
-    linkFields?: readonly LinkField[];
-    hooks?: Hooks;
-};
-type BormRelation = BormEntity & {
-    defaultDBConnector: DBConnector & {
-        path: string;
-    };
-    roles?: {
-        [key: string]: RoleField;
-    };
-};
-type BormOperation = 'create' | 'update' | 'delete' | 'link' | 'unlink' | 'replace' | 'match';
-type BormTrigger = 'onCreate' | 'onUpdate' | 'onDelete' | 'onLink' | 'onUnlink' | 'onReplace' | 'onMatch';
-type Hooks = {
-    pre?: readonly PreHook[];
-};
-type PreHook = {
-    triggers?: {
-        [K in BormTrigger]?: () => boolean;
-    };
-    actions: readonly Action[];
-};
-type Action = {
-    name?: string;
-    description?: string;
-} & (TransFormAction | ValidateAction);
-type NodeFunctionParams = [
-    currentNode: EnrichedBQLMutationBlock,
-    parentNode: EnrichedBQLMutationBlock,
-    context: Record<string, any>,
-    dbNode: EnrichedBQLMutationBlock | Record<string, never>
-];
-type TransFormAction = {
-    type: 'transform';
-    fn: (...args: NodeFunctionParams) => Partial<EnrichedBQLMutationBlock>;
-};
-type ValidateAction = {
-    type: 'validate';
-    fn: (...args: NodeFunctionParams) => boolean;
-    severity: 'error' | 'warning' | 'info';
-    message: string;
-};
-
-type AdapterContext = {
-    mutation: {
-        splitArray$Ids: boolean;
-        requiresParseBQL: boolean;
-    };
-};
-
-declare const Schema: unique symbol;
-declare const QueryPath: unique symbol;
-declare const EdgeType: unique symbol;
-declare const EdgeSchema: unique symbol;
-declare const DBNode: unique symbol;
-declare const FieldSchema: unique symbol;
-declare const SharedMetadata: unique symbol;
-declare const SuqlMetadata: unique symbol;
-
-type BormField = {
-    path: string;
-    cardinality?: DiscreteCardinality;
-    ordered?: boolean;
-    embedded?: boolean;
-    rights?: readonly RightType[];
-};
-type RoleField = {
-    cardinality: DiscreteCardinality;
-    dbConnector?: DBConnector;
-};
-type LinkField = BormField & {
-    relation: string;
-    cardinality: DiscreteCardinality;
-    plays: string;
-    isVirtual?: boolean;
-} & ({
-    target: 'role';
-    filter?: Filter | Filter[];
-} | {
-    target: 'relation';
-});
-type LinkedFieldWithThing = LinkField & {
-    thing: string;
-    thingType: ThingType;
-};
-type MultiField = BormField & {
-    contentType: 'FLEX';
-    default?: {
-        type: 'fn';
-        fn: (currentNode: BQLMutationBlock) => unknown;
-    } | {
-        type: 'value';
-        value: unknown;
-    };
-    validations?: {
-        enum?: unknown[];
-        unique?: boolean;
-        fn?: (value: unknown) => boolean;
-    };
-};
-type StringField = BormField & {
-    contentType: 'ID' | 'COLOR' | 'DATE' | 'FILE' | 'EMAIL' | 'PHONE' | 'URL' | 'PASSWORD' | 'LANGUAGE_TEXT' | 'RICH_TEXT' | 'TEXT' | 'JSON';
-    default?: {
-        type: 'fn';
-        fn: (currentNode: BQLMutationBlock) => string;
-    } | {
-        type: 'value';
-        value: string;
-    };
-    validations?: {
-        enum?: string[];
-        unique?: boolean;
-        fn?: (value: string) => boolean;
-    };
-};
-type NumberField = BormField & {
-    contentType: 'DURATION' | 'HOUR' | 'RATING' | 'CURRENCY' | 'PERCENTAGE' | 'NUMBER_DECIMAL' | 'NUMBER';
-    default?: {
-        type: 'fn';
-        fn: (currentNode: BQLMutationBlock) => number;
-    } | {
-        type: 'value';
-        value: number;
-    };
-    validations?: {
-        enum?: number[];
-        unique?: boolean;
-        fn?: (value: number) => boolean;
-    };
-};
-type DateField = BormField & {
-    contentType: 'TIME';
-    default?: {
-        type: 'fn';
-        fn: (currentNode: BQLMutationBlock) => Date;
-    } | {
-        type: 'value';
-        value: Date;
-    };
-    validations?: {
-        enum: Date[];
-        fn?: (value: Date) => boolean;
-    };
-};
-type BooleanField = BormField & {
-    contentType: 'BOOLEAN';
-    default?: {
-        type: 'fn';
-        fn: (currentNode: BQLMutationBlock) => boolean;
-    } | {
-        type: 'value';
-        value: boolean;
-    };
-    validations?: {
-        enum?: boolean[];
-        fn?: (value: boolean) => boolean;
-    };
-};
-type AllDataField = StringField | NumberField | DateField | BooleanField | MultiField;
-type DataField = BormField & {
-    cardinality?: Cardinality;
-    shared?: boolean;
-    validations?: {
-        required?: boolean;
-        unique?: boolean;
-    };
-    isVirtual?: boolean;
-    dbConnectors?: [DBConnector, ...DBConnector[]];
-} & AllDataField;
-type ContentType = keyof ContentTypeMapping;
-type ContentTypeMapping = {
-    ID: string;
-    JSON: string;
-    COLOR: string;
-    BOOLEAN: boolean;
-    POINT: {
-        x: number;
-        y: number;
-    };
-    FILE: string;
-    EMAIL: string;
-    PHONE: string;
-    WEEK_DAY: 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday';
-    DURATION: number;
-    HOUR: number;
-    TIME: Date;
-    DATE: string;
-    RATING: number;
-    CURRENCY: number;
-    PERCENTAGE: number;
-    NUMBER_DECIMAL: number;
-    NUMBER: number;
-    URL: string;
-    PASSWORD: string;
-    LANGUAGE_TEXT: string;
-    RICH_TEXT: string;
-    TEXT: string;
-};
-type DiscreteCardinality = 'ONE' | 'MANY';
-type Cardinality = DiscreteCardinality | 'INTERVAL';
-type RightType = 'CREATE' | 'DELETE' | 'UPDATE' | 'LINK' | 'UNLINK';
-type BQLFieldObj = {
-    $path: string;
-    $as?: string;
-} & Omit<RawBQLQuery, '$entity' | '$relation' | '$thing' | '$thingType'>;
-type BQLField = string | BQLFieldObj;
-
-type EnrichedBormSchema = {
-    entities: {
-        [s: string]: EnrichedBormEntity;
-    };
-    relations: {
-        [s: string]: EnrichedBormRelation;
-    };
-};
-type SharedEnrichedProps = {
-    name: string;
-    computedFields: string[];
-    virtualFields: string[];
-    requiredFields: string[];
-    enumFields: string[];
-    fnValidatedFields: string[];
-    linkFields?: EnrichedLinkField[];
-    dataFields?: EnrichedDataField[];
-    db: DBHandleKey;
-    dbContext: AdapterContext;
-    allExtends?: string[];
-    subTypes?: string[];
-};
-type EnrichedBormEntity = Omit<BormEntity, 'linkFields' | 'idFields' | 'dataFields'> & {
-    extends?: string;
-    thingType: 'entity';
-    idFields: string[];
-} & SharedEnrichedProps;
-type EnrichedBormRelation = Omit<BormRelation, 'linkFields' | 'dataFields'> & {
-    thingType: 'relation';
-    roles: {
-        [key: string]: EnrichedRoleField;
-    };
-    idFields: string[];
-} & SharedEnrichedProps;
-type EnrichedRoleField = RoleField & {
-    name: string;
-    playedBy?: LinkedFieldWithThing[];
-    $things: string[];
-    fieldType: 'roleField';
-    [SharedMetadata]: {
-        inheritanceOrigin: string;
-    };
-    [SuqlMetadata]: {
-        queryPath: string;
-    };
-};
-type EnrichedDataField = DataField & {
-    dbPath: string;
-    [SharedMetadata]: {
-        inheritanceOrigin: string;
-    };
-};
-type EnrichedLinkField = LinkField & {
-    name: string;
-    relation: string;
-    plays: string;
-    $things: string[];
-    fieldType: 'linkField';
-    [SharedMetadata]: {
-        inheritanceOrigin: string;
-    };
-    [SuqlMetadata]: {
-        queryPath: string;
-    };
-} & ({
-    target: 'role';
-    targetRoles?: string[];
-    oppositeLinkFieldsPlayedBy: LinkedFieldWithThing[];
-} | {
-    target: 'relation';
-    oppositeLinkFieldsPlayedBy: Pick<LinkedFieldWithThing, 'thing' | 'thingType' | 'plays'>[];
-});
-
-type Sorter = {
-    field: string;
-    desc?: boolean;
-} | string;
-type FilterValue = string | number | boolean | string[] | number[] | boolean[] | null;
-type PositiveFilter = {
-    [field: string]: FilterValue;
-};
-type NegativeFilter = {
-    $not?: PositiveFilter;
-};
-type Filter = PositiveFilter | NegativeFilter;
-type RawBQLQuery = {
-    $id?: string | string[];
-    $filter?: Filter;
-    $fields?: BQLField[];
-    $excludedFields?: BQLField[];
-    $sort?: Sorter[];
-    $offset?: number;
-    $limit?: number;
-} & ({
-    $entity: string;
-} | {
-    $relation: string;
-} | {
-    $thing: string;
-    $thingType: 'entity' | 'relation';
-});
-type EnrichedAttributeQuery = {
-    $fieldType: 'data';
-    $thingType: 'attribute';
-    $path: string;
-    $dbPath: string;
-    $as: string;
-    $var: string;
-    $justId: boolean;
-    $id: string;
-    $isVirtual?: boolean;
-    [FieldSchema]: EnrichedDataField;
-};
-type PlayedBy = {
-    path: string;
-    cardinality: 'ONE' | 'MANY';
-    relation: string;
-    plays: string;
-    target: 'role' | 'relation';
-    thing: string;
-    thingType: 'entity' | 'relation';
-};
-type EnrichedLinkQuery = {
-    $fieldType: 'link';
-    $thingType: 'entity' | 'relation';
-    $thing: string;
-    $plays: string;
-    $playedBy: PlayedBy;
-    $path: string;
-    $dbPath: string;
-    $as: string;
-    $var: string;
-    $fields: EnrichedFieldQuery[];
-    $target: 'relation' | 'role';
-    $intermediary?: string;
-    $justId: boolean;
-    $id: string;
-    $idNotIncluded?: boolean;
-    $filter?: Filter;
-    $filterByUnique: boolean;
-    $sort?: Sorter[];
-    $offset?: number;
-    $limit?: number;
-    [QueryPath]: string;
-    [FieldSchema]: EnrichedLinkField;
-};
-type EnrichedRoleQuery = {
-    $fieldType: 'role';
-    $thingType: 'relation';
-    $thing: string;
-    $path: string;
-    $dbPath: string;
-    $as: string;
-    $var: string;
-    $fields: EnrichedFieldQuery[];
-    $intermediary: string;
-    $justId: string;
-    $id: string;
-    $idNotIncluded?: boolean;
-    $filter?: Filter;
-    $filterByUnique: boolean;
-    $playedBy: PlayedBy;
-    $sort?: Sorter[];
-    $offset?: number;
-    $limit?: number;
-    [QueryPath]: string;
-    [FieldSchema]: EnrichedRoleField;
-};
-type EnrichedFieldQuery = EnrichedAttributeQuery | EnrichedLinkQuery | EnrichedRoleQuery;
-type EnrichedEntityQuery = {
-    $id?: string | string[];
-    $thingType: 'entity';
-    $thing: string;
-    $path: string;
-    $fields: (EnrichedAttributeQuery | EnrichedLinkQuery)[];
-    $idNotIncluded?: boolean;
-    $filter?: Filter;
-    $filterByUnique: boolean;
-    $sort?: Sorter[];
-    $offset?: number;
-    $limit?: number;
-    [QueryPath]: string;
-};
-type EnrichedRelationQuery = {
-    $id?: string | string[];
-    $thingType: 'relation';
-    $thing: string;
-    $path: string;
-    $fields: EnrichedFieldQuery[];
-    $idNotIncluded?: boolean;
-    $filter?: Filter;
-    $filterByUnique: boolean;
-    $sort?: Sorter[];
-    $offset?: number;
-    $limit?: number;
-    [QueryPath]: string;
-};
-type EnrichedBQLQuery = EnrichedEntityQuery | EnrichedRelationQuery;
-
-type RequiredKey<T, K extends keyof T> = T & {
-    [P in K]-?: T[P];
-};
-type WithRequired<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>> & RequiredKey<T, K>;
-type BQLMutation = RootBQLMutationBlock | RootBQLMutationBlock[];
-type RootBQLMutationBlock = {
-    [key: string]: any;
-    $id?: string | string[];
-    $filter?: Filter;
-    $tempId?: string;
-    $op?: string;
-} & ({
-    $entity: string;
-} | {
-    $relation: string;
-} | {
-    $thing: string;
-    $thingType?: 'entity' | 'relation';
-});
-type BQLMutationBlock = {
-    [key: string]: any;
-    $id?: string | string[];
-    $filter?: Filter;
-    $tempId?: string;
-    $op?: string;
-    $entity?: string;
-    $relation?: string;
-    $thing?: string;
-    $thingType?: 'entity' | 'relation';
-};
-type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$op'> & {
-    $entity?: string;
-    $relation?: string;
-    [Schema]?: EnrichedBormEntity | EnrichedBormRelation;
-    [EdgeType]?: 'linkField' | 'roleField';
-};
-type EnrichedBQLMutationBlock = {
-    [key: string]: any;
-    $id?: string | string[];
-    $filter?: Filter;
-    $fields?: any[];
-    $tempId?: string;
-    $op: BormOperation;
-    $thing: string;
-    $thingType: 'entity' | 'relation';
-    [EdgeSchema]?: EnrichedDataField | EnrichedLinkField | EnrichedRoleField;
-    [EdgeType]?: 'linkField' | 'roleField';
-    [DBNode]?: EnrichedBQLMutationBlock | Record<string, never>;
-};
-type RawBQLMutation<T extends Record<string, any> = Record<string, any>> = ({
-    $id?: string;
-    $op?: 'create' | 'delete' | 'update';
-    $tempId?: string;
-} | {
-    $entity: string;
-} | {
-    $relation: string;
-}) & T;
-type ParsedBQLMutation = {
-    things: BQLMutationBlock[];
-    edges: BQLMutationBlock[];
-};
-
-type TQLRequest = {
-    entity?: string;
-    roles?: {
-        path: string;
-        request: string;
-        owner: string;
-    }[];
-    relations?: {
-        relation: string;
-        entity: string;
-        request: string;
-    }[];
-    insertionMatches?: string;
-    deletionMatches?: string;
-    insertions?: string;
-    deletions?: string;
-};
-type TQLEntityMutation = {
-    entity: string;
-    relations?: {
-        relation: string;
-        entity: string;
-        request: string;
-    }[];
-};
-
-type ContentTypeToType<C extends keyof ContentTypeMapping> = ContentTypeMapping[C];
-type HandleCardinality<T, C extends 'ONE' | 'MANY'> = C extends 'MANY' ? T[] : T;
-type ContentTypeAndCardinality = {
-    contentType: keyof ContentTypeMapping;
-    cardinality: 'ONE' | 'MANY';
-};
-type ForDataField = {
-    path: string;
-    contentType: keyof ContentTypeMapping;
-    cardinality: 'ONE' | 'MANY';
-};
-type ForLinkField = {
-    path: string;
-    cardinality: 'ONE' | 'MANY';
-};
-type ForRoleFIeld = {
-    cardinality: 'ONE' | 'MANY';
-};
-type BaseSchemaEntity = {
-    dataFields: readonly ForDataField[];
-    linkFields?: readonly ForLinkField[];
-};
-type BaseSchemaRelation = BaseSchemaEntity & {
-    roles?: Record<string, ForRoleFIeld[]>;
-};
-type BaseSchema = BaseSchemaEntity | BaseSchemaRelation;
-type FieldToType<F extends ContentTypeAndCardinality> = HandleCardinality<ContentTypeToType<F['contentType']>, F['cardinality']>;
-type ExtractDataFields<S extends {
-    dataFields: readonly ForDataField[];
-}> = {
-    [K in S['dataFields'][number]['path']]?: FieldToType<Extract<S['dataFields'][number], {
-        path: K;
-    }>>;
-};
-type ExtractLinkFields<S> = S extends {
-    linkFields?: readonly ForLinkField[];
-} ? S['linkFields'] extends readonly ForLinkField[] ? {
-    [K in S['linkFields'][number]['path']]?: HandleCardinality<string, Extract<S['linkFields'][number], {
-        path: K;
-    }>['cardinality']>;
-} : {} : {};
-type ExtractRoles<S> = 'roles' extends keyof S ? {
-    [K in keyof S['roles']]?: S['roles'][K] extends {
-        cardinality: 'ONE' | 'MANY';
-    } ? HandleCardinality<string, S['roles'][K]['cardinality']> : never;
-} : {};
-type TypeGen<S extends BaseSchema> = ExtractDataFields<S> & ExtractLinkFields<S> & ExtractRoles<S>;
-
-type Request = {
-    rawBqlRequest: RawBQLQuery;
-    filledBqlRequest?: FilledBQLMutationBlock[] | FilledBQLMutationBlock;
-    bqlRequest?: {
-        query?: EnrichedBQLQuery;
-        mutation?: ParsedBQLMutation;
-    };
-    schema: EnrichedBormSchema;
-    config: BormConfig;
-    tqlRequest?: TQLRequest;
-    dbHandles: DBHandles;
-    enrichedBqlQuery?: any;
-};
-type BaseResponse = {
-    bqlRes?: BQLResponse | null;
-};
-type NextPipeline<Res extends BaseResponse> = {
-    req: Request;
-    res: Res;
-    pipeline: Pipeline<Res>;
-};
-type PipelineOperation<Res extends BaseResponse> = (req: Request, res: Res) => Promise<void | NextPipeline<Res>[]>;
-type Pipeline<Res extends BaseResponse> = PipelineOperation<Res>[];
-
-type BormProps = {
-    schema: BormSchema;
-    config: BormConfig;
-};
-declare class BormClient {
-    #private;
-    private schema;
-    private config;
-    private dbHandles?;
-    constructor({ schema, config }: BormProps);
-    getDbHandles: () => DBHandles | undefined;
-    init: () => Promise<void>;
-    introspect: () => Promise<BormSchema>;
-    define: () => Promise<void>;
-    query: (query: RawBQLQuery | RawBQLQuery[], queryConfig?: QueryConfig) => Promise<BQLResponseSingle | BQLResponse[]>;
-    mutate: (mutation: BQLMutation, mutationConfig?: MutationConfig) => Promise<BQLResponseMulti>;
-    close: () => Promise<void>;
-}
-
-export { type Action, type BQLField, type BQLFieldObj, type BQLMutation, type BQLMutationBlock, type BQLResponse, type BQLResponseMulti, type BQLResponseSingle, type BaseResponse, type BormConfig, type BormEntity, type BormField, type BormMetadata, type BormOperation, type BormRelation, type BormSchema, type BormTrigger, type Cardinality, type CommonProvider, type ContentType, type ContentTypeMapping, type DBConnector, type DBHandleKey, type DBHandles, type DataField, type DiscreteCardinality, type EnrichedAttributeQuery, type EnrichedBQLMutationBlock, type EnrichedBQLQuery, type EnrichedBormEntity, type EnrichedBormRelation, type EnrichedBormSchema, type EnrichedDataField, type EnrichedEntityQuery, type EnrichedFieldQuery, type EnrichedLinkField, type EnrichedLinkQuery, type EnrichedRelationQuery, type EnrichedRoleField, type EnrichedRoleQuery, type FilledBQLMutationBlock, type Filter, type FilterValue, type Hooks, type LinkField, type LinkedFieldWithThing, type MutationConfig, type NegativeFilter, type NodeFunctionParams, type ParsedBQLMutation, type Pipeline, type PipelineOperation, type PlayedBy, type PositiveFilter, type PreHook, type Provider, type QueryConfig, type RawBQLMutation, type RawBQLQuery, type Request, type RightType, type RoleField, type RootBQLMutationBlock, type Sorter, type TQLEntityMutation, type TQLRequest, type ThingType, type TransFormAction, type TypeDBClusterProvider, type TypeDBHandles, type TypeDBProvider, type TypeGen, type ValidateAction, type WithBormMetadata, BormClient as default };