@appforgeapps/shieldforge-types 0.0.5

package/README.md

@@ -0,0 +1,59 @@
+# @shieldforge/types
+
+Shared TypeScript types and interfaces for the ShieldForge authentication library.
+
+## Installation
+
+```bash
+npm install @shieldforge/types
+```
+
+## Usage
+
+```typescript
+import type {
+  User,
+  AuthUser,
+  AuthPayload,
+  LoginInput,
+  RegisterInput,
+  UserAccountStatus,
+  PasswordStrength,
+  ShieldForgeConfig,
+} from '@shieldforge/types';
+```
+
+## Exported Types
+
+### User Types
+
+- `User` - Complete user interface with all fields including sensitive data
+- `AuthUser` - Sanitized user interface for client-side use (no passwordHash)
+- `UserAccountStatus` - Enum for user account status (ACTIVE, INACTIVE, SUSPENDED, PENDING)
+
+### Authentication Types
+
+- `LoginInput` - Input type for login operations
+- `RegisterInput` - Input type for registration
+- `UpdateProfileInput` - Input type for profile updates
+- `UpdatePasswordInput` - Input type for password changes
+- `AuthPayload` - Response type for auth operations (user + token)
+- `JwtPayload` - JWT token payload structure
+
+### Configuration Types
+
+- `ShieldForgeConfig` - Configuration for @shieldforge/core
+- `AuthProviderConfig` - Configuration for @shieldforge/react
+- `PasskeyConfig` - Configuration for @shieldforge/passkey
+- `SmtpConfig` - SMTP configuration for email sending
+
+### Other Types
+
+- `Session` - Session interface
+- `PasswordStrength` - Password strength result (score + feedback)
+- `PasskeyCredential` - Passkey credential interface
+- `Challenge` - WebAuthn challenge interface
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,160 @@
+/**
+ * User account status enum
+ */
+export declare enum UserAccountStatus {
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE",
+    SUSPENDED = "SUSPENDED",
+    PENDING = "PENDING"
+}
+/**
+ * Core User interface
+ */
+export interface User {
+    id: string;
+    email: string;
+    username?: string;
+    name?: string;
+    passwordHash?: string;
+    accountStatus?: UserAccountStatus;
+    emailVerified?: boolean;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+/**
+ * Sanitized user for client-side (no sensitive fields)
+ */
+export interface AuthUser {
+    id: string;
+    email: string;
+    username?: string;
+    name?: string;
+    accountStatus?: UserAccountStatus;
+    emailVerified?: boolean;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+/**
+ * Session interface
+ */
+export interface Session {
+    userId: string;
+    token: string;
+    expiresAt: Date;
+    createdAt: Date;
+}
+/**
+ * Login input
+ */
+export interface LoginInput {
+    email: string;
+    password: string;
+}
+/**
+ * Register input
+ */
+export interface RegisterInput {
+    email: string;
+    password: string;
+    username?: string;
+    name?: string;
+}
+/**
+ * Update profile input
+ */
+export interface UpdateProfileInput {
+    username?: string;
+    name?: string;
+    email?: string;
+}
+/**
+ * Update password input
+ */
+export interface UpdatePasswordInput {
+    currentPassword: string;
+    newPassword: string;
+}
+/**
+ * Auth payload returned from authentication operations
+ */
+export interface AuthPayload {
+    user: AuthUser;
+    token: string;
+}
+/**
+ * JWT payload structure
+ */
+export interface JwtPayload {
+    userId: string;
+    email: string;
+    iat?: number;
+    exp?: number;
+}
+/**
+ * Password strength result
+ */
+export interface PasswordStrength {
+    score: 0 | 1 | 2 | 3 | 4;
+    feedback: string[];
+}
+/**
+ * SMTP configuration
+ */
+export interface SmtpConfig {
+    host: string;
+    port: number;
+    user: string;
+    pass: string;
+    from: string;
+    secure?: boolean;
+}
+/**
+ * ShieldForge core configuration
+ */
+export interface ShieldForgeConfig {
+    jwtSecret: string;
+    jwtExpiresIn?: string;
+    saltRounds?: number;
+    smtp?: SmtpConfig;
+}
+/**
+ * Passkey service configuration
+ */
+export interface PasskeyConfig {
+    rpName: string;
+    rpId: string;
+    origin: string;
+    challengeTTL?: number;
+}
+/**
+ * Auth provider configuration for React
+ */
+export interface AuthProviderConfig {
+    storageKey?: string;
+    pollInterval?: number;
+    enableCrossTabSync?: boolean;
+    initialToken?: string | null;
+    initialUser?: AuthUser | null;
+}
+/**
+ * Passkey credential
+ */
+export interface PasskeyCredential {
+    id: string;
+    userId: string;
+    credentialId: string;
+    publicKey: string;
+    counter: number;
+    transports?: string[];
+    createdAt?: Date;
+}
+/**
+ * Challenge for WebAuthn
+ */
+export interface Challenge {
+    challenge: string;
+    userId?: string;
+    createdAt: Date;
+    expiresAt: Date;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB"}

package/dist/index.js

@@ -0,0 +1,11 @@
+/**
+ * User account status enum
+ */
+export var UserAccountStatus;
+(function (UserAccountStatus) {
+    UserAccountStatus["ACTIVE"] = "ACTIVE";
+    UserAccountStatus["INACTIVE"] = "INACTIVE";
+    UserAccountStatus["SUSPENDED"] = "SUSPENDED";
+    UserAccountStatus["PENDING"] = "PENDING";
+})(UserAccountStatus || (UserAccountStatus = {}));
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,4CAAuB,CAAA;IACvB,wCAAmB,CAAA;AACrB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@appforgeapps/shieldforge-types",
+  "version": "0.0.5",
+  "description": "Shared TypeScript types for ShieldForge authentication library",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/chriscase/ShieldForge.git",
+    "directory": "packages/types"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "typescript",
+    "types",
+    "authentication",
+    "shieldforge"
+  ],
+  "author": "chriscase",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.3.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,175 @@
+/**
+ * User account status enum
+ */
+export enum UserAccountStatus {
+  ACTIVE = 'ACTIVE',
+  INACTIVE = 'INACTIVE',
+  SUSPENDED = 'SUSPENDED',
+  PENDING = 'PENDING'
+}
+
+/**
+ * Core User interface
+ */
+export interface User {
+  id: string;
+  email: string;
+  username?: string;
+  name?: string;
+  passwordHash?: string;
+  accountStatus?: UserAccountStatus;
+  emailVerified?: boolean;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+/**
+ * Sanitized user for client-side (no sensitive fields)
+ */
+export interface AuthUser {
+  id: string;
+  email: string;
+  username?: string;
+  name?: string;
+  accountStatus?: UserAccountStatus;
+  emailVerified?: boolean;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+/**
+ * Session interface
+ */
+export interface Session {
+  userId: string;
+  token: string;
+  expiresAt: Date;
+  createdAt: Date;
+}
+
+/**
+ * Login input
+ */
+export interface LoginInput {
+  email: string;
+  password: string;
+}
+
+/**
+ * Register input
+ */
+export interface RegisterInput {
+  email: string;
+  password: string;
+  username?: string;
+  name?: string;
+}
+
+/**
+ * Update profile input
+ */
+export interface UpdateProfileInput {
+  username?: string;
+  name?: string;
+  email?: string;
+}
+
+/**
+ * Update password input
+ */
+export interface UpdatePasswordInput {
+  currentPassword: string;
+  newPassword: string;
+}
+
+/**
+ * Auth payload returned from authentication operations
+ */
+export interface AuthPayload {
+  user: AuthUser;
+  token: string;
+}
+
+/**
+ * JWT payload structure
+ */
+export interface JwtPayload {
+  userId: string;
+  email: string;
+  iat?: number;
+  exp?: number;
+}
+
+/**
+ * Password strength result
+ */
+export interface PasswordStrength {
+  score: 0 | 1 | 2 | 3 | 4;
+  feedback: string[];
+}
+
+/**
+ * SMTP configuration
+ */
+export interface SmtpConfig {
+  host: string;
+  port: number;
+  user: string;
+  pass: string;
+  from: string;
+  secure?: boolean;
+}
+
+/**
+ * ShieldForge core configuration
+ */
+export interface ShieldForgeConfig {
+  jwtSecret: string;
+  jwtExpiresIn?: string;
+  saltRounds?: number;
+  smtp?: SmtpConfig;
+}
+
+/**
+ * Passkey service configuration
+ */
+export interface PasskeyConfig {
+  rpName: string;
+  rpId: string;
+  origin: string;
+  challengeTTL?: number;
+}
+
+/**
+ * Auth provider configuration for React
+ */
+export interface AuthProviderConfig {
+  storageKey?: string;
+  pollInterval?: number;
+  enableCrossTabSync?: boolean;
+  initialToken?: string | null;
+  initialUser?: AuthUser | null;
+}
+
+/**
+ * Passkey credential
+ */
+export interface PasskeyCredential {
+  id: string;
+  userId: string;
+  credentialId: string;
+  publicKey: string;
+  counter: number;
+  transports?: string[];
+  createdAt?: Date;
+}
+
+/**
+ * Challenge for WebAuthn
+ */
+export interface Challenge {
+  challenge: string;
+  userId?: string;
+  createdAt: Date;
+  expiresAt: Date;
+}