@blitznocode/blitz-orm 0.4.7 → 0.5.0

package/dist/index.d.ts

@@ -1,5 +1,19 @@
 import { TypeDBCredential, TypeDBClient, TypeDBSession } from 'typedb-client';
 
+interface TypeDBProviderObject {
+    provider: 'typeDB';
+    url: string;
+}
+interface TypeDBClusterProviderObject {
+    provider: 'typeDBCluster';
+    addresses: string[];
+    credentials: TypeDBCredential;
+}
+type TypeDBHandles = Map<string, {
+    client: TypeDBClient;
+    session: TypeDBSession;
+}>;
+
 type BormConfig = {
     server: {
         provider: 'blitz-orm-js';
@@ -20,103 +34,31 @@ interface CommonProperties {
     dbName: string;
 }
 type Provider = 'typeDB' | 'typeDBCluster';
-interface TypeDBProviderObject {
-    provider: 'typeDB';
-    url: string;
-}
-interface TypeDBClusterProviderObject {
-    provider: 'typeDBCluster';
-    addresses: string[];
-    credentials: TypeDBCredential;
-}
 type DBConnector = {
     id: string;
     subs?: string;
     path?: string;
     as?: string;
 };
-type TypeDBHandles = Map<string, {
-    client: TypeDBClient;
-    session: TypeDBSession;
-}>;
 type DBHandles = {
     typeDB: TypeDBHandles;
 };
-type BormSchema = {
-    entities: {
-        [s: string]: BormEntity;
-    };
-    relations: {
-        [s: string]: BormRelation;
-    };
-};
-type EnrichedBormSchema = {
-    entities: {
-        [s: string]: EnrichedBormEntity;
-    };
-    relations: {
-        [s: string]: EnrichedBormRelation;
-    };
-};
-type BormEntity = {
-    extends: string;
-    idFields?: string[];
-    defaultDBConnector: DBConnector;
-    dataFields?: DataField[];
-    linkFields?: LinkField[];
-} | {
-    extends?: string;
-    idFields: string[];
-    defaultDBConnector: DBConnector;
-    dataFields?: DataField[];
-    linkFields?: LinkField[];
-};
-type BormRelation = BormEntity & {
-    defaultDBConnector: DBConnector & {
-        path: string;
-    };
-    roles?: {
-        [key: string]: RoleField;
-    };
-};
-type EnrichedBormEntity = Omit<BormEntity, 'linkFields' | 'idFields' | 'dataFields'> & {
-    extends?: string;
-    allExtends?: string[];
-    idFields: string[];
-    thingType: 'entity';
-    name: string;
-    computedFields: string[];
-    virtualFields: string[];
-    linkFields?: EnrichedLinkField[];
-    dataFields?: EnrichedDataField[];
-};
-type EnrichedBormRelation = Omit<BormRelation, 'linkFields' | 'dataFields'> & {
-    thingType: 'relation';
-    name: string;
-    computedFields: string[];
-    virtualFields: string[];
-    linkFields?: EnrichedLinkField[];
-    dataFields?: EnrichedDataField[];
-    roles: {
-        [key: string]: EnrichedRoleField;
-    };
-};
-type LinkField = BormField & {
-    relation: string;
-    plays: string;
-} & ({
-    target: 'role';
-    filter?: Filter | Filter[];
-} | {
-    target: 'relation';
-});
-type LinkedFieldWithThing = LinkField & {
-    thing: string;
-    thingType: ThingType;
+
+type ThingType = 'entity' | 'relation' | 'attribute';
+type BormMetadata = {
+    $id: string;
+    $entity?: string;
+    $relation?: string;
+    $tempId?: string;
 };
-type RequireAtLeastOne<T> = {
-    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
-}[keyof T];
+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;
@@ -128,53 +70,14 @@ 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 EnrichedLinkField = BormField & {
-    name: string;
-    relation: string;
-    plays: string;
-} & ({
-    target: 'role';
-    filter?: Filter | Filter[];
-    oppositeLinkFieldsPlayedBy: LinkedFieldWithThing[];
-} | {
-    target: 'relation';
-    oppositeLinkFieldsPlayedBy: Pick<LinkedFieldWithThing, 'thing' | 'thingType' | 'plays'>[];
-});
-type BormField = {
-    path: string;
-    cardinality: CardinalityType;
-    ordered?: boolean;
-    embedded?: boolean;
-    rights?: RightType[];
-};
-type RoleField = {
-    cardinality: CardinalityType;
-    dbConnector?: DBConnector;
-};
-type EnrichedRoleField = RoleField & {
-    playedBy?: LinkedFieldWithThing[];
-    name: string;
-};
-type DataField = BormField & {
-    shared?: boolean;
-    default?: any;
-    contentType: ContentType;
-    validations?: any;
-    isVirtual?: boolean;
-    dbConnectors?: [DBConnector, ...DBConnector[]];
-};
-type EnrichedDataField = DataField & {
-    dbPath: string;
-};
-type ThingType = 'entity' | 'relation' | 'attribute';
-type RightType = 'CREATE' | 'DELETE' | 'UPDATE' | 'LINK' | 'UNLINK';
-type ContentType = 'ID' | 'JSON' | 'COLOR' | 'BOOLEAN' | 'POINT' | 'FILE' | 'EMAIL' | 'PHONE' | 'WEEK_DAY' | 'DURATION' | 'HOUR' | 'TIME' | 'DATE' | 'RATING' | 'CURRENCY' | 'PERCENTAGE' | 'NUMBER_DECIMAL' | 'NUMBER' | 'URL' | 'PASSWORD' | 'LANGUAGE_TEXT' | 'RICH_TEXT' | 'TEXT';
-type CardinalityType = 'ONE' | 'MANY' | 'INTERVAL';
-type RelationClassType = 'SYMMETRICAL' | 'OWNED';
+
 type RequiredKey<T, K extends keyof T> = T & {
     [P in K]-?: T[P];
 };
@@ -191,10 +94,16 @@ type BQLMutationBlock = {
     $relation: string;
 });
 type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$tempId' | '$op'>;
-type BQLFieldObj = {
-    $path: string;
-} & Omit<RawBQLQuery, '$entity' | '$relation'>;
-type BQLField = string | BQLFieldObj;
+type RawBQLMutation = ({
+    $entity: string;
+} | {
+    $relation: string;
+}) & Record<string, any>;
+type ParsedBQLMutation = {
+    things: BQLMutationBlock[];
+    edges: BQLMutationBlock[];
+};
+
 type RawBQLQuery = {
     $id?: string | string[];
     $filter?: Record<string, any>;
@@ -205,11 +114,6 @@ type RawBQLQuery = {
 } | {
     $relation: string;
 });
-type RawBQLMutation = ({
-    $entity: string;
-} | {
-    $relation: string;
-}) & Record<string, any>;
 type ParsedBQLQuery = Omit<RawBQLQuery, '$entity' | '$relation'> & {
     $localFilters?: Record<string, any>;
     $nestedFilters?: Record<string, any>;
@@ -218,10 +122,7 @@ type ParsedBQLQuery = Omit<RawBQLQuery, '$entity' | '$relation'> & {
 } | {
     $relation: EnrichedBormRelation;
 });
-type ParsedBQLMutation = {
-    things: BQLMutationBlock[];
-    edges: BQLMutationBlock[];
-};
+
 type TQLRequest = {
     entity?: string;
     roles?: {
@@ -247,15 +148,202 @@ type TQLEntityMutation = {
         request: string;
     }[];
 };
-type BQLResponseSingle = (({
-    $entity: string;
-    $id: 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[];
 } | {
-    $relation: string;
-    $id: string;
-}) | undefined) & Record<string, any>;
-type BQLResponseMulti = BQLResponseSingle[];
-type BQLResponse = BQLResponseSingle | BQLResponseMulti;
+    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 BormField = {
+    path: string;
+    cardinality: CardinalityType;
+    ordered?: boolean;
+    embedded?: boolean;
+    rights?: readonly RightType[];
+};
+type RoleField = {
+    cardinality: CardinalityType;
+    dbConnector?: DBConnector;
+};
+type LinkField = BormField & {
+    relation: string;
+    plays: string;
+} & ({
+    target: 'role';
+    filter?: Filter | Filter[];
+} | {
+    target: 'relation';
+});
+type LinkedFieldWithThing = LinkField & {
+    thing: string;
+    thingType: ThingType;
+};
+type DataField = BormField & {
+    shared?: boolean;
+    default?: any;
+    contentType: ContentType;
+    validations?: any;
+    isVirtual?: boolean;
+    dbConnectors?: [DBConnector, ...DBConnector[]];
+};
+type ContentType = 'ID' | 'JSON' | 'COLOR' | 'BOOLEAN' | 'POINT' | 'FILE' | 'EMAIL' | 'PHONE' | 'WEEK_DAY' | 'DURATION' | 'HOUR' | 'TIME' | 'DATE' | 'RATING' | 'CURRENCY' | 'PERCENTAGE' | 'NUMBER_DECIMAL' | 'NUMBER' | 'URL' | 'PASSWORD' | 'LANGUAGE_TEXT' | 'RICH_TEXT' | 'TEXT';
+type ContentTypeMapping = {
+    ID: string;
+    JSON: any;
+    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: Date;
+    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;
+} & Omit<RawBQLQuery, '$entity' | '$relation'>;
+type BQLField = string | BQLFieldObj;
+
+type EnrichedBormSchema = {
+    entities: {
+        [s: string]: EnrichedBormEntity;
+    };
+    relations: {
+        [s: string]: EnrichedBormRelation;
+    };
+};
+type EnrichedBormEntity = Omit<BormEntity, 'linkFields' | 'idFields' | 'dataFields'> & {
+    extends?: string;
+    allExtends?: string[];
+    idFields: string[];
+    thingType: 'entity';
+    name: string;
+    computedFields: string[];
+    virtualFields: string[];
+    linkFields?: EnrichedLinkField[];
+    dataFields?: EnrichedDataField[];
+};
+type EnrichedBormRelation = Omit<BormRelation, 'linkFields' | 'dataFields'> & {
+    thingType: 'relation';
+    name: string;
+    computedFields: string[];
+    virtualFields: string[];
+    linkFields?: EnrichedLinkField[];
+    dataFields?: EnrichedDataField[];
+    roles: {
+        [key: string]: EnrichedRoleField;
+    };
+};
+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'>[];
+});
+
+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;
@@ -270,27 +358,9 @@ declare class BormClient {
     init: () => Promise<void>;
     introspect: () => Promise<BormSchema>;
     define: () => Promise<void>;
-    query<T extends Record<string, any>>(query: RawBQLQuery & {
-        $filter: Record<string, any>;
-    } & ({
-        $entity: string;
-    } | {
-        $relation: string;
-    }), queryConfig?: any): Promise<(BQLResponseSingle & T)[] | (BQLResponseSingle & T)>;
-    query<T extends Record<string, any>>(query: RawBQLQuery & {
-        $id: string;
-    }, queryConfig?: any): Promise<BQLResponseSingle & T>;
-    query<T extends Record<string, any>>(query: RawBQLQuery & {
-        $id: string[];
-    }, queryConfig?: any): Promise<(BQLResponseSingle & T)[]>;
-    query<T extends Record<string, any>>(query: Omit<RawBQLQuery, '$id'> & ({
-        $entity: string;
-    } | {
-        $relation: string;
-    }), queryConfig?: any): Promise<(BQLResponseSingle & T)[]>;
-    mutate<T extends Record<string, any>>(mutation: RawBQLMutation, mutationConfig?: any): Promise<BQLResponseSingle & T>;
-    mutate(mutation: RawBQLMutation[], mutationConfig?: any): Promise<BQLResponseMulti>;
+    query: (query: RawBQLQuery, queryConfig?: any) => Promise<BQLResponse>;
+    mutate: (mutation: RawBQLMutation | RawBQLMutation[], mutationConfig?: any) => Promise<BQLResponseMulti>;
     close: () => Promise<void>;
 }
 
-export { BQLField, BQLFieldObj, BQLMutationBlock, BQLResponse, BQLResponseMulti, BQLResponseSingle, BormConfig, BormEntity, BormField, BormRelation, BormSchema, CardinalityType, CommonProperties, ContentType, DBConnector, DBHandles, DataField, DataFilter, EnrichedBormEntity, EnrichedBormRelation, EnrichedBormSchema, EnrichedDataField, EnrichedLinkField, EnrichedRoleField, FilledBQLMutationBlock, Filter, LinkField, LinkFilter, LinkedFieldWithThing, MiddleFilter, ParsedBQLMutation, ParsedBQLQuery, Provider, ProviderObject, RawBQLMutation, RawBQLQuery, RelationClassType, RightType, RoleField, TQLEntityMutation, TQLRequest, ThingType, TypeDBClusterProviderObject, TypeDBProviderObject, BormClient as default };
+export { BQLField, BQLFieldObj, BQLMutationBlock, BQLResponse, BQLResponseMulti, BQLResponseSingle, BormConfig, BormEntity, BormField, BormMetadata, BormRelation, BormSchema, CardinalityType, CommonProperties, ContentType, ContentTypeMapping, DBConnector, DBHandles, DataField, DataFilter, EnrichedBormEntity, EnrichedBormRelation, EnrichedBormSchema, EnrichedDataField, EnrichedLinkField, EnrichedRoleField, FilledBQLMutationBlock, Filter, LinkField, LinkFilter, LinkedFieldWithThing, MiddleFilter, ParsedBQLMutation, ParsedBQLQuery, Provider, ProviderObject, RawBQLMutation, RawBQLQuery, RightType, RoleField, TQLEntityMutation, TQLRequest, ThingType, TypeDBClusterProviderObject, TypeDBHandles, TypeDBProviderObject, TypeGen, WithBormMetadata, BormClient as default };