@wells-nelson/data-storage 0.0.0-stage → 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,42 @@
+import type { RxJsonSchema } from 'rxdb/plugins/core';
+/**
+ * Every synced document is flat (strings, numbers, booleans) because the RxDB Supabase
+ * replication maps each field 1:1 onto a Postgres column. `updated_at` (client clock, ms) drives
+ * last-write-wins conflict resolution.
+ */
+export interface DocBase {
+    id: string;
+    updated_at: number;
+}
+/** Collection name → document type, e.g. `{ projects: ProjectDoc; tasks: TaskDoc }`. */
+export type DocMap = {
+    [name: string]: DocBase;
+};
+export type CollectionName<D extends DocMap> = keyof D & string;
+/** Where a container lives: only on this device, or replicated to Supabase. */
+export type Location = 'local' | 'cloud';
+export type Role = 'viewer' | 'editor' | 'owner';
+/** Lowercase nouns for the container, e.g. `{ singular: 'project', plural: 'projects' }`. */
+export interface Nouns {
+    singular: string;
+    plural: string;
+}
+/**
+ * The shape of an app's data. A **container** (a project, a list…) owns every other row through
+ * `containerField` and is the unit that gets shared, synced and moved between data sets.
+ */
+export interface StoreSchema<D extends DocMap, C extends CollectionName<D> = CollectionName<D>> {
+    /** Every collection, parents before children (the container first). */
+    collections: readonly CollectionName<D>[];
+    schemas: {
+        [N in CollectionName<D>]: RxJsonSchema<D[N]>;
+    };
+    /** The container collection, e.g. 'projects'. */
+    container: C;
+    /** The field on every other collection pointing at its container, e.g. 'project_id'. */
+    containerField: string;
+    /** Index `containerField` in TanStack DB (worth it when a collection holds thousands of rows). */
+    indexContainerField?: boolean;
+}
+/** The container a document belongs to (containers are their own container). */
+export declare function containerIdOf<D extends DocMap>(schema: Pick<StoreSchema<D>, 'container' | 'containerField'>, collection: CollectionName<D>, doc: object): string;

package/dist/types.js

@@ -0,0 +1,5 @@
+/** The container a document belongs to (containers are their own container). */
+export function containerIdOf(schema, collection, doc) {
+    const row = doc;
+    return (collection === schema.container ? row.id : row[schema.containerField]);
+}

package/package.json

@@ -1,6 +1,58 @@
 {
   "name": "@wells-nelson/data-storage",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "description": "Offline-first storage for Wells Nelson apps: RxDB + TanStack DB data sets, Supabase sync of shared containers, tombstones, device prefs and a SQL migration generator.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bnelson729/wells-nelson-components.git",
+    "directory": "src/npm/data-storage"
+  },
+  "homepage": "https://github.com/bnelson729/wells-nelson-components/tree/main/src/npm/data-storage#readme",
+  "bugs": {
+    "url": "https://github.com/bnelson729/wells-nelson-components/issues"
+  },
+  "type": "module",
+  "svelte": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "svelte": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./sql": {
+      "types": "./dist/sql.d.ts",
+      "default": "./dist/sql.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "svelte-package -i src/lib -o dist",
+    "check": "svelte-check --tsconfig ./tsconfig.json",
+    "test": "vitest run",
+    "lint:package": "publint"
+  },
+  "peerDependencies": {
+    "@supabase/supabase-js": "^2.100.0",
+    "@tanstack/db": "^1.0.0-rc.1.4",
+    "@tanstack/rxdb-db-collection": "^1.0.0-rc.1.4",
+    "rxdb": "^17.6.0",
+    "rxjs": "^7.8.2",
+    "svelte": "^5.40.0"
+  },
+  "devDependencies": {
+    "@supabase/supabase-js": "^2.119.0",
+    "@tanstack/db": "^1.0.0-rc.1.4",
+    "@tanstack/rxdb-db-collection": "^1.0.0-rc.1.4",
+    "rxdb": "^17.6.0",
+    "rxjs": "^7.8.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}