@slimr/dbsync 0.0.3 → 0.0.5

package/README.md

@@ -27,9 +27,9 @@ You instantiate `dbsync` by supplying your backend [adapter](./src/adapters/Adap
 
 ```typescript
 import { DbSync } from '@slimr/dbsync';
-import { RestAdapter } from '@slimr/dbsync/adapters';
+import { LocalAdapter, RestAdapter } from '@slimr/dbsync/adapters';
 
-const dbAdapter = new RestAdapter({ url: 'https://api.myapp.com' });
+const dbAdapter = process.env.TEST ? new LocalAdapter() : new RestAdapter({ url: 'https://api.myapp.com' });
 
 const db = new DbSync({
     adapter: dbAdapter,
@@ -43,6 +43,8 @@ const db = new DbSync({
 await db.init();
 ```
 
+> **Local-Only No-Sync Database:** If you want all the IndexedDB ORM and reactive features, but completely lack a remote database to sync to, simply import `LocalAdapter` from `@slimr/dbsync/adapters` and pass that into the constructor instead. It acts as an empty black box so your operations succeed cleanly entirely on the client.
+
 ## Schema Versioning
 
 `@slimr/dbsync` automatically manages your IndexedDB database versioning to prevent schema mismatches and corruption across tabs and devices.

package/cjs/adapters/LocalAdapter.d.ts

@@ -0,0 +1,18 @@
+import type { BackendAdapter, SyncPullResult } from "./types.js";
+/**
+ * A no-op network adapter for pure local-only usage.
+ * Satisfies the DbSync adapter requirement and silently discards sync operations
+ * so your local `dirtyQueue` doesn't grow infinitely if synchronization is enabled.
+ */
+export declare class LocalAdapter implements BackendAdapter {
+    /** Always returns true so session checks pass locally. */
+    checkAuth(): Promise<boolean>;
+    /** Always resolves true to mimic successful mock logins. */
+    login(): Promise<boolean>;
+    /** Does nothing natively. */
+    logout(): Promise<void>;
+    /** Returns an empty payload because there is no remote source of truth. */
+    pull(): Promise<SyncPullResult>;
+    /** Silently drops write payloads into the void. */
+    push(): Promise<void>;
+}

package/cjs/adapters/LocalAdapter.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalAdapter = void 0;
+/**
+ * A no-op network adapter for pure local-only usage.
+ * Satisfies the DbSync adapter requirement and silently discards sync operations
+ * so your local `dirtyQueue` doesn't grow infinitely if synchronization is enabled.
+ */
+class LocalAdapter {
+    /** Always returns true so session checks pass locally. */
+    async checkAuth() {
+        return true;
+    }
+    /** Always resolves true to mimic successful mock logins. */
+    async login() {
+        return true;
+    }
+    /** Does nothing natively. */
+    async logout() { }
+    /** Returns an empty payload because there is no remote source of truth. */
+    async pull() {
+        return { items: [], hasMore: false };
+    }
+    /** Silently drops write payloads into the void. */
+    async push() { }
+}
+exports.LocalAdapter = LocalAdapter;
+//# sourceMappingURL=LocalAdapter.js.map

package/cjs/adapters/LocalAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalAdapter.js","sourceRoot":"","sources":["../../src/adapters/LocalAdapter.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACH,MAAa,YAAY;IACxB,0DAA0D;IAC1D,KAAK,CAAC,SAAS;QACd,OAAO,IAAI,CAAA;IACZ,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,KAAK;QACV,OAAO,IAAI,CAAA;IACZ,CAAC;IAED,6BAA6B;IAC7B,KAAK,CAAC,MAAM,KAAmB,CAAC;IAEhC,2EAA2E;IAC3E,KAAK,CAAC,IAAI;QACT,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IACrC,CAAC;IAED,mDAAmD;IACnD,KAAK,CAAC,IAAI,KAAmB,CAAC;CAC9B;AArBD,oCAqBC"}

package/cjs/adapters/index.d.ts

@@ -1,2 +1,3 @@
+export * from "./LocalAdapter.js";
 export * from "./RestAdapter.js";
 export * from "./types.js";

package/cjs/adapters/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./LocalAdapter.js"), exports);
 __exportStar(require("./RestAdapter.js"), exports);
 __exportStar(require("./types.js"), exports);
 //# sourceMappingURL=index.js.map

package/cjs/adapters/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/adapters/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAgC;AAChC,6CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/adapters/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAiC;AACjC,mDAAgC;AAChC,6CAA0B"}

package/esm/adapters/LocalAdapter.d.ts

@@ -0,0 +1,18 @@
+import type { BackendAdapter, SyncPullResult } from "./types.js";
+/**
+ * A no-op network adapter for pure local-only usage.
+ * Satisfies the DbSync adapter requirement and silently discards sync operations
+ * so your local `dirtyQueue` doesn't grow infinitely if synchronization is enabled.
+ */
+export declare class LocalAdapter implements BackendAdapter {
+    /** Always returns true so session checks pass locally. */
+    checkAuth(): Promise<boolean>;
+    /** Always resolves true to mimic successful mock logins. */
+    login(): Promise<boolean>;
+    /** Does nothing natively. */
+    logout(): Promise<void>;
+    /** Returns an empty payload because there is no remote source of truth. */
+    pull(): Promise<SyncPullResult>;
+    /** Silently drops write payloads into the void. */
+    push(): Promise<void>;
+}

package/esm/adapters/LocalAdapter.js

@@ -0,0 +1,24 @@
+/**
+ * A no-op network adapter for pure local-only usage.
+ * Satisfies the DbSync adapter requirement and silently discards sync operations
+ * so your local `dirtyQueue` doesn't grow infinitely if synchronization is enabled.
+ */
+export class LocalAdapter {
+    /** Always returns true so session checks pass locally. */
+    async checkAuth() {
+        return true;
+    }
+    /** Always resolves true to mimic successful mock logins. */
+    async login() {
+        return true;
+    }
+    /** Does nothing natively. */
+    async logout() { }
+    /** Returns an empty payload because there is no remote source of truth. */
+    async pull() {
+        return { items: [], hasMore: false };
+    }
+    /** Silently drops write payloads into the void. */
+    async push() { }
+}
+//# sourceMappingURL=LocalAdapter.js.map

package/esm/adapters/LocalAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalAdapter.js","sourceRoot":"","sources":["../../src/adapters/LocalAdapter.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,OAAO,YAAY;IACxB,0DAA0D;IAC1D,KAAK,CAAC,SAAS;QACd,OAAO,IAAI,CAAA;IACZ,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,KAAK;QACV,OAAO,IAAI,CAAA;IACZ,CAAC;IAED,6BAA6B;IAC7B,KAAK,CAAC,MAAM,KAAmB,CAAC;IAEhC,2EAA2E;IAC3E,KAAK,CAAC,IAAI;QACT,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IACrC,CAAC;IAED,mDAAmD;IACnD,KAAK,CAAC,IAAI,KAAmB,CAAC;CAC9B"}

package/esm/adapters/index.d.ts

@@ -1,2 +1,3 @@
+export * from "./LocalAdapter.js";
 export * from "./RestAdapter.js";
 export * from "./types.js";

package/esm/adapters/index.js

@@ -1,3 +1,4 @@
+export * from "./LocalAdapter.js";
 export * from "./RestAdapter.js";
 export * from "./types.js";
 //# sourceMappingURL=index.js.map

package/esm/adapters/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/adapters/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/adapters/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slimr/dbsync",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "author": "Brian Dombrowski",
   "license": "ISC",
   "private": false,