@koordinates/xstate-tree 1.0.0-beta.1 → 1.0.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,7 @@
1
- var SlotType;
1
+ /**
2
+ * @public
3
+ */
4
+ export var SlotType;
2
5
  (function (SlotType) {
3
6
  SlotType[SlotType["SingleSlot"] = 0] = "SingleSlot";
4
7
  SlotType[SlotType["MultiSlot"] = 1] = "MultiSlot";
@@ -216,7 +216,7 @@ declare type Events = any;
216
216
  export declare const genericSlotsTestingDummy: any;
217
217
 
218
218
  /**
219
- * @internal
219
+ * @public
220
220
  */
221
221
  export declare type GetSlotNames<TSlots extends readonly Slot[]> = TSlots[number]["name"];
222
222
 
@@ -296,11 +296,17 @@ declare type MakeEmptyObjectPropertiesOptional<T> = Omit<T, EmptyKeys<T>> & Part
296
296
  */
297
297
  export declare function matchRoute<TRoutes extends Route<any, any, any, any>[]>(routes: TRoutes, basePath: string, path: string, search: string): Return;
298
298
 
299
- declare type Meta<T> = T extends {
299
+ /**
300
+ * @public
301
+ */
302
+ export declare type Meta<T> = T extends {
300
303
  meta: infer TMeta;
301
304
  } ? TMeta : undefined;
302
305
 
303
- declare type MultiSlot<T> = {
306
+ /**
307
+ * @public
308
+ */
309
+ export declare type MultiSlot<T> = {
304
310
  type: SlotType.MultiSlot;
305
311
  name: T;
306
312
  getId(id: string): string;
@@ -320,7 +326,10 @@ declare type OmitOptional<T> = {
320
326
  */
321
327
  export declare function onBroadcast(handler: (event: GlobalEvents) => void): () => void;
322
328
 
323
- declare type Options<TParamsSchema extends Z.ZodObject<any>, TQuerySchema extends Z.ZodObject<any>, TMetaSchema> = {
329
+ /**
330
+ * @public
331
+ */
332
+ export declare type Options<TParamsSchema extends Z.ZodObject<any>, TQuerySchema extends Z.ZodObject<any>, TMetaSchema> = {
324
333
  params?: TParamsSchema;
325
334
  query?: TQuerySchema;
326
335
  meta?: TMetaSchema;
@@ -338,7 +347,10 @@ declare type Options_2<TContext> = {
338
347
  withContext?: () => Partial<TContext>;
339
348
  };
340
349
 
341
- declare type Params<T> = T extends {
350
+ /**
351
+ * @public
352
+ */
353
+ export declare type Params<T> = T extends {
342
354
  params: infer TParams;
343
355
  } ? TParams : undefined;
344
356
 
@@ -355,7 +367,10 @@ export declare type PickEvent<T extends Extract<GlobalEvents, {
355
367
 
356
368
  declare type PropsOf<C extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = JSX.LibraryManagedAttributes<C, ComponentPropsWithRef<C>>;
357
369
 
358
- declare type Query<T> = T extends {
370
+ /**
371
+ * @public
372
+ */
373
+ export declare type Query<T> = T extends {
359
374
  query: infer TQuery;
360
375
  } ? TQuery : undefined;
361
376
 
@@ -421,9 +436,15 @@ export declare type Route<TParams, TQuery, TEvent, TMeta> = {
421
436
  querySchema?: Z.ZodObject<any>;
422
437
  };
423
438
 
424
- 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;
439
+ /**
440
+ * @public
441
+ */
442
+ 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;
425
443
 
426
- declare type RouteArguments<TParams, TQuery, TMeta> = TParams extends undefined ? TQuery extends undefined ? TMeta extends undefined ? {} : {
444
+ /**
445
+ * @public
446
+ */
447
+ export declare type RouteArguments<TParams, TQuery, TMeta> = TParams extends undefined ? TQuery extends undefined ? TMeta extends undefined ? {} : {
427
448
  meta?: TMeta;
428
449
  } : TMeta extends undefined ? {
429
450
  query: TQuery;
@@ -447,7 +468,7 @@ declare type RouteArguments<TParams, TQuery, TMeta> = TParams extends undefined
447
468
  /**
448
469
  * @public
449
470
  */
450
- declare type RouteMeta<T> = T extends Route<any, any, any, infer TMeta> ? TMeta : undefined;
471
+ export declare type RouteMeta<T> = T extends Route<any, any, any, infer TMeta> ? TMeta : undefined;
451
472
 
452
473
  /**
453
474
  * @public
@@ -478,7 +499,10 @@ export declare type RoutingEvent<T> = T extends Route<infer TParams, infer TQuer
478
499
 
479
500
  declare type Selectors<TContext, TEvent extends EventObject, TSelectors, TStates> = (ctx: TContext, canHandleEvent: (e: TEvent) => boolean, inState: (state: TStates) => boolean, __currentState: TStates) => TSelectors;
480
501
 
481
- declare type SharedMeta = {
502
+ /**
503
+ * @public
504
+ */
505
+ export declare type SharedMeta = {
482
506
  /**
483
507
  * Suppresses this routing change event from being picked up by react-router
484
508
  */
@@ -493,7 +517,10 @@ declare type SharedMeta = {
493
517
  replace?: boolean;
494
518
  };
495
519
 
496
- declare type SingleSlot<T> = {
520
+ /**
521
+ * @public
522
+ */
523
+ export declare type SingleSlot<T> = {
497
524
  type: SlotType.SingleSlot;
498
525
  name: T;
499
526
  getId(): string;
@@ -523,7 +550,10 @@ context: unknown;
523
550
  context: unknown;
524
551
  }, any, any, any>;
525
552
 
526
- declare enum SlotType {
553
+ /**
554
+ * @public
555
+ */
556
+ export declare enum SlotType {
527
557
  SingleSlot = 0,
528
558
  MultiSlot = 1
529
559
  }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@koordinates/xstate-tree",
3
3
  "main": "lib/index.js",
4
4
  "types": "lib/xstate-tree.d.ts",
5
- "version": "1.0.0-beta.1",
5
+ "version": "1.0.0-beta.3",
6
6
  "dependencies": {
7
7
  "@xstate/react": "3.0.0",
8
8
  "fast-memoize": "2.5.2",