xenopomp-essentials 0.5.0-canary.1 → 0.5.0-canary.2

package/eslint/index.d.mts

@@ -36,4 +36,5 @@ type Options = OptionsConfig & CustomConfig & TypedFlatConfigItem & CustomOption
  */
 declare function xenopomp(options?: Options, ...userConfigs: UserConfigItem[]): Configs;
 
-export { type Configs, type CustomConfig, type Options, type UserConfigItem, xenopomp as default };
+export { xenopomp as default };
+export type { Configs, CustomConfig, Options, UserConfigItem };

package/eslint/index.d.ts

@@ -36,4 +36,5 @@ type Options = OptionsConfig & CustomConfig & TypedFlatConfigItem & CustomOption
  */
 declare function xenopomp(options?: Options, ...userConfigs: UserConfigItem[]): Configs;
 
-export { type Configs, type CustomConfig, type Options, type UserConfigItem, xenopomp as default };
+export { xenopomp as default };
+export type { Configs, CustomConfig, Options, UserConfigItem };

package/index.d.mts

@@ -1,3 +1,4 @@
+export { P as PromiseOr } from './shared/xenopomp-essentials.B-Vt61jj.mjs';
 import { ElementType, ComponentProps, FC, ReactNode, Dispatch, SetStateAction } from 'react';
 import { Jsonifiable } from 'type-fest';
 import * as transliteration from 'transliteration';
@@ -616,4 +617,5 @@ declare const minmax: (num: number, [min, max]: [min: number | undefined, max: n
  */
 declare function jsxDotNotation<Props = EmptyObject, Rest extends Record<string, FC<any>> = EmptyObject>(comp: FC<Props>, rest: Rest): FC<Props> & Rest;
 
-export { type AnyFC, type AnyObject, type ArrayItemType, type ArrayType, type AsyncFC, type AsyncReturnType, type AsyncVariableFC, type DataAttributes, type Defined, type EmptyObject, type FCProps, type FcProps, type Fn, type FunctionalChildren, type InjectDeep, type Jsonish, type Lenient, type LenientAutocomplete, type MatchType, type MergeTypes, type Modify, type NextErrorParams, type NextParams, type NextSearchParams, type Nullable, type OneOf, type OnlyFirst, type Optional, type Preid, type Prettify, type PrettifyDeep, type RecordKey, type RecordValue, type ReplaceReturnType, type SelectivePartial, type SetState, type StrictOmit, type Synchronous, type Undefinable, type VariableFC, type VariableProps, type VersionData, type WeakOmit, type Writeable, type WriteableDeep, capitalize, jsxDotNotation, minmax, parseVersion, pipe, transliterate, uncapitalize };
+export { capitalize, jsxDotNotation, minmax, parseVersion, pipe, transliterate, uncapitalize };
+export type { AnyFC, AnyObject, ArrayItemType, ArrayType, AsyncFC, AsyncReturnType, AsyncVariableFC, DataAttributes, Defined, EmptyObject, FCProps, FcProps, Fn, FunctionalChildren, InjectDeep, Jsonish, Lenient, LenientAutocomplete, MatchType, MergeTypes, Modify, NextErrorParams, NextParams, NextSearchParams, Nullable, OneOf, OnlyFirst, Optional, Preid, Prettify, PrettifyDeep, RecordKey, RecordValue, ReplaceReturnType, SelectivePartial, SetState, StrictOmit, Synchronous, Undefinable, VariableFC, VariableProps, VersionData, WeakOmit, Writeable, WriteableDeep };

package/index.d.ts

@@ -1,3 +1,4 @@
+export { P as PromiseOr } from './shared/xenopomp-essentials.B-Vt61jj.js';
 import { ElementType, ComponentProps, FC, ReactNode, Dispatch, SetStateAction } from 'react';
 import { Jsonifiable } from 'type-fest';
 import * as transliteration from 'transliteration';
@@ -616,4 +617,5 @@ declare const minmax: (num: number, [min, max]: [min: number | undefined, max: n
  */
 declare function jsxDotNotation<Props = EmptyObject, Rest extends Record<string, FC<any>> = EmptyObject>(comp: FC<Props>, rest: Rest): FC<Props> & Rest;
 
-export { type AnyFC, type AnyObject, type ArrayItemType, type ArrayType, type AsyncFC, type AsyncReturnType, type AsyncVariableFC, type DataAttributes, type Defined, type EmptyObject, type FCProps, type FcProps, type Fn, type FunctionalChildren, type InjectDeep, type Jsonish, type Lenient, type LenientAutocomplete, type MatchType, type MergeTypes, type Modify, type NextErrorParams, type NextParams, type NextSearchParams, type Nullable, type OneOf, type OnlyFirst, type Optional, type Preid, type Prettify, type PrettifyDeep, type RecordKey, type RecordValue, type ReplaceReturnType, type SelectivePartial, type SetState, type StrictOmit, type Synchronous, type Undefinable, type VariableFC, type VariableProps, type VersionData, type WeakOmit, type Writeable, type WriteableDeep, capitalize, jsxDotNotation, minmax, parseVersion, pipe, transliterate, uncapitalize };
+export { capitalize, jsxDotNotation, minmax, parseVersion, pipe, transliterate, uncapitalize };
+export type { AnyFC, AnyObject, ArrayItemType, ArrayType, AsyncFC, AsyncReturnType, AsyncVariableFC, DataAttributes, Defined, EmptyObject, FCProps, FcProps, Fn, FunctionalChildren, InjectDeep, Jsonish, Lenient, LenientAutocomplete, MatchType, MergeTypes, Modify, NextErrorParams, NextParams, NextSearchParams, Nullable, OneOf, OnlyFirst, Optional, Preid, Prettify, PrettifyDeep, RecordKey, RecordValue, ReplaceReturnType, SelectivePartial, SetState, StrictOmit, Synchronous, Undefinable, VariableFC, VariableProps, VersionData, WeakOmit, Writeable, WriteableDeep };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xenopomp-essentials",
-  "version": "0.5.0-canary.1",
+  "version": "0.5.0-canary.2",
   "author": "XenoPOMP <101574433+XenoPOMP@users.noreply.github.com>",
   "license": "MIT",
   "type": "module",
@@ -53,6 +53,8 @@
     "@typescript-eslint/types": "^8.48.0",
     "@typescript-eslint/utils": "^8.48.0",
     "@typescript-eslint/visitor-keys": "^8.48.0",
+    "@vitest/spy": "^4.0.14",
+    "ansi-colors": "^4.1.3",
     "deepmerge-ts": "^7.1.5",
     "eslint": "^9.22.0",
     "eslint-config-prettier": "^10.1.1",
@@ -88,7 +90,7 @@
     "prettier": "^3.4.2",
     "react-dom": "^19.2.0",
     "tsd": "^0.31.2",
-    "unbuild": "^3.3.1",
+    "unbuild": "^3.6.1",
     "vite": "^7.2.4",
     "vite-tsconfig-paths": "^5.1.4"
   }

package/shared/xenopomp-essentials.B-Vt61jj.d.mts

@@ -0,0 +1,3 @@
+type PromiseOr<T> = T | Promise<T>;
+
+export type { PromiseOr as P };

package/shared/xenopomp-essentials.B-Vt61jj.d.ts

@@ -0,0 +1,3 @@
+type PromiseOr<T> = T | Promise<T>;
+
+export type { PromiseOr as P };

package/vitest/index.d.mts

@@ -1,26 +1,93 @@
-import { renderHook, render } from '@testing-library/react';
+import { P as PromiseOr } from '../shared/xenopomp-essentials.B-Vt61jj.mjs';
+import { render, renderHook } from '@testing-library/react';
+import * as vitest from 'vitest';
+import * as _vitest_spy from '@vitest/spy';
 
 /** Executes function and expects that it won't throw. */
-declare const assertNotThrowing: (callable: () => void) => void;
-
-/**
- * Deeply checks if two objects are equal.
- *
- * @param expected
- * @param real
- */
-declare const expectToDeepEqual: <Type>(expected: Type, real: NoInfer<Type>) => void;
+declare const assertNotThrowing: <T = void>(callable: () => PromiseOr<T>) => void;
 
 type RenderArguments = Parameters<typeof render>;
 type RenderHookArguments = Parameters<typeof renderHook>;
 type RenderFunc<Args extends unknown[] = RenderArguments> = (...args: Args) => void;
-/** Renders component and expects that it won't throw error. */
-declare const expectToRender: RenderFunc;
+/**
+ * Renders component and expects that it won`t throw.
+ *
+ * @example
+ * test('It renders', () => {
+ *   test('It renders', () => {
+ *     assertRendering(<MyComponent />, {
+ *       wrapper: RQProvider,
+ *     });
+ *   });
+ * });
+ *
+ */
+declare const assertRendering: RenderFunc;
 /**
  * Renders hook within test React component without having to create that component yourself.
  * Expects that it won't throw error.
+ *
  * @param props
+ *
+ * @example
+ * test('It renders', () => {
+ *   assertHookRendering(() => useExampleStore());
+ * });
+ */
+declare const assertHookRendering: RenderFunc<RenderHookArguments>;
+
+/**
+ * Mocks .env file.
+ *
+ * @param additionalMocks  key-value record of env variables that also have to be mocked.
+ */
+declare const mockEnv: (additionalMocks?: Record<string, string>) => void;
+
+/**
+ * Clear all mocks from Vitest.
+ */
+declare const clearMocks: () => void;
+
+/**
+ * Mock **next/navigation** package.
+ */
+declare const mockRouter: () => void;
+
+declare const twApiMock: {
+    addBase: vitest.Mock<_vitest_spy.Procedure>;
+    addComponents: vitest.Mock<_vitest_spy.Procedure>;
+    addUtilities: vitest.Mock<_vitest_spy.Procedure>;
+    addVariant: vitest.Mock<_vitest_spy.Procedure>;
+    config: vitest.Mock<_vitest_spy.Procedure>;
+    corePlugins: vitest.Mock<_vitest_spy.Procedure>;
+    e: vitest.Mock<_vitest_spy.Procedure>;
+    matchComponents: vitest.Mock<_vitest_spy.Procedure>;
+    matchUtilities: vitest.Mock<_vitest_spy.Procedure>;
+    matchVariant: vitest.Mock<_vitest_spy.Procedure>;
+    theme: vitest.Mock<_vitest_spy.Procedure>;
+};
+
+type Caller = (...args: any[]) => void;
+/**
+ * Creates custom spy factory object that is callable.
+ * @param context
+ * @example
+ * const { callSpy, expectToBeCalled, expectToBeNotCalled } =
+ *   spyFactory('spyFactory test');
+ *
+ * // Call spy with some args
+ * const args: any[] = [1, 'some', 'args', 2];
+ * callSpy(...args);
+ *
+ * // Run expectation func
+ * expectToBeCalled(...args);
+ * expectToBeNotCalled(2, 2, 7);
  */
-declare const expectHookToRender: RenderFunc<RenderHookArguments>;
+declare function spyFactory(context: string): {
+    expectToBeCalled: Caller;
+    expectToBeNotCalled: Caller;
+    spy: vitest.Mock<(...args: any[]) => void>;
+    callSpy: Caller;
+};
 
-export { assertNotThrowing, expectHookToRender, expectToDeepEqual, expectToRender };
+export { assertHookRendering, assertNotThrowing, assertRendering, clearMocks, mockEnv, mockRouter, spyFactory, twApiMock };

package/vitest/index.d.ts

@@ -1,26 +1,93 @@
-import { renderHook, render } from '@testing-library/react';
+import { P as PromiseOr } from '../shared/xenopomp-essentials.B-Vt61jj.js';
+import { render, renderHook } from '@testing-library/react';
+import * as vitest from 'vitest';
+import * as _vitest_spy from '@vitest/spy';
 
 /** Executes function and expects that it won't throw. */
-declare const assertNotThrowing: (callable: () => void) => void;
-
-/**
- * Deeply checks if two objects are equal.
- *
- * @param expected
- * @param real
- */
-declare const expectToDeepEqual: <Type>(expected: Type, real: NoInfer<Type>) => void;
+declare const assertNotThrowing: <T = void>(callable: () => PromiseOr<T>) => void;
 
 type RenderArguments = Parameters<typeof render>;
 type RenderHookArguments = Parameters<typeof renderHook>;
 type RenderFunc<Args extends unknown[] = RenderArguments> = (...args: Args) => void;
-/** Renders component and expects that it won't throw error. */
-declare const expectToRender: RenderFunc;
+/**
+ * Renders component and expects that it won`t throw.
+ *
+ * @example
+ * test('It renders', () => {
+ *   test('It renders', () => {
+ *     assertRendering(<MyComponent />, {
+ *       wrapper: RQProvider,
+ *     });
+ *   });
+ * });
+ *
+ */
+declare const assertRendering: RenderFunc;
 /**
  * Renders hook within test React component without having to create that component yourself.
  * Expects that it won't throw error.
+ *
  * @param props
+ *
+ * @example
+ * test('It renders', () => {
+ *   assertHookRendering(() => useExampleStore());
+ * });
+ */
+declare const assertHookRendering: RenderFunc<RenderHookArguments>;
+
+/**
+ * Mocks .env file.
+ *
+ * @param additionalMocks  key-value record of env variables that also have to be mocked.
+ */
+declare const mockEnv: (additionalMocks?: Record<string, string>) => void;
+
+/**
+ * Clear all mocks from Vitest.
+ */
+declare const clearMocks: () => void;
+
+/**
+ * Mock **next/navigation** package.
+ */
+declare const mockRouter: () => void;
+
+declare const twApiMock: {
+    addBase: vitest.Mock<_vitest_spy.Procedure>;
+    addComponents: vitest.Mock<_vitest_spy.Procedure>;
+    addUtilities: vitest.Mock<_vitest_spy.Procedure>;
+    addVariant: vitest.Mock<_vitest_spy.Procedure>;
+    config: vitest.Mock<_vitest_spy.Procedure>;
+    corePlugins: vitest.Mock<_vitest_spy.Procedure>;
+    e: vitest.Mock<_vitest_spy.Procedure>;
+    matchComponents: vitest.Mock<_vitest_spy.Procedure>;
+    matchUtilities: vitest.Mock<_vitest_spy.Procedure>;
+    matchVariant: vitest.Mock<_vitest_spy.Procedure>;
+    theme: vitest.Mock<_vitest_spy.Procedure>;
+};
+
+type Caller = (...args: any[]) => void;
+/**
+ * Creates custom spy factory object that is callable.
+ * @param context
+ * @example
+ * const { callSpy, expectToBeCalled, expectToBeNotCalled } =
+ *   spyFactory('spyFactory test');
+ *
+ * // Call spy with some args
+ * const args: any[] = [1, 'some', 'args', 2];
+ * callSpy(...args);
+ *
+ * // Run expectation func
+ * expectToBeCalled(...args);
+ * expectToBeNotCalled(2, 2, 7);
  */
-declare const expectHookToRender: RenderFunc<RenderHookArguments>;
+declare function spyFactory(context: string): {
+    expectToBeCalled: Caller;
+    expectToBeNotCalled: Caller;
+    spy: vitest.Mock<(...args: any[]) => void>;
+    callSpy: Caller;
+};
 
-export { assertNotThrowing, expectHookToRender, expectToDeepEqual, expectToRender };
+export { assertHookRendering, assertNotThrowing, assertRendering, clearMocks, mockEnv, mockRouter, spyFactory, twApiMock };

package/vitest/index.mjs

@@ -1 +1 @@
-import{expect as t}from"vitest";import{render as n,renderHook as p}from"@testing-library/react";const o=e=>{t(()=>e()).not.toThrow()},c=(e,r)=>{t(e).to.deep.equal(r)},d=(...e)=>{o(()=>n(...e))},s=(...e)=>{o(()=>p(...e))};export{o as assertNotThrowing,s as expectHookToRender,c as expectToDeepEqual,d as expectToRender};
+import{expect as c,vi as t}from"vitest";import{render as l,renderHook as r}from"@testing-library/react";import{blue as i,green as u,blueBright as d}from"ansi-colors";const a=e=>{c(()=>e()).not.toThrow()},f=(...e)=>{a(()=>l(...e))},h=(...e)=>{a(()=>r(...e))},m=e=>{t.stubEnv("CANONICAL_URL","http://localhost:4242"),t.stubEnv("IS_PRODUCTION","false"),e&&Object.entries(e).forEach(([n,o])=>t.stubEnv(n,o))},p=()=>{t.clearAllMocks(),t.resetAllMocks(),t.unstubAllEnvs(),t.unstubAllGlobals()},C=()=>{t.mock("next/navigation",()=>({useRouter:()=>({push(){}}),usePathname:()=>"/"}))},x={addBase:t.fn(),addComponents:t.fn(),addUtilities:t.fn(),addVariant:t.fn(),config:t.fn(),corePlugins:t.fn(),e:t.fn(),matchComponents:t.fn(),matchUtilities:t.fn(),matchVariant:t.fn(),theme:t.fn()};class b{_executionContext;constructor(n){this._executionContext=n}call(...n){console.debug(`${i(`[${this._executionContext}]`)} ${u(`Custom spy is called with these args: ${d(n.map(o=>`${o}`).join(", "))}`)}`)}}function g(e){const n=new b(e),o=t.spyOn(n,"call");return{expectToBeCalled:(...s)=>c(o).toHaveBeenCalledWith(s),expectToBeNotCalled:(...s)=>c(o).not.toHaveBeenCalledWith(s),spy:o,callSpy:(...s)=>n.call(s)}}export{h as assertHookRendering,a as assertNotThrowing,f as assertRendering,p as clearMocks,m as mockEnv,C as mockRouter,g as spyFactory,x as twApiMock};