Some checks failed
CI / go (push) Waiting to run
CI / docker (push) Waiting to run
CI / lint-go (push) Waiting to run
CI / lint-docs (push) Waiting to run
CI / check-paperclip (push) Waiting to run
Deploy static site / Deploy to GitHub Pages (push) Has been cancelled
Deploy static site / Deploy via Docker to hatch.surf (push) Has been cancelled
Resolved conflicts by taking GitHub versions for: - .dockerignore, .gitignore, Dockerfile, README.md, docker-compose.yml Kept deploy.sh updated to: - Pull from GitHub (primary source) - Push to Gitea (push-mirror) - Build from site/ directory (GitHub structure) Co-Authored-By: Paperclip <noreply@paperclip.ing>
51 lines
2.3 KiB
TypeScript
51 lines
2.3 KiB
TypeScript
import type { FallbackRouteParam } from '../../build/static-paths/types';
|
|
import type { DynamicParamTypesShort } from '../../shared/lib/app-router-types';
|
|
import type AppPageRouteModule from '../route-modules/app-page/module';
|
|
export type OpaqueFallbackRouteParamValue = [
|
|
/**
|
|
* The search value of the fallback route param. This is the opaque key
|
|
* that will be used to replace the dynamic param in the postponed state.
|
|
*/
|
|
searchValue: string,
|
|
/**
|
|
* The dynamic param type of the fallback route param. This is the type of
|
|
* the dynamic param that will be used to replace the dynamic param in the
|
|
* postponed state.
|
|
*/
|
|
dynamicParamType: DynamicParamTypesShort
|
|
];
|
|
/**
|
|
* An opaque fallback route params object. This is used to store the fallback
|
|
* route params in a way that is not easily accessible to the client.
|
|
*/
|
|
export type OpaqueFallbackRouteParams = ReadonlyMap<string, OpaqueFallbackRouteParamValue>;
|
|
/**
|
|
* The entries of the opaque fallback route params object.
|
|
*
|
|
* @param key the key of the fallback route param
|
|
* @param value the value of the fallback route param
|
|
*/
|
|
export type OpaqueFallbackRouteParamEntries = ReturnType<OpaqueFallbackRouteParams['entries']> extends MapIterator<[
|
|
infer K,
|
|
infer V
|
|
]> ? ReadonlyArray<[K, V]> : never;
|
|
/**
|
|
* Creates an opaque fallback route params object from the fallback route params.
|
|
*
|
|
* @param fallbackRouteParams the fallback route params
|
|
* @returns the opaque fallback route params
|
|
*/
|
|
export declare function createOpaqueFallbackRouteParams(fallbackRouteParams: readonly FallbackRouteParam[]): OpaqueFallbackRouteParams | null;
|
|
export declare function buildDynamicSegmentPlaceholder(param: Pick<FallbackRouteParam, 'paramName' | 'paramType'>): string;
|
|
export declare function getPlaceholderFallbackRouteParams(params: Record<string, undefined | string | string[]> | undefined, fallbackRouteParams: readonly FallbackRouteParam[]): FallbackRouteParam[];
|
|
/**
|
|
* Gets the fallback route params for a given page. This is an expensive
|
|
* operation because it requires parsing the loader tree to extract the fallback
|
|
* route params.
|
|
*
|
|
* @param page the page
|
|
* @param routeModule the route module
|
|
* @returns the opaque fallback route params
|
|
*/
|
|
export declare function getFallbackRouteParams(page: string, routeModule: AppPageRouteModule): OpaqueFallbackRouteParams | null;
|