@dxos/invariant 0.4.9 → 0.4.10-main.06ef97a

package/dist/lib/browser/index.mjs

@@ -3,6 +3,9 @@ var invariant = (condition, message, meta) => {
   if (condition) {
     return;
   }
+  if (message?.startsWith("BUG")) {
+    debugger;
+  }
   let errorMessage = "invariant violation";
   if (message) {
     errorMessage += `: ${message}`;

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/invariant.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type CallMetadata } from './meta';\n\nexport type InvariantFn = (condition: unknown, message?: string, meta?: CallMetadata) => asserts condition;\n\n/**\n * Asserts that the condition is true.\n *\n * @param message Optional message.\n */\nexport const invariant: InvariantFn = (\n  condition: unknown,\n  message?: string,\n  meta?: CallMetadata,\n): asserts condition => {\n  if (condition) {\n    return;\n  }\n\n  let errorMessage = 'invariant violation';\n\n  if (message) {\n    errorMessage += `: ${message}`;\n  }\n\n  if (meta?.A) {\n    errorMessage += ` [${meta.A[0]}]`;\n  }\n\n  if (meta?.F) {\n    errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;\n  }\n\n  throw new InvariantViolation(errorMessage);\n};\n\nexport class InvariantViolation extends Error {\n  constructor(message: string) {\n    super(message);\n    // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).\n    Object.setPrototypeOf(this, new.target.prototype);\n  }\n}\n\nconst getRelativeFilename = (filename: string) => {\n  // TODO(burdon): Hack uses \"packages\" as an anchor (pre-parse NX?)\n  // Including `packages/` part of the path so that excluded paths (e.g. from dist) are clickable in vscode.\n  const match = filename.match(/.+\\/(packages\\/.+\\/.+)/);\n  if (match) {\n    const [, filePath] = match;\n    return filePath;\n  }\n\n  return filename;\n};\n\nexport const failedInvariant = (message1?: unknown, message2?: string, meta?: CallMetadata): never => {\n  let errorMessage = 'invariant violation';\n\n  const message = [message1, message2].filter((str) => typeof str === 'string').join(' ');\n\n  if (message) {\n    errorMessage += `: ${message}`;\n  }\n\n  if (meta?.A) {\n    errorMessage += ` [${meta.A[0]}]`;\n  }\n\n  if (meta?.F) {\n    errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;\n  }\n\n  throw new InvariantViolation(errorMessage);\n};\n"],
-  "mappings": ";AAaO,IAAMA,YAAyB,CACpCC,WACAC,SACAC,SAAAA;AAEA,MAAIF,WAAW;AACb;EACF;AAEA,MAAIG,eAAe;AAEnB,MAAIF,SAAS;AACXE,oBAAgB,KAAKF,OAAAA;EACvB;AAEA,MAAIC,MAAME,GAAG;AACXD,oBAAgB,KAAKD,KAAKE,EAAE,CAAA,CAAE;EAChC;AAEA,MAAIF,MAAMG,GAAG;AACXF,oBAAgB,OAAOG,oBAAoBJ,KAAKG,CAAC,CAAA,IAAKH,KAAKK,CAAC;EAC9D;AAEA,QAAM,IAAIC,mBAAmBL,YAAAA;AAC/B;AAEO,IAAMK,qBAAN,cAAiCC,MAAAA;EACtCC,YAAYT,SAAiB;AAC3B,UAAMA,OAAAA;AAENU,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMP,sBAAsB,CAACQ,aAAAA;AAG3B,QAAMC,QAAQD,SAASC,MAAM,wBAAA;AAC7B,MAAIA,OAAO;AACT,UAAM,CAAA,EAAGC,QAAAA,IAAYD;AACrB,WAAOC;EACT;AAEA,SAAOF;AACT;AAEO,IAAMG,kBAAkB,CAACC,UAAoBC,UAAmBjB,SAAAA;AACrE,MAAIC,eAAe;AAEnB,QAAMF,UAAU;IAACiB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AAEnF,MAAIrB,SAAS;AACXE,oBAAgB,KAAKF,OAAAA;EACvB;AAEA,MAAIC,MAAME,GAAG;AACXD,oBAAgB,KAAKD,KAAKE,EAAE,CAAA,CAAE;EAChC;AAEA,MAAIF,MAAMG,GAAG;AACXF,oBAAgB,OAAOG,oBAAoBJ,KAAKG,CAAC,CAAA,IAAKH,KAAKK,CAAC;EAC9D;AAEA,QAAM,IAAIC,mBAAmBL,YAAAA;AAC/B;",
-  "names": ["invariant", "condition", "message", "meta", "errorMessage", "A", "F", "getRelativeFilename", "L", "InvariantViolation", "Error", "constructor", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join"]
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type CallMetadata } from './meta';\n\nexport type InvariantFn = (condition: unknown, message?: string, meta?: CallMetadata) => asserts condition;\n\n/**\n * Asserts that the condition is true.\n *\n * @param message Optional message. If it starts with \"BUG\" then the program will break if this invariant fails if the debugger is attached.\n */\nexport const invariant: InvariantFn = (\n  condition: unknown,\n  message?: string,\n  meta?: CallMetadata,\n): asserts condition => {\n  if (condition) {\n    return;\n  }\n\n  if (message?.startsWith('BUG')) {\n    // This invariant is a debug bug-check: break if the debugger is attached.\n    // eslint-disable-next-line no-debugger\n    debugger;\n  }\n\n  let errorMessage = 'invariant violation';\n\n  if (message) {\n    errorMessage += `: ${message}`;\n  }\n\n  if (meta?.A) {\n    errorMessage += ` [${meta.A[0]}]`;\n  }\n\n  if (meta?.F) {\n    errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;\n  }\n\n  throw new InvariantViolation(errorMessage);\n};\n\nexport class InvariantViolation extends Error {\n  constructor(message: string) {\n    super(message);\n    // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).\n    Object.setPrototypeOf(this, new.target.prototype);\n  }\n}\n\nconst getRelativeFilename = (filename: string) => {\n  // TODO(burdon): Hack uses \"packages\" as an anchor (pre-parse NX?)\n  // Including `packages/` part of the path so that excluded paths (e.g. from dist) are clickable in vscode.\n  const match = filename.match(/.+\\/(packages\\/.+\\/.+)/);\n  if (match) {\n    const [, filePath] = match;\n    return filePath;\n  }\n\n  return filename;\n};\n\nexport const failedInvariant = (message1?: unknown, message2?: string, meta?: CallMetadata): never => {\n  let errorMessage = 'invariant violation';\n\n  const message = [message1, message2].filter((str) => typeof str === 'string').join(' ');\n\n  if (message) {\n    errorMessage += `: ${message}`;\n  }\n\n  if (meta?.A) {\n    errorMessage += ` [${meta.A[0]}]`;\n  }\n\n  if (meta?.F) {\n    errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;\n  }\n\n  throw new InvariantViolation(errorMessage);\n};\n"],
+  "mappings": ";AAaO,IAAMA,YAAyB,CACpCC,WACAC,SACAC,SAAAA;AAEA,MAAIF,WAAW;AACb;EACF;AAEA,MAAIC,SAASE,WAAW,KAAA,GAAQ;AAG9B;EACF;AAEA,MAAIC,eAAe;AAEnB,MAAIH,SAAS;AACXG,oBAAgB,KAAKH,OAAAA;EACvB;AAEA,MAAIC,MAAMG,GAAG;AACXD,oBAAgB,KAAKF,KAAKG,EAAE,CAAA,CAAE;EAChC;AAEA,MAAIH,MAAMI,GAAG;AACXF,oBAAgB,OAAOG,oBAAoBL,KAAKI,CAAC,CAAA,IAAKJ,KAAKM,CAAC;EAC9D;AAEA,QAAM,IAAIC,mBAAmBL,YAAAA;AAC/B;AAEO,IAAMK,qBAAN,cAAiCC,MAAAA;EACtCC,YAAYV,SAAiB;AAC3B,UAAMA,OAAAA;AAENW,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMP,sBAAsB,CAACQ,aAAAA;AAG3B,QAAMC,QAAQD,SAASC,MAAM,wBAAA;AAC7B,MAAIA,OAAO;AACT,UAAM,CAAA,EAAGC,QAAAA,IAAYD;AACrB,WAAOC;EACT;AAEA,SAAOF;AACT;AAEO,IAAMG,kBAAkB,CAACC,UAAoBC,UAAmBlB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACkB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AAEnF,MAAItB,SAAS;AACXG,oBAAgB,KAAKH,OAAAA;EACvB;AAEA,MAAIC,MAAMG,GAAG;AACXD,oBAAgB,KAAKF,KAAKG,EAAE,CAAA,CAAE;EAChC;AAEA,MAAIH,MAAMI,GAAG;AACXF,oBAAgB,OAAOG,oBAAoBL,KAAKI,CAAC,CAAA,IAAKJ,KAAKM,CAAC;EAC9D;AAEA,QAAM,IAAIC,mBAAmBL,YAAAA;AAC/B;",
+  "names": ["invariant", "condition", "message", "meta", "startsWith", "errorMessage", "A", "F", "getRelativeFilename", "L", "InvariantViolation", "Error", "constructor", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join"]
 }

package/dist/lib/browser/meta.json

@@ -1 +1 @@
-{"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":6468,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":470,"imports":[{"path":"packages/common/invariant/src/invariant.ts","kind":"import-statement","original":"./invariant"}],"format":"esm"}},"outputs":{"packages/common/invariant/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":3330},"packages/common/invariant/dist/lib/browser/index.mjs":{"imports":[],"exports":["InvariantViolation","failedInvariant","invariant"],"entryPoint":"packages/common/invariant/src/index.ts","inputs":{"packages/common/invariant/src/invariant.ts":{"bytesInOutput":1186},"packages/common/invariant/src/index.ts":{"bytesInOutput":0}},"bytes":1332}}}
+{"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7262,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":470,"imports":[{"path":"packages/common/invariant/src/invariant.ts","kind":"import-statement","original":"./invariant"}],"format":"esm"}},"outputs":{"packages/common/invariant/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":3678},"packages/common/invariant/dist/lib/browser/index.mjs":{"imports":[],"exports":["InvariantViolation","failedInvariant","invariant"],"entryPoint":"packages/common/invariant/src/index.ts","inputs":{"packages/common/invariant/src/invariant.ts":{"bytesInOutput":1240},"packages/common/invariant/src/index.ts":{"bytesInOutput":0}},"bytes":1386}}}

package/dist/lib/node/index.cjs

@@ -27,6 +27,9 @@ var invariant = (condition, message, meta) => {
   if (condition) {
     return;
   }
+  if (message?.startsWith("BUG")) {
+    debugger;
+  }
   let errorMessage = "invariant violation";
   if (message) {
     errorMessage += `: ${message}`;

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/invariant.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type CallMetadata } from './meta';\n\nexport type InvariantFn = (condition: unknown, message?: string, meta?: CallMetadata) => asserts condition;\n\n/**\n * Asserts that the condition is true.\n *\n * @param message Optional message.\n */\nexport const invariant: InvariantFn = (\n  condition: unknown,\n  message?: string,\n  meta?: CallMetadata,\n): asserts condition => {\n  if (condition) {\n    return;\n  }\n\n  let errorMessage = 'invariant violation';\n\n  if (message) {\n    errorMessage += `: ${message}`;\n  }\n\n  if (meta?.A) {\n    errorMessage += ` [${meta.A[0]}]`;\n  }\n\n  if (meta?.F) {\n    errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;\n  }\n\n  throw new InvariantViolation(errorMessage);\n};\n\nexport class InvariantViolation extends Error {\n  constructor(message: string) {\n    super(message);\n    // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).\n    Object.setPrototypeOf(this, new.target.prototype);\n  }\n}\n\nconst getRelativeFilename = (filename: string) => {\n  // TODO(burdon): Hack uses \"packages\" as an anchor (pre-parse NX?)\n  // Including `packages/` part of the path so that excluded paths (e.g. from dist) are clickable in vscode.\n  const match = filename.match(/.+\\/(packages\\/.+\\/.+)/);\n  if (match) {\n    const [, filePath] = match;\n    return filePath;\n  }\n\n  return filename;\n};\n\nexport const failedInvariant = (message1?: unknown, message2?: string, meta?: CallMetadata): never => {\n  let errorMessage = 'invariant violation';\n\n  const message = [message1, message2].filter((str) => typeof str === 'string').join(' ');\n\n  if (message) {\n    errorMessage += `: ${message}`;\n  }\n\n  if (meta?.A) {\n    errorMessage += ` [${meta.A[0]}]`;\n  }\n\n  if (meta?.F) {\n    errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;\n  }\n\n  throw new InvariantViolation(errorMessage);\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;AAaO,IAAMA,YAAyB,CACpCC,WACAC,SACAC,SAAAA;AAEA,MAAIF,WAAW;AACb;EACF;AAEA,MAAIG,eAAe;AAEnB,MAAIF,SAAS;AACXE,oBAAgB,KAAKF,OAAAA;EACvB;AAEA,MAAIC,MAAME,GAAG;AACXD,oBAAgB,KAAKD,KAAKE,EAAE,CAAA,CAAE;EAChC;AAEA,MAAIF,MAAMG,GAAG;AACXF,oBAAgB,OAAOG,oBAAoBJ,KAAKG,CAAC,CAAA,IAAKH,KAAKK,CAAC;EAC9D;AAEA,QAAM,IAAIC,mBAAmBL,YAAAA;AAC/B;AAEO,IAAMK,qBAAN,cAAiCC,MAAAA;EACtCC,YAAYT,SAAiB;AAC3B,UAAMA,OAAAA;AAENU,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMP,sBAAsB,CAACQ,aAAAA;AAG3B,QAAMC,QAAQD,SAASC,MAAM,wBAAA;AAC7B,MAAIA,OAAO;AACT,UAAM,CAAA,EAAGC,QAAAA,IAAYD;AACrB,WAAOC;EACT;AAEA,SAAOF;AACT;AAEO,IAAMG,kBAAkB,CAACC,UAAoBC,UAAmBjB,SAAAA;AACrE,MAAIC,eAAe;AAEnB,QAAMF,UAAU;IAACiB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AAEnF,MAAIrB,SAAS;AACXE,oBAAgB,KAAKF,OAAAA;EACvB;AAEA,MAAIC,MAAME,GAAG;AACXD,oBAAgB,KAAKD,KAAKE,EAAE,CAAA,CAAE;EAChC;AAEA,MAAIF,MAAMG,GAAG;AACXF,oBAAgB,OAAOG,oBAAoBJ,KAAKG,CAAC,CAAA,IAAKH,KAAKK,CAAC;EAC9D;AAEA,QAAM,IAAIC,mBAAmBL,YAAAA;AAC/B;",
-  "names": ["invariant", "condition", "message", "meta", "errorMessage", "A", "F", "getRelativeFilename", "L", "InvariantViolation", "Error", "constructor", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join"]
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type CallMetadata } from './meta';\n\nexport type InvariantFn = (condition: unknown, message?: string, meta?: CallMetadata) => asserts condition;\n\n/**\n * Asserts that the condition is true.\n *\n * @param message Optional message. If it starts with \"BUG\" then the program will break if this invariant fails if the debugger is attached.\n */\nexport const invariant: InvariantFn = (\n  condition: unknown,\n  message?: string,\n  meta?: CallMetadata,\n): asserts condition => {\n  if (condition) {\n    return;\n  }\n\n  if (message?.startsWith('BUG')) {\n    // This invariant is a debug bug-check: break if the debugger is attached.\n    // eslint-disable-next-line no-debugger\n    debugger;\n  }\n\n  let errorMessage = 'invariant violation';\n\n  if (message) {\n    errorMessage += `: ${message}`;\n  }\n\n  if (meta?.A) {\n    errorMessage += ` [${meta.A[0]}]`;\n  }\n\n  if (meta?.F) {\n    errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;\n  }\n\n  throw new InvariantViolation(errorMessage);\n};\n\nexport class InvariantViolation extends Error {\n  constructor(message: string) {\n    super(message);\n    // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).\n    Object.setPrototypeOf(this, new.target.prototype);\n  }\n}\n\nconst getRelativeFilename = (filename: string) => {\n  // TODO(burdon): Hack uses \"packages\" as an anchor (pre-parse NX?)\n  // Including `packages/` part of the path so that excluded paths (e.g. from dist) are clickable in vscode.\n  const match = filename.match(/.+\\/(packages\\/.+\\/.+)/);\n  if (match) {\n    const [, filePath] = match;\n    return filePath;\n  }\n\n  return filename;\n};\n\nexport const failedInvariant = (message1?: unknown, message2?: string, meta?: CallMetadata): never => {\n  let errorMessage = 'invariant violation';\n\n  const message = [message1, message2].filter((str) => typeof str === 'string').join(' ');\n\n  if (message) {\n    errorMessage += `: ${message}`;\n  }\n\n  if (meta?.A) {\n    errorMessage += ` [${meta.A[0]}]`;\n  }\n\n  if (meta?.F) {\n    errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;\n  }\n\n  throw new InvariantViolation(errorMessage);\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;AAaO,IAAMA,YAAyB,CACpCC,WACAC,SACAC,SAAAA;AAEA,MAAIF,WAAW;AACb;EACF;AAEA,MAAIC,SAASE,WAAW,KAAA,GAAQ;AAG9B;EACF;AAEA,MAAIC,eAAe;AAEnB,MAAIH,SAAS;AACXG,oBAAgB,KAAKH,OAAAA;EACvB;AAEA,MAAIC,MAAMG,GAAG;AACXD,oBAAgB,KAAKF,KAAKG,EAAE,CAAA,CAAE;EAChC;AAEA,MAAIH,MAAMI,GAAG;AACXF,oBAAgB,OAAOG,oBAAoBL,KAAKI,CAAC,CAAA,IAAKJ,KAAKM,CAAC;EAC9D;AAEA,QAAM,IAAIC,mBAAmBL,YAAAA;AAC/B;AAEO,IAAMK,qBAAN,cAAiCC,MAAAA;EACtCC,YAAYV,SAAiB;AAC3B,UAAMA,OAAAA;AAENW,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMP,sBAAsB,CAACQ,aAAAA;AAG3B,QAAMC,QAAQD,SAASC,MAAM,wBAAA;AAC7B,MAAIA,OAAO;AACT,UAAM,CAAA,EAAGC,QAAAA,IAAYD;AACrB,WAAOC;EACT;AAEA,SAAOF;AACT;AAEO,IAAMG,kBAAkB,CAACC,UAAoBC,UAAmBlB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACkB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AAEnF,MAAItB,SAAS;AACXG,oBAAgB,KAAKH,OAAAA;EACvB;AAEA,MAAIC,MAAMG,GAAG;AACXD,oBAAgB,KAAKF,KAAKG,EAAE,CAAA,CAAE;EAChC;AAEA,MAAIH,MAAMI,GAAG;AACXF,oBAAgB,OAAOG,oBAAoBL,KAAKI,CAAC,CAAA,IAAKJ,KAAKM,CAAC;EAC9D;AAEA,QAAM,IAAIC,mBAAmBL,YAAAA;AAC/B;",
+  "names": ["invariant", "condition", "message", "meta", "startsWith", "errorMessage", "A", "F", "getRelativeFilename", "L", "InvariantViolation", "Error", "constructor", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join"]
 }

package/dist/lib/node/meta.json

@@ -1 +1 @@
-{"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":6468,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":470,"imports":[{"path":"packages/common/invariant/src/invariant.ts","kind":"import-statement","original":"./invariant"}],"format":"esm"}},"outputs":{"packages/common/invariant/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":3330},"packages/common/invariant/dist/lib/node/index.cjs":{"imports":[],"exports":["InvariantViolation","failedInvariant","invariant"],"entryPoint":"packages/common/invariant/src/index.ts","inputs":{"packages/common/invariant/src/invariant.ts":{"bytesInOutput":1186},"packages/common/invariant/src/index.ts":{"bytesInOutput":0}},"bytes":1332}}}
+{"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7262,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":470,"imports":[{"path":"packages/common/invariant/src/invariant.ts","kind":"import-statement","original":"./invariant"}],"format":"esm"}},"outputs":{"packages/common/invariant/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":3678},"packages/common/invariant/dist/lib/node/index.cjs":{"imports":[],"exports":["InvariantViolation","failedInvariant","invariant"],"entryPoint":"packages/common/invariant/src/index.ts","inputs":{"packages/common/invariant/src/invariant.ts":{"bytesInOutput":1240},"packages/common/invariant/src/index.ts":{"bytesInOutput":0}},"bytes":1386}}}

package/dist/types/src/invariant.d.ts

@@ -3,7 +3,7 @@ export type InvariantFn = (condition: unknown, message?: string, meta?: CallMeta
 /**
  * Asserts that the condition is true.
  *
- * @param message Optional message.
+ * @param message Optional message. If it starts with "BUG" then the program will break if this invariant fails if the debugger is attached.
  */
 export declare const invariant: InvariantFn;
 export declare class InvariantViolation extends Error {

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

@@ -1 +1 @@
-{"version":3,"file":"invariant.d.ts","sourceRoot":"","sources":["../../../src/invariant.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,QAAQ,CAAC;AAE3C,MAAM,MAAM,WAAW,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,SAAS,CAAC;AAE3G;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAAE,WAwBvB,CAAC;AAEF,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAK5B;AAcD,eAAO,MAAM,eAAe,cAAe,OAAO,aAAa,MAAM,SAAS,YAAY,KAAG,KAkB5F,CAAC"}
+{"version":3,"file":"invariant.d.ts","sourceRoot":"","sources":["../../../src/invariant.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,QAAQ,CAAC;AAE3C,MAAM,MAAM,WAAW,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,SAAS,CAAC;AAE3G;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAAE,WA8BvB,CAAC;AAEF,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAK5B;AAcD,eAAO,MAAM,eAAe,cAAe,OAAO,aAAa,MAAM,SAAS,YAAY,KAAG,KAkB5F,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/invariant",
-  "version": "0.4.9",
+  "version": "0.4.10-main.06ef97a",
   "description": "Invariant assertion compatible with DXOS logger.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -16,7 +16,7 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/node-std": "0.4.9"
+    "@dxos/node-std": "0.4.10-main.06ef97a"
   },
   "devDependencies": {
     "@types/node": "^18.11.9",

package/src/invariant.ts

@@ -9,7 +9,7 @@ export type InvariantFn = (condition: unknown, message?: string, meta?: CallMeta
 /**
  * Asserts that the condition is true.
  *
- * @param message Optional message.
+ * @param message Optional message. If it starts with "BUG" then the program will break if this invariant fails if the debugger is attached.
  */
 export const invariant: InvariantFn = (
   condition: unknown,
@@ -20,6 +20,12 @@ export const invariant: InvariantFn = (
     return;
   }
 
+  if (message?.startsWith('BUG')) {
+    // This invariant is a debug bug-check: break if the debugger is attached.
+    // eslint-disable-next-line no-debugger
+    debugger;
+  }
+
   let errorMessage = 'invariant violation';
 
   if (message) {