@xylabs/vitest-extended 4.3.6 → 4.3.8

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 (7) hide show
  1. package/dist/neutral/customMatchers.d.ts +8 -0
  2. package/dist/neutral/customMatchers.d.ts.map +1 -1
  3. package/dist/neutral/index.mjs +34 -0
  4. package/dist/neutral/index.mjs.map +1 -1
  5. package/package.json +1 -1
  6. package/src/customMatchers.ts +43 -0
  7. package/src/vitest.customMatchers.d.ts +10 -0
package/dist/neutral/customMatchers.d.ts CHANGED
@@ -3,6 +3,10 @@ export declare const matchers: {
3
3
  message: () => string;
4
4
  pass: boolean;
5
5
  };
6
+ toBeArray(received: unknown): {
7
+ message: () => string;
8
+ pass: boolean;
9
+ };
6
10
  toBeNumber: (received: unknown) => {
7
11
  message: () => string;
8
12
  pass: boolean;
@@ -27,5 +31,9 @@ export declare const matchers: {
27
31
  pass: boolean;
28
32
  message: () => string;
29
33
  };
34
+ toContainAllKeys(received: object, expectedKeys: string[]): {
35
+ pass: boolean;
36
+ message: () => string;
37
+ };
30
38
  };
31
39
  //# sourceMappingURL=customMatchers.d.ts.map
package/dist/neutral/customMatchers.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"customMatchers.d.ts","sourceRoot":"","sources":["../../src/customMatchers.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,QAAQ;8BACO,OAAO,gBAAgB,MAAM;;;;2BAchC,OAAO;;;;6BACL,OAAO;;;;2BACT,OAAO;;;;wBACV,OAAO;;;;uBAYR,OAAO;;;;kCAYI,OAAO,EAAE,YAAY,OAAO,EAAE;;;;CAwB7D,CAAA"}
1
+ {"version":3,"file":"customMatchers.d.ts","sourceRoot":"","sources":["../../src/customMatchers.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,QAAQ;8BACO,OAAO,gBAAgB,MAAM;;;;wBAcnC,OAAO;;;;2BAYJ,OAAO;;;;6BACL,OAAO;;;;2BACT,OAAO;;;;wBACV,OAAO;;;;uBAYR,OAAO;;;;kCAYI,OAAO,EAAE,YAAY,OAAO,EAAE;;;;+BAwBjC,MAAM,gBAAgB,MAAM,EAAE;;;;CA+B1D,CAAA"}
package/dist/neutral/index.mjs CHANGED
@@ -21,6 +21,16 @@ var matchers = {
21
21
  pass: false
22
22
  };
23
23
  },
24
+ toBeArray(received) {
25
+ const pass = Array.isArray(received);
26
+ return pass ? {
27
+ message: () => "expected array",
28
+ pass: true
29
+ } : {
30
+ message: () => `expected array, but received ${typeof received}`,
31
+ pass: false
32
+ };
33
+ },
24
34
  toBeNumber: (received) => toBeType(received, "number"),
25
35
  toBeFunction: (received) => toBeType(received, "function"),
26
36
  toBeString: (received) => toBeType(received, "string"),
@@ -61,6 +71,30 @@ var matchers = {
61
71
  missingMembers
62
72
  )}.`
63
73
  };
74
+ },
75
+ toContainAllKeys(received, expectedKeys) {
76
+ if (typeof received !== "object" || received === null) {
77
+ return {
78
+ pass: false,
79
+ message: () => `Expected ${JSON.stringify(received)} to be an object.`
80
+ };
81
+ }
82
+ if (!Array.isArray(expectedKeys)) {
83
+ return {
84
+ pass: false,
85
+ message: () => `Expected keys to be an array, but received ${JSON.stringify(expectedKeys)}.`
86
+ };
87
+ }
88
+ const missingKeys = expectedKeys.filter((key) => !(key in received));
89
+ return missingKeys.length === 0 ? {
90
+ pass: true,
91
+ message: () => `Expected object not to contain all keys ${JSON.stringify(expectedKeys)}, but it does.`
92
+ } : {
93
+ pass: false,
94
+ message: () => `Expected object to contain all keys ${JSON.stringify(expectedKeys)}. Missing keys: ${JSON.stringify(
95
+ missingKeys
96
+ )}.`
97
+ };
64
98
  }
65
99
  };
66
100
  expect.extend(matchers);
package/dist/neutral/index.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/customMatchers.ts"],"sourcesContent":["import { expect } from 'vitest'\n\nfunction toBeType(received: unknown, expectedType: string) {\n const pass = typeof received === expectedType && !Number.isNaN(received)\n return pass\n ? {\n message: () => `expected ${received} not to be a ${expectedType}`,\n pass: true,\n }\n : {\n message: () => `expected ${received} to be a ${expectedType}`,\n pass: false,\n }\n}\n\nexport const matchers = {\n toBeArrayOfSize(received: unknown, expectedSize: number) {\n const pass = Array.isArray(received) && received.length === expectedSize\n return pass\n ? {\n message: () => `expected array not to have size ${expectedSize}, but received array of size ${received.length}`,\n pass: true,\n }\n : {\n message: () => Array.isArray(received)\n ? `expected array of size ${expectedSize}, but received array of size ${received.length}`\n : `expected array of size ${expectedSize}, but received a non-array`,\n pass: false,\n }\n },\n toBeNumber: (received: unknown) => toBeType(received, 'number'),\n toBeFunction: (received: unknown) => toBeType(received, 'function'),\n toBeString: (received: unknown) => toBeType(received, 'string'),\n toBeFalse(received: unknown) {\n const pass = received === false\n return pass\n ? {\n message: () => `expected ${received} to be false`,\n pass: true,\n }\n : {\n message: () => `expected ${received} to be false but was not false`,\n pass: false,\n }\n },\n toBeTrue(received: unknown) {\n const pass = received === true\n return pass\n ? {\n message: () => `expected ${received} to be true`,\n pass: true,\n }\n : {\n message: () => `expected ${received} to be true but was not true`,\n pass: false,\n }\n },\n toIncludeAllMembers(received: unknown[], expected: unknown[]) {\n if (!Array.isArray(received) || !Array.isArray(expected)) {\n return {\n pass: false,\n message: () => 'Expected both received and expected values to be arrays.',\n }\n }\n\n const missingMembers = expected.filter(item => !received.includes(item))\n\n return missingMembers.length === 0\n ? {\n pass: true,\n message: () =>\n `Expected array not to include all members of ${JSON.stringify(expected)}, but it does.`,\n }\n : {\n pass: false,\n message: () =>\n `Expected array to include all members of ${JSON.stringify(expected)}. Missing members: ${JSON.stringify(\n missingMembers,\n )}.`,\n }\n },\n}\n\nexpect.extend(matchers)\n"],"mappings":";AAAA,SAAS,cAAc;AAEvB,SAAS,SAAS,UAAmB,cAAsB;AACzD,QAAM,OAAO,OAAO,aAAa,gBAAgB,CAAC,OAAO,MAAM,QAAQ;AACvE,SAAO,OACH;AAAA,IACE,SAAS,MAAM,YAAY,QAAQ,gBAAgB,YAAY;AAAA,IAC/D,MAAM;AAAA,EACR,IACA;AAAA,IACE,SAAS,MAAM,YAAY,QAAQ,YAAY,YAAY;AAAA,IAC3D,MAAM;AAAA,EACR;AACN;AAEO,IAAM,WAAW;AAAA,EACtB,gBAAgB,UAAmB,cAAsB;AACvD,UAAM,OAAO,MAAM,QAAQ,QAAQ,KAAK,SAAS,WAAW;AAC5D,WAAO,OACH;AAAA,MACE,SAAS,MAAM,mCAAmC,YAAY,gCAAgC,SAAS,MAAM;AAAA,MAC7G,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,MAAM,QAAQ,QAAQ,IACjC,0BAA0B,YAAY,gCAAgC,SAAS,MAAM,KACrF,0BAA0B,YAAY;AAAA,MAC1C,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,YAAY,CAAC,aAAsB,SAAS,UAAU,QAAQ;AAAA,EAC9D,cAAc,CAAC,aAAsB,SAAS,UAAU,UAAU;AAAA,EAClE,YAAY,CAAC,aAAsB,SAAS,UAAU,QAAQ;AAAA,EAC9D,UAAU,UAAmB;AAC3B,UAAM,OAAO,aAAa;AAC1B,WAAO,OACH;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,SAAS,UAAmB;AAC1B,UAAM,OAAO,aAAa;AAC1B,WAAO,OACH;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,oBAAoB,UAAqB,UAAqB;AAC5D,QAAI,CAAC,MAAM,QAAQ,QAAQ,KAAK,CAAC,MAAM,QAAQ,QAAQ,GAAG;AACxD,aAAO;AAAA,QACL,MAAM;AAAA,QACN,SAAS,MAAM;AAAA,MACjB;AAAA,IACF;AAEA,UAAM,iBAAiB,SAAS,OAAO,UAAQ,CAAC,SAAS,SAAS,IAAI,CAAC;AAEvE,WAAO,eAAe,WAAW,IAC7B;AAAA,MACE,MAAM;AAAA,MACN,SAAS,MACP,gDAAgD,KAAK,UAAU,QAAQ,CAAC;AAAA,IAC5E,IACA;AAAA,MACE,MAAM;AAAA,MACN,SAAS,MACP,4CAA4C,KAAK,UAAU,QAAQ,CAAC,sBAAsB,KAAK;AAAA,QAC7F;AAAA,MACF,CAAC;AAAA,IACL;AAAA,EACN;AACF;AAEA,OAAO,OAAO,QAAQ;","names":[]}
1
+ {"version":3,"sources":["../../src/customMatchers.ts"],"sourcesContent":["import { expect } from 'vitest'\n\nfunction toBeType(received: unknown, expectedType: string) {\n const pass = typeof received === expectedType && !Number.isNaN(received)\n return pass\n ? {\n message: () => `expected ${received} not to be a ${expectedType}`,\n pass: true,\n }\n : {\n message: () => `expected ${received} to be a ${expectedType}`,\n pass: false,\n }\n}\n\nexport const matchers = {\n toBeArrayOfSize(received: unknown, expectedSize: number) {\n const pass = Array.isArray(received) && received.length === expectedSize\n return pass\n ? {\n message: () => `expected array not to have size ${expectedSize}, but received array of size ${received.length}`,\n pass: true,\n }\n : {\n message: () => Array.isArray(received)\n ? `expected array of size ${expectedSize}, but received array of size ${received.length}`\n : `expected array of size ${expectedSize}, but received a non-array`,\n pass: false,\n }\n },\n toBeArray(received: unknown) {\n const pass = Array.isArray(received)\n return pass\n ? {\n message: () => 'expected array',\n pass: true,\n }\n : {\n message: () => `expected array, but received ${typeof received}`,\n pass: false,\n }\n },\n toBeNumber: (received: unknown) => toBeType(received, 'number'),\n toBeFunction: (received: unknown) => toBeType(received, 'function'),\n toBeString: (received: unknown) => toBeType(received, 'string'),\n toBeFalse(received: unknown) {\n const pass = received === false\n return pass\n ? {\n message: () => `expected ${received} to be false`,\n pass: true,\n }\n : {\n message: () => `expected ${received} to be false but was not false`,\n pass: false,\n }\n },\n toBeTrue(received: unknown) {\n const pass = received === true\n return pass\n ? {\n message: () => `expected ${received} to be true`,\n pass: true,\n }\n : {\n message: () => `expected ${received} to be true but was not true`,\n pass: false,\n }\n },\n toIncludeAllMembers(received: unknown[], expected: unknown[]) {\n if (!Array.isArray(received) || !Array.isArray(expected)) {\n return {\n pass: false,\n message: () => 'Expected both received and expected values to be arrays.',\n }\n }\n\n const missingMembers = expected.filter(item => !received.includes(item))\n\n return missingMembers.length === 0\n ? {\n pass: true,\n message: () =>\n `Expected array not to include all members of ${JSON.stringify(expected)}, but it does.`,\n }\n : {\n pass: false,\n message: () =>\n `Expected array to include all members of ${JSON.stringify(expected)}. Missing members: ${JSON.stringify(\n missingMembers,\n )}.`,\n }\n },\n toContainAllKeys(received: object, expectedKeys: string[]) {\n if (typeof received !== 'object' || received === null) {\n return {\n pass: false,\n message: () => `Expected ${JSON.stringify(received)} to be an object.`,\n }\n }\n\n if (!Array.isArray(expectedKeys)) {\n return {\n pass: false,\n message: () => `Expected keys to be an array, but received ${JSON.stringify(expectedKeys)}.`,\n }\n }\n\n const missingKeys = expectedKeys.filter(key => !(key in received))\n\n return missingKeys.length === 0\n ? {\n pass: true,\n message: () =>\n `Expected object not to contain all keys ${JSON.stringify(expectedKeys)}, but it does.`,\n }\n : {\n pass: false,\n message: () =>\n `Expected object to contain all keys ${JSON.stringify(expectedKeys)}. Missing keys: ${JSON.stringify(\n missingKeys,\n )}.`,\n }\n },\n}\n\nexpect.extend(matchers)\n"],"mappings":";AAAA,SAAS,cAAc;AAEvB,SAAS,SAAS,UAAmB,cAAsB;AACzD,QAAM,OAAO,OAAO,aAAa,gBAAgB,CAAC,OAAO,MAAM,QAAQ;AACvE,SAAO,OACH;AAAA,IACE,SAAS,MAAM,YAAY,QAAQ,gBAAgB,YAAY;AAAA,IAC/D,MAAM;AAAA,EACR,IACA;AAAA,IACE,SAAS,MAAM,YAAY,QAAQ,YAAY,YAAY;AAAA,IAC3D,MAAM;AAAA,EACR;AACN;AAEO,IAAM,WAAW;AAAA,EACtB,gBAAgB,UAAmB,cAAsB;AACvD,UAAM,OAAO,MAAM,QAAQ,QAAQ,KAAK,SAAS,WAAW;AAC5D,WAAO,OACH;AAAA,MACE,SAAS,MAAM,mCAAmC,YAAY,gCAAgC,SAAS,MAAM;AAAA,MAC7G,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,MAAM,QAAQ,QAAQ,IACjC,0BAA0B,YAAY,gCAAgC,SAAS,MAAM,KACrF,0BAA0B,YAAY;AAAA,MAC1C,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,UAAU,UAAmB;AAC3B,UAAM,OAAO,MAAM,QAAQ,QAAQ;AACnC,WAAO,OACH;AAAA,MACE,SAAS,MAAM;AAAA,MACf,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,gCAAgC,OAAO,QAAQ;AAAA,MAC9D,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,YAAY,CAAC,aAAsB,SAAS,UAAU,QAAQ;AAAA,EAC9D,cAAc,CAAC,aAAsB,SAAS,UAAU,UAAU;AAAA,EAClE,YAAY,CAAC,aAAsB,SAAS,UAAU,QAAQ;AAAA,EAC9D,UAAU,UAAmB;AAC3B,UAAM,OAAO,aAAa;AAC1B,WAAO,OACH;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,SAAS,UAAmB;AAC1B,UAAM,OAAO,aAAa;AAC1B,WAAO,OACH;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR,IACA;AAAA,MACE,SAAS,MAAM,YAAY,QAAQ;AAAA,MACnC,MAAM;AAAA,IACR;AAAA,EACN;AAAA,EACA,oBAAoB,UAAqB,UAAqB;AAC5D,QAAI,CAAC,MAAM,QAAQ,QAAQ,KAAK,CAAC,MAAM,QAAQ,QAAQ,GAAG;AACxD,aAAO;AAAA,QACL,MAAM;AAAA,QACN,SAAS,MAAM;AAAA,MACjB;AAAA,IACF;AAEA,UAAM,iBAAiB,SAAS,OAAO,UAAQ,CAAC,SAAS,SAAS,IAAI,CAAC;AAEvE,WAAO,eAAe,WAAW,IAC7B;AAAA,MACE,MAAM;AAAA,MACN,SAAS,MACP,gDAAgD,KAAK,UAAU,QAAQ,CAAC;AAAA,IAC5E,IACA;AAAA,MACE,MAAM;AAAA,MACN,SAAS,MACP,4CAA4C,KAAK,UAAU,QAAQ,CAAC,sBAAsB,KAAK;AAAA,QAC7F;AAAA,MACF,CAAC;AAAA,IACL;AAAA,EACN;AAAA,EACA,iBAAiB,UAAkB,cAAwB;AACzD,QAAI,OAAO,aAAa,YAAY,aAAa,MAAM;AACrD,aAAO;AAAA,QACL,MAAM;AAAA,QACN,SAAS,MAAM,YAAY,KAAK,UAAU,QAAQ,CAAC;AAAA,MACrD;AAAA,IACF;AAEA,QAAI,CAAC,MAAM,QAAQ,YAAY,GAAG;AAChC,aAAO;AAAA,QACL,MAAM;AAAA,QACN,SAAS,MAAM,8CAA8C,KAAK,UAAU,YAAY,CAAC;AAAA,MAC3F;AAAA,IACF;AAEA,UAAM,cAAc,aAAa,OAAO,SAAO,EAAE,OAAO,SAAS;AAEjE,WAAO,YAAY,WAAW,IAC1B;AAAA,MACE,MAAM;AAAA,MACN,SAAS,MACP,2CAA2C,KAAK,UAAU,YAAY,CAAC;AAAA,IAC3E,IACA;AAAA,MACE,MAAM;AAAA,MACN,SAAS,MACP,uCAAuC,KAAK,UAAU,YAAY,CAAC,mBAAmB,KAAK;AAAA,QACzF;AAAA,MACF,CAAC;AAAA,IACL;AAAA,EACN;AACF;AAEA,OAAO,OAAO,QAAQ;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/vitest-extended",
3
- "version": "4.3.6",
3
+ "version": "4.3.8",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "log",
package/src/customMatchers.ts CHANGED
@@ -28,6 +28,18 @@ export const matchers = {
28
28
  pass: false,
29
29
  }
30
30
  },
31
+ toBeArray(received: unknown) {
32
+ const pass = Array.isArray(received)
33
+ return pass
34
+ ? {
35
+ message: () => 'expected array',
36
+ pass: true,
37
+ }
38
+ : {
39
+ message: () => `expected array, but received ${typeof received}`,
40
+ pass: false,
41
+ }
42
+ },
31
43
  toBeNumber: (received: unknown) => toBeType(received, 'number'),
32
44
  toBeFunction: (received: unknown) => toBeType(received, 'function'),
33
45
  toBeString: (received: unknown) => toBeType(received, 'string'),
@@ -79,6 +91,37 @@ export const matchers = {
79
91
  )}.`,
80
92
  }
81
93
  },
94
+ toContainAllKeys(received: object, expectedKeys: string[]) {
95
+ if (typeof received !== 'object' || received === null) {
96
+ return {
97
+ pass: false,
98
+ message: () => `Expected ${JSON.stringify(received)} to be an object.`,
99
+ }
100
+ }
101
+
102
+ if (!Array.isArray(expectedKeys)) {
103
+ return {
104
+ pass: false,
105
+ message: () => `Expected keys to be an array, but received ${JSON.stringify(expectedKeys)}.`,
106
+ }
107
+ }
108
+
109
+ const missingKeys = expectedKeys.filter(key => !(key in received))
110
+
111
+ return missingKeys.length === 0
112
+ ? {
113
+ pass: true,
114
+ message: () =>
115
+ `Expected object not to contain all keys ${JSON.stringify(expectedKeys)}, but it does.`,
116
+ }
117
+ : {
118
+ pass: false,
119
+ message: () =>
120
+ `Expected object to contain all keys ${JSON.stringify(expectedKeys)}. Missing keys: ${JSON.stringify(
121
+ missingKeys,
122
+ )}.`,
123
+ }
124
+ },
82
125
  }
83
126
 
84
127
  expect.extend(matchers)
package/src/vitest.customMatchers.d.ts CHANGED
@@ -9,6 +9,9 @@ declare module 'vitest' {
9
9
  interface Assertion<T = unknown> {
10
10
  toBeFunction(): T
11
11
  }
12
+ interface Assertion<T = unknown> {
13
+ toBeArray(): T
14
+ }
12
15
  interface Assertion<T = unknown> {
13
16
  toBeString(): T
14
17
  }
@@ -22,16 +25,23 @@ declare module 'vitest' {
22
25
  toBeArrayOfSize(size: number): T
23
26
  }
24
27
 
28
+ interface Assertion<T = unknown> {
29
+ toContainAllKeys(received: object, expectedKeys: string[]): T
30
+ }
31
+
25
32
  interface Assertion<T = unknown> {
26
33
  toIncludeAllMembers(received: unknown[], expected: unknown[]): T
27
34
  }
35
+
28
36
  interface expect {
37
+ toBeArray(): T
29
38
  toBeArrayOfSize(size: number): T
30
39
  toBeFalse(): T
31
40
  toBeFunction(): T
32
41
  toBeNumber(): T
33
42
  toBeString(): T
34
43
  toBeTrue(): T
44
+ toContainAllKeys(received: object, expectedKeys: string[]): T
35
45
  toIncludeAllMembers(received: unknown[], expected: unknown[]): T
36
46
  }
37
47
  }