@passlock/client 0.9.22 → 0.9.24

package/src/index.ts

@@ -1,3 +1,6 @@
+import { Effect as E, Layer as L, Layer, Option as O, Runtime, Scope, pipe } from 'effect'
+import { dual } from 'effect/Function'
+
 import type {
   BadRequest,
   Disabled,
@@ -7,40 +10,127 @@ import type {
   NotSupported,
   Unauthorized,
 } from '@passlock/shared/dist/error/error.js'
-
 import { ErrorCode } from '@passlock/shared/dist/error/error.js'
-import { RpcConfig } from '@passlock/shared/dist/rpc/config.js'
-import type { Principal } from '@passlock/shared/dist/schema/principal.js'
-import { Effect as E, Layer as L, Layer, Option, Runtime, Scope, pipe } from 'effect'
-import { AuthenticationService, type AuthenticationRequest } from './authentication/authenticate.js'
-import { Capabilities } from './capabilities/capabilities.js'
-import { ConnectionService } from './connection/connection.js'
-import { allRequirements } from './effect.js'
-import { EmailService, type VerifyRequest } from './email/email.js'
-import { RegistrationService, type RegistrationRequest } from './registration/register.js'
-import { SocialService, type AuthenticateOidcReq, type RegisterOidcReq } from './social/social.js'
-import { Storage, StorageService, type AuthType, type StoredToken } from './storage/storage.js'
-import { UserService, type Email, type ResendEmail } from './user/user.js'
+import type { VerifyEmail } from '@passlock/shared/dist/schema/email.js'
+import type { UserVerification } from '@passlock/shared/dist/schema/passkey.js'
+import type { Principal, UserPrincipal } from '@passlock/shared/dist/schema/principal.js'
+
+import type { AuthenticationService } from './authentication/authenticate.js'
+import type { Capabilities } from './capabilities/capabilities.js'
+import type { ConnectionService } from './connection/connection.js'
+import {
+  allRequirements,
+  authenticateOidc,
+  authenticatePasskey,
+  clearExpiredTokens,
+  getSessionToken,
+  isExistingUser,
+  isPasskeySupport,
+  preConnect,
+  registerOidc,
+  registerPasskey,
+  resendVerificationEmail,
+  verifyEmailCode,
+  verifyEmailLink,
+} from './effect.js'
+import type { EmailService, VerifyRequest } from './email/email.js'
+import type { RegistrationService } from './registration/register.js'
+import { RpcConfig } from './rpc/config.js'
+import type { Provider, SocialService } from './social/social.js'
+import {
+  type AuthType,
+  BrowserStorage,
+  StorageService,
+  type StoredToken,
+} from './storage/storage.js'
+import type { Email, ResendEmail, UserService } from './user/user.js'
+import { PASSLOCK_CLIENT_VERSION } from './version.js'
 
 /* Exports */
 
 export type Options = { signal?: AbortSignal }
 export type { VerifyEmail } from '@passlock/shared/dist/schema/email.js'
 export type { UserVerification } from '@passlock/shared/dist/schema/passkey.js'
-export type { Principal } from '@passlock/shared/dist/schema/principal.js'
+export type { Principal, UserPrincipal } from '@passlock/shared/dist/schema/principal.js'
 
-export type { AuthenticationRequest } from './authentication/authenticate.js'
 export type { VerifyRequest } from './email/email.js'
-export type { RegistrationRequest } from './registration/register.js'
 export type { AuthType, StoredToken } from './storage/storage.js'
 export type { Email } from './user/user.js'
 
 export type PasslockProps = {
-  tenancyId: string; 
-  clientId: string; 
+  tenancyId: string
+  clientId: string
   endpoint?: string
 }
 
+export type RegistrationRequest = {
+  email: string
+  givenName?: string
+  familyName?: string
+  userVerification?: UserVerification
+  verifyEmail?: VerifyEmail
+}
+
+const nonEmpty = (text: string): O.Option<string> => {
+  const trimmed = text.trim()
+  if (trimmed.length > 0) return O.some(trimmed)
+  return O.none()
+}
+
+const toRpcRegistrationRequest = (request: RegistrationRequest) => {
+  return {
+    email: request.email,
+    givenName: pipe(O.fromNullable(request.givenName), O.flatMap(nonEmpty)),
+    familyName: pipe(O.fromNullable(request.familyName), O.flatMap(nonEmpty)),
+    userVerification: O.fromNullable(request.userVerification),
+    verifyEmail: O.fromNullable(request.verifyEmail),
+  }
+}
+
+export type AuthenticationRequest = {
+  email?: string
+  userVerification?: UserVerification
+}
+
+const toRpcAuthenticationRequest = (request: AuthenticationRequest) => {
+  return {
+    email: O.fromNullable(request.email),
+    userVerification: O.fromNullable(request.userVerification),
+  }
+}
+
+export type RegisterOidcReq = {
+  provider: Provider
+  idToken: string
+  givenName?: string
+  familyName?: string
+  nonce: string
+}
+
+const toRpcRegisterOidcReq = (request: RegisterOidcReq) => {
+  return {
+    provider: request.provider,
+    idToken: request.idToken,
+    givenName: pipe(O.fromNullable(request.givenName), O.flatMap(nonEmpty)),
+    familyName: pipe(O.fromNullable(request.familyName), O.flatMap(nonEmpty)),
+    nonce: request.nonce,
+  }
+}
+
+export type AuthenticateOidcReq = {
+  provider: Provider
+  idToken: string
+  nonce: string
+}
+
+const toRpcAuthenticateOidcReq = (request: AuthenticateOidcReq) => {
+  return {
+    provider: request.provider,
+    idToken: request.idToken,
+    nonce: request.nonce,
+  }
+}
+
 export { ErrorCode } from '@passlock/shared/dist/error/error.js'
 
 export class PasslockError extends Error {
@@ -54,11 +144,7 @@ export class PasslockError extends Error {
   }
 
   static readonly isError = (error: unknown): error is PasslockError => {
-    return (
-      typeof error === 'object' &&
-      error !== null &&
-      error instanceof PasslockError
-    )
+    return typeof error === 'object' && error !== null && error instanceof PasslockError
   }
 }
 
@@ -105,11 +191,13 @@ const transformErrors = <A, R>(
     },
 
     Interrupt: () => {
+      console.error('Interrupt')
       return E.succeed(new PasslockError('Operation aborted', ErrorCode.InternalBrowserError))
     },
 
     Sequential: errors => {
       console.error(errors)
+
       return E.succeed(
         new PasslockError('Sorry, something went wrong', ErrorCode.InternalServerError),
       )
@@ -117,6 +205,7 @@ const transformErrors = <A, R>(
 
     Parallel: errors => {
       console.error(errors)
+
       return E.succeed(
         new PasslockError('Sorry, something went wrong', ErrorCode.InternalServerError),
       )
@@ -135,218 +224,191 @@ type Requirements =
   | StorageService
   | Capabilities
   | SocialService
+  | RpcConfig
 
 export class PasslockUnsafe {
   private readonly runtime: Runtime.Runtime<Requirements>
 
-  constructor(config: PasslockProps) {
-    const rpcConfig = Layer.succeed(RpcConfig, RpcConfig.of(config))
-    const storage = Layer.succeed(Storage, Storage.of(globalThis.localStorage))
-    const allLayers = pipe(allRequirements, L.provide(rpcConfig), L.provide(storage))
+  constructor(props: PasslockProps) {
+    const config = Layer.succeed(RpcConfig, RpcConfig.of(props))
+    const storage = Layer.succeed(BrowserStorage, BrowserStorage.of(globalThis.localStorage))
+    const allLayers = pipe(allRequirements, L.provide(config), L.provide(storage), L.merge(config))
     const scope = E.runSync(Scope.make())
+
     this.runtime = E.runSync(Layer.toRuntime(allLayers).pipe(Scope.extend(scope)))
+
+    E.runSync(E.logDebug(`Passlock version: ${PASSLOCK_CLIENT_VERSION}`))
   }
 
-  private readonly runPromise = <A, R extends Requirements>(
-    effect: E.Effect<A, PasslockErrors, R>,
-    options: Options | undefined = undefined
-  ) => {
-    return pipe(
-      transformErrors(effect),
-      E.flatMap(result => (PasslockError.isError(result) ? E.fail(result) : E.succeed(result))),
-      effect => Runtime.runPromise(this.runtime)(effect, options),
+  static isUserPrincipal = (principal: Principal): principal is UserPrincipal => {
+    return (
+      principal.givenName !== undefined &&
+      principal.familyName !== undefined &&
+      principal.email !== undefined &&
+      principal.emailVerified !== undefined
     )
   }
 
-  preConnect = (options?: Options): Promise<void> =>
-    pipe(
-      ConnectionService,
-      E.flatMap(service => service.preConnect()),
-      effect => Runtime.runPromise(this.runtime)(effect, options),
-    )
+  private readonly runPromise: {
+    <A, R extends Requirements>(
+      options: Options | undefined,
+    ): (effect: E.Effect<A, PasslockErrors, R>) => Promise<A>
+    <A, R extends Requirements>(
+      effect: E.Effect<A, PasslockErrors, R>,
+      options: Options | undefined,
+    ): Promise<A>
+  } = dual(
+    2,
+    <A, R extends Requirements>(
+      effect: E.Effect<A, PasslockErrors, R>,
+      options: Options | undefined,
+    ): Promise<A> =>
+      pipe(
+        transformErrors(effect),
+        E.flatMap(result => (PasslockError.isError(result) ? E.fail(result) : E.succeed(result))),
+        effect => Runtime.runPromise(this.runtime)(effect, options),
+      ),
+  )
+
+  preConnect = (options?: Options): Promise<void> => pipe(preConnect(), this.runPromise(options))
 
   isPasskeySupport = (): Promise<boolean> =>
-    pipe(
-      Capabilities,
-      E.flatMap(service => service.isPasskeySupport),
-      effect => Runtime.runPromise(this.runtime)(effect),
-    )
+    pipe(isPasskeySupport, effect => Runtime.runPromise(this.runtime)(effect))
 
   isExistingUser = (email: Email, options?: Options): Promise<boolean> =>
-    pipe(
-      UserService,
-      E.flatMap(service => service.isExistingUser(email)),
-      effect => this.runPromise(effect, options),
-    )
+    pipe(isExistingUser(email), this.runPromise(options))
 
   registerPasskey = (request: RegistrationRequest, options?: Options): Promise<Principal> =>
-    pipe(
-      RegistrationService,
-      E.flatMap(service => service.registerPasskey(request)),
-      effect => this.runPromise(effect, options),
-    )
+    pipe(registerPasskey(toRpcRegistrationRequest(request)), this.runPromise(options))
 
   authenticatePasskey = (request: AuthenticationRequest, options?: Options): Promise<Principal> =>
-    pipe(
-      AuthenticationService,
-      E.flatMap(service => service.authenticatePasskey(request)),
-      effect => this.runPromise(effect, options),
-    )
+    pipe(authenticatePasskey(toRpcAuthenticationRequest(request)), this.runPromise(options))
 
-  registerOidc = (request: RegisterOidcReq, options?: Options) => 
-    pipe(
-      SocialService,
-      E.flatMap(service => service.registerOidc(request)),
-      effect => this.runPromise(effect, options),
-    )   
-    
-  authenticateOidc = (request: AuthenticateOidcReq, options?: Options) => 
-    pipe(
-      SocialService,
-      E.flatMap(service => service.authenticateOidc(request)),
-      effect => this.runPromise(effect, options),
-    )      
+  registerOidc = (request: RegisterOidcReq, options?: Options) =>
+    pipe(registerOidc(toRpcRegisterOidcReq(request)), this.runPromise(options))
+
+  authenticateOidc = (request: AuthenticateOidcReq, options?: Options) =>
+    pipe(authenticateOidc(toRpcAuthenticateOidcReq(request)), this.runPromise(options))
 
   verifyEmailCode = (request: VerifyRequest, options?: Options): Promise<Principal> =>
-    pipe(
-      EmailService,
-      E.flatMap(service => service.verifyEmailCode(request)),
-      effect => this.runPromise(effect, options),
-    )
+    pipe(verifyEmailCode(request), this.runPromise(options))
 
   resendVerificationEmail = (request: ResendEmail, options?: Options): Promise<void> =>
-    pipe(
-      UserService,
-      E.flatMap(service => service.resendVerificationEmail(request)),
-      effect => this.runPromise(effect, options),
-    )    
+    pipe(resendVerificationEmail(request), this.runPromise(options))
 
   verifyEmailLink = (options?: Options): Promise<Principal> =>
-    pipe(
-      EmailService,
-      E.flatMap(service => service.verifyEmailLink()),
-      effect => this.runPromise(effect, options),
-    )
+    pipe(verifyEmailLink, this.runPromise(options))
 
   getSessionToken = (authType: AuthType): StoredToken | undefined =>
     pipe(
-      StorageService,
-      E.flatMap(service => service.getToken(authType).pipe(effect => E.option(effect))),
-      E.map(Option.getOrUndefined),
+      getSessionToken(authType),
+      E.orElseSucceed(() => undefined),
       effect => Runtime.runSync(this.runtime)(effect),
     )
 
-  clearExpiredTokens = (): void =>
-    pipe(
-      StorageService,
-      E.flatMap(service => service.clearExpiredTokens),
-      effect => Runtime.runSync(this.runtime)(effect),
-    )
+  clearExpiredTokens = (): void => {
+    pipe(clearExpiredTokens, effect => {
+      Runtime.runSync(this.runtime)(effect)
+    })
+  }
 }
 
 export class Passlock {
   private readonly runtime: Runtime.Runtime<Requirements>
 
-  constructor(config: PasslockProps) {
-    const rpcConfig = Layer.succeed(RpcConfig, RpcConfig.of(config))
-    const storage = Layer.succeed(Storage, Storage.of(globalThis.localStorage))
-    const allLayers = pipe(allRequirements, L.provide(rpcConfig), L.provide(storage))
+  constructor(props: PasslockProps) {
+    const config = Layer.succeed(RpcConfig, RpcConfig.of(props))
+    const storage = Layer.succeed(BrowserStorage, BrowserStorage.of(globalThis.localStorage))
+    const allLayers = pipe(allRequirements, L.provide(config), L.provide(storage), L.merge(config))
     const scope = E.runSync(Scope.make())
+
     this.runtime = E.runSync(Layer.toRuntime(allLayers).pipe(Scope.extend(scope)))
+
+    E.runSync(E.logDebug(`Passlock version: ${PASSLOCK_CLIENT_VERSION}`))
   }
 
-  private readonly runPromise = <A, R extends Requirements>(
-    effect: E.Effect<A, PasslockErrors, R>,
-    options: Options | undefined = undefined
-  ) => {
-    return pipe(
-      transformErrors(effect), 
-      effect => Runtime.runPromise(this.runtime)(effect, options)
+  static isUserPrincipal = (principal: Principal): principal is UserPrincipal => {
+    return (
+      principal.givenName !== undefined &&
+      principal.familyName !== undefined &&
+      principal.email !== undefined &&
+      principal.emailVerified !== undefined
     )
   }
 
-  preConnect = (options?: Options): Promise<void | PasslockError> =>
-    pipe(
-      ConnectionService,
-      E.flatMap(service => service.preConnect()),
-      effect => this.runPromise(effect, options),
-    )
+  private readonly runPromise: {
+    <A, R extends Requirements>(
+      options: Options | undefined,
+    ): (effect: E.Effect<A, PasslockErrors, R>) => Promise<A | PasslockError>
+    <A, R extends Requirements>(
+      effect: E.Effect<A, PasslockErrors, R>,
+      options: Options | undefined,
+    ): Promise<A | PasslockError>
+  } = dual(
+    2,
+    <A, R extends Requirements>(
+      effect: E.Effect<A, PasslockErrors, R>,
+      options: Options | undefined,
+    ): Promise<A | PasslockError> =>
+      pipe(transformErrors(effect), effect => Runtime.runPromise(this.runtime)(effect, options)),
+  )
+
+  preConnect = async (options?: Options): Promise<boolean | PasslockError> => {
+    return pipe(preConnect(), E.as(true), this.runPromise(options))
+  }
 
   isPasskeySupport = (): Promise<boolean> =>
-    pipe(
-      Capabilities,
-      E.flatMap(service => service.isPasskeySupport),
-      effect => Runtime.runPromise(this.runtime)(effect),
-    )
+    pipe(isPasskeySupport, effect => Runtime.runPromise(this.runtime)(effect))
 
   isExistingUser = (email: Email, options?: Options): Promise<boolean | PasslockError> =>
-    pipe(
-      UserService,
-      E.flatMap(service => service.isExistingUser(email)),
-      effect => this.runPromise(effect, options),
-    )
+    pipe(isExistingUser(email), this.runPromise(options))
 
-  registerPasskey = (request: RegistrationRequest, options?: Options): Promise<Principal | PasslockError> =>
-    pipe(
-      RegistrationService,
-      E.flatMap(service => service.registerPasskey(request)),
-      effect => this.runPromise(effect, options),
-    )
+  registerPasskey = (
+    request: RegistrationRequest,
+    options?: Options,
+  ): Promise<Principal | PasslockError> =>
+    pipe(registerPasskey(toRpcRegistrationRequest(request)), this.runPromise(options))
 
-  authenticatePasskey = (request: AuthenticationRequest = {}, options?: Options): Promise<Principal | PasslockError> =>
-    pipe(
-      AuthenticationService,
-      E.flatMap(service => service.authenticatePasskey(request)),
-      effect => this.runPromise(effect, options),
-    )
+  authenticatePasskey = (
+    request: AuthenticationRequest = {},
+    options?: Options,
+  ): Promise<Principal | PasslockError> =>
+    pipe(toRpcAuthenticationRequest(request), authenticatePasskey, this.runPromise(options))
 
-  registerOidc = (request: RegisterOidcReq, options?: Options) => 
-    pipe(
-      SocialService,
-      E.flatMap(service => service.registerOidc(request)),
-      effect => this.runPromise(effect, options),
-    )     
+  registerOidc = (request: RegisterOidcReq, options?: Options) =>
+    pipe(registerOidc(toRpcRegisterOidcReq(request)), this.runPromise(options))
 
-  authenticateOidc = (request: AuthenticateOidcReq, options?: Options) => 
-    pipe(
-      SocialService,
-      E.flatMap(service => service.authenticateOidc(request)),
-      effect => this.runPromise(effect, options),
-    )      
+  authenticateOidc = (request: AuthenticateOidcReq, options?: Options) =>
+    pipe(authenticateOidc(request), this.runPromise(options))
 
-  verifyEmailCode = (request: VerifyRequest, options?: Options): Promise<Principal | PasslockError> =>
-    pipe(
-      EmailService,
-      E.flatMap(service => service.verifyEmailCode(request)),
-      effect => this.runPromise(effect, options),
-    )
+  verifyEmailCode = (
+    request: VerifyRequest,
+    options?: Options,
+  ): Promise<Principal | PasslockError> => pipe(verifyEmailCode(request), this.runPromise(options))
 
   verifyEmailLink = (options?: Options): Promise<Principal | PasslockError> =>
-    pipe(
-      EmailService,
-      E.flatMap(service => service.verifyEmailLink()),
-      effect => this.runPromise(effect, options),
-    )
+    pipe(verifyEmailLink, this.runPromise(options))
 
-  resendVerificationEmail = (request: ResendEmail, options?: Options): Promise<void | PasslockError> =>
-    pipe(
-      UserService,
-      E.flatMap(service => service.resendVerificationEmail(request)),
-      effect => this.runPromise(effect, options),
-    )      
+  resendVerificationEmail = (
+    request: ResendEmail,
+    options?: Options,
+  ): Promise<boolean | PasslockError> =>
+    pipe(resendVerificationEmail(request), E.as(true), this.runPromise(options))
 
-  getSessionToken = (authType: AuthType): StoredToken | undefined =>
+  getSessionToken = (authType: AuthType): Promise<StoredToken | undefined> =>
     pipe(
-      StorageService,
-      E.flatMap(service => service.getToken(authType).pipe(effect => E.option(effect))),
-      E.map(maybeToken => Option.getOrUndefined(maybeToken)),
-      effect => Runtime.runSync(this.runtime)(effect),
+      getSessionToken(authType),
+      E.orElseSucceed(() => undefined),
+      effect => E.runPromise(effect),
     )
 
-  clearExpiredTokens = (): void =>
+  clearExpiredTokens = (): void => {
     pipe(
       StorageService,
       E.flatMap(service => service.clearExpiredTokens),
-      effect => Runtime.runSync(this.runtime)(effect),
+      effect => {
+        Runtime.runSync(this.runtime)(effect)
+      },
     )
+  }
 }

package/src/logging/eventLogger.test.ts

@@ -1,5 +1,6 @@
 import { Effect as E, LogLevel, Logger } from 'effect'
 import { describe, expect, test, vi } from 'vitest'
+
 import { eventLoggerLive, logRaw } from './eventLogger.js'
 
 /**
@@ -79,7 +80,7 @@ describe('log', () => {
     const withLogLevel = logStatement.pipe(Logger.withMinimumLogLevel(LogLevel.Warning))
 
     const effect = E.provide(withLogLevel, eventLoggerLive)
-    
+
     E.runSync(effect)
 
     const expectedEvent = new CustomEvent('PasslogDebugMessage', {

package/src/logging/eventLogger.ts

@@ -25,7 +25,7 @@ const dispatch = (message: string) => {
   try {
     const evt = new CustomEvent(DebugMessage, { detail: message })
     globalThis.dispatchEvent(evt)
-  } catch (e) {
+  } catch {
     globalThis.console.log('Unable to fire custom event')
   }
 }
@@ -36,6 +36,6 @@ export const eventLoggerLive = Logger.add(
       dispatch(message)
     } else if (Array.isArray(message) && logLevel !== LogLevel.Debug) {
       message.forEach(dispatch)
-    } 
-  })
+    }
+  }),
 )

package/src/registration/register.fixture.ts

@@ -1,13 +1,15 @@
+import { Effect as E, Layer as L, Option as O } from 'effect'
+
 import {
   OptionsReq,
   OptionsRes,
-  RegistrationClient,
   VerificationReq,
   VerificationRes,
 } from '@passlock/shared/dist/rpc/registration.js'
 import type { RegistrationCredential } from '@passlock/shared/dist/schema/passkey.js'
-import { Effect as E, Layer as L } from 'effect'
+
 import * as Fixtures from '../test/fixtures.js'
+import { RegistrationClient } from '../rpc/registration.js'
 import { UserService } from '../user/user.js'
 import { CreateCredential, type RegistrationRequest } from './register.js'
 
@@ -19,8 +21,10 @@ export const expireAt = Date.now() + 10000
 
 export const registrationRequest: RegistrationRequest = {
   email: 'jdoe@gmail.com',
-  givenName: 'john',
-  familyName: 'doe',
+  givenName: O.some('john'),
+  familyName: O.some('doe'),
+  userVerification: O.none(),
+  verifyEmail: O.none(),
 }
 
 export const rpcOptionsReq = new OptionsReq(registrationRequest)
@@ -56,20 +60,24 @@ export const credential: RegistrationCredential = {
   clientExtensionResults: {},
 }
 
-export const rpcVerificationReq = new VerificationReq({ session, credential })
+export const rpcVerificationReq = new VerificationReq({
+  session,
+  credential,
+  verifyEmail: O.none(),
+})
 
 export const rpcVerificationRes = new VerificationRes({ principal: Fixtures.principal })
 
 export const createCredentialTest = L.succeed(
   CreateCredential,
-  CreateCredential.of(() => E.succeed(credential)),
+  CreateCredential.of({ createCredential: () => E.succeed(credential) }),
 )
 
 export const userServiceTest = L.succeed(
   UserService,
   UserService.of({
     isExistingUser: () => E.succeed(false),
-    resendVerificationEmail: () => E.succeed(true)
+    resendVerificationEmail: () => E.succeed(true),
   }),
 )
 
@@ -78,7 +86,7 @@ export const rpcClientTest = L.succeed(
   RegistrationClient.of({
     getRegistrationOptions: () => E.succeed(rpcOptionsRes),
     verifyRegistrationCredential: () => E.succeed(rpcVerificationRes),
-  })
+  }),
 )
 
 export const principal = Fixtures.principal