@rpcbase/router 0.108.0 → 0.109.0

package/dist/Link.d.ts

@@ -0,0 +1,12 @@
+import { LinkProps as RouterLinkProps } from 'react-router';
+import { RoutePrefetchBehavior } from './routePrefetch';
+type LinkProps = Omit<RouterLinkProps, "prefetch"> & {
+    prefetch?: RoutePrefetchBehavior;
+    prefetchData?: boolean;
+};
+export declare const Link: import('react').ForwardRefExoticComponent<Omit<RouterLinkProps, "prefetch"> & {
+    prefetch?: RoutePrefetchBehavior;
+    prefetchData?: boolean;
+} & import('react').RefAttributes<HTMLAnchorElement>>;
+export type { LinkProps };
+//# sourceMappingURL=Link.d.ts.map

package/dist/Link.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Link.d.ts","sourceRoot":"","sources":["../src/Link.tsx"],"names":[],"mappings":"AACA,OAAO,EAAsB,KAAK,SAAS,IAAI,eAAe,EAAE,MAAM,cAAc,CAAA;AAEpF,OAAO,EAAE,KAAK,qBAAqB,EAAoB,MAAM,iBAAiB,CAAA;AAK9E,KAAK,SAAS,GAAG,IAAI,CAAC,eAAe,EAAE,UAAU,CAAC,GAAG;IACnD,QAAQ,CAAC,EAAE,qBAAqB,CAAA;IAChC,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAgED,eAAO,MAAM,IAAI;eAlEJ,qBAAqB;mBACjB,OAAO;qDAgJvB,CAAA;AAID,YAAY,EAAE,SAAS,EAAE,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from 'react-router';
+export { Link } from './Link';
+export type { LinkProps } from './Link';
+export * from './lazyRoute';
+export * from './useApplyMeta';
+export * from './navigationGuards';
+export * from './routePrefetch';
+export * from './queryOverlay';
+export * from './shortcutPrefetchNavigate';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC7B,YAAY,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AACvC,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,oBAAoB,CAAA;AAClC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,4BAA4B,CAAA"}

package/dist/lazyRoute.d.ts

@@ -0,0 +1,23 @@
+import { LoaderFunction } from 'react-router';
+import { Loader } from '@rpcbase/client';
+import { RouteHandleObject } from './routePrefetchHandles';
+type RouteModule = {
+    default: React.ComponentType<unknown>;
+    loader?: Loader;
+};
+type RouteModuleImporter = () => Promise<RouteModule>;
+type RouteOptions = {
+    handle?: unknown;
+    prefetchData?: boolean;
+    prefetchDataKey?: string;
+};
+type LazyRouteResult = {
+    lazy: () => Promise<{
+        Component: React.ComponentType<unknown>;
+        loader?: LoaderFunction;
+    }>;
+    handle: RouteHandleObject;
+};
+export declare const lazyRoute: (importer: RouteModuleImporter, opts?: RouteOptions) => LazyRouteResult;
+export {};
+//# sourceMappingURL=lazyRoute.d.ts.map

package/dist/lazyRoute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lazyRoute.d.ts","sourceRoot":"","sources":["../src/lazyRoute.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAExC,OAAO,EAAoB,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAG5E,KAAK,WAAW,GAAG;IACjB,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,KAAK,mBAAmB,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,CAAA;AAErD,KAAK,YAAY,GAAG;IAClB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,KAAK,eAAe,GAAG;IACrB,IAAI,EAAE,MAAM,OAAO,CAAC;QAClB,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;QACvC,MAAM,CAAC,EAAE,cAAc,CAAA;KACxB,CAAC,CAAA;IACF,MAAM,EAAE,iBAAiB,CAAA;CAC1B,CAAA;AAiBD,eAAO,MAAM,SAAS,GAAI,UAAU,mBAAmB,EAAE,OAAO,YAAY,KAAG,eAyB9E,CAAA"}

package/dist/navigationGuards.d.ts

@@ -0,0 +1,18 @@
+import { BlockerFunction } from 'react-router';
+export type NavigationGuard = {
+    id: string;
+    enabled: boolean;
+    priority?: number;
+    message: string;
+    blockOnSearch?: boolean;
+    shouldBlockNavigation: BlockerFunction;
+    shouldBlockUnload: boolean;
+};
+type NavigationGuardsListener = () => void;
+export declare const upsertNavigationGuard: (guard: NavigationGuard) => void;
+export declare const removeNavigationGuard: (id: string) => void;
+export declare const getNavigationGuards: () => NavigationGuard[];
+export declare const subscribeNavigationGuards: (listener: NavigationGuardsListener) => (() => void);
+export declare const useRegisterNavigationGuard: (guard: NavigationGuard) => void;
+export {};
+//# sourceMappingURL=navigationGuards.d.ts.map

package/dist/navigationGuards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigationGuards.d.ts","sourceRoot":"","sources":["../src/navigationGuards.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAGnD,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,qBAAqB,EAAE,eAAe,CAAA;IACtC,iBAAiB,EAAE,OAAO,CAAA;CAC3B,CAAA;AAED,KAAK,wBAAwB,GAAG,MAAM,IAAI,CAAA;AA2C1C,eAAO,MAAM,qBAAqB,GAAI,OAAO,eAAe,KAAG,IAS9D,CAAA;AAED,eAAO,MAAM,qBAAqB,GAAI,IAAI,MAAM,KAAG,IAMlD,CAAA;AAED,eAAO,MAAM,mBAAmB,QAAO,eAAe,EACE,CAAA;AAExD,eAAO,MAAM,yBAAyB,GACpC,UAAU,wBAAwB,KACjC,CAAC,MAAM,IAAI,CAMb,CAAA;AAED,eAAO,MAAM,0BAA0B,GAAI,OAAO,eAAe,KAAG,IA+BnE,CAAA"}

package/dist/queryOverlay.d.ts

@@ -0,0 +1,13 @@
+export type UseQueryOverlayOptions<TOverlay extends string> = {
+    param: string;
+    parse: (value: string | null) => TOverlay | null;
+};
+export type QueryOverlayApi<TOverlay extends string> = {
+    value: TOverlay | null;
+    isOpen: boolean;
+    buildHref: (nextValue: TOverlay | null) => string;
+    openOverlay: (nextValue: TOverlay) => void;
+    closeOverlay: () => void;
+};
+export declare const useQueryOverlay: <TOverlay extends string>({ param, parse, }: UseQueryOverlayOptions<TOverlay>) => QueryOverlayApi<TOverlay>;
+//# sourceMappingURL=queryOverlay.d.ts.map

package/dist/queryOverlay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryOverlay.d.ts","sourceRoot":"","sources":["../src/queryOverlay.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,sBAAsB,CAAC,QAAQ,SAAS,MAAM,IAAI;IAC5D,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,QAAQ,GAAG,IAAI,CAAA;CACjD,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,QAAQ,SAAS,MAAM,IAAI;IACrD,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;IACtB,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,CAAC,SAAS,EAAE,QAAQ,GAAG,IAAI,KAAK,MAAM,CAAA;IACjD,WAAW,EAAE,CAAC,SAAS,EAAE,QAAQ,KAAK,IAAI,CAAA;IAC1C,YAAY,EAAE,MAAM,IAAI,CAAA;CACzB,CAAA;AAED,eAAO,MAAM,eAAe,GAAI,QAAQ,SAAS,MAAM,EAAE,mBAGtD,sBAAsB,CAAC,QAAQ,CAAC,KAAG,eAAe,CAAC,QAAQ,CAgC7D,CAAA"}

package/dist/routePrefetch.d.ts

@@ -0,0 +1,22 @@
+import { ReactNode } from 'react';
+export type RoutePrefetchBehavior = "intent" | "render" | "none" | "viewport";
+export type RoutePrefetchCallOptions = {
+    prefetchCode?: boolean;
+    prefetchData?: boolean;
+};
+export type RoutePrefetchApi = {
+    defaultPrefetch: RoutePrefetchBehavior;
+    prefetch: (href: string, opts?: RoutePrefetchCallOptions) => Promise<void>;
+    prefetchCode: (href: string) => Promise<void>;
+    prefetchData: (href: string) => Promise<void>;
+};
+type RoutePrefetchProviderProps = {
+    children: ReactNode;
+    defaultPrefetch?: RoutePrefetchBehavior;
+    dataPrefetchTtlMs?: number;
+    dataPrefetchHandleKey?: string;
+};
+export declare const RoutePrefetchProvider: ({ children, defaultPrefetch, dataPrefetchTtlMs, dataPrefetchHandleKey, }: RoutePrefetchProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useRoutePrefetch: () => RoutePrefetchApi;
+export type { RoutePrefetchProviderProps };
+//# sourceMappingURL=routePrefetch.d.ts.map

package/dist/routePrefetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routePrefetch.d.ts","sourceRoot":"","sources":["../src/routePrefetch.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAqC,MAAM,OAAO,CAAA;AAepE,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAA;AAE7E,MAAM,MAAM,wBAAwB,GAAG;IACrC,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,eAAe,EAAE,qBAAqB,CAAA;IACtC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,wBAAwB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1E,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7C,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAC9C,CAAA;AASD,KAAK,0BAA0B,GAAG;IAChC,QAAQ,EAAE,SAAS,CAAA;IACnB,eAAe,CAAC,EAAE,qBAAqB,CAAA;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B,CAAA;AA4DD,eAAO,MAAM,qBAAqB,GAAI,0EAKnC,0BAA0B,4CAsJ5B,CAAA;AAED,eAAO,MAAM,gBAAgB,QAAO,gBAAoD,CAAA;AAExF,YAAY,EAAE,0BAA0B,EAAE,CAAA"}

package/dist/routePrefetchHandles.d.ts

@@ -0,0 +1,13 @@
+export declare const ROUTE_MODULE_IMPORTER_HANDLE = "__rpcbaseRouteModuleImporter";
+export declare const ROUTE_PREFETCH_DATA_HANDLE = "prefetchData";
+export type RouteHandleObject = Record<string, unknown>;
+type RouteModuleImporter = () => Promise<unknown>;
+export declare const getRouteModuleImporterFromHandle: (handle: unknown) => RouteModuleImporter | null;
+export declare const getRoutePrefetchDataFromHandle: (handle: unknown, key?: string) => boolean | undefined;
+export declare const mergeRouteHandle: (handle: unknown, { importer, prefetchData, prefetchDataKey, }: {
+    importer?: RouteModuleImporter;
+    prefetchData?: boolean;
+    prefetchDataKey?: string;
+}) => RouteHandleObject;
+export {};
+//# sourceMappingURL=routePrefetchHandles.d.ts.map

package/dist/routePrefetchHandles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routePrefetchHandles.d.ts","sourceRoot":"","sources":["../src/routePrefetchHandles.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,4BAA4B,iCAAiC,CAAA;AAC1E,eAAO,MAAM,0BAA0B,iBAAiB,CAAA;AAExD,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEvD,KAAK,mBAAmB,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;AAKjD,eAAO,MAAM,gCAAgC,GAAI,QAAQ,OAAO,KAAG,mBAAmB,GAAG,IAKxF,CAAA;AAED,eAAO,MAAM,8BAA8B,GACzC,QAAQ,OAAO,EACf,YAAgC,KAC/B,OAAO,GAAG,SAKZ,CAAA;AAED,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,OAAO,EACf,8CAIG;IACD,QAAQ,CAAC,EAAE,mBAAmB,CAAA;IAC9B,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,KACA,iBAYF,CAAA"}

package/dist/shortcutPrefetchNavigate.d.ts

@@ -0,0 +1,22 @@
+export type KeyboardShortcut = {
+    key: string;
+    mod?: boolean;
+    ctrl?: boolean;
+    meta?: boolean;
+    alt?: boolean;
+    shift?: boolean;
+};
+export type ShortcutTrigger = "keydown" | "keyup";
+export type UseShortcutPrefetchNavigateOptions = {
+    shortcut: KeyboardShortcut;
+    getHref: () => string;
+    prefetch?: (href: string) => Promise<void> | void;
+    navigate?: (href: string) => Promise<void> | void;
+    trigger?: ShortcutTrigger;
+    enabled?: boolean;
+    preventDefault?: boolean;
+    ignoreTypingTarget?: boolean;
+    isTypingTarget?: (target: EventTarget | null) => boolean;
+};
+export declare const useShortcutPrefetchNavigate: ({ shortcut, getHref, prefetch, navigate, trigger, enabled, preventDefault, ignoreTypingTarget, isTypingTarget, }: UseShortcutPrefetchNavigateOptions) => void;
+//# sourceMappingURL=shortcutPrefetchNavigate.d.ts.map

package/dist/shortcutPrefetchNavigate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shortcutPrefetchNavigate.d.ts","sourceRoot":"","sources":["../src/shortcutPrefetchNavigate.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,OAAO,CAAA;AAEjD,MAAM,MAAM,kCAAkC,GAAG;IAC/C,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,OAAO,EAAE,MAAM,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACjD,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACjD,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,KAAK,OAAO,CAAA;CACzD,CAAA;AAoCD,eAAO,MAAM,2BAA2B,GAAI,kHAUzC,kCAAkC,KAAG,IAwFvC,CAAA"}

package/dist/useApplyMeta.d.ts

@@ -0,0 +1,13 @@
+type MetaAttributeValue = string | number | boolean | undefined;
+type MetaEntry = Record<string, MetaAttributeValue>;
+type PageMeta = {
+    title: string;
+    meta: MetaEntry[];
+};
+export declare const useApplyMeta: ({ defaultTitle, defaultMeta, pagesMeta }?: {
+    defaultTitle?: string;
+    defaultMeta?: MetaEntry[];
+    pagesMeta?: Record<string, PageMeta>;
+}) => void;
+export {};
+//# sourceMappingURL=useApplyMeta.d.ts.map

package/dist/useApplyMeta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useApplyMeta.d.ts","sourceRoot":"","sources":["../src/useApplyMeta.tsx"],"names":[],"mappings":"AAIA,KAAK,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAA;AAC/D,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;AAEnD,KAAK,QAAQ,GAAG;IACd,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,SAAS,EAAE,CAAA;CAClB,CAAA;AAGD,eAAO,MAAM,YAAY,GAAI,2CAI1B;IACD,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,WAAW,CAAC,EAAE,SAAS,EAAE,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;CAChC,SAiDL,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rpcbase/router",
-  "version": "0.108.0",
+  "version": "0.109.0",
   "type": "module",
   "files": [
     "dist"