@blitznocode/blitz-orm 0.9.19 → 0.10.0

package/dist/index.d.ts

@@ -1,10 +1,27 @@
 import { TypeDBCredential, TypeDBDriver, TypeDBSession } from 'typedb-driver';
+import { Surreal } from 'surrealdb.node';
 
-interface TypeDBProviderObject {
+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;
+
+interface TypeDBProvider extends CommonProvider {
     provider: 'typeDB';
     url: string;
 }
-interface TypeDBClusterProviderObject {
+interface TypeDBClusterProvider extends CommonProvider {
     provider: 'typeDBCluster';
     addresses: string[];
     credentials: TypeDBCredential;
@@ -14,6 +31,17 @@ type TypeDBHandles = Map<string, {
     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;
@@ -32,14 +60,13 @@ type BormConfig = {
     };
     query?: QueryConfig;
     mutation?: MutationConfig;
-    dbConnectors: [ProviderObject, ...ProviderObject[]];
+    dbConnectors: [Provider, ...Provider[]];
 };
-type ProviderObject = (TypeDBProviderObject & CommonProperties) | (TypeDBClusterProviderObject & CommonProperties);
-interface CommonProperties {
+type Provider = TypeDBProvider | TypeDBClusterProvider | SurrealDBProviderObject;
+interface CommonProvider {
     id: string;
     dbName: string;
 }
-type Provider = 'typeDB' | 'typeDBCluster';
 type DBConnector = {
     id: string;
     subs?: string;
@@ -48,7 +75,7 @@ type DBConnector = {
 };
 type AllDbHandles = {
     typeDB: TypeDBHandles;
-    surrealDB: any;
+    surrealDB: SurrealDBHandles;
 };
 type AtLeastOne<T, U = {
     [K in keyof T]: Pick<T, K>;
@@ -56,41 +83,6 @@ type AtLeastOne<T, 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, 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 BormSchema = {
     entities: {
         [s: string]: BormEntity;
@@ -161,18 +153,18 @@ type AdapterContext = {
 
 type BormField = {
     path: string;
-    cardinality?: CardinalityType;
+    cardinality?: DiscreteCardinality;
     ordered?: boolean;
     embedded?: boolean;
     rights?: readonly RightType[];
 };
 type RoleField = {
-    cardinality: CardinalityType;
+    cardinality: DiscreteCardinality;
     dbConnector?: DBConnector;
 };
 type LinkField = BormField & {
     relation: string;
-    cardinality: CardinalityType;
+    cardinality: DiscreteCardinality;
     plays: string;
 } & ({
     target: 'role';
@@ -244,6 +236,7 @@ type BooleanField = BormField & {
 };
 type AllDataField = StringField | NumberField | DateField | BooleanField;
 type DataField = BormField & {
+    cardinality?: Cardinality;
     shared?: boolean;
     validations?: {
         required?: boolean;
@@ -281,7 +274,8 @@ type ContentTypeMapping = {
     RICH_TEXT: string;
     TEXT: string;
 };
-type CardinalityType = 'ONE' | 'MANY' | 'INTERVAL';
+type DiscreteCardinality = 'ONE' | 'MANY';
+type Cardinality = DiscreteCardinality | 'INTERVAL';
 type RightType = 'CREATE' | 'DELETE' | 'UPDATE' | 'LINK' | 'UNLINK';
 type BQLFieldObj = {
     $path: string;
@@ -329,7 +323,7 @@ type EnrichedRoleField = RoleField & {
 type EnrichedDataField = DataField & {
     dbPath: string;
 };
-type EnrichedLinkField = BormField & {
+type EnrichedLinkField = LinkField & {
     name: string;
     relation: string;
     plays: string;
@@ -344,9 +338,133 @@ type EnrichedLinkField = BormField & {
 });
 
 declare const Schema: unique symbol;
+declare const QueryPath: unique symbol;
 declare const EdgeType: unique symbol;
 declare const EdgeSchema: unique symbol;
 
+type Sorter = {
+    field: string;
+    desc?: boolean;
+} | string;
+type FilterValue = string | number | boolean | string[] | number[] | boolean[];
+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;
+};
+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;
+    $filterProcessed: boolean;
+    $sort?: Sorter[];
+    $offset?: number;
+    $limit?: number;
+    [QueryPath]: string;
+};
+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;
+    $filterProcessed: boolean;
+    $sort?: Sorter[];
+    $offset?: number;
+    $limit?: number;
+    [QueryPath]: string;
+};
+type EnrichedFieldQuery = EnrichedAttributeQuery | EnrichedLinkQuery | EnrichedRoleQuery;
+type EnrichedEntityQuery = {
+    $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 = {
+    $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];
 };
@@ -355,7 +473,7 @@ type BQLMutation = RootBQLMutationBlock | RootBQLMutationBlock[];
 type RootBQLMutationBlock = {
     [key: string]: any;
     $id?: string | string[];
-    $filter?: Filter | Filter[];
+    $filter?: Filter;
     $tempId?: string;
     $op?: string;
 } & ({
@@ -369,7 +487,7 @@ type RootBQLMutationBlock = {
 type BQLMutationBlock = {
     [key: string]: any;
     $id?: string | string[];
-    $filter?: Filter | Filter[];
+    $filter?: Filter;
     $tempId?: string;
     $op?: string;
     $entity?: string;
@@ -386,7 +504,7 @@ type FilledBQLMutationBlock = WithRequired<BQLMutationBlock, '$op'> & {
 type EnrichedBQLMutationBlock = {
     [key: string]: any;
     $id?: string | string[];
-    $filter?: Filter | Filter[];
+    $filter?: Filter;
     $tempId?: string;
     $op: BormOperation;
     $thing: string;
@@ -408,28 +526,6 @@ type ParsedBQLMutation = {
     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?: {
@@ -504,6 +600,30 @@ type ExtractRoles<S> = 'roles' extends keyof S ? {
 } : {};
 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;
@@ -518,9 +638,9 @@ declare class BormClient {
     init: () => Promise<void>;
     introspect: () => Promise<BormSchema>;
     define: () => Promise<void>;
-    query: (query: RawBQLQuery | RawBQLQuery[], queryConfig?: QueryConfig) => Promise<BQLResponse>;
+    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 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 DBHandleKey, type DBHandles, type DataField, type DataFilter, type EnrichedBQLMutationBlock, 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 MutationConfig, type NodeFunctionParams, type ParsedBQLMutation, type ParsedBQLQuery, type PreHook, type Provider, type ProviderObject, type QueryConfig, type RawBQLMutation, type RawBQLQuery, type RightType, type RoleField, type RootBQLMutationBlock, type TQLEntityMutation, type TQLRequest, type ThingType, type TransFormAction, type TypeDBClusterProviderObject, type TypeDBHandles, type TypeDBProviderObject, type TypeGen, type ValidateAction, type WithBormMetadata, BormClient as default };
+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 };