functype 0.8.55 → 0.8.61

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Jordan Burke
-
-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
+MIT License
+
+Copyright (c) 2025 Jordan Burke
+
+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

@@ -1,197 +1,277 @@
-# Functype
-
-![NPM Version](https://img.shields.io/npm/v/functype?link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Ffunctype)
-[![Node.js Build](https://github.com/jordanburke/functype/actions/workflows/pnpm-build.yml/badge.svg)](https://github.com/jordanburke/functype/actions/workflows/pnpm-build.yml)
-
-## A Functional Programming Library for TypeScript
-
-Functype is a lightweight functional programming library for TypeScript, drawing inspiration from functional programming paradigms, the Scala Standard Library, and ZIO. It provides a comprehensive set of utilities and abstractions designed to facilitate functional programming within TypeScript applications.
-
-## Core Principles
-
-- **Immutability**: All data structures are immutable, promoting predictable and side-effect-free code
-- **Type Safety**: Leverages TypeScript's type system to ensure compile-time safety
-- **Composability**: Provides abstractions for building complex programs from simple components
-- **Functional Paradigms**: Embraces concepts like monads, functors, and type classes
-
-## Key Features
-
-- **Option Type**: Handle nullable values with `Some` and `None` types
-- **Either Type**: Express computation results with potential failures using `Left` and `Right`
-- **List, Set, Map**: Immutable collection types with functional operators
-- **Try Type**: Safely execute operations that might throw exceptions
-- **Task**: Handle synchronous and asynchronous operations with error handling
-- **Tuple**: Type-safe fixed-length arrays
-- **Typeable**: Runtime type identification with compile-time safety
-
-## Installation
-
-```bash
-# NPM
-npm install functype
-
-# Yarn
-yarn add functype
-
-# PNPM
-pnpm add functype
-
-# Bun
-bun add functype
-```
-
-## Usage Examples
-
-### Option
-
-```typescript
-import { Option, Some, None } from "functype"
-
-// Create options
-const value = Option("hello") // Some("hello")
-const empty = Option(null) // None
-const explicit = Some(42) // Some(42)
-
-// Transform values
-const length = value.map((s) => s.length) // Some(5)
-const nothing = empty.map((s) => s.length) // None
-
-// Handle default values
-const result = value.getOrElse("world") // "hello"
-const fallback = empty.getOrElse("world") // "world"
-
-// Conditionally filter
-const filtered = value.filter((s) => s.length > 10) // None
-```
-
-### Either
-
-```typescript
-import { Either, Right, Left } from "functype"
-
-// Success case
-const success = Right<string, number>(42)
-// Error case
-const failure = Left<string, number>("error")
-
-// Transform values (map only applies to Right)
-const doubled = success.map((x) => x * 2) // Right(84)
-const stillError = failure.map((x) => x * 2) // Left("error")
-
-// Handle errors
-const value = success.getOrElse(0) // 42
-const fallback = failure.getOrElse(0) // 0
-
-// Pattern matching with fold
-const result = success.fold(
-  (err) => `Error: ${err}`,
-  (val) => `Success: ${val}`,
-) // "Success: 42"
-```
-
-### List
-
-```typescript
-import { List } from "functype"
-
-const numbers = List([1, 2, 3, 4])
-
-// Transform
-const doubled = numbers.map((x) => x * 2) // List([2, 4, 6, 8])
-
-// Filter
-const evens = numbers.filter((x) => x % 2 === 0) // List([2, 4])
-
-// Reduce
-const sum = numbers.foldLeft(0)((acc, x) => acc + x) // 10
-
-// Add/remove elements (immutably)
-const withFive = numbers.add(5) // List([1, 2, 3, 4, 5])
-const without3 = numbers.remove(3) // List([1, 2, 4])
-```
-
-### Try
-
-```typescript
-import { Try } from "functype"
-
-// Safely execute code that might throw
-const result = Try(() => {
-  // Potentially throwing operation
-  return JSON.parse('{"name": "John"}')
-})
-
-// Handle success/failure
-if (result.isSuccess()) {
-  console.log("Result:", result.get())
-} else {
-  console.error("Error:", result.error)
-}
-
-// Transform with map (only applies on Success)
-const name = result.map((obj) => obj.name)
-
-// Convert to Either
-const either = result.toEither()
-```
-
-### Task
-
-```typescript
-import { Task } from "functype"
-
-// Synchronous operations with error handling
-const syncResult = Task().Task(
-  () => "success",
-  (error) => new Error(`Failed: ${error}`),
-)
-
-// Asynchronous operations
-const asyncTask = async () => {
-  const result = await Task().Async(
-    async () => await fetchData(),
-    async (error) => new Error(`Fetch failed: ${error}`),
-  )
-  return result
-}
-```
-
-## Type Safety
-
-Functype leverages TypeScript's advanced type system to provide compile-time safety for functional patterns, ensuring that your code is both robust and maintainable.
-
-```typescript
-// Type inference works seamlessly
-const option = Option(42)
-// Inferred as number
-const mappedValue = option.map((x) => x.toString())
-// Inferred as string
-```
-
-## Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-## License
-
-MIT License
-
-Copyright (c) 2025 Jordan Burke
-
-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.
+# Functype
+
+![NPM Version](https://img.shields.io/npm/v/functype?link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Ffunctype)
+[![Node.js Build](https://github.com/jordanburke/functype/actions/workflows/pnpm-build.yml/badge.svg)](https://github.com/jordanburke/functype/actions/workflows/pnpm-build.yml)
+
+## A Functional Programming Library for TypeScript
+
+Functype is a lightweight functional programming library for TypeScript, drawing inspiration from functional programming paradigms, the Scala Standard Library, and ZIO. It provides a comprehensive set of utilities and abstractions designed to facilitate functional programming within TypeScript applications.
+
+[API Documentation](https://jordanburke.github.io/functype/)
+
+## Core Principles
+
+- **Immutability**: All data structures are immutable, promoting predictable and side-effect-free code
+- **Type Safety**: Leverages TypeScript's type system to ensure compile-time safety
+- **Composability**: Provides abstractions for building complex programs from simple components
+- **Functional Paradigms**: Embraces concepts like monads, functors, and type classes
+
+## Key Features
+
+- **Option Type**: Handle nullable values with `Some` and `None` types
+- **Either Type**: Express computation results with potential failures using `Left` and `Right`
+- **List, Set, Map**: Immutable collection types with functional operators
+- **Try Type**: Safely execute operations that might throw exceptions
+- **Task**: Handle synchronous and asynchronous operations with error handling
+- **Tuple**: Type-safe fixed-length arrays
+- **Typeable**: Runtime type identification with compile-time safety
+
+## Roadmap / TODO
+
+### Missing Functionality
+
+- [ ] Add lazy evaluation structures (LazyList/Stream)
+- [ ] Implement Validation type for applicative validation
+- [ ] Add Reader/State/IO monads for more functional patterns
+- [ ] Implement lens/optics for immutable updates
+- [ ] Expand concurrent execution utilities beyond FPromise.all
+
+### Performance Optimizations
+
+- [ ] Add memoization utilities
+- [ ] Improve recursive operations for large collections
+- [ ] Implement immutable data structures with structural sharing
+- [ ] Add performance benchmarks
+- [x] Optimize TreeShaking with sideEffects flag in package.json
+- [x] Support selective module imports for smaller bundles
+- [x] Add bundle size monitoring to CI/CD
+
+### API Consistency
+
+- [ ] Ensure all modules follow the Scala-inspired pattern:
+  - Constructor functions that return objects with methods
+  - Object methods for common operations
+  - Companion functions for additional utilities
+- [x] Align Task API with other monadic structures
+- [ ] Standardize import patterns (@ imports vs relative paths)
+- [x] Implement consistent error handling strategy for async operations
+
+### Testing and Documentation
+
+- [ ] Add observable test coverage metrics
+- [x] Implement property-based testing
+- [ ] Expand error handling tests
+- [ ] Add interoperability tests with other libraries
+
+### TypeScript Improvements
+
+- [x] Enable stricter TypeScript settings (noImplicitAny: true)
+- [x] Add noUncheckedIndexedAccess for safer array indexing
+- [ ] Improve support for higher-kinded types:
+  - Current type parameters work well for first-order types
+  - Expand to support type constructors as parameters (F<A> => F<B>)
+- [ ] Add branded/nominal types for stronger type safety
+- [ ] Implement more type-level utilities (conditional types, template literals)
+- [ ] Leverage newer TypeScript features (const type parameters, tuple manipulation)
+
+## Installation
+
+```bash
+# NPM
+npm install functype
+
+# Yarn
+yarn add functype
+
+# PNPM
+pnpm add functype
+
+# Bun
+bun add functype
+```
+
+### Bundle Size Optimization
+
+Functype is optimized for tree-shaking and offers multiple import strategies to minimize bundle size:
+
+```typescript
+// Selective module imports (recommended for production)
+import { Option } from "functype/option"
+import { Either } from "functype/either"
+
+// Direct constructor imports (smallest bundle)
+import { some, none } from "functype/option"
+```
+
+For detailed optimization strategies, see the [Bundle Optimization Guide](docs/BUNDLE_OPTIMIZATION.md).
+
+## Usage Examples
+
+### Option
+
+```typescript
+import { Option, Some, None } from "functype"
+
+// Create options
+const value = Option("hello") // Some("hello")
+const empty = Option(null) // None
+const explicit = Some(42) // Some(42)
+
+// Transform values
+const length = value.map((s) => s.length) // Some(5)
+const nothing = empty.map((s) => s.length) // None
+
+// Handle default values
+const result = value.getOrElse("world") // "hello"
+const fallback = empty.getOrElse("world") // "world"
+
+// Conditionally filter
+const filtered = value.filter((s) => s.length > 10) // None
+```
+
+### Either
+
+```typescript
+import { Either, Right, Left } from "functype"
+
+// Success case
+const success = Right<string, number>(42)
+// Error case
+const failure = Left<string, number>("error")
+
+// Transform values (map only applies to Right)
+const doubled = success.map((x) => x * 2) // Right(84)
+const stillError = failure.map((x) => x * 2) // Left("error")
+
+// Handle errors
+const value = success.getOrElse(0) // 42
+const fallback = failure.getOrElse(0) // 0
+
+// Pattern matching with fold
+const result = success.fold(
+  (err) => `Error: ${err}`,
+  (val) => `Success: ${val}`,
+) // "Success: 42"
+```
+
+### List
+
+```typescript
+import { List } from "functype"
+
+const numbers = List([1, 2, 3, 4])
+
+// Transform
+const doubled = numbers.map((x) => x * 2) // List([2, 4, 6, 8])
+
+// Filter
+const evens = numbers.filter((x) => x % 2 === 0) // List([2, 4])
+
+// Reduce
+const sum = numbers.foldLeft(0)((acc, x) => acc + x) // 10
+
+// Add/remove elements (immutably)
+const withFive = numbers.add(5) // List([1, 2, 3, 4, 5])
+const without3 = numbers.remove(3) // List([1, 2, 4])
+```
+
+### Try
+
+```typescript
+import { Try } from "functype"
+
+// Safely execute code that might throw
+const result = Try(() => {
+  // Potentially throwing operation
+  return JSON.parse('{"name": "John"}')
+})
+
+// Handle success/failure
+if (result.isSuccess()) {
+  console.log("Result:", result.get())
+} else {
+  console.error("Error:", result.error)
+}
+
+// Transform with map (only applies on Success)
+const name = result.map((obj) => obj.name)
+
+// Convert to Either
+const either = result.toEither()
+```
+
+### Task
+
+```typescript
+import { Task } from "functype"
+
+// Synchronous operations with error handling
+const syncResult = Task().Sync(
+  () => "success",
+  (error) => new Error(`Failed: ${error}`),
+)
+
+// Asynchronous operations
+const asyncTask = async () => {
+  const result = await Task().Async(
+    async () => await fetchData(),
+    async (error) => new Error(`Fetch failed: ${error}`),
+  )
+  return result
+}
+
+// Converting promise-based functions to Task
+const fetchUserAPI = (userId: string): Promise<User> => fetch(`/api/users/${userId}`).then((r) => r.json())
+
+// Use the adapter pattern for seamless integration
+const fetchUser = Task({ name: "UserFetch" }).fromPromise(fetchUserAPI)
+
+// Later use it with standard promise patterns
+fetchUser("user123")
+  .then((user) => console.log(user))
+  .catch((error) => console.error(error))
+
+// Or convert Task results back to promises
+const taskResult = Task().Sync(() => "hello world")
+const promise = Task().toPromise(taskResult) // Promise<string>
+```
+
+## Type Safety
+
+Functype leverages TypeScript's advanced type system to provide compile-time safety for functional patterns, ensuring that your code is both robust and maintainable.
+
+```typescript
+// Type inference works seamlessly
+const option = Option(42)
+// Inferred as number
+const mappedValue = option.map((x) => x.toString())
+// Inferred as string
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT License
+
+Copyright (c) 2025 Jordan Burke
+
+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/dist/Tuple-GXgoHfiN.d.ts

@@ -0,0 +1,54 @@
+type SingleType = unknown;
+type ArrayType = SingleType[];
+type Type = SingleType | ArrayType;
+type AbstractFunctor<A extends Type> = {
+    map(f: (value: A) => Type): AbstractFunctor<Type>;
+    flatMap(f: (value: A) => AbstractFunctor<Type>): AbstractFunctor<Type>;
+};
+type Functor<A extends Type> = AbstractFunctor<A> & {
+    map<B extends Type>(f: (value: A) => B): Functor<B>;
+    flatMap<B extends Type>(f: (value: A) => Functor<B>): Functor<B>;
+};
+type AsyncFunctor<A extends Type> = {
+    flatMapAsync(f: (value: A) => PromiseLike<AsyncFunctor<A>>): PromiseLike<AsyncFunctor<A>>;
+};
+type ArrayFunctor<A extends ArrayType> = AbstractFunctor<A> & {
+    map<U extends ArrayType>(f: (value: A) => U): ArrayFunctor<U>;
+    flatMap<U extends ArrayType>(f: (value: A) => ArrayFunctor<U>): ArrayFunctor<U>;
+};
+
+type TypeableParams<Tag extends string, T> = {
+    _tag: Tag;
+    impl: T;
+};
+type ExtractTag<T> = T extends Typeable<infer Tag, unknown> ? Tag : never;
+type Typeable<Tag extends string, T = object> = T & {
+    readonly _tag: Tag;
+};
+declare function Typeable<Tag extends string, T>({ _tag, impl }: TypeableParams<Tag, T>): Typeable<Tag, T>;
+declare function isTypeable<T>(value: unknown, tag: string): value is T;
+
+type ValuableParams<Tag extends string, T, V> = {
+    _tag: Tag;
+    impl: T;
+    value: V;
+};
+declare function Valuable<Tag extends string, V, T = object>(params: ValuableParams<Tag, T, V>): T & {
+    toValue: () => {
+        _tag: Tag;
+        value: V;
+    };
+    _tag: Tag;
+};
+type Valuable<Tag extends string, V, T = object> = ReturnType<typeof Valuable<Tag, V, T>>;
+
+type Tuple<T extends ArrayType> = {
+    get<K extends number>(index: K): T[K];
+    map<U extends ArrayType>(f: (value: T) => U): Tuple<U>;
+    flatMap<U extends ArrayType>(f: (value: T) => Tuple<U>): Tuple<U>;
+    toArray(): T;
+    [Symbol.iterator](): Iterator<T[number]>;
+} & ArrayFunctor<T> & Typeable<"Tuple"> & Valuable<"Tuple", T>;
+declare const Tuple: <T extends ArrayType>(values: T) => Tuple<T>;
+
+export { type AsyncFunctor as A, type ExtractTag as E, type Functor as F, type SingleType as S, Typeable as T, Valuable as V, type Type as a, Tuple as b, type ArrayType as c, type AbstractFunctor as d, type ArrayFunctor as e, type TypeableParams as f, isTypeable as i };

package/dist/branded/index.d.ts

@@ -0,0 +1,48 @@
+type Unbrand<T> = T extends Brand<string, infer U> ? U : never;
+type ExtractBrand<T> = T extends Brand<infer K, unknown> ? K : never;
+/**
+ * Brand is a utility for creating nominal typing in TypeScript
+ * It allows for creating distinct types that are structurally identical
+ * but considered different by TypeScript's type system
+ */
+type Brand<K extends string, T> = T & {
+    readonly __brand: K;
+};
+/**
+ * Helper to create a branded type
+ * @param value - The value to brand
+ * @returns The branded value
+ */
+declare function Brand<K extends string, T>(brand: K, value: T): Brand<K, T>;
+/**
+ * Helper to remove a brand from a value
+ * @param branded - The branded value
+ * @returns The original value without the brand
+ */
+declare function unbrand<T>(branded: Brand<string, T>): T;
+/**
+ * Type guard for checking if a value has a specific brand
+ * @param value - The value to check
+ * @param brand - The brand to check for
+ * @returns True if the value has the specified brand
+ *
+ * Note: Since brands are phantom types that exist only at compile time,
+ * this function can only provide a runtime approximation. It always returns true
+ * for non-null values, as we have no way to actually check the brand at runtime.
+ * This function is primarily for API consistency and documentation purposes.
+ */
+declare function hasBrand<K extends string, T>(value: unknown, brand: K): value is Brand<K, T>;
+/**
+ * Create a branded type constructor for a specific brand
+ * @param brand - The brand name
+ * @returns A function that brands values with the specified brand
+ */
+declare function createBrander<K extends string, T>(brand: K): (value: T) => Brand<K, T>;
+type BrandedString<K extends string> = Brand<K, string>;
+declare const BrandedString: <K extends string>(brand: K) => (value: string) => BrandedString<K>;
+type BrandedNumber<K extends string> = Brand<K, number>;
+declare const BrandedNumber: <K extends string>(brand: K) => (value: number) => BrandedNumber<K>;
+type BrandedBoolean<K extends string> = Brand<K, boolean>;
+declare const BrandedBoolean: <K extends string>(brand: K) => (value: boolean) => BrandedBoolean<K>;
+
+export { Brand, BrandedBoolean, BrandedNumber, BrandedString, type ExtractBrand, type Unbrand, createBrander, hasBrand, unbrand };

package/dist/branded/index.mjs

@@ -0,0 +1,2 @@
+export{a as Brand,g as BrandedBoolean,f as BrandedNumber,e as BrandedString,d as createBrander,c as hasBrand,b as unbrand}from'../chunk-TQJDL6YW.mjs';//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/branded/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.mjs"}