@kaumlaut/pure 0.5.2 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Max Kämmerer
+
+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

@@ -2,4 +2,4 @@
 
 Types and functions for a state runtime inspired by Elm and functional programming
 
-- [API Reference](https://github.com/maxkaemmerer/pure-vue-poc/blob/main/pure/docs/README.md)
+- [API Reference](https://github.com/maxkaemmerer/pure/blob/main/docs/README.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaumlaut/pure",
-  "version": "0.5.2",
+  "version": "1.0.1",
   "description": "Types and functions for a state runtime inspired by Elm and functional programming",
   "author": "Max Kaemmerer",
   "license": "MIT",
@@ -8,6 +8,10 @@
   "types": "dist/index.d.ts",
   "type": "module",
   "module": "dist/index.js",
+  "repository": {
+    "url": "git+https://github.com/maxkaemmerer/pure.git",
+    "type": "git"
+  },
   "exports": {
     "./*": {
       "import": "./dist/*/index.js",
@@ -16,7 +20,6 @@
   },
   "files": [
     "dist",
-    "docs",
     "README.md"
   ],
   "scripts": {
@@ -25,10 +28,12 @@
     "lint": "eslint -c eslint.config.js --fix",
     "format": "prettier . --write",
     "test": "vitest",
-    "release": "npm run docs && npm run build && npm publish --access public"
+    "release-minor": "npm run docs && npm run build && git add ./docs && git commit -m 'update docs' && npm version minor && git push --tags && npm publish --access public",
+    "release-patch": "npm run docs && npm run build && git add ./docs && git commit -m 'update docs' && npm version patch && git push --tags && npm publish --access public",
+    "release-major": "npm run docs && npm run build && git add ./docs && git commit -m 'update docs' && npm version major && git push --tags && npm publish --access public"
   },
   "devDependencies": {
-    "@eslint/js": "^9.22.0",
+    "@eslint/js": "^9.24.0",
     "@types/node": "^24.3.0",
     "eslint": "^9.22.0",
     "globals": "^16.0.0",
@@ -38,5 +43,8 @@
     "typescript": "^5.8.2",
     "typescript-eslint": "^8.26.1",
     "vitest": "^3.0.8"
+  },
+  "dependencies": {
+    "vite-tsconfig-paths": "^5.1.4"
   }
 }

package/docs/README.md

@@ -1,23 +0,0 @@
-**@kaumlaut/pure v0.5.2**
-
-***
-
-# @kaumlaut/pure v0.5.2
-
-## Modules
-
-- [clone](clone.md)
-- [fetch-state](fetch-state.md)
-- [guard](guard.md)
-- [maybe](maybe.md)
-- [parse](parse.md)
-- [pipe](pipe.md)
-- [result](result.md)
-- [runtime](runtime.md)
-- [runtime/effect](runtime/effect.md)
-- [runtime/effect/fetch](runtime/effect/fetch.md)
-- [runtime/effect/none](runtime/effect/none.md)
-- [runtime/persistence](runtime/persistence.md)
-- [runtime/persistence/none](runtime/persistence/none.md)
-- [runtime/persistence/storage](runtime/persistence/storage.md)
-- [util](util.md)

package/docs/clone.md

@@ -1,45 +0,0 @@
-[**@kaumlaut/pure v0.5.2**](README.md)
-
-***
-
-[@kaumlaut/pure](README.md) / clone
-
-# clone
-
-Provides value cloning capabilities
-
-## Type Aliases
-
-### Cloneable
-
-> **Cloneable** = `string` \| `number` \| `boolean` \| `null` \| [`Cloneable`](#cloneable)[] \| \{\[`key`: `string`\]: [`Cloneable`](#cloneable); \}
-
-Defined in: [clone/index.ts:9](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/clone/index.ts#L9)
-
-Defines the Cloneable type
-
-## Functions
-
-### clone()
-
-> **clone**\<`T`\>(`value`): `T`
-
-Defined in: [clone/index.ts:20](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/clone/index.ts#L20)
-
-Recursively clones values to prevent changing of the original value.
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* [`Cloneable`](#cloneable)
-
-#### Parameters
-
-##### value
-
-`T`
-
-#### Returns
-
-`T`

package/docs/fetch-state.md

@@ -1,368 +0,0 @@
-[**@kaumlaut/pure v0.5.2**](README.md)
-
-***
-
-[@kaumlaut/pure](README.md) / fetch-state
-
-# fetch-state
-
-Provides types and functions to represent fetch request states
-
-## Type Aliases
-
-### Failed
-
-> **Failed** = `object`
-
-Defined in: [fetch-state/index.ts:10](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L10)
-
-Represents a failed fetch request
-
-#### Properties
-
-##### error
-
-> **error**: `Readonly`\<`string`\>
-
-Defined in: [fetch-state/index.ts:11](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L11)
-
-##### type
-
-> **type**: `"Failed"`
-
-Defined in: [fetch-state/index.ts:12](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L12)
-
-***
-
-### FetchState\<T\>
-
-> **FetchState**\<`T`\> = [`Failed`](#failed) \| [`None`](#none) \| [`Loading`](#loading) \| [`Success`](#success)\<`T`\>
-
-Defined in: [fetch-state/index.ts:39](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L39)
-
-Represents all possible states of a fetch request
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-***
-
-### Loading
-
-> **Loading** = `object`
-
-Defined in: [fetch-state/index.ts:25](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L25)
-
-Represents a fetch request that is currently still running
-
-#### Properties
-
-##### type
-
-> **type**: `"Loading"`
-
-Defined in: [fetch-state/index.ts:26](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L26)
-
-***
-
-### None
-
-> **None** = `object`
-
-Defined in: [fetch-state/index.ts:18](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L18)
-
-Represents a fetch request that has not been executed
-
-#### Properties
-
-##### type
-
-> **type**: `"None"`
-
-Defined in: [fetch-state/index.ts:19](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L19)
-
-***
-
-### Success\<T\>
-
-> **Success**\<`T`\> = `object`
-
-Defined in: [fetch-state/index.ts:32](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L32)
-
-Represents a fetch request that succeeded
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Properties
-
-##### data
-
-> **data**: `Readonly`\<`T`\>
-
-Defined in: [fetch-state/index.ts:33](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L33)
-
-##### type
-
-> **type**: `"Success"`
-
-Defined in: [fetch-state/index.ts:34](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L34)
-
-## Functions
-
-### attempt()
-
-> **attempt**\<`T`\>(`guard`, `error`): (`data`) => [`Failed`](#failed) \| [`Success`](#success)\<`T`\>
-
-Defined in: [fetch-state/index.ts:100](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L100)
-
-Attempts to create a fetch state of type Success if the given guard passes.
-Otherwise creates a fetch state of type Failed with the provided error.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### guard
-
-[`Guard`](guard.md#guard)\<`T`\>
-
-##### error
-
-`string` = `"Guard did not pass. Ensure the attempted data has the correct type"`
-
-#### Returns
-
-> (`data`): [`Failed`](#failed) \| [`Success`](#success)\<`T`\>
-
-##### Parameters
-
-###### data
-
-`unknown`
-
-##### Returns
-
-[`Failed`](#failed) \| [`Success`](#success)\<`T`\>
-
-#### Example
-
-```ts
-const value = attempt(isString, "Not a String")(3);
-if(isSuccess(value)){
- console.log(value.data)
-} else if (isFailed(value)){
- console.error(value.error)
-}
-```
-
-***
-
-### fail()
-
-> **fail**(`error`): [`Failed`](#failed)
-
-Defined in: [fetch-state/index.ts:67](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L67)
-
-Creates a fetch state of type Failed
-
-#### Parameters
-
-##### error
-
-`string`
-
-#### Returns
-
-[`Failed`](#failed)
-
-***
-
-### isFailed()
-
-> **isFailed**\<`T`\>(`state`): `state is Failed`
-
-Defined in: [fetch-state/index.ts:49](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L49)
-
-Checks whether or not the fetch state is Failed via a type guard
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### state
-
-[`FetchState`](#fetchstate)\<`T`\>
-
-#### Returns
-
-`state is Failed`
-
-***
-
-### isLoading()
-
-> **isLoading**\<`T`\>(`state`): `state is Loading`
-
-Defined in: [fetch-state/index.ts:43](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L43)
-
-Checks whether or not the fetch state is Loading via a type guard
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### state
-
-[`FetchState`](#fetchstate)\<`T`\>
-
-#### Returns
-
-`state is Loading`
-
-***
-
-### isNone()
-
-> **isNone**\<`T`\>(`state`): `state is None`
-
-Defined in: [fetch-state/index.ts:55](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L55)
-
-Checks whether or not the fetch state is None via a type guard
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### state
-
-[`FetchState`](#fetchstate)\<`T`\>
-
-#### Returns
-
-`state is None`
-
-***
-
-### isSuccess()
-
-> **isSuccess**\<`T`\>(`state`): `state is Success<T>`
-
-Defined in: [fetch-state/index.ts:61](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L61)
-
-Checks whether or not the fetch state is Success via a type guard
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### state
-
-[`FetchState`](#fetchstate)\<`T`\>
-
-#### Returns
-
-`state is Success<T>`
-
-***
-
-### load()
-
-> **load**(): [`Loading`](#loading)
-
-Defined in: [fetch-state/index.ts:76](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L76)
-
-Creates a fetch state of type Loading
-
-#### Returns
-
-[`Loading`](#loading)
-
-***
-
-### mapFailed()
-
-> **mapFailed**\<`T`\>(`mapper`): (`state`) => [`FetchState`](#fetchstate)\<`T`\>
-
-Defined in: [fetch-state/index.ts:131](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L131)
-
-A Utility function that allows to map the Failed fetch state to any other fetch state.
-The mapper function is only called if the given fetch state is Failed.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### mapper
-
-(`state`) => [`FetchState`](#fetchstate)\<`T`\>
-
-#### Returns
-
-> (`state`): [`FetchState`](#fetchstate)\<`T`\>
-
-##### Parameters
-
-###### state
-
-[`FetchState`](#fetchstate)\<`T`\>
-
-##### Returns
-
-[`FetchState`](#fetchstate)\<`T`\>
-
-#### Example
-
-```ts
-const value = attempt(isString, "Not a String")(3);
-const mappedValue = mapFailed<string>(state => state.error.includes("404") ? fail("Not Found") : state)(value)
-if(isSuccess(mappedValue)){
- console.log(mappedValue.data)
-} else if (isFailed(mappedValue)){
- console.error(mappedValue.error)
-}
-```
-
-***
-
-### none()
-
-> **none**(): [`None`](#none)
-
-Defined in: [fetch-state/index.ts:84](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/fetch-state/index.ts#L84)
-
-Creates a fetch state of type None
-
-#### Returns
-
-[`None`](#none)