@turnipxenon/pineapple 4.5.1 → 5.0.0-alpha.1

package/dist/external/paraglide/runtime.d.ts

@@ -34,12 +34,14 @@ export function assertIsLocale(input: any): Locale;
 /**
  * Extracts a cookie from the document.
  *
- * Will return undefined if the docuement is not available or if the cookie is not set.
+ * Will return undefined if the document is not available or if the cookie is not set.
  * The `document` object is not available in server-side rendering, so this function should not be called in that context.
  *
  * @returns {string | undefined}
  */
 export function extractLocaleFromCookie(): string | undefined;
+export function extractLocaleFromHeader(request: Request): Locale;
+export function extractLocaleFromNavigator(): Locale | undefined;
 /**
  * Extracts the locale from a given URL using native URLPattern.
  *
@@ -131,6 +133,59 @@ export function localizeUrl(url: string | URL, options?: {
  */
 export function deLocalizeUrl(url: string | URL): URL;
 export function aggregateGroups(match: any): Record<string, string | null | undefined>;
+/**
+ * @typedef {object} ShouldRedirectServerInput
+ * @property {Request} request
+ * @property {string | URL} [url]
+ * @property {ReturnType<typeof assertIsLocale>} [locale]
+ *
+ * @typedef {object} ShouldRedirectClientInput
+ * @property {undefined} [request]
+ * @property {string | URL} [url]
+ * @property {ReturnType<typeof assertIsLocale>} [locale]
+ *
+ * @typedef {ShouldRedirectServerInput | ShouldRedirectClientInput} ShouldRedirectInput
+ *
+ * @typedef {object} ShouldRedirectResult
+ * @property {boolean} shouldRedirect - Indicates whether the consumer should perform a redirect.
+ * @property {ReturnType<typeof assertIsLocale>} locale - Locale resolved using the configured strategies.
+ * @property {URL | undefined} redirectUrl - Destination URL when a redirect is required.
+ */
+/**
+ * Determines whether a redirect is required to align the current URL with the active locale.
+ *
+ * This helper mirrors the logic that powers `paraglideMiddleware`, but works in both server
+ * and client environments. It evaluates the configured strategies in order, computes the
+ * canonical localized URL, and reports when the current URL does not match.
+ *
+ * When called in the browser without arguments, the current `window.location.href` is used.
+ *
+ * @example
+ * // Client side usage (e.g. TanStack Router beforeLoad hook)
+ * async function beforeLoad({ location }) {
+ *   const decision = await shouldRedirect({ url: location.href });
+ *
+ *   if (decision.shouldRedirect) {
+ *     throw redirect({ to: decision.redirectUrl.href });
+ *   }
+ * }
+ *
+ * @example
+ * // Server side usage with a Request
+ * export async function handle(request) {
+ *   const decision = await shouldRedirect({ request });
+ *
+ *   if (decision.shouldRedirect) {
+ *     return Response.redirect(decision.redirectUrl, 307);
+ *   }
+ *
+ *   return render(request, decision.locale);
+ * }
+ *
+ * @param {ShouldRedirectInput} [input]
+ * @returns {Promise<ShouldRedirectResult>}
+ */
+export function shouldRedirect(input?: ShouldRedirectInput): Promise<ShouldRedirectResult>;
 /**
  * High-level URL localization function optimized for client-side UI usage.
  *
@@ -240,6 +295,32 @@ export function trackMessageCall(safeModuleId: string, locale: Locale): void;
  * @returns {URL[]} List of localized URLs as URL objects
  */
 export function generateStaticLocalizedUrls(urls: (string | URL)[]): URL[];
+/**
+ * Checks if the given strategy is a custom strategy.
+ *
+ * @param {any} strategy The name of the custom strategy to validate.
+ * Must be a string that starts with "custom-" followed by alphanumeric characters, hyphens, or underscores.
+ * @returns {boolean} Returns true if it is a custom strategy, false otherwise.
+ */
+export function isCustomStrategy(strategy: any): boolean;
+/**
+ * Defines a custom strategy that is executed on the server.
+ *
+ * @param {any} strategy The name of the custom strategy to define. Must follow the pattern custom-name with alphanumeric characters, hyphens, or underscores.
+ * @param {CustomServerStrategyHandler} handler The handler for the custom strategy, which should implement
+ * the method getLocale.
+ * @returns {void}
+ */
+export function defineCustomServerStrategy(strategy: any, handler: CustomServerStrategyHandler): void;
+/**
+ * Defines a custom strategy that is executed on the client.
+ *
+ * @param {any} strategy The name of the custom strategy to define. Must follow the pattern custom-name with alphanumeric characters, hyphens, or underscores.
+ * @param {CustomClientStrategyHandler} handler The handler for the custom strategy, which should implement the
+ * methods getLocale and setLocale.
+ * @returns {void}
+ */
+export function defineCustomClientStrategy(strategy: any, handler: CustomClientStrategyHandler): void;
 /**
  * The project's base locale.
  *
@@ -263,11 +344,13 @@ export const cookieName: string;
 /** @type {number} */
 export const cookieMaxAge: number;
 /** @type {string} */
+export const cookieDomain: string;
+/** @type {string} */
 export const localStorageKey: string;
 /**
- * @type {Array<"cookie" | "baseLocale" | "globalVariable" | "url" | "preferredLanguage" | "localStorage">}
+ * @type {Array<"cookie" | "baseLocale" | "globalVariable" | "url" | "preferredLanguage" | "localStorage" | `custom-${string}`>}
  */
-export const strategy: Array<"cookie" | "baseLocale" | "globalVariable" | "url" | "preferredLanguage" | "localStorage">;
+export const strategy: Array<"cookie" | "baseLocale" | "globalVariable" | "url" | "preferredLanguage" | "localStorage" | `custom-${string}`>;
 /**
  * The used URL patterns.
  *
@@ -329,6 +412,9 @@ export let getLocale: () => Locale;
  * @type {(fn: () => Locale) => void}
  */
 export const overwriteGetLocale: (fn: () => Locale) => void;
+/**
+ * @typedef {(newLocale: Locale, options?: { reload?: boolean }) => void | Promise<void>} SetLocaleFn
+ */
 /**
  * Set the locale.
  *
@@ -337,18 +423,19 @@ export const overwriteGetLocale: (fn: () => Locale) => void;
  * reloading is disabled, you need to ensure that the UI is updated
  * to reflect the new locale.
  *
+ * If any custom strategy's \`setLocale\` function is async, then this
+ * function will become async as well.
+ *
  * @example
  *   setLocale('en');
  *
  * @example
  *   setLocale('en', { reload: false });
  *
- * @type {(newLocale: Locale, options?: { reload?: boolean }) => void}
+ * @type {SetLocaleFn}
  */
-export let setLocale: (newLocale: Locale, options?: {
-    reload?: boolean;
-}) => void;
-export function overwriteSetLocale(fn: (newLocale: Locale) => void): void;
+export let setLocale: SetLocaleFn;
+export function overwriteSetLocale(fn: SetLocaleFn): void;
 /**
  * The origin of the current URL.
  *
@@ -378,12 +465,92 @@ export let overwriteGetUrlOrigin: (fn: () => string) => void;
  * they are defined. If a strategy returns an invalid locale,
  * it will fall back to the next strategy.
  *
+ * Note: Custom server strategies are not supported in this synchronous version.
+ * Use `extractLocaleFromRequestAsync` if you need custom server strategies with async getLocale methods.
+ *
  * @example
  *   const locale = extractLocaleFromRequest(request);
  *
  * @type {(request: Request) => Locale}
  */
 export const extractLocaleFromRequest: (request: Request) => Locale;
+/**
+ * Asynchronously extracts a locale from a request.
+ *
+ * This function supports async custom server strategies, unlike the synchronous
+ * `extractLocaleFromRequest`. Use this function when you have custom server strategies
+ * that need to perform asynchronous operations (like database calls) in their getLocale method.
+ *
+ * The function first processes any custom server strategies asynchronously, then falls back
+ * to the synchronous `extractLocaleFromRequest` for all other strategies.
+ *
+ * @see {@link https://github.com/opral/inlang-paraglide-js/issues/527#issuecomment-2978151022}
+ *
+ * @example
+ *   // Basic usage
+ *   const locale = await extractLocaleFromRequestAsync(request);
+ *
+ * @example
+ *   // With custom async server strategy
+ *   defineCustomServerStrategy("custom-database", {
+ *     getLocale: async (request) => {
+ *       const userId = extractUserIdFromRequest(request);
+ *       return await getUserLocaleFromDatabase(userId);
+ *     }
+ *   });
+ *
+ *   const locale = await extractLocaleFromRequestAsync(request);
+ *
+ * @type {(request: Request) => Promise<Locale>}
+ */
+export const extractLocaleFromRequestAsync: (request: Request) => Promise<Locale>;
+/**
+ * @typedef {"cookie" | "baseLocale" | "globalVariable" | "url" | "preferredLanguage" | "localStorage"} BuiltInStrategy
+ */
+/**
+ * @typedef {`custom_${string}`} CustomStrategy
+ */
+/**
+ * @typedef {BuiltInStrategy | CustomStrategy} Strategy
+ */
+/**
+ * @typedef {Array<Strategy>} Strategies
+ */
+/**
+ * @typedef {{ getLocale: (request?: Request) => Promise<string | undefined> | (string | undefined) }} CustomServerStrategyHandler
+ */
+/**
+ * @typedef {{ getLocale: () => Promise<string|undefined> | (string | undefined), setLocale: (locale: string) => Promise<void> | void }} CustomClientStrategyHandler
+ */
+/** @type {Map<string, CustomServerStrategyHandler>} */
+export const customServerStrategies: Map<string, CustomServerStrategyHandler>;
+/** @type {Map<string, CustomClientStrategyHandler>} */
+export const customClientStrategies: Map<string, CustomClientStrategyHandler>;
+export type ShouldRedirectServerInput = {
+    request: Request;
+    url?: string | URL | undefined;
+    locale?: "en" | "fr" | "tl" | undefined;
+};
+export type ShouldRedirectClientInput = {
+    request?: undefined;
+    url?: string | URL | undefined;
+    locale?: "en" | "fr" | "tl" | undefined;
+};
+export type ShouldRedirectInput = ShouldRedirectServerInput | ShouldRedirectClientInput;
+export type ShouldRedirectResult = {
+    /**
+     * - Indicates whether the consumer should perform a redirect.
+     */
+    shouldRedirect: boolean;
+    /**
+     * - Locale resolved using the configured strategies.
+     */
+    locale: ReturnType<typeof assertIsLocale>;
+    /**
+     * - Destination URL when a redirect is required.
+     */
+    redirectUrl: URL | undefined;
+};
 export type ParaglideAsyncLocalStorage = {
     getStore(): {
         locale?: Locale;
@@ -396,7 +563,22 @@ export type ParaglideAsyncLocalStorage = {
         messageCalls?: Set<string>;
     }, cb: any) => any;
 };
+export type SetLocaleFn = (newLocale: Locale, options?: {
+    reload?: boolean;
+}) => void | Promise<void>;
+export type BuiltInStrategy = "cookie" | "baseLocale" | "globalVariable" | "url" | "preferredLanguage" | "localStorage";
+export type CustomStrategy = `custom_${string}`;
+export type Strategy = BuiltInStrategy | CustomStrategy;
+export type Strategies = Array<Strategy>;
+export type CustomServerStrategyHandler = {
+    getLocale: (request?: Request) => Promise<string | undefined> | (string | undefined);
+};
+export type CustomClientStrategyHandler = {
+    getLocale: () => Promise<string | undefined> | (string | undefined);
+    setLocale: (locale: string) => Promise<void> | void;
+};
 /**
  * A locale that is available in the project.
  */
 export type Locale = (typeof locales)[number];
+//# sourceMappingURL=runtime.d.ts.map

package/dist/external/paraglide/runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../../src/lib/external/paraglide/runtime.js"],"names":[],"mappings":"AAsFA;;;;;;;;;GASG;AACH,wDAFW,0BAA0B,GAAG,SAAS,QAIhD;AA0SD;;;;;;;;;;;;GAYG;AACH,iCAHW,GAAG,GACD,MAAM,IAAI,MAAM,CAI5B;AAED;;;;;;GAMG;AACH,sCAJW,GAAG,GACD,MAAM,CAQlB;AAmHD;;;;;;;GAOG;AACH,2CAFa,MAAM,GAAG,SAAS,CAY9B;AAWS,iDAAU,OAAO,GAAK,MAAM,CAAA;AA2C5B,8CAAM,MAAM,GAAG,SAAS,CAAA;AAgClC;;;;;GAKG;AACH,0CAHW,GAAG,GAAC,MAAM,GACR,MAAM,GAAC,SAAS,CAiC5B;AAoBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,iCALW,MAAM,GAAG,GAAG,YAEpB;IAAyB,MAAM;CAC/B,GAAU,GAAG,CAkCf;AAgCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,mCAHW,MAAM,GAAG,GAAG,GACV,GAAG,CA4Bf;AA2HS,uCAAQ,GAAG,GAAK,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,CAAA;AAenE;;;;;;;;;;;;;;;;;GAiBG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,uCAHW,mBAAmB,GACjB,OAAO,CAAC,oBAAoB,CAAC,CAezC;AAiDD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,mCALW,MAAM,YAEd;IAAyB,MAAM;CAC/B,GAAU,MAAM,CAsBlB;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,qCAJW,MAAM,GACJ,MAAM,CAYlB;AAED;;;GAGG;AACH,+CAHW,MAAM,UACN,MAAM,QAShB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,kDAHW,CAAC,MAAM,GAAG,GAAG,CAAC,EAAE,GACd,GAAG,EAAE,CAoEjB;AAwBD;;;;;;GAMG;AACH,2CAJW,GAAG,GAED,OAAO,CAInB;AACD;;;;;;;GAOG;AACH,qDALW,GAAG,WACH,2BAA2B,GAEzB,IAAI,CAOhB;AACD;;;;;;;GAOG;AACH,qDALW,GAAG,WACH,2BAA2B,GAEzB,IAAI,CAOhB;AA52CD;;;;;;;GAOG;AACH,yBAA0B,IAAI,CAAC;AAC/B;;;;;;;GAOG;AACH,kDAAiE;AACjE,qBAAqB;AACrB,yBADW,MAAM,CAC4B;AAC7C,qBAAqB;AACrB,2BADW,MAAM,CACoB;AACrC,qBAAqB;AACrB,2BADW,MAAM,CACc;AAC/B,qBAAqB;AACrB,8BADW,MAAM,CACiC;AAClD;;GAEG;AACH,uBAFU,KAAK,CAAC,QAAQ,GAAG,YAAY,GAAG,gBAAgB,GAAG,KAAK,GAAG,mBAAmB,GAAG,cAAc,GAAG,UAAU,MAAM,EAAE,CAAC,CAM7H;AACF;;;;GAIG;AACH,0BAFU,KAAK,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CAAE,CAAC,CAoBtE;AACF;;;;;;;;;;GAUG;AACH;;;;;;;GAOG;AACH,oCAFU,0BAA0B,GAAG,SAAS,CAED;AAC/C,uCAAwC,KAAK,CAAC;AAC9C,oDAAqD,KAAK,CAAC;AAC3D,+BAA8E;AAkC9E;;;;;;;;;;;GAWG;AACH,sBAFU,MAAM,MAAM,CAkEpB;AACF;;;;;;;;;;;;;;GAcG;AACH,iCAFU,CAAC,EAAE,EAAE,MAAM,MAAM,KAAK,IAAI,CAIlC;AAkBF;;GAEG;AACH;;;;;;;;;;;;;;;;;;GAkBG;AACH,sBAFU,WAAW,CAgGnB;AAeK,uCAFI,WAAW,QAIrB;AAED;;;;;;;;GAQG;AACH,yBAFU,MAAM,MAAM,CAUpB;AACF;;;;;;;GAOG;AACH,kCAFU,CAAC,EAAE,EAAE,MAAM,MAAM,KAAK,IAAI,CAIlC;AAiCF;;;;;;;;;;;;;;;;;GAiBG;AACH,uCAFU,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,CA4CpC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,4CAFU,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,CAAC,CAsB7C;AA4xBF;;GAEG;AACH;;GAEG;AACH;;GAEG;AACH;;GAEG;AACH;;GAEG;AACH;;GAEG;AACH,uDAAuD;AACvD,qCADW,GAAG,CAAC,MAAM,EAAE,2BAA2B,CAAC,CACH;AAChD,uDAAuD;AACvD,qCADW,GAAG,CAAC,MAAM,EAAE,2BAA2B,CAAC,CACH;;aAzVlC,OAAO;;;;;cAKP,SAAS;;;;kCAIV,yBAAyB,GAAG,yBAAyB;;;;;oBAGpD,OAAO;;;;YACP,UAAU,CAAC,OAAO,cAAc,CAAC;;;;iBACjC,GAAG,GAAG,SAAS;;yCAh8BhB;IACR,QAAQ,IAAI;QACV,MAAM,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;KACzB,GAAG,SAAS,CAAC;IACf,GAAG,EAAE,CAAC,KAAK,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;KAAC,EAC3E,EAAE,EAAE,GAAG,KAAK,GAAG,CAAA;CACjB;0BAgKS,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;8BA+kC3E,QAAQ,GAAG,YAAY,GAAG,gBAAgB,GAAG,KAAK,GAAG,mBAAmB,GAAG,cAAc;6BAGzF,UAAU,MAAM,EAAE;uBAGlB,eAAe,GAAG,cAAc;yBAGhC,KAAK,CAAC,QAAQ,CAAC;0CAGf;IAAE,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;CAAE;0CAGxF;IAAE,SAAS,EAAE,MAAM,OAAO,CAAC,MAAM,GAAC,SAAS,CAAC,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAAC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CAAE;;;;qBAqD1H,CAAC,OAAO,OAAO,EAAE,MAAM,CAAC"}