@dxos/invariant 0.10.0 → 0.11.0

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.
@@ -0,0 +1,88 @@
1
+ //#region src/invariant.ts
2
+ /**
3
+ * Asserts that the condition is true.
4
+ *
5
+ * @param message Optional message. If it starts with "BUG" then the program will break if this invariant fails if the debugger is attached.
6
+ */
7
+ var invariant = (condition, message, meta) => {
8
+ if (condition) return;
9
+ if (message?.startsWith("BUG")) debugger;
10
+ let errorMessage = "invariant violation";
11
+ if (message) errorMessage += `: ${message}`;
12
+ if (meta?.A) errorMessage += ` [${meta.A[0]}]`;
13
+ if (meta?.F) errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;
14
+ const error = new InvariantViolation(errorMessage);
15
+ Error.captureStackTrace(error, invariant);
16
+ throw error;
17
+ };
18
+ var InvariantViolation = class extends Error {
19
+ constructor(message) {
20
+ super(message);
21
+ Object.setPrototypeOf(this, new.target.prototype);
22
+ }
23
+ };
24
+ var getRelativeFilename = (filename) => {
25
+ const match = filename.match(/.+\/(packages\/.+\/.+)/);
26
+ if (match) {
27
+ const [, filePath] = match;
28
+ return filePath;
29
+ }
30
+ return filename;
31
+ };
32
+ var failedInvariant = (message1, message2, meta) => {
33
+ let errorMessage = "invariant violation";
34
+ const message = [message1, message2].filter((str) => typeof str === "string").join(" ");
35
+ if (message) errorMessage += `: ${message}`;
36
+ if (meta?.A) errorMessage += ` [${meta.A[0]}]`;
37
+ if (meta?.F) errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;
38
+ throw new InvariantViolation(errorMessage);
39
+ };
40
+ //#endregion
41
+ //#region src/assert.ts
42
+ /**
43
+ * Use this to assert the arguments of a function.
44
+ *
45
+ * @example
46
+ * ```ts
47
+ * function foo(arg: string) {
48
+ * assertArgument(typeof arg === 'string', 'arg must be a string');
49
+ * }
50
+ * ```
51
+ */
52
+ var assertArgument = (condition, argumentName, message) => {
53
+ if (!condition) {
54
+ const error = /* @__PURE__ */ new TypeError(`Invalid argument \`${argumentName}\`` + (message ? `: ${message}` : ""));
55
+ Error.captureStackTrace(error, assertArgument);
56
+ throw error;
57
+ }
58
+ };
59
+ /**
60
+ * Use this to assert the state of an object.
61
+ *
62
+ * @example
63
+ * ```ts
64
+ * class Foo {
65
+ * private _bar: boolean;
66
+ *
67
+ * public get bar() {
68
+ * assertState(this._bar, 'bar must be true');
69
+ * return this._bar;
70
+ * }
71
+ * }
72
+ *
73
+ * const foo = new Foo();
74
+ * foo.bar = false; // This will throw an InvalidStateError
75
+ * ```
76
+ */
77
+ var assertState = (condition, message) => {
78
+ if (!condition) {
79
+ const error = new InvalidStateError(message);
80
+ Error.captureStackTrace(error, assertState);
81
+ throw error;
82
+ }
83
+ };
84
+ var InvalidStateError = class extends Error {};
85
+ //#endregion
86
+ export { InvalidStateError, InvariantViolation, assertArgument, assertState, failedInvariant, invariant };
87
+
88
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.mjs","names":[],"sources":["../../src/invariant.ts","../../src/assert.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. 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, argumentName: string, message?: string) => asserts condition = (\n condition: unknown,\n argumentName: string,\n message?: string,\n): asserts condition => {\n if (!condition) {\n const error = new TypeError(`Invalid argument \\`${argumentName}\\`` + (message ? `: ${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"],"mappings":";;;;;;AAaA,IAAa,aACX,WACA,SACA,SACsB;CACtB,IAAI,WACF;CAGF,IAAI,SAAS,WAAW,KAAK,GAG3B;CAGF,IAAI,eAAe;CAEnB,IAAI,SACF,gBAAgB,KAAK;CAGvB,IAAI,MAAM,GACR,gBAAgB,KAAK,KAAK,EAAE,GAAG;CAGjC,IAAI,MAAM,GACR,gBAAgB,OAAO,oBAAoB,KAAK,CAAC,EAAE,GAAG,KAAK;CAG7D,MAAM,QAAQ,IAAI,mBAAmB,YAAY;CAGjD,MAAM,kBAAkB,OAAO,SAAS;CAExC,MAAM;AACR;AAEA,IAAa,qBAAb,cAAwC,MAAM;CAC5C,YAAY,SAAiB;EAC3B,MAAM,OAAO;EAEb,OAAO,eAAe,MAAM,IAAI,OAAO,SAAS;CAClD;AACF;AAEA,IAAM,uBAAuB,aAAqB;CAGhD,MAAM,QAAQ,SAAS,MAAM,wBAAwB;CACrD,IAAI,OAAO;EACT,MAAM,GAAG,YAAY;EACrB,OAAO;CACT;CAEA,OAAO;AACT;AAEA,IAAa,mBAAmB,UAAoB,UAAmB,SAA+B;CACpG,IAAI,eAAe;CAEnB,MAAM,UAAU,CAAC,UAAU,QAAQ,CAAC,CAAC,QAAQ,QAAQ,OAAO,QAAQ,QAAQ,CAAC,CAAC,KAAK,GAAG;CACtF,IAAI,SACF,gBAAgB,KAAK;CAGvB,IAAI,MAAM,GACR,gBAAgB,KAAK,KAAK,EAAE,GAAG;CAGjC,IAAI,MAAM,GACR,gBAAgB,OAAO,oBAAoB,KAAK,CAAC,EAAE,GAAG,KAAK;CAG7D,MAAM,IAAI,mBAAmB,YAAY;AAC3C;;;;;;;;;;;;;ACxEA,IAAa,kBACX,WACA,cACA,YACsB;CACtB,IAAI,CAAC,WAAW;EACd,MAAM,wBAAQ,IAAI,UAAU,sBAAsB,aAAa,OAAO,UAAU,KAAK,YAAY,GAAG;EACpG,MAAM,kBAAkB,OAAO,cAAc;EAC7C,MAAM;CACR;AACF;;;;;;;;;;;;;;;;;;;AAoBA,IAAa,eACX,WACA,YACsB;CACtB,IAAI,CAAC,WAAW;EACd,MAAM,QAAQ,IAAI,kBAAkB,OAAO;EAC3C,MAAM,kBAAkB,OAAO,WAAW;EAC1C,MAAM;CACR;AACF;AAGA,IAAa,oBAAb,cAAuC,MAAM,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/invariant",
3
- "version": "0.10.0",
3
+ "version": "0.11.0",
4
4
  "description": "Invariant assertion compatible with DXOS logger.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
@@ -14,12 +14,9 @@
14
14
  "type": "module",
15
15
  "exports": {
16
16
  ".": {
17
+ "source": "./src/index.ts",
17
18
  "types": "./dist/types/src/index.d.ts",
18
- "browser": "./dist/lib/browser/index.mjs",
19
- "node": {
20
- "require": "./dist/lib/node/index.cjs",
21
- "default": "./dist/lib/node-esm/index.mjs"
22
- }
19
+ "import": "./dist/lib/index.mjs"
23
20
  }
24
21
  },
25
22
  "types": "dist/types/src/index.d.ts",
@@ -1,80 +0,0 @@
1
- // src/invariant.ts
2
- var invariant = (condition, message, meta) => {
3
- if (condition) {
4
- return;
5
- }
6
- if (message?.startsWith("BUG")) {
7
- debugger;
8
- }
9
- let errorMessage = "invariant violation";
10
- if (message) {
11
- errorMessage += `: ${message}`;
12
- }
13
- if (meta?.A) {
14
- errorMessage += ` [${meta.A[0]}]`;
15
- }
16
- if (meta?.F) {
17
- errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;
18
- }
19
- const error = new InvariantViolation(errorMessage);
20
- Error.captureStackTrace(error, invariant);
21
- throw error;
22
- };
23
- var InvariantViolation = class extends Error {
24
- constructor(message) {
25
- super(message);
26
- Object.setPrototypeOf(this, new.target.prototype);
27
- }
28
- };
29
- var getRelativeFilename = (filename) => {
30
- const match = filename.match(/.+\/(packages\/.+\/.+)/);
31
- if (match) {
32
- const [, filePath] = match;
33
- return filePath;
34
- }
35
- return filename;
36
- };
37
- var failedInvariant = (message1, message2, meta) => {
38
- let errorMessage = "invariant violation";
39
- const message = [
40
- message1,
41
- message2
42
- ].filter((str) => typeof str === "string").join(" ");
43
- if (message) {
44
- errorMessage += `: ${message}`;
45
- }
46
- if (meta?.A) {
47
- errorMessage += ` [${meta.A[0]}]`;
48
- }
49
- if (meta?.F) {
50
- errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;
51
- }
52
- throw new InvariantViolation(errorMessage);
53
- };
54
-
55
- // src/assert.ts
56
- var assertArgument = (condition, argumentName, message) => {
57
- if (!condition) {
58
- const error = new TypeError(`Invalid argument \`${argumentName}\`` + (message ? `: ${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
- };
72
- export {
73
- InvalidStateError,
74
- InvariantViolation,
75
- assertArgument,
76
- assertState,
77
- failedInvariant,
78
- invariant
79
- };
80
- //# sourceMappingURL=index.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 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 */\n// TODO(dmaretskyi): Rename assertParameter.\nexport const assertArgument: (condition: unknown, argumentName: string, message?: string) => asserts condition = (\n condition: unknown,\n argumentName: string,\n message?: string,\n): asserts condition => {\n if (!condition) {\n const error = new TypeError(`Invalid argument \\`${argumentName}\\`` + (message ? `: ${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,iBAAoG,CAC/GC,WACAC,cACAC,YAAAA;AAEA,MAAI,CAACF,WAAW;AACd,UAAMG,QAAQ,IAAIC,UAAU,sBAAsBH,YAAAA,QAAoBC,UAAU,KAAKA,OAAAA,KAAY,GAAC;AAClGG,UAAMC,kBAAkBH,OAAOJ,cAAAA;AAC/B,UAAMI;EACR;AACF;AAoBO,IAAMI,cAA0E,CACrFP,WACAE,YAAAA;AAEA,MAAI,CAACF,WAAW;AACd,UAAMG,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", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join", "assertArgument", "condition", "argumentName", "message", "error", "TypeError", "Error", "captureStackTrace", "assertState", "InvalidStateError"]
7
- }
@@ -1 +0,0 @@
1
- {"inputs":{"src/invariant.ts":{"bytes":7562,"imports":[],"format":"esm"},"src/assert.ts":{"bytes":4370,"imports":[],"format":"esm"},"src/index.ts":{"bytes":463,"imports":[{"path":"src/invariant.ts","kind":"import-statement","original":"./invariant"},{"path":"src/assert.ts","kind":"import-statement","original":"./assert"}],"format":"esm"}},"outputs":{"dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5989},"dist/lib/browser/index.mjs":{"imports":[],"exports":["InvalidStateError","InvariantViolation","assertArgument","assertState","failedInvariant","invariant"],"entryPoint":"src/index.ts","inputs":{"src/invariant.ts":{"bytesInOutput":1308},"src/index.ts":{"bytesInOutput":0},"src/assert.ts":{"bytesInOutput":500}},"bytes":2000}}}
@@ -1,82 +0,0 @@
1
- import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
2
-
3
- // src/invariant.ts
4
- var invariant = (condition, message, meta) => {
5
- if (condition) {
6
- return;
7
- }
8
- if (message?.startsWith("BUG")) {
9
- debugger;
10
- }
11
- let errorMessage = "invariant violation";
12
- if (message) {
13
- errorMessage += `: ${message}`;
14
- }
15
- if (meta?.A) {
16
- errorMessage += ` [${meta.A[0]}]`;
17
- }
18
- if (meta?.F) {
19
- errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;
20
- }
21
- const error = new InvariantViolation(errorMessage);
22
- Error.captureStackTrace(error, invariant);
23
- throw error;
24
- };
25
- var InvariantViolation = class extends Error {
26
- constructor(message) {
27
- super(message);
28
- Object.setPrototypeOf(this, new.target.prototype);
29
- }
30
- };
31
- var getRelativeFilename = (filename) => {
32
- const match = filename.match(/.+\/(packages\/.+\/.+)/);
33
- if (match) {
34
- const [, filePath] = match;
35
- return filePath;
36
- }
37
- return filename;
38
- };
39
- var failedInvariant = (message1, message2, meta) => {
40
- let errorMessage = "invariant violation";
41
- const message = [
42
- message1,
43
- message2
44
- ].filter((str) => typeof str === "string").join(" ");
45
- if (message) {
46
- errorMessage += `: ${message}`;
47
- }
48
- if (meta?.A) {
49
- errorMessage += ` [${meta.A[0]}]`;
50
- }
51
- if (meta?.F) {
52
- errorMessage += ` at ${getRelativeFilename(meta.F)}:${meta.L}`;
53
- }
54
- throw new InvariantViolation(errorMessage);
55
- };
56
-
57
- // src/assert.ts
58
- var assertArgument = (condition, argumentName, message) => {
59
- if (!condition) {
60
- const error = new TypeError(`Invalid argument \`${argumentName}\`` + (message ? `: ${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
- };
74
- export {
75
- InvalidStateError,
76
- InvariantViolation,
77
- assertArgument,
78
- assertState,
79
- failedInvariant,
80
- invariant
81
- };
82
- //# sourceMappingURL=index.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 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 */\n// TODO(dmaretskyi): Rename assertParameter.\nexport const assertArgument: (condition: unknown, argumentName: string, message?: string) => asserts condition = (\n condition: unknown,\n argumentName: string,\n message?: string,\n): asserts condition => {\n if (!condition) {\n const error = new TypeError(`Invalid argument \\`${argumentName}\\`` + (message ? `: ${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,iBAAoG,CAC/GC,WACAC,cACAC,YAAAA;AAEA,MAAI,CAACF,WAAW;AACd,UAAMG,QAAQ,IAAIC,UAAU,sBAAsBH,YAAAA,QAAoBC,UAAU,KAAKA,OAAAA,KAAY,GAAC;AAClGG,UAAMC,kBAAkBH,OAAOJ,cAAAA;AAC/B,UAAMI;EACR;AACF;AAoBO,IAAMI,cAA0E,CACrFP,WACAE,YAAAA;AAEA,MAAI,CAACF,WAAW;AACd,UAAMG,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", "Object", "setPrototypeOf", "prototype", "filename", "match", "filePath", "failedInvariant", "message1", "message2", "filter", "str", "join", "assertArgument", "condition", "argumentName", "message", "error", "TypeError", "Error", "captureStackTrace", "assertState", "InvalidStateError"]
7
- }
@@ -1 +0,0 @@
1
- {"inputs":{"src/invariant.ts":{"bytes":7562,"imports":[],"format":"esm"},"src/assert.ts":{"bytes":4370,"imports":[],"format":"esm"},"src/index.ts":{"bytes":463,"imports":[{"path":"src/invariant.ts","kind":"import-statement","original":"./invariant"},{"path":"src/assert.ts","kind":"import-statement","original":"./assert"}],"format":"esm"}},"outputs":{"dist/lib/node-esm/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5991},"dist/lib/node-esm/index.mjs":{"imports":[],"exports":["InvalidStateError","InvariantViolation","assertArgument","assertState","failedInvariant","invariant"],"entryPoint":"src/index.ts","inputs":{"src/invariant.ts":{"bytesInOutput":1308},"src/index.ts":{"bytesInOutput":0},"src/assert.ts":{"bytesInOutput":500}},"bytes":2093}}}