@axium/core 0.5.5 → 0.7.0

package/dist/api.d.ts

@@ -1,45 +1,16 @@
-import type { AuthenticatorTransportFuture, CredentialDeviceType, PublicKeyCredentialCreationOptionsJSON, PublicKeyCredentialRequestOptionsJSON } from '@simplewebauthn/types';
+import type { PublicKeyCredentialCreationOptionsJSON, PublicKeyCredentialRequestOptionsJSON } from '@simplewebauthn/types';
 import type z from 'zod';
-import type { RequestMethod } from './requests.js';
-import type { APIUserRegistration, LogoutSessions, PasskeyAuthenticationResponse, PasskeyChangeable, PasskeyRegistration, UserAuthOptions } from './schemas.js';
-import type { User, UserChangeable, UserPublic } from './user.js';
 import type { AccessControl } from './access.js';
-export interface Session {
-    id: string;
-    userId: string;
-    expires: Date;
-    created: Date;
-    elevated: boolean;
-}
-export interface Verification {
-    userId: string;
-    expires: Date;
-}
-export interface Passkey {
-    id: string;
-    name?: string | null;
-    createdAt: Date;
-    userId: string;
-    deviceType: CredentialDeviceType;
-    backedUp: boolean;
-    transports: AuthenticatorTransportFuture[];
-}
-export interface NewSessionResponse {
-    userId: string;
-    token: string;
-}
-export interface AppMetadata {
-    readonly id: string;
-    readonly name?: string;
-    readonly version?: string;
-    readonly image?: string;
-    readonly icon?: string;
-}
+import type { App } from './apps.js';
+import type { NewSessionResponse, Session, Verification } from './auth.js';
+import type { Passkey, PasskeyAuthenticationResponse, PasskeyChangeable, PasskeyRegistration } from './passkeys.js';
+import type { RequestMethod } from './requests.js';
+import type { LogoutSessions, User, UserAuthOptions, UserChangeable, UserPublic, UserRegistration } from './user.js';
 /**
  * Types for all API endpoints
  * @internal
  */
-export interface _apiTypes {
+export interface $API {
     metadata: {
         GET: {
             version: string;
@@ -51,7 +22,7 @@ export interface _apiTypes {
         };
     };
     apps: {
-        GET: AppMetadata[];
+        GET: App[];
     };
     session: {
         GET: Session & {
@@ -64,7 +35,7 @@ export interface _apiTypes {
             userId: string;
             options: PublicKeyCredentialCreationOptionsJSON;
         };
-        POST: [z.input<typeof APIUserRegistration>, NewSessionResponse];
+        POST: [z.input<typeof UserRegistration>, NewSessionResponse];
     };
     'users/:id': {
         GET: UserPublic & Partial<User>;
@@ -118,8 +89,8 @@ export interface _apiTypes {
         }, AccessControl];
     };
 }
-export type Endpoint = keyof _apiTypes;
-export type APIFunction<Method extends RequestMethod, E extends Endpoint> = Method extends keyof _apiTypes[E] ? _apiTypes[E][Method] extends [infer Body, infer Result] ? (body: Body) => Promise<Result> : () => _apiTypes[E][Method] : unknown;
-export type RequestBody<Method extends RequestMethod, E extends Endpoint> = Method extends keyof _apiTypes[E] ? _apiTypes[E][Method] extends [infer Body, unknown] ? Body : any : unknown;
-export type Result<Method extends RequestMethod, E extends Endpoint> = Promise<Method extends keyof _apiTypes[E] ? (_apiTypes[E][Method] extends [unknown, infer R] ? R : _apiTypes[E][Method]) : unknown>;
+export type Endpoint = keyof $API;
+export type APIFunction<Method extends RequestMethod, E extends Endpoint> = Method extends keyof $API[E] ? $API[E][Method] extends [infer Body, infer Result] ? (body: Body) => Promise<Result> : () => $API[E][Method] : unknown;
+export type RequestBody<Method extends RequestMethod, E extends Endpoint> = Method extends keyof $API[E] ? $API[E][Method] extends [infer Body, unknown] ? Body : any : unknown;
+export type Result<Method extends RequestMethod, E extends Endpoint> = Promise<Method extends keyof $API[E] ? ($API[E][Method] extends [unknown, infer R] ? R : $API[E][Method]) : unknown>;
 export type APIParameters<S extends string> = S extends `${string}/:${infer Right}` ? [string, ...APIParameters<Right>] : [];

package/dist/apps.d.ts

@@ -0,0 +1,9 @@
+import * as z from 'zod';
+export declare const App: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    image: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export interface App extends z.infer<typeof App> {
+}

package/dist/apps.js

@@ -0,0 +1,7 @@
+import * as z from 'zod';
+export const App = z.object({
+    id: z.string(),
+    name: z.string().optional(),
+    image: z.string().optional(),
+    icon: z.string().optional(),
+});

package/dist/auth.d.ts

@@ -0,0 +1,15 @@
+export interface Session {
+    id: string;
+    userId: string;
+    expires: Date;
+    created: Date;
+    elevated: boolean;
+}
+export interface Verification {
+    userId: string;
+    expires: Date;
+}
+export interface NewSessionResponse {
+    userId: string;
+    token: string;
+}

package/dist/auth.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -1,6 +1,10 @@
 export * from './access.js';
 export * from './api.js';
+export * from './apps.js';
+export * from './auth.js';
 export * as icons from './icons.js';
+export * from './passkeys.js';
+export * from './preferences.js';
 export * from './requests.js';
 export * from './schemas.js';
 export * from './user.js';

package/dist/index.js

@@ -1,6 +1,10 @@
 export * from './access.js';
 export * from './api.js';
+export * from './apps.js';
+export * from './auth.js';
 export * as icons from './icons.js';
+export * from './passkeys.js';
+export * from './preferences.js';
 export * from './requests.js';
 export * from './schemas.js';
 export * from './user.js';

package/dist/passkeys.d.ts

@@ -0,0 +1,55 @@
+import type { AuthenticatorTransportFuture } from '@simplewebauthn/server';
+import type { CredentialDeviceType } from '@simplewebauthn/types';
+import * as z from 'zod';
+export declare const authenticatorAttachment: z.ZodOptional<z.ZodLiteral<"cross-platform" | "platform">>;
+export declare const PasskeyRegistration: z.ZodObject<{
+    id: z.ZodString;
+    rawId: z.ZodString;
+    response: z.ZodObject<{
+        clientDataJSON: z.ZodString;
+        attestationObject: z.ZodString;
+        authenticatorData: z.ZodOptional<z.ZodString>;
+        transports: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            ble: "ble";
+            hybrid: "hybrid";
+            internal: "internal";
+            nfc: "nfc";
+            usb: "usb";
+            cable: "cable";
+            "smart-card": "smart-card";
+        }>>>;
+        publicKeyAlgorithm: z.ZodOptional<z.ZodNumber>;
+        publicKey: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    authenticatorAttachment: z.ZodOptional<z.ZodLiteral<"cross-platform" | "platform">>;
+    clientExtensionResults: z.ZodRecord<z.ZodAny, z.ZodAny>;
+    type: z.ZodLiteral<"public-key">;
+}, z.core.$strip>;
+/**
+ * POSTed to the `/users/:id/login` endpoint.
+ */
+export declare const PasskeyAuthenticationResponse: z.ZodObject<{
+    id: z.ZodString;
+    rawId: z.ZodString;
+    response: z.ZodObject<{
+        clientDataJSON: z.ZodString;
+        authenticatorData: z.ZodString;
+        signature: z.ZodString;
+        userHandle: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    authenticatorAttachment: z.ZodOptional<z.ZodLiteral<"cross-platform" | "platform">>;
+    clientExtensionResults: z.ZodRecord<z.ZodAny, z.ZodAny>;
+    type: z.ZodLiteral<"public-key">;
+}, z.core.$strip>;
+export declare const PasskeyChangeable: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export interface Passkey {
+    id: string;
+    name?: string | null;
+    createdAt: Date;
+    userId: string;
+    deviceType: CredentialDeviceType;
+    backedUp: boolean;
+    transports: AuthenticatorTransportFuture[];
+}

package/dist/passkeys.js

@@ -0,0 +1,35 @@
+import * as z from 'zod';
+const transports = ['ble', 'cable', 'hybrid', 'internal', 'nfc', 'smart-card', 'usb'];
+export const authenticatorAttachment = z.literal(['platform', 'cross-platform']).optional();
+export const PasskeyRegistration = z.object({
+    id: z.string(),
+    rawId: z.string(),
+    response: z.object({
+        clientDataJSON: z.string(),
+        attestationObject: z.string(),
+        authenticatorData: z.string().optional(),
+        transports: z.array(z.enum(transports)).optional(),
+        publicKeyAlgorithm: z.number().optional(),
+        publicKey: z.string().optional(),
+    }),
+    authenticatorAttachment,
+    clientExtensionResults: z.record(z.any(), z.any()),
+    type: z.literal('public-key'),
+});
+/**
+ * POSTed to the `/users/:id/login` endpoint.
+ */
+export const PasskeyAuthenticationResponse = z.object({
+    id: z.string(),
+    rawId: z.string(),
+    response: z.object({
+        clientDataJSON: z.string(),
+        authenticatorData: z.string(),
+        signature: z.string(),
+        userHandle: z.string().optional(),
+    }),
+    authenticatorAttachment,
+    clientExtensionResults: z.record(z.any(), z.any()),
+    type: z.literal('public-key'),
+});
+export const PasskeyChangeable = z.object({ name: z.string() }).partial();

package/dist/preferences.d.ts

@@ -0,0 +1,39 @@
+import * as z from 'zod';
+/** @internal Used so we can narrow using `type` and get access to type-specific properties (e.g. `ZodNumber.minValue`) */
+type StringFormatTypes = z.ZodGUID | z.ZodUUID | z.ZodEmail | z.ZodURL | z.ZodEmoji | z.ZodNanoID | z.ZodCUID | z.ZodCUID2 | z.ZodULID | z.ZodXID | z.ZodKSUID | z.ZodISODateTime | z.ZodISODate | z.ZodISOTime | z.ZodISODuration | z.ZodIPv4 | z.ZodIPv6 | z.ZodCIDRv4 | z.ZodCIDRv6 | z.ZodBase64 | z.ZodBase64URL | z.ZodE164 | z.ZodJWT;
+type ZodPrefPrimitive = z.ZodString | z.ZodNumber | z.ZodBigInt | z.ZodBoolean | z.ZodDate | z.ZodLiteral | z.ZodTemplateLiteral | z.ZodFile | z.ZodEnum | StringFormatTypes;
+type ZodPrefComposite = ZodPrefPrimitive | z.ZodNullable<ZodPrefPrimitive> | z.ZodOptional<ZodPrefPrimitive> | z.ZodArray<ZodPrefPrimitive> | z.ZodTuple<ZodPrefPrimitive[]> | z.ZodRecord<z.ZodString, ZodPrefPrimitive> | z.ZodObject<Readonly<Record<string, ZodPrefPrimitive>>>;
+/** @internal Used so we can narrow using `type` and get access to type-specific properties (e.g. `ZodNumber.minValue`) */
+export type ZodPref = ZodPrefComposite | z.ZodObject<Readonly<Record<string, ZodPrefComposite>>>;
+/**
+ * Interface for the user preferences schema shape.
+ * Modify with `declare module ...`.
+ */
+export interface PreferenceSchemas {
+    debug: z.ZodBoolean;
+}
+export type PreferenceName = keyof PreferenceSchemas & string;
+/**
+ * @internal
+ */
+export declare const preferenceSchemas: PreferenceSchemas;
+export type Preferences = z.infer<z.ZodObject<Readonly<PreferenceSchemas>>>;
+/**
+ * @internal
+ */
+export declare const preferenceDefaults: Preferences;
+/**
+ * @internal
+ * @todo Implement proper localization
+ */
+export declare const preferenceLabels: Record<PreferenceName, string>;
+export declare const preferenceDescriptions: Partial<Record<PreferenceName, string>>;
+export interface PreferenceInit<T extends PreferenceName = PreferenceName> {
+    name: T;
+    schema: PreferenceSchemas[T] & ZodPref;
+    initial: z.infer<PreferenceSchemas[T] & ZodPref>;
+    label: string;
+    descriptions?: string;
+}
+export declare function addPreference<T extends PreferenceName = PreferenceName>(init: PreferenceInit<T>): void;
+export {};

package/dist/preferences.js

@@ -0,0 +1,27 @@
+import * as z from 'zod';
+/**
+ * @internal
+ */
+export const preferenceSchemas = {
+    debug: z.boolean(),
+};
+/**
+ * @internal
+ */
+export const preferenceDefaults = {
+    debug: false,
+};
+/**
+ * @internal
+ * @todo Implement proper localization
+ */
+export const preferenceLabels = {
+    debug: 'Debug mode',
+};
+export const preferenceDescriptions = {};
+export function addPreference(init) {
+    preferenceSchemas[init.name] = init.schema;
+    preferenceDefaults[init.name] = init.initial;
+    preferenceLabels[init.name] = init.label;
+    preferenceDescriptions[init.name] = init.descriptions;
+}

package/dist/schemas.d.ts

@@ -1,82 +1,7 @@
 import * as z from 'zod';
+/** Needed for discriminated union type narrowing */
+export declare function zIs<const T extends z.core.$ZodTypeDef['type']>(schema: z.ZodType, type: T): schema is z.ZodType & {
+    type: T;
+};
 export declare function zFunction<T extends z.core.$ZodFunction>(schema: T): z.ZodCustom<Parameters<T["implement"]>[0], Parameters<T["implement"]>[0]>;
 export declare function zAsyncFunction<T extends z.core.$ZodFunction>(schema: T): z.ZodCustom<Parameters<T["implementAsync"]>[0], Parameters<T["implementAsync"]>[0]>;
-export declare const authenticatorAttachment: z.ZodOptional<z.ZodLiteral<"cross-platform" | "platform">>;
-export declare const PasskeyRegistration: z.ZodObject<{
-    id: z.ZodString;
-    rawId: z.ZodString;
-    response: z.ZodObject<{
-        clientDataJSON: z.ZodString;
-        attestationObject: z.ZodString;
-        authenticatorData: z.ZodOptional<z.ZodString>;
-        transports: z.ZodOptional<z.ZodArray<z.ZodEnum<{
-            ble: "ble";
-            hybrid: "hybrid";
-            internal: "internal";
-            nfc: "nfc";
-            usb: "usb";
-            cable: "cable";
-            "smart-card": "smart-card";
-        }>>>;
-        publicKeyAlgorithm: z.ZodOptional<z.ZodNumber>;
-        publicKey: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>;
-    authenticatorAttachment: z.ZodOptional<z.ZodLiteral<"cross-platform" | "platform">>;
-    clientExtensionResults: z.ZodRecord<z.ZodAny, z.ZodAny>;
-    type: z.ZodLiteral<"public-key">;
-}, z.core.$strip>;
-/**
- * POSTed to the `/users/:id/login` endpoint.
- */
-export declare const PasskeyAuthenticationResponse: z.ZodObject<{
-    id: z.ZodString;
-    rawId: z.ZodString;
-    response: z.ZodObject<{
-        clientDataJSON: z.ZodString;
-        authenticatorData: z.ZodString;
-        signature: z.ZodString;
-        userHandle: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>;
-    authenticatorAttachment: z.ZodOptional<z.ZodLiteral<"cross-platform" | "platform">>;
-    clientExtensionResults: z.ZodRecord<z.ZodAny, z.ZodAny>;
-    type: z.ZodLiteral<"public-key">;
-}, z.core.$strip>;
-export declare const APIUserRegistration: z.ZodObject<{
-    name: z.ZodString;
-    email: z.ZodEmail;
-    userId: z.ZodUUID;
-    response: z.ZodObject<{
-        id: z.ZodString;
-        rawId: z.ZodString;
-        response: z.ZodObject<{
-            clientDataJSON: z.ZodString;
-            attestationObject: z.ZodString;
-            authenticatorData: z.ZodOptional<z.ZodString>;
-            transports: z.ZodOptional<z.ZodArray<z.ZodEnum<{
-                ble: "ble";
-                hybrid: "hybrid";
-                internal: "internal";
-                nfc: "nfc";
-                usb: "usb";
-                cable: "cable";
-                "smart-card": "smart-card";
-            }>>>;
-            publicKeyAlgorithm: z.ZodOptional<z.ZodNumber>;
-            publicKey: z.ZodOptional<z.ZodString>;
-        }, z.core.$strip>;
-        authenticatorAttachment: z.ZodOptional<z.ZodLiteral<"cross-platform" | "platform">>;
-        clientExtensionResults: z.ZodRecord<z.ZodAny, z.ZodAny>;
-        type: z.ZodLiteral<"public-key">;
-    }, z.core.$strip>;
-}, z.core.$strip>;
-export declare const PasskeyChangeable: z.ZodObject<{
-    name: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-export declare const UserAuthOptions: z.ZodObject<{
-    type: z.ZodLiteral<"login" | "action">;
-}, z.core.$strip>;
-export type UserAuthOptions = z.infer<typeof UserAuthOptions>;
-export declare const LogoutSessions: z.ZodObject<{
-    id: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
-    confirm_all: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;

package/dist/schemas.js

@@ -1,52 +1,11 @@
 import * as z from 'zod';
+/** Needed for discriminated union type narrowing */
+export function zIs(schema, type) {
+    return schema.def.type == type;
+}
 export function zFunction(schema) {
     return z.custom((fn) => schema.implement(fn));
 }
 export function zAsyncFunction(schema) {
     return z.custom((fn) => schema.implementAsync(fn));
 }
-const transports = ['ble', 'cable', 'hybrid', 'internal', 'nfc', 'smart-card', 'usb'];
-export const authenticatorAttachment = z.literal(['platform', 'cross-platform']).optional();
-export const PasskeyRegistration = z.object({
-    id: z.string(),
-    rawId: z.string(),
-    response: z.object({
-        clientDataJSON: z.string(),
-        attestationObject: z.string(),
-        authenticatorData: z.string().optional(),
-        transports: z.array(z.enum(transports)).optional(),
-        publicKeyAlgorithm: z.number().optional(),
-        publicKey: z.string().optional(),
-    }),
-    authenticatorAttachment,
-    clientExtensionResults: z.record(z.any(), z.any()),
-    type: z.literal('public-key'),
-});
-/**
- * POSTed to the `/users/:id/login` endpoint.
- */
-export const PasskeyAuthenticationResponse = z.object({
-    id: z.string(),
-    rawId: z.string(),
-    response: z.object({
-        clientDataJSON: z.string(),
-        authenticatorData: z.string(),
-        signature: z.string(),
-        userHandle: z.string().optional(),
-    }),
-    authenticatorAttachment,
-    clientExtensionResults: z.record(z.any(), z.any()),
-    type: z.literal('public-key'),
-});
-export const APIUserRegistration = z.object({
-    name: z.string().min(1).max(100),
-    email: z.email(),
-    userId: z.uuid(),
-    response: PasskeyRegistration,
-});
-export const PasskeyChangeable = z.object({ name: z.string() }).partial();
-export const UserAuthOptions = z.object({ type: z.literal(['login', 'action']) });
-export const LogoutSessions = z.object({
-    id: z.array(z.uuid()).optional(),
-    confirm_all: z.boolean().optional(),
-});

package/dist/user.d.ts

@@ -1,10 +1,5 @@
 import * as z from 'zod';
-/**
- * User preferences.
- * Modify with `declare module ...`
- */
-export interface Preferences {
-}
+import type { Preferences } from './preferences.js';
 export declare const User: z.ZodObject<{
     id: z.ZodUUID;
     name: z.ZodString;
@@ -29,6 +24,44 @@ export declare const UserChangeable: z.ZodObject<{
     image: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodURL>>>;
     preferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
 }, z.core.$strip>;
-export type UserChangeable = z.infer<typeof UserChangeable>;
+export interface UserChangeable extends z.infer<typeof UserChangeable> {
+    preferences?: Preferences;
+}
 export declare function getUserImage(user: Partial<User>): string;
+export declare const UserRegistration: z.ZodObject<{
+    name: z.ZodString;
+    email: z.ZodEmail;
+    userId: z.ZodUUID;
+    response: z.ZodObject<{
+        id: z.ZodString;
+        rawId: z.ZodString;
+        response: z.ZodObject<{
+            clientDataJSON: z.ZodString;
+            attestationObject: z.ZodString;
+            authenticatorData: z.ZodOptional<z.ZodString>;
+            transports: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                ble: "ble";
+                hybrid: "hybrid";
+                internal: "internal";
+                nfc: "nfc";
+                usb: "usb";
+                cable: "cable";
+                "smart-card": "smart-card";
+            }>>>;
+            publicKeyAlgorithm: z.ZodOptional<z.ZodNumber>;
+            publicKey: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        authenticatorAttachment: z.ZodOptional<z.ZodLiteral<"cross-platform" | "platform">>;
+        clientExtensionResults: z.ZodRecord<z.ZodAny, z.ZodAny>;
+        type: z.ZodLiteral<"public-key">;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const UserAuthOptions: z.ZodObject<{
+    type: z.ZodLiteral<"login" | "action">;
+}, z.core.$strip>;
+export type UserAuthOptions = z.infer<typeof UserAuthOptions>;
+export declare const LogoutSessions: z.ZodObject<{
+    id: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
+    confirm_all: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
 export {};

package/dist/user.js

@@ -1,4 +1,5 @@
 import * as z from 'zod';
+import { PasskeyRegistration } from './passkeys.js';
 export const User = z.object({
     id: z.uuid(),
     name: z.string().min(1, 'Name is required').max(255, 'Name is too long'),
@@ -33,3 +34,14 @@ export function getUserImage(user) {
 		<text x="23" y="28" style="font-family:sans-serif;font-weight:bold;" fill="white">${user.name.replaceAll(/\W/g, '')[0]}</text>
 	</svg>`.replaceAll(/[\t\n]/g, '');
 }
+export const UserRegistration = z.object({
+    name: z.string().min(1).max(100),
+    email: z.email(),
+    userId: z.uuid(),
+    response: PasskeyRegistration,
+});
+export const UserAuthOptions = z.object({ type: z.literal(['login', 'action']) });
+export const LogoutSessions = z.object({
+    id: z.array(z.uuid()).optional(),
+    confirm_all: z.boolean().optional(),
+});

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axium/core",
-	"version": "0.5.5",
+	"version": "0.7.0",
 	"author": "James Prevett <axium@jamespre.dev> (https://jamespre.dev)",
 	"funding": {
 		"type": "individual",