@molecule/app-query-memory 1.0.0

package/LICENSE

@@ -0,0 +1,115 @@
+                                 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.
+
+      "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.
+
+      "Contribution" shall mean any work of authorship, including the
+      original version of the Work and any modifications or additions
+      to that Work, that is intentionally submitted to the 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.
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the 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
+      patent license to make, have made, use, offer to sell, sell, import,
+      and otherwise transfer the Work.
+
+   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.
+
+   5. Submission of Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
+
+   8. Limitation of Liability. In no event and under no legal theory shall
+      any Contributor be liable to You for damages.
+
+   9. Accepting Warranty or Additional Liability.
+
+   Copyright 2026 Molecule Dev, Inc.
+
+   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/README.md

@@ -0,0 +1,134 @@
+<!--
+AUTO-GENERATED — DO NOT EDIT THIS FILE.
+Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
+Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
+To change this document, edit the module-level JSDoc in src/index.ts.
+Generated: 2026-09-28T07:09:01.977Z
+-->
+
+# @molecule/app-query-memory
+
+> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
+> It is written to be read by coding agents as much as by people, and is generated from this
+> package's source — edit `src/index.ts` JSDoc, not this file.
+
+In-memory bond for `@molecule/app-query`.
+
+A Map of documents with freshness, shared in-flight fetches, observers and
+garbage collection, and nothing else: no dependency, a few kilobytes. The
+right bond when the app has no other reason to ship a query library; the
+`@molecule/app-query-tanstack` bond is the same contract over TanStack Query
+for apps that already use it or want its devtools.
+
+## Quick Start
+
+```typescript
+import { getQueryClient, setProvider } from '@molecule/app-query'
+import { provider } from '@molecule/app-query-memory'
+
+setProvider(provider)
+const client = getQueryClient()
+await client.fetch({ key: ['profile'], fetch: (signal) => api.get('/me', { signal }) })
+```
+
+## Type
+
+`provider`
+
+## Installation
+
+```bash
+npm install @molecule/app-query-memory @molecule/app-query
+```
+
+## API
+
+### Interfaces
+
+#### `MemoryQueryConfig`
+
+Provider-specific configuration options. The in-memory bond needs none
+beyond the core's `QueryClientConfig`; the type exists so `createProvider`
+has the same shape as every other bond's.
+
+```typescript
+interface MemoryQueryConfig {
+  /** Reserved. */
+  readonly _?: never
+}
+```
+
+### Functions
+
+#### `createProvider(_config)`
+
+Creates an in-memory query provider.
+
+```typescript
+function createProvider(_config?: MemoryQueryConfig): QueryProvider
+```
+
+- `_config` — Provider configuration (none today).
+
+**Returns:** A query provider.
+
+### Constants
+
+#### `provider`
+
+Default in-memory provider instance.
+
+```typescript
+const provider: QueryProvider
+```
+
+## Core Interface
+
+Implements `@molecule/app-query` interface.
+
+## Bond Wiring
+
+Setup function to register this provider with the core interface:
+
+```typescript
+import { setProvider } from '@molecule/app-query'
+import { provider } from '@molecule/app-query-memory'
+
+export function setupQueryMemory(): void {
+  setProvider(provider)
+}
+```
+
+## Injection Notes
+
+### Requirements
+
+Peer dependencies:
+
+- `@molecule/app-query` ^1.0.0
+
+### Runtime Dependencies
+
+- `@molecule/app-query`
+
+- Documents are dropped `gcMs` after their last observer leaves (default 30
+  minutes) — a cache, not a store: nothing survives a reload.
+- `subscribe()` refetches a stale document while still emitting the stale
+  data first, so a component paints at once and updates when the fresh copy
+  lands.
+- Swapping to `@molecule/app-query-tanstack` changes no application code:
+  both pass the same behavioural suite.
+
+## E2E Tests
+
+Integration checklist — drive the real UI (live preview, no mocks), adapt
+each item to this app's actual screens/flows, and check every box off one
+by one. A box you can't check is an integration bug to fix — not a skip:
+
+- [ ] Opening a detail page after hovering its link shows no loading
+      state (the document was warmed) and the page is the right one.
+- [ ] Opening the same page twice fetches it once (check the network panel).
+- [ ] Going back to a page painted earlier paints at once, from memory.
+- [ ] After the app invalidates a key (an edit, a refresh action), the
+      next view shows the new data.
+- [ ] With the browser's data-saver on, hovering links fetches nothing.

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * In-memory bond for `@molecule/app-query`.
+ *
+ * A Map of documents with freshness, shared in-flight fetches, observers and
+ * garbage collection, and nothing else: no dependency, a few kilobytes. The
+ * right bond when the app has no other reason to ship a query library; the
+ * `@molecule/app-query-tanstack` bond is the same contract over TanStack Query
+ * for apps that already use it or want its devtools.
+ *
+ * @example
+ * ```typescript
+ * import { getQueryClient, setProvider } from '@molecule/app-query'
+ * import { provider } from '@molecule/app-query-memory'
+ *
+ * setProvider(provider)
+ * const client = getQueryClient()
+ * await client.fetch({ key: ['profile'], fetch: (signal) => api.get('/me', { signal }) })
+ * ```
+ *
+ * @remarks
+ * - Documents are dropped `gcMs` after their last observer leaves (default 30
+ *   minutes) — a cache, not a store: nothing survives a reload.
+ * - `subscribe()` refetches a stale document while still emitting the stale
+ *   data first, so a component paints at once and updates when the fresh copy
+ *   lands.
+ * - Swapping to `@molecule/app-query-tanstack` changes no application code:
+ *   both pass the same behavioural suite.
+ *
+ * @module
+ */
+export * from './provider.js';
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA"}

package/dist/index.js

@@ -0,0 +1,32 @@
+/**
+ * In-memory bond for `@molecule/app-query`.
+ *
+ * A Map of documents with freshness, shared in-flight fetches, observers and
+ * garbage collection, and nothing else: no dependency, a few kilobytes. The
+ * right bond when the app has no other reason to ship a query library; the
+ * `@molecule/app-query-tanstack` bond is the same contract over TanStack Query
+ * for apps that already use it or want its devtools.
+ *
+ * @example
+ * ```typescript
+ * import { getQueryClient, setProvider } from '@molecule/app-query'
+ * import { provider } from '@molecule/app-query-memory'
+ *
+ * setProvider(provider)
+ * const client = getQueryClient()
+ * await client.fetch({ key: ['profile'], fetch: (signal) => api.get('/me', { signal }) })
+ * ```
+ *
+ * @remarks
+ * - Documents are dropped `gcMs` after their last observer leaves (default 30
+ *   minutes) — a cache, not a store: nothing survives a reload.
+ * - `subscribe()` refetches a stale document while still emitting the stale
+ *   data first, so a component paints at once and updates when the fresh copy
+ *   lands.
+ * - Swapping to `@molecule/app-query-tanstack` changes no application code:
+ *   both pass the same behavioural suite.
+ *
+ * @module
+ */
+export * from './provider.js';
+export * from './types.js';

package/dist/provider.d.ts

@@ -0,0 +1,18 @@
+/**
+ * In-memory query client: a Map of documents with freshness, in-flight
+ * sharing, observers and garbage collection.
+ *
+ * @module
+ */
+import type { QueryProvider } from '@molecule/app-query';
+import type { MemoryQueryConfig } from './types.js';
+/**
+ * Creates an in-memory query provider.
+ *
+ * @param _config - Provider configuration (none today).
+ * @returns A query provider.
+ */
+export declare function createProvider(_config?: MemoryQueryConfig): QueryProvider;
+/** Default in-memory provider instance. */
+export declare const provider: QueryProvider;
+//# sourceMappingURL=provider.d.ts.map

package/dist/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAKV,aAAa,EAEd,MAAM,qBAAqB,CAAA;AAG5B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AA0QnD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,GAAE,iBAAsB,GAAG,aAAa,CAO7E;AAED,2CAA2C;AAC3C,eAAO,MAAM,QAAQ,EAAE,aAAgC,CAAA"}

package/dist/provider.js

@@ -0,0 +1,268 @@
+/**
+ * In-memory query client: a Map of documents with freshness, in-flight
+ * sharing, observers and garbage collection.
+ *
+ * @module
+ */
+import { hashQueryKey, keyStartsWith } from '@molecule/app-query';
+const DEFAULT_STALE_MS = 5 * 60 * 1000;
+const DEFAULT_GC_MS = 30 * 60 * 1000;
+/**
+ * One cache.
+ */
+class MemoryQueryClient {
+    entries = new Map();
+    staleMs;
+    gcMs;
+    /**
+     * Creates the cache.
+     *
+     * @param config - Defaults for every query.
+     */
+    constructor(config = {}) {
+        this.staleMs = config.staleMs ?? DEFAULT_STALE_MS;
+        this.gcMs = config.gcMs ?? DEFAULT_GC_MS;
+    }
+    /**
+     * The entry for a key, created idle when unknown.
+     *
+     * @param key - The document's key.
+     * @param gcMs - Its collection delay, when first seen.
+     * @returns The entry.
+     */
+    entry(key, gcMs) {
+        const hash = hashQueryKey(key);
+        let entry = this.entries.get(hash);
+        if (!entry) {
+            entry = {
+                key,
+                state: {
+                    data: undefined,
+                    status: 'idle',
+                    error: undefined,
+                    isFetching: false,
+                    updatedAt: undefined,
+                },
+                stale: true,
+                gcMs: gcMs ?? this.gcMs,
+                gcTimer: null,
+                inflight: null,
+                listeners: new Set(),
+            };
+            this.entries.set(hash, entry);
+        }
+        return entry;
+    }
+    /**
+     * Tells every observer of an entry its current state.
+     *
+     * @param entry - The entry.
+     */
+    emit(entry) {
+        for (const listener of entry.listeners)
+            listener(entry.state);
+    }
+    /**
+     * Whether an entry holds data younger than `staleMs` and not invalidated.
+     *
+     * @param entry - The entry.
+     * @param staleMs - The freshness window.
+     * @returns `true` when fresh.
+     */
+    isFresh(entry, staleMs) {
+        if (entry.stale || entry.state.updatedAt === undefined || entry.state.data === undefined)
+            return false;
+        return Date.now() - entry.state.updatedAt < staleMs;
+    }
+    /**
+     * Drops the entry after its collection delay unless something uses it by then.
+     *
+     * @param entry - The entry.
+     */
+    scheduleGc(entry) {
+        if (entry.gcTimer)
+            clearTimeout(entry.gcTimer);
+        entry.gcTimer = setTimeout(() => {
+            if (entry.listeners.size || entry.inflight)
+                return;
+            this.entries.delete(hashQueryKey(entry.key));
+        }, entry.gcMs);
+        entry.gcTimer.unref?.();
+    }
+    /**
+     * Starts (or joins) the entry's fetch.
+     *
+     * @param entry - The entry.
+     * @param options - Key, fetch, freshness.
+     * @returns The document.
+     */
+    start(entry, options) {
+        if (entry.inflight)
+            return entry.inflight.promise;
+        const controller = new AbortController();
+        entry.state = {
+            ...entry.state,
+            isFetching: true,
+            status: entry.state.data === undefined ? 'loading' : entry.state.status,
+        };
+        this.emit(entry);
+        const promise = options
+            .fetch(controller.signal)
+            .then((data) => {
+            entry.inflight = null;
+            entry.stale = false;
+            entry.state = {
+                data,
+                status: 'success',
+                error: undefined,
+                isFetching: false,
+                updatedAt: Date.now(),
+            };
+            this.emit(entry);
+            this.scheduleGc(entry);
+            return data;
+        })
+            .catch((error) => {
+            entry.inflight = null;
+            entry.state = { ...entry.state, status: 'error', error, isFetching: false };
+            this.emit(entry);
+            this.scheduleGc(entry);
+            throw error;
+        });
+        entry.inflight = { promise, controller };
+        return promise;
+    }
+    /**
+     * The cached document, synchronously, fresh or stale.
+     *
+     * @param key - The document's key.
+     * @returns The document, or `undefined`.
+     */
+    get(key) {
+        return this.entries.get(hashQueryKey(key))?.state.data;
+    }
+    /**
+     * The document's full state, synchronously.
+     *
+     * @param key - The document's key.
+     * @returns The state; `idle` for an unknown key.
+     */
+    getState(key) {
+        const entry = this.entries.get(hashQueryKey(key));
+        return entry
+            ? entry.state
+            : {
+                data: undefined,
+                status: 'idle',
+                error: undefined,
+                isFetching: false,
+                updatedAt: undefined,
+            };
+    }
+    /**
+     * The document: cached-and-fresh at once, a fetch in flight shared, otherwise fetched.
+     *
+     * @param options - Key, fetch, freshness.
+     * @returns The document.
+     */
+    fetch(options) {
+        const entry = this.entry(options.key, options.gcMs);
+        if (this.isFresh(entry, options.staleMs ?? this.staleMs))
+            return Promise.resolve(entry.state.data);
+        return this.start(entry, options);
+    }
+    /**
+     * Warms the cache; never throws; skips a fresh or in-flight document.
+     *
+     * @param options - Key, fetch, freshness.
+     */
+    prefetch(options) {
+        const entry = this.entry(options.key, options.gcMs);
+        if (entry.inflight || this.isFresh(entry, options.staleMs ?? this.staleMs))
+            return;
+        this.start(entry, options).catch(() => {
+            // Speculative: the real navigation reports a document that will not load.
+        });
+    }
+    /**
+     * Seeds the cache.
+     *
+     * @param key - The document's key.
+     * @param data - The document.
+     */
+    set(key, data) {
+        const entry = this.entry(key);
+        entry.stale = false;
+        entry.state = {
+            data,
+            status: 'success',
+            error: undefined,
+            isFetching: entry.state.isFetching,
+            updatedAt: Date.now(),
+        };
+        this.emit(entry);
+        this.scheduleGc(entry);
+    }
+    /**
+     * Marks the key and everything it prefixes as stale.
+     *
+     * @param key - A key or a key prefix.
+     */
+    invalidate(key) {
+        for (const entry of this.entries.values()) {
+            if (keyStartsWith(entry.key, key))
+                entry.stale = true;
+        }
+    }
+    /**
+     * Observes a document, fetching it when absent or stale.
+     *
+     * @param options - Key, fetch, freshness.
+     * @param listener - Called with each state.
+     * @returns Stops observing.
+     */
+    subscribe(options, listener) {
+        const entry = this.entry(options.key, options.gcMs);
+        entry.listeners.add(listener);
+        if (entry.gcTimer) {
+            clearTimeout(entry.gcTimer);
+            entry.gcTimer = null;
+        }
+        listener(entry.state);
+        if (!entry.inflight && !this.isFresh(entry, options.staleMs ?? this.staleMs)) {
+            this.start(entry, options).catch(() => {
+                // The state carries the error; observers read it from there.
+            });
+        }
+        return () => {
+            entry.listeners.delete(listener);
+            if (!entry.listeners.size)
+                this.scheduleGc(entry);
+        };
+    }
+    /** Drops every document and every in-flight fetch. */
+    clear() {
+        for (const entry of this.entries.values()) {
+            entry.inflight?.controller.abort();
+            if (entry.gcTimer)
+                clearTimeout(entry.gcTimer);
+        }
+        this.entries.clear();
+    }
+}
+/**
+ * Creates an in-memory query provider.
+ *
+ * @param _config - Provider configuration (none today).
+ * @returns A query provider.
+ */
+export function createProvider(_config = {}) {
+    return {
+        name: 'memory',
+        createClient(config) {
+            return new MemoryQueryClient(config);
+        },
+    };
+}
+/** Default in-memory provider instance. */
+export const provider = createProvider();

package/dist/types.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Configuration for the in-memory provider.
+ *
+ * @module
+ */
+/**
+ * Provider-specific configuration options. The in-memory bond needs none
+ * beyond the core's `QueryClientConfig`; the type exists so `createProvider`
+ * has the same shape as every other bond's.
+ */
+export interface MemoryQueryConfig {
+    /** Reserved. */
+    readonly _?: never;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,gBAAgB;IAChB,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,CAAA;CACnB"}

package/dist/types.js

@@ -0,0 +1,6 @@
+/**
+ * Configuration for the in-memory provider.
+ *
+ * @module
+ */
+export {};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@molecule/app-query-memory",
+  "version": "1.0.0",
+  "description": "Dependency-free in-memory bond for @molecule/app-query — a Map of documents with freshness, in-flight sharing and observers",
+  "homepage": "https://www.molecule.dev/packages/app-query-memory",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "molecule",
+    "query",
+    "cache",
+    "memory"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/molecule-dev/molecule.git",
+    "directory": "packages/app/bonds/query/memory"
+  },
+  "peerDependencies": {
+    "@molecule/app-query": "^1.0.0"
+  },
+  "devDependencies": {
+    "@molecule/app-query": "1.0.0",
+    "@types/node": "26.1.2",
+    "typescript": "6.0.3",
+    "vitest": "4.1.11"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}