@prisma/sqlcommenter-query-tags 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,260 @@
+# @prisma/sqlcommenter-query-tags
+
+An `AsyncLocalStorage`-based query tagging plugin for Prisma ORM's SQL commenter feature. This package allows you to add ad-hoc tags to your SQL queries that will be appended as comments, useful for tracing, debugging, and observability.
+
+## Installation
+
+```bash
+npm install @prisma/sqlcommenter-query-tags
+```
+
+## Usage
+
+```typescript
+import { queryTags, withQueryTags } from '@prisma/sqlcommenter-query-tags'
+import { PrismaClient } from '@prisma/client'
+
+const prisma = new PrismaClient({
+  adapter: myAdapter, // Driver adapter required (alternatively, Accelerate URL)
+  comments: [queryTags()],
+})
+
+// Wrap your queries to add tags
+const posts = await withQueryTags({ route: '/api/posts', user: 'user-123' }, () => prisma.post.findMany())
+```
+
+The resulting SQL will include comments like:
+
+```sql
+SELECT ... FROM "Post" /*route='/api/posts',user='user-123'*/
+```
+
+## API
+
+### `queryTags()`
+
+Creates a SQL commenter plugin that retrieves query tags from `AsyncLocalStorage`.
+
+```typescript
+function queryTags(): SqlCommenterPlugin
+```
+
+### `withQueryTags(tags, scope)`
+
+Executes a function with the given query tags added to all SQL queries within its scope.
+Nested calls to `withQueryTags` completely replace the outer tags.
+
+```typescript
+function withQueryTags<T>(tags: SqlCommenterTags, scope: () => PromiseLike<T>): Promise<T>
+```
+
+**Parameters:**
+
+- `tags` - Key-value pairs to add as SQL comments. Keys with `undefined` values are filtered out.
+- `scope` - An async function to execute within the tagged scope
+
+**Returns:** The result of the scope function
+
+### `withMergedQueryTags(tags, scope)`
+
+Executes a function with merged query tags added to all SQL queries within its scope.
+Unlike `withQueryTags`, this function merges the provided tags with any existing tags
+from an outer scope, with the new tags taking precedence for keys that exist in both.
+Setting a key to `undefined` removes it from the merged result.
+
+```typescript
+function withMergedQueryTags<T>(tags: SqlCommenterTags, scope: () => PromiseLike<T>): Promise<T>
+```
+
+**Parameters:**
+
+- `tags` - Key-value pairs to merge with existing tags. Keys with `undefined` values remove that key from the result.
+- `scope` - An async function to execute within the tagged scope
+
+**Returns:** The result of the scope function
+
+## Examples
+
+### Basic Usage
+
+```typescript
+const users = await withQueryTags({ requestId: 'abc-123', endpoint: '/api/users' }, () => prisma.user.findMany())
+```
+
+### Multiple Queries in One Scope
+
+```typescript
+const result = await withQueryTags({ traceId: 'trace-456' }, async () => {
+  const users = await prisma.user.findMany()
+  const posts = await prisma.post.findMany()
+  return { users, posts }
+})
+```
+
+### Merging Tags in Nested Scopes
+
+Use `withMergedQueryTags` when you want to add tags without losing the outer context:
+
+```typescript
+// Set base tags at the request level
+await withQueryTags({ requestId: 'req-123', source: 'api' }, async () => {
+  // Add handler-specific tags while keeping requestId
+  await withMergedQueryTags({ userId: 'user-456', source: 'handler' }, async () => {
+    // Queries here will have: requestId='req-123', userId='user-456', source='handler'
+    await prisma.user.findMany()
+  })
+})
+```
+
+### Removing Tags in Nested Scopes
+
+Use `undefined` to explicitly remove a tag set by an outer scope:
+
+```typescript
+await withQueryTags({ requestId: 'req-123', debug: 'true' }, async () => {
+  // Remove 'debug' tag for this inner scope
+  await withMergedQueryTags({ userId: 'user-456', debug: undefined }, async () => {
+    // Queries here will have: requestId='req-123', userId='user-456' (debug removed)
+    await prisma.user.findMany()
+  })
+})
+```
+
+### Combining with Other Plugins
+
+```typescript
+import type { SqlCommenterPlugin } from '@prisma/sqlcommenter'
+
+const appPlugin: SqlCommenterPlugin = () => ({
+  application: 'my-app',
+  version: '1.0.0',
+})
+
+const prisma = new PrismaClient({
+  adapter: myAdapter,
+  comments: [appPlugin, queryTags()], // Tags from both plugins are merged
+})
+```
+
+### Request Context in Web Frameworks
+
+For `withQueryTags` to work correctly, all database queries must execute **inside** the callback scope. This requires proper async middleware that awaits downstream handlers (Hono, Koa), or wrapping handlers/services directly (Express, Fastify, NestJS).
+
+#### Hono
+
+Hono's middleware properly awaits downstream handlers, making it ideal for request-scoped tagging:
+
+```typescript
+import { createMiddleware } from 'hono/factory'
+
+app.use(
+  createMiddleware(async (c, next) => {
+    await withQueryTags(
+      {
+        route: c.req.path,
+        method: c.req.method,
+        requestId: c.req.header('x-request-id') ?? crypto.randomUUID(),
+      },
+      () => next(),
+    )
+  }),
+)
+```
+
+#### Koa
+
+Koa's middleware properly awaits downstream handlers:
+
+```typescript
+app.use(async (ctx, next) => {
+  await withQueryTags(
+    {
+      route: ctx.path,
+      method: ctx.method,
+      requestId: ctx.get('x-request-id') || crypto.randomUUID(),
+    },
+    () => next(),
+  )
+})
+```
+
+#### Fastify
+
+Wrap individual route handlers since hooks complete before the handler runs:
+
+```typescript
+fastify.get('/users', (request, reply) => {
+  return withQueryTags(
+    {
+      route: '/users',
+      method: 'GET',
+      requestId: request.id,
+    },
+    () => prisma.user.findMany(),
+  )
+})
+```
+
+#### Express
+
+Express middleware uses callbacks, so `next()` returns immediately without waiting for downstream handlers. Wrap route handlers directly instead:
+
+```typescript
+app.get('/users', (req, res, next) => {
+  withQueryTags(
+    {
+      route: req.path,
+      method: req.method,
+      requestId: req.header('x-request-id') ?? crypto.randomUUID(),
+    },
+    () => prisma.user.findMany(),
+  )
+    .then((users) => res.json(users))
+    .catch(next)
+})
+```
+
+#### NestJS
+
+Use an interceptor, which properly wraps the handler execution:
+
+```typescript
+import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common'
+import { Observable, from } from 'rxjs'
+
+@Injectable()
+export class QueryTagsInterceptor implements NestInterceptor {
+  intercept(context: ExecutionContext, next: CallHandler): Observable<unknown> {
+    const request = context.switchToHttp().getRequest<Request>()
+    return from(
+      withQueryTags(
+        {
+          route: request.path,
+          method: request.method,
+          requestId: request.header('x-request-id') ?? crypto.randomUUID(),
+        },
+        () => lastValueFrom(next.handle()),
+      ),
+    )
+  }
+}
+
+// Apply globally in main.ts
+app.useGlobalInterceptors(new QueryTagsInterceptor())
+```
+
+## How It Works
+
+This package uses Node.js `AsyncLocalStorage` to maintain context across async operations. When you call `withQueryTags()` or `withMergedQueryTags()`, the tags are stored in the async local storage context. The `queryTags()` plugin retrieves these tags when Prisma executes queries within that scope.
+
+**Key behaviors:**
+
+- Tags are scoped to the callback and don't leak to queries outside
+- `withQueryTags` replaces the outer tags entirely in nested calls
+- `withMergedQueryTags` merges with outer tags, with new tags taking precedence for duplicate keys; `undefined` values remove keys
+- Multiple `queryTags()` plugin instances share the same `AsyncLocalStorage` context
+- Tags from multiple plugins are merged, with later plugins overriding earlier ones for the same key
+
+## License
+
+Apache-2.0

package/dist/index.d.mts

@@ -0,0 +1,176 @@
+declare type JsonQueryAction = 'findUnique' | 'findUniqueOrThrow' | 'findFirst' | 'findFirstOrThrow' | 'findMany' | 'createOne' | 'createMany' | 'createManyAndReturn' | 'updateOne' | 'updateMany' | 'updateManyAndReturn' | 'deleteOne' | 'deleteMany' | 'upsertOne' | 'aggregate' | 'groupBy' | 'executeRaw' | 'queryRaw' | 'runCommandRaw' | 'findRaw' | 'aggregateRaw';
+
+/**
+ * Creates a SQL commenter plugin that retrieves query tags from AsyncLocalStorage.
+ * Use this plugin with `withQueryTags()` to add ad-hoc tags to your queries.
+ *
+ * @example
+ * ```ts
+ * import { queryTags, withQueryTags } from '@prisma/sqlcommenter-query-tags'
+ *
+ * const prisma = new PrismaClient({
+ *   adapter: myAdapter,
+ *   comments: [queryTags()],
+ * })
+ *
+ * // Later, wrap your queries to add tags:
+ * const posts = await withQueryTags(
+ *   { route: '/api/posts', user: 'user-123' },
+ *   () => prisma.post.findMany()
+ * )
+ * ```
+ */
+export declare function queryTags(): SqlCommenterPlugin;
+
+/**
+ * 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.
+ */
+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,
+ *   }
+ * }
+ * ```
+ */
+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
+ */
+declare type SqlCommenterQueryInfo = ({
+    readonly type: 'single';
+} & SqlCommenterSingleQueryInfo) | ({
+    readonly type: 'compacted';
+} & SqlCommenterCompactedQueryInfo);
+
+/**
+ * Information about a single Prisma query.
+ */
+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.
+ */
+declare type SqlCommenterTags = {
+    readonly [key: string]: string | undefined;
+};
+
+/**
+ * Executes a function with merged query tags added to all SQL queries within its scope.
+ * Unlike `withQueryTags`, this function merges the provided tags with any existing tags
+ * from an outer scope, with the new tags taking precedence for keys that exist in both.
+ *
+ * @param tags - Key-value pairs to merge with existing tags
+ * @param scope - An async function to execute within the tagged scope
+ * @returns The result of the scope function
+ *
+ * @example
+ * ```ts
+ * // Outer scope sets base tags
+ * await withQueryTags({ requestId: 'req-123', source: 'api' }, async () => {
+ *   // Inner scope adds/overrides tags
+ *   await withMergedQueryTags({ userId: 'user-456', source: 'handler' }, async () => {
+ *     // Queries here will have: requestId='req-123', userId='user-456', source='handler'
+ *     await prisma.user.findMany()
+ *   })
+ * })
+ * ```
+ */
+export declare function withMergedQueryTags<T>(tags: SqlCommenterTags, scope: () => PromiseLike<T>): Promise<T>;
+
+/**
+ * Executes a function with the given query tags added to all SQL queries within its scope.
+ * Tags are stored in AsyncLocalStorage and retrieved by the `queryTags()` plugin.
+ *
+ * @param tags - Key-value pairs to add as SQL comments
+ * @param scope - An async function to execute within the tagged scope
+ * @returns The result of the scope function
+ *
+ * @example
+ * ```ts
+ * const result = await withQueryTags(
+ *   { route: '/api/users', requestId: 'abc-123' },
+ *   async () => {
+ *     // All queries here will have the tags attached
+ *     const users = await prisma.user.findMany()
+ *     const posts = await prisma.post.findMany()
+ *     return { users, posts }
+ *   }
+ * )
+ * ```
+ */
+export declare function withQueryTags<T>(tags: SqlCommenterTags, scope: () => PromiseLike<T>): Promise<T>;
+
+export { }

package/dist/index.d.ts

@@ -0,0 +1,176 @@
+declare type JsonQueryAction = 'findUnique' | 'findUniqueOrThrow' | 'findFirst' | 'findFirstOrThrow' | 'findMany' | 'createOne' | 'createMany' | 'createManyAndReturn' | 'updateOne' | 'updateMany' | 'updateManyAndReturn' | 'deleteOne' | 'deleteMany' | 'upsertOne' | 'aggregate' | 'groupBy' | 'executeRaw' | 'queryRaw' | 'runCommandRaw' | 'findRaw' | 'aggregateRaw';
+
+/**
+ * Creates a SQL commenter plugin that retrieves query tags from AsyncLocalStorage.
+ * Use this plugin with `withQueryTags()` to add ad-hoc tags to your queries.
+ *
+ * @example
+ * ```ts
+ * import { queryTags, withQueryTags } from '@prisma/sqlcommenter-query-tags'
+ *
+ * const prisma = new PrismaClient({
+ *   adapter: myAdapter,
+ *   comments: [queryTags()],
+ * })
+ *
+ * // Later, wrap your queries to add tags:
+ * const posts = await withQueryTags(
+ *   { route: '/api/posts', user: 'user-123' },
+ *   () => prisma.post.findMany()
+ * )
+ * ```
+ */
+export declare function queryTags(): SqlCommenterPlugin;
+
+/**
+ * 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.
+ */
+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,
+ *   }
+ * }
+ * ```
+ */
+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
+ */
+declare type SqlCommenterQueryInfo = ({
+    readonly type: 'single';
+} & SqlCommenterSingleQueryInfo) | ({
+    readonly type: 'compacted';
+} & SqlCommenterCompactedQueryInfo);
+
+/**
+ * Information about a single Prisma query.
+ */
+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.
+ */
+declare type SqlCommenterTags = {
+    readonly [key: string]: string | undefined;
+};
+
+/**
+ * Executes a function with merged query tags added to all SQL queries within its scope.
+ * Unlike `withQueryTags`, this function merges the provided tags with any existing tags
+ * from an outer scope, with the new tags taking precedence for keys that exist in both.
+ *
+ * @param tags - Key-value pairs to merge with existing tags
+ * @param scope - An async function to execute within the tagged scope
+ * @returns The result of the scope function
+ *
+ * @example
+ * ```ts
+ * // Outer scope sets base tags
+ * await withQueryTags({ requestId: 'req-123', source: 'api' }, async () => {
+ *   // Inner scope adds/overrides tags
+ *   await withMergedQueryTags({ userId: 'user-456', source: 'handler' }, async () => {
+ *     // Queries here will have: requestId='req-123', userId='user-456', source='handler'
+ *     await prisma.user.findMany()
+ *   })
+ * })
+ * ```
+ */
+export declare function withMergedQueryTags<T>(tags: SqlCommenterTags, scope: () => PromiseLike<T>): Promise<T>;
+
+/**
+ * Executes a function with the given query tags added to all SQL queries within its scope.
+ * Tags are stored in AsyncLocalStorage and retrieved by the `queryTags()` plugin.
+ *
+ * @param tags - Key-value pairs to add as SQL comments
+ * @param scope - An async function to execute within the tagged scope
+ * @returns The result of the scope function
+ *
+ * @example
+ * ```ts
+ * const result = await withQueryTags(
+ *   { route: '/api/users', requestId: 'abc-123' },
+ *   async () => {
+ *     // All queries here will have the tags attached
+ *     const users = await prisma.user.findMany()
+ *     const posts = await prisma.post.findMany()
+ *     return { users, posts }
+ *   }
+ * )
+ * ```
+ */
+export declare function withQueryTags<T>(tags: SqlCommenterTags, scope: () => PromiseLike<T>): Promise<T>;
+
+export { }

package/dist/index.js

@@ -0,0 +1,46 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  queryTags: () => queryTags,
+  withMergedQueryTags: () => withMergedQueryTags,
+  withQueryTags: () => withQueryTags
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_async_hooks = require("node:async_hooks");
+var asyncLocalStorage = new import_node_async_hooks.AsyncLocalStorage();
+function queryTags() {
+  return () => asyncLocalStorage.getStore() ?? {};
+}
+function withQueryTags(tags, scope) {
+  return asyncLocalStorage.run(tags, async () => await scope());
+}
+function withMergedQueryTags(tags, scope) {
+  const existingTags = asyncLocalStorage.getStore() ?? {};
+  const mergedTags = { ...existingTags, ...tags };
+  return asyncLocalStorage.run(mergedTags, async () => await scope());
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  queryTags,
+  withMergedQueryTags,
+  withQueryTags
+});

package/dist/index.mjs

@@ -0,0 +1,19 @@
+// src/index.ts
+import { AsyncLocalStorage } from "node:async_hooks";
+var asyncLocalStorage = new AsyncLocalStorage();
+function queryTags() {
+  return () => asyncLocalStorage.getStore() ?? {};
+}
+function withQueryTags(tags, scope) {
+  return asyncLocalStorage.run(tags, async () => await scope());
+}
+function withMergedQueryTags(tags, scope) {
+  const existingTags = asyncLocalStorage.getStore() ?? {};
+  const mergedTags = { ...existingTags, ...tags };
+  return asyncLocalStorage.run(mergedTags, async () => await scope());
+}
+export {
+  queryTags,
+  withMergedQueryTags,
+  withQueryTags
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@prisma/sqlcommenter-query-tags",
+  "version": "0.0.1",
+  "description": "AsyncLocalStorage-based query tagging plugin for Prisma SQL commenter",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      }
+    }
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://www.prisma.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/prisma/prisma.git",
+    "directory": "packages/sqlcommenter-query-tags"
+  },
+  "bugs": "https://github.com/prisma/prisma/issues",
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "devDependencies": {
+    "vitest": "3.2.4",
+    "@prisma/sqlcommenter": "0.0.0"
+  },
+  "scripts": {
+    "dev": "DEV=true tsx helpers/build.ts",
+    "build": "tsx helpers/build.ts",
+    "test": "vitest run"
+  }
+}