@withstudiocms/auth-kit 0.1.0-beta.5 → 0.1.0

package/dist/errors.d.ts

@@ -155,4 +155,12 @@ export declare const useUserError: <A>(_try: () => A) => Effect.Effect<A, UserEr
  * @returns An `Effect` that resolves with the value of type `A` or fails with a `UserError`.
  */
 export declare const useUserErrorPromise: <A>(_try: () => Promise<A>) => Effect.Effect<A, UserError>;
+declare const AuthKitError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }) => import("effect/Cause").YieldableError & {
+    readonly _tag: "AuthKitError";
+} & Readonly<A>;
+export declare class AuthKitError extends AuthKitError_base<{
+    message: string;
+    cause?: unknown;
+}> {
+}
 export {};

package/dist/errors.js

@@ -43,7 +43,10 @@ const useUserErrorPromise = (_try) => Effect.tryPromise({
   try: _try,
   catch: (cause) => new UserError({ cause })
 });
+class AuthKitError extends Data.TaggedError("AuthKitError") {
+}
 export {
+  AuthKitError,
   CheckIfUnsafeError,
   DecryptionError,
   EncryptionError,

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { Effect } from '@withstudiocms/effect';
 import { AuthKitOptions, PasswordModConfigFinal, type RawAuthKitConfig } from './config.js';
+import { AuthKitError } from './errors.js';
 export { Password } from './modules/password.js';
 /**
  * Creates a scrypt password hashing utility using the provided scrypt configuration.
@@ -9,7 +10,7 @@ export { Password } from './modules/password.js';
  */
 export declare const makeScrypt: (config: PasswordModConfigFinal) => Effect.Effect<Effect.Effect<{
     run: (password: import("crypto").BinaryLike) => Effect.Effect<Buffer<ArrayBufferLike>, import("@withstudiocms/effect/scrypt").ScryptError, never>;
-}, never, never>, Error, never>;
+}, never, never>, AuthKitError, never>;
 declare const AuthKit_base: Effect.Service.Class<AuthKit, "@withstudiocms/AuthKit", {
     readonly effect: Effect.Effect<{
         readonly Encryption: Effect.Effect<{
@@ -36,55 +37,19 @@ declare const AuthKit_base: Effect.Service.Class<AuthKit, "@withstudiocms/AuthKi
         readonly User: Effect.Effect<{
             readonly verifyUsernameInput: (username: string) => Effect.Effect<string | true, import("./errors.js").CheckIfUnsafeError | import("./errors.js").UserError, never>;
             readonly createUserAvatar: (email: string) => Effect.Effect<string, import("./errors.js").UserError, never>;
-            readonly createLocalUser: (name: string, username: string, email: string, password: string) => Effect.Effect<{
-                name: string;
-                username: string;
-                id: string;
-                url: string | null;
-                email: string | null;
-                avatar: string | null;
-                password: string | null;
-                updatedAt: Date | null;
-                createdAt: Date | null;
-                emailVerified: boolean;
-                notifications: string | null;
-            }, import("@withstudiocms/effect/scrypt").ScryptError | import("./errors.js").UserError, never>;
-            readonly createOAuthUser: (data: import("./types.js").UserData, oAuthFields: {
+            readonly createLocalUser: (name: string, username: string, email: string, password: string) => Effect.Effect<import("./types.js").UserData, import("@withstudiocms/effect/scrypt").ScryptError | import("./errors.js").UserError, never>;
+            readonly createOAuthUser: (data: import("./types.js").UserDataInsert, oAuthFields: {
                 provider: string;
                 providerUserId: string;
-            }) => Effect.Effect<{
-                name: string;
-                username: string;
-                id: string;
-                url: string | null;
-                email: string | null;
-                avatar: string | null;
-                password: string | null;
-                updatedAt: Date | null;
-                createdAt: Date | null;
-                emailVerified: boolean;
-                notifications: string | null;
-            }, import("./errors.js").UserError, never>;
-            readonly updateUserPassword: (userId: string, password: string) => Effect.Effect<{
-                name: string;
-                username: string;
-                id: string;
-                url: string | null;
-                email: string | null;
-                avatar: string | null;
-                password: string | null;
-                updatedAt: Date | null;
-                createdAt: Date | null;
-                emailVerified: boolean;
-                notifications: string | null;
-            }, import("@withstudiocms/effect/scrypt").ScryptError | import("./errors.js").UserError, never>;
+            }) => Effect.Effect<import("./types.js").UserData, import("./errors.js").UserError, never>;
+            readonly updateUserPassword: (userId: string, password: string) => Effect.Effect<import("./types.js").UserData, import("@withstudiocms/effect/scrypt").ScryptError | import("./errors.js").UserError, never>;
             readonly getUserPasswordHash: (userId: string) => Effect.Effect<string, import("./errors.js").UserError, never>;
             readonly getUserFromEmail: (email: string) => Effect.Effect<import("./types.js").CombinedUserData | null | undefined, import("./errors.js").UserError, never>;
             readonly getUserData: (context: import("astro").APIContext<Record<string, any>, Record<string, string | undefined>> | import("astro").AstroGlobal<Record<string, any>, import("astro/runtime/server/index.js").AstroComponentFactory, Record<string, string | undefined>>) => Effect.Effect<import("./types.js").UserSessionData, import("./errors.js").SessionError | import("./errors.js").UserError, never>;
             readonly getUserPermissionLevel: (userData: import("./types.js").UserSessionData | import("./types.js").CombinedUserData | null) => Effect.Effect<import("./types.js").UserPermissionLevel, import("./errors.js").UserError, never>;
             readonly isUserAllowed: (userData: import("./types.js").UserSessionData | import("./types.js").CombinedUserData | null, requiredPerms: "owner" | "admin" | "editor" | "visitor" | "unknown") => Effect.Effect<boolean, import("./errors.js").UserError, never>;
         }, import("./errors.js").SessionError | import("./errors.js").UserError, never>;
-    }, Error, AuthKitOptions>;
+    }, AuthKitError, AuthKitOptions>;
 }>;
 /**
  * The `AuthKit` service provides a collection of authentication utilities for use within the

package/dist/index.js

@@ -1,6 +1,7 @@
 import { Effect } from "@withstudiocms/effect";
 import { Scrypt as _Scrypt } from "@withstudiocms/effect/scrypt";
 import { AuthKitOptions, PasswordModConfigFinal } from "./config.js";
+import { AuthKitError } from "./errors.js";
 import { _Encryption, _Password, _Session, _User } from "./modules/index.js";
 import { Password } from "./modules/password.js";
 const makeScrypt = Effect.fn(
@@ -9,7 +10,10 @@ const makeScrypt = Effect.fn(
       const { run } = yield* _Scrypt;
       return { run };
     }).pipe(Effect.provide(_Scrypt.makeLive(config.scrypt))),
-    catch: (error) => new Error(`Failed to create Scrypt instance: ${error.message}`)
+    catch: (error) => new AuthKitError({
+      message: `Failed to create Scrypt instance: ${error.message}`,
+      cause: error
+    })
   })
 );
 class AuthKit extends Effect.Service()("@withstudiocms/AuthKit", {

package/dist/modules/session.js

@@ -8,21 +8,19 @@ const Session = (config) => Effect.gen(function* () {
     ...config
   };
   if (!sessionTools) {
-    return yield* Effect.fail(
-      new SessionError({ cause: "Session tools must be provided in the configuration" })
-    );
+    return yield* new SessionError({
+      cause: "Session tools must be provided in the configuration"
+    });
   }
   if (!Number.isFinite(expTime) || expTime <= 0) {
-    return yield* Effect.fail(
-      new SessionError({
-        cause: "Invalid session config: expTime must be a positive number (ms)"
-      })
-    );
+    return yield* new SessionError({
+      cause: "Invalid session config: expTime must be a positive number (ms)"
+    });
   }
   if (typeof cookieName !== "string" || cookieName.trim().length === 0) {
-    return yield* Effect.fail(
-      new SessionError({ cause: "Invalid session config: cookieName must be a non-empty string" })
-    );
+    return yield* new SessionError({
+      cause: "Invalid session config: cookieName must be a non-empty string"
+    });
   }
   const expTimeHalf = expTime / 2;
   const defaultSecure = process.env.NODE_ENV === "production";
@@ -55,13 +53,9 @@ const Session = (config) => Effect.gen(function* () {
       session: null,
       user: null
     };
-    const result = yield* useSessionErrorPromise(
+    const userSession = yield* useSessionErrorPromise(
       () => sessionTools.sessionAndUserData(sessionId)
     );
-    if (!result.length) {
-      return nullSession;
-    }
-    const userSession = result[0];
     if (!userSession) {
       return nullSession;
     }

package/dist/modules/user.d.ts

@@ -1,7 +1,7 @@
 import { Effect } from '@withstudiocms/effect';
 import type { APIContext, AstroGlobal } from 'astro';
 import { UserError } from '../errors.js';
-import type { CombinedUserData, UserConfig, UserData, UserSessionData } from '../types.js';
+import type { CombinedUserData, UserConfig, UserDataInsert, UserSessionData } from '../types.js';
 import { UserPermissionLevel } from '../types.js';
 /**
  * Factory function to create user-related operations for authentication and user management.
@@ -35,48 +35,12 @@ import { UserPermissionLevel } from '../types.js';
 export declare const User: ({ Scrypt, session, userTools }: UserConfig) => Effect.Effect<{
     readonly verifyUsernameInput: (username: string) => Effect.Effect<string | true, import("../errors.js").CheckIfUnsafeError | UserError, never>;
     readonly createUserAvatar: (email: string) => Effect.Effect<string, UserError, never>;
-    readonly createLocalUser: (name: string, username: string, email: string, password: string) => Effect.Effect<{
-        name: string;
-        username: string;
-        id: string;
-        url: string | null;
-        email: string | null;
-        avatar: string | null;
-        password: string | null;
-        updatedAt: Date | null;
-        createdAt: Date | null;
-        emailVerified: boolean;
-        notifications: string | null;
-    }, import("@withstudiocms/effect/scrypt").ScryptError | UserError, never>;
-    readonly createOAuthUser: (data: UserData, oAuthFields: {
+    readonly createLocalUser: (name: string, username: string, email: string, password: string) => Effect.Effect<import("../types.js").UserData, import("@withstudiocms/effect/scrypt").ScryptError | UserError, never>;
+    readonly createOAuthUser: (data: UserDataInsert, oAuthFields: {
         provider: string;
         providerUserId: string;
-    }) => Effect.Effect<{
-        name: string;
-        username: string;
-        id: string;
-        url: string | null;
-        email: string | null;
-        avatar: string | null;
-        password: string | null;
-        updatedAt: Date | null;
-        createdAt: Date | null;
-        emailVerified: boolean;
-        notifications: string | null;
-    }, UserError, never>;
-    readonly updateUserPassword: (userId: string, password: string) => Effect.Effect<{
-        name: string;
-        username: string;
-        id: string;
-        url: string | null;
-        email: string | null;
-        avatar: string | null;
-        password: string | null;
-        updatedAt: Date | null;
-        createdAt: Date | null;
-        emailVerified: boolean;
-        notifications: string | null;
-    }, import("@withstudiocms/effect/scrypt").ScryptError | UserError, never>;
+    }) => Effect.Effect<import("../types.js").UserData, UserError, never>;
+    readonly updateUserPassword: (userId: string, password: string) => Effect.Effect<import("../types.js").UserData, import("@withstudiocms/effect/scrypt").ScryptError | UserError, never>;
     readonly getUserPasswordHash: (userId: string) => Effect.Effect<string, UserError, never>;
     readonly getUserFromEmail: (email: string) => Effect.Effect<CombinedUserData | null | undefined, UserError, never>;
     readonly getUserData: (context: APIContext<Record<string, any>, Record<string, string | undefined>> | AstroGlobal<Record<string, any>, import("astro/runtime/server/index.js").AstroComponentFactory, Record<string, string | undefined>>) => Effect.Effect<UserSessionData, import("../errors.js").SessionError | UserError, never>;

package/dist/modules/user.js

@@ -15,7 +15,7 @@ import { Session as _Session } from "./session.js";
 const User = ({ Scrypt, session, userTools }) => Effect.gen(function* () {
   const [Password, Session] = yield* Effect.all([_Password(Scrypt), _Session(session)]);
   if (!userTools) {
-    return yield* Effect.fail(new UserError({ cause: "User tools are not available" }));
+    return yield* new UserError({ cause: "User tools are not available" });
   }
   const notifier = userTools.notifier;
   const verifyUsernameInput = Effect.fn(
@@ -43,7 +43,7 @@ const User = ({ Scrypt, session, userTools }) => Effect.gen(function* () {
         createUserAvatar(email),
         useUserError(() => userTools.idGenerator())
       ]);
-      const createdAt = /* @__PURE__ */ new Date();
+      const createdAt = (/* @__PURE__ */ new Date()).toISOString();
       const createdUser = yield* useUserErrorPromise(
         () => userTools.createLocalUser({
           id,
@@ -83,8 +83,24 @@ const User = ({ Scrypt, session, userTools }) => Effect.gen(function* () {
   const updateUserPassword = Effect.fn("@withstudiocms/AuthKit/modules/user.updateUserPassword")(
     function* (userId, password) {
       const newHash = yield* Password.hashPassword(password);
+      const data = yield* useUserErrorPromise(() => userTools.getUserById(userId));
+      if (!data) {
+        return yield* new UserError({ cause: "User not found" });
+      }
+      const { avatar, email, emailVerified, name, notifications, id, username, url } = data;
       return yield* useUserErrorPromise(
-        () => userTools.updateLocalUser(userId, { password: newHash })
+        () => userTools.updateLocalUser(userId, {
+          avatar,
+          email,
+          emailVerified,
+          name,
+          notifications,
+          id,
+          updatedAt: (/* @__PURE__ */ new Date()).toISOString(),
+          username,
+          url,
+          password: newHash
+        })
       );
     }
   );
@@ -92,9 +108,8 @@ const User = ({ Scrypt, session, userTools }) => Effect.gen(function* () {
     "@withstudiocms/AuthKit/modules/user.getUserPasswordHash"
   )(function* (userId) {
     const user = yield* useUserErrorPromise(() => userTools.getUserById(userId));
-    if (!user) return yield* Effect.fail(new UserError({ cause: "User not found" }));
-    if (!user.password)
-      return yield* Effect.fail(new UserError({ cause: "User has no password" }));
+    if (!user) return yield* new UserError({ cause: "User not found" });
+    if (!user.password) return yield* new UserError({ cause: "User has no password" });
     return user.password;
   });
   const getUserFromEmail = Effect.fn("@withstudiocms/AuthKit/modules/user.getUserFromEmail")(

package/dist/types.d.ts

@@ -35,17 +35,30 @@ export interface UserSession {
  * @property notifications - Notification settings or preferences for the user, or null if not set.
  */
 export interface UserData {
-    name: string;
-    username: string;
-    id?: string | undefined;
-    url?: string | null | undefined;
-    email?: string | null | undefined;
-    avatar?: string | null | undefined;
-    password?: string | null | undefined;
-    updatedAt?: Date | null | undefined;
-    createdAt?: Date | null | undefined;
-    emailVerified?: boolean | undefined;
-    notifications?: string | null | undefined;
+    readonly username: string;
+    readonly password?: string | null | undefined;
+    readonly name: string;
+    readonly notifications?: string | null | undefined;
+    readonly id: string;
+    readonly updatedAt: Date;
+    readonly url?: string | null | undefined;
+    readonly email?: string | null | undefined;
+    readonly avatar?: string | null | undefined;
+    readonly createdAt: Date;
+    readonly emailVerified: boolean;
+}
+export interface UserDataInsert {
+    readonly username: string;
+    readonly password?: string | null | undefined;
+    readonly name: string;
+    readonly notifications?: string | null | undefined;
+    readonly id: string;
+    readonly updatedAt: string;
+    readonly url?: string | null | undefined;
+    readonly email?: string | null | undefined;
+    readonly avatar?: string | null | undefined;
+    readonly createdAt: string | undefined;
+    readonly emailVerified: boolean;
 }
 /**
  * Represents the data associated with an OAuth authentication event.
@@ -87,9 +100,6 @@ export interface PermissionsData {
     user: string;
     rank: AvailablePermissionRanks;
 }
-type Present<T> = {
-    [K in keyof T]-?: Exclude<T[K], undefined>;
-};
 /**
  * Represents the session data for a user.
  *
@@ -99,7 +109,7 @@ type Present<T> = {
  */
 export type UserSessionData = {
     isLoggedIn: boolean;
-    user: Present<UserData> | null;
+    user: UserData | null;
     permissionLevel: AvailablePermissionRanks;
 };
 /**
@@ -121,7 +131,7 @@ export interface CombinedUserData extends UserData {
  */
 export interface SessionAndUserData {
     session: UserSession;
-    user: Present<UserData>;
+    user: UserData;
 }
 /**
  * Represents the result of validating a session.
@@ -143,9 +153,9 @@ export type SessionValidationResult = SessionAndUserData | {
  */
 export interface SessionTools {
     createSession(params: UserSession): Promise<UserSession>;
-    sessionAndUserData(sessionId: string): Promise<SessionAndUserData[]>;
+    sessionAndUserData(sessionId: string): Promise<SessionAndUserData | undefined>;
     deleteSession(sessionId: string): Promise<void>;
-    updateSession(sessionId: string, data: UserSession): Promise<UserSession[]>;
+    updateSession(sessionId: string, data: UserSession): Promise<UserSession>;
 }
 /**
  * Configuration options for managing user sessions.
@@ -171,7 +181,7 @@ export interface UserTools {
     notifier?: {
         admin(type: 'new_user', message: string): Promise<void>;
     };
-    createLocalUser(data: UserData): Promise<Present<UserData>>;
+    createLocalUser(data: UserDataInsert): Promise<UserData>;
     createOAuthUser(data: {
         provider: string;
         providerUserId: string;
@@ -181,7 +191,7 @@ export interface UserTools {
         provider: string;
         providerUserId: string;
     }>;
-    updateLocalUser(id: string, data: Partial<UserData>): Promise<Present<UserData>>;
+    updateLocalUser(id: string, data: Omit<UserDataInsert, 'createdAt'>): Promise<UserData>;
     getUserById(id: string): Promise<CombinedUserData | undefined | null>;
     getUserByEmail(email: string): Promise<CombinedUserData | undefined | null>;
     getCurrentPermissions(userId: string): Promise<PermissionsData | undefined | null>;
@@ -217,4 +227,3 @@ export declare enum UserPermissionLevel {
 }
 export declare const rankToLevel: Record<AvailablePermissionRanks, UserPermissionLevel>;
 export declare const levelToRank: Record<UserPermissionLevel, AvailablePermissionRanks>;
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@withstudiocms/auth-kit",
-  "version": "0.1.0-beta.5",
+  "version": "0.1.0",
   "description": "Utilities for managing authentication",
   "author": {
     "name": "withstudiocms",
@@ -59,7 +59,7 @@
     "@oslojs/binary": "^1.0.0",
     "@oslojs/crypto": "^1.0.1",
     "@oslojs/encoding": "^1.1.0",
-    "@withstudiocms/effect": "0.1.0-beta.6"
+    "@withstudiocms/effect": "0.1.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0"
@@ -74,6 +74,8 @@
     "build": "pnpm update:lists && pnpm buildkit build 'src/**/*.{ts,astro,css,json,png}'",
     "dev": "pnpm update:lists && pnpm buildkit dev 'src/**/*.{ts,astro,css,json,png}'",
     "test": "vitest",
+    "effect-check": "pnpm effect-language-service diagnostics --project tsconfig.tspc.json",
+    "ci:effect-check": "pnpm effect-check --format github-actions",
     "typecheck": "tspc -p tsconfig.tspc.json"
   }
 }