@sourceregistry/sveltekit-oidc 1.4.0 → 1.5.0

package/README.md

@@ -12,14 +12,14 @@ OIDC authentication helpers for SvelteKit with:
 ## Install
 
 ```sh
-npm install sveltekit-oidc
+npm install @sourceregistry/sveltekit-oidc
 ```
 
 ## Server Setup
 
 ```ts
 // src/lib/server/auth.ts
-import { createOIDC } from 'sveltekit-oidc/server';
+import { createOIDC } from '@sourceregistry/sveltekit-oidc/server';
 
 export const oidc = createOIDC({
 	issuer: 'https://your-idp.example.com',
@@ -104,7 +104,7 @@ export async function load(event) {
 
 ```html
 <script lang="ts">
-	import { OIDCContext } from 'sveltekit-oidc';
+	import { OIDCContext } from '@sourceregistry/sveltekit-oidc';
 	let { data } = $props();
 </script>
 
@@ -122,7 +122,7 @@ export async function load(event) {
 ```html
 <!-- src/lib/Account.svelte -->
 <script lang="ts">
-	import { useOIDC } from 'sveltekit-oidc';
+	import { useOIDC } from '@sourceregistry/sveltekit-oidc';
 
 	const oidc = useOIDC();
 </script>
@@ -170,7 +170,7 @@ Wire `App.Locals` so `event.locals.oidc` is fully typed everywhere — `OIDCLoca
 
 ```ts
 // src/app.d.ts
-import type { OIDCLocals } from 'sveltekit-oidc/server';
+import type { OIDCLocals } from '@sourceregistry/sveltekit-oidc/server';
 import { oidc } from '$lib/server/auth';
 
 declare global {
@@ -186,21 +186,12 @@ export {};
 
 Now `event.locals.oidc?.claims?.roles` is `string[]` and `?.tenant` is `string | undefined` in every hook, load function, and action — no separate type aliases needed.
 
-When you need the claim type explicitly (e.g. in a Svelte component), use `OIDCInferClaims`:
-
-```ts
-import type { OIDCInferClaims } from 'sveltekit-oidc/server';
-import { oidc } from '$lib/server/auth';
-
-type AppClaims = OIDCInferClaims<typeof oidc>;
-```
-
-`OIDCContext` is a generic component, but Svelte doesn't support passing explicit type arguments in markup — `TClaims` is inferred from the `session` prop instead. Since `data.session` comes from `oidc.getPublicSession(event)`, it's already typed `OIDCPublicSession<AppClaims> | null`, so the inference flows through automatically:
+`OIDCContext` is a generic component, but Svelte doesn't support passing explicit type arguments in markup — `TClaims` is inferred from the `session` prop instead. Since `data.session` comes from `oidc.getPublicSession(event)`, the type flows through automatically:
 
 ```html
 <!-- src/routes/+layout.svelte -->
 <script lang="ts">
-	import { OIDCContext } from 'sveltekit-oidc';
+	import { OIDCContext } from '@sourceregistry/sveltekit-oidc';
 	let { data, children } = $props();
 </script>
 
@@ -212,14 +203,13 @@ type AppClaims = OIDCInferClaims<typeof oidc>;
 ```html
 <!-- src/lib/Account.svelte -->
 <script lang="ts">
-	import { useOIDC } from 'sveltekit-oidc';
-	import type { AppClaims } from '../../app.d.ts';
+	import { useOIDC } from '@sourceregistry/sveltekit-oidc';
 
-	const oidc = useOIDC<AppClaims>();
+	const auth = useOIDC(); // TClaims inferred from App.Locals.oidc
 </script>
 
-{#if oidc.isAuthenticated}
-	<p>Roles: {oidc.claims?.roles.join(', ')}</p>
+{#if auth.isAuthenticated}
+	<p>Roles: {auth.claims?.roles.join(', ')}</p>
 {/if}
 ```
 
@@ -231,8 +221,9 @@ Backend apps commonly stash application-specific data on the session itself (e.g
 
 ```ts
 // src/lib/server/auth.ts
-import { createOIDC, type OIDCSession } from 'sveltekit-oidc/server';
+import { createOIDC, type OIDCSession, type OIDCUserClaims } from '@sourceregistry/sveltekit-oidc/server';
 
+type AppClaims = OIDCUserClaims & { tenant?: string };
 type AppSession = OIDCSession<AppClaims> & {
 	tenantId: string;
 	permissions: string[];
@@ -255,7 +246,7 @@ export const oidc = createOIDC({
 
 ```ts
 // src/app.d.ts
-import type { OIDCLocals } from 'sveltekit-oidc/server';
+import type { OIDCLocals } from '@sourceregistry/sveltekit-oidc/server';
 import { oidc } from '$lib/server/auth';
 
 declare global {
@@ -271,11 +262,11 @@ export {};
 
 Now `event.locals.oidc?.session?.tenantId` is `string` and `?.permissions` is `string[]` everywhere — and `oidc.requireAuth(event)` / `handleCallback`'s `onsuccess` resolve to `AppSession` directly.
 
-Use `OIDCInferClaims` / `OIDCInferSession` when you need the types explicitly:
+Use `OIDCInferClaims` / `OIDCInferSession` when you need the types explicitly in non-Svelte code (utility functions, API helpers, etc.):
 
 ```ts
-import type { OIDCInferClaims, OIDCInferSession } from 'sveltekit-oidc/server';
-import { oidc } from '$lib/server/auth';
+import type { OIDCInferClaims, OIDCInferSession } from '@sourceregistry/sveltekit-oidc/server';
+import type { oidc } from '$lib/server/auth';
 
 type AppClaims = OIDCInferClaims<typeof oidc>;
 type AppSession = OIDCInferSession<typeof oidc>;

package/dist/client/context.d.ts

@@ -1,4 +1,7 @@
-import type { OIDCDiscoveryDocument, OIDCPublicSession, OIDCUserClaims } from '../server/index.js';
+import type { OIDCDiscoveryDocument, OIDCHandleLocals, OIDCPublicSession, OIDCUserClaims } from '../server/index.js';
+type LocalsClaims = App.Locals extends {
+    oidc?: OIDCHandleLocals<infer C, any>;
+} ? C : OIDCUserClaims;
 export type OIDCClientContextValue<TClaims extends OIDCUserClaims = OIDCUserClaims> = {
     isAuthenticated: boolean;
     session: OIDCPublicSession<TClaims> | null;
@@ -12,5 +15,6 @@ export type OIDCClientContextValue<TClaims extends OIDCUserClaims = OIDCUserClai
     revalidate: () => Promise<void>;
 };
 export declare function setOIDCContext<TClaims extends OIDCUserClaims = OIDCUserClaims>(value: OIDCClientContextValue<TClaims>): OIDCClientContextValue<TClaims>;
-export declare function getOIDCContext<TClaims extends OIDCUserClaims = OIDCUserClaims>(): OIDCClientContextValue<TClaims>;
-export declare function useOIDC<TClaims extends OIDCUserClaims = OIDCUserClaims>(): OIDCClientContextValue<TClaims>;
+export declare function getOIDCContext<TClaims extends OIDCUserClaims = LocalsClaims>(): OIDCClientContextValue<TClaims>;
+export declare function useOIDC<TClaims extends OIDCUserClaims = LocalsClaims>(): OIDCClientContextValue<TClaims>;
+export {};

package/dist/client/index.d.ts

@@ -1,3 +1,3 @@
 export { default as OIDCContext } from './OIDCContext.svelte';
 export { getOIDCContext, useOIDC } from './context.js';
-export type { OIDCPublicSession, OIDCSessionManagementConfig, OIDCUserClaims } from '../server/index.js';
+export type { OIDCInferClaims, OIDCInferSession, OIDCLocals, OIDCPublicSession, OIDCSessionManagementConfig, OIDCUserClaims } from '../server/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sourceregistry/sveltekit-oidc",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "OIDC authentication helpers for SvelteKit applications",
   "license": "Apache-2.0",
   "scripts": {