resumon 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jan Müller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,62 @@
+<h1 align="center">resumon</h1>
+
+<p align="center">
+    A tiny TypeScript result monad.
+</p>
+
+<p align="center">
+  <a href="https://resumon.yeger.eu">
+    Documentation
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/DerYeger/resumon/actions/workflows/ci.yml">
+    <img alt="CI" src="https://img.shields.io/github/workflow/status/DerYeger/resumon/CI?label=ci&logo=github&color=#4DC71F">
+  </a>
+  <a href="https://www.npmjs.com/package/resumon">
+    <img alt="NPM" src="https://img.shields.io/npm/v/resumon?logo=npm">
+  </a>
+  <a href="https://codecov.io/gh/DerYeger/resumon">
+    <img alt="Coverage" src="https://codecov.io/gh/DerYeger/resumon/branch/master/graph/badge.svg?token=p35W6u2noe">
+  </a>
+  <a href="https://lgtm.com/projects/g/DerYeger/resumon">
+    <img alt="LGTM Grade" src="https://img.shields.io/lgtm/grade/javascript/github/DerYeger/resumon?logo=lgtm">
+  </a>
+  <a href="https://opensource.org/licenses/MIT">
+    <img alt="MIT" src="https://img.shields.io/npm/l/resumon?color=%234DC71F">
+  </a>
+  <a href="https://bundlephobia.com/package/resumon">
+    <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/resumon">
+  </a>
+</p>
+
+## Installation
+
+```bash
+# yarn
+$ yarn add resumon
+
+# npm
+$ npm install resumon
+```
+
+## Development
+
+```bash
+# install dependencies
+$ yarn install
+
+# build for production
+$ yarn build
+
+# lint project files
+$ yarn lint
+
+# run tests
+$ yarn test
+```
+
+## License
+
+[MIT](./LICENSE) - Copyright &copy; Jan Müller

package/dist/resumon.es.js

@@ -0,0 +1,95 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class IllegalStateError extends Error {
+}
+class Err {
+  constructor(error) {
+    __publicField(this, "isOk", false);
+    __publicField(this, "isError", true);
+    this.error = error;
+  }
+  get() {
+    throw new IllegalStateError("Cannot get data or Err");
+  }
+  getOrElse(other) {
+    return other;
+  }
+  getOrNull() {
+    return null;
+  }
+  getOrUndefined() {
+    return void 0;
+  }
+  getError() {
+    return this.error;
+  }
+  getErrorOrElse() {
+    return this.error;
+  }
+  getErrorOrNull() {
+    return this.error;
+  }
+  getErrorOrUndefined() {
+    return this.error;
+  }
+  andThen() {
+    return this;
+  }
+  map() {
+    return this;
+  }
+  mapError(map) {
+    return new Err(map(this.error));
+  }
+}
+function err(error) {
+  return new Err(error);
+}
+class Ok {
+  constructor(data) {
+    __publicField(this, "isOk", true);
+    __publicField(this, "isError", false);
+    this.data = data;
+  }
+  get() {
+    return this.data;
+  }
+  getOrElse() {
+    return this.data;
+  }
+  getOrNull() {
+    return this.data;
+  }
+  getOrUndefined() {
+    return this.data;
+  }
+  getError() {
+    throw new IllegalStateError("Cannot get error of Ok");
+  }
+  getErrorOrElse(other) {
+    return other;
+  }
+  getErrorOrNull() {
+    return null;
+  }
+  getErrorOrUndefined() {
+    return void 0;
+  }
+  andThen(map) {
+    return map(this.data);
+  }
+  map(map) {
+    return new Ok(map(this.data));
+  }
+  mapError() {
+    return this;
+  }
+}
+function ok(data) {
+  return new Ok(data);
+}
+export { Err, IllegalStateError, Ok, err, ok };

package/dist/resumon.umd.js

@@ -0,0 +1 @@
+var d=Object.defineProperty;var l=(r,e,n)=>e in r?d(r,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):r[e]=n;var o=(r,e,n)=>(l(r,typeof e!="symbol"?e+"":e,n),n);(function(r,e){typeof exports=="object"&&typeof module!="undefined"?e(exports):typeof define=="function"&&define.amd?define(["exports"],e):(r=typeof globalThis!="undefined"?globalThis:r||self,e(r.resumon={}))})(this,function(r){"use strict";class e extends Error{}class n{constructor(t){o(this,"isOk",!1);o(this,"isError",!0);this.error=t}get(){throw new e("Cannot get data or Err")}getOrElse(t){return t}getOrNull(){return null}getOrUndefined(){}getError(){return this.error}getErrorOrElse(){return this.error}getErrorOrNull(){return this.error}getErrorOrUndefined(){return this.error}andThen(){return this}map(){return this}mapError(t){return new n(t(this.error))}}function s(i){return new n(i)}class u{constructor(t){o(this,"isOk",!0);o(this,"isError",!1);this.data=t}get(){return this.data}getOrElse(){return this.data}getOrNull(){return this.data}getOrUndefined(){return this.data}getError(){throw new e("Cannot get error of Ok")}getErrorOrElse(t){return t}getErrorOrNull(){return null}getErrorOrUndefined(){}andThen(t){return t(this.data)}map(t){return new u(t(this.data))}mapError(){return this}}function a(i){return new u(i)}r.Err=n,r.IllegalStateError=e,r.Ok=u,r.err=s,r.ok=a,Object.defineProperty(r,"__esModule",{value:!0}),r[Symbol.toStringTag]="Module"});

package/dist/types/src/err.d.ts

@@ -0,0 +1,19 @@
+import { Failed, Result } from './result';
+export declare class Err<D, E> implements Result<D, E>, Failed<E> {
+    private readonly error;
+    readonly isOk = false;
+    readonly isError = true;
+    constructor(error: E);
+    get(): D;
+    getOrElse(other: D): D;
+    getOrNull(): null;
+    getOrUndefined(): undefined;
+    getError(): E;
+    getErrorOrElse(): E;
+    getErrorOrNull(): E;
+    getErrorOrUndefined(): E;
+    andThen<T>(): Result<T, E>;
+    map<T>(): Result<T, E>;
+    mapError<T, U>(map: (error: E) => U): Result<T, U>;
+}
+export declare function err<D, E>(error: E): Result<D, E>;

package/dist/types/src/main.d.ts

@@ -0,0 +1,3 @@
+export * from './err';
+export * from './ok';
+export * from './result';

package/dist/types/src/ok.d.ts

@@ -0,0 +1,19 @@
+import { Result, Succeeded } from './result';
+export declare class Ok<D, E> implements Result<D, E>, Succeeded<D> {
+    private readonly data;
+    readonly isOk = true;
+    readonly isError = false;
+    constructor(data: D);
+    get(): D;
+    getOrElse(): D;
+    getOrNull(): D;
+    getOrUndefined(): D;
+    getError(): E;
+    getErrorOrElse(other: E): E;
+    getErrorOrNull(): null;
+    getErrorOrUndefined(): undefined;
+    andThen<T>(map: (data: D) => Result<T, E>): Result<T, E>;
+    map<T>(map: (data: D) => T): Result<T, E>;
+    mapError<U>(): Result<D, U>;
+}
+export declare function ok<D, E>(data: D): Result<D, E>;

package/dist/types/src/result.d.ts

@@ -0,0 +1,31 @@
+export interface Result<D, E> extends Succeedable<D>, Failable<E> {
+    readonly isOk: boolean;
+    readonly isError: boolean;
+    andThen<T>(map: (data: D) => Result<T, E>): Result<T, E>;
+    map<T>(map: (data: D) => T): Result<T, E>;
+    mapError<U>(map: (error: E) => U): Result<D, U>;
+}
+export interface Succeedable<D> {
+    get(): D;
+    getOrElse(other: D): D;
+    getOrNull(): D | null;
+    getOrUndefined(): D | undefined;
+}
+export interface Succeeded<D> extends Succeedable<D> {
+    getOrElse(): D;
+    getOrNull(): D;
+    getOrUndefined(): D;
+}
+export interface Failable<E> {
+    getError(): E;
+    getErrorOrElse(other: E): E;
+    getErrorOrNull(): E | null;
+    getErrorOrUndefined(): E | undefined;
+}
+export interface Failed<E> extends Failable<E> {
+    getErrorOrElse(): E;
+    getErrorOrNull(): E;
+    getErrorOrUndefined(): E;
+}
+export declare class IllegalStateError extends Error {
+}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "resumon",
+  "description": "A tiny TypeScript result monad.",
+  "version": "1.0.1",
+  "license": "MIT",
+  "repository": "github:DerYeger/resumon",
+  "homepage": "https://resumon.yeger.eu",
+  "bugs": {
+    "url": "https://github.com/DerYeger/resumon/issues"
+  },
+  "author": {
+    "name": "Jan Müller",
+    "url": "https://github.com/DerYeger"
+  },
+  "keywords": [
+    "result",
+    "monad",
+    "typescript"
+  ],
+  "scripts": {
+    "prepare": "husky install",
+    "prebuild": "rimraf ./dist",
+    "build": "tsc --noEmit && vite build",
+    "docs:dev": "vuepress dev docs",
+    "docs:build": "vuepress build docs",
+    "lint": "yarn lint:prettier && yarn lint:eslint",
+    "lint:commits": "yarn commitlint --from=HEAD~1",
+    "lint:eslint": "eslint \"./**/*.{js,ts,vue}\"",
+    "lint:prettier": "prettier --check \"./**/*.{js,json,html,scss,ts,vue,yml}\"",
+    "fix": "yarn pretty && yarn lint:eslint --fix ",
+    "test": "vitest --api --open",
+    "test:ci": "rimraf ./coverage && c8 --reporter=lcov --reporter=text --all --src \"src\" --include \"src/*\" vitest --run",
+    "test:run": "vitest --run",
+    "pretty": "prettier --write \"./**/*.{js,json,html,scss,ts,vue,yml}\"",
+    "prepublishOnly": "yarn build"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/resumon.umd.js",
+  "module": "./dist/resumon.es.js",
+  "exports": {
+    ".": {
+      "import": "./dist/resumon.es.js",
+      "require": "./dist/resumon.umd.js"
+    }
+  },
+  "types": "dist/types/src/main.d.ts",
+  "sideEffects": false,
+  "devDependencies": {
+    "@commitlint/cli": "16.0.1",
+    "@commitlint/config-conventional": "16.0.0",
+    "@types/node": "16.11.17",
+    "@typescript-eslint/eslint-plugin": "5.8.1",
+    "@typescript-eslint/parser": "5.8.1",
+    "@vitest/ui": "0.0.127",
+    "@vue/component-compiler-utils": "3.3.0",
+    "@vuepress/plugin-register-components": "1.9.5",
+    "c8": "7.11.0",
+    "eslint": "8.6.0",
+    "eslint-config-prettier": "8.3.0",
+    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-tsdoc": "0.2.14",
+    "eslint-plugin-unused-imports": "2.0.0",
+    "eslint-plugin-vue": "8.2.0",
+    "husky": "7.0.4",
+    "lint-staged": "12.1.4",
+    "prettier": "2.5.1",
+    "rimraf": "3.0.2",
+    "typescript": "4.5.4",
+    "vite": "2.7.10",
+    "vite-plugin-dts": "0.9.7",
+    "vitest": "0.0.125",
+    "vuepress": "2.0.0-beta.32"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "lint-staged": {
+    "*.{js,json,html,scss,ts,vue,yml}": "prettier --write",
+    "*.{js,json,ts,vue}": "eslint --fix"
+  }
+}