@kaumlaut/pure 0.2.1 → 0.2.2

package/dist/fetch-state/index.d.ts

@@ -0,0 +1,26 @@
+import type { Guard } from "@kaumlaut/pure/guard";
+export type Failed = {
+    error: Readonly<string>;
+    type: "Failed";
+};
+export type None = {
+    type: "None";
+};
+export type Loading = {
+    type: "Loading";
+};
+export type Success<T> = {
+    data: Readonly<T>;
+    type: "Success";
+};
+export type FetchState<T> = Failed | None | Loading | Success<T>;
+export declare function isLoading<T>(state: FetchState<T>): state is Loading;
+export declare function isFailed<T>(state: FetchState<T>): state is Failed;
+export declare function isNone<T>(state: FetchState<T>): state is None;
+export declare function isSuccess<T>(state: FetchState<T>): state is Success<T>;
+export declare function fail(error: string): Failed;
+export declare function load(): Loading;
+export declare function none(): None;
+export declare function attempt<T>(data: unknown, guard: Guard<T>, error?: string): Success<T> | Failed;
+export declare function mapFailed<T>(state: FetchState<T>, mapper: (state: Failed) => FetchState<T>): FetchState<T>;
+//# sourceMappingURL=index.d.ts.map

package/dist/fetch-state/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fetch-state/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAElD,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACxB,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;IACvB,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAEjE,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAEnE;AACD,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,MAAM,CAEjE;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,CAE7D;AACD,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC,CAEtE;AAED,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAK1C;AAED,wBAAgB,IAAI,IAAI,OAAO,CAI9B;AAED,wBAAgB,IAAI,IAAI,IAAI,CAI3B;AACD,wBAAgB,OAAO,CAAC,CAAC,EACvB,IAAI,EAAE,OAAO,EACb,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACf,KAAK,GAAE,MAA6E,GACnF,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAYrB;AAED,wBAAgB,SAAS,CAAC,CAAC,EACzB,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EACpB,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,GACvC,UAAU,CAAC,CAAC,CAAC,CAMf"}

package/dist/fetch-state/index.js

@@ -0,0 +1,46 @@
+export function isLoading(state) {
+    return state.type === "Loading";
+}
+export function isFailed(state) {
+    return state.type === "Failed";
+}
+export function isNone(state) {
+    return state.type === "None";
+}
+export function isSuccess(state) {
+    return state.type === "Success";
+}
+export function fail(error) {
+    return {
+        type: "Failed",
+        error,
+    };
+}
+export function load() {
+    return {
+        type: "Loading",
+    };
+}
+export function none() {
+    return {
+        type: "None",
+    };
+}
+export function attempt(data, guard, error = "Guard did not pass. Ensure the attempted data has the correct type") {
+    if (guard(data)) {
+        return {
+            type: "Success",
+            data,
+        };
+    }
+    return {
+        type: "Failed",
+        error,
+    };
+}
+export function mapFailed(state, mapper) {
+    if (isFailed(state)) {
+        return mapper(state);
+    }
+    return state;
+}

package/dist/guard/index.d.ts

@@ -13,8 +13,13 @@ export declare function isObjectWithKeysMatchingGuard<T extends object>(guards:
 export declare function isExactString<T extends string>(expectedString: string): (value: unknown) => value is T;
 export declare function isOneStringOf<T extends string>(validValues: string[]): (value: unknown) => value is T;
 export declare function always<T>(value: unknown): value is T;
+export declare function never<T>(value: unknown): value is T;
 export declare function isBool(value: unknown): value is boolean;
 export declare function isNull(value: unknown): value is null;
 export declare function isListOf<T>(guard: Guard<T>): (value: unknown) => value is T[];
 export declare function oneOf<T1, T2>(a: Guard<T1>, b: Guard<T2>): (value: unknown) => value is T1 | T2;
+export declare function isObjectWithAllKeysMatchingGuard<B, T extends {
+    [key: string]: B;
+}>(guard: Guard<B>): (value: unknown) => value is T;
+export declare function isStringWithPattern(pattern: RegExp): Guard<string>;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/guard/index.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC;AAEtD,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAEzE;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GACb,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,MAAM,CAGrC;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAMrD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAMvD;AAMD,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAC9C,GAAG,EAAE,MAAM,CAAC,GACX,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAC/C,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAChB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,6BAA6B,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE;KACrE,CAAC,IAAI,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5B,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAIjC;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAC5C,cAAc,EAAE,MAAM,GACrB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAC5C,WAAW,EAAE,MAAM,EAAE,GACpB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,CAAC,CAEpD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAEvD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAEpD;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,EAAE,CAG7E;AAED,wBAAgB,KAAK,CAAC,EAAE,EAAE,EAAE,EAC1B,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,EACZ,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,GACX,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,EAAE,GAAG,EAAE,CAEtC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/guard/index.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC;AAEtD,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAEzE;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GACb,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,MAAM,CAGrC;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAMrD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAMvD;AAMD,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAC9C,GAAG,EAAE,MAAM,CAAC,GACX,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAC/C,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAChB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,6BAA6B,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE;KACrE,CAAC,IAAI,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5B,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAYjC;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAC5C,cAAc,EAAE,MAAM,GACrB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAC5C,WAAW,EAAE,MAAM,EAAE,GACpB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,CAAC,CAEpD;AAED,wBAAgB,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,CAAC,CAEnD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAEvD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAEpD;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,EAAE,CAU7E;AAED,wBAAgB,KAAK,CAAC,EAAE,EAAE,EAAE,EAC1B,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,EACZ,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,GACX,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,EAAE,GAAG,EAAE,CAEtC;AAED,wBAAgB,gCAAgC,CAC9C,CAAC,EACD,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;CAAE,EAC9B,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAYjD;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAGlE"}

package/dist/guard/index.js

@@ -33,7 +33,13 @@ export function isObjectWithKeys(keys) {
 }
 export function isObjectWithKeysMatchingGuard(guards) {
     return (value) => typeof value === "object" &&
-        Object.keys(guards).every((key) => key in value && guards[key](value[key]));
+        Object.keys(guards).filter((key) => {
+            const result = key in value && guards[key](value[key]);
+            if (!result) {
+                console.debug(`Guard not matched for object. Value of key ${key} did not pass the guard.`);
+            }
+            return result;
+        }).length === Object.keys(guards).length;
 }
 export function isExactString(expectedString) {
     return (value) => isString(value) && value === expectedString;
@@ -44,6 +50,9 @@ export function isOneStringOf(validValues) {
 export function always(value) {
     return true;
 }
+export function never(value) {
+    return false;
+}
 export function isBool(value) {
     return typeof value === "boolean";
 }
@@ -51,8 +60,28 @@ export function isNull(value) {
     return value === null;
 }
 export function isListOf(guard) {
-    return (value) => Array.isArray(value) && value.every(guard);
+    return (value) => Array.isArray(value) &&
+        value.filter((item, index) => {
+            const result = guard(item);
+            if (!result) {
+                console.debug(`Guard not matched for item ${index} of list.`);
+            }
+            return result;
+        }).length === value.length;
 }
 export function oneOf(a, b) {
     return (value) => a(value) || b(value);
 }
+export function isObjectWithAllKeysMatchingGuard(guard) {
+    return (value) => typeof value === "object" &&
+        Object.keys(value).filter((key) => {
+            const result = key in value && guard(value[key]);
+            if (!result) {
+                console.debug(`Guard not matched for object. Value of key ${key} did not pass the guard.`);
+            }
+            return result;
+        }).length === Object.keys(value).length;
+}
+export function isStringWithPattern(pattern) {
+    return (value) => isString(value) && pattern.test(value);
+}

package/dist/runtime/persistence/localStorage/index.d.ts

@@ -0,0 +1,5 @@
+import { Persistence } from "@kaumlaut/pure/runtime/persistence";
+import { Message } from "@kaumlaut/pure/runtime";
+import { Cloneable } from "@kaumlaut/pure/clone";
+export declare const localStoragePersistence: <Model extends Cloneable, CustomMessage extends Message>(name: string) => Persistence<Model, CustomMessage>;
+//# sourceMappingURL=index.d.ts.map

package/dist/runtime/persistence/localStorage/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/runtime/persistence/localStorage/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAA;AAChE,OAAO,EAAE,OAAO,EAAQ,MAAM,wBAAwB,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAIhD,eAAO,MAAM,uBAAuB,GAAI,KAAK,SAAS,SAAS,EAAE,aAAa,SAAS,OAAO,EAC5F,MAAM,MAAM,KACX,WAAW,CAAC,KAAK,EAAE,aAAa,CAwBjC,CAAA"}

package/dist/runtime/persistence/localStorage/index.js

@@ -0,0 +1,25 @@
+import { ok, err } from "@kaumlaut/pure/result";
+import { just, nothing } from "@kaumlaut/pure/maybe";
+export const localStoragePersistence = (name) => ({
+    persist(model) {
+        window.localStorage.setItem(name, btoa(JSON.stringify(model)));
+    },
+    read(guard, init) {
+        const record = window.localStorage.getItem(name);
+        if (record === null) {
+            return ok(init(nothing())[0]);
+        }
+        try {
+            const json = atob(record);
+            const model = JSON.parse(json);
+            if (guard(model)) {
+                return ok(init(just(model))[0]);
+            }
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        }
+        catch (e) {
+            return err('Could not decode stored model');
+        }
+        return err('Your guard did not match the retrieved model');
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaumlaut/pure",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Types and functions for a state runtime inspired by Elm and functional programming",
   "author": "Max Kaemmerer",
   "license": "MIT",
@@ -37,4 +37,4 @@
     "typescript-eslint": "^8.26.1",
     "vitest": "^3.0.8"
   }
-}
+}