aberdeen 1.17.0 → 2.0.0

package/dist/src/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Default browser entry point for Aberdeen.
+ *
+ * It exports a ready-to-use Aberdeen instance (`A`) bound to the global `window`, so you can
+ * `import A from 'aberdeen'` and start building UI with zero setup. Advanced users (and the
+ * `aberdeen/server` SSR entry) can instead import {@link createA} to create instances bound to a
+ * specific window, including multiple isolated instances.
+ */
+export { createA } from "./aberdeen.js";
+export type { Aberdeen, WindowLike, InitOptions, ValueRef, PromiseProxy } from "./aberdeen.js";
+declare const _default: import("./aberdeen.js").Aberdeen;
+export default _default;

package/dist/src/index.js

@@ -0,0 +1,11 @@
+// src/index.ts
+import { createA } from "./aberdeen.js";
+import { createA as createA2 } from "./aberdeen.js";
+var src_default = createA2(typeof window !== "undefined" ? window : undefined);
+export {
+  src_default as default,
+  createA
+};
+
+//# debugId=5E2A1B4525639B1164756E2164756E21
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../../src/index.ts"],
+  "sourcesContent": [
+    "/**\n * Default browser entry point for Aberdeen.\n *\n * It exports a ready-to-use Aberdeen instance (`A`) bound to the global `window`, so you can\n * `import A from 'aberdeen'` and start building UI with zero setup. Advanced users (and the\n * `aberdeen/server` SSR entry) can instead import {@link createA} to create instances bound to a\n * specific window, including multiple isolated instances.\n */\nexport { createA } from \"./aberdeen.js\";\nexport type { Aberdeen, WindowLike, InitOptions, ValueRef, PromiseProxy } from \"./aberdeen.js\";\nimport { createA } from \"./aberdeen.js\";\n\nexport default createA(typeof window !== \"undefined\" ? (window as any) : undefined);\n"
+  ],
+  "mappings": ";AAQA;AAEA,oBAAS;AAET,IAAe,uBAAQ,OAAO,WAAW,cAAe,SAAiB,SAAS;",
+  "debugId": "5E2A1B4525639B1164756E2164756E21",
+  "names": []
+}

package/dist/src/prediction.d.ts

@@ -1,20 +1,21 @@
-import type { TargetType } from "./aberdeen.js";
+type Aberdeen = any;
 /**
  * Represents a set of changes that can be applied to proxied objects.
  * This is an opaque type - its internal structure is not part of the public API.
  * @private
  */
-export type Patch = Map<TargetType, Map<any, [any, any]>>;
+export type Patch = Map<any, Map<any, [any, any]>>;
 /**
  * Run the provided function, while treating all changes to Observables as predictions,
  * meaning they will be reverted when changes come back from the server (or some other
  * async source).
+ * @param A The Aberdeen instance (the default export of `aberdeen`, or one from `init`).
  * @param predictFunc The function to run. It will generally modify some Observables
  * 	to immediately reflect state (as closely as possible) that we expect the server
  *  to communicate back to us later on.
  * @returns A `Patch` object. Don't modify it. This is only meant to be passed to `applyCanon`.
  */
-export declare function applyPrediction(predictFunc: () => void): Patch;
+export declare function applyPrediction(A: Aberdeen, predictFunc: () => void): Patch;
 /**
  * Temporarily revert all outstanding predictions, optionally run the provided function
  * (which will generally make authoritative changes to the data based on a server response),
@@ -24,10 +25,12 @@ export declare function applyPrediction(predictFunc: () => void): Patch;
  *
  * All of this is done such that redraws are only triggered if the overall effect is an
  * actual change to an `Observable`.
+ * @param A The Aberdeen instance (the default export of `aberdeen`, or one from `init`).
  * @param canonFunc The function to run without any predictions applied. This will typically
  *  make authoritative changes to the data, based on a server response.
  * @param dropPredictions An optional list of predictions (as returned by `applyPrediction`)
  *  to undo. Typically, when a server response for a certain request is being handled,
  *  you'd want to drop the prediction that was done for that request.
  */
-export declare function applyCanon(canonFunc?: () => void, dropPredictions?: Array<Patch>): void;
+export declare function applyCanon(A: Aberdeen, canonFunc?: () => void, dropPredictions?: Array<Patch>): void;
+export {};

package/dist/src/prediction.js

@@ -1,13 +1,7 @@
 // src/prediction.ts
-import {
-  defaultEmitHandler,
-  withEmitHandler,
-  EMPTY,
-  MAP_SIZE_SYMBOL
-} from "./aberdeen.js";
-function recordPatch(func) {
+function recordPatch(A, func) {
   const recordingPatch = new Map;
-  withEmitHandler((target, index, newData, oldData) => {
+  A.withEmitHandler((target, index, newData, oldData) => {
     addToPatch(recordingPatch, target, index, newData, oldData);
   }, func);
   return recordingPatch;
@@ -25,10 +19,10 @@ function addToPatch(patch, collection, index, newData, oldData) {
   else
     collectionMap.set(index, [newData, oldData0]);
 }
-function emitPatch(patch) {
+function emitPatch(A, patch) {
   for (const [collection, collectionMap] of patch) {
     for (const [index, [newData, oldData]] of collectionMap) {
-      defaultEmitHandler(collection, index, newData, oldData);
+      A.defaultEmitHandler(collection, index, newData, oldData);
     }
   }
 }
@@ -39,15 +33,16 @@ function mergePatch(target, source, reverse = false) {
     }
   }
 }
-function silentlyApplyPatch(patch, force = false) {
+function silentlyApplyPatch(A, patch, force = false) {
+  const EMPTY = A.EMPTY;
   for (const [collection, collectionMap] of patch) {
     for (const [index, [newData, oldData]] of collectionMap) {
-      if (index === MAP_SIZE_SYMBOL)
+      if (index === A.MAP_SIZE_SYMBOL)
         continue;
       const actualData = collection instanceof Map ? collection.has(index) ? collection.get(index) : EMPTY : (index in collection) ? collection[index] : EMPTY;
       if (actualData !== oldData) {
         if (force)
-          setTimeout(() => {
+          (A.window?.setTimeout ?? setTimeout)(() => {
             throw new Error(`Applying invalid patch: data ${String(actualData)} is unequal to expected old data ${String(oldData)} for index ${String(index)}`);
           }, 0);
         else
@@ -57,7 +52,7 @@ function silentlyApplyPatch(patch, force = false) {
   }
   for (const [collection, collectionMap] of patch) {
     for (const [index, [newData, oldData]] of collectionMap) {
-      if (index === MAP_SIZE_SYMBOL)
+      if (index === A.MAP_SIZE_SYMBOL)
         continue;
       if (collection instanceof Map) {
         if (newData === EMPTY)
@@ -75,38 +70,38 @@ function silentlyApplyPatch(patch, force = false) {
   return true;
 }
 var appliedPredictions = [];
-function applyPrediction(predictFunc) {
-  const patch = recordPatch(predictFunc);
+function applyPrediction(A, predictFunc) {
+  const patch = recordPatch(A, predictFunc);
   appliedPredictions.push(patch);
-  emitPatch(patch);
+  emitPatch(A, patch);
   return patch;
 }
-function applyCanon(canonFunc, dropPredictions = []) {
+function applyCanon(A, canonFunc, dropPredictions = []) {
   const resultPatch = new Map;
   for (const prediction of appliedPredictions)
     mergePatch(resultPatch, prediction, true);
-  silentlyApplyPatch(resultPatch, true);
+  silentlyApplyPatch(A, resultPatch, true);
   for (const prediction of dropPredictions) {
     const pos = appliedPredictions.indexOf(prediction);
     if (pos >= 0)
       appliedPredictions.splice(pos, 1);
   }
   if (canonFunc)
-    mergePatch(resultPatch, recordPatch(canonFunc));
+    mergePatch(resultPatch, recordPatch(A, canonFunc));
   for (let idx = 0;idx < appliedPredictions.length; idx++) {
-    if (silentlyApplyPatch(appliedPredictions[idx])) {
+    if (silentlyApplyPatch(A, appliedPredictions[idx])) {
       mergePatch(resultPatch, appliedPredictions[idx]);
     } else {
       appliedPredictions.splice(idx, 1);
       idx--;
     }
   }
-  emitPatch(resultPatch);
+  emitPatch(A, resultPatch);
 }
 export {
   applyPrediction,
   applyCanon
 };
 
-//# debugId=0E6977F82274D4EC64756E2164756E21
+//# debugId=908A3B91728A6C4A64756E2164756E21
 //# sourceMappingURL=prediction.js.map

package/dist/src/prediction.js.map

@@ -2,9 +2,9 @@
   "version": 3,
   "sources": ["../../src/prediction.ts"],
   "sourcesContent": [
-    "import {\n\tdefaultEmitHandler,\n\twithEmitHandler,\n\tEMPTY,\n\tMAP_SIZE_SYMBOL,\n} from \"./aberdeen.js\";\nimport type { TargetType } from \"./aberdeen.js\";\n\n/**\n * Represents a set of changes that can be applied to proxied objects.\n * This is an opaque type - its internal structure is not part of the public API.\n * @private\n */\nexport type Patch = Map<TargetType, Map<any, [any, any]>>;\n\nfunction recordPatch(func: () => void): Patch {\n\tconst recordingPatch = new Map();\n\twithEmitHandler((target, index, newData, oldData) => {\n\t\taddToPatch(recordingPatch, target, index, newData, oldData);\n\t}, func);\n\treturn recordingPatch;\n}\n\nfunction addToPatch(\n\tpatch: Patch,\n\tcollection: TargetType,\n\tindex: any,\n\tnewData: any,\n\toldData: any,\n) {\n\tlet collectionMap = patch.get(collection);\n\tif (!collectionMap) {\n\t\tcollectionMap = new Map();\n\t\tpatch.set(collection, collectionMap);\n\t}\n\tconst prev = collectionMap.get(index);\n\tconst oldData0 = prev ? prev[1] : oldData;\n\tif (newData === oldData0) collectionMap.delete(index);\n\telse collectionMap.set(index, [newData, oldData0]);\n}\n\nfunction emitPatch(patch: Patch) {\n\tfor (const [collection, collectionMap] of patch) {\n\t\tfor (const [index, [newData, oldData]] of collectionMap) {\n\t\t\tdefaultEmitHandler(collection, index, newData, oldData);\n\t\t}\n\t}\n}\n\nfunction mergePatch(target: Patch, source: Patch, reverse = false) {\n\tfor (const [collection, collectionMap] of source) {\n\t\tfor (const [index, [newData, oldData]] of collectionMap) {\n\t\t\taddToPatch(\n\t\t\t\ttarget,\n\t\t\t\tcollection,\n\t\t\t\tindex,\n\t\t\t\treverse ? oldData : newData,\n\t\t\t\treverse ? newData : oldData,\n\t\t\t);\n\t\t}\n\t}\n}\n\nfunction silentlyApplyPatch(patch: Patch, force = false): boolean {\n\tfor (const [collection, collectionMap] of patch) {\n\t\tfor (const [index, [newData, oldData]] of collectionMap) {\n\t\t\t// MAP_SIZE_SYMBOL is synthetic - size is derived from add/delete operations\n\t\t\tif (index === MAP_SIZE_SYMBOL) continue;\n\t\t\tconst actualData =\n\t\t\t\tcollection instanceof Map\n\t\t\t\t\t? collection.has(index)\n\t\t\t\t\t\t? collection.get(index)\n\t\t\t\t\t\t: EMPTY\n\t\t\t\t\t: index in (collection as any)\n\t\t\t\t\t\t? (collection as any)[index]\n\t\t\t\t\t\t: EMPTY;\n\t\t\tif (actualData !== oldData) {\n\t\t\t\tif (force)\n\t\t\t\t\tsetTimeout(() => {\n\t\t\t\t\t\tthrow new Error(\n\t\t\t\t\t\t\t`Applying invalid patch: data ${String(actualData)} is unequal to expected old data ${String(oldData)} for index ${String(index)}`,\n\t\t\t\t\t\t);\n\t\t\t\t\t}, 0);\n\t\t\t\telse return false;\n\t\t\t}\n\t\t}\n\t}\n\tfor (const [collection, collectionMap] of patch) {\n\t\tfor (const [index, [newData, oldData]] of collectionMap) {\n\t\t\tif (index === MAP_SIZE_SYMBOL) continue;\n\t\t\tif (collection instanceof Map) {\n\t\t\t\tif (newData === EMPTY) collection.delete(index);\n\t\t\t\telse collection.set(index, newData);\n\t\t\t} else {\n\t\t\t\tif (newData === EMPTY) delete (collection as any)[index];\n\t\t\t\telse (collection as any)[index] = newData;\n\t\t\t}\n\t\t}\n\t}\n\treturn true;\n}\n\nconst appliedPredictions: Array<Patch> = [];\n\n/**\n * Run the provided function, while treating all changes to Observables as predictions,\n * meaning they will be reverted when changes come back from the server (or some other\n * async source).\n * @param predictFunc The function to run. It will generally modify some Observables\n * \tto immediately reflect state (as closely as possible) that we expect the server\n *  to communicate back to us later on.\n * @returns A `Patch` object. Don't modify it. This is only meant to be passed to `applyCanon`.\n */\nexport function applyPrediction(predictFunc: () => void): Patch {\n\tconst patch = recordPatch(predictFunc);\n\tappliedPredictions.push(patch);\n\temitPatch(patch);\n\treturn patch;\n}\n\n/**\n * Temporarily revert all outstanding predictions, optionally run the provided function\n * (which will generally make authoritative changes to the data based on a server response),\n * and then attempt to reapply the predictions on top of the new canonical state, dropping\n * any predictions that can no longer be applied cleanly (the data has been modified) or\n * that were specified in `dropPredictions`.\n *\n * All of this is done such that redraws are only triggered if the overall effect is an\n * actual change to an `Observable`.\n * @param canonFunc The function to run without any predictions applied. This will typically\n *  make authoritative changes to the data, based on a server response.\n * @param dropPredictions An optional list of predictions (as returned by `applyPrediction`)\n *  to undo. Typically, when a server response for a certain request is being handled,\n *  you'd want to drop the prediction that was done for that request.\n */\nexport function applyCanon(\n\tcanonFunc?: () => void,\n\tdropPredictions: Array<Patch> = [],\n) {\n\tconst resultPatch = new Map();\n\tfor (const prediction of appliedPredictions)\n\t\tmergePatch(resultPatch, prediction, true);\n\tsilentlyApplyPatch(resultPatch, true);\n\n\tfor (const prediction of dropPredictions) {\n\t\tconst pos = appliedPredictions.indexOf(prediction);\n\t\tif (pos >= 0) appliedPredictions.splice(pos, 1);\n\t}\n\tif (canonFunc) mergePatch(resultPatch, recordPatch(canonFunc));\n\n\tfor (let idx = 0; idx < appliedPredictions.length; idx++) {\n\t\tif (silentlyApplyPatch(appliedPredictions[idx])) {\n\t\t\tmergePatch(resultPatch, appliedPredictions[idx]);\n\t\t} else {\n\t\t\tappliedPredictions.splice(idx, 1);\n\t\t\tidx--;\n\t\t}\n\t}\n\n\temitPatch(resultPatch);\n}\n"
+    "// This module operates on a specific Aberdeen instance, which is passed as the first argument\n// (`A`) to its public functions. `A` provides the emit handlers and the EMPTY/MAP_SIZE_SYMBOL\n// markers it needs.\ntype Aberdeen = any;\n\n/**\n * Represents a set of changes that can be applied to proxied objects.\n * This is an opaque type - its internal structure is not part of the public API.\n * @private\n */\nexport type Patch = Map<any, Map<any, [any, any]>>;\n\nfunction recordPatch(A: Aberdeen, func: () => void): Patch {\n\tconst recordingPatch = new Map();\n\tA.withEmitHandler((target: any, index: any, newData: any, oldData: any) => {\n\t\taddToPatch(recordingPatch, target, index, newData, oldData);\n\t}, func);\n\treturn recordingPatch;\n}\n\nfunction addToPatch(\n\tpatch: Patch,\n\tcollection: any,\n\tindex: any,\n\tnewData: any,\n\toldData: any,\n) {\n\tlet collectionMap = patch.get(collection);\n\tif (!collectionMap) {\n\t\tcollectionMap = new Map();\n\t\tpatch.set(collection, collectionMap);\n\t}\n\tconst prev = collectionMap.get(index);\n\tconst oldData0 = prev ? prev[1] : oldData;\n\tif (newData === oldData0) collectionMap.delete(index);\n\telse collectionMap.set(index, [newData, oldData0]);\n}\n\nfunction emitPatch(A: Aberdeen, patch: Patch) {\n\tfor (const [collection, collectionMap] of patch) {\n\t\tfor (const [index, [newData, oldData]] of collectionMap) {\n\t\t\tA.defaultEmitHandler(collection, index, newData, oldData);\n\t\t}\n\t}\n}\n\nfunction mergePatch(target: Patch, source: Patch, reverse = false) {\n\tfor (const [collection, collectionMap] of source) {\n\t\tfor (const [index, [newData, oldData]] of collectionMap) {\n\t\t\taddToPatch(\n\t\t\t\ttarget,\n\t\t\t\tcollection,\n\t\t\t\tindex,\n\t\t\t\treverse ? oldData : newData,\n\t\t\t\treverse ? newData : oldData,\n\t\t\t);\n\t\t}\n\t}\n}\n\nfunction silentlyApplyPatch(A: Aberdeen, patch: Patch, force = false): boolean {\n\tconst EMPTY = A.EMPTY;\n\tfor (const [collection, collectionMap] of patch) {\n\t\tfor (const [index, [newData, oldData]] of collectionMap) {\n\t\t\t// MAP_SIZE_SYMBOL is synthetic - size is derived from add/delete operations\n\t\t\tif (index === A.MAP_SIZE_SYMBOL) continue;\n\t\t\tconst actualData =\n\t\t\t\tcollection instanceof Map\n\t\t\t\t\t? collection.has(index)\n\t\t\t\t\t\t? collection.get(index)\n\t\t\t\t\t\t: EMPTY\n\t\t\t\t\t: index in (collection as any)\n\t\t\t\t\t\t? (collection as any)[index]\n\t\t\t\t\t\t: EMPTY;\n\t\t\tif (actualData !== oldData) {\n\t\t\t\tif (force)\n\t\t\t\t\t(A.window?.setTimeout ?? setTimeout)(() => {\n\t\t\t\t\t\tthrow new Error(\n\t\t\t\t\t\t\t`Applying invalid patch: data ${String(actualData)} is unequal to expected old data ${String(oldData)} for index ${String(index)}`,\n\t\t\t\t\t\t);\n\t\t\t\t\t}, 0);\n\t\t\t\telse return false;\n\t\t\t}\n\t\t}\n\t}\n\tfor (const [collection, collectionMap] of patch) {\n\t\tfor (const [index, [newData, oldData]] of collectionMap) {\n\t\t\tif (index === A.MAP_SIZE_SYMBOL) continue;\n\t\t\tif (collection instanceof Map) {\n\t\t\t\tif (newData === EMPTY) collection.delete(index);\n\t\t\t\telse collection.set(index, newData);\n\t\t\t} else {\n\t\t\t\tif (newData === EMPTY) delete (collection as any)[index];\n\t\t\t\telse (collection as any)[index] = newData;\n\t\t\t}\n\t\t}\n\t}\n\treturn true;\n}\n\nconst appliedPredictions: Array<Patch> = [];\n\n/**\n * Run the provided function, while treating all changes to Observables as predictions,\n * meaning they will be reverted when changes come back from the server (or some other\n * async source).\n * @param A The Aberdeen instance (the default export of `aberdeen`, or one from `init`).\n * @param predictFunc The function to run. It will generally modify some Observables\n * \tto immediately reflect state (as closely as possible) that we expect the server\n *  to communicate back to us later on.\n * @returns A `Patch` object. Don't modify it. This is only meant to be passed to `applyCanon`.\n */\nexport function applyPrediction(A: Aberdeen, predictFunc: () => void): Patch {\n\tconst patch = recordPatch(A, predictFunc);\n\tappliedPredictions.push(patch);\n\temitPatch(A, patch);\n\treturn patch;\n}\n\n/**\n * Temporarily revert all outstanding predictions, optionally run the provided function\n * (which will generally make authoritative changes to the data based on a server response),\n * and then attempt to reapply the predictions on top of the new canonical state, dropping\n * any predictions that can no longer be applied cleanly (the data has been modified) or\n * that were specified in `dropPredictions`.\n *\n * All of this is done such that redraws are only triggered if the overall effect is an\n * actual change to an `Observable`.\n * @param A The Aberdeen instance (the default export of `aberdeen`, or one from `init`).\n * @param canonFunc The function to run without any predictions applied. This will typically\n *  make authoritative changes to the data, based on a server response.\n * @param dropPredictions An optional list of predictions (as returned by `applyPrediction`)\n *  to undo. Typically, when a server response for a certain request is being handled,\n *  you'd want to drop the prediction that was done for that request.\n */\nexport function applyCanon(\n\tA: Aberdeen,\n\tcanonFunc?: () => void,\n\tdropPredictions: Array<Patch> = [],\n) {\n\tconst resultPatch = new Map();\n\tfor (const prediction of appliedPredictions)\n\t\tmergePatch(resultPatch, prediction, true);\n\tsilentlyApplyPatch(A, resultPatch, true);\n\n\tfor (const prediction of dropPredictions) {\n\t\tconst pos = appliedPredictions.indexOf(prediction);\n\t\tif (pos >= 0) appliedPredictions.splice(pos, 1);\n\t}\n\tif (canonFunc) mergePatch(resultPatch, recordPatch(A, canonFunc));\n\n\tfor (let idx = 0; idx < appliedPredictions.length; idx++) {\n\t\tif (silentlyApplyPatch(A, appliedPredictions[idx])) {\n\t\t\tmergePatch(resultPatch, appliedPredictions[idx]);\n\t\t} else {\n\t\t\tappliedPredictions.splice(idx, 1);\n\t\t\tidx--;\n\t\t}\n\t}\n\n\temitPatch(A, resultPatch);\n}\n"
   ],
-  "mappings": ";AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAeA,SAAS,WAAW,CAAC,MAAyB;AAAA,EAC7C,MAAM,iBAAiB,IAAI;AAAA,EAC3B,gBAAgB,CAAC,QAAQ,OAAO,SAAS,YAAY;AAAA,IACpD,WAAW,gBAAgB,QAAQ,OAAO,SAAS,OAAO;AAAA,KACxD,IAAI;AAAA,EACP,OAAO;AAAA;AAGR,SAAS,UAAU,CAClB,OACA,YACA,OACA,SACA,SACC;AAAA,EACD,IAAI,gBAAgB,MAAM,IAAI,UAAU;AAAA,EACxC,IAAI,CAAC,eAAe;AAAA,IACnB,gBAAgB,IAAI;AAAA,IACpB,MAAM,IAAI,YAAY,aAAa;AAAA,EACpC;AAAA,EACA,MAAM,OAAO,cAAc,IAAI,KAAK;AAAA,EACpC,MAAM,WAAW,OAAO,KAAK,KAAK;AAAA,EAClC,IAAI,YAAY;AAAA,IAAU,cAAc,OAAO,KAAK;AAAA,EAC/C;AAAA,kBAAc,IAAI,OAAO,CAAC,SAAS,QAAQ,CAAC;AAAA;AAGlD,SAAS,SAAS,CAAC,OAAc;AAAA,EAChC,YAAY,YAAY,kBAAkB,OAAO;AAAA,IAChD,YAAY,QAAQ,SAAS,aAAa,eAAe;AAAA,MACxD,mBAAmB,YAAY,OAAO,SAAS,OAAO;AAAA,IACvD;AAAA,EACD;AAAA;AAGD,SAAS,UAAU,CAAC,QAAe,QAAe,UAAU,OAAO;AAAA,EAClE,YAAY,YAAY,kBAAkB,QAAQ;AAAA,IACjD,YAAY,QAAQ,SAAS,aAAa,eAAe;AAAA,MACxD,WACC,QACA,YACA,OACA,UAAU,UAAU,SACpB,UAAU,UAAU,OACrB;AAAA,IACD;AAAA,EACD;AAAA;AAGD,SAAS,kBAAkB,CAAC,OAAc,QAAQ,OAAgB;AAAA,EACjE,YAAY,YAAY,kBAAkB,OAAO;AAAA,IAChD,YAAY,QAAQ,SAAS,aAAa,eAAe;AAAA,MAExD,IAAI,UAAU;AAAA,QAAiB;AAAA,MAC/B,MAAM,aACL,sBAAsB,MACnB,WAAW,IAAI,KAAK,IACnB,WAAW,IAAI,KAAK,IACpB,SACD,SAAU,cACR,WAAmB,SACpB;AAAA,MACL,IAAI,eAAe,SAAS;AAAA,QAC3B,IAAI;AAAA,UACH,WAAW,MAAM;AAAA,YAChB,MAAM,IAAI,MACT,gCAAgC,OAAO,UAAU,qCAAqC,OAAO,OAAO,eAAe,OAAO,KAAK,GAChI;AAAA,aACE,CAAC;AAAA,QACA;AAAA,iBAAO;AAAA,MACb;AAAA,IACD;AAAA,EACD;AAAA,EACA,YAAY,YAAY,kBAAkB,OAAO;AAAA,IAChD,YAAY,QAAQ,SAAS,aAAa,eAAe;AAAA,MACxD,IAAI,UAAU;AAAA,QAAiB;AAAA,MAC/B,IAAI,sBAAsB,KAAK;AAAA,QAC9B,IAAI,YAAY;AAAA,UAAO,WAAW,OAAO,KAAK;AAAA,QACzC;AAAA,qBAAW,IAAI,OAAO,OAAO;AAAA,MACnC,EAAO;AAAA,QACN,IAAI,YAAY;AAAA,UAAO,OAAQ,WAAmB;AAAA,QAC7C;AAAA,UAAC,WAAmB,SAAS;AAAA;AAAA,IAEpC;AAAA,EACD;AAAA,EACA,OAAO;AAAA;AAGR,IAAM,qBAAmC,CAAC;AAWnC,SAAS,eAAe,CAAC,aAAgC;AAAA,EAC/D,MAAM,QAAQ,YAAY,WAAW;AAAA,EACrC,mBAAmB,KAAK,KAAK;AAAA,EAC7B,UAAU,KAAK;AAAA,EACf,OAAO;AAAA;AAkBD,SAAS,UAAU,CACzB,WACA,kBAAgC,CAAC,GAChC;AAAA,EACD,MAAM,cAAc,IAAI;AAAA,EACxB,WAAW,cAAc;AAAA,IACxB,WAAW,aAAa,YAAY,IAAI;AAAA,EACzC,mBAAmB,aAAa,IAAI;AAAA,EAEpC,WAAW,cAAc,iBAAiB;AAAA,IACzC,MAAM,MAAM,mBAAmB,QAAQ,UAAU;AAAA,IACjD,IAAI,OAAO;AAAA,MAAG,mBAAmB,OAAO,KAAK,CAAC;AAAA,EAC/C;AAAA,EACA,IAAI;AAAA,IAAW,WAAW,aAAa,YAAY,SAAS,CAAC;AAAA,EAE7D,SAAS,MAAM,EAAG,MAAM,mBAAmB,QAAQ,OAAO;AAAA,IACzD,IAAI,mBAAmB,mBAAmB,IAAI,GAAG;AAAA,MAChD,WAAW,aAAa,mBAAmB,IAAI;AAAA,IAChD,EAAO;AAAA,MACN,mBAAmB,OAAO,KAAK,CAAC;AAAA,MAChC;AAAA;AAAA,EAEF;AAAA,EAEA,UAAU,WAAW;AAAA;",
-  "debugId": "0E6977F82274D4EC64756E2164756E21",
+  "mappings": ";AAYA,SAAS,WAAW,CAAC,GAAa,MAAyB;AAAA,EAC1D,MAAM,iBAAiB,IAAI;AAAA,EAC3B,EAAE,gBAAgB,CAAC,QAAa,OAAY,SAAc,YAAiB;AAAA,IAC1E,WAAW,gBAAgB,QAAQ,OAAO,SAAS,OAAO;AAAA,KACxD,IAAI;AAAA,EACP,OAAO;AAAA;AAGR,SAAS,UAAU,CAClB,OACA,YACA,OACA,SACA,SACC;AAAA,EACD,IAAI,gBAAgB,MAAM,IAAI,UAAU;AAAA,EACxC,IAAI,CAAC,eAAe;AAAA,IACnB,gBAAgB,IAAI;AAAA,IACpB,MAAM,IAAI,YAAY,aAAa;AAAA,EACpC;AAAA,EACA,MAAM,OAAO,cAAc,IAAI,KAAK;AAAA,EACpC,MAAM,WAAW,OAAO,KAAK,KAAK;AAAA,EAClC,IAAI,YAAY;AAAA,IAAU,cAAc,OAAO,KAAK;AAAA,EAC/C;AAAA,kBAAc,IAAI,OAAO,CAAC,SAAS,QAAQ,CAAC;AAAA;AAGlD,SAAS,SAAS,CAAC,GAAa,OAAc;AAAA,EAC7C,YAAY,YAAY,kBAAkB,OAAO;AAAA,IAChD,YAAY,QAAQ,SAAS,aAAa,eAAe;AAAA,MACxD,EAAE,mBAAmB,YAAY,OAAO,SAAS,OAAO;AAAA,IACzD;AAAA,EACD;AAAA;AAGD,SAAS,UAAU,CAAC,QAAe,QAAe,UAAU,OAAO;AAAA,EAClE,YAAY,YAAY,kBAAkB,QAAQ;AAAA,IACjD,YAAY,QAAQ,SAAS,aAAa,eAAe;AAAA,MACxD,WACC,QACA,YACA,OACA,UAAU,UAAU,SACpB,UAAU,UAAU,OACrB;AAAA,IACD;AAAA,EACD;AAAA;AAGD,SAAS,kBAAkB,CAAC,GAAa,OAAc,QAAQ,OAAgB;AAAA,EAC9E,MAAM,QAAQ,EAAE;AAAA,EAChB,YAAY,YAAY,kBAAkB,OAAO;AAAA,IAChD,YAAY,QAAQ,SAAS,aAAa,eAAe;AAAA,MAExD,IAAI,UAAU,EAAE;AAAA,QAAiB;AAAA,MACjC,MAAM,aACL,sBAAsB,MACnB,WAAW,IAAI,KAAK,IACnB,WAAW,IAAI,KAAK,IACpB,SACD,SAAU,cACR,WAAmB,SACpB;AAAA,MACL,IAAI,eAAe,SAAS;AAAA,QAC3B,IAAI;AAAA,WACF,EAAE,QAAQ,cAAc,YAAY,MAAM;AAAA,YAC1C,MAAM,IAAI,MACT,gCAAgC,OAAO,UAAU,qCAAqC,OAAO,OAAO,eAAe,OAAO,KAAK,GAChI;AAAA,aACE,CAAC;AAAA,QACA;AAAA,iBAAO;AAAA,MACb;AAAA,IACD;AAAA,EACD;AAAA,EACA,YAAY,YAAY,kBAAkB,OAAO;AAAA,IAChD,YAAY,QAAQ,SAAS,aAAa,eAAe;AAAA,MACxD,IAAI,UAAU,EAAE;AAAA,QAAiB;AAAA,MACjC,IAAI,sBAAsB,KAAK;AAAA,QAC9B,IAAI,YAAY;AAAA,UAAO,WAAW,OAAO,KAAK;AAAA,QACzC;AAAA,qBAAW,IAAI,OAAO,OAAO;AAAA,MACnC,EAAO;AAAA,QACN,IAAI,YAAY;AAAA,UAAO,OAAQ,WAAmB;AAAA,QAC7C;AAAA,UAAC,WAAmB,SAAS;AAAA;AAAA,IAEpC;AAAA,EACD;AAAA,EACA,OAAO;AAAA;AAGR,IAAM,qBAAmC,CAAC;AAYnC,SAAS,eAAe,CAAC,GAAa,aAAgC;AAAA,EAC5E,MAAM,QAAQ,YAAY,GAAG,WAAW;AAAA,EACxC,mBAAmB,KAAK,KAAK;AAAA,EAC7B,UAAU,GAAG,KAAK;AAAA,EAClB,OAAO;AAAA;AAmBD,SAAS,UAAU,CACzB,GACA,WACA,kBAAgC,CAAC,GAChC;AAAA,EACD,MAAM,cAAc,IAAI;AAAA,EACxB,WAAW,cAAc;AAAA,IACxB,WAAW,aAAa,YAAY,IAAI;AAAA,EACzC,mBAAmB,GAAG,aAAa,IAAI;AAAA,EAEvC,WAAW,cAAc,iBAAiB;AAAA,IACzC,MAAM,MAAM,mBAAmB,QAAQ,UAAU;AAAA,IACjD,IAAI,OAAO;AAAA,MAAG,mBAAmB,OAAO,KAAK,CAAC;AAAA,EAC/C;AAAA,EACA,IAAI;AAAA,IAAW,WAAW,aAAa,YAAY,GAAG,SAAS,CAAC;AAAA,EAEhE,SAAS,MAAM,EAAG,MAAM,mBAAmB,QAAQ,OAAO;AAAA,IACzD,IAAI,mBAAmB,GAAG,mBAAmB,IAAI,GAAG;AAAA,MACnD,WAAW,aAAa,mBAAmB,IAAI;AAAA,IAChD,EAAO;AAAA,MACN,mBAAmB,OAAO,KAAK,CAAC;AAAA,MAChC;AAAA;AAAA,EAEF;AAAA,EAEA,UAAU,GAAG,WAAW;AAAA;",
+  "debugId": "908A3B91728A6C4A64756E2164756E21",
   "names": []
 }

package/dist/src/route.d.ts

@@ -24,11 +24,6 @@ export interface Route {
     */
     nav: NavType;
 }
-/**
- * Configure logging on route changes.
- * @param value `true` to enable logging to console, `false` to disable logging, or a custom logging function. Defaults to `false`.
- */
-export declare function setLog(value: boolean | ((...args: any[]) => void)): void;
 type RouteTarget = string | (string | number)[] | Partial<Omit<Omit<Route, "p">, "search"> & {
     /** An convenience array containing path segments, mapping to `path`. For instance `[]` (for `"/"`) or `['users', 123, 'feed']` (for `"/users/123/feed"`). Values may be integers but will be converted to strings.*/
     p: (string | number)[];
@@ -36,102 +31,120 @@ type RouteTarget = string | (string | number)[] | Partial<Omit<Omit<Route, "p">,
     search: Record<string, string | number>;
 }>;
 /**
-* Navigate to a new URL by pushing a new history entry.
-*
-* Note that this happens synchronously, immediately updating `route` and processing any reactive updates based on that.
-*
-* @param target A subset of the {@link Route} properties to navigate to. If neither `p` nor `path` is given, the current path is used. For other properties, an empty/default value is assumed if not given. For convenience:
-* - You may pass a string instead of an object, which is interpreted as the `path`.
-* - You may pass an array instead of an object, which is interpreted as the `p` array.
-* - If you pass `p`, it may contain numbers, which will be converted to strings.
-* - If you pass `search`, its values may be numbers, which will be converted to strings.
-*
-* Examples:
-* ```js
-* // Navigate to /users/123
-* route.go("/users/123");
-*
-* // Navigate to /users/123?tab=feed#top
-* route.go({p: ["users", 123], search: {tab: "feed"}, hash: "top"});
-* ```
-*/
-export declare function go(target: RouteTarget, nav?: NavType): void;
-/**
- * Returns `true` if the current route matches `target`.
- *
- * Path must match exactly. Any search params specified in `target` must be present
- * in the current URL, but extra params in the current URL are allowed.
- *
- * Reactive: only reevaluates when the path changes to/from the target path, and
- * when target k/v search pairs are (un)set.
- *
- * Primary usage: 'active' status for menu items.
- *
- * @example
- * ```js
- * // This example assumes interceptLinks() has been called
- * A('a.my-button text=Users href=/users .is-active=', route.matchCurrent('/users'));
- *
- * // Alternatively a route object can be given
- * route.matchCurrent({path: '/users', search: {tab: 'profile'}});
- * ```
- */
-export declare function matchCurrent(target: RouteTarget): boolean;
-/**
- * Modify the current route by merging `target` into it (using {@link aberdeen.merge | A.merge}), pushing a new history entry.
- *
- * This is useful for things like opening modals or side panels, where you want a browser back action to return to the previous state.
- *
- * @param target Same as for {@link go}, but merged into the current route instead deleting all state.
- * @param nav The navigation type to use. Defaults to `undefined`, meaning the navigation type is unchanged from the current route,
- *  preventing unwanted page transition animations.
- */
-export declare function push(target: RouteTarget, nav?: NavType): void;
-/**
- * Try to go back in history to the first entry that matches the given target. If none is found, the given state will replace the current page. This is useful for "cancel" or "close" actions that should return to the previous page if possible, but create a new page if not (for instance when arriving at the current page through a direct link).
- *
- * Consider using {@link up} to go up in the path hierarchy.
- *
- * @param target The target route to go back to. May be a subset of {@link Route}, or a string (for `path`), or an array of strings (for `p`).
+ * The router API returned by {@link init}, bound to a specific Aberdeen instance's window.
  */
-export declare function back(target?: RouteTarget): void;
-/**
-* Navigate up in the path hierarchy, by going back to the first history entry
-* that has a shorter path than the current one. If there's none, we just shorten
-* the current path.
-*
-* Note that going back in browser history happens asynchronously, so `route` will not be updated immediately.
-*/
-export declare function up(stripCount?: number): void;
-/**
-* The global {@link Route} object reflecting the current URL and browser history state. Changes you make to this affect the current browser history item (modifying the URL if needed).
-*/
-export declare const current: Route;
-/**
-* Restore and store the vertical and horizontal scroll position for
-* the parent element to the page state.
-*
-* @param {string} name - A unique (within this page) name for this
-* scrollable element. Defaults to 'main'.
-*
-* The scroll position will be persisted in `route.aux.scroll.<name>`.
-*/
-export declare function persistScroll(name?: string): void;
+export interface RouteApi {
+    /**
+    * The global {@link Route} object reflecting the current URL and browser history state. Changes you make to this affect the current browser history item (modifying the URL if needed).
+    */
+    current: Route;
+    /**
+     * Configure logging on route changes.
+     * @param value `true` to enable logging to console, `false` to disable logging, or a custom logging function. Defaults to `false`.
+     */
+    setLog(value: boolean | ((...args: any[]) => void)): void;
+    /**
+    * Navigate to a new URL by pushing a new history entry.
+    *
+    * Note that this happens synchronously, immediately updating `route` and processing any reactive updates based on that.
+    *
+    * @param target A subset of the {@link Route} properties to navigate to. If neither `p` nor `path` is given, the current path is used. For other properties, an empty/default value is assumed if not given. For convenience:
+    * - You may pass a string instead of an object, which is interpreted as the `path`.
+    * - You may pass an array instead of an object, which is interpreted as the `p` array.
+    * - If you pass `p`, it may contain numbers, which will be converted to strings.
+    * - If you pass `search`, its values may be numbers, which will be converted to strings.
+    *
+    * Examples:
+    * ```js
+    * // Navigate to /users/123
+    * route.go("/users/123");
+    *
+    * // Navigate to /users/123?tab=feed#top
+    * route.go({p: ["users", 123], search: {tab: "feed"}, hash: "top"});
+    * ```
+    */
+    go(target: RouteTarget, nav?: NavType): void;
+    /**
+     * Returns `true` if the current route matches `target`.
+     *
+     * Path must match exactly. Any search params specified in `target` must be present
+     * in the current URL, but extra params in the current URL are allowed.
+     *
+     * Reactive: only reevaluates when the path changes to/from the target path, and
+     * when target k/v search pairs are (un)set.
+     *
+     * Primary usage: 'active' status for menu items.
+     *
+     * @example
+     * ```js
+     * // This example assumes interceptLinks() has been called
+     * A('a.my-button text=Users href=/users .is-active=', route.matchCurrent('/users'));
+     *
+     * // Alternatively a route object can be given
+     * route.matchCurrent({path: '/users', search: {tab: 'profile'}});
+     * ```
+     */
+    matchCurrent(target: RouteTarget): boolean;
+    /**
+     * Modify the current route by merging `target` into it (using {@link aberdeen!Aberdeen.merge | A.merge}), pushing a new history entry.
+     *
+     * This is useful for things like opening modals or side panels, where you want a browser back action to return to the previous state.
+     *
+     * @param target Same as for {@link go}, but merged into the current route instead deleting all state.
+     * @param nav The navigation type to use. Defaults to `undefined`, meaning the navigation type is unchanged from the current route,
+     *  preventing unwanted page transition animations.
+     */
+    push(target: RouteTarget, nav?: NavType): void;
+    /**
+     * Try to go back in history to the first entry that matches the given target. If none is found, the given state will replace the current page. This is useful for "cancel" or "close" actions that should return to the previous page if possible, but create a new page if not (for instance when arriving at the current page through a direct link).
+     *
+     * Consider using {@link up} to go up in the path hierarchy.
+     *
+     * @param target The target route to go back to. May be a subset of {@link Route}, or a string (for `path`), or an array of strings (for `p`).
+     */
+    back(target?: RouteTarget): void;
+    /**
+    * Navigate up in the path hierarchy, by going back to the first history entry
+    * that has a shorter path than the current one. If there's none, we just shorten
+    * the current path.
+    *
+    * Note that going back in browser history happens asynchronously, so `route` will not be updated immediately.
+    */
+    up(stripCount?: number): void;
+    /**
+    * Restore and store the vertical and horizontal scroll position for
+    * the parent element to the page state.
+    *
+    * @param {string} name - A unique (within this page) name for this
+    * scrollable element. Defaults to 'main'.
+    *
+    * The scroll position will be persisted in `route.aux.scroll.<name>`.
+    */
+    persistScroll(name?: string): void;
+    /**
+     * Intercept clicks and Enter key presses on links (`<a>` tags) and use Aberdeen routing
+     * instead of browser navigation for local paths (paths without a protocol or host).
+     *
+     * This allows you to use regular HTML anchor tags for navigation without needing to
+     * manually attach click handlers to each link.
+     *
+     * @example
+     * ```js
+     * // In your root component:
+     * route.interceptLinks();
+     *
+     * // Now you can use regular anchor tags:
+     * A('a text=About href=/corporate/about');
+     * ```
+     */
+    interceptLinks(): void;
+}
 /**
- * Intercept clicks and Enter key presses on links (`<a>` tags) and use Aberdeen routing
- * instead of browser navigation for local paths (paths without a protocol or host).
- *
- * This allows you to use regular HTML anchor tags for navigation without needing to
- * manually attach click handlers to each link.
- *
- * @example
- * ```js
- * // In your root component:
- * route.interceptLinks();
+ * Initialise routing for an Aberdeen instance and return the router API, bound to that
+ * instance's window. In the browser, use the default instance: `init(A)`. For server-side
+ * rendering, pass the instance provided by `aberdeen/server`'s render callback.
  *
- * // Now you can use regular anchor tags:
- * A('a text=About href=/corporate/about');
- * ```
+ * @param A An Aberdeen instance (the default export of `aberdeen`, or one from `init`).
  */
-export declare function interceptLinks(): void;
+export declare function init(A: any): RouteApi;
 export {};