@consolidados/results 0.1.0 → 0.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@consolidados/results",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"description": "Result types, ease and simple",
 	"main": "./dist/index.js",
 	"module": "./dist/index.js",
@@ -11,6 +11,9 @@
 		"type": "git",
 		"url": "https://github.com/consolidados/results"
 	},
+	"files": [
+		"dist"
+	],
 	"exports": {
 		"./option": {
 			"types": "./dist/option/index.d.ts",
@@ -39,7 +42,9 @@
 	"scripts": {
 		"build": "rm -rf dist && tsup",
 		"test": "vitest run",
-		"release": "release-it"
+		"release": "release-it",
+		"format-and-lint": "biome check .",
+		"format-and-lint:fix": "biome check . --write"
 	},
 	"keywords": [
 		"Rust",
@@ -54,7 +59,9 @@
 	"author": "Johnny Carreiro",
 	"license": "ISC",
 	"devDependencies": {
+		"@release-it/conventional-changelog": "^10.0.0",
 		"@types/node": "^22.13.13",
+		"biome": "^0.3.3",
 		"release-it": "^18.1.2",
 		"tsup": "^8.4.0",
 		"typescript": "^5.8.2",

package/.release-it.json

@@ -1,20 +0,0 @@
-{
-	"$schema": "https://unpkg.com/release-it/schema/release-it.json",
-	"git": {
-		"requireBranch": "main",
-		"commitMessage": "chore: release v${version}"
-	},
-	"hooks": {
-		"before:init": ["git pull", "pnpm run test"],
-		"afeter:bump": ["pnpm run build", "npx auto-changelog -p"]
-	},
-	"github": {
-		"release": true
-	},
-	"npm": {
-		"publish": true
-	},
-	"publishConfig": {
-		"access": "public"
-	}
-}

package/dist/err-B7LUEZ0f.d.cts

@@ -1,128 +0,0 @@
-/**
- * Represents a successful result (`Ok`) that contains a value.
- * @template T The type of the value contained in this `Ok`.
- */
-declare class Ok<T> implements ResultDefinition<T, never> {
-    private value;
-    /**
-     * Creates a new `Ok` instance with the given value.
-     * @param value The value to wrap in the `Ok` instance.
-     */
-    constructor(value: T);
-    /**
-     * Checks if this result is an `Ok`.
-     * @returns `true` because this is an `Ok`.
-     */
-    isOk(): this is Ok<T>;
-    /**
-     * Checks if this result is an `Err`.
-     * @returns `false` because this is an `Ok`.
-     */
-    isErr(): this is Err<never>;
-    /**
-     * Retrieves the value contained in this `Ok`.
-     * @returns The value contained in this `Ok`.
-     */
-    unwrap(): T;
-    /**
-     * Applies a transformation function to the value contained in this `Ok` and returns a new `Result` with the transformed value.
-     * @template U The type of the transformed value.
-     * @param fn The transformation function to apply to the value.
-     * @returns A new `Ok` containing the transformed value.
-     */
-    map<U>(fn: (value: T) => U): ResultDefinition<U, never>;
-    /**
-     * Applies a transformation function that returns a `Result` to the value contained in this `Ok`.
-     * @template U The type of the value in the resulting `Result`.
-     * @param fn The transformation function to apply to the value.
-     * @returns The result of applying the transformation function.
-     */
-    flatMap<U>(fn: (value: T) => ResultDefinition<U, never>): ResultDefinition<U, never>;
-    /**
-     * Maps the error value (if any). Since this is an `Ok`, the error mapping function is ignored, and the original `Ok` is returned.
-     * @template U The type of the error (ignored for `Ok`).
-     * @param _fn The mapping function for errors (not used).
-     * @returns The original `Ok` instance.
-     */
-    mapErr<U extends Error>(_fn: (err: never) => U): ResultDefinition<T, U>;
-    /**
-     * Retrieves the error contained in this result. Since this is an `Ok`, an error is thrown.
-     * @throws An error because `unwrapErr` is called on an `Ok`.
-     */
-    unwrapErr(): never;
-}
-
-type OkType<T> = [T] extends [never] ? never : T;
-type ErrType<E> = [E] extends [never] ? never : E;
-/**
- * Represents the result of an operation that can either succeed (`Ok`) or fail (`Err`).
- */
-type Result<T, E extends Error> = Ok<OkType<T>> | Err<ErrType<E>>;
-/**
- * Represents the result methods that must be implemented for success (`Ok`) or failure (`Err`).
- */
-interface ResultDefinition<T = never, E = never> {
-    isOk(): this is Ok<T>;
-    isErr(): this is Err<E extends Error ? E : Error>;
-    unwrap(): T;
-    unwrapErr(): E;
-    map<U>(fn: (value: T) => U): ResultDefinition<U, E>;
-    flatMap<U>(fn: (value: T) => ResultDefinition<U, E>): ResultDefinition<U, E>;
-    mapErr<U extends Error>(fn: (err: E) => U): ResultDefinition<T, U>;
-}
-
-/**
- * Represents a failed result (`Err`) that contains an error value.
- * @template E The type of the error contained in this `Err`.
- */
-declare class Err<E extends Error> extends Error implements ResultDefinition<never, E> {
-    private error;
-    /**
-     * Creates a new `Err` instance with the given error value.
-     * @param error The error to wrap in the `Err` instance.
-     */
-    constructor(error: E | string);
-    /**
-     * Checks if this result is an `Ok`.
-     * @returns `false` because this is an `Err`.
-     */
-    isOk(): this is Ok<never>;
-    /**
-     * Checks if this result is an `Err`.
-     * @returns `true` because this is an `Err`.
-     */
-    isErr(): this is Err<E extends Error ? E : Error>;
-    /**
-     * Retrieves the value contained in this result. Since this is an `Err`, an error is thrown.
-     * @throws An error because `unwrap` is called on an `Err`.
-     */
-    unwrap(): never;
-    /**
-     * Maps the value (if any). Since this is an `Err`, the mapping function is ignored, and the original `Err` is returned.
-     * @template U The type of the value (ignored for `Err`).
-     * @param _fn The mapping function for values (not used).
-     * @returns The original `Err` instance.
-     */
-    map<U>(_fn: (value: never) => U): ResultDefinition<never, E>;
-    /**
-     * Maps the error value using a transformation function and returns a new `Result` with the transformed error.
-     * @template U The type of the transformed error.
-     * @param fn The transformation function to apply to the error value.
-     * @returns A new `Err` containing the transformed error.
-     */
-    mapErr<U extends Error>(fn: (err: E) => U): ResultDefinition<never, U>;
-    /**
-     * Applies a transformation function that returns a `Result` to the value (which does not exist) of this `Err`.
-     * @template U The type of the value in the resulting `Result`.
-     * @param _fn The transformation function (ignored in this implementation).
-     * @returns The original `Err` instance.
-     */
-    flatMap<U>(_fn: (value: never) => ResultDefinition<U, never>): ResultDefinition<never, E>;
-    /**
-     * Retrieves the error value contained in this `Err`.
-     * @returns The error value contained in this `Err`.
-     */
-    unwrapErr(): E;
-}
-
-export { Err as E, Ok as O, type Result as R };

package/dist/err-B7LUEZ0f.d.ts

@@ -1,128 +0,0 @@
-/**
- * Represents a successful result (`Ok`) that contains a value.
- * @template T The type of the value contained in this `Ok`.
- */
-declare class Ok<T> implements ResultDefinition<T, never> {
-    private value;
-    /**
-     * Creates a new `Ok` instance with the given value.
-     * @param value The value to wrap in the `Ok` instance.
-     */
-    constructor(value: T);
-    /**
-     * Checks if this result is an `Ok`.
-     * @returns `true` because this is an `Ok`.
-     */
-    isOk(): this is Ok<T>;
-    /**
-     * Checks if this result is an `Err`.
-     * @returns `false` because this is an `Ok`.
-     */
-    isErr(): this is Err<never>;
-    /**
-     * Retrieves the value contained in this `Ok`.
-     * @returns The value contained in this `Ok`.
-     */
-    unwrap(): T;
-    /**
-     * Applies a transformation function to the value contained in this `Ok` and returns a new `Result` with the transformed value.
-     * @template U The type of the transformed value.
-     * @param fn The transformation function to apply to the value.
-     * @returns A new `Ok` containing the transformed value.
-     */
-    map<U>(fn: (value: T) => U): ResultDefinition<U, never>;
-    /**
-     * Applies a transformation function that returns a `Result` to the value contained in this `Ok`.
-     * @template U The type of the value in the resulting `Result`.
-     * @param fn The transformation function to apply to the value.
-     * @returns The result of applying the transformation function.
-     */
-    flatMap<U>(fn: (value: T) => ResultDefinition<U, never>): ResultDefinition<U, never>;
-    /**
-     * Maps the error value (if any). Since this is an `Ok`, the error mapping function is ignored, and the original `Ok` is returned.
-     * @template U The type of the error (ignored for `Ok`).
-     * @param _fn The mapping function for errors (not used).
-     * @returns The original `Ok` instance.
-     */
-    mapErr<U extends Error>(_fn: (err: never) => U): ResultDefinition<T, U>;
-    /**
-     * Retrieves the error contained in this result. Since this is an `Ok`, an error is thrown.
-     * @throws An error because `unwrapErr` is called on an `Ok`.
-     */
-    unwrapErr(): never;
-}
-
-type OkType<T> = [T] extends [never] ? never : T;
-type ErrType<E> = [E] extends [never] ? never : E;
-/**
- * Represents the result of an operation that can either succeed (`Ok`) or fail (`Err`).
- */
-type Result<T, E extends Error> = Ok<OkType<T>> | Err<ErrType<E>>;
-/**
- * Represents the result methods that must be implemented for success (`Ok`) or failure (`Err`).
- */
-interface ResultDefinition<T = never, E = never> {
-    isOk(): this is Ok<T>;
-    isErr(): this is Err<E extends Error ? E : Error>;
-    unwrap(): T;
-    unwrapErr(): E;
-    map<U>(fn: (value: T) => U): ResultDefinition<U, E>;
-    flatMap<U>(fn: (value: T) => ResultDefinition<U, E>): ResultDefinition<U, E>;
-    mapErr<U extends Error>(fn: (err: E) => U): ResultDefinition<T, U>;
-}
-
-/**
- * Represents a failed result (`Err`) that contains an error value.
- * @template E The type of the error contained in this `Err`.
- */
-declare class Err<E extends Error> extends Error implements ResultDefinition<never, E> {
-    private error;
-    /**
-     * Creates a new `Err` instance with the given error value.
-     * @param error The error to wrap in the `Err` instance.
-     */
-    constructor(error: E | string);
-    /**
-     * Checks if this result is an `Ok`.
-     * @returns `false` because this is an `Err`.
-     */
-    isOk(): this is Ok<never>;
-    /**
-     * Checks if this result is an `Err`.
-     * @returns `true` because this is an `Err`.
-     */
-    isErr(): this is Err<E extends Error ? E : Error>;
-    /**
-     * Retrieves the value contained in this result. Since this is an `Err`, an error is thrown.
-     * @throws An error because `unwrap` is called on an `Err`.
-     */
-    unwrap(): never;
-    /**
-     * Maps the value (if any). Since this is an `Err`, the mapping function is ignored, and the original `Err` is returned.
-     * @template U The type of the value (ignored for `Err`).
-     * @param _fn The mapping function for values (not used).
-     * @returns The original `Err` instance.
-     */
-    map<U>(_fn: (value: never) => U): ResultDefinition<never, E>;
-    /**
-     * Maps the error value using a transformation function and returns a new `Result` with the transformed error.
-     * @template U The type of the transformed error.
-     * @param fn The transformation function to apply to the error value.
-     * @returns A new `Err` containing the transformed error.
-     */
-    mapErr<U extends Error>(fn: (err: E) => U): ResultDefinition<never, U>;
-    /**
-     * Applies a transformation function that returns a `Result` to the value (which does not exist) of this `Err`.
-     * @template U The type of the value in the resulting `Result`.
-     * @param _fn The transformation function (ignored in this implementation).
-     * @returns The original `Err` instance.
-     */
-    flatMap<U>(_fn: (value: never) => ResultDefinition<U, never>): ResultDefinition<never, E>;
-    /**
-     * Retrieves the error value contained in this `Err`.
-     * @returns The error value contained in this `Err`.
-     */
-    unwrapErr(): E;
-}
-
-export { Err as E, Ok as O, type Result as R };

package/dist/helpers/match.cjs

@@ -1,27 +0,0 @@
-'use strict';
-
-// src/helpers/match.ts
-function match(matcher, cases) {
-  if ("isOk" in matcher && matcher.isOk()) {
-    if (!cases.Ok) throw new Error("Missing case for Ok");
-    return cases.Ok(matcher.unwrap());
-  }
-  if ("isErr" in matcher && matcher.isErr()) {
-    if (!cases.Err) throw new Error("Missing case for Err");
-    return cases.Err(matcher.unwrapErr());
-  }
-  if ("isSome" in matcher && matcher.isSome()) {
-    if (!cases.Some) throw new Error("Missing case for Some");
-    return cases.Some(matcher.unwrap());
-  }
-  if ("isNone" in matcher && matcher.isNone()) {
-    if (!cases.None) throw new Error("Missing case for None");
-    return cases.None();
-  }
-  throw new Error("Invalid matcher or missing case");
-}
-global.match = match;
-
-exports.match = match;
-//# sourceMappingURL=match.cjs.map
-//# sourceMappingURL=match.cjs.map

package/dist/helpers/match.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/helpers/match.ts"],"names":[],"mappings":";;;AAiBO,SAAS,KAAA,CACf,SACA,KAMI,EAAA;AACJ,EAAA,IAAI,MAAU,IAAA,OAAA,IAAW,OAAQ,CAAA,IAAA,EAAQ,EAAA;AACxC,IAAA,IAAI,CAAC,KAAM,CAAA,EAAA,EAAU,MAAA,IAAI,MAAM,qBAAqB,CAAA;AACpD,IAAA,OAAO,KAAM,CAAA,EAAA,CAAG,OAAQ,CAAA,MAAA,EAAQ,CAAA;AAAA;AAGjC,EAAA,IAAI,OAAW,IAAA,OAAA,IAAW,OAAQ,CAAA,KAAA,EAAS,EAAA;AAC1C,IAAA,IAAI,CAAC,KAAM,CAAA,GAAA,EAAW,MAAA,IAAI,MAAM,sBAAsB,CAAA;AACtD,IAAA,OAAO,KAAM,CAAA,GAAA,CAAI,OAAQ,CAAA,SAAA,EAAgB,CAAA;AAAA;AAG1C,EAAA,IAAI,QAAY,IAAA,OAAA,IAAW,OAAQ,CAAA,MAAA,EAAU,EAAA;AAC5C,IAAA,IAAI,CAAC,KAAM,CAAA,IAAA,EAAY,MAAA,IAAI,MAAM,uBAAuB,CAAA;AACxD,IAAA,OAAO,KAAM,CAAA,IAAA,CAAK,OAAQ,CAAA,MAAA,EAAQ,CAAA;AAAA;AAGnC,EAAA,IAAI,QAAY,IAAA,OAAA,IAAW,OAAQ,CAAA,MAAA,EAAU,EAAA;AAC5C,IAAA,IAAI,CAAC,KAAM,CAAA,IAAA,EAAY,MAAA,IAAI,MAAM,uBAAuB,CAAA;AACxD,IAAA,OAAO,MAAM,IAAK,EAAA;AAAA;AAGnB,EAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA;AAClD;AAEC,MAAA,CAAe,KAAQ,GAAA,KAAA","file":"match.cjs","sourcesContent":["import { Result } from \"../result\";\nimport { Option } from \"../option\";\n\nexport function match<T, E extends Error, R>(\n\tmatcher: Result<T, E>,\n\tcases: {\n\t\tOk: (value: T) => R;\n\t\tErr: (error: E) => R;\n\t},\n): R;\nexport function match<T, R>(\n\tmatcher: Option<T>,\n\tcases: {\n\t\tSome: (value: T) => R;\n\t\tNone: () => R;\n\t},\n): R;\nexport function match<T, E extends Error, R>(\n\tmatcher: Result<T, E> | Option<T>,\n\tcases: {\n\t\tOk?: (value: T) => R;\n\t\tErr?: (error: E) => R;\n\t\tSome?: (value: T) => R;\n\t\tNone?: () => R;\n\t},\n): R {\n\tif (\"isOk\" in matcher && matcher.isOk()) {\n\t\tif (!cases.Ok) throw new Error(\"Missing case for Ok\");\n\t\treturn cases.Ok(matcher.unwrap());\n\t}\n\n\tif (\"isErr\" in matcher && matcher.isErr()) {\n\t\tif (!cases.Err) throw new Error(\"Missing case for Err\");\n\t\treturn cases.Err(matcher.unwrapErr() as E);\n\t}\n\n\tif (\"isSome\" in matcher && matcher.isSome()) {\n\t\tif (!cases.Some) throw new Error(\"Missing case for Some\");\n\t\treturn cases.Some(matcher.unwrap());\n\t}\n\n\tif (\"isNone\" in matcher && matcher.isNone()) {\n\t\tif (!cases.None) throw new Error(\"Missing case for None\");\n\t\treturn cases.None();\n\t}\n\n\tthrow new Error(\"Invalid matcher or missing case\");\n}\n\n(global as any).match = match;\n"]}

package/dist/helpers/match.d.cts

@@ -1,13 +0,0 @@
-import { R as Result } from '../err-B7LUEZ0f.cjs';
-import { O as Option } from '../option-DpT8KCGE.cjs';
-
-declare function match<T, E extends Error, R>(matcher: Result<T, E>, cases: {
-    Ok: (value: T) => R;
-    Err: (error: E) => R;
-}): R;
-declare function match<T, R>(matcher: Option<T>, cases: {
-    Some: (value: T) => R;
-    None: () => R;
-}): R;
-
-export { match };

package/dist/helpers/match.d.ts

@@ -1,13 +0,0 @@
-import { R as Result } from '../err-B7LUEZ0f.js';
-import { O as Option } from '../option-DpT8KCGE.js';
-
-declare function match<T, E extends Error, R>(matcher: Result<T, E>, cases: {
-    Ok: (value: T) => R;
-    Err: (error: E) => R;
-}): R;
-declare function match<T, R>(matcher: Option<T>, cases: {
-    Some: (value: T) => R;
-    None: () => R;
-}): R;
-
-export { match };

package/dist/helpers/match.js

@@ -1,25 +0,0 @@
-// src/helpers/match.ts
-function match(matcher, cases) {
-  if ("isOk" in matcher && matcher.isOk()) {
-    if (!cases.Ok) throw new Error("Missing case for Ok");
-    return cases.Ok(matcher.unwrap());
-  }
-  if ("isErr" in matcher && matcher.isErr()) {
-    if (!cases.Err) throw new Error("Missing case for Err");
-    return cases.Err(matcher.unwrapErr());
-  }
-  if ("isSome" in matcher && matcher.isSome()) {
-    if (!cases.Some) throw new Error("Missing case for Some");
-    return cases.Some(matcher.unwrap());
-  }
-  if ("isNone" in matcher && matcher.isNone()) {
-    if (!cases.None) throw new Error("Missing case for None");
-    return cases.None();
-  }
-  throw new Error("Invalid matcher or missing case");
-}
-global.match = match;
-
-export { match };
-//# sourceMappingURL=match.js.map
-//# sourceMappingURL=match.js.map

package/dist/helpers/match.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/helpers/match.ts"],"names":[],"mappings":";AAiBO,SAAS,KAAA,CACf,SACA,KAMI,EAAA;AACJ,EAAA,IAAI,MAAU,IAAA,OAAA,IAAW,OAAQ,CAAA,IAAA,EAAQ,EAAA;AACxC,IAAA,IAAI,CAAC,KAAM,CAAA,EAAA,EAAU,MAAA,IAAI,MAAM,qBAAqB,CAAA;AACpD,IAAA,OAAO,KAAM,CAAA,EAAA,CAAG,OAAQ,CAAA,MAAA,EAAQ,CAAA;AAAA;AAGjC,EAAA,IAAI,OAAW,IAAA,OAAA,IAAW,OAAQ,CAAA,KAAA,EAAS,EAAA;AAC1C,IAAA,IAAI,CAAC,KAAM,CAAA,GAAA,EAAW,MAAA,IAAI,MAAM,sBAAsB,CAAA;AACtD,IAAA,OAAO,KAAM,CAAA,GAAA,CAAI,OAAQ,CAAA,SAAA,EAAgB,CAAA;AAAA;AAG1C,EAAA,IAAI,QAAY,IAAA,OAAA,IAAW,OAAQ,CAAA,MAAA,EAAU,EAAA;AAC5C,IAAA,IAAI,CAAC,KAAM,CAAA,IAAA,EAAY,MAAA,IAAI,MAAM,uBAAuB,CAAA;AACxD,IAAA,OAAO,KAAM,CAAA,IAAA,CAAK,OAAQ,CAAA,MAAA,EAAQ,CAAA;AAAA;AAGnC,EAAA,IAAI,QAAY,IAAA,OAAA,IAAW,OAAQ,CAAA,MAAA,EAAU,EAAA;AAC5C,IAAA,IAAI,CAAC,KAAM,CAAA,IAAA,EAAY,MAAA,IAAI,MAAM,uBAAuB,CAAA;AACxD,IAAA,OAAO,MAAM,IAAK,EAAA;AAAA;AAGnB,EAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA;AAClD;AAEC,MAAA,CAAe,KAAQ,GAAA,KAAA","file":"match.js","sourcesContent":["import { Result } from \"../result\";\nimport { Option } from \"../option\";\n\nexport function match<T, E extends Error, R>(\n\tmatcher: Result<T, E>,\n\tcases: {\n\t\tOk: (value: T) => R;\n\t\tErr: (error: E) => R;\n\t},\n): R;\nexport function match<T, R>(\n\tmatcher: Option<T>,\n\tcases: {\n\t\tSome: (value: T) => R;\n\t\tNone: () => R;\n\t},\n): R;\nexport function match<T, E extends Error, R>(\n\tmatcher: Result<T, E> | Option<T>,\n\tcases: {\n\t\tOk?: (value: T) => R;\n\t\tErr?: (error: E) => R;\n\t\tSome?: (value: T) => R;\n\t\tNone?: () => R;\n\t},\n): R {\n\tif (\"isOk\" in matcher && matcher.isOk()) {\n\t\tif (!cases.Ok) throw new Error(\"Missing case for Ok\");\n\t\treturn cases.Ok(matcher.unwrap());\n\t}\n\n\tif (\"isErr\" in matcher && matcher.isErr()) {\n\t\tif (!cases.Err) throw new Error(\"Missing case for Err\");\n\t\treturn cases.Err(matcher.unwrapErr() as E);\n\t}\n\n\tif (\"isSome\" in matcher && matcher.isSome()) {\n\t\tif (!cases.Some) throw new Error(\"Missing case for Some\");\n\t\treturn cases.Some(matcher.unwrap());\n\t}\n\n\tif (\"isNone\" in matcher && matcher.isNone()) {\n\t\tif (!cases.None) throw new Error(\"Missing case for None\");\n\t\treturn cases.None();\n\t}\n\n\tthrow new Error(\"Invalid matcher or missing case\");\n}\n\n(global as any).match = match;\n"]}