@crossauth/sveltekit 1.0.1 → 1.1.1

package/dist/sveltekituserclientendpoints.d.ts

@@ -1,7 +1,8 @@
-import { SvelteKitSessionServer, SvelteKitSessionServerOptions } from './sveltekitsession';
-import { RequestEvent } from '@sveltejs/kit';
-import { SearchClientsPageData, UpdateClientPageData, UpdateClientFormData, DeleteClientPageData, DeleteClientFormData, SvelteKitSharedClientEndpoints } from './sveltekitsharedclientendpoints';
-
+import { SvelteKitSessionServer } from './sveltekitsession';
+import type { SvelteKitSessionServerOptions } from './sveltekitsession';
+import type { RequestEvent } from '@sveltejs/kit';
+import type { SearchClientsPageData, UpdateClientPageData, UpdateClientFormData, DeleteClientPageData, DeleteClientFormData } from './sveltekitsharedclientendpoints';
+import { SvelteKitSharedClientEndpoints } from './sveltekitsharedclientendpoints';
 /**
  * Endpoints for manipulating the OAuth client table, for use by users.
  *
@@ -72,7 +73,7 @@ export declare class SvelteKitUserClientEndpoints extends SvelteKitSharedClientE
     readonly searchClientsEndpoint: {
         load: (event: RequestEvent) => Promise<{
             ok: boolean;
-            clients?: import('@crossauth/common').OAuthClient[] | undefined;
+            clients?: import("@crossauth/common").OAuthClient[] | undefined;
             skip: number;
             take: number;
             search?: string | undefined;
@@ -82,7 +83,7 @@ export declare class SvelteKitUserClientEndpoints extends SvelteKitSharedClientE
             hasPrevious: boolean;
             hasNext: boolean;
             clientUserId?: string | number | undefined;
-            user: import('@crossauth/common').User | undefined;
+            user: import("@crossauth/common").User | undefined;
             csrfToken: string | undefined;
         }>;
     };
@@ -92,7 +93,7 @@ export declare class SvelteKitUserClientEndpoints extends SvelteKitSharedClientE
     readonly updateClientEndpoint: {
         load: (event: RequestEvent) => Promise<{
             ok: boolean;
-            client?: import('@crossauth/common').OAuthClient | undefined;
+            client?: import("@crossauth/common").OAuthClient | undefined;
             client_id?: string | undefined;
             clientUsername?: string | undefined;
             error?: string | undefined;
@@ -102,7 +103,7 @@ export declare class SvelteKitUserClientEndpoints extends SvelteKitSharedClientE
             valid_flowNames: {
                 [key: string]: string;
             };
-            user: import('@crossauth/common').User | undefined;
+            user: import("@crossauth/common").User | undefined;
             csrfToken: string | undefined;
         }>;
         actions: {
@@ -115,7 +116,7 @@ export declare class SvelteKitUserClientEndpoints extends SvelteKitSharedClientE
     readonly createClientEndpoint: {
         load: (event: RequestEvent) => Promise<{
             ok: boolean;
-            client?: import('@crossauth/common').OAuthClient | undefined;
+            client?: import("@crossauth/common").OAuthClient | undefined;
             client_id?: string | undefined;
             clientUsername?: string | undefined;
             error?: string | undefined;
@@ -125,7 +126,7 @@ export declare class SvelteKitUserClientEndpoints extends SvelteKitSharedClientE
             valid_flowNames: {
                 [key: string]: string;
             };
-            user: import('@crossauth/common').User | undefined;
+            user: import("@crossauth/common").User | undefined;
             csrfToken: string | undefined;
         }>;
         actions: {
@@ -138,13 +139,13 @@ export declare class SvelteKitUserClientEndpoints extends SvelteKitSharedClientE
     readonly deleteClientEndpoint: {
         load: (event: RequestEvent) => Promise<{
             ok: boolean;
-            client?: import('@crossauth/common').OAuthClient | undefined;
+            client?: import("@crossauth/common").OAuthClient | undefined;
             client_id?: string | undefined;
             clientUsername?: string | undefined;
             error?: string | undefined;
             errorCode?: number | undefined;
             errorCodeName?: string | undefined;
-            user: import('@crossauth/common').User | undefined;
+            user: import("@crossauth/common").User | undefined;
             csrfToken: string | undefined;
         }>;
         actions: {

package/dist/sveltekituserclientendpoints.js

@@ -0,0 +1,270 @@
+// Copyright (c) 2026 Matthew Baker.  All rights reserved.  Licenced under the Apache Licence 2.0.  See LICENSE file
+import { SvelteKitServer } from './sveltekitserver';
+import { SvelteKitSessionServer } from './sveltekitsession';
+import { setParameter, ParamType, } from '@crossauth/backend';
+import { SvelteKitSharedClientEndpoints } from './sveltekitsharedclientendpoints';
+import { CrossauthError, j, CrossauthLogger, ErrorCode } from '@crossauth/common';
+//////////////////////////////////////////////////////////////////////
+// Class
+/**
+ * Endpoints for manipulating the OAuth client table, for use by users.
+ *
+ * You do not instantiate this directly - it is created when you create
+ * a {@link SvelteKitServer}.
+ *
+ * **Endpoints**
+ *
+ * These endpoints can only be called if an admin user is logged in, as defined
+ * by the {@link SvelteKitServer.isAdminFn}.  If the user does not
+ * have this permission, a 401 error is raised.
+ *
+ * | Name                       | Description                                                 | PageData (returned by load)                                                      | ActionData (return by actions)                                   | Form fields expected by actions                                  | URL param |
+ * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
+ * | baseEndpoint               | This PageData is returned by all endpoints' load function.  | - `user` logged in {@link @crossauth/common!User}                                | *Not provided*                                                   |                                                                  |           |
+ * |                            |                                                             | - `csrfToken` CSRF token if enabled                                              |                                                                  |                                                                  |           |                                                                                  | loginPage                |
+ * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
+ * | searchClientsEndpoint      | Returns a paginated set of clients or those matching search | See {@link SearchClientsPageData}                                                | *Not provided*                                                   |                                                                  |           |
+ * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
+ * | updateClientEndpoint       | Updates a client                                            | See {@link UpdateClientPageData}                                                | `default`:                                                       |                                                                  |           |
+ * |                            |                                                             |                                                                                  | See {@link UpdateClientFormData}                                | See {@link SvelteKitSharedClientEndpoints.updateClient_internal} | client_id  |
+ * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
+ * | createClientEndpoint       | Creates a new client                                        | See {@link CreateClientPageData}                                                | `default`:                                                       |                                                                  |           |
+ * |                            |                                                             |                                                                                  | See {@link CreateClientFormData}                                | See {@link SvelteKitSharedClientEndpoints.createClient_internal} | client_id  |
+ * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
+ * | deleteClientEndpoint       | Deletes a client                                            | See {@link DeleteClientPageData}                                                | `default`:                                                       |                                                                  |           |
+ * |                            |                                                             |                                                                                  | See {@link DeleteClientFormData}                                | See {@link SvelteKitSharedClientEndpoints.deleteClient_internal} | client_id  |
+ * | -------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --------- |
+ */
+export class SvelteKitUserClientEndpoints extends SvelteKitSharedClientEndpoints {
+    /**
+     * Constructor
+     * @param sessionServer the session server which will have these endpoints
+     * @param options See {@link SvelteKitSessionServerOptions}.
+     */
+    constructor(sessionServer, options) {
+        super(sessionServer, options);
+        this.sessionServer = sessionServer;
+        setParameter("loginUrl", ParamType.JsonArray, this, options, "LOGIN_URL");
+        if (options.clientSearchFn)
+            this.clientSearchFn = options.clientSearchFn;
+        this.redirect = options.redirect;
+        this.error = options.error;
+    }
+    ///////////////////////////////////////////////////////////////////
+    // Functions callable from apps
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.searchClients_internal}
+     */
+    async searchClients(event, searchTerm, skip, take) {
+        if (!event.locals.user)
+            throw this.redirect(302, this.loginUrl + "?next=" + encodeURIComponent(event.request.url));
+        return this.searchClients_internal(event, searchTerm, skip, take, event.locals.user?.id);
+    }
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.loadClient_internal}
+     */
+    async loadClient(event) {
+        if (!event.locals.user)
+            throw this.redirect(302, this.loginUrl + "?next=" + encodeURIComponent(event.request.url));
+        // check user owns client
+        try {
+            const client_id = event.params.client_id;
+            if (!client_id)
+                throw new CrossauthError(ErrorCode.BadRequest, "No client ID given");
+            const client = await this.clientStorage?.getClientById(client_id);
+            if (client?.userid != event.locals.user.id)
+                return this.error(401, "Access denied");
+        }
+        catch (e) {
+            if (SvelteKitServer.isSvelteKitRedirect(e) || SvelteKitServer.isSvelteKitError(e))
+                throw e;
+            const ce = CrossauthError.asCrossauthError(e);
+            CrossauthLogger.logger.debug(j({ err: ce }));
+            CrossauthLogger.logger.error(j({ cerr: ce }));
+            return {
+                ok: false,
+                error: ce.message,
+                errorCode: ce.code,
+                errorCodeName: ce.codeName,
+                validFlows: this.validFlows,
+                valid_flowNames: this.valid_flowNames,
+            };
+        }
+        return this.loadClient_internal(event);
+    }
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.updateClient_internal}
+     */
+    async updateClient(event) {
+        if (!event.locals.user)
+            throw this.redirect(302, this.loginUrl + "?next=" + encodeURIComponent(event.request.url));
+        // check user owns client
+        try {
+            const client_id = event.params.client_id;
+            if (!client_id)
+                throw new CrossauthError(ErrorCode.BadRequest, "No client ID given");
+            const client = await this.clientStorage?.getClientById(client_id);
+            if (client?.userid != event.locals.user.id)
+                return this.error(401, "Access denied");
+        }
+        catch (e) {
+            if (SvelteKitServer.isSvelteKitRedirect(e) || SvelteKitServer.isSvelteKitError(e))
+                throw e;
+            const ce = CrossauthError.asCrossauthError(e);
+            CrossauthLogger.logger.debug(j({ err: ce }));
+            CrossauthLogger.logger.error(j({ cerr: ce }));
+            return {
+                ok: false,
+                error: ce.message,
+                errorCode: ce.code,
+                errorCodeName: ce.codeName,
+            };
+        }
+        return this.updateClient_internal(event, false);
+    }
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.loadDeleteClient_internal}
+     */
+    async loadDeleteClient(event) {
+        if (!event.locals.user)
+            throw this.redirect(302, this.loginUrl + "?next=" + encodeURIComponent(event.request.url));
+        // check user owns client
+        try {
+            const client_id = event.params.client_id;
+            if (!client_id)
+                throw new CrossauthError(ErrorCode.BadRequest, "No client ID given");
+            const client = await this.clientStorage?.getClientById(client_id);
+            if (client?.userid != event.locals.user.id)
+                return this.error(401, "Access denied");
+        }
+        catch (e) {
+            if (SvelteKitServer.isSvelteKitRedirect(e) || SvelteKitServer.isSvelteKitError(e))
+                throw e;
+            const ce = CrossauthError.asCrossauthError(e);
+            CrossauthLogger.logger.debug(j({ err: ce }));
+            CrossauthLogger.logger.error(j({ cerr: ce }));
+            return {
+                ok: false,
+                error: ce.message,
+                errorCode: ce.code,
+                errorCodeName: ce.codeName,
+            };
+        }
+        return this.loadDeleteClient_internal(event);
+    }
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.deleteClient_internal}
+     */
+    async deleteClient(event) {
+        if (!event.locals.user)
+            throw this.redirect(302, this.loginUrl + "?next=" + encodeURIComponent(event.request.url));
+        // check user owns client
+        try {
+            const client_id = event.params.client_id;
+            if (!client_id)
+                throw new CrossauthError(ErrorCode.BadRequest, "No client ID given");
+            const client = await this.clientStorage?.getClientById(client_id);
+            if (client?.userid != event.locals.user.id)
+                return this.error(401, "Access denied");
+        }
+        catch (e) {
+            if (SvelteKitServer.isSvelteKitRedirect(e) || SvelteKitServer.isSvelteKitError(e))
+                throw e;
+            const ce = CrossauthError.asCrossauthError(e);
+            CrossauthLogger.logger.debug(j({ err: ce }));
+            CrossauthLogger.logger.error(j({ cerr: ce }));
+            return {
+                ok: false,
+                error: ce.message,
+                errorCode: ce.code,
+                errorCodeName: ce.codeName,
+            };
+        }
+        return this.deleteClient_internal(event, false);
+    }
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.emptyClient_internal}
+     */
+    async emptyClient(event) {
+        if (!event.locals.user)
+            throw this.redirect(302, this.loginUrl + "?next=" + encodeURIComponent(event.request.url));
+        return this.emptyClient_internal(event, false);
+    }
+    /**
+     * See {@link SvelteKitSharedClientEndpoints.createClient_internal}
+     */
+    async createClient(event) {
+        if (!event.locals.user)
+            throw this.redirect(302, this.loginUrl + "?next=" + encodeURIComponent(event.request.url));
+        return this.createClient_internal(event, false);
+    }
+    /////////////////////////////////////////////////////////////////
+    // Endpoints
+    /**
+     * See class documentation.
+     */
+    searchClientsEndpoint = {
+        load: async (event) => {
+            const resp = await this.searchClients(event);
+            return {
+                ...this.baseEndpoint(event),
+                ...resp,
+            };
+        },
+    };
+    /**
+     * See class documentation.
+     */
+    updateClientEndpoint = {
+        load: async (event) => {
+            const resp = await this.loadClient(event);
+            return {
+                ...this.baseEndpoint(event),
+                ...resp,
+            };
+        },
+        actions: {
+            default: async (event) => {
+                let resp = await this.updateClient(event);
+                return resp;
+            }
+        }
+    };
+    /**
+     * See class documentation.
+     */
+    createClientEndpoint = {
+        load: async (event) => {
+            const resp = await this.emptyClient(event);
+            return {
+                ...this.baseEndpoint(event),
+                ...resp,
+            };
+        },
+        actions: {
+            default: async (event) => {
+                let resp = await this.createClient(event);
+                return resp;
+            }
+        }
+    };
+    /**
+     * See class documentation.
+     */
+    deleteClientEndpoint = {
+        load: async (event) => {
+            const resp = await this.loadDeleteClient(event);
+            return {
+                ...this.baseEndpoint(event),
+                ...resp,
+            };
+        },
+        actions: {
+            default: async (event) => {
+                let resp = await this.deleteClient(event);
+                return resp;
+            }
+        }
+    };
+}
+;

package/dist/sveltekituserendpoints.d.ts

@@ -1,8 +1,9 @@
-import { SveltekitEndpoint } from './sveltekitserver';
-import { SvelteKitSessionServer, SvelteKitSessionServerOptions } from './sveltekitsession';
-import { User, UserInputFields, ErrorCode } from '@crossauth/common';
-import { RequestEvent } from '@sveltejs/kit';
-
+import { type SveltekitEndpoint } from './sveltekitserver';
+import { SvelteKitSessionServer } from './sveltekitsession';
+import type { SvelteKitSessionServerOptions } from './sveltekitsession';
+import type { User, UserInputFields } from '@crossauth/common';
+import { ErrorCode } from '@crossauth/common';
+import type { RequestEvent } from '@sveltejs/kit';
 /**
  * Return type for {@link SvelteKitUserEndpoints.login},
  * {@link SvelteKitUserEndpoints.loginFactor2} and the