@blitznocode/blitz-orm 0.0.42 → 0.0.44

package/dist/index.d.ts

@@ -0,0 +1,255 @@
+import { TypeDBClient, TypeDBSession } from 'typedb-client';
+
+type BormConfig = {
+    server: {
+        provider: 'blitz-orm-js';
+    };
+    query?: {
+        noMetadata?: boolean;
+        simplifiedLinks?: boolean;
+    };
+    mutation?: {
+        noMetadata?: boolean;
+    };
+    dbConnectors: [ProviderObject, ...ProviderObject[]];
+};
+type ProviderObject = {
+    id: string;
+    provider: 'typeDB';
+    dbName: string;
+    url: string;
+};
+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 & {
+    roles?: {
+        [key: string]: RoleField;
+    };
+};
+type EnrichedBormEntity = Omit<BormEntity, 'linkFields' | 'idFields' | 'dataFields'> & {
+    extends?: string;
+    idFields: string[];
+    thingType: 'entity';
+    name: string;
+    computedFields: string[];
+    linkFields?: EnrichedLinkField[];
+    dataFields?: EnrichedDataField[];
+};
+type EnrichedBormRelation = Omit<BormRelation, 'linkFields' | 'dataFields'> & {
+    thingType: 'relation';
+    name: string;
+    computedFields: 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 RequireAtLeastOne<T> = {
+    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
+}[keyof T];
+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 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[];
+};
+type DataField = BormField & {
+    shared?: boolean;
+    default?: any;
+    contentType: ContentType;
+    validations?: any;
+    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];
+};
+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;
+});
+type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$tempId' | '$op'>;
+type BQLFieldObj = {
+    $path: string;
+} & Omit<RawBQLQuery, '$entity' | '$relation'>;
+type BQLField = string | BQLFieldObj;
+type RawBQLQuery = {
+    $id?: string | string[];
+    $filter?: Record<string, any>;
+    $fields?: BQLField[];
+} & ({
+    $entity: string;
+} | {
+    $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>;
+} & ({
+    $entity: EnrichedBormEntity;
+} | {
+    $relation: EnrichedBormRelation;
+});
+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 BQLResponseSingle = (({
+    $entity: string;
+    $id: string;
+} | undefined) & Record<string, any>) | string | null;
+type BQLResponseMulti = BQLResponseSingle[];
+type BQLResponse = BQLResponseSingle | BQLResponseMulti;
+
+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>;
+    query: (query: RawBQLQuery, queryConfig?: any) => Promise<void | BQLResponse>;
+    mutate: (mutation: RawBQLMutation | RawBQLMutation[], mutationConfig?: any) => Promise<void | BQLResponse>;
+    close: () => Promise<void>;
+}
+
+export { BQLField, BQLFieldObj, BQLMutationBlock, BQLResponse, BQLResponseMulti, BQLResponseSingle, BormConfig, BormEntity, BormField, BormRelation, BormSchema, CardinalityType, ContentType, DBConnector, DBHandles, DataField, DataFilter, EnrichedBormEntity, EnrichedBormRelation, EnrichedBormSchema, EnrichedDataField, EnrichedLinkField, EnrichedRoleField, FilledBQLMutationBlock, Filter, LinkField, LinkFilter, LinkedFieldWithThing, MiddleFilter, ParsedBQLMutation, ParsedBQLQuery, ProviderObject, RawBQLMutation, RawBQLQuery, RelationClassType, RightType, RoleField, TQLEntityMutation, TQLRequest, ThingType, BormClient as default };