crelte 0.1.0

package/dist/routing/PageLoader.d.ts

@@ -0,0 +1,37 @@
+import Route from './Route.js';
+import Site from './Site.js';
+export type PageLoaderOptions = {
+    debugTiming: boolean;
+};
+export type LoadResponse = {
+    success: boolean;
+    data: any;
+};
+export type LoadFn = (route: Route, site: Site, opts: LoadOptions) => Promise<any> | any;
+export type LoadOptions = {
+    setProgress: (num: number) => void;
+};
+/**
+ * The PageLoader which is responsible for loading page Data
+ */
+export default class PageLoader<More> {
+    private debugTiming;
+    private preloadedUrls;
+    private loadingVersion;
+    onLoaded: (resp: LoadResponse, route: Route, site: Site, more: More) => void;
+    onProgress: (loading: boolean, progress?: number) => void;
+    loadFn: LoadFn;
+    /**
+     * Creates a new PageLoader
+     *
+     * @param {Object} options `{debugTiming}`
+     */
+    constructor(options: PageLoaderOptions);
+    /**
+     * Discard the current page load if one is happening
+     */
+    discard(): void;
+    load(route: Route, site: Site, more: More): Promise<void>;
+    preload(route: Route, site: Site): Promise<void>;
+}
+//# sourceMappingURL=PageLoader.d.ts.map

package/dist/routing/PageLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PageLoader.d.ts","sourceRoot":"","sources":["../../../../src/routing/PageLoader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,GAAG,CAAC;CACV,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,CACpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,WAAW,KACb,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;AAExB,MAAM,MAAM,WAAW,GAAG;IACzB,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU,CAAC,IAAI;IACnC,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,aAAa,CAAc;IAEnC,OAAO,CAAC,cAAc,CAAS;IAE/B,QAAQ,EAAE,CACT,IAAI,EAAE,YAAY,EAClB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,KACN,IAAI,CAAC;IACV,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1D,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;gBACS,OAAO,EAAE,iBAAiB;IAWtC;;OAEG;IACH,OAAO;IAKD,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI;IAiCzC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI;CActC"}

package/dist/routing/PageLoader.js

@@ -0,0 +1,72 @@
+/**
+ * The PageLoader which is responsible for loading page Data
+ */
+export default class PageLoader {
+    debugTiming;
+    preloadedUrls;
+    loadingVersion;
+    onLoaded;
+    onProgress;
+    loadFn;
+    /**
+     * Creates a new PageLoader
+     *
+     * @param {Object} options `{debugTiming}`
+     */
+    constructor(options) {
+        this.debugTiming = options.debugTiming;
+        this.preloadedUrls = new Set();
+        this.loadingVersion = 0;
+        this.onLoaded = () => null;
+        this.onProgress = () => null;
+        this.loadFn = () => null;
+    }
+    /**
+     * Discard the current page load if one is happening
+     */
+    discard() {
+        this.loadingVersion++;
+        this.onProgress(false);
+    }
+    async load(route, site, more) {
+        this.onProgress(true);
+        const version = ++this.loadingVersion;
+        const startTime = this.debugTiming ? Date.now() : null;
+        const setProgress = (num) => {
+            if (this.loadingVersion !== version)
+                return;
+            this.onProgress(true, num);
+        };
+        const resp = { success: false, data: null };
+        try {
+            resp.data = await this.loadFn(route, site, { setProgress });
+            resp.success = true;
+        }
+        catch (e) {
+            resp.success = false;
+            resp.data = e;
+        }
+        if (startTime)
+            console.log('page load took ' + (Date.now() - startTime) + 'ms');
+        // if were the last that called loading, trigger the loaded event
+        if (this.loadingVersion !== version)
+            return console.log('route changed quickly, ignoring response');
+        this.onProgress(false);
+        this.onLoaded(resp, route, site, more);
+    }
+    // you don't need to wait on this call
+    async preload(route, site) {
+        const url = route.url.origin + route.url.pathname;
+        if (this.preloadedUrls.has(url))
+            return;
+        this.preloadedUrls.add(url);
+        try {
+            await this.loadFn(route, site, { setProgress: () => null });
+        }
+        catch (e) {
+            console.log('preload failed');
+            // retry at another time
+            this.preloadedUrls.delete(url);
+        }
+    }
+}

package/dist/routing/Route.d.ts

@@ -0,0 +1,82 @@
+import Site from './Site.js';
+export type RouteOpts = {
+    scrollY?: number;
+    index?: number;
+    origin?: RouteOrigin;
+};
+/**
+ * RouteOrigin represents the origin of a route.
+ * This type is non-exhaustive and might expand in the future.
+ *
+ * - `'init'`: is set on the first page load
+ * - `'manual'`: is set when a route is triggered manually via `Router.open`
+ * - `'live-preview-init'`: is set on the first page load in live preview mode
+ * - `'click'`: is set when a route is triggered by a click event
+ * - `'pop'`: is set when a route is triggered by a popstate event (back/forward)
+ */
+export type RouteOrigin = 'init' | 'live-preview-init' | 'manual' | 'click' | 'pop';
+/**
+ * A Route contains information about the current page for example the url and
+ * the site id
+ *
+ * ## Note
+ * Never update the route directly, clone it before
+ */
+export default class Route {
+    /**
+     * The url of the route
+     */
+    url: URL;
+    /**
+     * The site of the route if it could be defined
+     */
+    site: Site | null;
+    /**
+     * The scroll position of the current route
+     */
+    scrollY: number | null;
+    /**
+     * the position in the browser history of this route
+     * this allows to find out if we can go back
+     */
+    index: number;
+    /**
+     * The origin of this route
+     *
+     * Might pop, click or init (non exclusive)
+     */
+    origin: RouteOrigin;
+    /**
+     * Creates a new Route
+     */
+    constructor(url: string | URL, site: Site | null, opts?: RouteOpts);
+    /**
+     * Returns the uri of the route
+     *
+     * Never ends with a slash
+     */
+    get uri(): string;
+    /**
+     * Never ends with a slash
+     */
+    get baseUrl(): string;
+    get search(): URLSearchParams;
+    get hash(): string;
+    eq(route: Route): boolean;
+    /**
+     * Checks if there are previous routes which would allow it to go back
+     */
+    canGoBack(): boolean;
+    /**
+     * Gets the search param
+     */
+    getSearchParam(key: string): string | null;
+    /**
+     * Sets the search param or removes it if the value is null or undefined
+     */
+    setSearchParam(key: string, value?: string | number | null): void;
+    clone(): Route;
+    _fillFromState(state: any): void;
+    _toState(): any;
+}
+//# sourceMappingURL=Route.d.ts.map

package/dist/routing/Route.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Route.d.ts","sourceRoot":"","sources":["../../../../src/routing/Route.ts"],"names":[],"mappings":"AACA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,MAAM,SAAS,GAAG;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,WAAW,GACpB,MAAM,GACN,mBAAmB,GACnB,QAAQ,GACR,OAAO,GACP,KAAK,CAAC;AAET;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,KAAK;IACzB;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;IAET;;OAEG;IACH,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;OAEG;gBACS,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,IAAI,GAAE,SAAc;IAStE;;;;OAIG;IACH,IAAI,GAAG,IAAI,MAAM,CAShB;IAGD;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,CAIpB;IAED,IAAI,MAAM,IAAI,eAAe,CAE5B;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,EAAE,CAAC,KAAK,EAAE,KAAK;IAwBf;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAI1C;;OAEG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAQ1D,KAAK;IASL,cAAc,CAAC,KAAK,EAAE,GAAG;IASzB,QAAQ,IAAI,GAAG;CAQf"}

package/dist/routing/Route.js

@@ -0,0 +1,134 @@
+import { trimSlashEnd } from './Router.js';
+/**
+ * A Route contains information about the current page for example the url and
+ * the site id
+ *
+ * ## Note
+ * Never update the route directly, clone it before
+ */
+export default class Route {
+    /**
+     * The url of the route
+     */
+    url;
+    /**
+     * The site of the route if it could be defined
+     */
+    site;
+    /**
+     * The scroll position of the current route
+     */
+    scrollY;
+    /**
+     * the position in the browser history of this route
+     * this allows to find out if we can go back
+     */
+    index;
+    /**
+     * The origin of this route
+     *
+     * Might pop, click or init (non exclusive)
+     */
+    origin;
+    /**
+     * Creates a new Route
+     */
+    constructor(url, site, opts = {}) {
+        this.url = new URL(url);
+        this.site = site;
+        this.scrollY = opts.scrollY ?? null;
+        this.index = opts.index ?? 0;
+        this.origin = opts.origin ?? 'manual';
+    }
+    /**
+     * Returns the uri of the route
+     *
+     * Never ends with a slash
+     */
+    get uri() {
+        // todo check if this is correct
+        if (this.site) {
+            return trimSlashEnd(this.url.pathname.substring(this.site.uri.length));
+        }
+        return trimSlashEnd(this.url.pathname);
+    }
+    // todo is this correct and do we wan't it?
+    /**
+     * Never ends with a slash
+     */
+    get baseUrl() {
+        if (this.site)
+            return trimSlashEnd(this.site.url.href);
+        return this.url.origin;
+    }
+    get search() {
+        return this.url.searchParams;
+    }
+    get hash() {
+        return this.url.hash;
+    }
+    eq(route) {
+        const searchEq = (a, b) => {
+            if (a.size !== b.size)
+                return false;
+            a.sort();
+            b.sort();
+            const aEntries = Array.from(a.entries());
+            const bEntries = Array.from(b.entries());
+            return aEntries
+                .map((a, i) => [a, bEntries[i]])
+                .every(([[ak, av], [bk, bv]]) => ak === bk && av === bv);
+        };
+        return (route &&
+            this.url.pathname === route.url.pathname &&
+            this.url.origin === route.url.origin &&
+            searchEq(this.search, route.search) &&
+            this.hash === route.hash);
+    }
+    /**
+     * Checks if there are previous routes which would allow it to go back
+     */
+    canGoBack() {
+        return !!this.index;
+    }
+    /**
+     * Gets the search param
+     */
+    getSearchParam(key) {
+        return this.search.get(key);
+    }
+    /**
+     * Sets the search param or removes it if the value is null or undefined
+     */
+    setSearchParam(key, value) {
+        if (typeof value !== 'undefined' && value !== null) {
+            this.search.set(key, value);
+        }
+        else {
+            this.search.delete(key);
+        }
+    }
+    clone() {
+        return new Route(this.url.href, this.site, {
+            scrollY: this.scrollY ?? undefined,
+            index: this.index,
+            origin: this.origin,
+        });
+    }
+    // internal function
+    _fillFromState(state) {
+        if (typeof state?.route?.scrollY === 'number')
+            this.scrollY = state.route.scrollY;
+        if (typeof state?.route?.index === 'number')
+            this.index = state.route.index;
+    }
+    // internal function
+    _toState() {
+        return {
+            route: {
+                scrollY: this.scrollY,
+                index: this.index,
+            },
+        };
+    }
+}

package/dist/routing/Router.d.ts

@@ -0,0 +1,162 @@
+import Route from './Route.js';
+import Site, { SiteFromGraphQl } from './Site.js';
+import { LoadFn } from './PageLoader.js';
+import { Readable } from 'crelte-std/stores';
+export type RouterOpts = {
+    preloadOnMouseOver?: boolean;
+    debugTiming?: boolean;
+};
+/**
+ * internal only
+ */
+type Internal = {
+    onLoaded: (success: boolean, route: Route, site: Site, ready: () => any) => void;
+    onLoad: LoadFn;
+    domReady: (route: Route) => void;
+    initClient: () => void;
+    initServer: (url: string, acceptLang?: string) => Promise<ServerInited>;
+};
+type ServerInited = {
+    success: boolean;
+    redirect: boolean;
+    route: Route;
+    site: Site;
+    props: any;
+};
+export declare function trimSlashEnd(str: string): string;
+export type OnNextRouteOpts = {
+    /**
+     * If you call delayRender you need to call ready or the render will never happen
+     */
+    delayRender: () => DelayRender;
+};
+export default class Router {
+    /**
+     * The current route
+     */
+    private _route;
+    /**
+     * The current site
+     */
+    private _site;
+    /**
+     * The next route which is currently being loaded
+     */
+    private _nextRoute;
+    /**
+     * The next site which is currently being loaded
+     */
+    private _nextSite;
+    /**
+     * The loading flag, specifies if a page is currently
+     * getting loaded
+     */
+    private _loading;
+    /**
+     * The loading progress, the value is between 0 and 1
+     */
+    private _loadingProgress;
+    private _onRouteEv;
+    private _onNextRoute;
+    private _renderBarrier;
+    _internal: Internal;
+    private inner;
+    private pageLoader;
+    constructor(sites: SiteFromGraphQl[], opts?: RouterOpts);
+    /**
+     * The current route
+     *
+     * this is a svelte store
+     */
+    get route(): Readable<Route>;
+    /**
+     * The current site
+     */
+    get site(): Readable<Site>;
+    /**
+     * The next route which is currently being loaded
+     */
+    get nextRoute(): Readable<Route>;
+    /**
+     * The next site which is currently being loaded
+     */
+    get nextSite(): Readable<Site>;
+    /**
+     * The sites which are available
+     */
+    get sites(): Site[];
+    /**
+     * The loading flag, specifies if a page is currently
+     * getting loaded
+     */
+    get loading(): Readable<boolean>;
+    /**
+     * The loading progress, the value is between 0 and 1
+     */
+    get loadingProgress(): Readable<number>;
+    /**
+     * Open a new route
+     *
+     * @param target the target to open can be an url or a route
+     * the url needs to start with http or with a / which will be considered as
+     * the site baseUrl
+     */
+    open(target: string | URL | Route): void;
+    /**
+     * This pushes the state of the route without triggering an event
+     *
+     * You can use this when using pagination for example change the route object
+     * (search argument) and then call pushState
+     *
+     * @param route
+     */
+    pushState(route: Route): void;
+    /**
+     * This replaces the state of the route without triggering an event
+     *
+     * @param route
+     */
+    replaceState(route: Route): void;
+    /**
+     * Checks if there are previous routes which would allow it to go back
+     */
+    canGoBack(): boolean;
+    /**
+     * Go back in the history
+     */
+    back(): void;
+    /**
+     * Preload a url
+     */
+    preload(target: string | URL | Route): void;
+    /**
+     * Add a listener for the onRoute event
+     *
+     * This differs from router.route.subscribe in the way that
+     * it will only trigger if a new render / load will occur
+     */
+    onRoute(fn: (route: Route, site: Site) => void): () => void;
+    onNextRoute(fn: (route: Route, site: Site, opts: OnNextRouteOpts) => void): () => void;
+    private setNewRoute;
+    private _initClient;
+    private _initServer;
+    private _onRoute;
+    private _onPreload;
+    private _onLoaded;
+    private _onProgress;
+}
+export type DelayRender = {
+    /**
+     * Call this when you're ready for the render to happen
+     * the promise will resolve when the render is done or was cancelled
+     *
+     * @returns if the render was cancelled
+     */
+    ready: () => Promise<boolean>;
+    /**
+     * If youre not interested in the render anymore
+     */
+    remove: () => void;
+};
+export {};
+//# sourceMappingURL=Router.d.ts.map

package/dist/routing/Router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Router.d.ts","sourceRoot":"","sources":["../../../../src/routing/Router.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,IAAI,EAAE,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAElD,OAAmB,EAAE,MAAM,EAAgB,MAAM,iBAAiB,CAAC;AAEnE,OAAO,EAAE,QAAQ,EAAY,MAAM,mBAAmB,CAAC;AAGvD,MAAM,MAAM,UAAU,GAAG;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAWF;;GAEG;AACH,KAAK,QAAQ,GAAG;IACf,QAAQ,EAAE,CACT,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,IAAI,EAKV,KAAK,EAAE,MAAM,GAAG,KACZ,IAAI,CAAC;IAEV,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAEjC,UAAU,EAAE,MAAM,IAAI,CAAC;IAEvB,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;CACxE,CAAC;AAEF,KAAK,YAAY,GAAG;IACnB,OAAO,EAAE,OAAO,CAAC;IAEjB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,GAAG,CAAC;CACX,CAAC;AAEF,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,UAEvC;AAED,MAAM,MAAM,eAAe,GAAG;IAC7B;;OAEG;IACH,WAAW,EAAE,MAAM,WAAW,CAAC;CAC/B,CAAC;AAGF,MAAM,CAAC,OAAO,OAAO,MAAM;IAC1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAkB;IAEhC;;OAEG;IACH,OAAO,CAAC,KAAK,CAAiB;IAE9B;;OAEG;IACH,OAAO,CAAC,UAAU,CAAkB;IAEpC;;OAEG;IACH,OAAO,CAAC,SAAS,CAAiB;IAElC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAoB;IAEpC;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAmB;IAE3C,OAAO,CAAC,UAAU,CAA2B;IAE7C,OAAO,CAAC,YAAY,CAA4C;IAChE,OAAO,CAAC,cAAc,CAAuB;IAG7C,SAAS,EAAE,QAAQ,CAAC;IAEpB,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,UAAU,CAAyB;gBAE/B,KAAK,EAAE,eAAe,EAAE,EAAE,IAAI,GAAE,UAAe;IA2C3D;;;;OAIG;IACH,IAAI,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,CAE3B;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,CAEzB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,CAE/B;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,CAE7B;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,IAAI,EAAE,CAElB;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAE/B;IAED;;OAEG;IACH,IAAI,eAAe,IAAI,QAAQ,CAAC,MAAM,CAAC,CAEtC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK;IAIjC;;;;;;;OAOG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK;IAMtB;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK;IAMzB;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,IAAI;IAIJ;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK;IAIpC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,GAAG,MAAM,IAAI;IAI3D,WAAW,CACV,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,eAAe,KAAK,IAAI,GAC3D,MAAM,IAAI;IAIb,OAAO,CAAC,WAAW;YAkBL,WAAW;YAIX,WAAW;IAyDzB,OAAO,CAAC,QAAQ;IAyBhB,OAAO,CAAC,UAAU;YAIJ,SAAS;IAmCvB,OAAO,CAAC,WAAW;CAKnB;AAoCD,MAAM,MAAM,WAAW,GAAG;IACzB;;;;;OAKG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,IAAI,CAAC;CACnB,CAAC"}