@resultsafe/core-fp-result 0.1.9 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resultsafe/core-fp-result",
-  "version": "0.1.9",
+  "version": "0.2.0",
   "type": "module",
   "sideEffects": false,
   "main": "./cjs/index.js",

package/types/index.d.ts

@@ -2,4 +2,5 @@ export * from './constructors/index.js';
 export * from './guards/index.js';
 export * from './methods/index.js';
 export * from './refiners/index.js';
+export * from './shared-types.js';
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC"}

package/types/refiners/types/Handler.d.ts

@@ -1,5 +1,13 @@
 import type { VariantOf } from './VariantOf.js';
-/** Описывает запись обработчика варианта во внутренних механизмах matcher. @internal */
+/**
+ * Describes a handler entry for variant matching in internal matcher mechanisms.
+ *
+ * @typeParam K - The variant key type.
+ * @typeParam T - The variant union type.
+ * @typeParam R - The return type of the handler function.
+ *
+ * @internal
+ */
 export type Handler<K extends string, T extends VariantOf<K>, R> = {
     readonly variant: K;
     readonly fn: (value: Extract<T, {

package/types/refiners/types/Handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Handler.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/Handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,wFAAwF;AACxF,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI;IACjE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACpB,QAAQ,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,CAAC,CAAC;CACpD,CAAC"}
+{"version":3,"file":"Handler.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/Handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;;;;;;GAQG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI;IACjE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACpB,QAAQ,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,CAAC,CAAC;CACpD,CAAC"}

package/types/refiners/types/MatchBuilder.d.ts

@@ -1,5 +1,24 @@
 import type { VariantOf } from './VariantOf.js';
-/** Описывает форму строгого builder для matcher. */
+/**
+ * Describes the shape of a strict builder for variant matching.
+ *
+ * @typeParam T - The variant union type.
+ * @typeParam R - The return type of the match operation.
+ * @typeParam Handled - The union of already handled variant types.
+ *
+ * @example
+ * ```ts
+ * import { MatchBuilder } from '@resultsafe/core-fp-result';
+ *
+ * const builder: MatchBuilder<MyVariant, string> = {
+ *   with: (variant, fn) => builder,
+ *   run: () => 'result'
+ * };
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type MatchBuilder<T extends VariantOf, R, Handled extends T['type'] = never> = {
     readonly with: <K extends Exclude<T['type'], Handled>>(variant: K, fn: (value: Extract<T, {
         type: K;

package/types/refiners/types/MatchBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MatchBuilder.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/MatchBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,oDAAoD;AACpD,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,SAAS,EACnB,CAAC,EACD,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,IAC/B;IACF,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,EACnD,OAAO,EAAE,CAAC,EACV,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,CAAC,KACtC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;IACrC,QAAQ,CAAC,GAAG,EAAE,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC;CAC3D,CAAC"}
+{"version":3,"file":"MatchBuilder.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/MatchBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,SAAS,EACnB,CAAC,EACD,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,IAC/B;IACF,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,EACnD,OAAO,EAAE,CAAC,EACV,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,CAAC,KACtC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;IACrC,QAAQ,CAAC,GAAG,EAAE,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC;CAC3D,CAAC"}

package/types/refiners/types/Matcher.d.ts

@@ -1,5 +1,27 @@
 import type { VariantOf } from './VariantOf.js';
-/** Описывает форму нестрогого builder для matcher. */
+/**
+ * Describes the shape of a non-strict builder for variant matching.
+ *
+ * @typeParam T - The variant union type.
+ * @typeParam R - The return type of the match operation.
+ *
+ * @remarks
+ * Unlike {@link MatchBuilder}, this builder allows matching any variant
+ * and provides an `otherwise` fallback handler for unmatched cases.
+ *
+ * @example
+ * ```ts
+ * import { Matcher } from '@resultsafe/core-fp-result';
+ *
+ * const matcher: Matcher<MyVariant, string> = {
+ *   with: (variant, fn) => matcher,
+ *   otherwise: (fn) => ({ run: () => 'default' })
+ * };
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type Matcher<T extends VariantOf, R> = {
     readonly with: <K extends T['type']>(variant: K, fn: (value: Extract<T, {
         type: K;

package/types/refiners/types/Matcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Matcher.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/Matcher.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,sDAAsD;AACtD,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,IAAI;IAC5C,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,EACjC,OAAO,EAAE,CAAC,EACV,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,CAAC,KACtC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACnB,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,KAAK;QAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CACxE,CAAC"}
+{"version":3,"file":"Matcher.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/Matcher.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,IAAI;IAC5C,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,EACjC,OAAO,EAAE,CAAC,EACV,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,CAAC,KACtC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACnB,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,KAAK;QAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CACxE,CAAC"}

package/types/refiners/types/SyncRefinedResult.d.ts

@@ -1,5 +1,27 @@
 import type { PayloadKeys, ValidatorFn, VariantConfig } from '../../shared-types.js';
-/** Описывает синхронно уточненное конкретное значение варианта. */
+/**
+ * Describes a synchronously refined specific variant value.
+ *
+ * @typeParam K - The variant key type.
+ * @typeParam TMap - The variant configuration map.
+ * @typeParam _TValidators - The validator map for the variant.
+ *
+ * @remarks
+ * This type represents a refined variant with its payload fields
+ * validated synchronously. The `type` field discriminates the variant,
+ * and the remaining fields are the validated payload.
+ *
+ * @example
+ * ```ts
+ * import { SyncRefinedResult, VariantConfig } from '@resultsafe/core-fp-result';
+ *
+ * type MyVariant = SyncRefinedResult<'user', { user: { payload: 'name' } }, {}>;
+ * // { type: 'user'; name: unknown }
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type SyncRefinedResult<K extends keyof TMap & string, TMap extends Record<string, VariantConfig>, _TValidators extends Partial<Record<PayloadKeys<TMap[K]>, ValidatorFn>>> = {
     type: K;
 } & Record<PayloadKeys<TMap[K]>, unknown>;

package/types/refiners/types/SyncRefinedResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SyncRefinedResult.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/SyncRefinedResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,aAAa,EACd,MAAM,uBAAuB,CAAC;AAE/B,mEAAmE;AACnE,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,MAAM,IAAI,GAAG,MAAM,EAC7B,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EAC1C,YAAY,SAAS,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,IACrE;IACF,IAAI,EAAE,CAAC,CAAC;CACT,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC"}
+{"version":3,"file":"SyncRefinedResult.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/SyncRefinedResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,aAAa,EACd,MAAM,uBAAuB,CAAC;AAE/B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,MAAM,IAAI,GAAG,MAAM,EAC7B,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EAC1C,YAAY,SAAS,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,IACrE;IACF,IAAI,EAAE,CAAC,CAAC;CACT,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC"}

package/types/refiners/types/SyncRefinedResultUnion.d.ts

@@ -1,7 +1,30 @@
 import type { VariantConfig } from '../../shared-types.js';
 import type { SyncRefinedResult } from './SyncRefinedResult.js';
 import type { SyncValidatorMap } from './SyncValidatorMap.js';
-/** Описывает объединение синхронно уточненных вариантов. */
+/**
+ * Describes a union of synchronously refined variants.
+ *
+ * @typeParam TMap - The variant configuration map.
+ * @typeParam TValidators - The validator map for all variants.
+ *
+ * @remarks
+ * This type represents the union of all refined variants in the map.
+ * Each variant is refined using {@link SyncRefinedResult}.
+ *
+ * @example
+ * ```ts
+ * import { SyncRefinedResultUnion, VariantConfig } from '@resultsafe/core-fp-result';
+ *
+ * type Variants = SyncRefinedResultUnion<
+ *   { user: { payload: 'name' }; error: { payload: 'code' } },
+ *   {}
+ * >;
+ * // { type: 'user'; name: unknown } | { type: 'error'; code: unknown }
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type SyncRefinedResultUnion<TMap extends Record<string, VariantConfig>, TValidators extends SyncValidatorMap<TMap>> = {
     [K in keyof TMap & string]: SyncRefinedResult<K, TMap, NonNullable<TValidators[K]>>;
 }[keyof TMap & string];

package/types/refiners/types/SyncRefinedResultUnion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SyncRefinedResultUnion.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/SyncRefinedResultUnion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D,4DAA4D;AAC5D,MAAM,MAAM,sBAAsB,CAChC,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EAC1C,WAAW,SAAS,gBAAgB,CAAC,IAAI,CAAC,IACxC;KACD,CAAC,IAAI,MAAM,IAAI,GAAG,MAAM,GAAG,iBAAiB,CAC3C,CAAC,EACD,IAAI,EACJ,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAC5B;CACF,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC"}
+{"version":3,"file":"SyncRefinedResultUnion.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/SyncRefinedResultUnion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,sBAAsB,CAChC,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EAC1C,WAAW,SAAS,gBAAgB,CAAC,IAAI,CAAC,IACxC;KACD,CAAC,IAAI,MAAM,IAAI,GAAG,MAAM,GAAG,iBAAiB,CAC3C,CAAC,EACD,IAAI,EACJ,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAC5B;CACF,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC"}

package/types/refiners/types/SyncValidatorMap.d.ts

@@ -1,5 +1,27 @@
 import type { PayloadKeys, ValidatorFn, VariantConfig } from '../../shared-types.js';
-/** Описывает наборы валидаторов, сгруппированные по ключу варианта. */
+/**
+ * Describes validator sets grouped by variant key.
+ *
+ * @typeParam TMap - The variant configuration map.
+ *
+ * @remarks
+ * This type maps each variant to its optional validators for payload fields.
+ * Validators are used to refine and check variant data at runtime.
+ *
+ * @example
+ * ```ts
+ * import { SyncValidatorMap, VariantConfig } from '@resultsafe/core-fp-result';
+ *
+ * type Validators = SyncValidatorMap<{
+ *   user: { payload: 'name' | 'age' };
+ *   error: { payload: 'code' };
+ * }>;
+ * // { user?: { name?: ValidatorFn; age?: ValidatorFn }; error?: { code?: ValidatorFn } }
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type SyncValidatorMap<TMap extends Record<string, VariantConfig>> = {
     [K in keyof TMap]?: Partial<Record<PayloadKeys<TMap[K]>, ValidatorFn>>;
 };

package/types/refiners/types/SyncValidatorMap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SyncValidatorMap.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/SyncValidatorMap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,aAAa,EACd,MAAM,uBAAuB,CAAC;AAE/B,uEAAuE;AACvE,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,IAAI;KACxE,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;CACvE,CAAC"}
+{"version":3,"file":"SyncValidatorMap.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/SyncValidatorMap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,aAAa,EACd,MAAM,uBAAuB,CAAC;AAE/B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,IAAI;KACxE,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;CACvE,CAAC"}

package/types/refiners/types/UniversalAsyncRefinedResult.d.ts

@@ -1,5 +1,31 @@
 import type { VariantConfig } from '../../shared-types.js';
-/** Описывает обобщенное асинхронно уточненное значение варианта. */
+/**
+ * Describes a generalized asynchronously refined variant value.
+ *
+ * @typeParam K - The variant key type.
+ * @typeParam TMap - The variant configuration map.
+ * @typeParam _TValidators - The validator map for the variant.
+ *
+ * @remarks
+ * This type represents a variant refined through async validation.
+ * The `type` field discriminates the variant, and additional fields
+ * are validated asynchronously.
+ *
+ * @example
+ * ```ts
+ * import { UniversalAsyncRefinedResult, VariantConfig } from '@resultsafe/core-fp-result';
+ *
+ * type AsyncVariant = UniversalAsyncRefinedResult<
+ *   'user',
+ *   { user: { payload: 'name' } },
+ *   {}
+ * >;
+ * // { type: 'user'; [key: string]: unknown }
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type UniversalAsyncRefinedResult<K extends keyof TMap & string, TMap extends Record<string, VariantConfig>, _TValidators extends Record<string, unknown>> = {
     type: K;
 } & Record<string, unknown>;

package/types/refiners/types/UniversalAsyncRefinedResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UniversalAsyncRefinedResult.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/UniversalAsyncRefinedResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,oEAAoE;AACpE,MAAM,MAAM,2BAA2B,CACrC,CAAC,SAAS,MAAM,IAAI,GAAG,MAAM,EAC7B,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EAC1C,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC1C;IACF,IAAI,EAAE,CAAC,CAAC;CACT,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC"}
+{"version":3,"file":"UniversalAsyncRefinedResult.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/UniversalAsyncRefinedResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,2BAA2B,CACrC,CAAC,SAAS,MAAM,IAAI,GAAG,MAAM,EAC7B,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EAC1C,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC1C;IACF,IAAI,EAAE,CAAC,CAAC;CACT,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC"}

package/types/refiners/types/UniversalRefinedResult.d.ts

@@ -1,5 +1,31 @@
 import type { VariantConfig } from '../../shared-types.js';
-/** Описывает обобщенное синхронно уточненное значение варианта. */
+/**
+ * Describes a generalized synchronously refined variant value.
+ *
+ * @typeParam K - The variant key type.
+ * @typeParam TMap - The variant configuration map.
+ * @typeParam _TValidators - The validator map for the variant.
+ *
+ * @remarks
+ * This type represents a variant refined through sync validation.
+ * The `type` field discriminates the variant, and additional fields
+ * are validated synchronously.
+ *
+ * @example
+ * ```ts
+ * import { UniversalRefinedResult, VariantConfig } from '@resultsafe/core-fp-result';
+ *
+ * type SyncVariant = UniversalRefinedResult<
+ *   'user',
+ *   { user: { payload: 'name' } },
+ *   {}
+ * >;
+ * // { type: 'user'; [key: string]: unknown }
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type UniversalRefinedResult<K extends keyof TMap & string, TMap extends Record<string, VariantConfig>, _TValidators extends Record<string, unknown>> = {
     type: K;
 } & Record<string, unknown>;

package/types/refiners/types/UniversalRefinedResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UniversalRefinedResult.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/UniversalRefinedResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,mEAAmE;AACnE,MAAM,MAAM,sBAAsB,CAChC,CAAC,SAAS,MAAM,IAAI,GAAG,MAAM,EAC7B,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EAC1C,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC1C;IACF,IAAI,EAAE,CAAC,CAAC;CACT,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC"}
+{"version":3,"file":"UniversalRefinedResult.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/UniversalRefinedResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,sBAAsB,CAChC,CAAC,SAAS,MAAM,IAAI,GAAG,MAAM,EAC7B,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,EAC1C,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC1C;IACF,IAAI,EAAE,CAAC,CAAC;CACT,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC"}

package/types/refiners/types/VariantOf.d.ts

@@ -1,4 +1,23 @@
-/** Описывает минимальный контракт дискриминированного объединения. */
+/**
+ * Describes the minimal contract for a discriminated union variant.
+ *
+ * @typeParam K - The variant key type. Defaults to `string`.
+ *
+ * @remarks
+ * This type is used as a constraint for variant unions. Each variant
+ * must have a `type` field that serves as the discriminator.
+ *
+ * @example
+ * ```ts
+ * import { VariantOf } from '@resultsafe/core-fp-result';
+ *
+ * type MyVariant = VariantOf<'user' | 'error'>;
+ * // { type: 'user' } | { type: 'error' }
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type VariantOf<K extends string = string> = {
     type: K;
 };

package/types/refiners/types/VariantOf.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VariantOf.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/VariantOf.ts"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CAAC"}
+{"version":3,"file":"VariantOf.d.ts","sourceRoot":"","sources":["../../../../src/refiners/types/VariantOf.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CAAC"}

package/types/shared-types.d.ts

@@ -1,3 +1,42 @@
+/**
+ * Represents the result of an operation that can either succeed with a
+ * value of type `T` or fail with an error of type `E`.
+ *
+ * @summary
+ * Represents the result of an operation that can either succeed with a
+ * value of type `T` or fail with an error of type `E`.
+ *
+ * @remarks
+ * `Result` is the core type of this library. Pattern match on the `ok`
+ * field to narrow the union, then access `value` or `error` safely.
+ *
+ * Unlike exceptions, `Result` makes the failure path explicit in the
+ * type signature, forcing the caller to handle both outcomes.
+ *
+ * @typeParam T - The type of the success value.
+ * @typeParam E - The type of the error.
+ *
+ * @example
+ * ```ts
+ * import { Result, Ok, Err } from '@resultsafe/core-fp-result';
+ *
+ * function divide(a: number, b: number): Result<number, string> {
+ *   if (b === 0) return Err("Division by zero");
+ *   return Ok(a / b);
+ * }
+ *
+ * const result = divide(10, 2);
+ *
+ * if (result.ok) {
+ *   console.log(result.value); // 5
+ * } else {
+ *   console.error(result.error);
+ * }
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type Result<T, E> = {
     readonly ok: true;
     readonly value: T;
@@ -5,18 +44,121 @@ export type Result<T, E> = {
     readonly ok: false;
     readonly error: E;
 };
+/**
+ * Represents an optional value that can either contain a value of type `T`
+ * or be empty.
+ *
+ * @summary
+ * Represents an optional value that can either contain a value of type `T`
+ * or be empty.
+ *
+ * @remarks
+ * `Option` is used to represent the presence or absence of a value. It is
+ * an alternative to `null` or `undefined` that is type-safe and explicit.
+ *
+ * @typeParam T - The type of the contained value.
+ *
+ * @example
+ * ```ts
+ * import { Option } from '@resultsafe/core-fp-result';
+ *
+ * const someValue: Option<number> = { some: true, value: 42 };
+ * const noValue: Option<number> = { some: false };
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type Option<T> = {
     readonly some: true;
     readonly value: T;
 } | {
     readonly some: false;
 };
+/**
+ * Configuration options for variant validation.
+ *
+ * @remarks
+ * Used to configure how variants are validated, including payload keys
+ * and field strictness.
+ *
+ * @example
+ * ```ts
+ * import { VariantConfig } from '@resultsafe/core-fp-result';
+ *
+ * const config: VariantConfig = {
+ *   payload: ['name', 'age'],
+ *   forbidden: 'id',
+ *   strictFields: true
+ * };
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export interface VariantConfig {
     readonly payload: 'never' | string | readonly string[];
     readonly forbidden?: string | undefined;
     readonly strictFields?: boolean | undefined;
 }
+/**
+ * Extracts the payload keys from a `VariantConfig`.
+ *
+ * @typeParam T - The `VariantConfig` type to extract keys from.
+ * @returns The union of payload keys, or `never` if payload is `'never'`.
+ *
+ * @example
+ * ```ts
+ * import { PayloadKeys, VariantConfig } from '@resultsafe/core-fp-result';
+ *
+ * type Config = { payload: 'name' | 'age'; forbidden?: string };
+ * type Keys = PayloadKeys<Config>; // 'name' | 'age'
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type PayloadKeys<T extends VariantConfig> = T['payload'] extends 'never' ? never : T['payload'] extends string ? T['payload'] : T['payload'] extends readonly string[] ? T['payload'][number] : never;
+/**
+ * A synchronous validator function that checks if a value is of a specific type.
+ *
+ * @typeParam T - The type the validator checks for.
+ * @param x - The value to validate.
+ * @returns `true` if `x` is of type `T`, `false` otherwise.
+ *
+ * @example
+ * ```ts
+ * import { ValidatorFn } from '@resultsafe/core-fp-result';
+ *
+ * const isNumber: ValidatorFn<number> = (x): x is number =>
+ *   typeof x === 'number';
+ *
+ * console.log(isNumber(42)); // true
+ * console.log(isNumber('42')); // false
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type ValidatorFn<T = unknown> = (x: unknown) => x is T;
+/**
+ * An asynchronous validator function that checks if a value is valid.
+ *
+ * @param value - The value to validate.
+ * @returns A promise that resolves to `true` if valid, `false` otherwise.
+ *
+ * @example
+ * ```ts
+ * import { AsyncValidatorFn } from '@resultsafe/core-fp-result';
+ *
+ * const isValidId: AsyncValidatorFn = async (value) => {
+ *   // Simulate async database check
+ *   return typeof value === 'string' && value.length > 0;
+ * };
+ * ```
+ *
+ * @since 0.1.8
+ * @public
+ */
 export type AsyncValidatorFn = (value: unknown) => Promise<boolean>;
 //# sourceMappingURL=shared-types.d.ts.map

package/types/shared-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared-types.d.ts","sourceRoot":"","sources":["../../src/shared-types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IACnB;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GACxC;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAE9C,MAAM,MAAM,MAAM,CAAC,CAAC,IAChB;IAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAC1C;IAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;CAAE,CAAC;AAE7B,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;IACvD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC7C;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,aAAa,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,OAAO,GAC3E,KAAK,GACL,CAAC,CAAC,SAAS,CAAC,SAAS,MAAM,GACzB,CAAC,CAAC,SAAS,CAAC,GACZ,CAAC,CAAC,SAAS,CAAC,SAAS,SAAS,MAAM,EAAE,GACpC,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,GACpB,KAAK,CAAC;AAEd,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC;AAE9D,MAAM,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC"}
+{"version":3,"file":"shared-types.d.ts","sourceRoot":"","sources":["../../src/shared-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IACnB;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GACxC;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAChB;IAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAC1C;IAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;CAAE,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;IACvD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC7C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,aAAa,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,OAAO,GAC3E,KAAK,GACL,CAAC,CAAC,SAAS,CAAC,SAAS,MAAM,GACzB,CAAC,CAAC,SAAS,CAAC,GACZ,CAAC,CAAC,SAAS,CAAC,SAAS,SAAS,MAAM,EAAE,GACpC,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,GACpB,KAAK,CAAC;AAEd;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC;AAE9D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC"}