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

package/index.d.mts

@@ -1,4 +1,4 @@
-export { P as PromiseOr } from './shared/xenopomp-essentials.B-Vt61jj.mjs';
+export { O as Optional, P as PromiseOr, U as Undefinable } from './shared/xenopomp-essentials.CO5lcTlK.mjs';
 import { ElementType, ComponentProps, FC, ReactNode, Dispatch, SetStateAction } from 'react';
 import { Jsonifiable } from 'type-fest';
 import * as transliteration from 'transliteration';
@@ -345,17 +345,6 @@ type ReplaceReturnType<TFn, TR> = TFn extends (...a: infer A) => any ? (...a: A)
  */
 type SelectivePartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 
-/**
- * Makes type union of type T and undefined
- * @since 0.0.1
- * @deprecated Renamed to {@link Optional}.
- */
-type Undefinable<T> = T | undefined;
-/**
- * Marks type as optional (undefinable).
- */
-type Optional<T> = T | undefined;
-
 /**
  * The strict version of Omit. Allows to remove only
  * keys that are presented in T type.
@@ -618,4 +607,4 @@ 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 { 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 };
+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, Preid, Prettify, PrettifyDeep, RecordKey, RecordValue, ReplaceReturnType, SelectivePartial, SetState, StrictOmit, Synchronous, VariableFC, VariableProps, VersionData, WeakOmit, Writeable, WriteableDeep };

package/index.d.ts

@@ -1,4 +1,4 @@
-export { P as PromiseOr } from './shared/xenopomp-essentials.B-Vt61jj.js';
+export { O as Optional, P as PromiseOr, U as Undefinable } from './shared/xenopomp-essentials.CO5lcTlK.js';
 import { ElementType, ComponentProps, FC, ReactNode, Dispatch, SetStateAction } from 'react';
 import { Jsonifiable } from 'type-fest';
 import * as transliteration from 'transliteration';
@@ -345,17 +345,6 @@ type ReplaceReturnType<TFn, TR> = TFn extends (...a: infer A) => any ? (...a: A)
  */
 type SelectivePartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 
-/**
- * Makes type union of type T and undefined
- * @since 0.0.1
- * @deprecated Renamed to {@link Optional}.
- */
-type Undefinable<T> = T | undefined;
-/**
- * Marks type as optional (undefinable).
- */
-type Optional<T> = T | undefined;
-
 /**
  * The strict version of Omit. Allows to remove only
  * keys that are presented in T type.
@@ -618,4 +607,4 @@ 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 { 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 };
+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, Preid, Prettify, PrettifyDeep, RecordKey, RecordValue, ReplaceReturnType, SelectivePartial, SetState, StrictOmit, Synchronous, VariableFC, VariableProps, VersionData, WeakOmit, Writeable, WriteableDeep };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xenopomp-essentials",
-  "version": "0.5.0-canary.2",
+  "version": "0.5.0-canary.4",
   "author": "XenoPOMP <101574433+XenoPOMP@users.noreply.github.com>",
   "license": "MIT",
   "type": "module",
@@ -69,6 +69,7 @@
     "type-fest": "^4.33.0",
     "typescript": "^5.7.3",
     "vitest": "^4.0.14",
+    "vitest-matchmedia-mock": "^2.0.3",
     "zod": "^3.24.1"
   },
   "devDependencies": {

package/shared/xenopomp-essentials.CO5lcTlK.d.mts

@@ -0,0 +1,14 @@
+type PromiseOr<T> = T | Promise<T>;
+
+/**
+ * Makes type union of type T and undefined
+ * @since 0.0.1
+ * @deprecated Renamed to {@link Optional}.
+ */
+type Undefinable<T> = T | undefined;
+/**
+ * Marks type as optional (undefinable).
+ */
+type Optional<T> = T | undefined;
+
+export type { Optional as O, PromiseOr as P, Undefinable as U };

package/shared/xenopomp-essentials.CO5lcTlK.d.ts

@@ -0,0 +1,14 @@
+type PromiseOr<T> = T | Promise<T>;
+
+/**
+ * Makes type union of type T and undefined
+ * @since 0.0.1
+ * @deprecated Renamed to {@link Optional}.
+ */
+type Undefinable<T> = T | undefined;
+/**
+ * Marks type as optional (undefinable).
+ */
+type Optional<T> = T | undefined;
+
+export type { Optional as O, PromiseOr as P, Undefinable as U };

package/vitest/index.d.mts

@@ -1,7 +1,9 @@
-import { P as PromiseOr } from '../shared/xenopomp-essentials.B-Vt61jj.mjs';
+import { P as PromiseOr, O as Optional } from '../shared/xenopomp-essentials.CO5lcTlK.mjs';
 import { render, renderHook } from '@testing-library/react';
 import * as vitest from 'vitest';
+import { beforeAll, afterEach, Mock } from 'vitest';
 import * as _vitest_spy from '@vitest/spy';
+import { PartialDeep } from 'type-fest';
 
 /** Executes function and expects that it won't throw. */
 declare const assertNotThrowing: <T = void>(callable: () => PromiseOr<T>) => void;
@@ -90,4 +92,85 @@ declare function spyFactory(context: string): {
     callSpy: Caller;
 };
 
-export { assertHookRendering, assertNotThrowing, assertRendering, clearMocks, mockEnv, mockRouter, spyFactory, twApiMock };
+/**
+ * Mocks global scope object.
+ *
+ * @param name
+ * @param stub
+ *
+ * @example
+ * stubGlobal<typeof navigator>('navigator', {
+ *     clipboard: {
+ *       writeText: async (text: string) => vi.fn(),
+ *     },
+ * });
+ */
+declare const stubGlobal: <Global extends object>(name: string, stub: PartialDeep<Stub<Global>>) => void;
+
+type Fn = () => void;
+type Strategy = keyof typeof strategies;
+type AfterAllCallback = Optional<Fn> | void;
+/**
+ * Map of all available strategies for
+ * injectMocks function.
+ */
+declare const strategies: {
+    beforeAll: typeof beforeAll;
+    afterEach: typeof afterEach;
+};
+/**
+ * Inserts mocks according to selected strategy
+ * (default is `beforeAll`).
+ *
+ * This function takes approach of useEffect hook
+ * from React. You define mocks inside function body,
+ * then you return function, that will be called
+ * in `afterAll` event.
+ *
+ * @example
+ * injectMocks(() => {
+ *     mockRouter();
+ *
+ *     return () => {
+ *       console.log('This is printed from injectMocks func (afterAll event).');
+ *     };
+ *   });
+ */
+declare const injectMocks: (func: () => AfterAllCallback, strategy?: Strategy) => void;
+
+/**
+ * Mocks stuff related to window.matchMedia.
+ *
+ * @example
+ * describe('Root layout test', () => {
+ *   // Use it inside describe suite. Place it to top
+ *   injectMatchMediaMock();
+ *
+ *   injectMocks(() => {
+ *     vi.mock('next/font/google', () => ({
+ *       Inter: FONT_MOCK,
+ *     }));
+ *   });
+ *
+ *   testNextPage(<RootLayout children={undefined} />, {
+ *     generateMetadata,
+ *   });
+ * });
+ */
+declare const injectMatchMediaMock: () => void;
+
+/**
+ * Recursevely changes all keys` types inside T to R.
+ */
+type TypeReplaceDeep<T extends object, R> = {
+    [K in keyof T]: T[K] extends object ? TypeReplaceDeep<T[K], R> : R;
+};
+
+type StubValue = Mock | (() => Mock) | (() => Promise<Mock>);
+/**
+ * Represents vi stub object.
+ */
+type Stub<T extends object> = TypeReplaceDeep<T, StubValue>;
+
+export { assertHookRendering, assertNotThrowing, assertRendering, clearMocks, injectMatchMediaMock, injectMocks, mockEnv, mockRouter, spyFactory, stubGlobal, twApiMock };
+export type { Stub, TypeReplaceDeep };

package/vitest/index.d.ts

@@ -1,7 +1,9 @@
-import { P as PromiseOr } from '../shared/xenopomp-essentials.B-Vt61jj.js';
+import { P as PromiseOr, O as Optional } from '../shared/xenopomp-essentials.CO5lcTlK.js';
 import { render, renderHook } from '@testing-library/react';
 import * as vitest from 'vitest';
+import { beforeAll, afterEach, Mock } from 'vitest';
 import * as _vitest_spy from '@vitest/spy';
+import { PartialDeep } from 'type-fest';
 
 /** Executes function and expects that it won't throw. */
 declare const assertNotThrowing: <T = void>(callable: () => PromiseOr<T>) => void;
@@ -90,4 +92,85 @@ declare function spyFactory(context: string): {
     callSpy: Caller;
 };
 
-export { assertHookRendering, assertNotThrowing, assertRendering, clearMocks, mockEnv, mockRouter, spyFactory, twApiMock };
+/**
+ * Mocks global scope object.
+ *
+ * @param name
+ * @param stub
+ *
+ * @example
+ * stubGlobal<typeof navigator>('navigator', {
+ *     clipboard: {
+ *       writeText: async (text: string) => vi.fn(),
+ *     },
+ * });
+ */
+declare const stubGlobal: <Global extends object>(name: string, stub: PartialDeep<Stub<Global>>) => void;
+
+type Fn = () => void;
+type Strategy = keyof typeof strategies;
+type AfterAllCallback = Optional<Fn> | void;
+/**
+ * Map of all available strategies for
+ * injectMocks function.
+ */
+declare const strategies: {
+    beforeAll: typeof beforeAll;
+    afterEach: typeof afterEach;
+};
+/**
+ * Inserts mocks according to selected strategy
+ * (default is `beforeAll`).
+ *
+ * This function takes approach of useEffect hook
+ * from React. You define mocks inside function body,
+ * then you return function, that will be called
+ * in `afterAll` event.
+ *
+ * @example
+ * injectMocks(() => {
+ *     mockRouter();
+ *
+ *     return () => {
+ *       console.log('This is printed from injectMocks func (afterAll event).');
+ *     };
+ *   });
+ */
+declare const injectMocks: (func: () => AfterAllCallback, strategy?: Strategy) => void;
+
+/**
+ * Mocks stuff related to window.matchMedia.
+ *
+ * @example
+ * describe('Root layout test', () => {
+ *   // Use it inside describe suite. Place it to top
+ *   injectMatchMediaMock();
+ *
+ *   injectMocks(() => {
+ *     vi.mock('next/font/google', () => ({
+ *       Inter: FONT_MOCK,
+ *     }));
+ *   });
+ *
+ *   testNextPage(<RootLayout children={undefined} />, {
+ *     generateMetadata,
+ *   });
+ * });
+ */
+declare const injectMatchMediaMock: () => void;
+
+/**
+ * Recursevely changes all keys` types inside T to R.
+ */
+type TypeReplaceDeep<T extends object, R> = {
+    [K in keyof T]: T[K] extends object ? TypeReplaceDeep<T[K], R> : R;
+};
+
+type StubValue = Mock | (() => Mock) | (() => Promise<Mock>);
+/**
+ * Represents vi stub object.
+ */
+type Stub<T extends object> = TypeReplaceDeep<T, StubValue>;
+
+export { assertHookRendering, assertNotThrowing, assertRendering, clearMocks, injectMatchMediaMock, injectMocks, mockEnv, mockRouter, spyFactory, stubGlobal, twApiMock };
+export type { Stub, TypeReplaceDeep };

package/vitest/index.mjs

@@ -1 +1 @@
-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};
+import{expect as c,vi as t,afterEach as f,beforeAll as u,afterAll as h}from"vitest";import{render as d,renderHook as m}from"@testing-library/react";import l from"ansi-colors";import p from"vitest-matchmedia-mock";const a=e=>{c(()=>e()).not.toThrow()},b=(...e)=>{a(()=>d(...e))},C=(...e)=>{a(()=>m(...e))},k=e=>{t.stubEnv("CANONICAL_URL","http://localhost:4242"),t.stubEnv("IS_PRODUCTION","false"),e&&Object.entries(e).forEach(([o,n])=>t.stubEnv(o,n))},r=()=>{t.clearAllMocks(),t.resetAllMocks(),t.unstubAllEnvs(),t.unstubAllGlobals()},x=()=>{t.mock("next/navigation",()=>({useRouter:()=>({push(){}}),usePathname:()=>"/"}))},A={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 g{_executionContext;constructor(o){this._executionContext=o}call(...o){console.debug(`${l.blue(`[${this._executionContext}]`)} ${l.green(`Custom spy is called with these args: ${l.blueBright(o.map(n=>`${n}`).join(", "))}`)}`)}}function v(e){const o=new g(e),n=t.spyOn(o,"call");return{expectToBeCalled:(...s)=>c(n).toHaveBeenCalledWith(s),expectToBeNotCalled:(...s)=>c(n).not.toHaveBeenCalledWith(s),spy:n,callSpy:(...s)=>o.call(s)}}const E=(e,o)=>{t.stubGlobal(e,o)},M={beforeAll:u,afterEach:f},i=(e,o="beforeAll")=>{let n;M[o](()=>n=e()),h(()=>{r(),n?.()})},y=()=>{const e=new p;i(()=>(e.clear(),()=>e.destroy()),"afterEach")};export{C as assertHookRendering,a as assertNotThrowing,b as assertRendering,r as clearMocks,y as injectMatchMediaMock,i as injectMocks,k as mockEnv,x as mockRouter,v as spyFactory,E as stubGlobal,A as twApiMock};

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

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

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

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