@prisma/param-graph 7.7.0-integration-feat-prisma-bootstrap.7 → 7.7.0-integration-feat-bootstrap-ux-fixes.1

package/dist/index.d.mts

@@ -0,0 +1,262 @@
+/**
+ * Deserializes a binary-encoded ParamGraph.
+ */
+export declare function deserializeParamGraph(serialized: SerializedParamGraph): ParamGraphData;
+
+/**
+ * Bit flags for InputEdge.flags describing what the field accepts.
+ */
+export declare const EdgeFlag: {
+    /**
+     * Field may be parameterized as a scalar value.
+     * Check ScalarMask to validate the value type.
+     */
+    readonly ParamScalar: 1;
+    /**
+     * Field may be parameterized as an enum.
+     * Check enum ID to validate the value type.
+     */
+    readonly ParamEnum: 2;
+    /**
+     * Field accepts list-of-scalar values.
+     * Parameterize the whole list if all elements match ScalarMask.
+     */
+    readonly ParamListScalar: 4;
+    /**
+     * Field accepts list-of-enum values.
+     * Parameterize the whole list if all elements match enum ID.
+     */
+    readonly ParamListEnum: 8;
+    /**
+     * Field accepts list-of-object values.
+     * Recurse into each element using the child node.
+     */
+    readonly ListObject: 16;
+    /**
+     * Field accepts object values.
+     * Recurse into child input node.
+     */
+    readonly Object: 32;
+};
+
+export declare type EdgeFlagValue = (typeof EdgeFlag)[keyof typeof EdgeFlag];
+
+/**
+ * Function type for looking up enum values by name.
+ * This allows ParamGraph to remain decoupled from RuntimeDataModel.
+ */
+export declare type EnumLookup = (enumName: string) => Readonly<EnumNameToValueMap> | undefined;
+
+/**
+ * Map of enum names to their respective values.
+ */
+declare type EnumNameToValueMap = Record<string, string>;
+
+/**
+ * Helper function to get the scalar mask from an edge.
+ */
+export declare function getScalarMask(edge: InputEdge): number;
+
+/**
+ * Helper function to check if an edge has a specific flag.
+ */
+export declare function hasFlag(edge: InputEdge, flag: number): boolean;
+
+/**
+ * Readable view of input edge.
+ */
+export declare interface InputEdge {
+    readonly flags: number;
+    readonly childNodeId: number | undefined;
+    readonly scalarMask: number;
+    readonly enumNameIndex: number | undefined;
+}
+
+/**
+ * Input edge data: describes what a field accepts.
+ */
+export declare interface InputEdgeData {
+    /** Bit flags describing field capabilities (see EdgeFlag) */
+    flags: number;
+    /** Child input node id (for object values) */
+    childNodeId?: number;
+    /** Scalar type mask (see ScalarMask) */
+    scalarMask?: number;
+    /** Enum name index into string table */
+    enumNameIndex?: number;
+}
+
+/**
+ * Readable view of input node.
+ */
+export declare interface InputNode {
+    readonly id: number;
+}
+
+/**
+ * Input node data: describes parameterizable fields in an input object.
+ */
+export declare interface InputNodeData {
+    /** Map from string-table index to edge descriptor */
+    edges: Record<number, InputEdgeData>;
+}
+
+/**
+ * Readable view of output edge.
+ */
+export declare interface OutputEdge {
+    readonly argsNodeId: number | undefined;
+    readonly outputNodeId: number | undefined;
+}
+
+/**
+ * Output edge data: describes a field in a selection set.
+ */
+export declare interface OutputEdgeData {
+    /** Args node id for this field */
+    argsNodeId?: number;
+    /** Next output node id for nested selection */
+    outputNodeId?: number;
+}
+
+/**
+ * Readable view of output node.
+ */
+export declare interface OutputNode {
+    readonly id: number;
+}
+
+/**
+ * Output node data: describes fields in a selection set.
+ */
+export declare interface OutputNodeData {
+    /** Map from string-table index to edge descriptor */
+    edges: Record<number, OutputEdgeData>;
+}
+
+/**
+ * ParamGraph provides runtime access to the schema information
+ * needed for parameterization decisions.
+ */
+export declare class ParamGraph {
+    #private;
+    private constructor();
+    /**
+     * Creates a ParamGraph from serialized format.
+     * This is the primary factory method for runtime use.
+     */
+    static deserialize(serialized: SerializedParamGraph, enumLookup: EnumLookup): ParamGraph;
+    /**
+     * Creates a ParamGraph from builder data.
+     * Used by the builder for testing and direct construction.
+     */
+    static fromData(data: ParamGraphData, enumLookup: EnumLookup): ParamGraph;
+    /**
+     * Look up a root entry by "Model.action" or "action".
+     */
+    root(key: string): RootEntry | undefined;
+    /**
+     * Get an input node by ID.
+     */
+    inputNode(id: number | undefined): InputNode | undefined;
+    /**
+     * Get an output node by ID.
+     */
+    outputNode(id: number | undefined): OutputNode | undefined;
+    /**
+     * Get an input edge for a field name within a node.
+     */
+    inputEdge(node: InputNode | undefined, fieldName: string): InputEdge | undefined;
+    /**
+     * Get an output edge for a field name within a node.
+     */
+    outputEdge(node: OutputNode | undefined, fieldName: string): OutputEdge | undefined;
+    /**
+     * Get enum values for an edge that references a user enum.
+     * Returns undefined if the edge doesn't reference an enum.
+     */
+    enumValues(edge: InputEdge | undefined): Readonly<EnumNameToValueMap> | undefined;
+    /**
+     * Get a string from the string table by index.
+     */
+    getString(index: number): string | undefined;
+}
+
+/**
+ * Internal data types for ParamGraph.
+ *
+ * These types represent the in-memory structure of the param graph,
+ * used both during building and after deserialization.
+ */
+/**
+ * Complete param graph data structure.
+ * This is the internal representation, not the serialized format.
+ */
+export declare interface ParamGraphData {
+    /** String table containing field names and enum names */
+    strings: string[];
+    /** Input nodes for argument objects and input types */
+    inputNodes: InputNodeData[];
+    /** Output nodes for selection traversal */
+    outputNodes: OutputNodeData[];
+    /** Root mapping: "Model.action" -> entry */
+    roots: Record<string, RootEntryData>;
+}
+
+/**
+ * Readable view of root entry.
+ */
+export declare interface RootEntry {
+    readonly argsNodeId: number | undefined;
+    readonly outputNodeId: number | undefined;
+}
+
+/**
+ * Root entry data: entry point for an operation.
+ */
+export declare interface RootEntryData {
+    /** Args node id */
+    argsNodeId?: number;
+    /** Output node id */
+    outputNodeId?: number;
+}
+
+/**
+ * Bit mask for scalar type categories.
+ * Used in InputEdge.scalarMask to validate runtime value types.
+ */
+export declare const ScalarMask: {
+    readonly String: 1;
+    readonly Int: 2;
+    readonly BigInt: 4;
+    readonly Float: 8;
+    readonly Decimal: 16;
+    readonly Boolean: 32;
+    readonly DateTime: 64;
+    readonly Json: 128;
+    readonly Bytes: 256;
+};
+
+export declare type ScalarMaskValue = (typeof ScalarMask)[keyof typeof ScalarMask];
+
+/**
+ * Maps DMMF scalar type names to ScalarMask values.
+ */
+export declare function scalarTypeToMask(typeName: string): number;
+
+/**
+ * Serialized format stored in the generated client.
+ */
+export declare interface SerializedParamGraph {
+    /** String table (field names, enum names, root keys) */
+    strings: string[];
+    /** Base64url-encoded binary blob for structural data */
+    graph: string;
+}
+
+/**
+ * Serializes a ParamGraphData to the compact binary format.
+ */
+export declare function serializeParamGraph(data: ParamGraphData): SerializedParamGraph;
+
+export { }

package/dist/index.d.ts

@@ -1,7 +1,262 @@
-export type { EnumLookup, InputEdge, InputNode, OutputEdge, OutputNode, RootEntry } from './param-graph';
-export type { InputEdgeData, InputNodeData, OutputEdgeData, OutputNodeData, ParamGraphData, RootEntryData, } from './param-graph';
-export type { EdgeFlagValue, ScalarMaskValue } from './param-graph';
-export { ParamGraph } from './param-graph';
-export { EdgeFlag, getScalarMask, hasFlag, ScalarMask, scalarTypeToMask } from './param-graph';
-export type { SerializedParamGraph } from './serialization';
-export { deserializeParamGraph, serializeParamGraph } from './serialization';
+/**
+ * Deserializes a binary-encoded ParamGraph.
+ */
+export declare function deserializeParamGraph(serialized: SerializedParamGraph): ParamGraphData;
+
+/**
+ * Bit flags for InputEdge.flags describing what the field accepts.
+ */
+export declare const EdgeFlag: {
+    /**
+     * Field may be parameterized as a scalar value.
+     * Check ScalarMask to validate the value type.
+     */
+    readonly ParamScalar: 1;
+    /**
+     * Field may be parameterized as an enum.
+     * Check enum ID to validate the value type.
+     */
+    readonly ParamEnum: 2;
+    /**
+     * Field accepts list-of-scalar values.
+     * Parameterize the whole list if all elements match ScalarMask.
+     */
+    readonly ParamListScalar: 4;
+    /**
+     * Field accepts list-of-enum values.
+     * Parameterize the whole list if all elements match enum ID.
+     */
+    readonly ParamListEnum: 8;
+    /**
+     * Field accepts list-of-object values.
+     * Recurse into each element using the child node.
+     */
+    readonly ListObject: 16;
+    /**
+     * Field accepts object values.
+     * Recurse into child input node.
+     */
+    readonly Object: 32;
+};
+
+export declare type EdgeFlagValue = (typeof EdgeFlag)[keyof typeof EdgeFlag];
+
+/**
+ * Function type for looking up enum values by name.
+ * This allows ParamGraph to remain decoupled from RuntimeDataModel.
+ */
+export declare type EnumLookup = (enumName: string) => Readonly<EnumNameToValueMap> | undefined;
+
+/**
+ * Map of enum names to their respective values.
+ */
+declare type EnumNameToValueMap = Record<string, string>;
+
+/**
+ * Helper function to get the scalar mask from an edge.
+ */
+export declare function getScalarMask(edge: InputEdge): number;
+
+/**
+ * Helper function to check if an edge has a specific flag.
+ */
+export declare function hasFlag(edge: InputEdge, flag: number): boolean;
+
+/**
+ * Readable view of input edge.
+ */
+export declare interface InputEdge {
+    readonly flags: number;
+    readonly childNodeId: number | undefined;
+    readonly scalarMask: number;
+    readonly enumNameIndex: number | undefined;
+}
+
+/**
+ * Input edge data: describes what a field accepts.
+ */
+export declare interface InputEdgeData {
+    /** Bit flags describing field capabilities (see EdgeFlag) */
+    flags: number;
+    /** Child input node id (for object values) */
+    childNodeId?: number;
+    /** Scalar type mask (see ScalarMask) */
+    scalarMask?: number;
+    /** Enum name index into string table */
+    enumNameIndex?: number;
+}
+
+/**
+ * Readable view of input node.
+ */
+export declare interface InputNode {
+    readonly id: number;
+}
+
+/**
+ * Input node data: describes parameterizable fields in an input object.
+ */
+export declare interface InputNodeData {
+    /** Map from string-table index to edge descriptor */
+    edges: Record<number, InputEdgeData>;
+}
+
+/**
+ * Readable view of output edge.
+ */
+export declare interface OutputEdge {
+    readonly argsNodeId: number | undefined;
+    readonly outputNodeId: number | undefined;
+}
+
+/**
+ * Output edge data: describes a field in a selection set.
+ */
+export declare interface OutputEdgeData {
+    /** Args node id for this field */
+    argsNodeId?: number;
+    /** Next output node id for nested selection */
+    outputNodeId?: number;
+}
+
+/**
+ * Readable view of output node.
+ */
+export declare interface OutputNode {
+    readonly id: number;
+}
+
+/**
+ * Output node data: describes fields in a selection set.
+ */
+export declare interface OutputNodeData {
+    /** Map from string-table index to edge descriptor */
+    edges: Record<number, OutputEdgeData>;
+}
+
+/**
+ * ParamGraph provides runtime access to the schema information
+ * needed for parameterization decisions.
+ */
+export declare class ParamGraph {
+    #private;
+    private constructor();
+    /**
+     * Creates a ParamGraph from serialized format.
+     * This is the primary factory method for runtime use.
+     */
+    static deserialize(serialized: SerializedParamGraph, enumLookup: EnumLookup): ParamGraph;
+    /**
+     * Creates a ParamGraph from builder data.
+     * Used by the builder for testing and direct construction.
+     */
+    static fromData(data: ParamGraphData, enumLookup: EnumLookup): ParamGraph;
+    /**
+     * Look up a root entry by "Model.action" or "action".
+     */
+    root(key: string): RootEntry | undefined;
+    /**
+     * Get an input node by ID.
+     */
+    inputNode(id: number | undefined): InputNode | undefined;
+    /**
+     * Get an output node by ID.
+     */
+    outputNode(id: number | undefined): OutputNode | undefined;
+    /**
+     * Get an input edge for a field name within a node.
+     */
+    inputEdge(node: InputNode | undefined, fieldName: string): InputEdge | undefined;
+    /**
+     * Get an output edge for a field name within a node.
+     */
+    outputEdge(node: OutputNode | undefined, fieldName: string): OutputEdge | undefined;
+    /**
+     * Get enum values for an edge that references a user enum.
+     * Returns undefined if the edge doesn't reference an enum.
+     */
+    enumValues(edge: InputEdge | undefined): Readonly<EnumNameToValueMap> | undefined;
+    /**
+     * Get a string from the string table by index.
+     */
+    getString(index: number): string | undefined;
+}
+
+/**
+ * Internal data types for ParamGraph.
+ *
+ * These types represent the in-memory structure of the param graph,
+ * used both during building and after deserialization.
+ */
+/**
+ * Complete param graph data structure.
+ * This is the internal representation, not the serialized format.
+ */
+export declare interface ParamGraphData {
+    /** String table containing field names and enum names */
+    strings: string[];
+    /** Input nodes for argument objects and input types */
+    inputNodes: InputNodeData[];
+    /** Output nodes for selection traversal */
+    outputNodes: OutputNodeData[];
+    /** Root mapping: "Model.action" -> entry */
+    roots: Record<string, RootEntryData>;
+}
+
+/**
+ * Readable view of root entry.
+ */
+export declare interface RootEntry {
+    readonly argsNodeId: number | undefined;
+    readonly outputNodeId: number | undefined;
+}
+
+/**
+ * Root entry data: entry point for an operation.
+ */
+export declare interface RootEntryData {
+    /** Args node id */
+    argsNodeId?: number;
+    /** Output node id */
+    outputNodeId?: number;
+}
+
+/**
+ * Bit mask for scalar type categories.
+ * Used in InputEdge.scalarMask to validate runtime value types.
+ */
+export declare const ScalarMask: {
+    readonly String: 1;
+    readonly Int: 2;
+    readonly BigInt: 4;
+    readonly Float: 8;
+    readonly Decimal: 16;
+    readonly Boolean: 32;
+    readonly DateTime: 64;
+    readonly Json: 128;
+    readonly Bytes: 256;
+};
+
+export declare type ScalarMaskValue = (typeof ScalarMask)[keyof typeof ScalarMask];
+
+/**
+ * Maps DMMF scalar type names to ScalarMask values.
+ */
+export declare function scalarTypeToMask(typeName: string): number;
+
+/**
+ * Serialized format stored in the generated client.
+ */
+export declare interface SerializedParamGraph {
+    /** String table (field names, enum names, root keys) */
+    strings: string[];
+    /** Base64url-encoded binary blob for structural data */
+    graph: string;
+}
+
+/**
+ * Serializes a ParamGraphData to the compact binary format.
+ */
+export declare function serializeParamGraph(data: ParamGraphData): SerializedParamGraph;
+
+export { }