@machynx/data-db 1.0.6 → 1.0.7

package/client/runtime/client.d.ts

@@ -1,5 +1,7 @@
 import { AnyNull } from '@prisma/client-runtime-utils';
+import { AnyNullClass } from '@prisma/client-runtime-utils';
 import { DbNull } from '@prisma/client-runtime-utils';
+import { DbNullClass } from '@prisma/client-runtime-utils';
 import { Decimal } from '@prisma/client-runtime-utils';
 import { empty } from '@prisma/client-runtime-utils';
 import { isAnyNull } from '@prisma/client-runtime-utils';
@@ -7,6 +9,7 @@ import { isDbNull } from '@prisma/client-runtime-utils';
 import { isJsonNull } from '@prisma/client-runtime-utils';
 import { join } from '@prisma/client-runtime-utils';
 import { JsonNull } from '@prisma/client-runtime-utils';
+import { JsonNullClass } from '@prisma/client-runtime-utils';
 import { NullTypes } from '@prisma/client-runtime-utils';
 import { ObjectEnumValue } from '@prisma/client-runtime-utils';
 import { PrismaClientInitializationError } from '@prisma/client-runtime-utils';
@@ -87,6 +90,8 @@ export declare type AllModelsToStringIndex<TypeMap extends TypeMapDef, Args exte
 
 export { AnyNull }
 
+export { AnyNullClass }
+
 export declare type ApplyOmit<T, OmitConfig> = Compute<{
     [K in keyof T as OmitValue<OmitConfig, K> extends true ? never : K]: T[K];
 }>;
@@ -271,6 +276,7 @@ declare type CompilerWasmLoadingConfig = {
      * @remarks only used by ClientEngine
      */
     getQueryCompilerWasmModule: () => Promise<unknown>;
+    importName: string;
 };
 
 export declare type Compute<T> = T extends Function ? T : {
@@ -384,13 +390,6 @@ declare type DatamodelEnum = ReadonlyDeep_2<{
 
 declare function datamodelEnumToSchemaEnum(datamodelEnum: DatamodelEnum): SchemaEnum;
 
-declare type DatamodelSchemaEnum = ReadonlyDeep_2<{
-    name: string;
-    values: string[];
-}>;
-
-declare function datamodelSchemaEnumToSchemaEnum(datamodelSchemaEnum: DatamodelSchemaEnum): SchemaEnum;
-
 declare type DataRule = {
     type: 'rowCountEq';
     args: number;
@@ -406,6 +405,8 @@ declare type DataRule = {
 
 export { DbNull }
 
+export { DbNullClass }
+
 export declare const Debug: typeof debugCreate & {
     enable(namespace: any): void;
     disable(): any;
@@ -497,12 +498,10 @@ export declare type DevTypeMapFnDef = {
 export declare namespace DMMF {
     export {
         datamodelEnumToSchemaEnum,
-        datamodelSchemaEnumToSchemaEnum,
         Document_2 as Document,
         Mappings,
         OtherOperationMappings,
         DatamodelEnum,
-        DatamodelSchemaEnum,
         SchemaEnum,
         EnumValue,
         Datamodel,
@@ -541,12 +540,10 @@ export declare namespace DMMF {
 declare namespace DMMF_2 {
     export {
         datamodelEnumToSchemaEnum,
-        datamodelSchemaEnumToSchemaEnum,
         Document_2 as Document,
         Mappings,
         OtherOperationMappings,
         DatamodelEnum,
-        DatamodelSchemaEnum,
         SchemaEnum,
         EnumValue,
         Datamodel,
@@ -795,6 +792,20 @@ declare interface EngineConfig {
      * Web Assembly module loading configuration
      */
     compilerWasm?: CompilerWasmLoadingConfig;
+    /**
+     * SQL commenter plugins that add metadata to SQL queries as comments.
+     * Each plugin receives query context and returns key-value pairs.
+     */
+    sqlCommenters?: SqlCommenterPlugin[];
+    /**
+     * Parameterization schema (ParamGraph) for schema-aware query parameterization.
+     * Enables precise parameterization based on DMMF metadata.
+     */
+    parameterizationSchema: SerializedParamGraph;
+    /**
+     * Runtime data model for enum lookups during parameterization.
+     */
+    runtimeDataModel: RuntimeDataModel;
 }
 
 declare type EngineEvent<E extends EngineEventType> = E extends QueryEventType ? QueryEvent : LogEvent;
@@ -861,7 +872,7 @@ declare interface ExceptionWithName {
 
 declare type ExtendedEventType = LogLevel | 'beforeExit';
 
-declare type ExtendedSpanOptions = SpanOptions & {
+declare interface ExtendedSpanOptions extends SpanOptions {
     /** The name of the span */
     name: string;
     internal?: boolean;
@@ -869,7 +880,7 @@ declare type ExtendedSpanOptions = SpanOptions & {
     active?: boolean;
     /** The context to append the span to */
     context?: Context;
-};
+}
 
 /** $extends, defineExtension */
 export declare interface ExtendsHook<Variant extends 'extends' | 'define', TypeMapCb extends TypeMapCbDef, ExtArgs extends Record<string, any>, TypeMap extends TypeMapDef = Call<TypeMapCb, {
@@ -1294,6 +1305,11 @@ export declare type GetPrismaClientConfig = {
      * Optional wasm loading configuration
      */
     compilerWasm?: CompilerWasmLoadingConfig;
+    /**
+     * Parameterization schema for schema-aware query parameterization.
+     * Enables precise parameterization based on DMMF metadata.
+     */
+    parameterizationSchema: SerializedParamGraph;
 };
 
 export declare type GetResult<Payload extends OperationPayload, Args, OperationName extends Operation = 'findUniqueOrThrow', GlobalOmitOptions = {}> = {
@@ -1591,6 +1607,8 @@ declare type JsonFieldSelection = {
 
 export { JsonNull }
 
+export { JsonNullClass }
+
 /**
  * From https://github.com/sindresorhus/type-fest/
  * Matches a JSON object.
@@ -1602,12 +1620,14 @@ export declare type JsonObject = {
 
 export declare type JsonQuery = {
     modelName?: string;
-    action: JsonQueryAction;
+    action: JsonQueryAction_2;
     query: JsonFieldSelection;
 };
 
 declare type JsonQueryAction = 'findUnique' | 'findUniqueOrThrow' | 'findFirst' | 'findFirstOrThrow' | 'findMany' | 'createOne' | 'createMany' | 'createManyAndReturn' | 'updateOne' | 'updateMany' | 'updateManyAndReturn' | 'deleteOne' | 'deleteMany' | 'upsertOne' | 'aggregate' | 'groupBy' | 'executeRaw' | 'queryRaw' | 'runCommandRaw' | 'findRaw' | 'aggregateRaw';
 
+declare type JsonQueryAction_2 = 'findUnique' | 'findUniqueOrThrow' | 'findFirst' | 'findFirstOrThrow' | 'findMany' | 'createOne' | 'createMany' | 'createManyAndReturn' | 'updateOne' | 'updateMany' | 'updateManyAndReturn' | 'deleteOne' | 'deleteMany' | 'upsertOne' | 'aggregate' | 'groupBy' | 'executeRaw' | 'queryRaw' | 'runCommandRaw' | 'findRaw' | 'aggregateRaw';
+
 declare type JsonSelectionSet = {
     $scalars?: boolean;
     $composites?: boolean;
@@ -2004,10 +2024,26 @@ export declare type PrismaClientOptions = PrismaClientMutuallyExclusiveOptions &
      *  { emit: 'stdout', level: 'warn' }
      * ]
      * \`\`\`
-     * Read more in our [docs](https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-client/logging#the-log-option).
+     * Read more in our [docs](https://pris.ly/d/logging).
      */
     log?: Array<LogLevel | LogDefinition>;
     omit?: GlobalOmitOptions;
+    /**
+     * SQL commenter plugins that add metadata to SQL queries as comments.
+     * Comments follow the sqlcommenter format: https://google.github.io/sqlcommenter/
+     *
+     * @example
+     * ```ts
+     * new PrismaClient({
+     *   adapter: new PrismaPg({ connectionString }),
+     *   comments: [
+     *     traceContext(),
+     *     queryInsights(),
+     *   ],
+     * })
+     * ```
+     */
+    comments?: SqlCommenterPlugin[];
     /**
      * @internal
      * You probably don't want to use this. \`__internal\` is used by internal tooling.
@@ -2540,8 +2576,8 @@ declare type Schema = ReadonlyDeep_2<{
         prisma: OutputType[];
     };
     enumTypes: {
-        model?: DatamodelSchemaEnum[];
-        prisma: DatamodelSchemaEnum[];
+        model?: SchemaEnum[];
+        prisma: SchemaEnum[];
     };
     fieldRefTypes: {
         prisma?: FieldRefType[];
@@ -2554,16 +2590,14 @@ declare type SchemaArg = ReadonlyDeep_2<{
     isNullable: boolean;
     isRequired: boolean;
     inputTypes: InputTypeRef[];
+    isParameterizable: boolean;
     requiresOtherFields?: string[];
     deprecation?: Deprecation;
 }>;
 
 declare type SchemaEnum = ReadonlyDeep_2<{
     name: string;
-    data: {
-        key: string;
-        value: string;
-    }[];
+    values: string[];
 }>;
 
 declare type SchemaField = ReadonlyDeep_2<{
@@ -2596,7 +2630,17 @@ export declare type SelectField<P extends SelectablePayloadFields<any, any>, K e
 declare type Selection_2 = Record<string, boolean | Skip | JsArgs>;
 export { Selection_2 as Selection }
 
-export declare function serializeJsonQuery({ modelName, action, args, runtimeDataModel, extensions, callsite, clientMethod, errorFormat, clientVersion, previewFeatures, globalOmit, }: SerializeParams): JsonQuery;
+/**
+ * Serialized format stored in the generated client.
+ */
+declare interface SerializedParamGraph {
+    /** String table (field names, enum names, root keys) */
+    strings: string[];
+    /** Base64url-encoded binary blob for structural data */
+    graph: string;
+}
+
+export declare function serializeJsonQuery({ modelName, action, args, runtimeDataModel, extensions, callsite, clientMethod, errorFormat, clientVersion, previewFeatures, globalOmit, wrapRawValues, }: SerializeParams): JsonQuery;
 
 declare type SerializeParams = {
     runtimeDataModel: RuntimeDataModel;
@@ -2610,6 +2654,7 @@ declare type SerializeParams = {
     errorFormat: ErrorFormat;
     previewFeatures: string[];
     globalOmit?: GlobalOmitOptions;
+    wrapRawValues?: boolean;
 };
 
 declare class Skip {
@@ -2873,6 +2918,111 @@ declare enum SpanStatusCode {
 
 export { Sql }
 
+/**
+ * Information about a compacted batch query (e.g. multiple independent
+ * `findUnique` queries automatically merged into a single `SELECT` SQL
+ * statement).
+ */
+declare interface SqlCommenterCompactedQueryInfo {
+    /**
+     * The model name (e.g., "User", "Post").
+     */
+    readonly modelName: string;
+    /**
+     * The Prisma operation (e.g., "findUnique").
+     */
+    readonly action: SqlCommenterQueryAction;
+    /**
+     * The full query objects (selections, arguments, etc.).
+     * Specifics of the query representation are not part of the public API yet.
+     */
+    readonly queries: ReadonlyArray<unknown>;
+}
+
+/**
+ * Context provided to SQL commenter plugins.
+ */
+export declare interface SqlCommenterContext {
+    /**
+     * Information about the Prisma query being executed.
+     */
+    readonly query: SqlCommenterQueryInfo;
+    /**
+     * Raw SQL query generated from this Prisma query.
+     *
+     * It is always available when `PrismaClient` connects to the database and
+     * renders SQL queries directly.
+     *
+     * When using Prisma Accelerate, SQL rendering happens on Accelerate side and the raw
+     * SQL strings are not yet available when SQL commenter plugins are executed.
+     */
+    readonly sql?: string;
+}
+
+/**
+ * A SQL commenter plugin that returns key-value pairs to be added as comments.
+ * Return an empty object to add no comments. Keys with undefined values will be omitted.
+ *
+ * @example
+ * ```ts
+ * const myPlugin: SqlCommenterPlugin = (context) => {
+ *   return {
+ *     application: 'my-app',
+ *     model: context.query.modelName ?? 'raw',
+ *     // Conditional key - will be omitted if ctx.sql is undefined
+ *     sqlLength: context.sql ? String(context.sql.length) : undefined,
+ *   }
+ * }
+ * ```
+ */
+export declare interface SqlCommenterPlugin {
+    (context: SqlCommenterContext): SqlCommenterTags;
+}
+
+/**
+ * Prisma query type corresponding to this SQL query.
+ */
+declare type SqlCommenterQueryAction = JsonQueryAction;
+
+/**
+ * Information about the query or queries being executed.
+ *
+ * - `single`: A single query is being executed
+ * - `compacted`: Multiple queries have been compacted into a single SQL statement
+ */
+export declare type SqlCommenterQueryInfo = ({
+    readonly type: 'single';
+} & SqlCommenterSingleQueryInfo) | ({
+    readonly type: 'compacted';
+} & SqlCommenterCompactedQueryInfo);
+
+/**
+ * Information about a single Prisma query.
+ */
+export declare interface SqlCommenterSingleQueryInfo {
+    /**
+     * The model name (e.g., "User", "Post"). Undefined for raw queries.
+     */
+    readonly modelName?: string;
+    /**
+     * The Prisma operation (e.g., "findMany", "createOne", "queryRaw").
+     */
+    readonly action: SqlCommenterQueryAction;
+    /**
+     * The full query object (selection, arguments, etc.).
+     * Specifics of the query representation are not part of the public API yet.
+     */
+    readonly query: unknown;
+}
+
+/**
+ * Key-value pairs to add as SQL comments.
+ * Keys with undefined values will be omitted from the final comment.
+ */
+export declare type SqlCommenterTags = {
+    readonly [key: string]: string | undefined;
+};
+
 declare interface SqlDriverAdapter extends SqlQueryable {
     /**
      * Execute multiple SQL statements separated by semicolon.
@@ -3001,8 +3151,8 @@ declare interface Transaction extends AdapterInfo, SqlQueryable {
 
 declare namespace Transaction_2 {
     export {
-        Options,
         IsolationLevel_2 as IsolationLevel,
+        Options,
         InteractiveTransactionInfo,
         TransactionHeaders
     }