@dbos-inc/kysely-datasource 4.28.4-preview → 4.28.6-preview

package/dist/index.d.mts

@@ -0,0 +1,26 @@
+import { FunctionName } from '@dbos-inc/dbos-sdk';
+import { DBOSDataSource } from '@dbos-inc/dbos-sdk/datasource';
+import { Kysely, IsolationLevel } from 'kysely';
+import { PoolConfig } from 'pg';
+export interface transaction_completion {
+    workflow_id: string;
+    function_num: number;
+    output: string | null;
+    error: string | null;
+}
+export interface TransactionConfig {
+    name?: string;
+    isolationLevel?: IsolationLevel;
+    readOnly?: boolean;
+}
+export declare class KyselyDataSource<DB> implements DBOSDataSource<TransactionConfig> {
+    #private;
+    readonly name: string;
+    get client(): Kysely<DB>;
+    static initializeDBOSSchema(poolConfig: PoolConfig, schemaName?: string): Promise<void>;
+    static uninitializeDBOSSchema(poolConfig: PoolConfig, schemaName?: string): Promise<void>;
+    constructor(name: string, poolConfigOrKysely: PoolConfig | Kysely<any>, schemaName?: string);
+    runTransaction<R>(func: () => Promise<R>, config?: TransactionConfig): Promise<R>;
+    registerTransaction<This, Args extends unknown[], Return>(func: (this: This, ...args: Args) => Promise<Return>, config?: TransactionConfig & FunctionName): (this: This, ...args: Args) => Promise<Return>;
+    transaction(config?: TransactionConfig): <This, Args extends unknown[], Return>(target: object, propertyKey: PropertyKey, descriptor: TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>;
+}

package/package.json

@@ -1,10 +1,23 @@
 {
   "name": "@dbos-inc/kysely-datasource",
-  "version": "4.28.4-preview",
+  "version": "4.28.6-preview",
   "description": "DBOS DataSource library for Kysely Query Builder with PostgreSQL support",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
   "homepage": "https://docs.dbos.dev/",
   "repository": {
     "type": "git",
@@ -12,7 +25,7 @@
     "directory": "packages/kysely-datasource"
   },
   "scripts": {
-    "build": "tsc --project tsconfig.json",
+    "build": "tsc --project tsconfig.json && node scripts/emit-esm-types.js",
     "test": "jest --detectOpenHandles"
   },
   "dependencies": {

package/scripts/emit-esm-types.js

@@ -0,0 +1,6 @@
+const fs = require('fs');
+
+// ESM consumers need a .d.mts so the declarations' own imports resolve through the "import" condition.
+const declarations = fs.readFileSync('dist/index.d.ts', 'utf8');
+// The copied sourceMappingURL would point at a map that names index.d.ts as its file.
+fs.writeFileSync('dist/index.d.mts', declarations.replace(/^\/\/# sourceMappingURL=.*\n?/m, ''));

package/tests/esm-consumer.mts

@@ -0,0 +1,13 @@
+// Typechecked by esmtypes.test.ts, never executed: .mts makes it ESM regardless of the package type.
+import { KyselyDataSource } from '@dbos-inc/kysely-datasource';
+import type { Kysely } from 'kysely';
+
+interface Database {
+  greetings: { greeting: string };
+}
+
+declare const dataSource: KyselyDataSource<Database>;
+declare const existingClient: Kysely<Database>;
+
+export const client: Kysely<Database> = dataSource.client;
+export const fromExistingClient = new KyselyDataSource<Database>('app', existingClient);

package/tests/esmtypes.test.ts

@@ -0,0 +1,27 @@
+import { execFileSync } from 'child_process';
+import { readFileSync } from 'fs';
+import path from 'path';
+
+const packageRoot = path.join(__dirname, '..');
+
+describe('ESM type declarations', () => {
+  test('an ESM consumer under NodeNext typechecks against the built declarations', () => {
+    const tsc = require.resolve('typescript/bin/tsc');
+    const project = path.join(__dirname, 'tsconfig.esmcheck.json');
+    try {
+      execFileSync(process.execPath, [tsc, '--project', project], { cwd: packageRoot, stdio: 'pipe' });
+    } catch (error) {
+      const { stdout } = error as { stdout?: Buffer };
+      throw new Error(`ESM consumer failed to typecheck. Run 'npm run build' first.\n${stdout?.toString() ?? ''}`);
+    }
+  }, 120000);
+
+  test('the ESM declarations carry no reference to the CommonJS declaration map', () => {
+    const declarations = readFileSync(path.join(packageRoot, 'dist', 'index.d.mts'), 'utf8');
+    expect(declarations).not.toContain('sourceMappingURL');
+  });
+
+  test('the exports map still resolves the package manifest', () => {
+    expect(() => require.resolve('@dbos-inc/kysely-datasource/package.json')).not.toThrow();
+  });
+});

package/tests/tsconfig.esmcheck.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "target": "esnext",
+    "strict": true,
+    "skipLibCheck": true,
+    "noEmit": true
+  },
+  "files": ["esm-consumer.mts"]
+}