@crossauth/sveltekit 1.1.0 → 1.1.2

package/dist/sveltekitsessionadapter.d.ts

@@ -1,6 +1,5 @@
-import { RequestEvent } from '@sveltejs/kit';
-import { User } from '@crossauth/common';
-
+import type { RequestEvent } from '@sveltejs/kit';
+import type { User } from '@crossauth/common';
 export declare abstract class SvelteKitSessionAdapter {
     abstract csrfProtectionEnabled(): boolean;
     abstract getCsrfToken(event: RequestEvent): string | undefined;

package/dist/sveltekitsessionadapter.js

@@ -0,0 +1,2 @@
+export class SvelteKitSessionAdapter {
+}

package/dist/sveltekitsharedclientendpoints.d.ts

@@ -1,15 +1,23 @@
-import { SvelteKitSessionServer, SvelteKitSessionServerOptions } from './sveltekitsession';
-import { OAuthClientManager, OAuthClientStorage } from '@crossauth/backend';
-import { OAuthClient } from '@crossauth/common';
-import { RequestEvent } from '@sveltejs/kit';
-
+import { SvelteKitSessionServer } from './sveltekitsession';
+import type { SvelteKitSessionServerOptions } from './sveltekitsession';
+import { OAuthClientManager } from '@crossauth/backend';
+import type { OAuthClientStorage } from '@crossauth/backend';
+import type { User, OAuthClient } from '@crossauth/common';
+import type { RequestEvent } from '@sveltejs/kit';
+/**
+ * Base class for all PageData
+ */
+export interface BasePageData {
+    user?: User;
+    csrfToken?: string;
+}
 /**
  * Return type for {@link SvelteKitUserClientEndpoints.searchClients}
  *  {@link SvelteKitAdminClientEndpoints.searchClients} load.
  *
  * See class documentation for {@link SvelteKitSharedClientEndpoints} for more details.
  */
-export type SearchClientsPageData = {
+export interface SearchClientsPageData extends BasePageData {
     ok: boolean;
     clients?: OAuthClient[];
     skip: number;
@@ -21,34 +29,34 @@ export type SearchClientsPageData = {
     hasPrevious: boolean;
     hasNext: boolean;
     clientUserId?: string | number;
-};
+}
 /**
  * Return type for {@link SvelteKitUserClientEndpoints.updateClientEndpoint}
  *  {@link SvelteKitAdminClientEndpoints.updateClientEndpoint} load.
  *
  * See class documentation for {@link SvelteKitSharedClientEndpoints} for more details.
  */
-export type UpdateClientPageData = {
-    ok: boolean;
+export interface UpdateClientPageData extends BasePageData {
+    ok?: boolean;
     client?: OAuthClient;
     client_id?: string;
     clientUsername?: string;
     error?: string;
     errorCode?: number;
     errorCodeName?: string;
-    validFlows: string[];
-    valid_flowNames: {
+    validFlows?: string[];
+    valid_flowNames?: {
         [key: string]: string;
     };
-};
+}
 /**
  * Return type for {@link SvelteKitUserClientEndpoints.updateClientEndpoint}
  *  {@link SvelteKitAdminClientEndpoints.updateClientEndpoint} actions.
  *
  * See class documentation for {@link SvelteKitSharedClientEndpoints} for more details.
  */
-export type UpdateClientFormData = {
-    ok: boolean;
+export interface UpdateClientActionData {
+    ok?: boolean;
     client?: OAuthClient;
     error?: string;
     errorCode?: number;
@@ -57,14 +65,14 @@ export type UpdateClientFormData = {
         [key: string]: string;
     };
     plaintextSecret?: string;
-};
+}
 /**
  * Return type for {@link SvelteKitUserClientEndpoints.createClientEndpoint}
  *  {@link SvelteKitAdminClientEndpoints.createClient} load.
  *
  * See class documentation for {@link SvelteKitSharedClientEndpoints} for more details.
  */
-export type CreateClientPageData = {
+export interface CreateClientPageData extends BasePageData {
     ok: boolean;
     clientUserId?: string | number;
     clientUsername?: string;
@@ -75,14 +83,14 @@ export type CreateClientPageData = {
     valid_flowNames: {
         [key: string]: string;
     };
-};
+}
 /**
  * Return type for {@link SvelteKitUserClientEndpoints.createClientEndpoint}
  *  {@link SvelteKitAdminClientEndpoints.createClientEndpoint} actions.
  *
  * See class documentation for {@link SvelteKitSharedClientEndpoints} for more details.
  */
-export type CreateClientFormData = {
+export type CreateClientActionData = {
     ok: boolean;
     client?: OAuthClient;
     error?: string;
@@ -98,23 +106,23 @@ export type CreateClientFormData = {
  *
  * See class documentation for {@link SvelteKitSharedClientEndpoints} for more details.
  */
-export type DeleteClientPageData = {
-    ok: boolean;
+export interface DeleteClientPageData extends BasePageData {
+    ok?: boolean;
     client?: OAuthClient;
     client_id?: string;
     clientUsername?: string;
     error?: string;
     errorCode?: number;
     errorCodeName?: string;
-};
+}
 /**
  * Return type for {@link SvelteKitUserClientEndpoints.deleteClientEndpoint}
  *  {@link SvelteKitAdminClientEndpoints.deleteClientEndpoint} actions.
  *
  * See class documentation for {@link SvelteKitSharedClientEndpoints} for more details.
  */
-export type DeleteClientFormData = {
-    ok: boolean;
+export type DeleteClientActionData = {
+    ok?: boolean;
     error?: string;
     errorCode?: number;
     errorCodeName?: string;
@@ -242,9 +250,9 @@ export declare class SvelteKitSharedClientEndpoints {
      *   - `confidential` from the body form data: 1, `on`, `yes` or `true` are true
      *   _ `resetSecret` if true (1, `on`, `yes` or `true`), create and return a new secret.  Ignored if not confidential
      *   - Flow names from {@link @crossauth/common!OAuthFlows} taken from the body form data.  1, `on`, `yes` or `true` are true
-     * @returns {@link UpdateClientFormData}.  If a new secret was created, it will be placed as plaintext in the client that is returned.
+     * @returns {@link UpdateClientActionData}.  If a new secret was created, it will be placed as plaintext in the client that is returned.
      */
-    protected updateClient_internal(event: RequestEvent, isAdmin: boolean): Promise<UpdateClientFormData>;
+    protected updateClient_internal(event: RequestEvent, isAdmin: boolean): Promise<UpdateClientActionData>;
     /**
      * The base class of the load function for creating an OAuth client.
      *
@@ -263,9 +271,9 @@ export declare class SvelteKitSharedClientEndpoints {
      *   - `redirect_uri` from the body form data (space-separated)
      *   - `confidential` from the body form data: 1, `on`, `yes` or `true` are true
      *   - Flow names from {@link @crossauth/common!OAuthFlows} taken from the body form data.  1, `on`, `yes` or `true` are true
-     * @returns {@link UpdateClientFormData}.  If a secret was created, it will be placed as plaintext in the client that is returned.  A random `client_id` is created.
+     * @returns {@link UpdateClientActionData}.  If a secret was created, it will be placed as plaintext in the client that is returned.  A random `client_id` is created.
      */
-    protected createClient_internal(event: RequestEvent, isAdmin: boolean): Promise<CreateClientFormData>;
+    protected createClient_internal(event: RequestEvent, isAdmin: boolean): Promise<CreateClientActionData>;
     /**
      * The base class of the load function for deleting an OAuth client.
      *
@@ -279,9 +287,9 @@ export declare class SvelteKitSharedClientEndpoints {
      *
      * @param event the Sveltekit request event.  The following are taken:
      *   - `client_id` from the URL path parameters
-     * @returns {@link DeleteClientFormData}
+     * @returns {@link DeleteClientActionData}
      */
-    protected deleteClient_internal(event: RequestEvent, isAdmin: boolean): Promise<DeleteClientFormData>;
+    protected deleteClient_internal(event: RequestEvent, isAdmin: boolean): Promise<DeleteClientActionData>;
     /**
      * Returned by all endpoitns
      * @param event the sveltekit request event
@@ -290,7 +298,7 @@ export declare class SvelteKitSharedClientEndpoints {
      *   - `csrfToken` the CSRF token if using
      */
     baseEndpoint(event: RequestEvent): {
-        user: import('@crossauth/common').User | undefined;
+        user: User | undefined;
         csrfToken: string | undefined;
     };
 }