crelte 0.5.8 → 0.5.9

package/dist/ssr/SsrCache.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Calculates a key based on the json representation of the data
+ *
+ * If available hashes the data using SHA-1
+ */
 export declare function calcKey(data: any): Promise<string>;
 /**
  * A simple cache for server side rendering
@@ -9,9 +14,9 @@ export default class SsrCache {
     private store;
     constructor();
     /**
-     * check if the value is in the cache else calls the fn
+     * Check if a key exists in the cache
      */
-    load<T>(key: string, fn: () => Promise<T>): Promise<any>;
+    has(key: string): boolean;
     /**
      * Get a value from the cache
      */
@@ -20,10 +25,57 @@ export default class SsrCache {
      * Set a value in the cache
      */
     set<T>(key: string, val: T): T;
+    /**
+     * check if the value is in the cache else calls the fn
+     *
+     * See also {@link getOrInsertLoaded}
+     */
+    getOrInsertComputed<T>(key: string, fn: () => T): T;
+    /**
+     * check if the value is in the cache else calls the fn
+     *
+     * See also {@link getOrInsertComputed}
+     *
+     * @deprecated use {@link getOrInsertLoaded} instead
+     */
+    load<T>(key: string, fn: () => Promise<T>): Promise<T>;
+    /**
+     * check if the value is in the cache else calls the fn
+     *
+     * See also {@link getOrInsertComputed}
+     */
+    getOrInsertLoaded<T>(key: string, fn: () => Promise<T>): Promise<T>;
+    /**
+     * One-shot SSR handoff value.
+     *
+     * Intended use: call this once per request (per key) during SSR to generate
+     * a value that must match between server render and client hydration.
+     *
+     * On the server, the value is generated once per key and stored for hydration.
+     * Subsequent calls with the same key during SSR currently return the same value,
+     * but this behaviour is an implementation detail and may change in the future.
+     * Consumers should rely on calling this at most once per key during SSR.
+     *
+     * On the client, the stored value is returned exactly once and removed.
+     * Subsequent calls return a fresh value and are not cached.
+     *
+     * Warning: this function is designed to be called once per key during SSR.
+     * Calling it multiple times may lead to unexpected behaviour if the server-side
+     * implementation changes.
+     *
+     * See also {@link getOrInsertComputed}
+     */
+    takeOnce<T>(key: string, fn: () => T): T;
+    /**
+     * Remove a value from the cache and return it
+     */
+    remove<T>(key: string): T | null;
+    /** @hidden */
+    z_clear(): void;
     /** @hidden */
-    clear(): void;
+    z_importFromHead(): void;
     private exportAsJson;
     /** @hidden */
-    exportToHead(): string;
+    z_exportToHead(): string;
 }
 //# sourceMappingURL=SsrCache.d.ts.map

package/dist/ssr/SsrCache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SsrCache.d.ts","sourceRoot":"","sources":["../../src/ssr/SsrCache.ts"],"names":[],"mappings":"AAAA,wBAAsB,OAAO,CAAC,IAAI,EAAE,GAAG,mBAoBtC;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC5B,OAAO,CAAC,KAAK,CAAsB;;IAYnC;;OAEG;IACG,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAO/C;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAI7B;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC;IAI9B,cAAc;IACd,KAAK;IAIL,OAAO,CAAC,YAAY;IAIpB,cAAc;IACd,YAAY,IAAI,MAAM;CAGtB"}
+{"version":3,"file":"SsrCache.d.ts","sourceRoot":"","sources":["../../src/ssr/SsrCache.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAoBxD;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC5B,OAAO,CAAC,KAAK,CAAmB;;IAMhC;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIzB;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAI7B;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC;IAK9B;;;;OAIG;IACH,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;IAKnD;;;;;;OAMG;IACG,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAI5D;;;;OAIG;IACG,iBAAiB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAKzE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;IAcxC;;OAEG;IACH,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAMhC,cAAc;IACd,OAAO;IAIP,cAAc;IACd,gBAAgB;IAOhB,OAAO,CAAC,YAAY;IAOpB,cAAc;IACd,cAAc,IAAI,MAAM;CAGxB"}

package/dist/ssr/SsrCache.js

@@ -1,3 +1,8 @@
+/**
+ * Calculates a key based on the json representation of the data
+ *
+ * If available hashes the data using SHA-1
+ */
 export async function calcKey(data) {
     const json = JSON.stringify(data);
     // this should only happen in an unsecure context
@@ -25,44 +30,113 @@ export async function calcKey(data) {
 export default class SsrCache {
     store;
     constructor() {
-        this.store = {};
-        // @ts-ignore
-        if (typeof window !== 'undefined' && window.SSR_STORE) {
-            // @ts-ignore
-            this.store = window.SSR_STORE;
-        }
+        this.store = new Map();
     }
     /**
-     * check if the value is in the cache else calls the fn
+     * Check if a key exists in the cache
      */
-    async load(key, fn) {
-        if (key in this.store)
-            return this.store[key];
-        const v = await fn();
-        this.set(key, v);
-        return v;
+    has(key) {
+        return this.store.has(key);
     }
     /**
      * Get a value from the cache
      */
     get(key) {
-        return this.store[key] ?? null;
+        return this.store.get(key) ?? null;
     }
     /**
      * Set a value in the cache
      */
     set(key, val) {
-        return (this.store[key] = val);
+        this.store.set(key, val);
+        return val;
+    }
+    /**
+     * check if the value is in the cache else calls the fn
+     *
+     * See also {@link getOrInsertLoaded}
+     */
+    getOrInsertComputed(key, fn) {
+        if (this.store.has(key))
+            return this.store.get(key);
+        return this.set(key, fn());
+    }
+    /**
+     * check if the value is in the cache else calls the fn
+     *
+     * See also {@link getOrInsertComputed}
+     *
+     * @deprecated use {@link getOrInsertLoaded} instead
+     */
+    async load(key, fn) {
+        return this.getOrInsertLoaded(key, fn);
+    }
+    /**
+     * check if the value is in the cache else calls the fn
+     *
+     * See also {@link getOrInsertComputed}
+     */
+    async getOrInsertLoaded(key, fn) {
+        if (this.store.has(key))
+            return this.store.get(key);
+        return this.set(key, await fn());
+    }
+    /**
+     * One-shot SSR handoff value.
+     *
+     * Intended use: call this once per request (per key) during SSR to generate
+     * a value that must match between server render and client hydration.
+     *
+     * On the server, the value is generated once per key and stored for hydration.
+     * Subsequent calls with the same key during SSR currently return the same value,
+     * but this behaviour is an implementation detail and may change in the future.
+     * Consumers should rely on calling this at most once per key during SSR.
+     *
+     * On the client, the stored value is returned exactly once and removed.
+     * Subsequent calls return a fresh value and are not cached.
+     *
+     * Warning: this function is designed to be called once per key during SSR.
+     * Calling it multiple times may lead to unexpected behaviour if the server-side
+     * implementation changes.
+     *
+     * See also {@link getOrInsertComputed}
+     */
+    takeOnce(key, fn) {
+        if (import.meta.env.SSR) {
+            if (this.store.has(key)) {
+                console.warn(`SsrCache.takeOnce called multiple times for key "${key}" during SSR.`);
+                return this.store.get(key);
+            }
+            return this.set(key, fn());
+        }
+        if (this.store.has(key))
+            return this.remove(key);
+        return fn();
+    }
+    /**
+     * Remove a value from the cache and return it
+     */
+    remove(key) {
+        const val = this.get(key);
+        this.store.delete(key);
+        return val;
     }
     /** @hidden */
-    clear() {
-        this.store = {};
+    z_clear() {
+        this.store.clear();
+    }
+    /** @hidden */
+    z_importFromHead() {
+        // @ts-ignore
+        this.store = new Map(window._SSR_STORE ?? []);
+        // @ts-ignore
+        delete window._SSR_STORE;
     }
     exportAsJson() {
-        return JSON.stringify(this.store).replace(/</g, '\\u003c');
+        return JSON.stringify(Array.from(this.store.entries())).replace(/</g, '\\u003c');
     }
     /** @hidden */
-    exportToHead() {
-        return `\n\t\t<script>window.SSR_STORE = ${this.exportAsJson()};</script>`;
+    z_exportToHead() {
+        return `\n\t\t<script>window._SSR_STORE = ${this.exportAsJson()};</script>`;
     }
 }

package/dist/std/index.d.ts

@@ -1,3 +1,16 @@
+/**
+ * @packageDocumentation
+ *
+ * Crelte Standard library
+ *
+ * Provides standard utility functions and types for Crelte applications.
+ *
+ * ### Modules:
+ * - {@link std/intl}
+ * - {@link std/stores}
+ * - {@link std/sync}
+ * - {@link std/rand}
+ */
 /**
  * Delays for a specified amount of time.
  *

package/dist/std/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/std/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjD;AAED,MAAM,WAAW,SAAS;IACzB,KAAK,IAAI,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC7B,SAAS,GACT,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,CAAC;AAEb;;;GAGG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAIjE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/std/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjD;AAED,MAAM,WAAW,SAAS;IACzB,KAAK,IAAI,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC7B,SAAS,GACT,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,CAAC;AAEb;;;GAGG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAIjE"}

package/dist/std/index.js

@@ -1,3 +1,16 @@
+/**
+ * @packageDocumentation
+ *
+ * Crelte Standard library
+ *
+ * Provides standard utility functions and types for Crelte applications.
+ *
+ * ### Modules:
+ * - {@link std/intl}
+ * - {@link std/stores}
+ * - {@link std/sync}
+ * - {@link std/rand}
+ */
 /**
  * Delays for a specified amount of time.
  *

package/dist/std/rand/index.d.ts

@@ -0,0 +1,34 @@
+import { Crelte } from '../../crelte.js';
+/**
+ * Returns a random number between 0 (inclusive) and 1 (exclusive).
+ *
+ * In SSR mode, the same key will always return the same random number.
+ * In client mode, the first call will return the number generated during SSR.
+ */
+export declare function random(key: string, crelte?: Crelte): number;
+/**
+ * Create a deterministic random number generator.
+ *
+ * Intended use: create this once during component initialization when a sequence
+ * of random values must be consistent between server-side rendering and client
+ * hydration.
+ *
+ * The generator is seeded during SSR using the provided key. During hydration,
+ * the same seed is reused so that the client produces the same sequence of random
+ * numbers as the server for the initial render.
+ *
+ * After hydration, the generator continues independently on the client.
+ *
+ * @returns A function that returns a pseudo-random number in the range
+ *          [0, 1).
+ *
+ * #### Example
+ * ```ts
+ * const rng = createRng('lucky-number');
+ *
+ * const val1 = rng(); // same on server and client
+ * const val2 = rng(); // same on server and client
+ * ```
+ */
+export declare function createRng(key: string, crelte?: Crelte): () => number;
+//# sourceMappingURL=index.d.ts.map

package/dist/std/rand/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/std/rand/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAGzC;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,MAAoB,GAAG,MAAM,CAExE;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,SAAS,CACxB,GAAG,EAAE,MAAM,EACX,MAAM,GAAE,MAAoB,GAC1B,MAAM,MAAM,CAcd"}

package/dist/std/rand/index.js

@@ -0,0 +1,45 @@
+import { getCrelte } from '../../index.js';
+/**
+ * Returns a random number between 0 (inclusive) and 1 (exclusive).
+ *
+ * In SSR mode, the same key will always return the same random number.
+ * In client mode, the first call will return the number generated during SSR.
+ */
+export function random(key, crelte = getCrelte()) {
+    return crelte.ssrCache.takeOnce('_rand_' + key, () => Math.random());
+}
+/**
+ * Create a deterministic random number generator.
+ *
+ * Intended use: create this once during component initialization when a sequence
+ * of random values must be consistent between server-side rendering and client
+ * hydration.
+ *
+ * The generator is seeded during SSR using the provided key. During hydration,
+ * the same seed is reused so that the client produces the same sequence of random
+ * numbers as the server for the initial render.
+ *
+ * After hydration, the generator continues independently on the client.
+ *
+ * @returns A function that returns a pseudo-random number in the range
+ *          [0, 1).
+ *
+ * #### Example
+ * ```ts
+ * const rng = createRng('lucky-number');
+ *
+ * const val1 = rng(); // same on server and client
+ * const val2 = rng(); // same on server and client
+ * ```
+ */
+export function createRng(key, crelte = getCrelte()) {
+    const seed = crelte.ssrCache.takeOnce('_rng_' + key, () => Math.random());
+    // park miller algorithm
+    const MOD = 2147483647;
+    const MUL = 16807;
+    let state = Math.floor(seed * (MOD - 1)) + 1;
+    return () => {
+        state = (state * MUL) % MOD;
+        return (state - 1) / (MOD - 1);
+    };
+}

package/dist/std/rand/internal.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates a random token of a specified length.
+ *
+ * @param length - The desired length of the token.
+ * @returns A random token.
+ */
+export declare function randomToken(length?: number): string;
+//# sourceMappingURL=internal.d.ts.map

package/dist/std/rand/internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../../src/std/rand/internal.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,GAAE,MAAU,GAAG,MAAM,CAMtD"}

package/dist/std/rand/internal.js

@@ -0,0 +1,15 @@
+const ALPHABET = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
+const ALPHABET_LENGTH = ALPHABET.length;
+/**
+ * Generates a random token of a specified length.
+ *
+ * @param length - The desired length of the token.
+ * @returns A random token.
+ */
+export function randomToken(length = 8) {
+    let s = '';
+    for (let i = 0; i < length; i++) {
+        s += ALPHABET[Math.floor(Math.random() * ALPHABET_LENGTH)];
+    }
+    return s;
+}

package/dist/std/stores/Writable.d.ts

@@ -20,7 +20,7 @@ export default class Writable<T> {
      * The function get's called once with the current value and then when the
      * values changes
      *
-     * ## Note
+     * #### Note
      * This does not check for equality like svelte.
      *
      * @return a function which should be called to unsubscribe

package/dist/std/stores/Writable.js

@@ -23,7 +23,7 @@ export default class Writable {
      * The function get's called once with the current value and then when the
      * values changes
      *
-     * ## Note
+     * #### Note
      * This does not check for equality like svelte.
      *
      * @return a function which should be called to unsubscribe

package/dist/translations/index.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @packageDocumentation
+ *
+ * ## Unstable
+ * The translations module is not yet stable. APIs may change without a major version bump.
+ */
+import { createFileLoader } from './loader/fileLoader/fileLoader.js';
+import { createGlobalLoader } from './loader/GlobalLoader.js';
+import { type TranslationsLoader, type LoaderCreator } from './loader/index.js';
+import loadTranslations from './loadTranslations.js';
+import { createTranslations, getTranslationsPlugin, type TranslateFunction, type TranslateStore, type Translations, TranslationsPlugin, type TranslationsPluginOptions } from './translationsPlugin.js';
+/**
+ * Creates a translate store for the given namespace.
+ *
+ * #### Example
+ * ```svelte
+ * <script>
+ * 	import { getTranslations } from 'crelte/translations';
+ *
+ * 	const t = getTranslations();
+ * </script>
+ *
+ * <h1>{$t('welcome_message')}</h1>
+ * ```
+ */
+declare function getTranslations(namespace?: string): TranslateStore;
+export { createTranslations, TranslationsPluginOptions, loadTranslations, getTranslations, getTranslationsPlugin, Translations, TranslationsPlugin, TranslationsLoader, LoaderCreator, TranslateStore, TranslateFunction, createFileLoader, createGlobalLoader, };
+//# sourceMappingURL=index.d.ts.map

package/dist/translations/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/translations/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAChF,OAAO,gBAAgB,MAAM,uBAAuB,CAAC;AACrD,OAAO,EACN,kBAAkB,EAClB,qBAAqB,EACrB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,kBAAkB,EAClB,KAAK,yBAAyB,EAC9B,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;;;;;;GAaG;AACH,iBAAS,eAAe,CAAC,SAAS,GAAE,MAAiB,GAAG,cAAc,CAGrE;AAED,OAAO,EACN,kBAAkB,EAClB,yBAAyB,EACzB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACb,cAAc,EACd,iBAAiB,EAEjB,gBAAgB,EAChB,kBAAkB,GAClB,CAAC"}

package/dist/translations/index.js

@@ -0,0 +1,31 @@
+/**
+ * @packageDocumentation
+ *
+ * ## Unstable
+ * The translations module is not yet stable. APIs may change without a major version bump.
+ */
+import { createFileLoader } from './loader/fileLoader/fileLoader.js';
+import { createGlobalLoader } from './loader/GlobalLoader.js';
+import loadTranslations from './loadTranslations.js';
+import { createTranslations, getTranslationsPlugin, TranslationsPlugin, } from './translationsPlugin.js';
+/**
+ * Creates a translate store for the given namespace.
+ *
+ * #### Example
+ * ```svelte
+ * <script>
+ * 	import { getTranslations } from 'crelte/translations';
+ *
+ * 	const t = getTranslations();
+ * </script>
+ *
+ * <h1>{$t('welcome_message')}</h1>
+ * ```
+ */
+function getTranslations(namespace = 'common') {
+    const plugin = getTranslationsPlugin();
+    return plugin.z_createTranslateStore(namespace);
+}
+export { createTranslations, loadTranslations, getTranslations, getTranslationsPlugin, TranslationsPlugin, 
+// loaders
+createFileLoader, createGlobalLoader, };

package/dist/translations/loadTranslations.d.ts

@@ -0,0 +1,23 @@
+import { CrelteRequest } from '../crelte.js';
+import { TranslateStore } from './translationsPlugin.js';
+/**
+ * Creates a translate store and loads the specified namespace.
+ *
+ * #### Example
+ * ```svelte
+ * <script module>
+ * 	import { loadTranslations } from 'crelte/translations';
+ * 	export const loadData = {
+ * 		t: cr => loadTranslations(cr, 'customNamespace')
+ * 	};
+ * </script>
+ *
+ * <script>
+ * 	let { t } = $props();
+ * </script>
+ *
+ * <h1>{$t('welcome_message')}</h1>
+ * ```
+ */
+export default function loadTranslations(cr: CrelteRequest, namespace: string): Promise<TranslateStore>;
+//# sourceMappingURL=loadTranslations.d.ts.map

package/dist/translations/loadTranslations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadTranslations.d.ts","sourceRoot":"","sources":["../../src/translations/loadTranslations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAyB,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEhF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAA8B,gBAAgB,CAC7C,EAAE,EAAE,aAAa,EACjB,SAAS,EAAE,MAAM,GACf,OAAO,CAAC,cAAc,CAAC,CAOzB"}

package/dist/translations/loadTranslations.js

@@ -0,0 +1,26 @@
+import { getTranslationsPlugin } from './translationsPlugin.js';
+/**
+ * Creates a translate store and loads the specified namespace.
+ *
+ * #### Example
+ * ```svelte
+ * <script module>
+ * 	import { loadTranslations } from 'crelte/translations';
+ * 	export const loadData = {
+ * 		t: cr => loadTranslations(cr, 'customNamespace')
+ * 	};
+ * </script>
+ *
+ * <script>
+ * 	let { t } = $props();
+ * </script>
+ *
+ * <h1>{$t('welcome_message')}</h1>
+ * ```
+ */
+export default async function loadTranslations(cr, namespace) {
+    const plugin = getTranslationsPlugin(cr);
+    // we don't need the return value here as it's cached
+    await plugin.load(cr, namespace);
+    return plugin.z_createTranslateStore(namespace);
+}

package/dist/translations/loader/GlobalLoader.d.ts

@@ -0,0 +1,34 @@
+import { Translations } from '../translationsPlugin.js';
+import { Crelte, CrelteRequest } from '../../crelte.js';
+import { LoaderCreator, TranslationsLoader } from '../index.js';
+export default class GlobalLoader implements TranslationsLoader {
+    private handle;
+    constructor(_crelte: Crelte, opts: {
+        handle?: string;
+    });
+    load(cr: CrelteRequest, namespace: string): Promise<Translations>;
+}
+/**
+ * Creates a loader that loads translations from a global set.
+ *
+ * ```ts
+ * import { createTranslations, createGlobalLoader } from 'crelte/translations';
+ *
+ * createTranslations({ loader: createGlobalLoader() });
+ * ```
+ *
+ * Then in you're global export a `translations` globalSet with namespaces
+ * as fields, at least `common`.
+ *
+ * ```graphql
+ * translations: globalSet(handle: "translations", siteId: $siteId) {
+ *   ... on translations_GlobalSet {
+ *     common
+ *   }
+ * }
+ */
+export declare function createGlobalLoader(opts?: {
+    /** the handle for the global set containing the namespaces (default = translations) */
+    handle?: string;
+}): LoaderCreator;
+//# sourceMappingURL=GlobalLoader.d.ts.map

package/dist/translations/loader/GlobalLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GlobalLoader.d.ts","sourceRoot":"","sources":["../../../src/translations/loader/GlobalLoader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEhE,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,kBAAkB;IAC9D,OAAO,CAAC,MAAM,CAAS;gBAEX,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;IAIhD,IAAI,CAAC,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CAsBvE;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CACjC,IAAI,GAAE;IACL,uFAAuF;IACvF,MAAM,CAAC,EAAE,MAAM,CAAC;CACX,GACJ,aAAa,CAEf"}

package/dist/translations/loader/GlobalLoader.js

@@ -0,0 +1,45 @@
+export default class GlobalLoader {
+    handle;
+    constructor(_crelte, opts) {
+        this.handle = opts.handle ?? 'translations';
+    }
+    async load(cr, namespace) {
+        const globalSet = await cr.globals.getAsync(this.handle);
+        if (!globalSet || typeof globalSet !== 'object')
+            throw new Error(`missing globals \`${this.handle}\``);
+        const data = globalSet[namespace];
+        if (!data)
+            throw new Error(`could not find \`${namespace}\` in globals \`${this.handle}\``);
+        if (typeof data !== 'string')
+            return data;
+        try {
+            return JSON.parse(data);
+        }
+        catch (e) {
+            throw new Error(`could not parse \`${this.handle}.${namespace}\` as json \n\n` +
+                (e instanceof Error ? e.message : ''));
+        }
+    }
+}
+/**
+ * Creates a loader that loads translations from a global set.
+ *
+ * ```ts
+ * import { createTranslations, createGlobalLoader } from 'crelte/translations';
+ *
+ * createTranslations({ loader: createGlobalLoader() });
+ * ```
+ *
+ * Then in you're global export a `translations` globalSet with namespaces
+ * as fields, at least `common`.
+ *
+ * ```graphql
+ * translations: globalSet(handle: "translations", siteId: $siteId) {
+ *   ... on translations_GlobalSet {
+ *     common
+ *   }
+ * }
+ */
+export function createGlobalLoader(opts = {}) {
+    return crelte => new GlobalLoader(crelte, opts);
+}

package/dist/translations/loader/fileLoader/ClientFileLoader.d.ts

@@ -0,0 +1,10 @@
+import { CrelteRequest } from '../../../crelte.js';
+import SsrCache from '../../../ssr/SsrCache.js';
+import { Translations } from '../../translationsPlugin.js';
+import { TranslationsLoader } from '../index.js';
+export default class ClientFileLoader implements TranslationsLoader {
+    private readonly runNumber;
+    constructor(cache: SsrCache);
+    load(cr: CrelteRequest, namespace: string): Promise<Translations>;
+}
+//# sourceMappingURL=ClientFileLoader.d.ts.map

package/dist/translations/loader/fileLoader/ClientFileLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClientFileLoader.d.ts","sourceRoot":"","sources":["../../../../src/translations/loader/fileLoader/ClientFileLoader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,QAAQ,MAAM,0BAA0B,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGjD,MAAM,CAAC,OAAO,OAAO,gBAAiB,YAAW,kBAAkB;IAClE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAEvB,KAAK,EAAE,QAAQ;IAIrB,IAAI,CAAC,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CA0BvE"}

package/dist/translations/loader/fileLoader/ClientFileLoader.js

@@ -0,0 +1,24 @@
+import { SSR_RUN_NUMBER_KEY, translationFilePath } from './fileLoader.js';
+export default class ClientFileLoader {
+    runNumber;
+    constructor(cache) {
+        this.runNumber = cache.get(SSR_RUN_NUMBER_KEY) ?? '';
+    }
+    async load(cr, namespace) {
+        const lang = cr.site.language;
+        try {
+            const resp = await fetch(`${translationFilePath(lang, namespace)}?run=${this.runNumber}`);
+            if (!resp.ok) {
+                throw new Error(`Failed to fetch translations file for ${lang}/${namespace}`);
+            }
+            // todo: validate data
+            const data = await resp.json();
+            return data;
+        }
+        catch (e) {
+            console.error(e);
+            throw new Error('There is something wrong with your translations file. \n\n' +
+                (e instanceof Error ? e.message : ''));
+        }
+    }
+}

package/dist/translations/loader/fileLoader/NodeFileLoader.d.ts

@@ -0,0 +1,9 @@
+import { Translations } from '../../translationsPlugin.js';
+import SsrCache from '../../../ssr/SsrCache.js';
+import { CrelteRequest } from '../../../crelte.js';
+import { TranslationsLoader } from '../index.js';
+export default class NodeFileLoader implements TranslationsLoader {
+    constructor(cache: SsrCache);
+    load(cr: CrelteRequest, namespace: string): Promise<Translations>;
+}
+//# sourceMappingURL=NodeFileLoader.d.ts.map