@benjavicente/angular-router-experimental 1.142.11

package/dist/types/tanstack-angular-router-experimental-experimental.d.ts

@@ -0,0 +1,110 @@
+import { AnyRouter } from '@benjavicente/router-core';
+import { FromPathOption } from '@benjavicente/router-core';
+import { RegisteredRouter } from '@benjavicente/router-core';
+
+/**
+ * EXPERIMENTAL
+ *
+ * While in other adapters you can use build-in error boundaries,
+ * Angular does not provide any. As an workarraound, we export a function
+ * to simulate an error boundary by changing the router state to show
+ * the error component.
+ *
+ * Note that an equivalent for suspense can't exist since we can't restore
+ * the component state when the promise is resolved as is with other adapters.
+ */
+export declare function injectRouteErrorHandler<TRouter extends AnyRouter = RegisteredRouter, TDefaultFrom extends string = string>(options: {
+    from?: FromPathOption<TRouter, TDefaultFrom>;
+}): {
+    throw: (error: Error) => void;
+};
+
+export { }
+
+
+declare module '@benjavicente/router-core' {
+    interface UpdatableRouteOptionsExtensions {
+        component?: RouteComponent;
+        errorComponent?: false | null | undefined | ErrorRouteComponent;
+        notFoundComponent?: NotFoundRouteComponent;
+        pendingComponent?: RouteComponent;
+    }
+    interface RootRouteOptionsExtensions {
+        shellComponent?: Angular.Type<{
+            children: any;
+        }>;
+    }
+    interface RouteExtensions<in out TId extends string, in out TFullPath extends string> {
+        injectMatch: InjectMatchRoute<TId>;
+        injectRouteContext: InjectRouteContextRoute<TId>;
+        injectSearch: InjectSearchRoute<TId>;
+        injectParams: InjectParamsRoute<TId>;
+        injectLoaderDeps: InjectLoaderDepsRoute<TId>;
+        injectLoaderData: InjectLoaderDataRoute<TId>;
+        injectNavigate: () => UseNavigateResult<TFullPath>;
+    }
+}
+
+
+declare module '@benjavicente/router-core' {
+    interface LazyRoute<in out TRoute extends AnyRoute> {
+        injectMatch: InjectMatchRoute<TRoute['id']>;
+        injectRouteContext: InjectRouteContextRoute<TRoute['id']>;
+        injectSearch: InjectSearchRoute<TRoute['id']>;
+        injectParams: InjectParamsRoute<TRoute['id']>;
+        injectLoaderDeps: InjectLoaderDepsRoute<TRoute['id']>;
+        injectLoaderData: InjectLoaderDataRoute<TRoute['id']>;
+        injectNavigate: () => UseNavigateResult<TRoute['fullPath']>;
+    }
+}
+
+
+declare module '@benjavicente/router-core' {
+    interface RouterOptionsExtensions {
+        /**
+         * The default `component` a route should use if no component is provided.
+         *
+         * @default Outlet
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/solid/api/router/RouterOptionsType#defaultcomponent-property)
+         */
+        defaultComponent?: RouteComponent;
+        /**
+         * The default `errorComponent` a route should use if no error component is provided.
+         *
+         * @default ErrorComponent
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/solid/api/router/RouterOptionsType#defaulterrorcomponent-property)
+         * @link [Guide](https://tanstack.com/router/latest/docs/framework/solid/guide/data-loading#handling-errors-with-routeoptionserrorcomponent)
+         */
+        defaultErrorComponent?: ErrorRouteComponent;
+        /**
+         * The default `pendingComponent` a route should use if no pending component is provided.
+         *
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/solid/api/router/RouterOptionsType#defaultpendingcomponent-property)
+         * @link [Guide](https://tanstack.com/router/latest/docs/framework/solid/guide/data-loading#showing-a-pending-component)
+         */
+        defaultPendingComponent?: RouteComponent;
+        /**
+         * The default `notFoundComponent` a route should use if no notFound component is provided.
+         *
+         * @default NotFound
+         * @link [API Docs](https://tanstack.com/router/latest/docs/framework/solid/api/router/RouterOptionsType#defaultnotfoundcomponent-property)
+         * @link [Guide](https://tanstack.com/router/latest/docs/framework/solid/guide/not-found-errors#default-router-wide-not-found-handling)
+         */
+        defaultNotFoundComponent?: RouteComponent;
+    }
+}
+
+
+declare module '@benjavicente/router-core' {
+    interface RouterStores<in out TRouteTree extends AnyRoute> {
+        childMatchIdByRouteId: RouterReadableStore<Record<string, string>>;
+        pendingRouteIds: RouterReadableStore<Record<string, boolean>>;
+    }
+}
+
+
+declare global {
+    interface Window {
+        __TSR_ROUTER_INJECTION_KEY__?: Angular.InjectionToken<AnyRouter>;
+    }
+}