@dxos/invariant 0.8.2 → 0.8.3-main.672df60
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.
- package/dist/lib/browser/index.mjs.map +2 -2
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/node/index.cjs.map +2 -2
- package/dist/lib/node/meta.json +1 -1
- package/dist/lib/node-esm/index.mjs.map +2 -2
- package/dist/lib/node-esm/meta.json +1 -1
- package/dist/types/src/assert.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/assert.ts +1 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
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;EACtC,YAAYV,SAAiB;AAC3B,UAAMA,OAAAA;AAENY,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMR,sBAAsB,CAACS,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,UAAmBnB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACmB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIvB,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;;;
|
|
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 */\n// TODO(dmaretskyi): Rename assertParameter.\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;EACtC,YAAYV,SAAiB;AAC3B,UAAMA,OAAAA;AAENY,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMR,sBAAsB,CAACS,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,UAAmBnB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACmB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIvB,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;;;ACxEO,IAAMqB,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
6
|
"names": ["invariant", "condition", "message", "meta", "startsWith", "errorMessage", "A", "F", "getRelativeFilename", "L", "error", "InvariantViolation", "Error", "captureStackTrace", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join", "assertArgument", "condition", "message", "error", "TypeError", "Error", "captureStackTrace", "assertState", "InvalidStateError"]
|
|
7
7
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7655,"imports":[],"format":"esm"},"packages/common/invariant/src/assert.ts":{"bytes":
|
|
1
|
+
{"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7655,"imports":[],"format":"esm"},"packages/common/invariant/src/assert.ts":{"bytes":4093,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":552,"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":5810},"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}}}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
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;EACtC,YAAYV,SAAiB;AAC3B,UAAMA,OAAAA;AAENY,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMR,sBAAsB,CAACS,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,UAAmBnB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACmB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIvB,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;
|
|
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 */\n// TODO(dmaretskyi): Rename assertParameter.\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;EACtC,YAAYV,SAAiB;AAC3B,UAAMA,OAAAA;AAENY,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMR,sBAAsB,CAACS,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,UAAmBnB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACmB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIvB,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;ACxEO,IAAMqB,iBAA6E,CACxFzB,WACAC,YAAAA;AAEA,MAAI,CAACD,WAAW;AACd,UAAMS,QAAQ,IAAIiB,UAAUzB,OAAAA;AAC5BU,UAAMC,kBAAkBH,OAAOgB,cAAAA;AAC/B,UAAMhB;EACR;AACF;AAoBO,IAAMkB,cAA0E,CACrF3B,WACAC,YAAAA;AAEA,MAAI,CAACD,WAAW;AACd,UAAMS,QAAQ,IAAImB,kBAAkB3B,OAAAA;AACpCU,UAAMC,kBAAkBH,OAAOkB,WAAAA;AAC/B,UAAMlB;EACR;AACF;AAGO,IAAMmB,oBAAN,cAAgCjB,MAAAA;AAAO;",
|
|
6
6
|
"names": ["invariant", "condition", "message", "meta", "startsWith", "errorMessage", "A", "F", "getRelativeFilename", "L", "error", "InvariantViolation", "Error", "captureStackTrace", "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":7655,"imports":[],"format":"esm"},"packages/common/invariant/src/assert.ts":{"bytes":
|
|
1
|
+
{"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7655,"imports":[],"format":"esm"},"packages/common/invariant/src/assert.ts":{"bytes":4093,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":552,"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":5810},"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}}}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
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;EACtC,YAAYV,SAAiB;AAC3B,UAAMA,OAAAA;AAENY,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMR,sBAAsB,CAACS,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,UAAmBnB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACmB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIvB,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;;;
|
|
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 */\n// TODO(dmaretskyi): Rename assertParameter.\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;EACtC,YAAYV,SAAiB;AAC3B,UAAMA,OAAAA;AAENY,WAAOC,eAAe,MAAM,WAAWC,SAAS;EAClD;AACF;AAEA,IAAMR,sBAAsB,CAACS,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,UAAmBnB,SAAAA;AACrE,MAAIE,eAAe;AAEnB,QAAMH,UAAU;IAACmB;IAAUC;IAAUC,OAAO,CAACC,QAAQ,OAAOA,QAAQ,QAAA,EAAUC,KAAK,GAAA;AACnF,MAAIvB,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;;;ACxEO,IAAMqB,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
6
|
"names": ["invariant", "condition", "message", "meta", "startsWith", "errorMessage", "A", "F", "getRelativeFilename", "L", "error", "InvariantViolation", "Error", "captureStackTrace", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join", "assertArgument", "condition", "message", "error", "TypeError", "Error", "captureStackTrace", "assertState", "InvalidStateError"]
|
|
7
7
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7655,"imports":[],"format":"esm"},"packages/common/invariant/src/assert.ts":{"bytes":
|
|
1
|
+
{"inputs":{"packages/common/invariant/src/invariant.ts":{"bytes":7655,"imports":[],"format":"esm"},"packages/common/invariant/src/assert.ts":{"bytes":4093,"imports":[],"format":"esm"},"packages/common/invariant/src/index.ts":{"bytes":552,"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":5812},"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}}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../../src/assert.ts"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;
|
|
1
|
+
{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../../src/assert.ts"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;AAEH,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/package.json
CHANGED