@dxos/invariant 0.8.1-main.ba2dec9 → 0.8.1-staging.31c3ee1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. package/dist/lib/browser/index.mjs +21 -0
  2. package/dist/lib/browser/index.mjs.map +4 -4
  3. package/dist/lib/browser/meta.json +1 -1
  4. package/dist/lib/node/index.cjs +22 -0
  5. package/dist/lib/node/index.cjs.map +4 -4
  6. package/dist/lib/node/meta.json +1 -1
  7. package/dist/lib/node-esm/index.mjs +21 -0
  8. package/dist/lib/node-esm/index.mjs.map +4 -4
  9. package/dist/lib/node-esm/meta.json +1 -1
  10. package/dist/types/src/assert.d.ts +33 -0
  11. package/dist/types/src/assert.d.ts.map +1 -0
  12. package/dist/types/src/index.d.ts +1 -0
  13. package/dist/types/src/index.d.ts.map +1 -1
  14. package/package.json +1 -1
  15. package/src/assert.ts +56 -0
  16. package/src/index.ts +1 -0
package/dist/lib/browser/index.mjs CHANGED
@@ -51,8 +51,29 @@ var failedInvariant = (message1, message2, meta) => {
51
51
  }
52
52
  throw new InvariantViolation(errorMessage);
53
53
  };
54
+
55
+ // packages/common/invariant/src/assert.ts
56
+ var assertArgument = (condition, message) => {
57
+ if (!condition) {
58
+ const error = new TypeError(message);
59
+ Error.captureStackTrace(error, assertArgument);
60
+ throw error;
61
+ }
62
+ };
63
+ var assertState = (condition, message) => {
64
+ if (!condition) {
65
+ const error = new InvalidStateError(message);
66
+ Error.captureStackTrace(error, assertState);
67
+ throw error;
68
+ }
69
+ };
70
+ var InvalidStateError = class extends Error {
71
+ };
54
72
  export {
73
+ InvalidStateError,
55
74
  InvariantViolation,
75
+ assertArgument,
76
+ assertState,
56
77
  failedInvariant,
57
78
  invariant
58
79
  };
package/dist/lib/browser/index.mjs.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
- "sources": ["../../../src/invariant.ts"],
4
- "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 const error = new InvariantViolation(errorMessage);\n\n // Do not include the invariant function in the stack trace.\n Error.captureStackTrace(error, invariant);\n\n throw error;\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 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"],
5
- "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,QAAMC,QAAQ,IAAIC,mBAAmBN,YAAAA;AAGrCO,QAAMC,kBAAkBH,OAAOV,SAAAA;AAE/B,QAAMU;AACR;AAEO,IAAMC,qBAAN,cAAiCC,MAAAA;EACtCE,YAAYZ,SAAiB;AAC3B,UAAMA,OAAAA;AAENa,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMT,sBAAsB,CAACU,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,UAAmBpB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACoB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIxB,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,IAAIE,mBAAmBN,YAAAA;AAC/B;",
6
- "names": ["invariant", "condition", "message", "meta", "startsWith", "errorMessage", "A", "F", "getRelativeFilename", "L", "error", "InvariantViolation", "Error", "captureStackTrace", "constructor", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join"]
3
+ "sources": ["../../../src/invariant.ts", "../../../src/assert.ts"],
4
+ "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 const error = new InvariantViolation(errorMessage);\n\n // Do not include the invariant function in the stack trace.\n Error.captureStackTrace(error, invariant);\n\n throw error;\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 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", "//\n// Copyright 2025 DXOS.org\n//\n\n/**\n * Use this to assert the arguments of a function.\n *\n * @example\n * ```ts\n * function foo(arg: string) {\n * assertArgument(typeof arg === 'string', 'arg must be a string');\n * }\n * ```\n */\nexport const assertArgument: (condition: unknown, message: string) => asserts condition = (\n condition: unknown,\n message: string,\n): asserts condition => {\n if (!condition) {\n const error = new TypeError(message);\n Error.captureStackTrace(error, assertArgument);\n throw error;\n }\n};\n\n/**\n * Use this to assert the state of an object.\n *\n * @example\n * ```ts\n * class Foo {\n * private _bar: boolean;\n *\n * public get bar() {\n * assertState(this._bar, 'bar must be true');\n * return this._bar;\n * }\n * }\n *\n * const foo = new Foo();\n * foo.bar = false; // This will throw an InvalidStateError\n * ```\n */\nexport const assertState: (condition: unknown, message: string) => asserts condition = (\n condition: unknown,\n message: string,\n): asserts condition => {\n if (!condition) {\n const error = new InvalidStateError(message);\n Error.captureStackTrace(error, assertState);\n throw error;\n }\n};\n\n// TODO(dmaretskyi): Consider how this correlates to effect errors. Intuitively, this should be a defect, not a checked error.\nexport class InvalidStateError extends Error {}\n"],
5
+ "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,QAAMC,QAAQ,IAAIC,mBAAmBN,YAAAA;AAGrCO,QAAMC,kBAAkBH,OAAOV,SAAAA;AAE/B,QAAMU;AACR;AAEO,IAAMC,qBAAN,cAAiCC,MAAAA;EACtCE,YAAYZ,SAAiB;AAC3B,UAAMA,OAAAA;AAENa,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMT,sBAAsB,CAACU,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,UAAmBpB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACoB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIxB,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,IAAIE,mBAAmBN,YAAAA;AAC/B;;;ACzEO,IAAMsB,iBAA6E,CACxFC,WACAC,YAAAA;AAEA,MAAI,CAACD,WAAW;AACd,UAAME,QAAQ,IAAIC,UAAUF,OAAAA;AAC5BG,UAAMC,kBAAkBH,OAAOH,cAAAA;AAC/B,UAAMG;EACR;AACF;AAoBO,IAAMI,cAA0E,CACrFN,WACAC,YAAAA;AAEA,MAAI,CAACD,WAAW;AACd,UAAME,QAAQ,IAAIK,kBAAkBN,OAAAA;AACpCG,UAAMC,kBAAkBH,OAAOI,WAAAA;AAC/B,UAAMJ;EACR;AACF;AAGO,IAAMK,oBAAN,cAAgCH,MAAAA;AAAO;",
6
+ "names": ["invariant", "condition", "message", "meta", "startsWith", "errorMessage", "A", "F", "getRelativeFilename", "L", "error", "InvariantViolation", "Error", "captureStackTrace", "constructor", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join", "assertArgument", "condition", "message", "error", "TypeError", "Error", "captureStackTrace", "assertState", "InvalidStateError"]
7
7
  }
package/dist/lib/browser/meta.json CHANGED
@@ -1 +1 @@
1
- {"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7815,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":498,"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":3894},"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":1308},"packages/common/invariant/src/index.ts":{"bytesInOutput":0}},"bytes":1454}}}
1
+ {"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7815,"imports":[],"format":"esm"},"packages/common/invariant/src/assert.ts":{"bytes":4056,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":584,"imports":[{"path":"packages/common/invariant/src/invariant.ts","kind":"import-statement","original":"./invariant"},{"path":"packages/common/invariant/src/assert.ts","kind":"import-statement","original":"./assert"}],"format":"esm"}},"outputs":{"packages/common/invariant/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5780},"packages/common/invariant/dist/lib/browser/index.mjs":{"imports":[],"exports":["InvalidStateError","InvariantViolation","assertArgument","assertState","failedInvariant","invariant"],"entryPoint":"packages/common/invariant/src/index.ts","inputs":{"packages/common/invariant/src/invariant.ts":{"bytesInOutput":1308},"packages/common/invariant/src/index.ts":{"bytesInOutput":0},"packages/common/invariant/src/assert.ts":{"bytesInOutput":421}},"bytes":1973}}}
package/dist/lib/node/index.cjs CHANGED
@@ -18,7 +18,10 @@ var __copyProps = (to, from, except, desc) => {
18
18
  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
19
  var node_exports = {};
20
20
  __export(node_exports, {
21
+ InvalidStateError: () => InvalidStateError,
21
22
  InvariantViolation: () => InvariantViolation,
23
+ assertArgument: () => assertArgument,
24
+ assertState: () => assertState,
22
25
  failedInvariant: () => failedInvariant,
23
26
  invariant: () => invariant
24
27
  });
@@ -75,9 +78,28 @@ var failedInvariant = (message1, message2, meta) => {
75
78
  }
76
79
  throw new InvariantViolation(errorMessage);
77
80
  };
81
+ var assertArgument = (condition, message) => {
82
+ if (!condition) {
83
+ const error = new TypeError(message);
84
+ Error.captureStackTrace(error, assertArgument);
85
+ throw error;
86
+ }
87
+ };
88
+ var assertState = (condition, message) => {
89
+ if (!condition) {
90
+ const error = new InvalidStateError(message);
91
+ Error.captureStackTrace(error, assertState);
92
+ throw error;
93
+ }
94
+ };
95
+ var InvalidStateError = class extends Error {
96
+ };
78
97
  // Annotate the CommonJS export names for ESM import in node:
79
98
  0 && (module.exports = {
99
+ InvalidStateError,
80
100
  InvariantViolation,
101
+ assertArgument,
102
+ assertState,
81
103
  failedInvariant,
82
104
  invariant
83
105
  });
package/dist/lib/node/index.cjs.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
- "sources": ["../../../src/invariant.ts"],
4
- "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 const error = new InvariantViolation(errorMessage);\n\n // Do not include the invariant function in the stack trace.\n Error.captureStackTrace(error, invariant);\n\n throw error;\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 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"],
5
- "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,QAAMC,QAAQ,IAAIC,mBAAmBN,YAAAA;AAGrCO,QAAMC,kBAAkBH,OAAOV,SAAAA;AAE/B,QAAMU;AACR;AAEO,IAAMC,qBAAN,cAAiCC,MAAAA;EACtCE,YAAYZ,SAAiB;AAC3B,UAAMA,OAAAA;AAENa,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMT,sBAAsB,CAACU,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,UAAmBpB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACoB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIxB,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,IAAIE,mBAAmBN,YAAAA;AAC/B;",
6
- "names": ["invariant", "condition", "message", "meta", "startsWith", "errorMessage", "A", "F", "getRelativeFilename", "L", "error", "InvariantViolation", "Error", "captureStackTrace", "constructor", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join"]
3
+ "sources": ["../../../src/invariant.ts", "../../../src/assert.ts"],
4
+ "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 const error = new InvariantViolation(errorMessage);\n\n // Do not include the invariant function in the stack trace.\n Error.captureStackTrace(error, invariant);\n\n throw error;\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 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", "//\n// Copyright 2025 DXOS.org\n//\n\n/**\n * Use this to assert the arguments of a function.\n *\n * @example\n * ```ts\n * function foo(arg: string) {\n * assertArgument(typeof arg === 'string', 'arg must be a string');\n * }\n * ```\n */\nexport const assertArgument: (condition: unknown, message: string) => asserts condition = (\n condition: unknown,\n message: string,\n): asserts condition => {\n if (!condition) {\n const error = new TypeError(message);\n Error.captureStackTrace(error, assertArgument);\n throw error;\n }\n};\n\n/**\n * Use this to assert the state of an object.\n *\n * @example\n * ```ts\n * class Foo {\n * private _bar: boolean;\n *\n * public get bar() {\n * assertState(this._bar, 'bar must be true');\n * return this._bar;\n * }\n * }\n *\n * const foo = new Foo();\n * foo.bar = false; // This will throw an InvalidStateError\n * ```\n */\nexport const assertState: (condition: unknown, message: string) => asserts condition = (\n condition: unknown,\n message: string,\n): asserts condition => {\n if (!condition) {\n const error = new InvalidStateError(message);\n Error.captureStackTrace(error, assertState);\n throw error;\n }\n};\n\n// TODO(dmaretskyi): Consider how this correlates to effect errors. Intuitively, this should be a defect, not a checked error.\nexport class InvalidStateError extends Error {}\n"],
5
+ "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,QAAMC,QAAQ,IAAIC,mBAAmBN,YAAAA;AAGrCO,QAAMC,kBAAkBH,OAAOV,SAAAA;AAE/B,QAAMU;AACR;AAEO,IAAMC,qBAAN,cAAiCC,MAAAA;EACtCE,YAAYZ,SAAiB;AAC3B,UAAMA,OAAAA;AAENa,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMT,sBAAsB,CAACU,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,UAAmBpB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACoB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIxB,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,IAAIE,mBAAmBN,YAAAA;AAC/B;ACzEO,IAAMsB,iBAA6E,CACxF1B,WACAC,YAAAA;AAEA,MAAI,CAACD,WAAW;AACd,UAAMS,QAAQ,IAAIkB,UAAU1B,OAAAA;AAC5BU,UAAMC,kBAAkBH,OAAOiB,cAAAA;AAC/B,UAAMjB;EACR;AACF;AAoBO,IAAMmB,cAA0E,CACrF5B,WACAC,YAAAA;AAEA,MAAI,CAACD,WAAW;AACd,UAAMS,QAAQ,IAAIoB,kBAAkB5B,OAAAA;AACpCU,UAAMC,kBAAkBH,OAAOmB,WAAAA;AAC/B,UAAMnB;EACR;AACF;AAGO,IAAMoB,oBAAN,cAAgClB,MAAAA;AAAO;",
6
+ "names": ["invariant", "condition", "message", "meta", "startsWith", "errorMessage", "A", "F", "getRelativeFilename", "L", "error", "InvariantViolation", "Error", "captureStackTrace", "constructor", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join", "assertArgument", "TypeError", "assertState", "InvalidStateError"]
7
7
  }
package/dist/lib/node/meta.json CHANGED
@@ -1 +1 @@
1
- {"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7815,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":498,"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":3894},"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":1308},"packages/common/invariant/src/index.ts":{"bytesInOutput":0}},"bytes":1454}}}
1
+ {"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7815,"imports":[],"format":"esm"},"packages/common/invariant/src/assert.ts":{"bytes":4056,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":584,"imports":[{"path":"packages/common/invariant/src/invariant.ts","kind":"import-statement","original":"./invariant"},{"path":"packages/common/invariant/src/assert.ts","kind":"import-statement","original":"./assert"}],"format":"esm"}},"outputs":{"packages/common/invariant/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5780},"packages/common/invariant/dist/lib/node/index.cjs":{"imports":[],"exports":["InvalidStateError","InvariantViolation","assertArgument","assertState","failedInvariant","invariant"],"entryPoint":"packages/common/invariant/src/index.ts","inputs":{"packages/common/invariant/src/invariant.ts":{"bytesInOutput":1308},"packages/common/invariant/src/index.ts":{"bytesInOutput":0},"packages/common/invariant/src/assert.ts":{"bytesInOutput":421}},"bytes":1973}}}
package/dist/lib/node-esm/index.mjs CHANGED
@@ -53,8 +53,29 @@ var failedInvariant = (message1, message2, meta) => {
53
53
  }
54
54
  throw new InvariantViolation(errorMessage);
55
55
  };
56
+
57
+ // packages/common/invariant/src/assert.ts
58
+ var assertArgument = (condition, message) => {
59
+ if (!condition) {
60
+ const error = new TypeError(message);
61
+ Error.captureStackTrace(error, assertArgument);
62
+ throw error;
63
+ }
64
+ };
65
+ var assertState = (condition, message) => {
66
+ if (!condition) {
67
+ const error = new InvalidStateError(message);
68
+ Error.captureStackTrace(error, assertState);
69
+ throw error;
70
+ }
71
+ };
72
+ var InvalidStateError = class extends Error {
73
+ };
56
74
  export {
75
+ InvalidStateError,
57
76
  InvariantViolation,
77
+ assertArgument,
78
+ assertState,
58
79
  failedInvariant,
59
80
  invariant
60
81
  };
package/dist/lib/node-esm/index.mjs.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
- "sources": ["../../../src/invariant.ts"],
4
- "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 const error = new InvariantViolation(errorMessage);\n\n // Do not include the invariant function in the stack trace.\n Error.captureStackTrace(error, invariant);\n\n throw error;\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 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"],
5
- "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,QAAMC,QAAQ,IAAIC,mBAAmBN,YAAAA;AAGrCO,QAAMC,kBAAkBH,OAAOV,SAAAA;AAE/B,QAAMU;AACR;AAEO,IAAMC,qBAAN,cAAiCC,MAAAA;EACtCE,YAAYZ,SAAiB;AAC3B,UAAMA,OAAAA;AAENa,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMT,sBAAsB,CAACU,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,UAAmBpB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACoB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIxB,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,IAAIE,mBAAmBN,YAAAA;AAC/B;",
6
- "names": ["invariant", "condition", "message", "meta", "startsWith", "errorMessage", "A", "F", "getRelativeFilename", "L", "error", "InvariantViolation", "Error", "captureStackTrace", "constructor", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join"]
3
+ "sources": ["../../../src/invariant.ts", "../../../src/assert.ts"],
4
+ "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 const error = new InvariantViolation(errorMessage);\n\n // Do not include the invariant function in the stack trace.\n Error.captureStackTrace(error, invariant);\n\n throw error;\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 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", "//\n// Copyright 2025 DXOS.org\n//\n\n/**\n * Use this to assert the arguments of a function.\n *\n * @example\n * ```ts\n * function foo(arg: string) {\n * assertArgument(typeof arg === 'string', 'arg must be a string');\n * }\n * ```\n */\nexport const assertArgument: (condition: unknown, message: string) => asserts condition = (\n condition: unknown,\n message: string,\n): asserts condition => {\n if (!condition) {\n const error = new TypeError(message);\n Error.captureStackTrace(error, assertArgument);\n throw error;\n }\n};\n\n/**\n * Use this to assert the state of an object.\n *\n * @example\n * ```ts\n * class Foo {\n * private _bar: boolean;\n *\n * public get bar() {\n * assertState(this._bar, 'bar must be true');\n * return this._bar;\n * }\n * }\n *\n * const foo = new Foo();\n * foo.bar = false; // This will throw an InvalidStateError\n * ```\n */\nexport const assertState: (condition: unknown, message: string) => asserts condition = (\n condition: unknown,\n message: string,\n): asserts condition => {\n if (!condition) {\n const error = new InvalidStateError(message);\n Error.captureStackTrace(error, assertState);\n throw error;\n }\n};\n\n// TODO(dmaretskyi): Consider how this correlates to effect errors. Intuitively, this should be a defect, not a checked error.\nexport class InvalidStateError extends Error {}\n"],
5
+ "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,QAAMC,QAAQ,IAAIC,mBAAmBN,YAAAA;AAGrCO,QAAMC,kBAAkBH,OAAOV,SAAAA;AAE/B,QAAMU;AACR;AAEO,IAAMC,qBAAN,cAAiCC,MAAAA;EACtCE,YAAYZ,SAAiB;AAC3B,UAAMA,OAAAA;AAENa,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMT,sBAAsB,CAACU,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,UAAmBpB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACoB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIxB,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,IAAIE,mBAAmBN,YAAAA;AAC/B;;;ACzEO,IAAMsB,iBAA6E,CACxFC,WACAC,YAAAA;AAEA,MAAI,CAACD,WAAW;AACd,UAAME,QAAQ,IAAIC,UAAUF,OAAAA;AAC5BG,UAAMC,kBAAkBH,OAAOH,cAAAA;AAC/B,UAAMG;EACR;AACF;AAoBO,IAAMI,cAA0E,CACrFN,WACAC,YAAAA;AAEA,MAAI,CAACD,WAAW;AACd,UAAME,QAAQ,IAAIK,kBAAkBN,OAAAA;AACpCG,UAAMC,kBAAkBH,OAAOI,WAAAA;AAC/B,UAAMJ;EACR;AACF;AAGO,IAAMK,oBAAN,cAAgCH,MAAAA;AAAO;",
6
+ "names": ["invariant", "condition", "message", "meta", "startsWith", "errorMessage", "A", "F", "getRelativeFilename", "L", "error", "InvariantViolation", "Error", "captureStackTrace", "constructor", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join", "assertArgument", "condition", "message", "error", "TypeError", "Error", "captureStackTrace", "assertState", "InvalidStateError"]
7
7
  }
package/dist/lib/node-esm/meta.json CHANGED
@@ -1 +1 @@
1
- {"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7815,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":498,"imports":[{"path":"packages/common/invariant/src/invariant.ts","kind":"import-statement","original":"./invariant"}],"format":"esm"}},"outputs":{"packages/common/invariant/dist/lib/node-esm/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":3896},"packages/common/invariant/dist/lib/node-esm/index.mjs":{"imports":[],"exports":["InvariantViolation","failedInvariant","invariant"],"entryPoint":"packages/common/invariant/src/index.ts","inputs":{"packages/common/invariant/src/invariant.ts":{"bytesInOutput":1308},"packages/common/invariant/src/index.ts":{"bytesInOutput":0}},"bytes":1547}}}
1
+ {"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7815,"imports":[],"format":"esm"},"packages/common/invariant/src/assert.ts":{"bytes":4056,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":584,"imports":[{"path":"packages/common/invariant/src/invariant.ts","kind":"import-statement","original":"./invariant"},{"path":"packages/common/invariant/src/assert.ts","kind":"import-statement","original":"./assert"}],"format":"esm"}},"outputs":{"packages/common/invariant/dist/lib/node-esm/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5782},"packages/common/invariant/dist/lib/node-esm/index.mjs":{"imports":[],"exports":["InvalidStateError","InvariantViolation","assertArgument","assertState","failedInvariant","invariant"],"entryPoint":"packages/common/invariant/src/index.ts","inputs":{"packages/common/invariant/src/invariant.ts":{"bytesInOutput":1308},"packages/common/invariant/src/index.ts":{"bytesInOutput":0},"packages/common/invariant/src/assert.ts":{"bytesInOutput":421}},"bytes":2066}}}
package/dist/types/src/assert.d.ts ADDED
@@ -0,0 +1,33 @@
1
+ /**
2
+ * Use this to assert the arguments of a function.
3
+ *
4
+ * @example
5
+ * ```ts
6
+ * function foo(arg: string) {
7
+ * assertArgument(typeof arg === 'string', 'arg must be a string');
8
+ * }
9
+ * ```
10
+ */
11
+ export declare const assertArgument: (condition: unknown, message: string) => asserts condition;
12
+ /**
13
+ * Use this to assert the state of an object.
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * class Foo {
18
+ * private _bar: boolean;
19
+ *
20
+ * public get bar() {
21
+ * assertState(this._bar, 'bar must be true');
22
+ * return this._bar;
23
+ * }
24
+ * }
25
+ *
26
+ * const foo = new Foo();
27
+ * foo.bar = false; // This will throw an InvalidStateError
28
+ * ```
29
+ */
30
+ export declare const assertState: (condition: unknown, message: string) => asserts condition;
31
+ export declare class InvalidStateError extends Error {
32
+ }
33
+ //# sourceMappingURL=assert.d.ts.map
package/dist/types/src/assert.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../../src/assert.ts"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,SAS7E,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,SAS1E,CAAC;AAGF,qBAAa,iBAAkB,SAAQ,KAAK;CAAG"}
package/dist/types/src/index.d.ts CHANGED
@@ -1,2 +1,3 @@
1
1
  export * from './invariant';
2
+ export * from './assert';
2
3
  //# sourceMappingURL=index.d.ts.map
package/dist/types/src/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,aAAa,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/invariant",
3
- "version": "0.8.1-main.ba2dec9",
3
+ "version": "0.8.1-staging.31c3ee1",
4
4
  "description": "Invariant assertion compatible with DXOS logger.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
package/src/assert.ts ADDED
@@ -0,0 +1,56 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ /**
6
+ * Use this to assert the arguments of a function.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * function foo(arg: string) {
11
+ * assertArgument(typeof arg === 'string', 'arg must be a string');
12
+ * }
13
+ * ```
14
+ */
15
+ export const assertArgument: (condition: unknown, message: string) => asserts condition = (
16
+ condition: unknown,
17
+ message: string,
18
+ ): asserts condition => {
19
+ if (!condition) {
20
+ const error = new TypeError(message);
21
+ Error.captureStackTrace(error, assertArgument);
22
+ throw error;
23
+ }
24
+ };
25
+
26
+ /**
27
+ * Use this to assert the state of an object.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * class Foo {
32
+ * private _bar: boolean;
33
+ *
34
+ * public get bar() {
35
+ * assertState(this._bar, 'bar must be true');
36
+ * return this._bar;
37
+ * }
38
+ * }
39
+ *
40
+ * const foo = new Foo();
41
+ * foo.bar = false; // This will throw an InvalidStateError
42
+ * ```
43
+ */
44
+ export const assertState: (condition: unknown, message: string) => asserts condition = (
45
+ condition: unknown,
46
+ message: string,
47
+ ): asserts condition => {
48
+ if (!condition) {
49
+ const error = new InvalidStateError(message);
50
+ Error.captureStackTrace(error, assertState);
51
+ throw error;
52
+ }
53
+ };
54
+
55
+ // TODO(dmaretskyi): Consider how this correlates to effect errors. Intuitively, this should be a defect, not a checked error.
56
+ export class InvalidStateError extends Error {}
package/src/index.ts CHANGED
@@ -3,3 +3,4 @@
3
3
  //
4
4
 
5
5
  export * from './invariant';
6
+ export * from './assert';