@geekmidas/db 0.0.3 → 0.1.0

package/dist/rls.d.cts

@@ -0,0 +1,57 @@
+import { DatabaseConnection, TransactionSettings } from "./kysely-0FOi6ZdO.cjs";
+import { Transaction } from "kysely";
+
+//#region src/rls.d.ts
+
+/**
+ * RLS context - key-value pairs to set as PostgreSQL session variables.
+ * Keys become `prefix.key` (e.g., `app.user_id`).
+ */
+interface RlsContext {
+  [key: string]: string | number | boolean | null | undefined;
+}
+/**
+ * Options for withRlsContext function.
+ */
+interface WithRlsContextOptions {
+  /** Prefix for PostgreSQL session variables (default: 'app') */
+  prefix?: string;
+  /** Transaction settings (isolation level) */
+  settings?: TransactionSettings;
+}
+/**
+ * Execute a callback within a transaction with RLS context variables set.
+ *
+ * Sets PostgreSQL session variables using `SET LOCAL` which scopes them to the
+ * current transaction. Variables are automatically cleared when the transaction
+ * ends (commit or rollback).
+ *
+ * @example
+ * ```ts
+ * await withRlsContext(
+ *   db,
+ *   { user_id: session.userId, tenant_id: session.tenantId },
+ *   async (trx) => {
+ *     // RLS policies can now use current_setting('app.user_id')
+ *     return trx.selectFrom('orders').selectAll().execute();
+ *   }
+ * );
+ * ```
+ *
+ * @param db - Database connection (Kysely, Transaction, or ControlledTransaction)
+ * @param context - Key-value pairs to set as session variables
+ * @param callback - Function to execute within the RLS context
+ * @param options - Optional prefix and transaction settings
+ */
+declare function withRlsContext<DB, T>(db: DatabaseConnection<DB>, context: RlsContext, callback: (trx: Transaction<DB>) => Promise<T>, options?: WithRlsContextOptions): Promise<T>;
+/**
+ * Bypass marker symbol for explicitly skipping RLS context.
+ */
+declare const RLS_BYPASS: unique symbol;
+/**
+ * Type for RLS bypass marker.
+ */
+type RlsBypass = typeof RLS_BYPASS;
+//#endregion
+export { RLS_BYPASS, RlsBypass, RlsContext, WithRlsContextOptions, withRlsContext };
+//# sourceMappingURL=rls.d.cts.map

package/dist/rls.d.mts

@@ -0,0 +1,57 @@
+import { DatabaseConnection, TransactionSettings } from "./kysely-Di1LVvL2.mjs";
+import { Transaction } from "kysely";
+
+//#region src/rls.d.ts
+
+/**
+ * RLS context - key-value pairs to set as PostgreSQL session variables.
+ * Keys become `prefix.key` (e.g., `app.user_id`).
+ */
+interface RlsContext {
+  [key: string]: string | number | boolean | null | undefined;
+}
+/**
+ * Options for withRlsContext function.
+ */
+interface WithRlsContextOptions {
+  /** Prefix for PostgreSQL session variables (default: 'app') */
+  prefix?: string;
+  /** Transaction settings (isolation level) */
+  settings?: TransactionSettings;
+}
+/**
+ * Execute a callback within a transaction with RLS context variables set.
+ *
+ * Sets PostgreSQL session variables using `SET LOCAL` which scopes them to the
+ * current transaction. Variables are automatically cleared when the transaction
+ * ends (commit or rollback).
+ *
+ * @example
+ * ```ts
+ * await withRlsContext(
+ *   db,
+ *   { user_id: session.userId, tenant_id: session.tenantId },
+ *   async (trx) => {
+ *     // RLS policies can now use current_setting('app.user_id')
+ *     return trx.selectFrom('orders').selectAll().execute();
+ *   }
+ * );
+ * ```
+ *
+ * @param db - Database connection (Kysely, Transaction, or ControlledTransaction)
+ * @param context - Key-value pairs to set as session variables
+ * @param callback - Function to execute within the RLS context
+ * @param options - Optional prefix and transaction settings
+ */
+declare function withRlsContext<DB, T>(db: DatabaseConnection<DB>, context: RlsContext, callback: (trx: Transaction<DB>) => Promise<T>, options?: WithRlsContextOptions): Promise<T>;
+/**
+ * Bypass marker symbol for explicitly skipping RLS context.
+ */
+declare const RLS_BYPASS: unique symbol;
+/**
+ * Type for RLS bypass marker.
+ */
+type RlsBypass = typeof RLS_BYPASS;
+//#endregion
+export { RLS_BYPASS, RlsBypass, RlsContext, WithRlsContextOptions, withRlsContext };
+//# sourceMappingURL=rls.d.mts.map

package/dist/rls.mjs

@@ -0,0 +1,48 @@
+import { withTransaction } from "./kysely-DmfA94RY.mjs";
+import { sql } from "kysely";
+
+//#region src/rls.ts
+/**
+* Execute a callback within a transaction with RLS context variables set.
+*
+* Sets PostgreSQL session variables using `SET LOCAL` which scopes them to the
+* current transaction. Variables are automatically cleared when the transaction
+* ends (commit or rollback).
+*
+* @example
+* ```ts
+* await withRlsContext(
+*   db,
+*   { user_id: session.userId, tenant_id: session.tenantId },
+*   async (trx) => {
+*     // RLS policies can now use current_setting('app.user_id')
+*     return trx.selectFrom('orders').selectAll().execute();
+*   }
+* );
+* ```
+*
+* @param db - Database connection (Kysely, Transaction, or ControlledTransaction)
+* @param context - Key-value pairs to set as session variables
+* @param callback - Function to execute within the RLS context
+* @param options - Optional prefix and transaction settings
+*/
+async function withRlsContext(db, context, callback, options) {
+	const prefix = options?.prefix ?? "app";
+	return withTransaction(db, async (trx) => {
+		for (const [key, value] of Object.entries(context)) {
+			if (value === null || value === void 0) continue;
+			const settingName = `${prefix}.${key}`;
+			const settingValue = String(value);
+			await sql`SELECT set_config(${settingName}, ${settingValue}, true)`.execute(trx);
+		}
+		return callback(trx);
+	}, options?.settings);
+}
+/**
+* Bypass marker symbol for explicitly skipping RLS context.
+*/
+const RLS_BYPASS = Symbol.for("geekmidas.rls.bypass");
+
+//#endregion
+export { RLS_BYPASS, withRlsContext };
+//# sourceMappingURL=rls.mjs.map

package/dist/rls.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rls.mjs","names":["db: DatabaseConnection<DB>","context: RlsContext","callback: (trx: Transaction<DB>) => Promise<T>","options?: WithRlsContextOptions"],"sources":["../src/rls.ts"],"sourcesContent":["import type { Transaction } from 'kysely';\nimport { sql } from 'kysely';\nimport {\n  type DatabaseConnection,\n  type TransactionSettings,\n  withTransaction,\n} from './kysely';\n\n/**\n * RLS context - key-value pairs to set as PostgreSQL session variables.\n * Keys become `prefix.key` (e.g., `app.user_id`).\n */\nexport interface RlsContext {\n  [key: string]: string | number | boolean | null | undefined;\n}\n\n/**\n * Options for withRlsContext function.\n */\nexport interface WithRlsContextOptions {\n  /** Prefix for PostgreSQL session variables (default: 'app') */\n  prefix?: string;\n  /** Transaction settings (isolation level) */\n  settings?: TransactionSettings;\n}\n\n/**\n * Execute a callback within a transaction with RLS context variables set.\n *\n * Sets PostgreSQL session variables using `SET LOCAL` which scopes them to the\n * current transaction. Variables are automatically cleared when the transaction\n * ends (commit or rollback).\n *\n * @example\n * ```ts\n * await withRlsContext(\n *   db,\n *   { user_id: session.userId, tenant_id: session.tenantId },\n *   async (trx) => {\n *     // RLS policies can now use current_setting('app.user_id')\n *     return trx.selectFrom('orders').selectAll().execute();\n *   }\n * );\n * ```\n *\n * @param db - Database connection (Kysely, Transaction, or ControlledTransaction)\n * @param context - Key-value pairs to set as session variables\n * @param callback - Function to execute within the RLS context\n * @param options - Optional prefix and transaction settings\n */\nexport async function withRlsContext<DB, T>(\n  db: DatabaseConnection<DB>,\n  context: RlsContext,\n  callback: (trx: Transaction<DB>) => Promise<T>,\n  options?: WithRlsContextOptions,\n): Promise<T> {\n  const prefix = options?.prefix ?? 'app';\n\n  return withTransaction(\n    db,\n    async (trx) => {\n      // Set each context variable using SET LOCAL (scoped to transaction)\n      for (const [key, value] of Object.entries(context)) {\n        if (value === null || value === undefined) continue;\n\n        const settingName = `${prefix}.${key}`;\n        const settingValue = String(value);\n\n        // Use raw SQL for SET LOCAL with proper escaping\n        // The setting name is an identifier, value is a string literal\n        await sql`SELECT set_config(${settingName}, ${settingValue}, true)`.execute(\n          trx,\n        );\n      }\n\n      return callback(trx);\n    },\n    options?.settings,\n  );\n}\n\n/**\n * Bypass marker symbol for explicitly skipping RLS context.\n */\nexport const RLS_BYPASS = Symbol.for('geekmidas.rls.bypass');\n\n/**\n * Type for RLS bypass marker.\n */\nexport type RlsBypass = typeof RLS_BYPASS;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkDA,eAAsB,eACpBA,IACAC,SACAC,UACAC,SACY;CACZ,MAAM,SAAS,SAAS,UAAU;AAElC,QAAO,gBACL,IACA,OAAO,QAAQ;AAEb,OAAK,MAAM,CAAC,KAAK,MAAM,IAAI,OAAO,QAAQ,QAAQ,EAAE;AAClD,OAAI,UAAU,QAAQ,iBAAqB;GAE3C,MAAM,eAAe,EAAE,OAAO,GAAG,IAAI;GACrC,MAAM,eAAe,OAAO,MAAM;AAIlC,SAAM,IAAI,oBAAoB,YAAY,IAAI,aAAa,SAAS,QAClE,IACD;EACF;AAED,SAAO,SAAS,IAAI;CACrB,GACD,SAAS,SACV;AACF;;;;AAKD,MAAa,aAAa,OAAO,IAAI,uBAAuB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geekmidas/db",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "private": false,
   "type": "module",
   "exports": {
@@ -8,6 +8,11 @@
       "types": "./dist/kysely.d.ts",
       "import": "./dist/kysely.mjs",
       "require": "./dist/kysely.cjs"
+    },
+    "./rls": {
+      "types": "./dist/rls.d.ts",
+      "import": "./dist/rls.mjs",
+      "require": "./dist/rls.cjs"
     }
   },
   "dependencies": {
@@ -16,6 +21,10 @@
   "devDependencies": {
     "@types/pg": "~8.15.4"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/geekmidas/toolbox"
+  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -27,5 +36,8 @@
     "objection": "~3.1.5",
     "db-errors": "~0.2.3",
     "vitest": "~3.2.4"
+  },
+  "scripts": {
+    "ts": "tsc --noEmit --skipLibCheck src/**/*.ts"
   }
 }