@dxos/context 0.1.2 → 0.1.16

package/LICENSE

@@ -1,21 +1,8 @@
-MIT License
+MIT License 
+Copyright (c) 2022 DXOS
 
-Copyright (c) 2022 DXOS.org
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/lib/browser/index.mjs

@@ -0,0 +1,96 @@
+// packages/common/context/src/context.ts
+import { log } from "@dxos/log";
+import { safeInstanceof } from "@dxos/util";
+var __decorate = function(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
+    r = Reflect.decorate(decorators, target, key, desc);
+  else
+    for (var i = decorators.length - 1; i >= 0; i--)
+      if (d = decorators[i])
+        r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var Context = class Context1 {
+  constructor({ onError = (error) => {
+    void this.dispose();
+    throw error;
+  } } = {}) {
+    this._disposeCallbacks = [];
+    this._isDisposed = false;
+    this._onError = onError;
+  }
+  get disposed() {
+    return this._isDisposed;
+  }
+  onDispose(callback) {
+    if (this._isDisposed) {
+      throw new Error("Context is already disposed");
+    }
+    this._disposeCallbacks.push(callback);
+  }
+  dispose() {
+    if (this._disposePromise) {
+      return this._disposePromise;
+    }
+    this._isDisposed = true;
+    const promises = [];
+    for (const callback of this._disposeCallbacks.reverse()) {
+      promises.push((async () => {
+        try {
+          await callback();
+        } catch (error) {
+          log.catch(error, {}, {
+            file: "/home/runner/work/dxos/dxos/packages/common/context/src/context.ts",
+            line: 72,
+            scope: this,
+            callSite: (f, a) => f(...a)
+          });
+        }
+      })());
+    }
+    this._disposeCallbacks.length = 0;
+    return this._disposePromise = Promise.all(promises).then(() => {
+    });
+  }
+  raise(error) {
+    if (this._isDisposed) {
+      log.warn("Error in disposed context", error, {
+        file: "/home/runner/work/dxos/dxos/packages/common/context/src/context.ts",
+        line: 89,
+        scope: this,
+        callSite: (f, a) => f(...a)
+      });
+      return;
+    }
+    try {
+      this._onError(error);
+    } catch (err) {
+      void Promise.reject(err);
+    }
+  }
+  derive({ onError }) {
+    const newCtx = new Context({
+      onError: async (error) => {
+        if (!onError) {
+          this.raise(error);
+        } else {
+          try {
+            await onError(error);
+          } catch (e) {
+            this.raise(error);
+          }
+        }
+      }
+    });
+    this.onDispose(() => newCtx.dispose());
+    return newCtx;
+  }
+};
+Context = __decorate([
+  safeInstanceof("Context")
+], Context);
+export {
+  Context
+};
+//# sourceMappingURL=index.mjs.map

package/dist/lib/browser/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/home/runner/work/dxos/dxos/packages/common/context/src/context.ts"],
+  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { log } from '@dxos/log';\nimport { safeInstanceof } from '@dxos/util';\n\nexport type ContextErrorHandler = (error: Error) => void;\n\nexport type DisposeCallback = () => void | Promise<void>;\n\nexport type CreateContextParams = {\n  onError?: ContextErrorHandler;\n};\n\n@safeInstanceof('Context')\nexport class Context {\n  private readonly _onError: ContextErrorHandler;\n  private readonly _disposeCallbacks: DisposeCallback[] = [];\n  private _isDisposed = false;\n  private _disposePromise?: Promise<void>;\n\n  constructor({\n    onError = (error) => {\n      void this.dispose();\n\n      // Will generate an unhandled rejection.\n      throw error;\n    }\n  }: CreateContextParams = {}) {\n    this._onError = onError;\n  }\n\n  get disposed() {\n    return this._isDisposed;\n  }\n\n  /**\n   * Schedules a callback to run when the context is disposed.\n   * May be async, in this case the disposer might choose to wait for all resource to released.\n   * Throwing an error inside the callback will result in the error being logged, but not re-thrown.\n   */\n  onDispose(callback: DisposeCallback) {\n    if (this._isDisposed) {\n      throw new Error('Context is already disposed');\n    }\n\n    this._disposeCallbacks.push(callback);\n  }\n\n  /**\n   * Runs all dispose callbacks.\n   * Sync callbacks are run in the reverse order they were added.\n   * Async callbacks are run in parallel.\n   * This function never throws.\n   * It is safe to ignore the returned promise if the caller does not wish to wait for callbacks to complete.\n   * Disposing context means that onDispose will throw an error and any errors raised will be logged and not propagated.\n   */\n  dispose(): Promise<void> {\n    if (this._disposePromise) {\n      return this._disposePromise;\n    }\n    this._isDisposed = true;\n\n    const promises = [];\n    for (const callback of this._disposeCallbacks.reverse()) {\n      promises.push(\n        (async () => {\n          try {\n            await callback();\n          } catch (error: any) {\n            log.catch(error);\n          }\n        })()\n      );\n    }\n    this._disposeCallbacks.length = 0;\n\n    return (this._disposePromise = Promise.all(promises).then(() => {}));\n  }\n\n  /**\n   * Raise the error inside the context.\n   * The error will be propagated to the error handler.\n   * IF the error handler is not set, the error will dispose the context and cause an unhandled rejection.\n   */\n  raise(error: Error): void {\n    if (this._isDisposed) {\n      log.warn('Error in disposed context', error);\n      return;\n    }\n\n    try {\n      this._onError(error);\n    } catch (err) {\n      // Generate an unhandled rejection and stop the error propagation.\n      void Promise.reject(err);\n    }\n  }\n\n  derive({ onError }: CreateContextParams): Context {\n    const newCtx = new Context({\n      onError: async (error) => {\n        if (!onError) {\n          this.raise(error);\n        } else {\n          try {\n            await onError(error);\n          } catch {\n            this.raise(error);\n          }\n        }\n      }\n    });\n    this.onDispose(() => newCtx.dispose());\n    return newCtx;\n  }\n}\n"],
+  "mappings": ";AAIA,SAASA,WAAW;AACpB,SAASC,sBAAsB;AAD/B,IAAA,aAAA,SAAA,YAAA,QAAA,KAAA,MAAA;;;;;;;;;;AAYA,IAAaC,UAAN,MAAA,SAAA;EAMLC,YAAY,EACVC,UAAU,CAACC,UAAU;AACnB,SAAK,KAAKC,QAAO;AAGjB,UAAMD;EACR,EAAC,IACsB,CAAC,GAAG;AAXZE,6BAAuC,CAAA;AAChDC,uBAAc;AAWpB,SAAKC,WAAWL;EAClB;EAEA,IAAIM,WAAW;AACb,WAAO,KAAKF;EACd;EAOAG,UAAUC,UAA2B;AACnC,QAAI,KAAKJ,aAAa;AACpB,YAAM,IAAIK,MAAM,6BAAA;IAClB;AAEA,SAAKN,kBAAkBO,KAAKF,QAAAA;EAC9B;EAUAN,UAAyB;AACvB,QAAI,KAAKS,iBAAiB;AACxB,aAAO,KAAKA;IACd;AACA,SAAKP,cAAc;AAEnB,UAAMQ,WAAW,CAAA;AACjB,eAAWJ,YAAY,KAAKL,kBAAkBU,QAAO,GAAI;AACvDD,eAASF,MACN,YAAY;AACX,YAAI;AACF,gBAAMF,SAAAA;QACR,SAASP,OAAP;AACAL,cAAIkB,MAAMb,OAAAA,CAAAA,GAAAA;;;;;;QACZ;MACF,GAAA,CAAA;IAEJ;AACA,SAAKE,kBAAkBY,SAAS;AAEhC,WAAQ,KAAKJ,kBAAkBK,QAAQC,IAAIL,QAAAA,EAAUM,KAAK,MAAM;IAAC,CAAA;EACnE;EAOAC,MAAMlB,OAAoB;AACxB,QAAI,KAAKG,aAAa;AACpBR,UAAIwB,KAAK,6BAA6BnB,OAAAA;;;;;;AACtC;IACF;AAEA,QAAI;AACF,WAAKI,SAASJ,KAAAA;IAChB,SAASoB,KAAP;AAEA,WAAKL,QAAQM,OAAOD,GAAAA;IACtB;EACF;EAEAE,OAAO,EAAEvB,QAAO,GAAkC;AAChD,UAAMwB,SAAS,IAAI1B,QAAQ;MACzBE,SAAS,OAAOC,UAAU;AACxB,YAAI,CAACD,SAAS;AACZ,eAAKmB,MAAMlB,KAAAA;QACb,OAAO;AACL,cAAI;AACF,kBAAMD,QAAQC,KAAAA;UAChB,SAAQ,GAAN;AACA,iBAAKkB,MAAMlB,KAAAA;UACb;QACF;MACF;IACF,CAAA;AACA,SAAKM,UAAU,MAAMiB,OAAOtB,QAAO,CAAA;AACnC,WAAOsB;EACT;AACF;AArGa1B,UAAAA,WAAAA;EADZD,eAAe,SAAA;GACHC,OAAAA;",
+  "names": ["log", "safeInstanceof", "Context", "constructor", "onError", "error", "dispose", "_disposeCallbacks", "_isDisposed", "_onError", "disposed", "onDispose", "callback", "Error", "push", "_disposePromise", "promises", "reverse", "catch", "length", "Promise", "all", "then", "raise", "warn", "err", "reject", "derive", "newCtx"]
+}

package/dist/lib/browser/meta.json

@@ -0,0 +1 @@
+{"inputs":{"packages/common/context/src/context.ts":{"bytes":11074,"imports":[]},"packages/common/context/src/index.ts":{"bytes":447,"imports":[{"path":"packages/common/context/src/context.ts","kind":"import-statement"}]}},"outputs":{"packages/common/context/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5050},"packages/common/context/dist/lib/browser/index.mjs":{"imports":[],"exports":["Context"],"entryPoint":"packages/common/context/src/index.ts","inputs":{"packages/common/context/src/context.ts":{"bytesInOutput":2570},"packages/common/context/src/index.ts":{"bytesInOutput":0}},"bytes":2669}}}

package/dist/lib/node/index.cjs

@@ -0,0 +1,123 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/common/context/src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Context: () => Context
+});
+module.exports = __toCommonJS(src_exports);
+
+// packages/common/context/src/context.ts
+var import_log = require("@dxos/log");
+var import_util = require("@dxos/util");
+var __decorate = function(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
+    r = Reflect.decorate(decorators, target, key, desc);
+  else
+    for (var i = decorators.length - 1; i >= 0; i--)
+      if (d = decorators[i])
+        r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var Context = class Context1 {
+  constructor({ onError = (error) => {
+    void this.dispose();
+    throw error;
+  } } = {}) {
+    this._disposeCallbacks = [];
+    this._isDisposed = false;
+    this._onError = onError;
+  }
+  get disposed() {
+    return this._isDisposed;
+  }
+  onDispose(callback) {
+    if (this._isDisposed) {
+      throw new Error("Context is already disposed");
+    }
+    this._disposeCallbacks.push(callback);
+  }
+  dispose() {
+    if (this._disposePromise) {
+      return this._disposePromise;
+    }
+    this._isDisposed = true;
+    const promises = [];
+    for (const callback of this._disposeCallbacks.reverse()) {
+      promises.push((async () => {
+        try {
+          await callback();
+        } catch (error) {
+          import_log.log.catch(error, {}, {
+            file: "/home/runner/work/dxos/dxos/packages/common/context/src/context.ts",
+            line: 72,
+            scope: this,
+            callSite: (f, a) => f(...a)
+          });
+        }
+      })());
+    }
+    this._disposeCallbacks.length = 0;
+    return this._disposePromise = Promise.all(promises).then(() => {
+    });
+  }
+  raise(error) {
+    if (this._isDisposed) {
+      import_log.log.warn("Error in disposed context", error, {
+        file: "/home/runner/work/dxos/dxos/packages/common/context/src/context.ts",
+        line: 89,
+        scope: this,
+        callSite: (f, a) => f(...a)
+      });
+      return;
+    }
+    try {
+      this._onError(error);
+    } catch (err) {
+      void Promise.reject(err);
+    }
+  }
+  derive({ onError }) {
+    const newCtx = new Context({
+      onError: async (error) => {
+        if (!onError) {
+          this.raise(error);
+        } else {
+          try {
+            await onError(error);
+          } catch (e) {
+            this.raise(error);
+          }
+        }
+      }
+    });
+    this.onDispose(() => newCtx.dispose());
+    return newCtx;
+  }
+};
+Context = __decorate([
+  (0, import_util.safeInstanceof)("Context")
+], Context);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Context
+});
+//# sourceMappingURL=index.cjs.map

package/dist/lib/node/index.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/home/runner/work/dxos/dxos/packages/common/context/src/index.ts", "../../../src/home/runner/work/dxos/dxos/packages/common/context/src/context.ts"],
+  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nexport * from './context';\n", "//\n// Copyright 2022 DXOS.org\n//\n\nimport { log } from '@dxos/log';\nimport { safeInstanceof } from '@dxos/util';\n\nexport type ContextErrorHandler = (error: Error) => void;\n\nexport type DisposeCallback = () => void | Promise<void>;\n\nexport type CreateContextParams = {\n  onError?: ContextErrorHandler;\n};\n\n@safeInstanceof('Context')\nexport class Context {\n  private readonly _onError: ContextErrorHandler;\n  private readonly _disposeCallbacks: DisposeCallback[] = [];\n  private _isDisposed = false;\n  private _disposePromise?: Promise<void>;\n\n  constructor({\n    onError = (error) => {\n      void this.dispose();\n\n      // Will generate an unhandled rejection.\n      throw error;\n    }\n  }: CreateContextParams = {}) {\n    this._onError = onError;\n  }\n\n  get disposed() {\n    return this._isDisposed;\n  }\n\n  /**\n   * Schedules a callback to run when the context is disposed.\n   * May be async, in this case the disposer might choose to wait for all resource to released.\n   * Throwing an error inside the callback will result in the error being logged, but not re-thrown.\n   */\n  onDispose(callback: DisposeCallback) {\n    if (this._isDisposed) {\n      throw new Error('Context is already disposed');\n    }\n\n    this._disposeCallbacks.push(callback);\n  }\n\n  /**\n   * Runs all dispose callbacks.\n   * Sync callbacks are run in the reverse order they were added.\n   * Async callbacks are run in parallel.\n   * This function never throws.\n   * It is safe to ignore the returned promise if the caller does not wish to wait for callbacks to complete.\n   * Disposing context means that onDispose will throw an error and any errors raised will be logged and not propagated.\n   */\n  dispose(): Promise<void> {\n    if (this._disposePromise) {\n      return this._disposePromise;\n    }\n    this._isDisposed = true;\n\n    const promises = [];\n    for (const callback of this._disposeCallbacks.reverse()) {\n      promises.push(\n        (async () => {\n          try {\n            await callback();\n          } catch (error: any) {\n            log.catch(error);\n          }\n        })()\n      );\n    }\n    this._disposeCallbacks.length = 0;\n\n    return (this._disposePromise = Promise.all(promises).then(() => {}));\n  }\n\n  /**\n   * Raise the error inside the context.\n   * The error will be propagated to the error handler.\n   * IF the error handler is not set, the error will dispose the context and cause an unhandled rejection.\n   */\n  raise(error: Error): void {\n    if (this._isDisposed) {\n      log.warn('Error in disposed context', error);\n      return;\n    }\n\n    try {\n      this._onError(error);\n    } catch (err) {\n      // Generate an unhandled rejection and stop the error propagation.\n      void Promise.reject(err);\n    }\n  }\n\n  derive({ onError }: CreateContextParams): Context {\n    const newCtx = new Context({\n      onError: async (error) => {\n        if (!onError) {\n          this.raise(error);\n        } else {\n          try {\n            await onError(error);\n          } catch {\n            this.raise(error);\n          }\n        }\n      }\n    });\n    this.onDispose(() => newCtx.dispose());\n    return newCtx;\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;ACIA,iBAAoB;AACpB,kBAA+B;AAD/B,IAAA,aAAA,SAAA,YAAA,QAAA,KAAA,MAAA;;;;;;;;;;AAYA,IAAaA,UAAN,MAAA,SAAA;EAMLC,YAAY,EACVC,UAAU,CAACC,UAAU;AACnB,SAAK,KAAKC,QAAO;AAGjB,UAAMD;EACR,EAAC,IACsB,CAAC,GAAG;AAXZE,6BAAuC,CAAA;AAChDC,uBAAc;AAWpB,SAAKC,WAAWL;EAClB;EAEA,IAAIM,WAAW;AACb,WAAO,KAAKF;EACd;EAOAG,UAAUC,UAA2B;AACnC,QAAI,KAAKJ,aAAa;AACpB,YAAM,IAAIK,MAAM,6BAAA;IAClB;AAEA,SAAKN,kBAAkBO,KAAKF,QAAAA;EAC9B;EAUAN,UAAyB;AACvB,QAAI,KAAKS,iBAAiB;AACxB,aAAO,KAAKA;IACd;AACA,SAAKP,cAAc;AAEnB,UAAMQ,WAAW,CAAA;AACjB,eAAWJ,YAAY,KAAKL,kBAAkBU,QAAO,GAAI;AACvDD,eAASF,MACN,YAAY;AACX,YAAI;AACF,gBAAMF,SAAAA;QACR,SAASP,OAAP;AACAa,yBAAIC,MAAMd,OAAAA,CAAAA,GAAAA;;;;;;QACZ;MACF,GAAA,CAAA;IAEJ;AACA,SAAKE,kBAAkBa,SAAS;AAEhC,WAAQ,KAAKL,kBAAkBM,QAAQC,IAAIN,QAAAA,EAAUO,KAAK,MAAM;IAAC,CAAA;EACnE;EAOAC,MAAMnB,OAAoB;AACxB,QAAI,KAAKG,aAAa;AACpBU,qBAAIO,KAAK,6BAA6BpB,OAAAA;;;;;;AACtC;IACF;AAEA,QAAI;AACF,WAAKI,SAASJ,KAAAA;IAChB,SAASqB,KAAP;AAEA,WAAKL,QAAQM,OAAOD,GAAAA;IACtB;EACF;EAEAE,OAAO,EAAExB,QAAO,GAAkC;AAChD,UAAMyB,SAAS,IAAI3B,QAAQ;MACzBE,SAAS,OAAOC,UAAU;AACxB,YAAI,CAACD,SAAS;AACZ,eAAKoB,MAAMnB,KAAAA;QACb,OAAO;AACL,cAAI;AACF,kBAAMD,QAAQC,KAAAA;UAChB,SAAQ,GAAN;AACA,iBAAKmB,MAAMnB,KAAAA;UACb;QACF;MACF;IACF,CAAA;AACA,SAAKM,UAAU,MAAMkB,OAAOvB,QAAO,CAAA;AACnC,WAAOuB;EACT;AACF;AArGa3B,UAAAA,WAAAA;MADZ4B,4BAAe,SAAA;GACH5B,OAAAA;",
+  "names": ["Context", "constructor", "onError", "error", "dispose", "_disposeCallbacks", "_isDisposed", "_onError", "disposed", "onDispose", "callback", "Error", "push", "_disposePromise", "promises", "reverse", "log", "catch", "length", "Promise", "all", "then", "raise", "warn", "err", "reject", "derive", "newCtx", "safeInstanceof"]
+}

package/dist/lib/node/meta.json

@@ -0,0 +1 @@
+{"inputs":{"packages/common/context/src/context.ts":{"bytes":11074,"imports":[]},"packages/common/context/src/index.ts":{"bytes":447,"imports":[{"path":"packages/common/context/src/context.ts","kind":"import-statement"}]}},"outputs":{"packages/common/context/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5223},"packages/common/context/dist/lib/node/index.cjs":{"imports":[],"exports":[],"entryPoint":"packages/common/context/src/index.ts","inputs":{"packages/common/context/src/index.ts":{"bytesInOutput":119},"packages/common/context/src/context.ts":{"bytesInOutput":2611}},"bytes":3749}}}

package/dist/{src → types/src}/context.d.ts

@@ -4,15 +4,12 @@ export declare type CreateContextParams = {
     onError?: ContextErrorHandler;
 };
 export declare class Context {
-    private readonly _isContext;
-    /**
-     * Checks if the object is a context. Not susceptible to prototype duplication that could happen during bundling.
-     */
-    static isContext(value: unknown): value is Context;
     private readonly _onError;
     private readonly _disposeCallbacks;
     private _isDisposed;
+    private _disposePromise?;
     constructor({ onError }?: CreateContextParams);
+    get disposed(): boolean;
     /**
      * Schedules a callback to run when the context is disposed.
      * May be async, in this case the disposer might choose to wait for all resource to released.

package/dist/types/src/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/context.ts"],"names":[],"mappings":"AAOA,oBAAY,mBAAmB,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;AAEzD,oBAAY,eAAe,GAAG,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzD,oBAAY,mBAAmB,GAAG;IAChC,OAAO,CAAC,EAAE,mBAAmB,CAAC;CAC/B,CAAC;AAEF,qBACa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAsB;IAC/C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAyB;IAC3D,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,eAAe,CAAC,CAAgB;gBAE5B,EACV,OAKC,EACF,GAAE,mBAAwB;IAI3B,IAAI,QAAQ,YAEX;IAED;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,eAAe;IAQnC;;;;;;;OAOG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBxB;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAczB,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE,mBAAmB,GAAG,OAAO;CAiBlD"}

package/dist/{src → types/src}/context.test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"context.test.d.ts","sourceRoot":"","sources":["../../src/context.test.ts"],"names":[],"mappings":""}
+{"version":3,"file":"context.test.d.ts","sourceRoot":"","sources":["../../../src/context.test.ts"],"names":[],"mappings":""}

package/dist/types/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,WAAW,CAAC"}

package/package.json

@@ -1,24 +1,25 @@
 {
   "name": "@dxos/context",
-  "version": "0.1.2",
+  "version": "0.1.16",
   "description": "Async utils.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
   "license": "MIT",
   "author": "DXOS.org",
-  "main": "dist/src/index.js",
-  "types": "dist/src/index.d.ts",
+  "main": "dist/lib/node/index.cjs",
+  "browser": {
+    "./dist/lib/node/index.cjs": "./dist/lib/browser/index.mjs"
+  },
+  "types": "dist/types/src/index.d.ts",
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "@dxos/log": "0.1.3"
+    "@dxos/log": "0.1.16",
+    "@dxos/util": "0.1.16"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "scripts": {
-    "check": "true"
   }
 }

package/src/context.test.ts

@@ -4,10 +4,12 @@
 
 import expect from 'expect';
 
+import { describe, test } from '@dxos/test';
+
 import { Context } from './context';
 
-describe('Context', function () {
-  it('dispose calls dispose hooks', function () {
+describe('Context', () => {
+  test('dispose calls dispose hooks', () => {
     const ctx = new Context();
 
     let called = false;
@@ -19,11 +21,11 @@ describe('Context', function () {
     expect(called).toBeTruthy();
   });
 
-  it('dispose waits for async callbacks');
+  test('dispose waits for async callbacks', () => {});
 
-  it('error in dispose callbacks are not propagated');
+  test('error in dispose callbacks are not propagated', () => {});
 
-  it('raised errors are propagated to the error handler', function () {
+  test('raised errors are propagated to the error handler', () => {
     let error!: Error;
     const ctx = new Context({
       onError: (err) => {
@@ -35,12 +37,25 @@ describe('Context', function () {
     expect(error.message).toEqual('test');
   });
 
-  it('isContext', function () {
+  test('instanceof', () => {
     const ctx = new Context();
-    expect(Context.isContext(ctx)).toBeTruthy();
+    expect(ctx instanceof Context).toBeTruthy();
+
+    expect({} instanceof Context).toBeFalsy();
 
-    expect(Context.isContext({})).toBeFalsy();
+    expect((undefined as any) instanceof Context).toBeFalsy();
+  });
 
-    expect(Context.isContext(undefined)).toBeFalsy();
+  test('dispose is idempotent', () => {
+    const ctx = new Context();
+
+    let called = false;
+    ctx.onDispose(() => {
+      called = true;
+    });
+
+    void ctx.dispose();
+    void ctx.dispose();
+    expect(called).toBeTruthy();
   });
 });

package/src/context.ts

@@ -3,6 +3,7 @@
 //
 
 import { log } from '@dxos/log';
+import { safeInstanceof } from '@dxos/util';
 
 export type ContextErrorHandler = (error: Error) => void;
 
@@ -12,20 +13,12 @@ export type CreateContextParams = {
   onError?: ContextErrorHandler;
 };
 
+@safeInstanceof('Context')
 export class Context {
-  // Marker for the isContext method.
-  private readonly _isContext = true;
-
-  /**
-   * Checks if the object is a context. Not susceptible to prototype duplication that could happen during bundling.
-   */
-  static isContext(value: unknown): value is Context {
-    return (value as Context)?._isContext === true;
-  }
-
   private readonly _onError: ContextErrorHandler;
   private readonly _disposeCallbacks: DisposeCallback[] = [];
   private _isDisposed = false;
+  private _disposePromise?: Promise<void>;
 
   constructor({
     onError = (error) => {
@@ -38,6 +31,10 @@ export class Context {
     this._onError = onError;
   }
 
+  get disposed() {
+    return this._isDisposed;
+  }
+
   /**
    * Schedules a callback to run when the context is disposed.
    * May be async, in this case the disposer might choose to wait for all resource to released.
@@ -60,8 +57,8 @@ export class Context {
    * Disposing context means that onDispose will throw an error and any errors raised will be logged and not propagated.
    */
   dispose(): Promise<void> {
-    if (this._isDisposed) {
-      throw new Error('Context is already disposed');
+    if (this._disposePromise) {
+      return this._disposePromise;
     }
     this._isDisposed = true;
 
@@ -79,7 +76,7 @@ export class Context {
     }
     this._disposeCallbacks.length = 0;
 
-    return Promise.all(promises).then(() => {});
+    return (this._disposePromise = Promise.all(promises).then(() => {}));
   }
 
   /**
@@ -89,7 +86,7 @@ export class Context {
    */
   raise(error: Error): void {
     if (this._isDisposed) {
-      log.error(`Error in disposed context: ${error}`);
+      log.warn('Error in disposed context', error);
       return;
     }
 

package/dist/src/context.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/context.ts"],"names":[],"mappings":"AAMA,oBAAY,mBAAmB,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;AAEzD,oBAAY,eAAe,GAAG,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzD,oBAAY,mBAAmB,GAAG;IAChC,OAAO,CAAC,EAAE,mBAAmB,CAAC;CAC/B,CAAC;AAEF,qBAAa,OAAO;IAElB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IAEnC;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO;IAIlD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAsB;IAC/C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAyB;IAC3D,OAAO,CAAC,WAAW,CAAS;gBAEhB,EACV,OAKC,EACF,GAAE,mBAAwB;IAI3B;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,eAAe;IAQnC;;;;;;;OAOG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBxB;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAczB,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE,mBAAmB,GAAG,OAAO;CAiBlD"}

package/dist/src/context.js

@@ -1,103 +0,0 @@
-"use strict";
-//
-// Copyright 2022 DXOS.org
-//
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Context = void 0;
-const log_1 = require("@dxos/log");
-class Context {
-    constructor({ onError = (error) => {
-        void this.dispose();
-        // Will generate an unhandled rejection.
-        throw error;
-    } } = {}) {
-        // Marker for the isContext method.
-        this._isContext = true;
-        this._disposeCallbacks = [];
-        this._isDisposed = false;
-        this._onError = onError;
-    }
-    /**
-     * Checks if the object is a context. Not susceptible to prototype duplication that could happen during bundling.
-     */
-    static isContext(value) {
-        return (value === null || value === void 0 ? void 0 : value._isContext) === true;
-    }
-    /**
-     * Schedules a callback to run when the context is disposed.
-     * May be async, in this case the disposer might choose to wait for all resource to released.
-     * Throwing an error inside the callback will result in the error being logged, but not re-thrown.
-     */
-    onDispose(callback) {
-        if (this._isDisposed) {
-            throw new Error('Context is already disposed');
-        }
-        this._disposeCallbacks.push(callback);
-    }
-    /**
-     * Runs all dispose callbacks.
-     * Sync callbacks are run in the reverse order they were added.
-     * Async callbacks are run in parallel.
-     * This function never throws.
-     * It is safe to ignore the returned promise if the caller does not wish to wait for callbacks to complete.
-     * Disposing context means that onDispose will throw an error and any errors raised will be logged and not propagated.
-     */
-    dispose() {
-        if (this._isDisposed) {
-            throw new Error('Context is already disposed');
-        }
-        this._isDisposed = true;
-        const promises = [];
-        for (const callback of this._disposeCallbacks.reverse()) {
-            promises.push((async () => {
-                try {
-                    await callback();
-                }
-                catch (error) {
-                    log_1.log.catch(error, {}, { file: "packages/common/context/src/context.ts", line: 75 });
-                }
-            })());
-        }
-        this._disposeCallbacks.length = 0;
-        return Promise.all(promises).then(() => { });
-    }
-    /**
-     * Raise the error inside the context.
-     * The error will be propagated to the error handler.
-     * IF the error handler is not set, the error will dispose the context and cause an unhandled rejection.
-     */
-    raise(error) {
-        if (this._isDisposed) {
-            log_1.log.error(`Error in disposed context: ${error}`, {}, { file: "packages/common/context/src/context.ts", line: 92 });
-            return;
-        }
-        try {
-            this._onError(error);
-        }
-        catch (err) {
-            // Generate an unhandled rejection and stop the error propagation.
-            void Promise.reject(err);
-        }
-    }
-    derive({ onError }) {
-        const newCtx = new Context({
-            onError: async (error) => {
-                if (!onError) {
-                    this.raise(error);
-                }
-                else {
-                    try {
-                        await onError(error);
-                    }
-                    catch (_a) {
-                        this.raise(error);
-                    }
-                }
-            }
-        });
-        this.onDispose(() => newCtx.dispose());
-        return newCtx;
-    }
-}
-exports.Context = Context;
-//# sourceMappingURL=context.js.map

package/dist/src/context.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/context.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;;AAEF,mCAAgC;AAUhC,MAAa,OAAO;IAelB,YAAY,EACV,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE;QAClB,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;QAEpB,wCAAwC;QACxC,MAAM,KAAK,CAAC;IACd,CAAC,KACsB,EAAE;QArB3B,mCAAmC;QAClB,eAAU,GAAG,IAAI,CAAC;QAUlB,sBAAiB,GAAsB,EAAE,CAAC;QACnD,gBAAW,GAAG,KAAK,CAAC;QAU1B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IApBD;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,KAAc;QAC7B,OAAO,CAAC,KAAiB,aAAjB,KAAK,uBAAL,KAAK,CAAc,UAAU,MAAK,IAAI,CAAC;IACjD,CAAC;IAiBD;;;;OAIG;IACH,SAAS,CAAC,QAAyB;QACjC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;SAChD;QAED,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;SAChD;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAExB,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,EAAE;YACvD,QAAQ,CAAC,IAAI,CACX,CAAC,KAAK,IAAI,EAAE;gBACV,IAAI;oBACF,MAAM,QAAQ,EAAE,CAAC;iBAClB;gBAAC,OAAO,KAAU,EAAE;oBACnB,SAAG,CAAC,KAAK,CAAC,KAAK,mEAAC,CAAC;iBAClB;YACH,CAAC,CAAC,EAAE,CACL,CAAC;SACH;QACD,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;QAElC,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAY;QAChB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,SAAG,CAAC,KAAK,CAAC,8BAA8B,KAAK,EAAE,mEAAC,CAAC;YACjD,OAAO;SACR;QAED,IAAI;YACF,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SACtB;QAAC,OAAO,GAAG,EAAE;YACZ,kEAAkE;YAClE,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC1B;IACH,CAAC;IAED,MAAM,CAAC,EAAE,OAAO,EAAuB;QACrC,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC;YACzB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;gBACvB,IAAI,CAAC,OAAO,EAAE;oBACZ,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBACnB;qBAAM;oBACL,IAAI;wBACF,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;qBACtB;oBAAC,WAAM;wBACN,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;qBACnB;iBACF;YACH,CAAC;SACF,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QACvC,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA1GD,0BA0GC"}

package/dist/src/context.test.js

@@ -1,40 +0,0 @@
-"use strict";
-//
-// Copyright 2022 DXOS.org
-//
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const expect_1 = __importDefault(require("expect"));
-const context_1 = require("./context");
-describe('Context', function () {
-    it('dispose calls dispose hooks', function () {
-        const ctx = new context_1.Context();
-        let called = false;
-        ctx.onDispose(() => {
-            called = true;
-        });
-        void ctx.dispose();
-        (0, expect_1.default)(called).toBeTruthy();
-    });
-    it('dispose waits for async callbacks');
-    it('error in dispose callbacks are not propagated');
-    it('raised errors are propagated to the error handler', function () {
-        let error;
-        const ctx = new context_1.Context({
-            onError: (err) => {
-                error = err;
-            }
-        });
-        ctx.raise(new Error('test'));
-        (0, expect_1.default)(error.message).toEqual('test');
-    });
-    it('isContext', function () {
-        const ctx = new context_1.Context();
-        (0, expect_1.default)(context_1.Context.isContext(ctx)).toBeTruthy();
-        (0, expect_1.default)(context_1.Context.isContext({})).toBeFalsy();
-        (0, expect_1.default)(context_1.Context.isContext(undefined)).toBeFalsy();
-    });
-});
-//# sourceMappingURL=context.test.js.map

package/dist/src/context.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"context.test.js","sourceRoot":"","sources":["../../src/context.test.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;;;;AAEF,oDAA4B;AAE5B,uCAAoC;AAEpC,QAAQ,CAAC,SAAS,EAAE;IAClB,EAAE,CAAC,6BAA6B,EAAE;QAChC,MAAM,GAAG,GAAG,IAAI,iBAAO,EAAE,CAAC;QAE1B,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE;YACjB,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC;QACnB,IAAA,gBAAM,EAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,CAAC,CAAC;IAExC,EAAE,CAAC,+CAA+C,CAAC,CAAC;IAEpD,EAAE,CAAC,mDAAmD,EAAE;QACtD,IAAI,KAAa,CAAC;QAClB,MAAM,GAAG,GAAG,IAAI,iBAAO,CAAC;YACtB,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACf,KAAK,GAAG,GAAG,CAAC;YACd,CAAC;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7B,IAAA,gBAAM,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,WAAW,EAAE;QACd,MAAM,GAAG,GAAG,IAAI,iBAAO,EAAE,CAAC;QAC1B,IAAA,gBAAM,EAAC,iBAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QAE5C,IAAA,gBAAM,EAAC,iBAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;QAE1C,IAAA,gBAAM,EAAC,iBAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;IACnD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,WAAW,CAAC"}

package/dist/src/index.js

@@ -1,21 +0,0 @@
-"use strict";
-//
-// Copyright 2022 DXOS.org
-//
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-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("./context"), exports);
-//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;;;;;;;;;;;;;;;AAEF,4CAA0B"}