@blitznocode/blitz-orm 0.13.8 → 0.14.0

package/dist/index.d.mts

@@ -56,6 +56,7 @@ type QueryConfig = {
     returnNulls?: boolean;
     simplifiedLinks?: boolean;
     debugger?: boolean;
+    legacySurrealDBAdapter?: boolean;
 };
 type MutationConfig = {
     noMetadata?: boolean;
@@ -93,6 +94,30 @@ type AtLeastOne<T, U = {
 type DBHandles = AtLeastOne<AllDbHandles>;
 type DBHandleKey = keyof DBHandles;
 
+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<undefined | NextPipeline<Res>[]>;
+type Pipeline<Res extends BaseResponse> = PipelineOperation<Res>[];
+
 type ThingType = 'entity' | 'relation';
 type BormMetadata = {
     $id: string;
@@ -109,90 +134,32 @@ 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[];
-    refFields?: {
-        [key: string]: RefField;
-    };
-    hooks?: Hooks;
-} | {
-    idFields: readonly string[];
-    defaultDBConnector: DBConnector;
-    dataFields?: readonly DataField[];
-    linkFields?: readonly LinkField[];
-    refFields?: {
-        [key: string]: RefField;
-    };
-    hooks?: Hooks;
-};
-type BormRelation = BormEntity & {
-    defaultDBConnector: DBConnector & {
-        path: string;
-    };
+type TQLRequest = {
+    entity?: 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;
+        path: string;
+        request: string;
+        owner: string;
+    }[];
+    relations?: {
+        relation: string;
+        entity: string;
+        request: string;
+    }[];
+    insertionMatches?: string;
+    deletionMatches?: string;
+    insertions?: string;
+    deletions?: string;
 };
-
-type AdapterContext = {
-    mutation: {
-        splitArray$Ids: boolean;
-        requiresParseBQL: boolean;
-    };
+type TQLEntityMutation = {
+    entity: string;
+    relations?: {
+        relation: string;
+        entity: string;
+        request: string;
+    }[];
 };
 
-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;
@@ -222,6 +189,7 @@ type LinkField = BormField & {
 } & ({
     target: 'role';
     filter?: Filter | Filter[];
+    targetRole: string;
 } | {
     target: 'relation';
 });
@@ -359,6 +327,107 @@ type BQLFieldObj = {
 } & Omit<RawBQLQuery, '$entity' | '$relation' | '$thing' | '$thingType'>;
 type BQLField = string | BQLFieldObj;
 
+/**
+ * These types are design for SurrealDB query in mind. For other DBs or for mutation, they may be missing some fields.
+ */
+
+type Index = SingleIndex | CompositeIndex;
+interface SingleIndex {
+    type: 'single';
+    field: string;
+}
+interface CompositeIndex {
+    type: 'composite';
+    fields: [string, ...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[];
+    refFields?: {
+        [key: string]: RefField;
+    };
+    hooks?: Hooks;
+    indexes?: Index[];
+} | {
+    idFields: readonly string[];
+    defaultDBConnector: DBConnector;
+    dataFields?: readonly DataField[];
+    linkFields?: readonly LinkField[];
+    refFields?: {
+        [key: string]: RefField;
+    };
+    hooks?: Hooks;
+    indexes?: Index[];
+};
+type BormRelation = BormEntity & {
+    defaultDBConnector: DBConnector & {
+        path: string;
+    };
+    roles?: {
+        [key: string]: RoleField;
+    };
+    indexes?: Index[];
+};
+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 EnrichedBormSchema = {
     entities: {
         [s: string]: EnrichedBormEntity;
@@ -657,32 +726,6 @@ type ParsedBQLMutation = {
     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 = {
@@ -731,30 +774,6 @@ type ExtractRoles<S> = 'roles' extends keyof S ? {
 } : Record<string, 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<undefined | NextPipeline<Res>[]>;
-type Pipeline<Res extends BaseResponse> = PipelineOperation<Res>[];
-
 type BormProps = {
     schema: BormSchema;
     config: BormConfig;