@smart-data-engines/sde 0.1.0-dev.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,13 @@
+Smart Data Engine client libraries
+Copyright 2026 Smart Data Engines
+
+This product includes software developed at Smart Data Engines
+(https://smartdataengines.com).
+
+The libraries in this repository are the client side of Smart Data Engine: they
+declare a data model, cache a placement map, route operations and manage schema.
+They connect to database engines directly and they work without an account.
+
+The control plane - the placement planner, the scoring model and the migration
+orchestrator - is a separate, private program and is not covered by this notice
+or by this licence.

package/README.md

@@ -0,0 +1,153 @@
+# @smart-data-engines/sde — TypeScript client library
+
+Declare your data model. We decide which database engine each part of it lives in, how it is laid out
+there, and when it should move.
+
+```ts
+import { entity, ref, buildModel, T } from '@smart-data-engines/sde'
+
+const User = entity('User', {
+  fields: { id: T.uuid, email: T.string },
+  pii: ['email'],
+})
+
+const Order = entity('Order', {
+  fields: { id: T.uuid, total: T.decimal(12, 2), placedAt: T.timestamptz },
+  relations: { user: ref('User') },
+  residency: 'EU',
+})
+
+const Event = entity('Event', {
+  fields: { id: T.uuid, name: T.string, at: T.timestamptz },
+})
+
+const model = buildModel([User, Order, Event])
+```
+
+`User` and `Order` are related, so they are placed together. `Event` is joined to nothing, so it is
+free to go somewhere built for it. That split is the decision most applications get wrong once, at the
+start, and never revisit.
+
+## Status: Tier 2 for PostgreSQL and ClickHouse, plus hashed identifiers
+
+| Tier | What it covers | Here? |
+|---|---|---|
+| 0 | model, canonical IR and version, groups, shapes and ids, map parsing and refusals, routing | **yes** |
+| 1 | telemetry: measurement, window aggregation, local buffering | **yes** |
+| 2 | schema creation and migration participation | **yes**, for `postgres` and `clickhouse` |
+| 3 | framework integrations, pooling | not yet |
+| — | hashed identifiers (§2a), a mode rather than a tier | **yes** |
+
+The shared vectors for Tier 1 and Tier 2 were written **before** this library claimed those tiers,
+which is what §10 of the format contract says has to happen and is worth knowing about the claim:
+`telemetry/`, `schema/` and `migration/` exist because of it. Closing that gap found five defects in
+the reference implementation, which had been claiming those tiers with nothing shared to check them.
+
+### Where the two libraries differ, and why
+
+Two differences, both deliberate.
+
+**Tier 2 here is asynchronous.** Node's I/O is asynchronous, so a synchronous wrapper around a driver
+means blocking the event loop - a worse thing to do to your process than a `Promise` in a signature.
+The split follows the tiers exactly: everything up to and including telemetry touches no socket and
+stays synchronous, and a `Session` is *opened* rather than constructed, because the forward-only map
+check reads a table and a constructor cannot await. You therefore cannot hold a session whose check
+has not run.
+
+**The ClickHouse adapter has no driver dependency.** There is an official Node client and it requires
+Node 20 or newer; this package supports Node 18 to 26 and its CI runs all five majors. Dropping Node 18
+would narrow a published claim to gain a dependency, and pinning a superseded version of the client
+is the conflict the zero-dependency rule exists to avoid - so neither. ClickHouse's HTTP interface
+needs no client, and this adapter therefore owns both of its timeouts instead of inheriting a
+driver's defaults, which is how the reference implementation discovered that its ClickHouse connect
+timeout never fired.
+
+`pg` is an **optional peer dependency**: install it if you place a group in PostgreSQL, and keep the
+version you already chose. Importing this library resolves neither driver, and a test over the import
+closure of `src/index.ts` pins that - which is what makes the no-account mode free and
+`docs/observability.md` true.
+
+`hashIdentifiers` is listed separately because hashing is orthogonal to the tiers - a complete Tier 0
+library may omit it. What is not optional is agreement: run two services in two languages against one
+model, and if they derive different digests they compute different `model_version` values and each
+refuses the other's placement map. This library passes `conformance/vectors/hashing/`, which is the
+only claim worth making about it.
+
+## Why the model is declared rather than inferred
+
+TypeScript's types are erased before the code runs, so a library cannot read them the way the Python
+one reads annotations. The model is stated as values instead.
+
+That is not a workaround, and it is the reason this was a good second implementation to write. Anything
+the format contract had left implicit - anything that was really "whatever Python's introspection
+produces" - had nowhere to hide here, because nothing is introspected.
+
+It found one immediately, and it was not small. JavaScript compares strings by UTF-16 code unit; the
+contract requires code point order. For anything in the Basic Multilingual Plane the two agree, so no
+test written with Latin or CJK identifiers can see the difference. Above U+FFFF they diverge: an astral
+character is a surrogate pair starting at 0xD800, so `Array.prototype.sort` places every emoji *before*
+U+E000 while code point order places it after. One such field name would have hashed differently in
+Python and TypeScript, the control plane would have seen two models where there was one, and nothing
+would have failed until half a fleet was writing to the wrong tables.
+
+Hence `compareCodePoints` in `src/canonical.ts`, and two vectors that make sure nobody replaces it
+with `.sort()`.
+
+## Conformance
+
+```bash
+npm install
+npx vitest run
+
+# with both engines, which is what the Tier 2 slices need
+export SDE_POSTGRES_DSN=postgresql://postgres:sde@127.0.0.1:55432/sde
+export SDE_CLICKHOUSE_DSN=clickhouse://default:sde@127.0.0.1:58123/sde
+npx vitest run
+```
+
+The vectors live in `../conformance` and are shared with every other language. A divergence is a red
+test for whoever caused it, rather than an operation written to the wrong engine in production.
+
+If you are porting this to another language, read `../docs/format-contract.md` first. It is meant to be
+sufficient on its own; if it is not, that is a bug in the document and worth reporting as one.
+
+## Licence
+
+Apache-2.0.
+
+## Timestamp values
+
+Both adapters return `Timestamp`, an immutable value with microsecond precision, for `timestamp`
+and `timestamptz`. `Date` is still accepted on writes. Use `Timestamp.from(isoText)` for six-digit
+inputs, `.toISOString()` for text and `.epochMicroseconds` for exact comparison; `.toDate()` refuses
+if converting would lose digits. See [exact timestamps](../docs/timestamps.md) for examples and
+migration from the previous `Date` return type.
+
+## Bound migration verification
+
+Configure `Session.open(..., { projectId })` from your local enrollment manifest. Load the
+controller's request with `VerificationRequest.fromRecord` and call `verify(session, group,
+{ request })`; send `verifyRecord(report)` back. The complete request is checked before comparison,
+and row-level differences remain local. See [the request protocol](../docs/format-contract.md#7b-verification-requests-and-bound-reports).
+Loaded placement maps are immutable snapshots. Load a new document rather than modifying a layout
+or copying an object with its old fingerprint.
+
+Batch operations: [logical bulk writes](../docs/bulk-writes.md) document `save_many` / `saveMany`,
+bounds, source/copy ordering and uncertain outcomes.
+
+[Logical reads and exact summaries](../docs/logical-reads.md) cover scan, count and summarize,
+including portable keyset pages, typed values and explicit failure semantics.
+
+## Local Weather starter
+
+The unreleased [Weather starter](https://github.com/Smart-Data-Engines/smart-data-engine-sdk/blob/main/docs/weather-starter.md)
+installs from reviewed artifacts and exercises logical operations with restricted runtime credentials.
+It includes local setup, telemetry, operator handoffs and an ownership-checked reset.
+
+## Test-tool dependencies
+
+The Node 18/20/22/24/26 matrix uses the tool versions and supported invocation described in
+[the test-toolchain record](../docs/test-toolchain.md). That record distinguishes the SDK runtime
+from development dependencies and documents the remaining development-server advisory.
+
+Engine credentials and verified TLS configuration: [connection guide](../docs/engine-connections.md).

package/bin/weather.mjs

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+/** Runtime entry point; bootstrap and the local operator use the Python sde-weather command. */
+import { resolve } from 'node:path'
+import { parseArgs } from 'node:util'
+import { DemoRefused } from '../dist/demo/project.js'
+import { runWeather, workloads } from '../dist/demo/weather.js'
+
+try {
+  const { values, positionals } = parseArgs({ allowPositionals: true, options: {
+    directory: { type: 'string' }, iterations: { type: 'string', default: '10' },
+    'batch-size': { type: 'string', default: '10' }, 'interval-ms': { type: 'string', default: '100' },
+    'recovery-ms': { type: 'string', default: '10000' }, workload: { type: 'string', default: 'mixed' },
+    help: { type: 'boolean' },
+  } })
+  if (values.help) {
+    console.log(`sde-weather-ts --directory DIR run [--iterations 10] [--batch-size 10] [--interval-ms 100] [--recovery-ms 10000] [--workload ${workloads.join('|')}]`)
+  } else {
+    const workload = workloads.find(item => item === (values.workload ?? 'mixed'))
+    if (positionals.length !== 1 || positionals[0] !== 'run' || !values.directory ||
+        workload === undefined) throw new DemoRefused('Use --help for the local runtime command.')
+    const result = await runWeather(resolve(values.directory), {
+      iterations: Number(values.iterations), batchSize: Number(values['batch-size']),
+      intervalMs: Number(values['interval-ms']), recoveryMs: Number(values['recovery-ms']),
+      workload,
+    })
+    console.log(JSON.stringify(result))
+  }
+} catch (error) {
+  console.error(JSON.stringify({ error: error instanceof Error ? error.name : 'UnknownError', message:
+    error instanceof DemoRefused ? error.message : 'The local operation did not complete. Inspect the run report before retrying.' }))
+  process.exitCode = error instanceof DemoRefused ? 2 : 3
+}

package/dist/_usage.d.ts

@@ -0,0 +1,30 @@
+export declare function checkScope(): void;
+export declare function withSession<T>(owner: object, body: () => T): T;
+export declare class UsageGate {
+    private operationOwner;
+    private operationDepth;
+    private transactionOwner;
+    private checkTransaction;
+    operation<T>(body: () => Promise<T>): Promise<T>;
+    transaction<T>(body: () => Promise<T>): Promise<T>;
+    seal(): void;
+    idle(): void;
+}
+export declare class SessionUsage {
+    private readonly owner;
+    private closed;
+    private busy;
+    private transactionScope;
+    constructor(owner: object);
+    isOwner(owner: object): boolean;
+    check(): void;
+    group(name: string): void;
+    operation<T>(body: () => Promise<T>): Promise<T>;
+    transaction<T>(group: string, body: () => Promise<T>): Promise<T>;
+    idle(): void;
+    maintenance<T>(body: () => Promise<T>): Promise<T>;
+    seal(): void;
+    close(): void;
+}
+export declare function registerSession(owner: object, usage: SessionUsage): void;
+export declare function withReader<T>(reader: object, body: () => Promise<T>): Promise<T>;

package/dist/_usage.js

@@ -0,0 +1,194 @@
+/** Local operation/transaction ownership across async execution chains. */
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { ModelPlanningError, ResourceBusy, ResourceClosed } from './errors.js';
+const sessionOwner = new AsyncLocalStorage();
+const operation = new AsyncLocalStorage();
+const transaction = new AsyncLocalStorage();
+export function checkScope() {
+    let scope = transaction.getStore();
+    while (scope !== undefined) {
+        if (!scope.active)
+            throw new ResourceClosed('the inherited transaction scope has already ended');
+        scope = scope.parent;
+    }
+}
+export function withSession(owner, body) {
+    checkScope();
+    const logical = sessionScope.getStore();
+    if (logical !== undefined && logical.active && !logical.usage.isOwner(owner)) {
+        throw new ResourceBusy('another session owns the current transaction scope');
+    }
+    const scope = transaction.getStore();
+    if (scope !== undefined && scope.session !== owner) {
+        throw new ResourceBusy('another session owns the current transaction scope');
+    }
+    return sessionOwner.run(owner, body);
+}
+export class UsageGate {
+    operationOwner;
+    operationDepth = 0;
+    transactionOwner;
+    checkTransaction() {
+        checkScope();
+        if (this.transactionOwner === undefined)
+            return;
+        let scope = transaction.getStore();
+        while (scope !== undefined && scope.gate !== this)
+            scope = scope.parent;
+        if (scope !== this.transactionOwner || scope.session !== sessionOwner.getStore()) {
+            throw new ResourceBusy('the connection is owned by another active transaction scope');
+        }
+    }
+    async operation(body) {
+        this.checkTransaction();
+        const owner = operation.getStore() ?? {};
+        if (this.operationOwner !== undefined && this.operationOwner !== owner) {
+            throw new ResourceBusy('the connection already has an operation in progress');
+        }
+        this.operationOwner = owner;
+        this.operationDepth++;
+        return operation.run(owner, async () => {
+            let failed = false;
+            try {
+                return await body();
+            }
+            catch (error) {
+                failed = true;
+                throw error;
+            }
+            finally {
+                this.operationDepth--;
+                if (this.operationDepth === 0)
+                    this.operationOwner = undefined;
+                if (!failed)
+                    checkScope();
+            }
+        });
+    }
+    async transaction(body) {
+        this.checkTransaction();
+        if (this.operationOwner !== undefined) {
+            throw new ResourceBusy('a transaction cannot begin while an operation is in progress');
+        }
+        const previous = this.transactionOwner;
+        const scope = {
+            gate: this, parent: transaction.getStore(), session: sessionOwner.getStore(), active: true,
+        };
+        this.transactionOwner = scope;
+        return transaction.run(scope, async () => {
+            try {
+                return await body();
+            }
+            finally {
+                scope.active = false;
+                this.transactionOwner = previous;
+            }
+        });
+    }
+    seal() { if (this.transactionOwner !== undefined)
+        this.transactionOwner.active = false; }
+    idle() {
+        if (this.operationOwner !== undefined) {
+            if (this.transactionOwner !== undefined)
+                this.transactionOwner.active = false;
+            throw new ResourceBusy('finish all operations before leaving the transaction');
+        }
+    }
+}
+const sessionScope = new AsyncLocalStorage();
+export class SessionUsage {
+    owner;
+    closed = false;
+    busy = false;
+    transactionScope;
+    constructor(owner) {
+        this.owner = owner;
+    }
+    isOwner(owner) { return this.owner === owner; }
+    check() {
+        checkScope();
+        const scope = sessionScope.getStore();
+        if (this.closed || (scope !== undefined && !scope.active)) {
+            throw new ResourceClosed('the session or inherited transaction scope has ended');
+        }
+        if (this.transactionScope !== undefined && scope !== this.transactionScope) {
+            throw new ResourceBusy('the session belongs to another active transaction context');
+        }
+    }
+    group(name) {
+        this.check();
+        if (this.transactionScope !== undefined && this.transactionScope.group !== name) {
+            throw new ModelPlanningError("the operation is outside the active transaction's colocation group");
+        }
+    }
+    async operation(body) {
+        this.check();
+        if (this.busy)
+            throw new ResourceBusy('the session already has an operation in progress');
+        this.busy = true;
+        let failed = false;
+        try {
+            return await withSession(this.owner, async () => {
+                try {
+                    return await body();
+                }
+                catch (error) {
+                    failed = true;
+                    throw error;
+                }
+                finally {
+                    if (!failed)
+                        this.check();
+                }
+            });
+        }
+        finally {
+            this.busy = false;
+        }
+    }
+    async transaction(group, body) {
+        this.group(group);
+        if (this.busy)
+            throw new ResourceBusy('finish the session operation before beginning a transaction');
+        const previous = this.transactionScope;
+        const scope = { usage: this, group, active: true };
+        this.transactionScope = scope;
+        try {
+            return await sessionScope.run(scope, () => withSession(this.owner, body));
+        }
+        finally {
+            scope.active = false;
+            this.transactionScope = previous;
+        }
+    }
+    idle() {
+        if (this.busy) {
+            if (this.transactionScope !== undefined)
+                this.transactionScope.active = false;
+            throw new ResourceBusy('finish all session operations before leaving the transaction');
+        }
+    }
+    async maintenance(body) {
+        this.check();
+        if (this.transactionScope !== undefined)
+            throw new ResourceBusy('run migration helpers outside application transactions');
+        return this.operation(body);
+    }
+    seal() { if (this.transactionScope !== undefined)
+        this.transactionScope.active = false; }
+    close() {
+        if (this.busy || this.transactionScope !== undefined) {
+            throw new ResourceBusy('cannot close a session while its operation or transaction is active');
+        }
+        this.closed = true;
+    }
+}
+const sessions = new WeakMap();
+export function registerSession(owner, usage) { sessions.set(owner, usage); }
+export async function withReader(reader, body) {
+    const usage = sessions.get(reader);
+    if (usage === undefined)
+        return body();
+    return usage.maintenance(body);
+}
+//# sourceMappingURL=_usage.js.map

package/dist/_usage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_usage.js","sourceRoot":"","sources":["../src/_usage.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAQ9E,MAAM,YAAY,GAAG,IAAI,iBAAiB,EAAU,CAAA;AACpD,MAAM,SAAS,GAAG,IAAI,iBAAiB,EAAU,CAAA;AACjD,MAAM,WAAW,GAAG,IAAI,iBAAiB,EAAoB,CAAA;AAE7D,MAAM,UAAU,UAAU;IACxB,IAAI,KAAK,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAA;IAClC,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC3B,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,MAAM,IAAI,cAAc,CAAC,mDAAmD,CAAC,CAAA;QAChG,KAAK,GAAG,KAAK,CAAC,MAAM,CAAA;IACtB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,WAAW,CAAI,KAAa,EAAE,IAAa;IACzD,UAAU,EAAE,CAAA;IACZ,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAA;IACvC,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7E,MAAM,IAAI,YAAY,CAAC,oDAAoD,CAAC,CAAA;IAC9E,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAA;IACpC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;QACnD,MAAM,IAAI,YAAY,CAAC,oDAAoD,CAAC,CAAA;IAC9E,CAAC;IACD,OAAO,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;AACtC,CAAC;AAED,MAAM,OAAO,SAAS;IACZ,cAAc,CAAoB;IAClC,cAAc,GAAG,CAAC,CAAA;IAClB,gBAAgB,CAA8B;IAE9C,gBAAgB;QACtB,UAAU,EAAE,CAAA;QACZ,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS;YAAE,OAAM;QAC/C,IAAI,KAAK,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAA;QAClC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI;YAAE,KAAK,GAAG,KAAK,CAAC,MAAM,CAAA;QACvE,IAAI,KAAK,KAAK,IAAI,CAAC,gBAAgB,IAAI,KAAK,CAAC,OAAO,KAAK,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;YACjF,MAAM,IAAI,YAAY,CAAC,6DAA6D,CAAC,CAAA;QACvF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CAAI,IAAsB;QACvC,IAAI,CAAC,gBAAgB,EAAE,CAAA;QACvB,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAA;QACxC,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC;YACvE,MAAM,IAAI,YAAY,CAAC,qDAAqD,CAAC,CAAA;QAC/E,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,KAAK,CAAA;QAC3B,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,OAAO,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,IAAI,EAAE;YACrC,IAAI,MAAM,GAAG,KAAK,CAAA;YAClB,IAAI,CAAC;gBACH,OAAO,MAAM,IAAI,EAAE,CAAA;YACrB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,GAAG,IAAI,CAAA;gBACb,MAAM,KAAK,CAAA;YACb,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,cAAc,EAAE,CAAA;gBACrB,IAAI,IAAI,CAAC,cAAc,KAAK,CAAC;oBAAE,IAAI,CAAC,cAAc,GAAG,SAAS,CAAA;gBAC9D,IAAI,CAAC,MAAM;oBAAE,UAAU,EAAE,CAAA;YAC3B,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CAAI,IAAsB;QACzC,IAAI,CAAC,gBAAgB,EAAE,CAAA;QACvB,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,IAAI,YAAY,CAAC,8DAA8D,CAAC,CAAA;QACxF,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAA;QACtC,MAAM,KAAK,GAAqB;YAC9B,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,YAAY,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI;SAC3F,CAAA;QACD,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAA;QAC7B,OAAO,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,IAAI,EAAE;YACvC,IAAI,CAAC;gBAAC,OAAO,MAAM,IAAI,EAAE,CAAA;YAAC,CAAC;oBACnB,CAAC;gBAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;gBAAC,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAA;YAAC,CAAC;QACpE,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,KAAW,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS;QAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,KAAK,CAAA,CAAC,CAAC;IAE9F,IAAI;QACF,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS;gBAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,KAAK,CAAA;YAC7E,MAAM,IAAI,YAAY,CAAC,sDAAsD,CAAC,CAAA;QAChF,CAAC;IACH,CAAC;CACF;AAGD,MAAM,YAAY,GAAG,IAAI,iBAAiB,EAAgB,CAAA;AAE1D,MAAM,OAAO,YAAY;IAIM;IAHrB,MAAM,GAAG,KAAK,CAAA;IACd,IAAI,GAAG,KAAK,CAAA;IACZ,gBAAgB,CAA0B;IAClD,YAA6B,KAAa;QAAb,UAAK,GAAL,KAAK,CAAQ;IAAG,CAAC;IAC9C,OAAO,CAAC,KAAa,IAAa,OAAO,IAAI,CAAC,KAAK,KAAK,KAAK,CAAA,CAAC,CAAC;IAE/D,KAAK;QACH,UAAU,EAAE,CAAA;QACZ,MAAM,KAAK,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAA;QACrC,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1D,MAAM,IAAI,cAAc,CAAC,sDAAsD,CAAC,CAAA;QAClF,CAAC;QACD,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3E,MAAM,IAAI,YAAY,CAAC,2DAA2D,CAAC,CAAA;QACrF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAY;QAChB,IAAI,CAAC,KAAK,EAAE,CAAA;QACZ,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YAChF,MAAM,IAAI,kBAAkB,CAAC,oEAAoE,CAAC,CAAA;QACpG,CAAC;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CAAI,IAAsB;QACvC,IAAI,CAAC,KAAK,EAAE,CAAA;QACZ,IAAI,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,YAAY,CAAC,kDAAkD,CAAC,CAAA;QACzF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,MAAM,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC;YACH,OAAO,MAAM,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,IAAI,EAAE;gBAC9C,IAAI,CAAC;oBAAC,OAAO,MAAM,IAAI,EAAE,CAAA;gBAAC,CAAC;gBAC3B,OAAO,KAAK,EAAE,CAAC;oBAAC,MAAM,GAAG,IAAI,CAAC;oBAAC,MAAM,KAAK,CAAA;gBAAC,CAAC;wBACpC,CAAC;oBAAC,IAAI,CAAC,MAAM;wBAAE,IAAI,CAAC,KAAK,EAAE,CAAA;gBAAC,CAAC;YACvC,CAAC,CAAC,CAAA;QACJ,CAAC;gBAAS,CAAC;YAAC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAA;QAAC,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,WAAW,CAAI,KAAa,EAAE,IAAsB;QACxD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACjB,IAAI,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,YAAY,CAAC,6DAA6D,CAAC,CAAA;QACpG,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAA;QACtC,MAAM,KAAK,GAAiB,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAA;QAChE,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAA;QAC7B,IAAI,CAAC;YAAC,OAAO,MAAM,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;QAAC,CAAC;gBACzE,CAAC;YAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;YAAC,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAA;QAAC,CAAC;IACpE,CAAC;IAED,IAAI;QACF,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS;gBAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,KAAK,CAAA;YAC7E,MAAM,IAAI,YAAY,CAAC,8DAA8D,CAAC,CAAA;QACxF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CAAI,IAAsB;QACzC,IAAI,CAAC,KAAK,EAAE,CAAA;QACZ,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS;YAAE,MAAM,IAAI,YAAY,CAAC,wDAAwD,CAAC,CAAA;QACzH,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;IAED,IAAI,KAAW,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS;QAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,KAAK,CAAA,CAAC,CAAC;IAE9F,KAAK;QACH,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACrD,MAAM,IAAI,YAAY,CAAC,qEAAqE,CAAC,CAAA;QAC/F,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;IACpB,CAAC;CACF;AAED,MAAM,QAAQ,GAAG,IAAI,OAAO,EAAwB,CAAA;AACpD,MAAM,UAAU,eAAe,CAAC,KAAa,EAAE,KAAmB,IAAU,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA,CAAC,CAAC;AACxG,MAAM,CAAC,KAAK,UAAU,UAAU,CAAI,MAAc,EAAE,IAAsB;IACxE,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAClC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,EAAE,CAAA;IACtC,OAAO,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;AAChC,CAAC"}

package/dist/bulk.d.ts

@@ -0,0 +1,9 @@
+import type { Row } from './session.js';
+export declare const MAX_BATCH_ROWS = 1000;
+export declare const MAX_BATCH_VALUES = 60000;
+export interface BulkWritable {
+    insertMany(table: string, rows: readonly Readonly<Row>[]): Promise<void>;
+}
+export declare function bulkWriter(engine: object): BulkWritable;
+export declare function batchColumns(rows: readonly Readonly<Row>[], extraColumns?: number): string[];
+export declare function snapshotRows(rows: readonly Readonly<Row>[]): Row[];