@verdant-web/common 2.3.3 → 2.4.0-next.0

package/dist/esm/utils.js

@@ -125,4 +125,25 @@ export function debounce(fn, wait) {
         timeout = setTimeout(() => fn.apply(context, args), wait);
     };
 }
+export function throttle(fn, wait) {
+    let lastTime = 0;
+    // invoke once for the last call
+    let trailingTimeout;
+    return function (...args) {
+        const context = this;
+        const now = Date.now();
+        if (now - lastTime >= wait) {
+            lastTime = now;
+            fn.apply(context, args);
+            clearTimeout(trailingTimeout);
+        }
+        else {
+            clearTimeout(trailingTimeout);
+            trailingTimeout = setTimeout(() => {
+                lastTime = now;
+                fn.apply(context, args);
+            }, wait);
+        }
+    };
+}
 //# sourceMappingURL=utils.js.map

package/dist/esm/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,IAAI,MAAM,aAAa,CAAC;AAE/B,MAAM,UAAU,IAAI,CACnB,GAAM,EACN,IAAY;IAEZ,MAAM,MAAM,GAAQ,EAAE,CAAC;IACvB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,MAAM,UAAU,IAAI,CACnB,GAAM,EACN,IAAY;IAEZ,MAAM,MAAM,GAAQ,EAAE,CAAC;IACvB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACpC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAW,CAAC,EAAE,CAAC;YACjC,MAAM,CAAC,GAAG,CAAC,GAAI,GAAW,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC;IACF,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,MAAM,UAAU,cAAc,CAC7B,KAAU,EACV,MAAS,EACT,OAA+B;IAE/B,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC;IACxB,OAAO,GAAG,GAAG,IAAI,EAAE,CAAC;QACnB,MAAM,GAAG,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;QACxC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACb,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC;QACf,CAAC;aAAM,CAAC;YACP,IAAI,GAAG,GAAG,CAAC;QACZ,CAAC;IACF,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,SAAS,eAAe,CAAC,CAAM,EAAE,CAAM;IACtC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,OAAO,CAAC,CAAC;IACV,CAAC;IACD,OAAO,MAAM,CAAC,WAAW,CACxB,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACxE,CAAC;AACH,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,GAAQ;IACvC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;AAC7C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAI,GAAM,EAAE,QAAQ,GAAG,IAAI;IACnD,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACzC,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,KAAU,CAAC;QACf,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAM,CAAC;QACrD,CAAC;aAAM,CAAC;YACP,KAAK,GAAG,EAAE,CAAC;YACX,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAU,CAAC,EAAE,CAAC;gBACvD,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACzC,CAAC;QACF,CAAC;QACD,IAAI,QAAQ,IAAI,GAAG,EAAE,CAAC;YACrB,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,oBAAoB;AACpB,MAAM,UAAU,UAAU,CAAC,GAAQ;IAClC,uCAAuC;IACvC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,GAAQ;IAChC,OAAO,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAW;IAC5C,IAAI,UAAU,GAAG,EAAE,CAAC;IACpB,IAAI,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC;IACrB,IAAI,KAAK,GAAG,CAAC,CAAC;IAEd,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;QACrB,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QAExB,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,KAAK,IAAI,CAAC,CAAC;QACZ,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACtC,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QAC3B,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACtC,KAAK,IAAI,CAAC,CAAC;QACZ,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC1E,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAEvB,KAAK,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC;gBACrB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACtB,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,MAAM,UAAU,MAAM,CACrB,SAAc,EACd,UAAkB,kBAAkB;IAEpC,IAAI,CAAC,SAAS,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;AACF,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAM,GAAG,EAAE;IACrC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,aAAa,CAAI,KAAU,EAAE,SAA+B;IAC3E,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5C,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACzB,OAAO,CAAC,CAAC;QACV,CAAC;IACF,CAAC;IACD,OAAO,CAAC,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,QAAQ,CACvB,EAAK,EACL,IAAY;IAEZ,IAAI,OAAY,CAAC;IACjB,OAAO,UAAqB,GAAG,IAAW;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC;QACrB,YAAY,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3D,CAAQ,CAAC;AACV,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,IAAI,MAAM,aAAa,CAAC;AAE/B,MAAM,UAAU,IAAI,CACnB,GAAM,EACN,IAAY;IAEZ,MAAM,MAAM,GAAQ,EAAE,CAAC;IACvB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,MAAM,UAAU,IAAI,CACnB,GAAM,EACN,IAAY;IAEZ,MAAM,MAAM,GAAQ,EAAE,CAAC;IACvB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACpC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAW,CAAC,EAAE,CAAC;YACjC,MAAM,CAAC,GAAG,CAAC,GAAI,GAAW,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC;IACF,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,MAAM,UAAU,cAAc,CAC7B,KAAU,EACV,MAAS,EACT,OAA+B;IAE/B,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC;IACxB,OAAO,GAAG,GAAG,IAAI,EAAE,CAAC;QACnB,MAAM,GAAG,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;QACxC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACb,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC;QACf,CAAC;aAAM,CAAC;YACP,IAAI,GAAG,GAAG,CAAC;QACZ,CAAC;IACF,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,SAAS,eAAe,CAAC,CAAM,EAAE,CAAM;IACtC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,OAAO,CAAC,CAAC;IACV,CAAC;IACD,OAAO,MAAM,CAAC,WAAW,CACxB,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACxE,CAAC;AACH,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,GAAQ;IACvC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;AAC7C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAI,GAAM,EAAE,QAAQ,GAAG,IAAI;IACnD,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACzC,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,KAAU,CAAC;QACf,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAM,CAAC;QACrD,CAAC;aAAM,CAAC;YACP,KAAK,GAAG,EAAE,CAAC;YACX,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAU,CAAC,EAAE,CAAC;gBACvD,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACzC,CAAC;QACF,CAAC;QACD,IAAI,QAAQ,IAAI,GAAG,EAAE,CAAC;YACrB,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,oBAAoB;AACpB,MAAM,UAAU,UAAU,CAAC,GAAQ;IAClC,uCAAuC;IACvC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,GAAQ;IAChC,OAAO,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAW;IAC5C,IAAI,UAAU,GAAG,EAAE,CAAC;IACpB,IAAI,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC;IACrB,IAAI,KAAK,GAAG,CAAC,CAAC;IAEd,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;QACrB,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QAExB,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,KAAK,IAAI,CAAC,CAAC;QACZ,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACtC,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QAC3B,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACtC,KAAK,IAAI,CAAC,CAAC;QACZ,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC1E,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAEvB,KAAK,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC;gBACrB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACtB,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,MAAM,UAAU,MAAM,CACrB,SAAc,EACd,UAAkB,kBAAkB;IAEpC,IAAI,CAAC,SAAS,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;AACF,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAM,GAAG,EAAE;IACrC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,aAAa,CAAI,KAAU,EAAE,SAA+B;IAC3E,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5C,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACzB,OAAO,CAAC,CAAC;QACV,CAAC;IACF,CAAC;IACD,OAAO,CAAC,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,QAAQ,CACvB,EAAK,EACL,IAAY;IAEZ,IAAI,OAAY,CAAC;IACjB,OAAO,UAAqB,GAAG,IAAW;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC;QACrB,YAAY,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3D,CAAQ,CAAC;AACV,CAAC;AAED,MAAM,UAAU,QAAQ,CACvB,EAAK,EACL,IAAY;IAEZ,IAAI,QAAQ,GAAG,CAAC,CAAC;IAEjB,gCAAgC;IAChC,IAAI,eAAoB,CAAC;IAEzB,OAAO,UAAqB,GAAG,IAAW;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,GAAG,GAAG,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC5B,QAAQ,GAAG,GAAG,CAAC;YACf,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACxB,YAAY,CAAC,eAAe,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACP,YAAY,CAAC,eAAe,CAAC,CAAC;YAC9B,eAAe,GAAG,UAAU,CAAC,GAAG,EAAE;gBACjC,QAAQ,GAAG,GAAG,CAAC;gBACf,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACzB,CAAC,EAAE,IAAI,CAAC,CAAC;QACV,CAAC;IACF,CAAQ,CAAC;AACV,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdant-web/common",
-  "version": "2.3.3",
+  "version": "2.4.0-next.0",
   "access": "public",
   "type": "module",
   "exports": {

package/src/authz.ts

@@ -0,0 +1,67 @@
+import { DocumentBaseline } from './baseline.js';
+import { Operation } from './operation.js';
+
+function encode(str: string): AuthorizationKey {
+	const val = Buffer.from(str).toString('base64');
+	return val as AuthorizationKey;
+}
+
+function decode(str: string): string {
+	return Buffer.from(str, 'base64').toString();
+}
+
+export type AuthorizationKey = string & {
+	'@@type': 'authz';
+};
+
+export const authz = {
+	onlyUser: (userId: string): AuthorizationKey => encode(`u:${userId}:*`),
+	onlyMe: (): AuthorizationKey => authz.onlyUser(ORIGINATOR_SUBJECT),
+	decode: (encoded: string) => {
+		const decoded = decode(encoded);
+		const parts = decoded.split(':');
+		if (parts.length !== 3) {
+			throw new Error('Invalid authz string');
+		}
+		return {
+			scope: parts[0],
+			subject: parts[1],
+			action: parts[2],
+		};
+	},
+};
+
+export const ORIGINATOR_SUBJECT = '$$_originator_$$';
+
+/**
+ * Rewrites the special "originator" constant subject (used by
+ * local-only clients) to the given user ID.
+ *
+ * Used to initialize a library from a local-only replica
+ */
+export function rewriteAuthzOriginator(
+	data: { operations?: Operation[]; baselines?: DocumentBaseline[] },
+	newSubject: string,
+) {
+	const { operations, baselines } = data;
+	if (operations) {
+		for (const op of operations) {
+			if (op.authz) {
+				const decoded = authz.decode(op.authz);
+				if (decoded.subject === ORIGINATOR_SUBJECT) {
+					op.authz = authz.onlyUser(newSubject);
+				}
+			}
+		}
+	}
+	if (baselines) {
+		for (const baseline of baselines) {
+			if (baseline.authz) {
+				const decoded = authz.decode(baseline.authz);
+				if (decoded.subject === ORIGINATOR_SUBJECT) {
+					baseline.authz = authz.onlyUser(newSubject);
+				}
+			}
+		}
+	}
+}

package/src/baseline.ts

@@ -1,9 +1,10 @@
+// A: Docs without a base state don't have a baseline, it's
+// written upon rebasing. If you apply ops to an undefined
+// snapshot without an initialize, it remains undefined.
+
 export type DocumentBaseline<T extends any = any> = {
 	oid: string;
 	snapshot: T;
 	timestamp: string;
-	// TODO: is a deleted flag required here? can we disambiguate
-	// a document which was snapshotted in a deleted state, vs
-	// one without a base state at all? what happens if you apply
-	// ops onto an undefined snapshot (which aren't initialize)?
+	authz?: string;
 };

package/src/files.ts

@@ -1,3 +1,5 @@
+import { isObject } from './utils.js';
+
 export type FileRef = {
 	'@@type': 'file';
 	id: string;
@@ -22,7 +24,9 @@ export type FileData = {
 	remote: boolean;
 	name: string;
 	type: string;
+	/** A local File instance, if available. */
 	file?: Blob;
+	/** The server URL of this file. */
 	url?: string;
 };
 
@@ -32,3 +36,24 @@ export function getAllFileFields(snapshot: any): [string, FileRef][] {
 		FileRef,
 	][];
 }
+
+export function isFile(value: any) {
+	if (typeof File !== 'undefined' && value instanceof File) {
+		return true;
+	}
+	if (typeof Blob !== 'undefined' && value instanceof Blob) {
+		return true;
+	}
+	return false;
+}
+
+export function isFileData(value: any): value is FileData {
+	return (
+		value &&
+		isObject(value) &&
+		typeof value.id === 'string' &&
+		typeof value.remote === 'boolean' &&
+		typeof value.name === 'string' &&
+		typeof value.type === 'string'
+	);
+}

package/src/index.ts

@@ -20,6 +20,7 @@ export type {
 export type { UserInfo } from './presence.js';
 export * from './patch.js';
 export * from './oids.js';
+export * from './oidsLegacy.js';
 export * from './EventSubscriber.js';
 export * from './undo.js';
 export * from './batching.js';
@@ -28,3 +29,4 @@ export type { Ref } from './refs.js';
 export { makeObjectRef, makeFileRef, isRef, compareRefs } from './refs.js';
 export * from './memo.js';
 export * from './error.js';
+export * from './authz.js';

package/src/indexes.test.ts

@@ -185,7 +185,7 @@ describe('all indexes', () => {
 			),
 		).toEqual({
 			foobar: 'foo' + COMPOUND_INDEX_SEPARATOR + 'foobar',
-			'@@@snapshot': { foo: 'foo' },
+			'@@@snapshot': JSON.stringify({ foo: 'foo' }),
 			foo: 'foo',
 			bar: 'foobar',
 		});

package/src/indexes.ts

@@ -161,7 +161,7 @@ export function getIndexValues(
 		basicIndexes,
 		computeCompoundIndices(schema, { ...doc, ...basicIndexes }),
 	);
-	basicIndexes['@@@snapshot'] = doc;
+	basicIndexes['@@@snapshot'] = JSON.stringify(doc);
 	return basicIndexes;
 }
 

package/src/migration.ts

@@ -13,6 +13,7 @@ import {
 	getOid,
 	hasDefault,
 	validateEntity,
+	AuthorizationKey,
 } from './index.js';
 
 /**@deprecated */
@@ -473,7 +474,10 @@ type MigrationQueries<Old extends SchemaDocuments> = {
 };
 type MigrationMutations<New extends SchemaDocuments> = {
 	[Key in keyof New]: {
-		put(document: New[Key]['init']): Promise<New[Key]['snapshot']>;
+		put(
+			document: New[Key]['init'],
+			options?: { access?: AuthorizationKey },
+		): Promise<New[Key]['snapshot']>;
 		delete(primaryKey: string): Promise<void>;
 	};
 };

package/src/oids.test.ts

@@ -1,27 +1,15 @@
 import { describe, expect, it } from 'vitest';
 import { createFileRef } from './files.js';
 import {
-	areOidsRelated,
 	assignOid,
-	assignOidPropertiesToAllSubObjects,
-	assignOidProperty,
 	assignOidsToAllSubObjects,
 	createOid,
-	createSubOid,
 	decomposeOid,
-	getOid,
 	getOidSubIdRange,
-	getOidRoot,
 	hasOid,
-	maybeGetOidProperty,
 	normalize,
 	normalizeFirstLevel,
 	ObjectIdentifier,
-	removeOidPropertiesFromAllSubObjects,
-	getLegacyDotOidSubIdRange,
-	replaceLegacyOidsInJsonString,
-	MATCH_LEGACY_OID_JSON_STRING,
-	replaceLegacyOidsInObject,
 } from './oids.js';
 
 describe('normalizing an object', () => {
@@ -280,127 +268,6 @@ describe('computing a range of oids for a whole object set', () => {
 		expect(isWithin('test/a1', start, end)).toBe(false);
 		expect(isWithin('test/a1:3', start, end)).toBe(false);
 	});
-	it('should accommodate legacy dot style oids', () => {
-		const [start, end] = getLegacyDotOidSubIdRange('test/a.foo:barrrr');
-		expect(start).toEqual('test/a.');
-		expect(end).toEqual('test/a.\uffff');
-		expect(start < end).toBe(true);
-		expect(isWithin('test/a.foo:0', start, end)).toBe(true);
-		expect(isWithin('test/a.foo:1', start, end)).toBe(true);
-		expect(isWithin('test/a.bar:zzzzzzzzzzzzzzzzzzzzzzz', start, end)).toBe(
-			true,
-		);
-		expect(isWithin('test/a.aff:\uffff', start, end)).toBe(true);
-		expect(isWithin('test1/a', start, end)).toBe(false);
-		expect(isWithin('test/b', start, end)).toBe(false);
-		expect(isWithin('test/ ', start, end)).toBe(false);
-		expect(isWithin('test/a1', start, end)).toBe(false);
-		expect(isWithin('test/a1:3', start, end)).toBe(false);
-		expect(isWithin('test/a.foo:barrrr', start, end)).toBe(true);
-	});
-});
-
-describe('assigning OIDs as properties', () => {
-	it('should assign to all sub-objects', () => {
-		let i = 0;
-		function createSubId() {
-			return (i++).toString();
-		}
-
-		const initial = {
-			foo: {
-				bar: 1,
-				baz: [2, 3],
-			},
-			qux: [
-				{
-					corge: true,
-				},
-				{
-					grault: {
-						garply: 4,
-					},
-				},
-			],
-		};
-		assignOid(initial, 'test/a');
-		assignOidsToAllSubObjects(initial, createSubId);
-		assignOidPropertiesToAllSubObjects(initial);
-
-		expect(initial).toMatchInlineSnapshot(`
-			{
-			  "@@id": "test/a",
-			  "foo": {
-			    "@@id": "test/a:0",
-			    "bar": 1,
-			    "baz": [
-			      2,
-			      3,
-			    ],
-			  },
-			  "qux": [
-			    {
-			      "@@id": "test/a:3",
-			      "corge": true,
-			    },
-			    {
-			      "@@id": "test/a:4",
-			      "grault": {
-			        "@@id": "test/a:5",
-			        "garply": 4,
-			      },
-			    },
-			  ],
-			}
-		`);
-		// extra check needed for array since it doesn't serialize in the snapshot
-		expect(maybeGetOidProperty(initial.qux)).toBe('test/a:2');
-	});
-
-	it('should transfer assigned OID properties to the memory system', () => {
-		const initial = assignOidProperty(
-			{
-				foo: assignOidProperty(
-					{
-						bar: 1,
-					},
-					'test/a:1',
-				),
-				qux: assignOidProperty(
-					[
-						assignOidProperty(
-							{
-								corge: true,
-							},
-							'test/a:2',
-						),
-						assignOidProperty(
-							{
-								grault: assignOidProperty(
-									{
-										garply: 4,
-									},
-									'test/a:3',
-								),
-							},
-							'test/a:4',
-						),
-					],
-					'test/a:2',
-				),
-			},
-			'test/a',
-		);
-
-		removeOidPropertiesFromAllSubObjects(initial);
-
-		expect(getOid(initial)).toEqual('test/a');
-		expect(getOid(initial.foo)).toEqual('test/a:1');
-		expect(getOid(initial.qux)).toEqual('test/a:2');
-		expect(getOid(initial.qux[0])).toEqual('test/a:2');
-		expect(getOid(initial.qux[1])).toEqual('test/a:4');
-		expect(getOid(initial.qux[1].grault)).toEqual('test/a:3');
-	});
 });
 
 it('should handle special characters in document id or collection', () => {
@@ -430,111 +297,3 @@ describe('assigning OIDs to sub-objects', () => {
 		expect(hasOid(obj.bar[0])).toBe(false);
 	});
 });
-
-describe('handling legacy OIDs', () => {
-	it('should get the root OID for a legacy OID', () => {
-		expect(getOidRoot('items/clabgyjfh00003968qycsq3ld.inputs.#')).toEqual(
-			'items/clabgyjfh00003968qycsq3ld',
-		);
-	});
-	it('should create sub-ids for legacy OIDs in new format', () => {
-		expect(
-			createSubOid(
-				'items/clabgyjfh00003968qycsq3ld.inputs.#',
-				() => 'pseudorandom',
-			),
-		).toEqual('items/clabgyjfh00003968qycsq3ld:pseudorandom');
-	});
-	it('should identify new sub-OIDs as related to the legacy root OID', () => {
-		expect(
-			areOidsRelated(
-				'items/clabgyjfh00003968qycsq3ld.inputs.#',
-				'items/clabgyjfh00003968qycsq3ld:pseudorandom',
-			),
-		).toBe(true);
-	});
-	it.each([
-		['items/clabgyjfh00003968qycsq3ld.inputs.#:baz', true],
-		// include more unicode chars
-		['items/clabgyjfh00003968qycsq3ld\ufea3.inputs\u39fc.#:baz!!!', true],
-		// not matching new oids
-		['items/clabgyjfh00003968qycsq3ld', false],
-		['items/clabgyjfh00003968qycsq3ld:baz', false],
-		['items/clabgyjfh00003968qycsq3ld:baz1111', false],
-		// not matching anything else
-		[
-			'PREPARE SOUS VIDE BATH: Fill container or pot with water. Set the temperature to 130F/54.4C – 132F/55.5C (for very moist and tender) and allow water to heat to that temperature.Tip: start with hot tap water instead of cold water to reduce heating time. Note 4 for other temperatures.',
-			false,
-		],
-	])('matches legacy oids', (oid, match) => {
-		expect(MATCH_LEGACY_OID_JSON_STRING.test('"' + oid + '"'), oid).toBe(match);
-		// regex are stateful 🙄
-		MATCH_LEGACY_OID_JSON_STRING.lastIndex = 0;
-	});
-	it.each([
-		[
-			{ op: 'delete', oid: 'items/clabgyjfh00003968qycsq3ld.inputs.#:baz' },
-			{ op: 'delete', oid: 'items/clabgyjfh00003968qycsq3ld:baz' },
-		],
-		[
-			{
-				op: 'list-push',
-				oid: 'items/clabgyjfh00003968qycsq3ld.inputs.#:baz',
-				value: {
-					'@@type': 'ref',
-					id: 'items/clabgyjfh00003968qycsq3ld.inputs.#:qux',
-				},
-			},
-			{
-				op: 'list-push',
-				oid: 'items/clabgyjfh00003968qycsq3ld:baz',
-				value: { '@@type': 'ref', id: 'items/clabgyjfh00003968qycsq3ld:qux' },
-			},
-		],
-		[
-			{
-				op: 'list-remove',
-				oid: 'items/clabgyjfh00003968qycsq3ld.inputs.#:baz',
-				value: {
-					'@@type': 'ref',
-					id: 'items/clabgyjfh00003968qycsq3ld.inputs.#:qux',
-				},
-			},
-			{
-				op: 'list-remove',
-				oid: 'items/clabgyjfh00003968qycsq3ld:baz',
-				value: { '@@type': 'ref', id: 'items/clabgyjfh00003968qycsq3ld:qux' },
-			},
-		],
-		[
-			{
-				oid: 'items/clabgyjfh00003968qycsq3ld.inputs.#:baz',
-				timestamp: '2021-03-04T21:00:00.000Z',
-				snapshot: {
-					foo: 1,
-					bar: {
-						'@@type': 'ref',
-						id: 'items/clabgyjfh00003968qycsq3ld.inputs.#:qux',
-					},
-				},
-			},
-			{
-				oid: 'items/clabgyjfh00003968qycsq3ld:baz',
-				timestamp: '2021-03-04T21:00:00.000Z',
-				snapshot: {
-					foo: 1,
-					bar: { '@@type': 'ref', id: 'items/clabgyjfh00003968qycsq3ld:qux' },
-				},
-			},
-		],
-		[
-			{ oid: 'test/what if.boo.blah so what:fajsdfj' },
-			{ oid: 'test/what if:fajsdfj' },
-		],
-	])(
-		'should replace legacy OIDs in a JSON string with new OIDs',
-		(from, to) => {
-			expect(replaceLegacyOidsInObject(from), JSON.stringify(from)).toEqual(to);
-		},
-	);
-});