aang 1.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Aadit M Shah
+
+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,23 @@
+<p align="center">
+  <img src="aang.svg" align="center" alt="Aang Logo" />
+  <h1 align="center">Aang (安昂)</h1>
+  <p align="center">A powerful functional programming library for TypeScript.</p>
+</p>
+<br/>
+<p align="center">
+  <a href="https://github.com/aaditmshah/aang/actions/workflows/continuous-deployment.yml">
+    <img src="https://img.shields.io/github/actions/workflow/status/aaditmshah/aang/continuous-deployment.yml?branch=alpha&logo=github" alt="GitHub Workflow Status" />
+  </a>
+  <a href="https://github.com/aaditmshah/aang/blob/alpha/LICENSE">
+    <img src="https://img.shields.io/github/license/aaditmshah/aang" alt="GitHub license" />
+  </a>
+  <a href="https://www.npmjs.com/package/aang">
+    <img src="https://img.shields.io/npm/v/aang?logo=npm" alt="npm" />
+  </a>
+  <a href="https://github.com/semantic-release/semantic-release">
+    <img src="https://img.shields.io/badge/semantic--release-gitmoji-E10079?logo=semantic-release" alt="semantic-release: gitmoji" />
+  </a>
+  <a href="https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Faaditmshah%2Faang">
+    <img src="https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2Faaditmshah%2Faang" alt="Twitter" />
+  </a>
+</p>

package/lib/add.d.ts

@@ -0,0 +1 @@
+export declare const add: (x: number, y: number) => number;

package/lib/add.js

@@ -0,0 +1 @@
+export const add = (x, y) => x + y;

package/lib/errors.d.ts

@@ -0,0 +1,9 @@
+export interface ErrorOptions {
+    cause?: unknown;
+}
+export declare abstract class CustomError extends Error {
+    constructor(name: string, message?: string, options?: ErrorOptions);
+}
+export declare class UnsafeExtractError extends CustomError {
+    constructor(message: string);
+}

package/lib/errors.js

@@ -0,0 +1,19 @@
+export class CustomError extends Error {
+    constructor(name, message, options) {
+        super(message, options);
+        Object.defineProperty(this, "name", {
+            value: name,
+            enumerable: false,
+            configurable: true,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if ("captureStackTrace" in Error) {
+            Error.captureStackTrace(this, new.target);
+        }
+    }
+}
+export class UnsafeExtractError extends CustomError {
+    constructor(message) {
+        super("UnsafeExtractError", message);
+    }
+}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./add.js";
+export * from "./errors.js";

package/lib/index.js

@@ -0,0 +1,2 @@
+export * from "./add.js";
+export * from "./errors.js";

package/lib/option.d.ts

@@ -0,0 +1,20 @@
+export type Option<A> = Some<A> | None;
+declare abstract class OptionMethods {
+    abstract readonly isSome: boolean;
+    abstract readonly isNone: boolean;
+    map<A, B>(this: Option<A>, morphism: (value: A) => B): Option<B>;
+    unsafeExtract<A>(this: Option<A>, error: Error | string): A;
+}
+declare class Some<out A> extends OptionMethods {
+    readonly value: A;
+    readonly isSome = true;
+    readonly isNone = false;
+    constructor(value: A);
+}
+declare class None extends OptionMethods {
+    readonly isSome = false;
+    readonly isNone = true;
+}
+export declare const some: <A>(value: A) => Some<A>;
+export declare const none: None;
+export type { Some, None };

package/lib/option.js

@@ -0,0 +1,26 @@
+import { UnsafeExtractError } from "./errors.js";
+class OptionMethods {
+    map(morphism) {
+        return this.isSome ? new Some(morphism(this.value)) : none;
+    }
+    unsafeExtract(error) {
+        if (this.isSome)
+            return this.value;
+        throw error instanceof Error ? error : new UnsafeExtractError(error);
+    }
+}
+class Some extends OptionMethods {
+    value;
+    isSome = true;
+    isNone = false;
+    constructor(value) {
+        super();
+        this.value = value;
+    }
+}
+class None extends OptionMethods {
+    isSome = false;
+    isNone = true;
+}
+export const some = (value) => new Some(value);
+export const none = new None();

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "aang",
+  "version": "1.1.0-alpha.1",
+  "description": "A powerful functional programming library for TypeScript.",
+  "keywords": [
+    "aang",
+    "functional",
+    "library",
+    "typescript"
+  ],
+  "homepage": "https://github.com/aaditmshah/aang",
+  "bugs": "https://github.com/aaditmshah/aang/issues",
+  "license": "MIT",
+  "author": "Aadit M Shah <aaditmshah@aadit.codes> (https://aadit.codes/)",
+  "funding": [
+    {
+      "type": "individual",
+      "url": "https://aadit.codes/sponsor"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/aaditmshah"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/aaditmshah"
+    },
+    {
+      "type": "patreon",
+      "url": "https://www.patreon.com/aaditmshah"
+    },
+    {
+      "type": "buymeacoffee",
+      "url": "https://www.buymeacoffee.com/aaditmshah"
+    }
+  ],
+  "files": [
+    "lib"
+  ],
+  "type": "module",
+  "exports": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "repository": "github:aaditmshah/aang",
+  "scripts": {
+    "clean": "git clean -fdx",
+    "prettier:write": "prettier --write .",
+    "prettier:check": "prettier --check .",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "test": "rimraf coverage && jest",
+    "build": "rimraf lib && tsc -p tsconfig.build.json",
+    "check": "concurrently --kill-others-on-fail 'pnpm prettier:check' 'pnpm lint' 'pnpm typecheck' 'pnpm test' 'pnpm build'",
+    "prepare": "is-ci || husky install"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@types/node": "^20.11.6",
+    "@typescript-eslint/eslint-plugin": "^6.19.1",
+    "@typescript-eslint/parser": "^6.19.1",
+    "concurrently": "^8.2.2",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jest": "^27.6.3",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-unicorn": "^50.0.1",
+    "fast-check": "^3.15.0",
+    "gitmoji-cli": "^9.0.0",
+    "husky": "^8.0.3",
+    "is-ci": "^3.0.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.4",
+    "rimraf": "^5.0.5",
+    "semantic-release": "^22.0.12",
+    "semantic-release-gitmoji": "^1.6.5",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">=16.9"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}