@xmachines/play-xstate 3.0.0 → 5.0.0

package/dist/guards/helpers.d.ts

@@ -1,62 +0,0 @@
-import type { Guard } from "./types.js";
-import type { PlayEvent } from "@xmachines/play";
-/**
- * Tells you if the context holds a value at the path, and that the value is truthy
- *
- * @example
- * ```typescript
- * const machine = setup({
- *   guards: {
- *     hasUserId: hasContext('userId'),
- *     hasEmail: hasContext('user.email')
- *   }
- * });
- * ```
- *
- * @param path - The path to the context property, with a dot between two segments
- * @returns The guard predicate. It tests the property for a truthy value
- * @deprecated This function is part of the guard utilities, and the next major version removes
- * them. Write a plain typed predicate instead.
- */
-export declare const hasContext: <TContext = Record<string, unknown>>(path: string) => Guard<TContext, PlayEvent>;
-/**
- * Tells you if the type of the event is the expected type
- *
- * @example
- * ```typescript
- * const machine = setup({
- *   guards: {
- *     isSubmitEvent: eventMatches('submit'),
- *     isBackOrForward: composeGuardsOr([
- *       eventMatches('back'),
- *       eventMatches('forward')
- *     ])
- *   }
- * });
- * ```
- *
- * @param eventType - The expected event type
- * @returns The guard predicate. It tests the event type
- * @deprecated This function is part of the guard utilities, and the next major version removes
- * them. Write a plain typed predicate instead.
- */
-export declare const eventMatches: <TEvent extends PlayEvent = PlayEvent>(eventType: string) => Guard<unknown, TEvent>;
-/**
- * Tells you if a context field holds the expected value.
- *
- * - The function accepts an explicit field path, with a dot between two segments, for example `"user.role"`
- * - It compares a primitive with a strict equality, and an object with a deep structural equality
- * - The order of the keys has no effect on the comparison of an object: `{a:1,b:2}` equals `{b:2,a:1}`
- * - It supports a Date, a RegExp, an instance of a class, a nested object, and an array, through `dequal/lite`
- * - It does NOT match a substring: `"a"` does not match `"active"`
- *
- * For a match of an XState state node, use the built-in `in:` guard syntax instead.
- *
- * @param fieldPath - The path to the context property, with a dot between two segments, for example "status" or "user.role"
- * @param expectedValue - The value for the comparison: a string, an object, a Date, and so on
- * @returns The guard predicate. It tests the context field for the value
- * @deprecated This function is part of the guard utilities, and the next major version removes
- * them. Write a plain typed predicate instead.
- */
-export declare const contextFieldMatches: <TContext = Record<string, unknown>>(fieldPath: string, expectedValue: unknown) => Guard<TContext, PlayEvent>;
-//# sourceMappingURL=helpers.d.ts.map

package/dist/guards/helpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/guards/helpers.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,GACrB,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,MAAM,KAAG,KAAK,CAAC,QAAQ,EAAE,SAAS,CAI5E,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,YAAY,GACvB,MAAM,SAAS,SAAS,GAAG,SAAS,EAAE,WAAW,MAAM,KAAG,KAAK,CAAC,OAAO,EAAE,MAAM,CAG/E,CAAC;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,WAAW,MAAM,EACjB,eAAe,OAAO,KACpB,KAAK,CAAC,QAAQ,EAAE,SAAS,CAI3B,CAAC"}

package/dist/guards/helpers.js

@@ -1,85 +0,0 @@
-import { dequal } from "dequal/lite";
-/**
- * Tells you if the context holds a value at the path, and that the value is truthy
- *
- * @example
- * ```typescript
- * const machine = setup({
- *   guards: {
- *     hasUserId: hasContext('userId'),
- *     hasEmail: hasContext('user.email')
- *   }
- * });
- * ```
- *
- * @param path - The path to the context property, with a dot between two segments
- * @returns The guard predicate. It tests the property for a truthy value
- * @deprecated This function is part of the guard utilities, and the next major version removes
- * them. Write a plain typed predicate instead.
- */
-export const hasContext = (path) => ({ context }) => {
-    const value = getNestedValue(context, path);
-    return value !== undefined && value !== null && value !== "";
-};
-/**
- * Tells you if the type of the event is the expected type
- *
- * @example
- * ```typescript
- * const machine = setup({
- *   guards: {
- *     isSubmitEvent: eventMatches('submit'),
- *     isBackOrForward: composeGuardsOr([
- *       eventMatches('back'),
- *       eventMatches('forward')
- *     ])
- *   }
- * });
- * ```
- *
- * @param eventType - The expected event type
- * @returns The guard predicate. It tests the event type
- * @deprecated This function is part of the guard utilities, and the next major version removes
- * them. Write a plain typed predicate instead.
- */
-export const eventMatches = (eventType) => ({ event }) => {
-    return event.type === eventType;
-};
-/**
- * Tells you if a context field holds the expected value.
- *
- * - The function accepts an explicit field path, with a dot between two segments, for example `"user.role"`
- * - It compares a primitive with a strict equality, and an object with a deep structural equality
- * - The order of the keys has no effect on the comparison of an object: `{a:1,b:2}` equals `{b:2,a:1}`
- * - It supports a Date, a RegExp, an instance of a class, a nested object, and an array, through `dequal/lite`
- * - It does NOT match a substring: `"a"` does not match `"active"`
- *
- * For a match of an XState state node, use the built-in `in:` guard syntax instead.
- *
- * @param fieldPath - The path to the context property, with a dot between two segments, for example "status" or "user.role"
- * @param expectedValue - The value for the comparison: a string, an object, a Date, and so on
- * @returns The guard predicate. It tests the context field for the value
- * @deprecated This function is part of the guard utilities, and the next major version removes
- * them. Write a plain typed predicate instead.
- */
-export const contextFieldMatches = (fieldPath, expectedValue) => ({ context }) => {
-    const actual = getNestedValue(context, fieldPath);
-    return dequal(actual, expectedValue);
-};
-/**
- * Returns a nested value of an object, from a path with a dot between two segments
- *
- * @internal
- */
-const getNestedValue = (obj, path) => {
-    const keys = path.split(".");
-    let value = obj;
-    for (const key of keys) {
-        if (value === null || value === undefined || typeof value !== "object") {
-            return undefined;
-        }
-        value = value[key]; // nosemgrep: gitlab.eslint.detect-object-injection
-    }
-    return value;
-};
-//# sourceMappingURL=helpers.js.map

package/dist/guards/helpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/guards/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAIrC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,UAAU,GACtB,CAAqC,IAAY,EAA8B,EAAE,CACjF,CAAC,EAAE,OAAO,EAAyB,EAAE,EAAE;IACtC,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5C,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;AAC9D,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,YAAY,GACxB,CAAuC,SAAiB,EAA0B,EAAE,CACpF,CAAC,EAAE,KAAK,EAAqB,EAAE,EAAE;IAChC,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC;AACjC,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAC/B,CACC,SAAiB,EACjB,aAAsB,EACO,EAAE,CAChC,CAAC,EAAE,OAAO,EAAyB,EAAE,EAAE;IACtC,MAAM,MAAM,GAAG,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAClD,OAAO,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AACtC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,cAAc,GAAG,CAAC,GAAY,EAAE,IAAY,EAAW,EAAE;IAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,KAAK,GAAG,GAAG,CAAC;IAEhB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACxE,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,KAAK,GAAI,KAAiC,CAAC,GAAG,CAAC,CAAC,CAAC,mDAAmD;IACrG,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC,CAAC"}

package/dist/guards/index.d.ts

@@ -1,20 +0,0 @@
-/**
- * The guard composition utilities and the guard helpers of an XState machine
- *
- * The package gives you a composition where an array means AND. It also gives you
- * the helpers of the common guard patterns of the Play Architecture.
- *
- * @deprecated These guard helpers wrap the `and`, `or`, and `not` combinators of
- * XState, but they do not compose with a guard slot that `setup()` types. The
- * example of the package itself needs a cast for them. Use the combinators of XState
- * directly. The next major version removes this module. Each exported symbol carries
- * its own deprecation tag, because a consumer imports it through the root of the
- * package, and not through this barrel.
- *
- * @packageDocumentation
- */
-export { composeGuards, composeGuardsOr, negateGuard } from "./compose.js";
-export type { ComposedGuard } from "./compose.js";
-export { hasContext, eventMatches, contextFieldMatches } from "./helpers.js";
-export type { Guard, GuardArray } from "./types.js";
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/guards/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3E,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAC7E,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC"}

package/dist/guards/index.js

@@ -1,18 +0,0 @@
-/**
- * The guard composition utilities and the guard helpers of an XState machine
- *
- * The package gives you a composition where an array means AND. It also gives you
- * the helpers of the common guard patterns of the Play Architecture.
- *
- * @deprecated These guard helpers wrap the `and`, `or`, and `not` combinators of
- * XState, but they do not compose with a guard slot that `setup()` types. The
- * example of the package itself needs a cast for them. Use the combinators of XState
- * directly. The next major version removes this module. Each exported symbol carries
- * its own deprecation tag, because a consumer imports it through the root of the
- * package, and not through this barrel.
- *
- * @packageDocumentation
- */
-export { composeGuards, composeGuardsOr, negateGuard } from "./compose.js";
-export { hasContext, eventMatches, contextFieldMatches } from "./helpers.js";
-//# sourceMappingURL=index.js.map

package/dist/guards/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/guards/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3E,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC"}

package/dist/guards/types.d.ts

@@ -1,22 +0,0 @@
-import type { PlayEvent } from "@xmachines/play";
-/**
- * The standard signature of an XState guard function. A guard receives `{ context, event }`.
- *
- * @param args - The arguments of the guard: the context and the event
- * @param args.context - The current machine context
- * @param args.event - The event that started the evaluation of the guard
- * @returns The boolean value. It tells you if the guard passes
- * @deprecated The next major version removes the guard utilities.
- */
-export type Guard<TContext = Record<string, unknown>, TEvent = PlayEvent> = (args: {
-    context: TContext;
-    event: TEvent;
-}) => boolean;
-/**
- * The array of the guard predicates, or of the guard names. An array means AND:
- * every guard must pass.
- *
- * @deprecated The next major version removes the guard utilities.
- */
-export type GuardArray<TContext = Record<string, unknown>, TEvent = PlayEvent> = Array<Guard<TContext, TEvent> | string>;
-//# sourceMappingURL=types.d.ts.map

package/dist/guards/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/guards/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,MAAM,KAAK,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,IAAI,CAAC,IAAI,EAAE;IAClF,OAAO,EAAE,QAAQ,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACd,KAAK,OAAO,CAAC;AAEd;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,IAAI,KAAK,CACrF,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,MAAM,CAChC,CAAC"}

package/dist/guards/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/dist/guards/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/guards/types.ts"],"names":[],"mappings":""}