@dayme/alien-utils 0.1.0

package/README.md

@@ -0,0 +1,98 @@
+# @dayme/alien-utils
+
+TypeScript utility library with functional programming data structures (Option, Result, Iter, Stack, Queue, Bimap, Match, Dispatch).
+
+## Installation
+
+```bash
+npm install @dayme/alien-utils
+# or
+bun add @dayme/alien-utils
+# or
+pnpm add @dayme/alien-utils
+```
+
+## Usage
+
+```typescript
+import { Option, Result, Iter, Stack, Queue } from "@dayme/alien-utils";
+
+// Option - Handle nullable values
+const maybeValue = Option.from("hello");
+const doubled = maybeValue.map(s => s.length * 2); // Some(10)
+
+// Result - Handle errors
+const result = Result.ok(42);
+const value = result.unwrapOr(0); // 42
+
+// Iter - Lazy transformations
+Iter.from([1, 2, 3])
+  .map(x => x * 2)
+  .filter(x => x > 3)
+  .collect(); // [4, 6]
+
+// Stack - LIFO
+const stack = new Stack<number>();
+stack.push(1).push(2);
+stack.pop(); // Some(2)
+
+// Queue - FIFO
+const queue = new Queue<number>();
+queue.enqueue(1).enqueue(2);
+queue.dequeue(); // Some(1)
+```
+
+## Documentation
+
+**[View Documentation](https://lisovskiyivan.github.io/alien-utils/)**
+
+## Development
+
+```bash
+# Install dependencies
+bun install
+
+# Build library
+bun run build
+
+# Watch mode (TypeScript + Vite)
+bun run dev
+
+# Run tests
+bun test
+
+# Run tests in watch mode
+bun test --watch
+
+# Playground for testing the package
+# First build the package: bun run build
+# Then run playground: bun run playground
+bun run playground
+
+# Development documentation
+bun run docs:dev
+
+# Build documentation
+bun run docs:build
+
+# Preview documentation
+bun run docs:preview
+```
+
+## Testing
+
+Tests are written using Bun's built-in test framework:
+
+```bash
+# Run all tests
+bun test
+
+# Run tests in watch mode
+bun test --watch
+```
+
+Tests cover all methods of `Option` (Some/None), `Result` (Ok/Err), and other classes, including practical usage examples.
+
+## License
+
+MIT

package/dist/bimap/bimap.d.ts

@@ -0,0 +1,44 @@
+export interface IBimap<K, V> {
+    set(key: K, value: V): this;
+    get(key: K): V | undefined;
+    getReverse(value: V): K | undefined;
+    has(key: K): boolean;
+    hasValue(value: V): boolean;
+    delete(key: K): boolean;
+    deleteValue(value: V): boolean;
+    clear(): void;
+    get size(): number;
+    keys(): K[];
+    values(): V[];
+    entries(): [K, V][];
+    reverseEntries(): [V, K][];
+}
+export declare class Bimap<K, V> implements IBimap<K, V> {
+    private _forward;
+    private _reverse;
+    constructor();
+    static from<K, V>(entries: Iterable<[K, V]>): Bimap<K, V>;
+    static of<K, V>(...entries: [K, V][]): Bimap<K, V>;
+    set(key: K, value: V): this;
+    get(key: K): V | undefined;
+    getReverse(value: V): K | undefined;
+    has(key: K): boolean;
+    hasValue(value: V): boolean;
+    delete(key: K): boolean;
+    deleteValue(value: V): boolean;
+    clear(): void;
+    get size(): number;
+    keys(): K[];
+    values(): V[];
+    entries(): [K, V][];
+    reverseEntries(): [V, K][];
+    forEach(callback: (value: V, key: K, bimap: Bimap<K, V>) => void): void;
+    forEachReverse(callback: (key: K, value: V, bimap: Bimap<K, V>) => void): void;
+    clone(): Bimap<K, V>;
+    toString(): string;
+    toJSON(): {
+        forward: [K, V][];
+        reverse: [V, K][];
+    };
+}
+//# sourceMappingURL=bimap.d.ts.map

package/dist/bimap/bimap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bimap.d.ts","sourceRoot":"","sources":["../../src/package/bimap/bimap.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM,CAAC,CAAC,EAAE,CAAC;IAC1B,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAE5B,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE3B,UAAU,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAEpC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;IAErB,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC;IAE5B,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;IAExB,WAAW,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC;IAE/B,KAAK,IAAI,IAAI,CAAC;IAEd,IAAI,IAAI,IAAI,MAAM,CAAC;IAEnB,IAAI,IAAI,CAAC,EAAE,CAAC;IAEZ,MAAM,IAAI,CAAC,EAAE,CAAC;IAEd,OAAO,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;IAEpB,cAAc,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;CAC5B;AAED,qBAAa,KAAK,CAAC,CAAC,EAAE,CAAC,CAAE,YAAW,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;IAC9C,OAAO,CAAC,QAAQ,CAAY;IAC5B,OAAO,CAAC,QAAQ,CAAY;;IAO5B,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAQzD,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAQlD,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAgB3B,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAI1B,UAAU,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAInC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO;IAIpB,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO;IAI3B,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO;IAUvB,WAAW,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO;IAU9B,KAAK,IAAI,IAAI;IAKb,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,IAAI,CAAC,EAAE;IAIX,MAAM,IAAI,CAAC,EAAE;IAIb,OAAO,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;IAInB,cAAc,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;IAI1B,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI;IAMvE,cAAc,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI;IAM9E,KAAK,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAQpB,QAAQ,IAAI,MAAM;IAOlB,MAAM,IAAI;QAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAA;KAAE;CAMnD"}

package/dist/bimap/index.d.ts

@@ -0,0 +1,4 @@
+import { Bimap } from './bimap';
+export { Bimap };
+export type { IBimap } from './bimap';
+//# sourceMappingURL=index.d.ts.map

package/dist/bimap/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/package/bimap/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,KAAK,EAAE,CAAC;AACjB,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC"}

package/dist/dispatch/dispatch.d.ts

@@ -0,0 +1,17 @@
+type TypeGuard<T> = (value: unknown) => value is T;
+type Handler<T, R> = (value: T) => R;
+export declare function dispatch<T = unknown, R = unknown>(): {
+    (value: T): R;
+    on<U>(guard: TypeGuard<U>, handler: Handler<U, R>): /*elided*/ any;
+    default(handler: (value: T) => R): /*elided*/ any;
+};
+export declare const isNumber: (value: unknown) => value is number;
+export declare const isString: (value: unknown) => value is string;
+export declare const isArray: (value: unknown) => value is unknown[];
+export declare const isBoolean: (value: unknown) => value is boolean;
+export declare const isNull: (value: unknown) => value is null;
+export declare const isUndefined: (value: unknown) => value is undefined;
+export declare const isObject: (value: unknown) => value is Record<string, unknown>;
+export declare const isFunction: (value: unknown) => value is (...args: unknown[]) => unknown;
+export {};
+//# sourceMappingURL=dispatch.d.ts.map

package/dist/dispatch/dispatch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dispatch.d.ts","sourceRoot":"","sources":["../../src/package/dispatch/dispatch.ts"],"names":[],"mappings":"AAAA,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC;AAEnD,KAAK,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;AAOrC,wBAAgB,QAAQ,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO;YAIpB,CAAC,GAAG,CAAC;OAcN,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,WAAW,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;qBAMhC,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC;EAMxD;AAED,eAAO,MAAM,QAAQ,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAAmC,CAAC;AACvF,eAAO,MAAM,QAAQ,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAAmC,CAAC;AACvF,eAAO,MAAM,OAAO,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,OAAO,EAA0B,CAAC;AACpF,eAAO,MAAM,SAAS,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,OAAqC,CAAC;AAC1F,eAAO,MAAM,MAAM,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,IAAsB,CAAC;AACxE,eAAO,MAAM,WAAW,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,SAAgC,CAAC;AACvF,eAAO,MAAM,QAAQ,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CACH,CAAC;AACvE,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAChD,CAAC"}

package/dist/dispatch/index.d.ts

@@ -0,0 +1,2 @@
+export { dispatch, isNumber, isString, isArray, isBoolean, isNull, isUndefined, isObject, isFunction } from './dispatch';
+//# sourceMappingURL=index.d.ts.map

package/dist/dispatch/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/package/dispatch/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export * from './result/index';
+export * from './option/index';
+export * from './iterator/index';
+export * from './match/index';
+export * from './dispatch/index';
+export * from './bimap/index';
+export * from './stack/index';
+export * from './queue/index';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/package/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC"}