@koordinates/xstate-tree 1.0.0-beta.2 → 1.0.0-beta.4

package/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2022 Koordinates
+
+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/lib/routing/Link.js

@@ -13,7 +13,8 @@ export function Link({ to, children, testId, ...rest }) {
     const { params, query, meta, ...props } = rest;
     const href = useHref(to, params, query);
     return (React.createElement("a", { ...props, href: href, "data-testid": testId, onClick: (e) => {
-            if (props.onClick?.(e) === false) {
+            var _a;
+            if (((_a = props.onClick) === null || _a === void 0 ? void 0 : _a.call(props, e)) === false) {
                 return;
             }
             // Holding the Command key on Mac or the Control Key on Windows while clicking the link will open a new tab/window

package/lib/routing/createRoute/createRoute.js

@@ -7,7 +7,7 @@ import { joinRoutes } from "../joinRoutes";
  */
 export function buildCreateRoute(history, basePath) {
     function navigate({ history, url, meta, }) {
-        const method = meta?.replace ? history.replace : history.push;
+        const method = (meta === null || meta === void 0 ? void 0 : meta.replace) ? history.replace : history.push;
         method(url, {
             meta,
             previousUrl: window.location.pathname,
@@ -32,8 +32,8 @@ export function buildCreateRoute(history, basePath) {
         dynamicRoute: function createDynamicRoute(opts) {
             return ({ event, matches, reverse, }) => {
                 return {
-                    paramsSchema: opts?.params,
-                    querySchema: opts?.query,
+                    paramsSchema: opts === null || opts === void 0 ? void 0 : opts.params,
+                    querySchema: opts === null || opts === void 0 ? void 0 : opts.query,
                     event,
                     history,
                     basePath,
@@ -49,10 +49,10 @@ export function buildCreateRoute(history, basePath) {
                         if (match === false) {
                             return undefined;
                         }
-                        if (opts?.params && "params" in match) {
+                        if ((opts === null || opts === void 0 ? void 0 : opts.params) && "params" in match) {
                             opts.params.parse(match.params);
                         }
-                        if (opts?.query && "query" in match) {
+                        if ((opts === null || opts === void 0 ? void 0 : opts.query) && "query" in match) {
                             opts.query.parse(match.query);
                         }
                         return { type: event, originalUrl: `${url}${search}`, ...match };
@@ -107,16 +107,16 @@ export function buildCreateRoute(history, basePath) {
                     : urlWithTrailingSlash;
                 const matcher = match(fullUrl, {});
                 const reverser = compile(fullUrl);
-                const paramsSchema = baseRoute?.paramsSchema
-                    ? opts?.params
+                const paramsSchema = (baseRoute === null || baseRoute === void 0 ? void 0 : baseRoute.paramsSchema)
+                    ? (opts === null || opts === void 0 ? void 0 : opts.params)
                         ? baseRoute.paramsSchema.merge(opts.params)
                         : baseRoute.paramsSchema
-                    : opts?.params
+                    : (opts === null || opts === void 0 ? void 0 : opts.params)
                         ? opts.params
                         : undefined;
                 return {
                     paramsSchema,
-                    querySchema: opts?.query,
+                    querySchema: opts === null || opts === void 0 ? void 0 : opts.query,
                     event,
                     history,
                     basePath,
@@ -138,7 +138,7 @@ export function buildCreateRoute(history, basePath) {
                             paramsSchema.parse(params);
                         }
                         const query = parse(search);
-                        if (opts?.query) {
+                        if (opts === null || opts === void 0 ? void 0 : opts.query) {
                             opts.query.parse(query);
                         }
                         return {

package/lib/routing/handleLocationChange/handleLocationChange.js

@@ -20,13 +20,13 @@ export function handleLocationChange(routes, basePath, path, search, setActiveRo
     }
     else {
         const matchedEvent = match.event;
-        matchedEvent.meta = { ...(meta ?? {}) };
+        matchedEvent.meta = { ...(meta !== null && meta !== void 0 ? meta : {}) };
         matchedEvent.meta.indexEvent = true;
         const { params } = match.event;
         const routingEvents = [];
         let route = match.route;
         while (route.parent) {
-            routingEvents.push(route.parent.getEvent({ params, query: {}, meta: { ...(meta ?? {}) } }));
+            routingEvents.push(route.parent.getEvent({ params, query: {}, meta: { ...(meta !== null && meta !== void 0 ? meta : {}) } }));
             route = route.parent;
         }
         setActiveRouteEvents([...routingEvents, match.event]);

package/lib/routing/matchRoute/matchRoute.js

@@ -2,6 +2,7 @@
  * @public
  */
 export function matchRoute(routes, basePath, path, search) {
+    var _a;
     const realBase = basePath.endsWith("/") ? basePath.slice(0, -1) : basePath;
     const realPath = (() => {
         if (path.startsWith(realBase) && realBase.length > 0) {
@@ -9,7 +10,7 @@ export function matchRoute(routes, basePath, path, search) {
         }
         return path;
     })();
-    const [matchingRoute, event] = routes
+    const [matchingRoute, event] = (_a = routes
         .map((route) => {
         try {
             const match = route.matches(realPath, search);
@@ -24,7 +25,7 @@ export function matchRoute(routes, basePath, path, search) {
         }
         return [undefined, undefined];
     })
-        .find(([match]) => Boolean(match)) ?? [undefined, undefined];
+        .find(([match]) => Boolean(match))) !== null && _a !== void 0 ? _a : [undefined, undefined];
     if (matchingRoute === undefined) {
         return { type: "no-matches" };
     }

package/lib/routing/providers.js

@@ -12,7 +12,7 @@ export function useActiveRouteEvents() {
         const context = useRoutingContext();
         return context.activeRouteEvents;
     }
-    catch {
+    catch (_a) {
         return undefined;
     }
 }

package/lib/slots/slots.js

@@ -1,4 +1,7 @@
-var SlotType;
+/**
+ * @public
+ */
+export var SlotType;
 (function (SlotType) {
     SlotType[SlotType["SingleSlot"] = 0] = "SingleSlot";
     SlotType[SlotType["MultiSlot"] = 1] = "MultiSlot";

package/lib/testingUtilities.js

@@ -152,7 +152,10 @@ function difference(object, base) {
  *
  * I have no solutions for this
  */
-export function buildStorybookComponent(machine, state = machine.initial, context = machine.context ?? {}) {
+export function buildStorybookComponent(machine, state, context) {
+    var _a;
+    if (state === void 0) { state = machine.initial; }
+    if (context === void 0) { context = (_a = machine.context) !== null && _a !== void 0 ? _a : {}; }
     // `set` converts a state.like.this to a {state: { like: this {} } }
     const objectState = set({}, String(state), undefined);
     const startingState = new State({

package/lib/useService.js

@@ -46,18 +46,20 @@ export function useService(service) {
     }, [service, setChildren]);
     useEffect(() => {
         function handler(event) {
+            var _a, _b, _c;
             if (event.type.includes("done")) {
                 const idOfFinishedChild = event.type.split(".")[2];
                 childrenRef.current.delete(idOfFinishedChild);
                 setChildren(new Map(childrenRef.current));
             }
-            console.debug(`[xstate-tree] ${service.id} handling event`, service.machine.meta?.xstateTree?.ignoredEvents?.has(event.type)
+            console.debug(`[xstate-tree] ${service.id} handling event`, ((_c = (_b = (_a = service.machine.meta) === null || _a === void 0 ? void 0 : _a.xstateTree) === null || _b === void 0 ? void 0 : _b.ignoredEvents) === null || _c === void 0 ? void 0 : _c.has(event.type))
                 ? event.type
                 : event);
         }
         let prevState = undefined;
         function transitionHandler(state) {
-            const ignoreContext = service.machine.meta?.xstateTree?.ignoreContext;
+            var _a, _b;
+            const ignoreContext = (_b = (_a = service.machine.meta) === null || _a === void 0 ? void 0 : _a.xstateTree) === null || _b === void 0 ? void 0 : _b.ignoreContext;
             const context = ignoreContext
                 ? ignoreContext.length > 0
                     ? omit(state.context, ignoreContext)

package/lib/xstate-tree.d.ts

@@ -216,7 +216,7 @@ declare type Events = any;
 export declare const genericSlotsTestingDummy: any;
 
 /**
- * @internal
+ * @public
  */
 export declare type GetSlotNames<TSlots extends readonly Slot[]> = TSlots[number]["name"];
 
@@ -296,11 +296,17 @@ declare type MakeEmptyObjectPropertiesOptional<T> = Omit<T, EmptyKeys<T>> & Part
  */
 export declare function matchRoute<TRoutes extends Route<any, any, any, any>[]>(routes: TRoutes, basePath: string, path: string, search: string): Return;
 
-declare type Meta<T> = T extends {
+/**
+ * @public
+ */
+export declare type Meta<T> = T extends {
     meta: infer TMeta;
 } ? TMeta : undefined;
 
-declare type MultiSlot<T> = {
+/**
+ * @public
+ */
+export declare type MultiSlot<T> = {
     type: SlotType.MultiSlot;
     name: T;
     getId(id: string): string;
@@ -320,7 +326,10 @@ declare type OmitOptional<T> = {
  */
 export declare function onBroadcast(handler: (event: GlobalEvents) => void): () => void;
 
-declare type Options<TParamsSchema extends Z.ZodObject<any>, TQuerySchema extends Z.ZodObject<any>, TMetaSchema> = {
+/**
+ * @public
+ */
+export declare type Options<TParamsSchema extends Z.ZodObject<any>, TQuerySchema extends Z.ZodObject<any>, TMetaSchema> = {
     params?: TParamsSchema;
     query?: TQuerySchema;
     meta?: TMetaSchema;
@@ -338,7 +347,10 @@ declare type Options_2<TContext> = {
     withContext?: () => Partial<TContext>;
 };
 
-declare type Params<T> = T extends {
+/**
+ * @public
+ */
+export declare type Params<T> = T extends {
     params: infer TParams;
 } ? TParams : undefined;
 
@@ -355,7 +367,10 @@ export declare type PickEvent<T extends Extract<GlobalEvents, {
 
 declare type PropsOf<C extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = JSX.LibraryManagedAttributes<C, ComponentPropsWithRef<C>>;
 
-declare type Query<T> = T extends {
+/**
+ * @public
+ */
+export declare type Query<T> = T extends {
     query: infer TQuery;
 } ? TQuery : undefined;
 
@@ -421,7 +436,10 @@ export declare type Route<TParams, TQuery, TEvent, TMeta> = {
     querySchema?: Z.ZodObject<any>;
 };
 
-declare type RouteArgumentFunctions<TReturn, TParams, TQuery, TMeta, TArgs = RouteArguments<TParams, TQuery, TMeta>> = IsEmptyObject<TArgs> extends true ? () => TReturn : keyof TArgs extends "meta" ? (args?: TArgs) => TReturn : EmptyRouteArguments<TParams, TQuery> extends true ? (args?: Partial<TArgs>) => TReturn : (args: MakeEmptyObjectPropertiesOptional<TArgs>) => TReturn;
+/**
+ * @public
+ */
+export declare type RouteArgumentFunctions<TReturn, TParams, TQuery, TMeta, TArgs = RouteArguments<TParams, TQuery, TMeta>> = IsEmptyObject<TArgs> extends true ? () => TReturn : keyof TArgs extends "meta" ? (args?: TArgs) => TReturn : EmptyRouteArguments<TParams, TQuery> extends true ? (args?: Partial<TArgs>) => TReturn : (args: MakeEmptyObjectPropertiesOptional<TArgs>) => TReturn;
 
 /**
  * @public
@@ -481,7 +499,10 @@ export declare type RoutingEvent<T> = T extends Route<infer TParams, infer TQuer
 
 declare type Selectors<TContext, TEvent extends EventObject, TSelectors, TStates> = (ctx: TContext, canHandleEvent: (e: TEvent) => boolean, inState: (state: TStates) => boolean, __currentState: TStates) => TSelectors;
 
-declare type SharedMeta = {
+/**
+ * @public
+ */
+export declare type SharedMeta = {
     /**
      * Suppresses this routing change event from being picked up by react-router
      */
@@ -496,7 +517,10 @@ declare type SharedMeta = {
     replace?: boolean;
 };
 
-declare type SingleSlot<T> = {
+/**
+ * @public
+ */
+export declare type SingleSlot<T> = {
     type: SlotType.SingleSlot;
     name: T;
     getId(): string;
@@ -526,7 +550,10 @@ context: unknown;
     context: unknown;
 }, any, any, any>;
 
-declare enum SlotType {
+/**
+ * @public
+ */
+export declare enum SlotType {
     SingleSlot = 0,
     MultiSlot = 1
 }

package/lib/xstateTree.js

@@ -102,10 +102,12 @@ export function XstateTreeView({ interpreter }) {
     const { view: View, actions: actionsFactory, selectors: selectorsFactory, slots: interpreterSlots, } = interpreter.machine.meta;
     const slots = useSlots(interpreter, interpreterSlots.map((x) => x.name));
     const canHandleEvent = useCallback((e) => {
-        return interpreter.nextState(e).changed ?? false;
+        var _a;
+        return (_a = interpreter.nextState(e).changed) !== null && _a !== void 0 ? _a : false;
     }, [interpreter]);
     const inState = useCallback((state) => {
-        return currentRef.current?.matches(state) ?? false;
+        var _a, _b;
+        return (_b = (_a = currentRef.current) === null || _a === void 0 ? void 0 : _a.matches(state)) !== null && _b !== void 0 ? _b : false;
     }, 
     // This is needed because the inState function needs to be recreated if the
     // current state the machine is in changes. But _only_ then
@@ -171,7 +173,8 @@ export function buildRootComponent(machine, routing) {
         useEffect(() => {
             if (routing) {
                 const unsub = routing.history.listen((location) => {
-                    handleLocationChange(routing.routes, routing.basePath, location.pathname, location.search, setActiveRouteEvents, location.state?.meta);
+                    var _a;
+                    handleLocationChange(routing.routes, routing.basePath, location.pathname, location.search, setActiveRouteEvents, (_a = location.state) === null || _a === void 0 ? void 0 : _a.meta);
                 });
                 return () => {
                     unsub();

package/package.json

@@ -2,7 +2,7 @@
   "name": "@koordinates/xstate-tree",
   "main": "lib/index.js",
   "types": "lib/xstate-tree.d.ts",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.4",
   "dependencies": {
     "@xstate/react": "3.0.0",
     "fast-memoize": "2.5.2",