@framers/sql-storage-adapter 0.6.16 → 0.7.0

package/dist/shared/postgresTarget.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postgresTarget.d.ts","sourceRoot":"","sources":["../../src/shared/postgresTarget.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAE1E,qCAAqC;AACrC,eAAO,MAAM,UAAU,UAAW,OAAO,KAAG,KAAK,IAAI,MAAuD,CAAC;AAE7G;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,YAAa,sBAAsB,GAAG,SAAS,KAAG,OAO/E,CAAC"}
+{"version":3,"file":"postgresTarget.d.ts","sourceRoot":"","sources":["../../src/shared/postgresTarget.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAE1E,qCAAqC;AACrC,eAAO,MAAM,UAAU,UAAW,OAAO,KAAG,KAAK,IAAI,MAAuD,CAAC;AAE7G;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,YAAa,sBAAsB,GAAG,SAAS,KAAG,OAQ/E,CAAC"}

package/dist/shared/postgresTarget.js

@@ -1,12 +1,14 @@
 /** A string with something in it. */
 export const isNonEmpty = (value) => typeof value === 'string' && value.length > 0;
 /**
- * Whether Postgres options name a server: a connection string, or a host,
- * database or user. `{ connectionString: process.env.DATABASE_URL }` with
- * DATABASE_URL unset names none.
+ * Whether Postgres options name a server: a pool of the caller's, a
+ * connection string, or a host, database or user.
+ * `{ connectionString: process.env.DATABASE_URL }` with DATABASE_URL unset
+ * names none.
  */
 export const namesPostgresServer = (options) => Boolean(options &&
-    (isNonEmpty(options.connectionString) ||
+    (Boolean(options.pool) ||
+        isNonEmpty(options.connectionString) ||
         isNonEmpty(options.host) ||
         isNonEmpty(options.database) ||
         isNonEmpty(options.user)));

package/dist/shared/postgresTarget.js.map

@@ -1 +1 @@
-{"version":3,"file":"postgresTarget.js","sourceRoot":"","sources":["../../src/shared/postgresTarget.ts"],"names":[],"mappings":"AAEA,qCAAqC;AACrC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AAE7G;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAA2C,EAAW,EAAE,CAC1F,OAAO,CACL,OAAO;IACL,CAAC,UAAU,CAAC,OAAO,CAAC,gBAAgB,CAAC;QACnC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;QACxB,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC5B,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAC9B,CAAC"}
+{"version":3,"file":"postgresTarget.js","sourceRoot":"","sources":["../../src/shared/postgresTarget.ts"],"names":[],"mappings":"AAEA,qCAAqC;AACrC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AAE7G;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAA2C,EAAW,EAAE,CAC1F,OAAO,CACL,OAAO;IACL,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACpB,UAAU,CAAC,OAAO,CAAC,gBAAgB,CAAC;QACpC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;QACxB,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC5B,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAC9B,CAAC"}

package/dist/shared/segment.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Segments keep one user's tables apart from another's in a database they
+ * share. On PostgreSQL a segment is a schema of its own; on the SQLite family a
+ * database file of its own; on IndexedDB and Capacitor a database name of its
+ * own. A segment name is the same on every backend, so one name gives a host
+ * the same separation on the server, the desktop, the phone and the browser.
+ *
+ * This module imports nothing, so browser bundles can include it.
+ */
+/**
+ * Checks a segment name and returns it.
+ *
+ * A segment name is lower-case letters, digits and underscores, starts with a
+ * letter or an underscore, and has at most 63 characters: an unquoted
+ * PostgreSQL identifier, and a safe file, IndexedDB and Capacitor database
+ * name. It is not `public`, `information_schema` or a name beginning with
+ * `pg_`, which PostgreSQL keeps for its own schemas.
+ *
+ * @throws {Error} When the name is not one a segment can take.
+ */
+export declare const validateSegment: (segment: string) => string;
+/**
+ * The name of a segment's database: `name` followed by `-` and the segment,
+ * or `name` itself when there is no segment. For IndexedDB and Capacitor
+ * database names: `app-db` and segment `agentos` give `app-db-agentos`.
+ *
+ * @throws {Error} When the segment is not one a segment name can take.
+ */
+export declare const segmentName: (name: string, segment: string | undefined) => string;
+/**
+ * The file of a segment's database: the segment goes between the file's name
+ * and its extension (`/data/app.sqlite3` and segment `agentos` give
+ * `/data/app-agentos.sqlite3`), or after a name with no extension. A `file:`
+ * URI keeps its query, and SQLite's in-memory names (`:memory:`,
+ * `file::memory:`) stay as they are, since each in-memory connection is a
+ * database of its own. Without a segment the path is returned as it is.
+ *
+ * @throws {Error} When the segment is not one a segment name can take.
+ */
+export declare const segmentFilePath: (filePath: string, segment: string | undefined) => string;
+/** Whether a path names an in-memory SQLite database, which no file holds. */
+export declare const namesInMemoryDatabase: (filePath: string) => boolean;
+//# sourceMappingURL=segment.d.ts.map

package/dist/shared/segment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"segment.d.ts","sourceRoot":"","sources":["../../src/shared/segment.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAWH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,YAAa,MAAM,KAAG,MAajD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,SAAU,MAAM,WAAW,MAAM,GAAG,SAAS,KAAG,MACF,CAAC;AAMvE;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,aAAc,MAAM,WAAW,MAAM,GAAG,SAAS,KAAG,MAkB/E,CAAC;AAEF,8EAA8E;AAC9E,eAAO,MAAM,qBAAqB,aAlCA,MAAM,KAAG,OAkCQ,CAAC"}

package/dist/shared/segment.js

@@ -0,0 +1,77 @@
+/**
+ * Segments keep one user's tables apart from another's in a database they
+ * share. On PostgreSQL a segment is a schema of its own; on the SQLite family a
+ * database file of its own; on IndexedDB and Capacitor a database name of its
+ * own. A segment name is the same on every backend, so one name gives a host
+ * the same separation on the server, the desktop, the phone and the browser.
+ *
+ * This module imports nothing, so browser bundles can include it.
+ */
+/** PostgreSQL's identifier limit: a schema name has at most 63 bytes. */
+const MAX_SEGMENT_LENGTH = 63;
+/** Lower-case letters, digits and underscores, starting with a letter or an underscore. */
+const SEGMENT_PATTERN = /^[a-z_][a-z0-9_]*$/;
+/** Schemas PostgreSQL keeps for itself, besides the names beginning with pg_. */
+const RESERVED_SEGMENTS = new Set(['public', 'information_schema']);
+/**
+ * Checks a segment name and returns it.
+ *
+ * A segment name is lower-case letters, digits and underscores, starts with a
+ * letter or an underscore, and has at most 63 characters: an unquoted
+ * PostgreSQL identifier, and a safe file, IndexedDB and Capacitor database
+ * name. It is not `public`, `information_schema` or a name beginning with
+ * `pg_`, which PostgreSQL keeps for its own schemas.
+ *
+ * @throws {Error} When the name is not one a segment can take.
+ */
+export const validateSegment = (segment) => {
+    if (typeof segment !== 'string' || !SEGMENT_PATTERN.test(segment) || segment.length > MAX_SEGMENT_LENGTH) {
+        throw new Error(`Invalid segment ${JSON.stringify(segment)}: a segment name is lower-case letters, digits and underscores, ` +
+            `starts with a letter or an underscore, and has at most ${MAX_SEGMENT_LENGTH} characters.`);
+    }
+    if (RESERVED_SEGMENTS.has(segment) || segment.startsWith('pg_')) {
+        throw new Error(`Invalid segment "${segment}": PostgreSQL keeps public, information_schema and the names beginning with pg_ for its own schemas.`);
+    }
+    return segment;
+};
+/**
+ * The name of a segment's database: `name` followed by `-` and the segment,
+ * or `name` itself when there is no segment. For IndexedDB and Capacitor
+ * database names: `app-db` and segment `agentos` give `app-db-agentos`.
+ *
+ * @throws {Error} When the segment is not one a segment name can take.
+ */
+export const segmentName = (name, segment) => segment === undefined ? name : `${name}-${validateSegment(segment)}`;
+/** SQLite's names for a database that lives in its connection alone. */
+const isInMemoryPath = (filePath) => filePath === '' || filePath === ':memory:' || filePath.startsWith('file::memory:');
+/**
+ * The file of a segment's database: the segment goes between the file's name
+ * and its extension (`/data/app.sqlite3` and segment `agentos` give
+ * `/data/app-agentos.sqlite3`), or after a name with no extension. A `file:`
+ * URI keeps its query, and SQLite's in-memory names (`:memory:`,
+ * `file::memory:`) stay as they are, since each in-memory connection is a
+ * database of its own. Without a segment the path is returned as it is.
+ *
+ * @throws {Error} When the segment is not one a segment name can take.
+ */
+export const segmentFilePath = (filePath, segment) => {
+    if (segment === undefined)
+        return filePath;
+    validateSegment(segment);
+    if (isInMemoryPath(filePath))
+        return filePath;
+    // A file: URI's path ends at its query or fragment.
+    const queryAt = filePath.startsWith('file:') ? filePath.search(/[?#]/) : -1;
+    const pathPart = queryAt === -1 ? filePath : filePath.slice(0, queryAt);
+    const rest = queryAt === -1 ? '' : filePath.slice(queryAt);
+    const nameAt = Math.max(pathPart.lastIndexOf('/'), pathPart.lastIndexOf('\\'), pathPart.startsWith('file:') ? 4 : -1) + 1;
+    const directory = pathPart.slice(0, nameAt);
+    const name = pathPart.slice(nameAt);
+    // A dot that begins the name (.store) starts no extension.
+    const extensionAt = name.lastIndexOf('.');
+    const segmented = extensionAt > 0 ? `${name.slice(0, extensionAt)}-${segment}${name.slice(extensionAt)}` : `${name}-${segment}`;
+    return `${directory}${segmented}${rest}`;
+};
+/** Whether a path names an in-memory SQLite database, which no file holds. */
+export const namesInMemoryDatabase = isInMemoryPath;
+//# sourceMappingURL=segment.js.map

package/dist/shared/segment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"segment.js","sourceRoot":"","sources":["../../src/shared/segment.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,yEAAyE;AACzE,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B,2FAA2F;AAC3F,MAAM,eAAe,GAAG,oBAAoB,CAAC;AAE7C,iFAAiF;AACjF,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CAAC;AAEpE;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAe,EAAU,EAAE;IACzD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,kBAAkB,EAAE,CAAC;QACzG,MAAM,IAAI,KAAK,CACb,mBAAmB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,kEAAkE;YAC1G,0DAA0D,kBAAkB,cAAc,CAC7F,CAAC;IACJ,CAAC;IACD,IAAI,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QAChE,MAAM,IAAI,KAAK,CACb,oBAAoB,OAAO,sGAAsG,CAClI,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,OAA2B,EAAU,EAAE,CAC/E,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;AAEvE,wEAAwE;AACxE,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAW,EAAE,CACnD,QAAQ,KAAK,EAAE,IAAI,QAAQ,KAAK,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;AAErF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAE,OAA2B,EAAU,EAAE;IACvF,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IAC3C,eAAe,CAAC,OAAO,CAAC,CAAC;IACzB,IAAI,cAAc,CAAC,QAAQ,CAAC;QAAE,OAAO,QAAQ,CAAC;IAE9C,oDAAoD;IACpD,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5E,MAAM,QAAQ,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACxE,MAAM,IAAI,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE3D,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC1H,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACpC,2DAA2D;IAC3D,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,SAAS,GACb,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,IAAI,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,OAAO,EAAE,CAAC;IAChH,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,IAAI,EAAE,CAAC;AAC3C,CAAC,CAAC;AAEF,8EAA8E;AAC9E,MAAM,CAAC,MAAM,qBAAqB,GAAG,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@framers/sql-storage-adapter",
-  "version": "0.6.16",
+  "version": "0.7.0",
   "description": "Robust cross-platform SQL storage abstraction with automatic fallbacks and runtime detection",
   "type": "module",
   "main": "dist/index.js",
@@ -32,6 +32,11 @@
       "import": "./dist/features/sync/index.js",
       "default": "./dist/features/sync/index.js"
     },
+    "./kv": {
+      "types": "./dist/features/kv/index.d.ts",
+      "import": "./dist/features/kv/index.js",
+      "default": "./dist/features/kv/index.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -48,6 +53,7 @@
     "format:check": "prettier --check \"src/**/*.{ts,tsx,json,md}\"",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
+    "test:browser": "vitest run --config vitest.browser.config.ts",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",
     "coverage": "npm run test:coverage",
@@ -121,7 +127,9 @@
     "typedoc": "^0.26.11",
     "typescript": "^5.6.3",
     "typescript-eslint": "^8.46.2",
-    "vitest": "^3.2.7"
+    "vitest": "^3.2.7",
+    "@vitest/browser": "^3.2.7",
+    "playwright": "~1.63.0"
   },
   "dependencies": {
     "pg": "^8.13.1",