@framers/sql-storage-adapter 0.6.15 → 0.7.0

package/dist/shared/errors.js

@@ -0,0 +1,44 @@
+/**
+ * Error checks that read the same failure from every adapter.
+ */
+/** better-sqlite3's extended result codes for a unique or primary-key violation. */
+const SQLITE_UNIQUE_CODES = new Set(['SQLITE_CONSTRAINT_UNIQUE', 'SQLITE_CONSTRAINT_PRIMARYKEY']);
+/** SQLite's message for one, which sql.js and the Capacitor plugin pass on without a code. */
+const SQLITE_UNIQUE_MESSAGE = /\bUNIQUE constraint failed\b/;
+/** How deep isUniqueViolation follows `cause`. */
+const MAX_CAUSE_DEPTH = 10;
+/**
+ * Whether `error` is a unique or primary-key violation, from any adapter:
+ * PostgreSQL's SQLSTATE `23505` (`unique_violation`, pg's `code`),
+ * better-sqlite3's `SQLITE_CONSTRAINT_UNIQUE` and
+ * `SQLITE_CONSTRAINT_PRIMARYKEY`, and the "UNIQUE constraint failed" message
+ * that sql.js, the IndexedDB adapter and the Capacitor plugin give. An error
+ * that wraps one as its `cause`, to any depth up to ten, counts too.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await db.run('INSERT INTO users (email) VALUES (?)', [email]);
+ * } catch (error) {
+ *   if (isUniqueViolation(error)) return { taken: true };
+ *   throw error;
+ * }
+ * ```
+ */
+export const isUniqueViolation = (error) => {
+    const seen = new Set();
+    let current = error;
+    while (current !== null && typeof current === 'object' && !seen.has(current) && seen.size < MAX_CAUSE_DEPTH) {
+        seen.add(current);
+        const { code, message } = current;
+        if (code === '23505')
+            return true;
+        if (typeof code === 'string' && SQLITE_UNIQUE_CODES.has(code))
+            return true;
+        if (typeof message === 'string' && SQLITE_UNIQUE_MESSAGE.test(message))
+            return true;
+        current = current.cause;
+    }
+    return false;
+};
+//# sourceMappingURL=errors.js.map

package/dist/shared/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/shared/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,oFAAoF;AACpF,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,CAAC,0BAA0B,EAAE,8BAA8B,CAAC,CAAC,CAAC;AAElG,8FAA8F;AAC9F,MAAM,qBAAqB,GAAG,8BAA8B,CAAC;AAE7D,kDAAkD;AAClD,MAAM,eAAe,GAAG,EAAE,CAAC;AAE3B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAAW,EAAE;IAC3D,MAAM,IAAI,GAAG,IAAI,GAAG,EAAW,CAAC;IAChC,IAAI,OAAO,GAAY,KAAK,CAAC;IAC7B,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,eAAe,EAAE,CAAC;QAC5G,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClB,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAgD,CAAC;QAC3E,IAAI,IAAI,KAAK,OAAO;YAAE,OAAO,IAAI,CAAC;QAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;QAC3E,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC;YAAE,OAAO,IAAI,CAAC;QACpF,OAAO,GAAI,OAA+B,CAAC,KAAK,CAAC;IACnD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}

package/dist/shared/logger.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Where the library's log lines go. A host hands its own logger in, and
+ * pino's logger fits as it is: each call passes the line's fields first and
+ * its message second, as pino takes them. Without one, lines go to the
+ * console, as the library has always written them.
+ */
+export interface StorageLogger {
+    debug?(fields: Record<string, unknown>, message: string): void;
+    info(fields: Record<string, unknown>, message: string): void;
+    warn(fields: Record<string, unknown>, message: string): void;
+    error(fields: Record<string, unknown>, message: string): void;
+}
+/**
+ * Routes every line the library writes to `logger`, from then on and in every
+ * adapter. `null` routes them back to the console.
+ *
+ * @example
+ * ```typescript
+ * import pino from 'pino';
+ * setStorageLogger(pino({ name: 'storage' }));
+ * ```
+ */
+export declare const setStorageLogger: (logger: StorageLogger | null) => void;
+/** The logger the library writes to now. */
+export declare const getStorageLogger: () => StorageLogger;
+//# sourceMappingURL=logger.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/shared/logger.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/D,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7D,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7D,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/D;AAgBD;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,WAAY,aAAa,GAAG,IAAI,KAAG,IAE/D,CAAC;AAEF,4CAA4C;AAC5C,eAAO,MAAM,gBAAgB,QAAO,aAAwB,CAAC"}

package/dist/shared/logger.js

@@ -0,0 +1,26 @@
+/** The console line's prefix: the field `scope` when a line has one, else StorageAdapter. */
+const prefix = (fields) => `[${typeof fields.scope === 'string' ? fields.scope : 'StorageAdapter'}]`;
+/** The default: one line on the console per call, prefixed as before. */
+const consoleLogger = {
+    debug: (fields, message) => console.log(`${prefix(fields)} ${message}`),
+    info: (fields, message) => console.info(`${prefix(fields)} ${message}`),
+    warn: (fields, message) => console.warn(`${prefix(fields)} ${message}`),
+    error: (fields, message) => console.error(`${prefix(fields)} ${message}`),
+};
+let current = consoleLogger;
+/**
+ * Routes every line the library writes to `logger`, from then on and in every
+ * adapter. `null` routes them back to the console.
+ *
+ * @example
+ * ```typescript
+ * import pino from 'pino';
+ * setStorageLogger(pino({ name: 'storage' }));
+ * ```
+ */
+export const setStorageLogger = (logger) => {
+    current = logger ?? consoleLogger;
+};
+/** The logger the library writes to now. */
+export const getStorageLogger = () => current;
+//# sourceMappingURL=logger.js.map

package/dist/shared/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/shared/logger.ts"],"names":[],"mappings":"AAaA,6FAA6F;AAC7F,MAAM,MAAM,GAAG,CAAC,MAA+B,EAAU,EAAE,CACzD,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,gBAAgB,GAAG,CAAC;AAE5E,yEAAyE;AACzE,MAAM,aAAa,GAAkB;IACnC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;IACvE,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;IACvE,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;IACvE,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;CAC1E,CAAC;AAEF,IAAI,OAAO,GAAkB,aAAa,CAAC;AAE3C;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAA4B,EAAQ,EAAE;IACrE,OAAO,GAAG,MAAM,IAAI,aAAa,CAAC;AACpC,CAAC,CAAC;AAEF,4CAA4C;AAC5C,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAkB,EAAE,CAAC,OAAO,CAAC"}

package/dist/shared/parameterUtils.d.ts

@@ -6,4 +6,11 @@ export declare const normaliseParameters: (parameters?: StorageParameters) => {
     named?: Record<string, unknown>;
     positional?: Array<unknown>;
 };
+/**
+ * Named parameters under every key sql.js may look them up by. sql.js binds a
+ * named value only under the key that matches the placeholder as written
+ * (":id", "@id", "$id"); better-sqlite3 takes the bare key ("id"). Expanding
+ * every variant lets one payload work on both.
+ */
+export declare const expandNamedParameters: (named: Record<string, unknown>) => Record<string, unknown>;
 //# sourceMappingURL=parameterUtils.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"parameterUtils.d.ts","sourceRoot":"","sources":["../../src/shared/parameterUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,mBAAmB,gBACjB,iBAAiB,KAC7B;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;CAehE,CAAC"}
+{"version":3,"file":"parameterUtils.d.ts","sourceRoot":"","sources":["../../src/shared/parameterUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,mBAAmB,gBACjB,iBAAiB,KAC7B;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;CAehE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,UAAW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAY5F,CAAC"}

package/dist/shared/parameterUtils.js

@@ -14,4 +14,29 @@ export const normaliseParameters = (parameters) => {
     // Fall back to positional when unknown primitive is provided.
     return { positional: [parameters] };
 };
+/**
+ * Named parameters under every key sql.js may look them up by. sql.js binds a
+ * named value only under the key that matches the placeholder as written
+ * (":id", "@id", "$id"); better-sqlite3 takes the bare key ("id"). Expanding
+ * every variant lets one payload work on both.
+ */
+export const expandNamedParameters = (named) => {
+    const expanded = { ...named };
+    for (const [rawKey, value] of Object.entries(named)) {
+        if (!rawKey)
+            continue;
+        const key = rawKey.replace(/^[:@$]/, '');
+        if (!key)
+            continue;
+        if (!(key in expanded))
+            expanded[key] = value;
+        if (!(`:${key}` in expanded))
+            expanded[`:${key}`] = value;
+        if (!(`@${key}` in expanded))
+            expanded[`@${key}`] = value;
+        if (!(`$${key}` in expanded))
+            expanded[`$${key}`] = value;
+    }
+    return expanded;
+};
 //# sourceMappingURL=parameterUtils.js.map

package/dist/shared/parameterUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"parameterUtils.js","sourceRoot":"","sources":["../../src/shared/parameterUtils.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,UAA8B,EACoC,EAAE;IACpE,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9B,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC;IACpC,CAAC;IAED,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO,EAAE,KAAK,EAAE,UAAqC,EAAE,CAAC;IAC1D,CAAC;IAED,8DAA8D;IAC9D,OAAO,EAAE,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;AACtC,CAAC,CAAC"}
+{"version":3,"file":"parameterUtils.js","sourceRoot":"","sources":["../../src/shared/parameterUtils.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,UAA8B,EACoC,EAAE;IACpE,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9B,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC;IACpC,CAAC;IAED,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO,EAAE,KAAK,EAAE,UAAqC,EAAE,CAAC;IAC1D,CAAC;IAED,8DAA8D;IAC9D,OAAO,EAAE,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;AACtC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,KAA8B,EAA2B,EAAE;IAC/F,MAAM,QAAQ,GAA4B,EAAE,GAAG,KAAK,EAAE,CAAC;IACvD,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACpD,IAAI,CAAC,MAAM;YAAE,SAAS;QACtB,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG;YAAE,SAAS;QACnB,IAAI,CAAC,CAAC,GAAG,IAAI,QAAQ,CAAC;YAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC9C,IAAI,CAAC,CAAC,IAAI,GAAG,EAAE,IAAI,QAAQ,CAAC;YAAE,QAAQ,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC;QAC1D,IAAI,CAAC,CAAC,IAAI,GAAG,EAAE,IAAI,QAAQ,CAAC;YAAE,QAAQ,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC;QAC1D,IAAI,CAAC,CAAC,IAAI,GAAG,EAAE,IAAI,QAAQ,CAAC;YAAE,QAAQ,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC;IAC5D,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC"}

package/dist/shared/postgresTarget.d.ts

@@ -2,9 +2,10 @@ import type { PostgresAdapterOptions } from '../adapters/postgresAdapter.js';
 /** A string with something in it. */
 export declare const isNonEmpty: (value: unknown) => value is string;
 /**
- * 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 declare const namesPostgresServer: (options: PostgresAdapterOptions | undefined) => boolean;
 //# sourceMappingURL=postgresTarget.d.ts.map

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/dist/shared/sqlPlaceholders.d.ts

@@ -0,0 +1,40 @@
+import type { StorageParameters } from '../core/contracts/index.js';
+/** A statement and its values, ready for node-postgres. */
+export interface PostgresStatement {
+    text: string;
+    values: unknown[];
+}
+/**
+ * Rewrites a statement's placeholders for node-postgres, which takes only
+ * `$1`, `$2`, ... Outside literals, quoted identifiers, dollar-quoted strings
+ * and comments:
+ *
+ * - Named parameters: each `@name` becomes the next `$n`, bound to that name's value.
+ * - A statement that already uses `$n` placeholders is sent as written, its
+ *   `?` operators included.
+ * - Otherwise `??` becomes `?` (the jsonb key-exists operator), `?|` and `?&`
+ *   stay operators (`?||` and `?&&` are a placeholder followed by `||` or
+ *   `&&`), and each other `?` becomes the next `$n`. A statement run without
+ *   parameters keeps its `?`, so the jsonb `?` operator works in it as written.
+ */
+export declare const toPostgresStatement: (statement: string, parameters?: StorageParameters) => PostgresStatement;
+/** A statement and its parameters, ready for a SQLite engine. */
+export interface SqliteStatement {
+    statement: string;
+    parameters?: StorageParameters;
+}
+/**
+ * A value as the SQLite adapters bind it. better-sqlite3 refuses booleans,
+ * Dates and objects, and sql.js refuses Dates and binds an array as a blob,
+ * so: a boolean binds as 1 or 0, a Date as its ISO 8601 text (an Invalid Date
+ * is refused), an array or a plain object as JSON text, and undefined as
+ * NULL. Strings, numbers, bigints, null and bytes bind as they are.
+ */
+export declare const toSqliteValue: (value: unknown) => unknown;
+/**
+ * The statement and values a SQLite adapter binds: `$n` placeholders become
+ * `?` (see rewriteDollarPlaceholders above) and each value is converted with
+ * toSqliteValue, positional and named alike.
+ */
+export declare const toSqliteStatement: (statement: string, parameters?: StorageParameters) => SqliteStatement;
+//# sourceMappingURL=sqlPlaceholders.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sqlPlaceholders.d.ts","sourceRoot":"","sources":["../../src/shared/sqlPlaceholders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AA8J3D,2DAA2D;AAC3D,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,EAAE,CAAC;CACnB;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,mBAAmB,cAAe,MAAM,eAAe,iBAAiB,KAAG,iBA4DvF,CAAC;AAEF,iEAAiE;AACjE,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAChC;AA+CD;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,UAAW,OAAO,KAAG,OAW9C,CAAC;AAeF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,cAAe,MAAM,eAAe,iBAAiB,KAAG,eAGrF,CAAC"}