@blitznocode/blitz-orm 0.8.2 → 0.8.3

package/dist/index.d.mts

@@ -0,0 +1,470 @@
+import { TypeDBCredential, TypeDBDriver, TypeDBSession } from 'typedb-driver';
+
+interface TypeDBProviderObject {
+    provider: 'typeDB';
+    url: string;
+}
+interface TypeDBClusterProviderObject {
+    provider: 'typeDBCluster';
+    addresses: string[];
+    credentials: TypeDBCredential;
+}
+type TypeDBHandles = Map<string, {
+    client: TypeDBDriver;
+    session: TypeDBSession;
+}>;
+
+type QueryConfig = {
+    noMetadata?: boolean;
+    returnNulls?: boolean;
+    simplifiedLinks?: boolean;
+    debugger?: boolean;
+};
+type MutateConfig = {
+    noMetadata?: boolean;
+    preQuery?: boolean;
+    ignoreNonexistingThings?: boolean;
+};
+type BormConfig = {
+    server: {
+        provider: 'blitz-orm-js';
+    };
+    query?: QueryConfig;
+    mutation?: MutateConfig;
+    dbConnectors: [ProviderObject, ...ProviderObject[]];
+};
+type ProviderObject = (TypeDBProviderObject & CommonProperties) | (TypeDBClusterProviderObject & CommonProperties);
+interface CommonProperties {
+    id: string;
+    dbName: string;
+}
+type Provider = 'typeDB' | 'typeDBCluster';
+type DBConnector = {
+    id: string;
+    subs?: string;
+    path?: string;
+    as?: string;
+};
+type DBHandles = {
+    typeDB: TypeDBHandles;
+};
+
+type ThingType = 'entity' | 'relation' | 'attribute';
+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, any>;
+type BQLResponseMulti = BQLResponseSingle[];
+type BQLResponse = BQLResponseSingle | BQLResponseMulti;
+
+type LinkFilter = {
+    $thing?: string;
+    $thingType?: string;
+    $role?: string;
+    [key: string]: string | number | Filter | undefined;
+};
+type Filter = DataFilter | LinkFilter | MiddleFilter;
+type MiddleFilter = {
+    $and?: Filter[];
+    $or?: Filter[];
+};
+type RequireAtLeastOne<T> = {
+    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
+}[keyof T];
+type DataFilter = RequireAtLeastOne<{
+    $eq?: any;
+    $ge?: number | string;
+}>;
+
+type BormField = {
+    path: string;
+    cardinality?: CardinalityType;
+    ordered?: boolean;
+    embedded?: boolean;
+    rights?: readonly RightType[];
+};
+type RoleField = {
+    cardinality: CardinalityType;
+    dbConnector?: DBConnector;
+};
+type LinkField = BormField & {
+    relation: string;
+    cardinality: CardinalityType;
+    plays: string;
+} & ({
+    target: 'role';
+    filter?: Filter | Filter[];
+} | {
+    target: 'relation';
+});
+type LinkedFieldWithThing = LinkField & {
+    thing: string;
+    thingType: ThingType;
+};
+type StringField = BormField & {
+    contentType: 'ID' | 'COLOR' | 'DATE' | 'FILE' | 'EMAIL' | 'PHONE' | 'URL' | 'PASSWORD' | 'LANGUAGE_TEXT' | 'RICH_TEXT' | 'TEXT';
+    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;
+type DataField = BormField & {
+    shared?: boolean;
+    validations?: {
+        required?: boolean;
+        unique?: boolean;
+    };
+    isVirtual?: boolean;
+    dbConnectors?: [DBConnector, ...DBConnector[]];
+} & AllDataField;
+type ContentType = keyof ContentTypeMapping;
+type ContentTypeMapping = {
+    ID: string;
+    JSON: unknown;
+    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 CardinalityType = 'ONE' | 'MANY' | '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[];
+};
+type EnrichedBormEntity = Omit<BormEntity, 'linkFields' | 'idFields' | 'dataFields'> & {
+    extends?: string;
+    thingType: 'entity';
+    allExtends?: string[];
+    idFields: string[];
+} & SharedEnrichedProps;
+type EnrichedBormRelation = Omit<BormRelation, 'linkFields' | 'dataFields'> & {
+    thingType: 'relation';
+    roles: {
+        [key: string]: EnrichedRoleField;
+    };
+} & SharedEnrichedProps;
+type EnrichedRoleField = RoleField & {
+    playedBy?: LinkedFieldWithThing[];
+    name: string;
+};
+type EnrichedDataField = DataField & {
+    dbPath: string;
+};
+type EnrichedLinkField = BormField & {
+    name: string;
+    relation: string;
+    plays: string;
+} & ({
+    target: 'role';
+    filter?: Filter | Filter[];
+    oppositeLinkFieldsPlayedBy: LinkedFieldWithThing[];
+} | {
+    target: 'relation';
+    oppositeLinkFieldsPlayedBy: Pick<LinkedFieldWithThing, 'thing' | 'thingType' | 'plays'>[];
+});
+
+declare const Schema: unique symbol;
+
+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 BQLMutationBlock = {
+    [key: string]: any;
+    $id?: string | string[];
+    $filter?: Filter | Filter[];
+    $tempId?: string;
+    $op?: string;
+} & ({
+    $entity: string;
+} | {
+    $relation: string;
+} | {
+    $thing: string;
+    $thingType: 'entity' | 'relation';
+});
+type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$tempId' | '$op'> & {
+    $entity?: string;
+    [Schema]: EnrichedBormEntity | EnrichedBormRelation;
+};
+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 RawBQLQuery = {
+    $id?: string | string[];
+    $filter?: Record<string, any>;
+    $fields?: BQLField[];
+    $excludedFields?: BQLField[];
+} & ({
+    $entity: string;
+} | {
+    $relation: string;
+} | {
+    $thing: string;
+    $thingType: 'entity' | 'relation';
+});
+type ParsedBQLQuery = Omit<RawBQLQuery, '$entity' | '$relation' | '$thing' | '$thingType'> & {
+    $localFilters?: Record<string, any>;
+    $nestedFilters?: Record<string, any>;
+} & ({
+    $entity: EnrichedBormEntity;
+} | {
+    $relation: EnrichedBormRelation;
+});
+
+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 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;
+} | {
+    extends?: string;
+    idFields: readonly string[];
+    defaultDBConnector: DBConnector;
+    dataFields?: readonly DataField[];
+    linkFields?: readonly LinkField[];
+};
+type BormRelation = BormEntity & {
+    defaultDBConnector: DBConnector & {
+        path: string;
+    };
+    roles?: {
+        [key: string]: RoleField;
+    };
+};
+type BormOperation = 'create' | 'update' | 'delete' | 'link' | 'unlink';
+type BormTrigger = 'onCreate' | 'onUpdate' | 'onDelete' | 'onLink' | 'onUnlink';
+type Hooks = {
+    pre?: readonly PreHook[];
+};
+type PreHook = {
+    triggers: {
+        [K in BormTrigger]?: () => boolean;
+    };
+    actions: readonly Action[];
+};
+type Action = {
+    type: 'validate';
+    fn: (entity: FilledBQLMutationBlock) => boolean;
+    severity: 'error' | 'warning' | 'info';
+    message: string;
+} | {
+    type: 'transform';
+    fn: (entity: FilledBQLMutationBlock) => Partial<FilledBQLMutationBlock>;
+};
+
+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 BormProps = {
+    schema: BormSchema;
+    config: BormConfig;
+};
+declare class BormClient {
+    #private;
+    private schema;
+    private config;
+    private dbHandles?;
+    constructor({ schema, config }: BormProps);
+    init: () => Promise<void>;
+    introspect: () => Promise<BormSchema>;
+    define: () => Promise<void>;
+    query: (query: RawBQLQuery | RawBQLQuery[], queryConfig?: QueryConfig) => Promise<BQLResponse>;
+    mutate: (mutation: RawBQLMutation | RawBQLMutation[], mutationConfig?: MutateConfig) => Promise<BQLResponseMulti>;
+    close: () => Promise<void>;
+}
+
+export { type Action, type BQLField, type BQLFieldObj, type BQLMutationBlock, type BQLResponse, type BQLResponseMulti, type BQLResponseSingle, type BormConfig, type BormEntity, type BormField, type BormMetadata, type BormOperation, type BormRelation, type BormSchema, type BormTrigger, type CardinalityType, type CommonProperties, type ContentType, type ContentTypeMapping, type DBConnector, type DBHandles, type DataField, type DataFilter, type EnrichedBormEntity, type EnrichedBormRelation, type EnrichedBormSchema, type EnrichedDataField, type EnrichedLinkField, type EnrichedRoleField, type FilledBQLMutationBlock, type Filter, type Hooks, type LinkField, type LinkFilter, type LinkedFieldWithThing, type MiddleFilter, type MutateConfig, type ParsedBQLMutation, type ParsedBQLQuery, type PreHook, type Provider, type ProviderObject, type QueryConfig, type RawBQLMutation, type RawBQLQuery, type RightType, type RoleField, type TQLEntityMutation, type TQLRequest, type ThingType, type TypeDBClusterProviderObject, type TypeDBHandles, type TypeDBProviderObject, type TypeGen, type WithBormMetadata, BormClient as default };

package/dist/index.d.ts

@@ -0,0 +1,470 @@
+import { TypeDBCredential, TypeDBDriver, TypeDBSession } from 'typedb-driver';
+
+interface TypeDBProviderObject {
+    provider: 'typeDB';
+    url: string;
+}
+interface TypeDBClusterProviderObject {
+    provider: 'typeDBCluster';
+    addresses: string[];
+    credentials: TypeDBCredential;
+}
+type TypeDBHandles = Map<string, {
+    client: TypeDBDriver;
+    session: TypeDBSession;
+}>;
+
+type QueryConfig = {
+    noMetadata?: boolean;
+    returnNulls?: boolean;
+    simplifiedLinks?: boolean;
+    debugger?: boolean;
+};
+type MutateConfig = {
+    noMetadata?: boolean;
+    preQuery?: boolean;
+    ignoreNonexistingThings?: boolean;
+};
+type BormConfig = {
+    server: {
+        provider: 'blitz-orm-js';
+    };
+    query?: QueryConfig;
+    mutation?: MutateConfig;
+    dbConnectors: [ProviderObject, ...ProviderObject[]];
+};
+type ProviderObject = (TypeDBProviderObject & CommonProperties) | (TypeDBClusterProviderObject & CommonProperties);
+interface CommonProperties {
+    id: string;
+    dbName: string;
+}
+type Provider = 'typeDB' | 'typeDBCluster';
+type DBConnector = {
+    id: string;
+    subs?: string;
+    path?: string;
+    as?: string;
+};
+type DBHandles = {
+    typeDB: TypeDBHandles;
+};
+
+type ThingType = 'entity' | 'relation' | 'attribute';
+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, any>;
+type BQLResponseMulti = BQLResponseSingle[];
+type BQLResponse = BQLResponseSingle | BQLResponseMulti;
+
+type LinkFilter = {
+    $thing?: string;
+    $thingType?: string;
+    $role?: string;
+    [key: string]: string | number | Filter | undefined;
+};
+type Filter = DataFilter | LinkFilter | MiddleFilter;
+type MiddleFilter = {
+    $and?: Filter[];
+    $or?: Filter[];
+};
+type RequireAtLeastOne<T> = {
+    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
+}[keyof T];
+type DataFilter = RequireAtLeastOne<{
+    $eq?: any;
+    $ge?: number | string;
+}>;
+
+type BormField = {
+    path: string;
+    cardinality?: CardinalityType;
+    ordered?: boolean;
+    embedded?: boolean;
+    rights?: readonly RightType[];
+};
+type RoleField = {
+    cardinality: CardinalityType;
+    dbConnector?: DBConnector;
+};
+type LinkField = BormField & {
+    relation: string;
+    cardinality: CardinalityType;
+    plays: string;
+} & ({
+    target: 'role';
+    filter?: Filter | Filter[];
+} | {
+    target: 'relation';
+});
+type LinkedFieldWithThing = LinkField & {
+    thing: string;
+    thingType: ThingType;
+};
+type StringField = BormField & {
+    contentType: 'ID' | 'COLOR' | 'DATE' | 'FILE' | 'EMAIL' | 'PHONE' | 'URL' | 'PASSWORD' | 'LANGUAGE_TEXT' | 'RICH_TEXT' | 'TEXT';
+    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;
+type DataField = BormField & {
+    shared?: boolean;
+    validations?: {
+        required?: boolean;
+        unique?: boolean;
+    };
+    isVirtual?: boolean;
+    dbConnectors?: [DBConnector, ...DBConnector[]];
+} & AllDataField;
+type ContentType = keyof ContentTypeMapping;
+type ContentTypeMapping = {
+    ID: string;
+    JSON: unknown;
+    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 CardinalityType = 'ONE' | 'MANY' | '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[];
+};
+type EnrichedBormEntity = Omit<BormEntity, 'linkFields' | 'idFields' | 'dataFields'> & {
+    extends?: string;
+    thingType: 'entity';
+    allExtends?: string[];
+    idFields: string[];
+} & SharedEnrichedProps;
+type EnrichedBormRelation = Omit<BormRelation, 'linkFields' | 'dataFields'> & {
+    thingType: 'relation';
+    roles: {
+        [key: string]: EnrichedRoleField;
+    };
+} & SharedEnrichedProps;
+type EnrichedRoleField = RoleField & {
+    playedBy?: LinkedFieldWithThing[];
+    name: string;
+};
+type EnrichedDataField = DataField & {
+    dbPath: string;
+};
+type EnrichedLinkField = BormField & {
+    name: string;
+    relation: string;
+    plays: string;
+} & ({
+    target: 'role';
+    filter?: Filter | Filter[];
+    oppositeLinkFieldsPlayedBy: LinkedFieldWithThing[];
+} | {
+    target: 'relation';
+    oppositeLinkFieldsPlayedBy: Pick<LinkedFieldWithThing, 'thing' | 'thingType' | 'plays'>[];
+});
+
+declare const Schema: unique symbol;
+
+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 BQLMutationBlock = {
+    [key: string]: any;
+    $id?: string | string[];
+    $filter?: Filter | Filter[];
+    $tempId?: string;
+    $op?: string;
+} & ({
+    $entity: string;
+} | {
+    $relation: string;
+} | {
+    $thing: string;
+    $thingType: 'entity' | 'relation';
+});
+type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$tempId' | '$op'> & {
+    $entity?: string;
+    [Schema]: EnrichedBormEntity | EnrichedBormRelation;
+};
+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 RawBQLQuery = {
+    $id?: string | string[];
+    $filter?: Record<string, any>;
+    $fields?: BQLField[];
+    $excludedFields?: BQLField[];
+} & ({
+    $entity: string;
+} | {
+    $relation: string;
+} | {
+    $thing: string;
+    $thingType: 'entity' | 'relation';
+});
+type ParsedBQLQuery = Omit<RawBQLQuery, '$entity' | '$relation' | '$thing' | '$thingType'> & {
+    $localFilters?: Record<string, any>;
+    $nestedFilters?: Record<string, any>;
+} & ({
+    $entity: EnrichedBormEntity;
+} | {
+    $relation: EnrichedBormRelation;
+});
+
+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 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;
+} | {
+    extends?: string;
+    idFields: readonly string[];
+    defaultDBConnector: DBConnector;
+    dataFields?: readonly DataField[];
+    linkFields?: readonly LinkField[];
+};
+type BormRelation = BormEntity & {
+    defaultDBConnector: DBConnector & {
+        path: string;
+    };
+    roles?: {
+        [key: string]: RoleField;
+    };
+};
+type BormOperation = 'create' | 'update' | 'delete' | 'link' | 'unlink';
+type BormTrigger = 'onCreate' | 'onUpdate' | 'onDelete' | 'onLink' | 'onUnlink';
+type Hooks = {
+    pre?: readonly PreHook[];
+};
+type PreHook = {
+    triggers: {
+        [K in BormTrigger]?: () => boolean;
+    };
+    actions: readonly Action[];
+};
+type Action = {
+    type: 'validate';
+    fn: (entity: FilledBQLMutationBlock) => boolean;
+    severity: 'error' | 'warning' | 'info';
+    message: string;
+} | {
+    type: 'transform';
+    fn: (entity: FilledBQLMutationBlock) => Partial<FilledBQLMutationBlock>;
+};
+
+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 BormProps = {
+    schema: BormSchema;
+    config: BormConfig;
+};
+declare class BormClient {
+    #private;
+    private schema;
+    private config;
+    private dbHandles?;
+    constructor({ schema, config }: BormProps);
+    init: () => Promise<void>;
+    introspect: () => Promise<BormSchema>;
+    define: () => Promise<void>;
+    query: (query: RawBQLQuery | RawBQLQuery[], queryConfig?: QueryConfig) => Promise<BQLResponse>;
+    mutate: (mutation: RawBQLMutation | RawBQLMutation[], mutationConfig?: MutateConfig) => Promise<BQLResponseMulti>;
+    close: () => Promise<void>;
+}
+
+export { type Action, type BQLField, type BQLFieldObj, type BQLMutationBlock, type BQLResponse, type BQLResponseMulti, type BQLResponseSingle, type BormConfig, type BormEntity, type BormField, type BormMetadata, type BormOperation, type BormRelation, type BormSchema, type BormTrigger, type CardinalityType, type CommonProperties, type ContentType, type ContentTypeMapping, type DBConnector, type DBHandles, type DataField, type DataFilter, type EnrichedBormEntity, type EnrichedBormRelation, type EnrichedBormSchema, type EnrichedDataField, type EnrichedLinkField, type EnrichedRoleField, type FilledBQLMutationBlock, type Filter, type Hooks, type LinkField, type LinkFilter, type LinkedFieldWithThing, type MiddleFilter, type MutateConfig, type ParsedBQLMutation, type ParsedBQLQuery, type PreHook, type Provider, type ProviderObject, type QueryConfig, type RawBQLMutation, type RawBQLQuery, type RightType, type RoleField, type TQLEntityMutation, type TQLRequest, type ThingType, type TypeDBClusterProviderObject, type TypeDBHandles, type TypeDBProviderObject, type TypeGen, type WithBormMetadata, BormClient as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blitznocode/blitz-orm",
-  "version": "0.8.2",
+  "version": "0.8.3",
   "main": "dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "dist/index.d.ts",