@txstate-mws/sveltekit-utils 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Texas State ETC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# sveltekit-utils
+Shared library for code that is specifically tied to sveltekit in addition to svelte.

package/dist/api.d.ts

@@ -0,0 +1,43 @@
+import { InteractionEvent } from '@txstate-mws/fastify-shared';
+export type APIBaseQueryPayload = string | Record<string, string | number | (string | number)[]>;
+type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
+/**
+ * Provided for convenience in case you are not using APIBase but still want to record navigations
+ *
+ * If you are using or extending APIBase, call `api.recordNavigations` instead.
+ *
+ * Must be called from a svelte component. Should usually be your root +layout.svelte.
+ */
+export declare function recordNavigations(callback: (evt: InteractionEvent) => void): void;
+export declare class APIBase {
+    protected apiBase: string;
+    protected authRedirect: string;
+    protected token?: string;
+    fetch: (info: RequestInfo, init?: RequestInit) => Promise<Response>;
+    protected ready: () => void;
+    protected readyPromise: Promise<void>;
+    constructor(apiBase: string, authRedirect: string);
+    init(token: string | undefined, fetch?: (info: RequestInfo, init?: RequestInit) => Promise<Response>): Promise<void>;
+    stringifyQuery(query: undefined | APIBaseQueryPayload): string;
+    protected request<ReturnType = any>(path: string, method: string, payload?: {
+        body?: any;
+        query?: APIBaseQueryPayload;
+    }): Promise<any>;
+    get<ReturnType = any>(path: string, query?: APIBaseQueryPayload): Promise<any>;
+    post<ReturnType = any>(path: string, body?: any, query?: APIBaseQueryPayload): Promise<any>;
+    put<ReturnType = any>(path: string, body?: any, query?: APIBaseQueryPayload): Promise<any>;
+    patch<ReturnType = any>(path: string, body?: any, query?: APIBaseQueryPayload): Promise<any>;
+    /**
+     * Sending a JSON body with an HTTP DELETE is not recommended
+     */
+    delete<ReturnType = any>(path: string, query?: APIBaseQueryPayload, body?: any): Promise<any>;
+    graphql<ReturnType = any>(query: string, variables?: any, querySignature?: string): Promise<ReturnType>;
+    protected analyticsQueue: InteractionEvent[];
+    recordInteraction(evt: Optional<InteractionEvent, 'screen'>): void;
+    /**
+     * Due to the mechanics of sveltekit, this function cannot be fully automatic and must
+     * be called in your global +layout.svelte
+     */
+    recordNavigations(): void;
+}
+export {};

package/dist/api.js

@@ -0,0 +1,137 @@
+import { toasts } from '@txstate-mws/svelte-components';
+import { error } from '@sveltejs/kit';
+import { get } from 'svelte/store';
+import { rescue, toArray } from 'txstate-utils';
+import { page } from '$app/stores';
+import { afterNavigate } from '$app/navigation';
+/**
+ * Provided for convenience in case you are not using APIBase but still want to record navigations
+ *
+ * If you are using or extending APIBase, call `api.recordNavigations` instead.
+ *
+ * Must be called from a svelte component. Should usually be your root +layout.svelte.
+ */
+export function recordNavigations(callback) {
+    afterNavigate(navigation => {
+        callback({ eventType: 'sveltekit-utils-navigation', screen: (navigation.from ?? navigation.to)?.route.id, target: navigation.to?.url.toString(), action: 'navigation', additionalProperties: { fullPageLoad: String(!navigation.from) } });
+    });
+}
+export class APIBase {
+    apiBase;
+    authRedirect;
+    token;
+    fetch;
+    ready;
+    readyPromise;
+    constructor(apiBase, authRedirect) {
+        this.apiBase = apiBase;
+        this.authRedirect = authRedirect;
+        this.readyPromise = new Promise(resolve => { this.ready = resolve; });
+    }
+    async init(token, fetch) {
+        this.token = token;
+        this.fetch = fetch ?? this.fetch;
+        if (this.token) {
+            sessionStorage.setItem('token', this.token);
+        }
+        else {
+            this.token = sessionStorage.getItem('token') ?? undefined;
+        }
+        this.ready();
+    }
+    stringifyQuery(query) {
+        if (query == null)
+            return '';
+        if (typeof query === 'string')
+            return query.startsWith('?') ? query : '?' + query;
+        const p = new URLSearchParams();
+        for (const [key, val] of Object.entries(query)) {
+            for (const v of toArray(val))
+                p.append(key, String(v));
+        }
+        return '?' + p.toString();
+    }
+    async request(path, method, payload) {
+        await this.readyPromise;
+        try {
+            const resp = await this.fetch(this.apiBase + path + this.stringifyQuery(payload?.query), {
+                method,
+                headers: {
+                    Authorization: `Bearer ${this.token ?? ''}`,
+                    Accept: 'application/json',
+                    ...(payload?.body ? { 'Content-Type': 'application/json' } : {})
+                },
+                body: payload?.body ? JSON.stringify(payload.body) : undefined
+            });
+            if (!resp.ok) {
+                if (resp.status === 401) {
+                    const loginRedirect = new URL(this.authRedirect);
+                    loginRedirect.searchParams.set('requestedUrl', location.href);
+                    location.href = loginRedirect.toString();
+                    throw error(401);
+                }
+                else {
+                    const message = ((await rescue(resp.json()))?.message ?? resp.statusText);
+                    toasts.add(message);
+                    throw error(resp.status, message);
+                }
+            }
+            const contentType = resp.headers.get("content-type");
+            return (contentType && contentType.indexOf("application/json") !== -1) ? await resp.json() : await resp.text();
+        }
+        catch (e) {
+            toasts.add(e.message);
+            throw e;
+        }
+    }
+    async get(path, query) {
+        return await this.request(path, 'GET', { query });
+    }
+    async post(path, body, query) {
+        return await this.request(path, 'POST', { body, query });
+    }
+    async put(path, body, query) {
+        return await this.request(path, 'PUT', { body, query });
+    }
+    async patch(path, body, query) {
+        return await this.request(path, 'PATCH', { body, query });
+    }
+    /**
+     * Sending a JSON body with an HTTP DELETE is not recommended
+     */
+    async delete(path, query, body) {
+        return await this.request(path, 'DELETE', { body, query });
+    }
+    async graphql(query, variables, querySignature) {
+        const gqlresponse = await this.request('/graphql', 'POST', { body: {
+                query,
+                variables,
+                extensions: {
+                    querySignature
+                }
+            } });
+        if (gqlresponse.errors?.length) {
+            toasts.add(gqlresponse.errors[0].message);
+            throw new Error(JSON.stringify(gqlresponse.errors));
+        }
+        return gqlresponse.data;
+    }
+    analyticsQueue = [];
+    recordInteraction(evt) {
+        evt.screen ??= get(page).route.id;
+        this.analyticsQueue.push(evt);
+        setTimeout(() => {
+            const events = [...this.analyticsQueue];
+            this.analyticsQueue.length = 0;
+            this.post('/analytics', events).catch((e) => console.error(e));
+        }, 2000);
+    }
+    /**
+     * Due to the mechanics of sveltekit, this function cannot be fully automatic and must
+     * be called in your global +layout.svelte
+     */
+    recordNavigations() {
+        recordNavigations(this.recordInteraction.bind(this));
+    }
+}
+//# sourceMappingURL=api.js.map

package/dist/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAA;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AACrC,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAElC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAK/C;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAE,QAAyC;IAC1E,aAAa,CAAC,UAAU,CAAC,EAAE;QACzB,QAAQ,CAAC,EAAE,SAAS,EAAE,4BAA4B,EAAE,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,IAAI,UAAU,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,oBAAoB,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;IAC7O,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,OAAO,OAAO;IAMK;IAA2B;IALxC,KAAK,CAAS;IACjB,KAAK,CAA+D;IACjE,KAAK,CAAa;IAClB,YAAY,CAAe;IAErC,YAAuB,OAAe,EAAY,YAAoB;QAA/C,YAAO,GAAP,OAAO,CAAQ;QAAY,iBAAY,GAAZ,YAAY,CAAQ;QACpE,IAAI,CAAC,YAAY,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,GAAG,OAAO,CAAA,CAAC,CAAC,CAAC,CAAA;IACtE,CAAC;IAED,KAAK,CAAC,IAAI,CAAE,KAAyB,EAAE,KAAoE;QACzG,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,IAAI,CAAC,KAAK,CAAA;QAChC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QAC7C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,SAAS,CAAA;QAC3D,CAAC;QACD,IAAI,CAAC,KAAK,EAAE,CAAA;IACd,CAAC;IAED,cAAc,CAAE,KAAsC;QACpD,IAAI,KAAK,IAAI,IAAI;YAAE,OAAO,EAAE,CAAA;QAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAA;QACjF,MAAM,CAAC,GAAG,IAAI,eAAe,EAAE,CAAA;QAC/B,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC;gBAAE,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QACxD,CAAC;QACD,OAAO,GAAG,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAA;IAC3B,CAAC;IAES,KAAK,CAAC,OAAO,CAAqB,IAAY,EAAE,MAAc,EAAE,OAAqD;QAC7H,MAAM,IAAI,CAAC,YAAY,CAAA;QACvB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;gBACvF,MAAM;gBACN,OAAO,EAAE;oBACP,aAAa,EAAE,UAAU,IAAI,CAAC,KAAK,IAAI,EAAE,EAAE;oBAC3C,MAAM,EAAE,kBAAkB;oBAC1B,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACjE;gBACD,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;aAC/D,CAAC,CAAA;YACF,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;gBACb,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;oBACxB,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;oBAChD,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;oBAC7D,QAAQ,CAAC,IAAI,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAA;oBACxC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;gBAClB,CAAC;qBAAM,CAAC;oBACN,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,IAAI,IAAI,CAAC,UAAU,CAAW,CAAA;oBACnF,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;oBACnB,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;gBACnC,CAAC;YACH,CAAC;YACD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YACrD,OAAO,CAAC,WAAW,IAAI,WAAW,CAAC,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAChH,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,OAAiB,CAAC,CAAA;YAC/B,MAAM,CAAC,CAAA;QACT,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAqB,IAAY,EAAE,KAA2B;QACrE,OAAO,MAAM,IAAI,CAAC,OAAO,CAAa,IAAI,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IAC/D,CAAC;IAED,KAAK,CAAC,IAAI,CAAqB,IAAY,EAAE,IAAU,EAAE,KAA2B;QAClF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAa,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IACtE,CAAC;IAED,KAAK,CAAC,GAAG,CAAqB,IAAY,EAAE,IAAU,EAAE,KAA2B;QACjF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAa,IAAI,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IACrE,CAAC;IAED,KAAK,CAAC,KAAK,CAAqB,IAAY,EAAE,IAAU,EAAE,KAA2B;QACnF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAa,IAAI,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IACvE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAqB,IAAY,EAAE,KAA2B,EAAE,IAAU;QACpF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAa,IAAI,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IACxE,CAAC;IAED,KAAK,CAAC,OAAO,CAAqB,KAAa,EAAE,SAAe,EAAE,cAAuB;QACvF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE;gBACjE,KAAK;gBACL,SAAS;gBACT,UAAU,EAAE;oBACV,cAAc;iBACf;aACF,EAAE,CAAC,CAAA;QACJ,IAAI,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;YAC/B,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;YACzC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;QACrD,CAAC;QACD,OAAO,WAAW,CAAC,IAAI,CAAA;IACzB,CAAC;IAES,cAAc,GAAuB,EAAE,CAAA;IACjD,iBAAiB,CAAC,GAAyC;QACzD,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAG,CAAA;QAClC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAuB,CAAC,CAAA;QACjD,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAA;YACvC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAA;YAC9B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAChE,CAAC,EAAE,IAAI,CAAC,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,iBAAiB;QACf,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IACtD,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './api.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './api.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@txstate-mws/sveltekit-utils",
+  "version": "1.0.0",
+  "description": "Shared library for code that is specifically tied to sveltekit in addition to svelte.",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@sveltejs/kit": "^2.5.4",
+    "@txstate-mws/fastify-shared": "^1.0.4",
+    "@txstate-mws/svelte-components": "^1.6.1",
+    "txstate-utils": "^1.8.15"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.3"
+  },
+  "scripts": {
+    "prepublishOnly": "npm run build",
+    "build": "tsc -b"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/txstate-etc/sveltekit-utils.git"
+  },
+  "author": "Nick Wing",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/txstate-etc/sveltekit-utils/issues"
+  },
+  "homepage": "https://github.com/txstate-etc/sveltekit-utils#readme",
+  "files": ["dist"]
+}