@branchly/datasource-postgres 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { DatasourceAdapter } from 'branchly';
+
+interface SqlResult {
+    readonly rows: readonly Record<string, unknown>[];
+}
+type SqlRunner = (sql: string, params?: readonly unknown[]) => Promise<SqlResult>;
+interface PostgresDatasourceOptions {
+    readonly admin: string;
+    readonly prefix?: string;
+    readonly query?: SqlRunner;
+}
+declare const createPostgresDatasource: (options: PostgresDatasourceOptions) => DatasourceAdapter;
+
+export { type PostgresDatasourceOptions, type SqlResult, type SqlRunner, createPostgresDatasource, createPostgresDatasource as default };

package/dist/index.js

@@ -0,0 +1,60 @@
+// src/index.ts
+var PG_NAME_PATTERN = /^[a-z0-9_]+$/;
+var PG_NAME_MAX_LENGTH = 63;
+var DEFAULT_PREFIX = "app";
+var databaseName = (prefix, key) => {
+  const name = `${prefix}_${key}`;
+  if (!PG_NAME_PATTERN.test(name) || name.length > PG_NAME_MAX_LENGTH) {
+    throw new Error(`branchly: branch key "${key}" does not map to a valid Postgres database name ("${name}").`);
+  }
+  return name;
+};
+var createDefaultRunner = (admin) => async (sql, params = []) => {
+  const { Client } = await import("pg");
+  const client = new Client({ connectionString: admin });
+  await client.connect();
+  try {
+    const result = await client.query(sql, [...params]);
+    return { rows: result.rows };
+  } finally {
+    await client.end();
+  }
+};
+var createPostgresDatasource = (options) => {
+  const prefix = options.prefix ?? DEFAULT_PREFIX;
+  const query = options.query ?? createDefaultRunner(options.admin);
+  const nameOf = (key) => databaseName(prefix, key);
+  return {
+    id: "postgres",
+    apiVersion: 1,
+    capabilities: { instantClone: true, snapshot: true, isolatedPerBranch: true },
+    resolve: (key) => {
+      const url = new URL(options.admin);
+      url.pathname = `/${nameOf(key)}`;
+      return url.toString();
+    },
+    exists: async (key) => {
+      const result = await query("SELECT 1 FROM pg_database WHERE datname = $1", [nameOf(key)]);
+      return result.rows.length > 0;
+    },
+    list: async () => {
+      const result = await query("SELECT datname FROM pg_database WHERE datname LIKE $1", [`${prefix}_%`]);
+      return result.rows.map((row) => row.datname).filter((name) => typeof name === "string").map((name) => name.slice(prefix.length + 1));
+    },
+    create: async (key) => {
+      await query(`CREATE DATABASE "${nameOf(key)}"`);
+    },
+    clone: async (from, to) => {
+      await query(`CREATE DATABASE "${nameOf(to)}" TEMPLATE "${nameOf(from)}"`);
+    },
+    destroy: async (key) => {
+      await query(`DROP DATABASE IF EXISTS "${nameOf(key)}"`);
+    }
+  };
+};
+var index_default = createPostgresDatasource;
+export {
+  createPostgresDatasource,
+  index_default as default
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { BranchKey, DatasourceAdapter } from 'branchly';\n\nconst PG_NAME_PATTERN = /^[a-z0-9_]+$/;\nconst PG_NAME_MAX_LENGTH = 63;\nconst DEFAULT_PREFIX = 'app';\n\nexport interface SqlResult {\n  readonly rows: readonly Record<string, unknown>[];\n}\n\nexport type SqlRunner = (sql: string, params?: readonly unknown[]) => Promise<SqlResult>;\n\nexport interface PostgresDatasourceOptions {\n  readonly admin: string;\n  readonly prefix?: string;\n  readonly query?: SqlRunner;\n}\n\nconst databaseName = (prefix: string, key: BranchKey): string => {\n  const name = `${prefix}_${key}`;\n  if (!PG_NAME_PATTERN.test(name) || name.length > PG_NAME_MAX_LENGTH) {\n    throw new Error(`branchly: branch key \"${key}\" does not map to a valid Postgres database name (\"${name}\").`);\n  }\n  return name;\n};\n\nconst createDefaultRunner =\n  (admin: string): SqlRunner =>\n  async (sql, params = []) => {\n    const { Client } = await import('pg');\n    const client = new Client({ connectionString: admin });\n    await client.connect();\n    try {\n      const result = await client.query(sql, [...params]);\n      return { rows: result.rows as Record<string, unknown>[] };\n    } finally {\n      await client.end();\n    }\n  };\n\nexport const createPostgresDatasource = (options: PostgresDatasourceOptions): DatasourceAdapter => {\n  const prefix = options.prefix ?? DEFAULT_PREFIX;\n  const query = options.query ?? createDefaultRunner(options.admin);\n  const nameOf = (key: BranchKey): string => databaseName(prefix, key);\n  return {\n    id: 'postgres',\n    apiVersion: 1,\n    capabilities: { instantClone: true, snapshot: true, isolatedPerBranch: true },\n    resolve: (key) => {\n      const url = new URL(options.admin);\n      url.pathname = `/${nameOf(key)}`;\n      return url.toString();\n    },\n    exists: async (key) => {\n      const result = await query('SELECT 1 FROM pg_database WHERE datname = $1', [nameOf(key)]);\n      return result.rows.length > 0;\n    },\n    list: async () => {\n      const result = await query('SELECT datname FROM pg_database WHERE datname LIKE $1', [`${prefix}_%`]);\n      return result.rows\n        .map((row) => row.datname)\n        .filter((name): name is string => typeof name === 'string')\n        .map((name) => name.slice(prefix.length + 1));\n    },\n    create: async (key) => {\n      await query(`CREATE DATABASE \"${nameOf(key)}\"`);\n    },\n    clone: async (from, to) => {\n      await query(`CREATE DATABASE \"${nameOf(to)}\" TEMPLATE \"${nameOf(from)}\"`);\n    },\n    destroy: async (key) => {\n      await query(`DROP DATABASE IF EXISTS \"${nameOf(key)}\"`);\n    },\n  };\n};\n\nexport default createPostgresDatasource;\n"],"mappings":";AAEA,IAAM,kBAAkB;AACxB,IAAM,qBAAqB;AAC3B,IAAM,iBAAiB;AAcvB,IAAM,eAAe,CAAC,QAAgB,QAA2B;AAC/D,QAAM,OAAO,GAAG,MAAM,IAAI,GAAG;AAC7B,MAAI,CAAC,gBAAgB,KAAK,IAAI,KAAK,KAAK,SAAS,oBAAoB;AACnE,UAAM,IAAI,MAAM,yBAAyB,GAAG,sDAAsD,IAAI,KAAK;AAAA,EAC7G;AACA,SAAO;AACT;AAEA,IAAM,sBACJ,CAAC,UACD,OAAO,KAAK,SAAS,CAAC,MAAM;AAC1B,QAAM,EAAE,OAAO,IAAI,MAAM,OAAO,IAAI;AACpC,QAAM,SAAS,IAAI,OAAO,EAAE,kBAAkB,MAAM,CAAC;AACrD,QAAM,OAAO,QAAQ;AACrB,MAAI;AACF,UAAM,SAAS,MAAM,OAAO,MAAM,KAAK,CAAC,GAAG,MAAM,CAAC;AAClD,WAAO,EAAE,MAAM,OAAO,KAAkC;AAAA,EAC1D,UAAE;AACA,UAAM,OAAO,IAAI;AAAA,EACnB;AACF;AAEK,IAAM,2BAA2B,CAAC,YAA0D;AACjG,QAAM,SAAS,QAAQ,UAAU;AACjC,QAAM,QAAQ,QAAQ,SAAS,oBAAoB,QAAQ,KAAK;AAChE,QAAM,SAAS,CAAC,QAA2B,aAAa,QAAQ,GAAG;AACnE,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,YAAY;AAAA,IACZ,cAAc,EAAE,cAAc,MAAM,UAAU,MAAM,mBAAmB,KAAK;AAAA,IAC5E,SAAS,CAAC,QAAQ;AAChB,YAAM,MAAM,IAAI,IAAI,QAAQ,KAAK;AACjC,UAAI,WAAW,IAAI,OAAO,GAAG,CAAC;AAC9B,aAAO,IAAI,SAAS;AAAA,IACtB;AAAA,IACA,QAAQ,OAAO,QAAQ;AACrB,YAAM,SAAS,MAAM,MAAM,gDAAgD,CAAC,OAAO,GAAG,CAAC,CAAC;AACxF,aAAO,OAAO,KAAK,SAAS;AAAA,IAC9B;AAAA,IACA,MAAM,YAAY;AAChB,YAAM,SAAS,MAAM,MAAM,yDAAyD,CAAC,GAAG,MAAM,IAAI,CAAC;AACnG,aAAO,OAAO,KACX,IAAI,CAAC,QAAQ,IAAI,OAAO,EACxB,OAAO,CAAC,SAAyB,OAAO,SAAS,QAAQ,EACzD,IAAI,CAAC,SAAS,KAAK,MAAM,OAAO,SAAS,CAAC,CAAC;AAAA,IAChD;AAAA,IACA,QAAQ,OAAO,QAAQ;AACrB,YAAM,MAAM,oBAAoB,OAAO,GAAG,CAAC,GAAG;AAAA,IAChD;AAAA,IACA,OAAO,OAAO,MAAM,OAAO;AACzB,YAAM,MAAM,oBAAoB,OAAO,EAAE,CAAC,eAAe,OAAO,IAAI,CAAC,GAAG;AAAA,IAC1E;AAAA,IACA,SAAS,OAAO,QAAQ;AACtB,YAAM,MAAM,4BAA4B,OAAO,GAAG,CAAC,GAAG;AAAA,IACxD;AAAA,EACF;AACF;AAEA,IAAO,gBAAQ;","names":[]}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@branchly/datasource-postgres",
+  "version": "0.1.0",
+  "description": "Reference Postgres datasource adapter for branchly.",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "pg": "^8.13.1"
+  },
+  "devDependencies": {
+    "@types/pg": "^8.11.10",
+    "branchly": "0.1.0",
+    "@branchly/adapter-test-kit": "0.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
+  }
+}