@nebutra/tenant-store 0.2.2 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,7 @@
 # @nebutra/tenant-store
 
+## 2.0.0
+
 ## 0.2.2
 
 ### Patch Changes

package/package.json

@@ -1,19 +1,25 @@
 {
   "name": "@nebutra/tenant-store",
-  "version": "0.2.2",
+  "version": "2.0.0",
   "description": "Neutral lowest-layer multi-tenant primitives: per-(tenant,resource) serialization lock + tenant-scoped in-memory store base. Depended on by atelier-canvas and reel; depends on neither.",
   "private": false,
   "license": "MIT",
   "type": "module",
   "nebutra": {
+    "status": "foundation",
+    "graph": "core",
     "featureId": "tenant-store",
     "category": "platform",
     "summary": "Multi-tenant lock + store base shared by canvas/graph features"
   },
-  "main": "./src/index.ts",
-  "types": "./src/index.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./src/index.ts"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
   },
   "dependencies": {},
   "devDependencies": {
@@ -34,6 +40,12 @@
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
   "scripts": {
     "build": "tsup",
     "test": "vitest run",

package/.turbo/turbo-build.log

@@ -1,17 +0,0 @@
-
-> @nebutra/tenant-store@0.2.2 build /Users/tseka_luk/Documents/Nebutra-SaaS-Lab/Nebutra-Sailor/packages/platform/tenant-store
-> tsup
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.5.1
-CLI Using tsup config: /Users/tseka_luk/Documents/Nebutra-SaaS-Lab/Nebutra-Sailor/packages/platform/tenant-store/tsup.config.ts
-CLI Target: es2022
-CLI Cleaning output folder
-ESM Build start
-ESM dist/index.js     1.83 KB
-ESM dist/index.js.map 6.80 KB
-ESM ⚡️ Build success in 57ms
-DTS Build start
-DTS ⚡️ Build success in 2951ms
-DTS dist/index.d.ts 3.40 KB

package/.turbo/turbo-test.log

@@ -1,14 +0,0 @@
-
-> @nebutra/tenant-store@0.2.1 test /Users/tseka_luk/Documents/Nebutra-SaaS-Lab/Nebutra-Sailor/packages/platform/tenant-store
-> vitest run
-
-
- RUN  v4.1.4 /Users/tseka_luk/Documents/Nebutra-SaaS-Lab/Nebutra-Sailor/packages/platform/tenant-store
-
- ✓ src/__tests__/tenant-store.test.ts (12 tests) 88ms
-
- Test Files  1 passed (1)
-      Tests  12 passed (12)
-   Start at  09:38:28
-   Duration  301ms (transform 32ms, setup 0ms, import 46ms, tests 88ms, environment 0ms)
-

package/.turbo/turbo-typecheck.log

@@ -1,4 +0,0 @@
-
-> @nebutra/tenant-store@0.2.2 typecheck /Users/tseka_luk/Documents/Nebutra-SaaS-Lab/Nebutra-Sailor/packages/platform/tenant-store
-> tsc --noEmit
-

package/src/__tests__/tenant-store.test.ts

@@ -1,123 +0,0 @@
-import { beforeEach, describe, expect, it } from "vitest";
-import { _resetTenantLocks, withTenantLock } from "../lock";
-import { InMemoryTenantStore } from "../store";
-
-describe("withTenantLock", () => {
-  beforeEach(() => _resetTenantLocks());
-
-  it("serializes calls for the same (tenant, resource) in submission order", async () => {
-    const order: number[] = [];
-    const slow = (n: number, ms: number) =>
-      withTenantLock("t1", "r1", async () => {
-        await new Promise((r) => setTimeout(r, ms));
-        order.push(n);
-      });
-    // 1 submitted first but slowest — must still finish before 2 and 3.
-    await Promise.all([slow(1, 30), slow(2, 5), slow(3, 1)]);
-    expect(order).toEqual([1, 2, 3]);
-  });
-
-  it("runs different resources concurrently", async () => {
-    const order: string[] = [];
-    await Promise.all([
-      withTenantLock("t1", "a", async () => {
-        await new Promise((r) => setTimeout(r, 20));
-        order.push("a");
-      }),
-      withTenantLock("t1", "b", async () => {
-        order.push("b");
-      }),
-    ]);
-    // b (no wait) finishes before slow a → proves no cross-resource serialization.
-    expect(order).toEqual(["b", "a"]);
-  });
-
-  it("isolates the same resourceId across tenants", async () => {
-    const order: string[] = [];
-    await Promise.all([
-      withTenantLock("tenantA", "shared", async () => {
-        await new Promise((r) => setTimeout(r, 20));
-        order.push("A");
-      }),
-      withTenantLock("tenantB", "shared", async () => {
-        order.push("B");
-      }),
-    ]);
-    expect(order).toEqual(["B", "A"]);
-  });
-
-  it("does not deadlock the next waiter when a section rejects", async () => {
-    const failing = withTenantLock("t1", "r1", async () => {
-      throw new Error("boom");
-    });
-    await expect(failing).rejects.toThrow("boom");
-    const ok = await withTenantLock("t1", "r1", async () => "recovered");
-    expect(ok).toBe("recovered");
-  });
-
-  it("returns the section's value", async () => {
-    await expect(withTenantLock("t1", "r1", async () => 42)).resolves.toBe(42);
-  });
-});
-
-interface Row {
-  readonly id: string;
-  readonly tenantId: string;
-  readonly value: number;
-}
-
-describe("InMemoryTenantStore", () => {
-  let store: InMemoryTenantStore<Row>;
-  beforeEach(() => {
-    store = new InMemoryTenantStore<Row>();
-  });
-
-  it("round-trips a written record", async () => {
-    const row: Row = { id: "1", tenantId: "t1", value: 7 };
-    await store.write("t1", "1", row);
-    expect(await store.read("t1", "1")).toEqual(row);
-  });
-
-  it("returns null for a missing record", async () => {
-    expect(await store.read("t1", "missing")).toBeNull();
-  });
-
-  it("isolates records across tenants (read)", async () => {
-    await store.write("tenantA", "1", { id: "1", tenantId: "tenantA", value: 1 });
-    expect(await store.read("tenantB", "1")).toBeNull();
-  });
-
-  it("isolates records across tenants (list)", async () => {
-    await store.write("tenantA", "1", { id: "1", tenantId: "tenantA", value: 1 });
-    await store.write("tenantA", "2", { id: "2", tenantId: "tenantA", value: 2 });
-    await store.write("tenantB", "3", { id: "3", tenantId: "tenantB", value: 3 });
-    const a = await store.listByTenant("tenantA");
-    expect(a.map((r) => r.id).sort()).toEqual(["1", "2"]);
-    expect(await store.listByTenant("tenantB")).toHaveLength(1);
-  });
-
-  it("delete() removes only the targeted record, tenant-checked", async () => {
-    await store.write("tenantA", "1", { id: "1", tenantId: "tenantA", value: 1 });
-    await store.write("tenantA", "2", { id: "2", tenantId: "tenantA", value: 2 });
-    expect(await store.delete("tenantB", "1")).toBe(false); // wrong tenant
-    expect(await store.read("tenantA", "1")).not.toBeNull();
-    expect(await store.delete("tenantA", "1")).toBe(true);
-    expect(await store.read("tenantA", "1")).toBeNull();
-    expect(await store.delete("tenantA", "1")).toBe(false); // already gone
-    expect(await store.listByTenant("tenantA")).toHaveLength(1);
-  });
-
-  it("size() counts records across tenants", async () => {
-    expect(store.size()).toBe(0);
-    await store.write("tenantA", "1", { id: "1", tenantId: "tenantA", value: 1 });
-    await store.write("tenantB", "1", { id: "1", tenantId: "tenantB", value: 1 });
-    expect(store.size()).toBe(2);
-  });
-
-  it("clear() empties all tenants", async () => {
-    await store.write("t1", "1", { id: "1", tenantId: "t1", value: 1 });
-    store.clear();
-    expect(await store.read("t1", "1")).toBeNull();
-    expect(await store.listByTenant("t1")).toHaveLength(0);
-  });
-});

package/src/index.ts

@@ -1,14 +0,0 @@
-/**
- * @nebutra/tenant-store — neutral lowest-layer multi-tenant primitives.
- *
- * Depended on by `@nebutra/atelier-canvas` and `@nebutra/reel` (and new
- * tenant-scoped features); depends on neither. This is the explicit lower
- * contract those siblings share instead of one importing the other.
- */
-
-export { _resetTenantLocks, withTenantLock } from "./lock";
-export {
-  InMemoryTenantStore,
-  type TenantOwned,
-  type TenantScopedStore,
-} from "./store";

package/src/lock.ts

@@ -1,61 +0,0 @@
-/**
- * Per-(tenant, resource) serialization.
- *
- * A process-global lock keyed only by resource id would be correct for a
- * single-user desktop app but wrong for a multi-tenant server (one tenant's
- * lock could be observed by another, and ids may collide). Here the key is
- * `tenantId:resourceId`, so isolation holds.
- *
- * Scope is in-process: it serializes concurrent mutations of one resource
- * within a single server instance. Cross-instance correctness comes from a
- * persist-then-broadcast ordering at the call site (last write wins on the
- * row), not from this lock. Swapping to a distributed lock (Redis/etcd) is a
- * documented future change that does NOT alter any call site — replace the
- * body of `withTenantLock` here only.
- */
-
-/** Tail of the promise chain per (tenant, resource). */
-const _tails = new Map<string, Promise<unknown>>();
-
-function key(tenantId: string, resourceId: string): string {
-  return `${tenantId}:${resourceId}`;
-}
-
-/**
- * Run `fn` with exclusive access to a single (tenant, resource). Calls for the
- * same resource run strictly in submission order; different resources (or the
- * same resource under different tenants) run freely in parallel.
- */
-export async function withTenantLock<T>(
-  tenantId: string,
-  resourceId: string,
-  fn: () => Promise<T>,
-): Promise<T> {
-  const k = key(tenantId, resourceId);
-  const prev = _tails.get(k) ?? Promise.resolve();
-
-  // Chain onto the previous holder; `.then(fn, fn)` runs `fn` whether the
-  // prior critical section resolved or rejected, so one failure doesn't
-  // deadlock the next waiter.
-  const run = prev.then(fn, fn);
-
-  // The new tail is `run` with its outcome neutralized, so the next waiter
-  // never sees this section's value or error.
-  const tail = run.then(
-    () => undefined,
-    () => undefined,
-  );
-  _tails.set(k, tail);
-
-  try {
-    return await run;
-  } finally {
-    // Bound the map: if no later caller replaced the tail, drop the entry.
-    if (_tails.get(k) === tail) _tails.delete(k);
-  }
-}
-
-/** Test helper — clears all lock chains. */
-export function _resetTenantLocks(): void {
-  _tails.clear();
-}

package/src/store.ts

@@ -1,87 +0,0 @@
-/**
- * Tenant-scoped persistence primitives.
- *
- * Two artifacts that were independently re-implemented per feature
- * (atelier-canvas scenes, reel graphs, knowledge-rag chunks) and are now
- * shared:
- *
- *  - `TenantScopedStore<T>` — the minimal honest read contract every
- *    tenant-scoped store exposes. It deliberately does NOT prescribe
- *    `create` / `save`, because domain write signatures legitimately differ
- *    (a scene vs. nodes+edges vs. a chunk batch). Over-unifying those would be
- *    a leaky abstraction; the shared part is *reads* + isolation.
- *
- *  - `InMemoryTenantStore<T>` — the storage MECHANICS (a Map keyed by
- *    `tenantId:id`, never returning rows across tenants, tenant-filtered
- *    listing). Concrete in-memory stores compose this and add their own
- *    typed `create` / `save` on top, instead of copying the Map+key+filter
- *    boilerplate.
- *
- * The same tenant-isolation property a Prisma adapter gets from RLS is
- * enforced here structurally by the composite key.
- */
-
-/** Records carry their owning tenant so listing can be verified, not trusted. */
-export interface TenantOwned {
-  readonly tenantId: string;
-}
-
-/** Minimal read contract shared by every tenant-scoped store. */
-export interface TenantScopedStore<TRecord extends TenantOwned> {
-  read(tenantId: string, id: string): Promise<TRecord | null>;
-  listByTenant(tenantId: string): Promise<readonly TRecord[]>;
-}
-
-function key(tenantId: string, id: string): string {
-  return `${tenantId}:${id}`;
-}
-
-/**
- * Reusable in-memory storage core. Default for tests and flag-gated demos;
- * production features wrap a Prisma/RLS adapter behind the same read contract.
- */
-export class InMemoryTenantStore<TRecord extends TenantOwned>
-  implements TenantScopedStore<TRecord>
-{
-  private readonly rows = new Map<string, TRecord>();
-
-  async read(tenantId: string, id: string): Promise<TRecord | null> {
-    const row = this.rows.get(key(tenantId, id));
-    // Defense in depth: the composite key already isolates, but verify the
-    // stored record's own tenantId too so a mis-keyed write can't leak.
-    return row && row.tenantId === tenantId ? row : null;
-  }
-
-  async write(tenantId: string, id: string, record: TRecord): Promise<TRecord> {
-    if (record.tenantId !== tenantId) {
-      throw new Error(
-        `tenant-store: record.tenantId "${record.tenantId}" does not match write tenant "${tenantId}". ` +
-          `Fix: pass a record whose tenantId equals the tenant you are writing for.`,
-      );
-    }
-    this.rows.set(key(tenantId, id), record);
-    return record;
-  }
-
-  async listByTenant(tenantId: string): Promise<readonly TRecord[]> {
-    return [...this.rows.values()].filter((r) => r.tenantId === tenantId);
-  }
-
-  /** Delete one record. Returns true if it existed (and belonged to tenant). */
-  async delete(tenantId: string, id: string): Promise<boolean> {
-    const k = key(tenantId, id);
-    const row = this.rows.get(k);
-    if (!row || row.tenantId !== tenantId) return false;
-    return this.rows.delete(k);
-  }
-
-  /** Total record count across all tenants (diagnostics/health only). */
-  size(): number {
-    return this.rows.size;
-  }
-
-  /** Test helper. */
-  clear(): void {
-    this.rows.clear();
-  }
-}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src",
-    "incremental": false
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["node_modules", "dist"]
-}

package/tsup.config.ts

@@ -1,10 +0,0 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig({
-  entry: ["src/index.ts"],
-  format: ["esm"],
-  dts: true,
-  clean: true,
-  sourcemap: true,
-  target: "es2022",
-});