@theateros/result 0.0.1 → 0.0.2

package/dist/result.cjs

@@ -0,0 +1,2 @@
+"use strict";var l=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var T=(r,e)=>{for(var t in e)l(r,t,{get:e[t],enumerable:!0})},w=(r,e,t,s)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of b(e))!c.call(r,o)&&o!==t&&l(r,o,{get:()=>e[o],enumerable:!(s=m(e,o))||s.enumerable});return r};var S=r=>w(l({},"__esModule",{value:!0}),r);var _={};T(_,{Result:()=>k});module.exports=S(_);var i=Symbol.for("@theateros/result"),p=Symbol.for("@theateros/result/ok"),a=Symbol.for("@theateros/result/err"),f=Symbol.for("@theateros/result/unset-default-value"),k;(v=>{function r(n){return{_type:i,_kind:p,value:n}}v.ok=r;function e(n){return{_type:i,_kind:a,error:n}}v.err=e;function t(n){return n instanceof Object&&"_type"in n&&"_kind"in n&&n._type===i}v.is=t;function s(n){return t(n)?n._kind===p:!1}v.isOk=s;function o(n){return t(n)?n._kind===a:!1}v.isErr=o;function x(n,u=f){if(s(n))return n.value;if(u===f)throw n.error;return u}v.unwrap=x;function d(n,u){return(...E)=>{try{let y=n(...E);return r(y)}catch(y){return e(u?u(y):y)}}}v.safe=d})(k||={});0&&(module.exports={Result});
+//# sourceMappingURL=result.cjs.map

package/dist/result.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/result.ts"],"sourcesContent":["const resultSymbol: unique symbol = Symbol.for('@theateros/result')\nconst okSymbol: unique symbol = Symbol.for('@theateros/result/ok')\nconst errSymbol: unique symbol = Symbol.for('@theateros/result/err')\nconst unsetDefaultValueSymbol: unique symbol = Symbol.for('@theateros/result/unset-default-value')\n\n/**\n * The Ok type represents a successful result.\n *\n * @typeparam T - The value type.\n */\nexport type Ok<T> = {\n  /**\n   * The type of the result. Allows us to brand the type of the result and ensure that\n   * that is comming from the @theateros/result package.\n   */\n  _type: typeof resultSymbol\n\n  /**\n   * The kind of the result. Allows us to brand the kind of the result and ensure that\n   * that is comming from the @theateros/result package.\n   */\n  _kind: typeof okSymbol\n\n  /**\n   * The value of the result.\n   */\n  value: T\n\n  /**\n   * The error of the result. Should be never because the result is OK.\n   */\n  error?: never\n}\n\n/**\n * The Err type represents a failed result.\n *\n * @typeparam E - The error type.\n */\nexport type Err<E> = {\n  /**\n   * The type of the result. Allows us to brand the type of the result and ensure that\n   * that is comming from the @theateros/result package.\n   */\n  _type: typeof resultSymbol\n\n  /**\n   * The kind of the result. Allows us to brand the kind of the result and ensure that\n   * that is comming from the @theateros/result package.\n   */\n  _kind: typeof errSymbol\n\n  /**\n   * The error of the result.\n   */\n  error: E\n\n  /**\n   * The value of the result. Should be never because the result is an error.\n   */\n  value?: never\n}\n\n/**\n * The Result type represents a result of a computation.\n *\n * @typeparam T - The value type.\n * @typeparam E - The error type.\n */\nexport type Result<T, E> = Ok<T> | Err<E>\n\nexport namespace Result {\n  /**\n   * Create a new Ok result.\n   *\n   * @typeparam T - The value type.\n   * @param value - The value of the result.\n   * @returns A new Ok result.\n   */\n  export function ok<T>(value: T): Ok<T> {\n    return { _type: resultSymbol, _kind: okSymbol, value }\n  }\n\n  /**\n   * Create a new Err result.\n   *\n   * @typeparam E - The error type.\n   * @param error - The error of the result.\n   * @returns A new Err result.\n   */\n  export function err<E>(error: E): Err<E> {\n    return { _type: resultSymbol, _kind: errSymbol, error }\n  }\n\n  /**\n   * Test if the given result is a result.\n   *\n   * @param result - The result to check.\n   *\n   * @typeparam T - The value type.\n   * @typeparam E - The error type.\n   *\n   * @returns True if the result is a result, false otherwise.\n   */\n  export function is<T = unknown, E = unknown>(result: unknown): result is Result<T, E> {\n    return result instanceof Object && '_type' in result && '_kind' in result && result._type === resultSymbol\n  }\n\n  /**\n   * Test if the given result is an Ok result.\n   *\n   * @param result - The result to check.\n   *\n   * @typeparam T - The value type.\n   *\n   * @returns True if the result is an Ok result, false otherwise.\n   */\n  export function isOk<T = unknown>(result: unknown): result is Ok<T> {\n    if (is(result)) {\n      return result._kind === okSymbol\n    }\n\n    return false\n  }\n\n  /**\n   * Test if the given result is an Err result.\n   *\n   * @param result - The result to check.\n   *\n   * @typeparam E - The error type.\n   *\n   * @returns True if the result is an Err result, false otherwise.\n   */\n  export function isErr<E = unknown>(result: unknown): result is Err<E> {\n    if (is(result)) {\n      return result._kind === errSymbol\n    }\n\n    return false\n  }\n\n  /**\n   * Unwrap the value of the given result.\n   *\n   * @param result - The result to unwrap.\n   *\n   * @typeparam T - The value type.\n   * @typeparam E - The error type.\n   *\n   * @throws If the result is an Err result and the default value is the unset default value (default value\n   * is not provided), the error of the result is thrown.\n   *\n   * @returns The value of the result.\n   */\n  export function unwrap<T = unknown, E = unknown>(\n    result: Result<T, E>,\n    defaultValue: T | typeof unsetDefaultValueSymbol = unsetDefaultValueSymbol,\n  ): T {\n    if (isOk(result)) {\n      return result.value\n    }\n\n    if (defaultValue === unsetDefaultValueSymbol) {\n      throw result.error\n    }\n\n    return defaultValue\n  }\n\n  /**\n   * A simple helper that represents any function.\n   *\n   * @typeparam Args - The arguments type.\n   * @typeparam Return - The return type.\n   */\n  // biome-ignore lint/suspicious/noExplicitAny: could be any function here\n  type AnyFn = (...args: any[]) => any\n\n  /**\n   * Safe wrap a function in a Result.\n   *\n   * @param fn - The function to safe wrap.\n   * @param onError - The function to handle the error.\n   *\n   * @typeparam T - The value type.\n   * @typeparam E - The error type.\n   *\n   * @returns A new function that wraps the given function in a Result.\n   */\n  export function safe<Fn extends AnyFn, E = unknown>(fn: Fn, onError?: (error: unknown) => E) {\n    return (...args: Parameters<Fn>): Result<ReturnType<Fn>, E> => {\n      try {\n        const value = fn(...args) as ReturnType<Fn>\n\n        return ok(value)\n      } catch (error) {\n        if (onError) {\n          return err(onError(error))\n        }\n\n        return err(error as E)\n      }\n    }\n  }\n}\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,YAAAE,IAAA,eAAAC,EAAAH,GAAA,IAAMI,EAA8B,OAAO,IAAI,mBAAmB,EAC5DC,EAA0B,OAAO,IAAI,sBAAsB,EAC3DC,EAA2B,OAAO,IAAI,uBAAuB,EAC7DC,EAAyC,OAAO,IAAI,uCAAuC,EAoEhFL,MAAV,CAQE,SAASM,EAAMC,EAAiB,CACrC,MAAO,CAAE,MAAOL,EAAc,MAAOC,EAAU,MAAAI,CAAM,CACvD,CAFOP,EAAS,GAAAM,EAWT,SAASE,EAAOC,EAAkB,CACvC,MAAO,CAAE,MAAOP,EAAc,MAAOE,EAAW,MAAAK,CAAM,CACxD,CAFOT,EAAS,IAAAQ,EAcT,SAASE,EAA6BC,EAAyC,CACpF,OAAOA,aAAkB,QAAU,UAAWA,GAAU,UAAWA,GAAUA,EAAO,QAAUT,CAChG,CAFOF,EAAS,GAAAU,EAaT,SAASE,EAAkBD,EAAkC,CAClE,OAAID,EAAGC,CAAM,EACJA,EAAO,QAAUR,EAGnB,EACT,CANOH,EAAS,KAAAY,EAiBT,SAASC,EAAmBF,EAAmC,CACpE,OAAID,EAAGC,CAAM,EACJA,EAAO,QAAUP,EAGnB,EACT,CANOJ,EAAS,MAAAa,EAqBT,SAASC,EACdH,EACAI,EAAmDV,EAChD,CACH,GAAIO,EAAKD,CAAM,EACb,OAAOA,EAAO,MAGhB,GAAII,IAAiBV,EACnB,MAAMM,EAAO,MAGf,OAAOI,CACT,CAbOf,EAAS,OAAAc,EAmCT,SAASE,EAAoCC,EAAQC,EAAiC,CAC3F,MAAO,IAAIC,IAAoD,CAC7D,GAAI,CACF,IAAMZ,EAAQU,EAAG,GAAGE,CAAI,EAExB,OAAOb,EAAGC,CAAK,CACjB,OAASE,EAAO,CACd,OACSD,EADLU,EACSA,EAAQT,CAAK,EAGfA,CAHgB,CAI7B,CACF,CACF,CAdOT,EAAS,KAAAgB,IAvHDhB,IAAA","names":["result_exports","__export","Result","__toCommonJS","resultSymbol","okSymbol","errSymbol","unsetDefaultValueSymbol","ok","value","err","error","is","result","isOk","isErr","unwrap","defaultValue","safe","fn","onError","args"]}

package/dist/result.d.cts

@@ -0,0 +1,146 @@
+declare const resultSymbol: unique symbol;
+declare const okSymbol: unique symbol;
+declare const errSymbol: unique symbol;
+declare const unsetDefaultValueSymbol: unique symbol;
+/**
+ * The Ok type represents a successful result.
+ *
+ * @typeparam T - The value type.
+ */
+type Ok<T> = {
+    /**
+     * The type of the result. Allows us to brand the type of the result and ensure that
+     * that is comming from the @theateros/result package.
+     */
+    _type: typeof resultSymbol;
+    /**
+     * The kind of the result. Allows us to brand the kind of the result and ensure that
+     * that is comming from the @theateros/result package.
+     */
+    _kind: typeof okSymbol;
+    /**
+     * The value of the result.
+     */
+    value: T;
+    /**
+     * The error of the result. Should be never because the result is OK.
+     */
+    error?: never;
+};
+/**
+ * The Err type represents a failed result.
+ *
+ * @typeparam E - The error type.
+ */
+type Err<E> = {
+    /**
+     * The type of the result. Allows us to brand the type of the result and ensure that
+     * that is comming from the @theateros/result package.
+     */
+    _type: typeof resultSymbol;
+    /**
+     * The kind of the result. Allows us to brand the kind of the result and ensure that
+     * that is comming from the @theateros/result package.
+     */
+    _kind: typeof errSymbol;
+    /**
+     * The error of the result.
+     */
+    error: E;
+    /**
+     * The value of the result. Should be never because the result is an error.
+     */
+    value?: never;
+};
+/**
+ * The Result type represents a result of a computation.
+ *
+ * @typeparam T - The value type.
+ * @typeparam E - The error type.
+ */
+type Result<T, E> = Ok<T> | Err<E>;
+declare namespace Result {
+    /**
+     * Create a new Ok result.
+     *
+     * @typeparam T - The value type.
+     * @param value - The value of the result.
+     * @returns A new Ok result.
+     */
+    export function ok<T>(value: T): Ok<T>;
+    /**
+     * Create a new Err result.
+     *
+     * @typeparam E - The error type.
+     * @param error - The error of the result.
+     * @returns A new Err result.
+     */
+    export function err<E>(error: E): Err<E>;
+    /**
+     * Test if the given result is a result.
+     *
+     * @param result - The result to check.
+     *
+     * @typeparam T - The value type.
+     * @typeparam E - The error type.
+     *
+     * @returns True if the result is a result, false otherwise.
+     */
+    export function is<T = unknown, E = unknown>(result: unknown): result is Result<T, E>;
+    /**
+     * Test if the given result is an Ok result.
+     *
+     * @param result - The result to check.
+     *
+     * @typeparam T - The value type.
+     *
+     * @returns True if the result is an Ok result, false otherwise.
+     */
+    export function isOk<T = unknown>(result: unknown): result is Ok<T>;
+    /**
+     * Test if the given result is an Err result.
+     *
+     * @param result - The result to check.
+     *
+     * @typeparam E - The error type.
+     *
+     * @returns True if the result is an Err result, false otherwise.
+     */
+    export function isErr<E = unknown>(result: unknown): result is Err<E>;
+    /**
+     * Unwrap the value of the given result.
+     *
+     * @param result - The result to unwrap.
+     *
+     * @typeparam T - The value type.
+     * @typeparam E - The error type.
+     *
+     * @throws If the result is an Err result and the default value is the unset default value (default value
+     * is not provided), the error of the result is thrown.
+     *
+     * @returns The value of the result.
+     */
+    export function unwrap<T = unknown, E = unknown>(result: Result<T, E>, defaultValue?: T | typeof unsetDefaultValueSymbol): T;
+    /**
+     * A simple helper that represents any function.
+     *
+     * @typeparam Args - The arguments type.
+     * @typeparam Return - The return type.
+     */
+    type AnyFn = (...args: any[]) => any;
+    /**
+     * Safe wrap a function in a Result.
+     *
+     * @param fn - The function to safe wrap.
+     * @param onError - The function to handle the error.
+     *
+     * @typeparam T - The value type.
+     * @typeparam E - The error type.
+     *
+     * @returns A new function that wraps the given function in a Result.
+     */
+    export function safe<Fn extends AnyFn, E = unknown>(fn: Fn, onError?: (error: unknown) => E): (...args: Parameters<Fn>) => Result<ReturnType<Fn>, E>;
+    export {  };
+}
+
+export { type Err, type Ok, Result };

package/dist/result.d.ts

@@ -7,7 +7,7 @@ declare const unsetDefaultValueSymbol: unique symbol;
  *
  * @typeparam T - The value type.
  */
-export type Ok<T> = {
+type Ok<T> = {
     /**
      * The type of the result. Allows us to brand the type of the result and ensure that
      * that is comming from the @theateros/result package.
@@ -32,7 +32,7 @@ export type Ok<T> = {
  *
  * @typeparam E - The error type.
  */
-export type Err<E> = {
+type Err<E> = {
     /**
      * The type of the result. Allows us to brand the type of the result and ensure that
      * that is comming from the @theateros/result package.
@@ -58,8 +58,8 @@ export type Err<E> = {
  * @typeparam T - The value type.
  * @typeparam E - The error type.
  */
-export type Result<T, E> = Ok<T> | Err<E>;
-export declare namespace Result {
+type Result<T, E> = Ok<T> | Err<E>;
+declare namespace Result {
     /**
      * Create a new Ok result.
      *
@@ -140,7 +140,7 @@ export declare namespace Result {
      * @returns A new function that wraps the given function in a Result.
      */
     export function safe<Fn extends AnyFn, E = unknown>(fn: Fn, onError?: (error: unknown) => E): (...args: Parameters<Fn>) => Result<ReturnType<Fn>, E>;
-    export {};
+    export {  };
 }
-export {};
-//# sourceMappingURL=result.d.ts.map
+
+export { type Err, type Ok, Result };

package/dist/result.js

@@ -1,128 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Result = void 0;
-const resultSymbol = Symbol.for('@theateros/result');
-const okSymbol = Symbol.for('@theateros/result/ok');
-const errSymbol = Symbol.for('@theateros/result/err');
-const unsetDefaultValueSymbol = Symbol.for('@theateros/result/unset-default-value');
-var Result;
-(function (Result) {
-    /**
-     * Create a new Ok result.
-     *
-     * @typeparam T - The value type.
-     * @param value - The value of the result.
-     * @returns A new Ok result.
-     */
-    function ok(value) {
-        return { _type: resultSymbol, _kind: okSymbol, value };
-    }
-    Result.ok = ok;
-    /**
-     * Create a new Err result.
-     *
-     * @typeparam E - The error type.
-     * @param error - The error of the result.
-     * @returns A new Err result.
-     */
-    function err(error) {
-        return { _type: resultSymbol, _kind: errSymbol, error };
-    }
-    Result.err = err;
-    /**
-     * Test if the given result is a result.
-     *
-     * @param result - The result to check.
-     *
-     * @typeparam T - The value type.
-     * @typeparam E - The error type.
-     *
-     * @returns True if the result is a result, false otherwise.
-     */
-    function is(result) {
-        return result instanceof Object && '_type' in result && '_kind' in result && result._type === resultSymbol;
-    }
-    Result.is = is;
-    /**
-     * Test if the given result is an Ok result.
-     *
-     * @param result - The result to check.
-     *
-     * @typeparam T - The value type.
-     *
-     * @returns True if the result is an Ok result, false otherwise.
-     */
-    function isOk(result) {
-        if (is(result)) {
-            return result._kind === okSymbol;
-        }
-        return false;
-    }
-    Result.isOk = isOk;
-    /**
-     * Test if the given result is an Err result.
-     *
-     * @param result - The result to check.
-     *
-     * @typeparam E - The error type.
-     *
-     * @returns True if the result is an Err result, false otherwise.
-     */
-    function isErr(result) {
-        if (is(result)) {
-            return result._kind === errSymbol;
-        }
-        return false;
-    }
-    Result.isErr = isErr;
-    /**
-     * Unwrap the value of the given result.
-     *
-     * @param result - The result to unwrap.
-     *
-     * @typeparam T - The value type.
-     * @typeparam E - The error type.
-     *
-     * @throws If the result is an Err result and the default value is the unset default value (default value
-     * is not provided), the error of the result is thrown.
-     *
-     * @returns The value of the result.
-     */
-    function unwrap(result, defaultValue = unsetDefaultValueSymbol) {
-        if (isOk(result)) {
-            return result.value;
-        }
-        if (defaultValue === unsetDefaultValueSymbol) {
-            throw result.error;
-        }
-        return defaultValue;
-    }
-    Result.unwrap = unwrap;
-    /**
-     * Safe wrap a function in a Result.
-     *
-     * @param fn - The function to safe wrap.
-     * @param onError - The function to handle the error.
-     *
-     * @typeparam T - The value type.
-     * @typeparam E - The error type.
-     *
-     * @returns A new function that wraps the given function in a Result.
-     */
-    function safe(fn, onError) {
-        return (...args) => {
-            try {
-                const value = fn(...args);
-                return ok(value);
-            }
-            catch (error) {
-                if (onError) {
-                    return err(onError(error));
-                }
-                return err(error);
-            }
-        };
-    }
-    Result.safe = safe;
-})(Result || (exports.Result = Result = {}));
+var t=Symbol.for("@theateros/result"),s=Symbol.for("@theateros/result/ok"),y=Symbol.for("@theateros/result/err"),l=Symbol.for("@theateros/result/unset-default-value"),f;(b=>{function i(n){return{_type:t,_kind:s,value:n}}b.ok=i;function o(n){return{_type:t,_kind:y,error:n}}b.err=o;function u(n){return n instanceof Object&&"_type"in n&&"_kind"in n&&n._type===t}b.is=u;function p(n){return u(n)?n._kind===s:!1}b.isOk=p;function k(n){return u(n)?n._kind===y:!1}b.isErr=k;function E(n,e=l){if(p(n))return n.value;if(e===l)throw n.error;return e}b.unwrap=E;function m(n,e){return(...a)=>{try{let r=n(...a);return i(r)}catch(r){return o(e?e(r):r)}}}b.safe=m})(f||={});export{f as Result};
 //# sourceMappingURL=result.js.map

package/dist/result.js.map

@@ -1 +1 @@
-{"version":3,"file":"result.js","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":";;;AAAA,MAAM,YAAY,GAAkB,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAA;AACnE,MAAM,QAAQ,GAAkB,MAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;AAClE,MAAM,SAAS,GAAkB,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAA;AACpE,MAAM,uBAAuB,GAAkB,MAAM,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAA;AAoElG,IAAiB,MAAM,CAsItB;AAtID,WAAiB,MAAM;IACrB;;;;;;OAMG;IACH,SAAgB,EAAE,CAAI,KAAQ;QAC5B,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAA;IACxD,CAAC;IAFe,SAAE,KAEjB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,GAAG,CAAI,KAAQ;QAC7B,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAA;IACzD,CAAC;IAFe,UAAG,MAElB,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,EAAE,CAA2B,MAAe;QAC1D,OAAO,MAAM,YAAY,MAAM,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,KAAK,YAAY,CAAA;IAC5G,CAAC;IAFe,SAAE,KAEjB,CAAA;IAED;;;;;;;;OAQG;IACH,SAAgB,IAAI,CAAc,MAAe;QAC/C,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YACf,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,CAAA;QAClC,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IANe,WAAI,OAMnB,CAAA;IAED;;;;;;;;OAQG;IACH,SAAgB,KAAK,CAAc,MAAe;QAChD,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YACf,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAAA;QACnC,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IANe,YAAK,QAMpB,CAAA;IAED;;;;;;;;;;;;OAYG;IACH,SAAgB,MAAM,CACpB,MAAoB,EACpB,eAAmD,uBAAuB;QAE1E,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC,KAAK,CAAA;QACrB,CAAC;QAED,IAAI,YAAY,KAAK,uBAAuB,EAAE,CAAC;YAC7C,MAAM,MAAM,CAAC,KAAK,CAAA;QACpB,CAAC;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;IAbe,aAAM,SAarB,CAAA;IAWD;;;;;;;;;;OAUG;IACH,SAAgB,IAAI,CAAgC,EAAM,EAAE,OAA+B;QACzF,OAAO,CAAC,GAAG,IAAoB,EAA6B,EAAE;YAC5D,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,EAAE,CAAC,GAAG,IAAI,CAAmB,CAAA;gBAE3C,OAAO,EAAE,CAAC,KAAK,CAAC,CAAA;YAClB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,OAAO,EAAE,CAAC;oBACZ,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;gBAC5B,CAAC;gBAED,OAAO,GAAG,CAAC,KAAU,CAAC,CAAA;YACxB,CAAC;QACH,CAAC,CAAA;IACH,CAAC;IAde,WAAI,OAcnB,CAAA;AACH,CAAC,EAtIgB,MAAM,sBAAN,MAAM,QAsItB"}
+{"version":3,"sources":["../src/result.ts"],"sourcesContent":["const resultSymbol: unique symbol = Symbol.for('@theateros/result')\nconst okSymbol: unique symbol = Symbol.for('@theateros/result/ok')\nconst errSymbol: unique symbol = Symbol.for('@theateros/result/err')\nconst unsetDefaultValueSymbol: unique symbol = Symbol.for('@theateros/result/unset-default-value')\n\n/**\n * The Ok type represents a successful result.\n *\n * @typeparam T - The value type.\n */\nexport type Ok<T> = {\n  /**\n   * The type of the result. Allows us to brand the type of the result and ensure that\n   * that is comming from the @theateros/result package.\n   */\n  _type: typeof resultSymbol\n\n  /**\n   * The kind of the result. Allows us to brand the kind of the result and ensure that\n   * that is comming from the @theateros/result package.\n   */\n  _kind: typeof okSymbol\n\n  /**\n   * The value of the result.\n   */\n  value: T\n\n  /**\n   * The error of the result. Should be never because the result is OK.\n   */\n  error?: never\n}\n\n/**\n * The Err type represents a failed result.\n *\n * @typeparam E - The error type.\n */\nexport type Err<E> = {\n  /**\n   * The type of the result. Allows us to brand the type of the result and ensure that\n   * that is comming from the @theateros/result package.\n   */\n  _type: typeof resultSymbol\n\n  /**\n   * The kind of the result. Allows us to brand the kind of the result and ensure that\n   * that is comming from the @theateros/result package.\n   */\n  _kind: typeof errSymbol\n\n  /**\n   * The error of the result.\n   */\n  error: E\n\n  /**\n   * The value of the result. Should be never because the result is an error.\n   */\n  value?: never\n}\n\n/**\n * The Result type represents a result of a computation.\n *\n * @typeparam T - The value type.\n * @typeparam E - The error type.\n */\nexport type Result<T, E> = Ok<T> | Err<E>\n\nexport namespace Result {\n  /**\n   * Create a new Ok result.\n   *\n   * @typeparam T - The value type.\n   * @param value - The value of the result.\n   * @returns A new Ok result.\n   */\n  export function ok<T>(value: T): Ok<T> {\n    return { _type: resultSymbol, _kind: okSymbol, value }\n  }\n\n  /**\n   * Create a new Err result.\n   *\n   * @typeparam E - The error type.\n   * @param error - The error of the result.\n   * @returns A new Err result.\n   */\n  export function err<E>(error: E): Err<E> {\n    return { _type: resultSymbol, _kind: errSymbol, error }\n  }\n\n  /**\n   * Test if the given result is a result.\n   *\n   * @param result - The result to check.\n   *\n   * @typeparam T - The value type.\n   * @typeparam E - The error type.\n   *\n   * @returns True if the result is a result, false otherwise.\n   */\n  export function is<T = unknown, E = unknown>(result: unknown): result is Result<T, E> {\n    return result instanceof Object && '_type' in result && '_kind' in result && result._type === resultSymbol\n  }\n\n  /**\n   * Test if the given result is an Ok result.\n   *\n   * @param result - The result to check.\n   *\n   * @typeparam T - The value type.\n   *\n   * @returns True if the result is an Ok result, false otherwise.\n   */\n  export function isOk<T = unknown>(result: unknown): result is Ok<T> {\n    if (is(result)) {\n      return result._kind === okSymbol\n    }\n\n    return false\n  }\n\n  /**\n   * Test if the given result is an Err result.\n   *\n   * @param result - The result to check.\n   *\n   * @typeparam E - The error type.\n   *\n   * @returns True if the result is an Err result, false otherwise.\n   */\n  export function isErr<E = unknown>(result: unknown): result is Err<E> {\n    if (is(result)) {\n      return result._kind === errSymbol\n    }\n\n    return false\n  }\n\n  /**\n   * Unwrap the value of the given result.\n   *\n   * @param result - The result to unwrap.\n   *\n   * @typeparam T - The value type.\n   * @typeparam E - The error type.\n   *\n   * @throws If the result is an Err result and the default value is the unset default value (default value\n   * is not provided), the error of the result is thrown.\n   *\n   * @returns The value of the result.\n   */\n  export function unwrap<T = unknown, E = unknown>(\n    result: Result<T, E>,\n    defaultValue: T | typeof unsetDefaultValueSymbol = unsetDefaultValueSymbol,\n  ): T {\n    if (isOk(result)) {\n      return result.value\n    }\n\n    if (defaultValue === unsetDefaultValueSymbol) {\n      throw result.error\n    }\n\n    return defaultValue\n  }\n\n  /**\n   * A simple helper that represents any function.\n   *\n   * @typeparam Args - The arguments type.\n   * @typeparam Return - The return type.\n   */\n  // biome-ignore lint/suspicious/noExplicitAny: could be any function here\n  type AnyFn = (...args: any[]) => any\n\n  /**\n   * Safe wrap a function in a Result.\n   *\n   * @param fn - The function to safe wrap.\n   * @param onError - The function to handle the error.\n   *\n   * @typeparam T - The value type.\n   * @typeparam E - The error type.\n   *\n   * @returns A new function that wraps the given function in a Result.\n   */\n  export function safe<Fn extends AnyFn, E = unknown>(fn: Fn, onError?: (error: unknown) => E) {\n    return (...args: Parameters<Fn>): Result<ReturnType<Fn>, E> => {\n      try {\n        const value = fn(...args) as ReturnType<Fn>\n\n        return ok(value)\n      } catch (error) {\n        if (onError) {\n          return err(onError(error))\n        }\n\n        return err(error as E)\n      }\n    }\n  }\n}\n"],"mappings":"AAAA,IAAMA,EAA8B,OAAO,IAAI,mBAAmB,EAC5DC,EAA0B,OAAO,IAAI,sBAAsB,EAC3DC,EAA2B,OAAO,IAAI,uBAAuB,EAC7DC,EAAyC,OAAO,IAAI,uCAAuC,EAoEhFC,MAAV,CAQE,SAASC,EAAMC,EAAiB,CACrC,MAAO,CAAE,MAAON,EAAc,MAAOC,EAAU,MAAAK,CAAM,CACvD,CAFOF,EAAS,GAAAC,EAWT,SAASE,EAAOC,EAAkB,CACvC,MAAO,CAAE,MAAOR,EAAc,MAAOE,EAAW,MAAAM,CAAM,CACxD,CAFOJ,EAAS,IAAAG,EAcT,SAASE,EAA6BC,EAAyC,CACpF,OAAOA,aAAkB,QAAU,UAAWA,GAAU,UAAWA,GAAUA,EAAO,QAAUV,CAChG,CAFOI,EAAS,GAAAK,EAaT,SAASE,EAAkBD,EAAkC,CAClE,OAAID,EAAGC,CAAM,EACJA,EAAO,QAAUT,EAGnB,EACT,CANOG,EAAS,KAAAO,EAiBT,SAASC,EAAmBF,EAAmC,CACpE,OAAID,EAAGC,CAAM,EACJA,EAAO,QAAUR,EAGnB,EACT,CANOE,EAAS,MAAAQ,EAqBT,SAASC,EACdH,EACAI,EAAmDX,EAChD,CACH,GAAIQ,EAAKD,CAAM,EACb,OAAOA,EAAO,MAGhB,GAAII,IAAiBX,EACnB,MAAMO,EAAO,MAGf,OAAOI,CACT,CAbOV,EAAS,OAAAS,EAmCT,SAASE,EAAoCC,EAAQC,EAAiC,CAC3F,MAAO,IAAIC,IAAoD,CAC7D,GAAI,CACF,IAAMZ,EAAQU,EAAG,GAAGE,CAAI,EAExB,OAAOb,EAAGC,CAAK,CACjB,OAASE,EAAO,CACd,OACSD,EADLU,EACSA,EAAQT,CAAK,EAGfA,CAHgB,CAI7B,CACF,CACF,CAdOJ,EAAS,KAAAW,IAvHDX,IAAA","names":["resultSymbol","okSymbol","errSymbol","unsetDefaultValueSymbol","Result","ok","value","err","error","is","result","isOk","isErr","unwrap","defaultValue","safe","fn","onError","args"]}

package/package.json

@@ -1,22 +1,25 @@
 {
   "name": "@theateros/result",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "module": "dist/result.js",
   "type": "module",
   "scripts": {
     "lint": "biome check .",
     "test": "bun test",
-    "build:dist": "tsc",
+    "build:dist": "rm -rf dist && tsup",
     "release": "release-it"
   },
   "devDependencies": {
     "@types/bun": "catalog:",
     "typescript": "catalog:",
-    "release-it": "catalog:"
+    "release-it": "catalog:",
+    "tsup": "catalog:"
   },
   "exports": {
     ".": {
       "types": "./dist/result.d.ts",
+      "import": "./dist/result.js",
+      "require": "./dist/result.cjs",
       "default": "./dist/result.js"
     }
   },

package/tsup.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'tsup'
+import { baseConfig } from '../../tsup.base'
+
+export default defineConfig({
+  entry: ['src/result.ts'],
+  ...baseConfig,
+})

package/dist/result.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,YAAY,EAAE,OAAO,MAAwC,CAAA;AACnE,QAAA,MAAM,QAAQ,EAAE,OAAO,MAA2C,CAAA;AAClE,QAAA,MAAM,SAAS,EAAE,OAAO,MAA4C,CAAA;AACpE,QAAA,MAAM,uBAAuB,EAAE,OAAO,MAA4D,CAAA;AAElG;;;;GAIG;AACH,MAAM,MAAM,EAAE,CAAC,CAAC,IAAI;IAClB;;;OAGG;IACH,KAAK,EAAE,OAAO,YAAY,CAAA;IAE1B;;;OAGG;IACH,KAAK,EAAE,OAAO,QAAQ,CAAA;IAEtB;;OAEG;IACH,KAAK,EAAE,CAAC,CAAA;IAER;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI;IACnB;;;OAGG;IACH,KAAK,EAAE,OAAO,YAAY,CAAA;IAE1B;;;OAGG;IACH,KAAK,EAAE,OAAO,SAAS,CAAA;IAEvB;;OAEG;IACH,KAAK,EAAE,CAAC,CAAA;IAER;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAA;AAEzC,yBAAiB,MAAM,CAAC;IACtB;;;;;;OAMG;IACH,MAAM,UAAU,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAErC;IAED;;;;;;OAMG;IACH,MAAM,UAAU,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAEvC;IAED;;;;;;;;;OASG;IACH,MAAM,UAAU,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAEpF;IAED;;;;;;;;OAQG;IACH,MAAM,UAAU,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,CAMlE;IAED;;;;;;;;OAQG;IACH,MAAM,UAAU,KAAK,CAAC,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAMpE;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,UAAU,MAAM,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EAC7C,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,YAAY,GAAE,CAAC,GAAG,OAAO,uBAAiD,GACzE,CAAC,CAUH;IAED;;;;;OAKG;IAEH,KAAK,KAAK,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAEpC;;;;;;;;;;OAUG;IACH,MAAM,UAAU,IAAI,CAAC,EAAE,SAAS,KAAK,EAAE,CAAC,GAAG,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC,IACjF,GAAG,MAAM,UAAU,CAAC,EAAE,CAAC,KAAG,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAa5D;;CACF"}