@qyh213/easyauth-client 1.0.0-beta.1

package/dist/client-RPDHpVsj.d.mts

@@ -0,0 +1,300 @@
+/**
+ * Easy Auth Client - Type Definitions
+ */
+interface EasyAuthConfig {
+    /** Base URL of the Easy Auth service */
+    baseUrl: string;
+    /** API Key for admin operations (keep secret!) */
+    apiKey?: string;
+    /** Default token expiration in hours */
+    defaultTokenExpiry?: number;
+}
+interface LoginCredentials {
+    email: string;
+    password: string;
+    /** Token expiration in hours (overrides default) */
+    expiresInHours?: number;
+    /** Scopes to request for the token */
+    scopes?: string[];
+}
+interface AuthToken {
+    accessToken: string;
+    tokenType: "Bearer";
+    expiresIn: number;
+    expiresAt: string;
+    userId: string;
+    email: string;
+    scopes?: string[];
+}
+interface ValidationResult {
+    valid: boolean;
+    type?: "token" | "api_key";
+    serviceId?: string;
+    scope?: "admin" | "service" | "user";
+    scopes?: string[];
+    userId?: string;
+    email?: string;
+    keyId?: string;
+    error?: string;
+}
+interface IntrospectRequest {
+    serviceId: string;
+    /** Either token or apiKey must be provided */
+    token?: string;
+    apiKey?: string;
+    /** Required scopes to check */
+    requiredScopes?: string[];
+}
+interface IntrospectResponse {
+    valid: boolean;
+    type?: "bearer" | "api_key";
+    userId?: string;
+    email?: string;
+    scopes?: string[];
+    keyId?: string;
+    error?: string;
+    required?: string[];
+    provided?: string[];
+}
+interface User {
+    userId: string;
+    email: string;
+    createdAt: string;
+}
+interface CreateUserRequest {
+    email: string;
+    password: string;
+    userId?: string;
+    scopes?: string[];
+}
+interface UserListResponse {
+    users: User[];
+}
+interface ApiKey {
+    keyId: string;
+    name: string;
+    scope: string;
+    scopes: Scope[];
+    keyType: string;
+    tpsLimit: number;
+    revoked: boolean;
+    createdAt: string;
+}
+interface CreateApiKeyRequest {
+    name: string;
+    scope?: string;
+    /** Custom granular scopes */
+    scopes?: string[];
+    keyType?: string;
+    tpsLimit?: number;
+}
+interface CreateApiKeyResponse {
+    keyId: string;
+    apiKey: string;
+    name: string;
+    scope: string;
+    scopes: string[];
+}
+interface Scope {
+    scopeId: string;
+    name: string;
+    key: string;
+    description?: string;
+    createdAt: string;
+}
+interface CreateScopeRequest {
+    name: string;
+    key: string;
+    description?: string;
+}
+interface Service {
+    serviceId: string;
+    serviceName: string;
+    ownerEmail: string;
+    createdAt: string;
+    userCount: number;
+    apiKeyCount: number;
+    webhookCount: number;
+}
+interface OnboardRequest {
+    serviceName: string;
+    ownerEmail: string;
+}
+interface OnboardResponse {
+    serviceId: string;
+    serviceName: string;
+    ownerEmail: string;
+    adminKeyId: string;
+    serviceAdminApiKey: string;
+    createdAt: string;
+}
+interface Webhook {
+    webhookId: string;
+    url: string;
+    events: string[];
+    active: boolean;
+    createdAt: string;
+}
+interface RegisterWebhookRequest {
+    url: string;
+    events: string[];
+    secret?: string;
+}
+declare class EasyAuthError extends Error {
+    code: string;
+    statusCode?: number | undefined;
+    constructor(message: string, code: string, statusCode?: number | undefined);
+}
+declare class ScopeError extends EasyAuthError {
+    requiredScopes: string[];
+    providedScopes: string[];
+    constructor(message: string, requiredScopes: string[], providedScopes: string[]);
+}
+interface TokenStorage {
+    getToken(): string | null;
+    setToken(token: string): void;
+    removeToken(): void;
+}
+declare class LocalStorageTokenStorage implements TokenStorage {
+    private static readonly KEY;
+    getToken(): string | null;
+    setToken(token: string): void;
+    removeToken(): void;
+}
+declare class MemoryTokenStorage implements TokenStorage {
+    private token;
+    getToken(): string | null;
+    setToken(token: string): void;
+    removeToken(): void;
+}
+
+/**
+ * Easy Auth Client - Core Client Implementation
+ */
+
+declare class EasyAuthClient {
+    private config;
+    private tokenStorage;
+    constructor(config: EasyAuthConfig, tokenStorage?: TokenStorage);
+    private request;
+    /**
+     * Update the client's service configuration
+     */
+    configure(config: Partial<EasyAuthConfig>): void;
+    /**
+     * Get current configuration (without sensitive data)
+     */
+    getConfig(): Omit<EasyAuthConfig, "apiKey">;
+    /**
+     * Get the stored access token
+     */
+    getAccessToken(): string | null;
+    /**
+     * Store an access token
+     */
+    setAccessToken(token: string): void;
+    /**
+     * Remove the stored access token (logout)
+     */
+    clearAccessToken(): void;
+    /**
+     * Check if user is logged in
+     */
+    isLoggedIn(): boolean;
+    /**
+     * Introspect a token or API key and validate required scopes
+     */
+    introspect(request: IntrospectRequest): Promise<IntrospectResponse>;
+    /**
+     * Validate the current token with optional scope checking
+     */
+    validateWithScopes(requiredScopes?: string[]): Promise<ValidationResult>;
+    /**
+     * Check if the current user has all the required scopes
+     * Throws ScopeError if scopes are insufficient
+     */
+    requireScopes(...requiredScopes: string[]): Promise<ValidationResult>;
+    /**
+     * Execute a function only if the user has the required scopes
+     */
+    withScope<T>(scopes: string[], fn: () => Promise<T>): Promise<T>;
+    /**
+     * Login a user and store the access token
+     */
+    login(credentials: LoginCredentials): Promise<AuthToken>;
+    /**
+     * Logout the current user
+     */
+    logout(): Promise<void>;
+    /**
+     * Validate the current token or an API key
+     * @deprecated Use validateWithScopes instead
+     */
+    validate(_credential?: string): Promise<ValidationResult>;
+    /**
+     * Refresh the current token
+     */
+    refreshToken(): Promise<AuthToken>;
+    /**
+     * Create a new user (requires admin API key)
+     */
+    createUser(request: CreateUserRequest): Promise<User>;
+    /**
+     * List all users for the service
+     */
+    listUsers(): Promise<User[]>;
+    /**
+     * Delete a user
+     */
+    deleteUser(userId: string): Promise<void>;
+    /**
+     * Update user password
+     */
+    updatePassword(userId: string, oldPassword: string, newPassword: string): Promise<void>;
+    /**
+     * List custom scopes for the service
+     */
+    listScopes(): Promise<Scope[]>;
+    /**
+     * Create a custom scope
+     */
+    createScope(request: CreateScopeRequest): Promise<Scope>;
+    /**
+     * Delete a custom scope
+     */
+    deleteScope(scopeId: string): Promise<void>;
+    /**
+     * List all API keys for the service
+     */
+    listApiKeys(): Promise<ApiKey[]>;
+    /**
+     * Create a new API key with optional custom scopes
+     */
+    createApiKey(request: CreateApiKeyRequest): Promise<CreateApiKeyResponse>;
+    /**
+     * Revoke an API key
+     */
+    revokeApiKey(keyId: string): Promise<void>;
+    /**
+     * Onboard a new service (requires master admin key)
+     */
+    onboardService(request: OnboardRequest, masterAdminKey: string): Promise<OnboardResponse>;
+    /**
+     * Delete a service (requires master admin key)
+     */
+    deleteService(serviceId: string, masterAdminKey: string): Promise<void>;
+    /**
+     * List webhooks
+     */
+    listWebhooks(): Promise<Webhook[]>;
+    /**
+     * Register a webhook
+     */
+    registerWebhook(request: RegisterWebhookRequest): Promise<Webhook>;
+    /**
+     * Delete a webhook
+     */
+    deleteWebhook(webhookId: string): Promise<void>;
+}
+
+export { type ApiKey as A, type CreateApiKeyRequest as C, EasyAuthClient as E, type IntrospectRequest as I, LocalStorageTokenStorage as L, MemoryTokenStorage as M, type OnboardRequest as O, type RegisterWebhookRequest as R, type Scope as S, type TokenStorage as T, type User as U, type ValidationResult as V, type Webhook as W, type AuthToken as a, type CreateApiKeyResponse as b, type CreateScopeRequest as c, type CreateUserRequest as d, type EasyAuthConfig as e, EasyAuthError as f, type IntrospectResponse as g, type LoginCredentials as h, type OnboardResponse as i, ScopeError as j, type Service as k, type UserListResponse as l };

package/dist/client-RPDHpVsj.d.ts

@@ -0,0 +1,300 @@
+/**
+ * Easy Auth Client - Type Definitions
+ */
+interface EasyAuthConfig {
+    /** Base URL of the Easy Auth service */
+    baseUrl: string;
+    /** API Key for admin operations (keep secret!) */
+    apiKey?: string;
+    /** Default token expiration in hours */
+    defaultTokenExpiry?: number;
+}
+interface LoginCredentials {
+    email: string;
+    password: string;
+    /** Token expiration in hours (overrides default) */
+    expiresInHours?: number;
+    /** Scopes to request for the token */
+    scopes?: string[];
+}
+interface AuthToken {
+    accessToken: string;
+    tokenType: "Bearer";
+    expiresIn: number;
+    expiresAt: string;
+    userId: string;
+    email: string;
+    scopes?: string[];
+}
+interface ValidationResult {
+    valid: boolean;
+    type?: "token" | "api_key";
+    serviceId?: string;
+    scope?: "admin" | "service" | "user";
+    scopes?: string[];
+    userId?: string;
+    email?: string;
+    keyId?: string;
+    error?: string;
+}
+interface IntrospectRequest {
+    serviceId: string;
+    /** Either token or apiKey must be provided */
+    token?: string;
+    apiKey?: string;
+    /** Required scopes to check */
+    requiredScopes?: string[];
+}
+interface IntrospectResponse {
+    valid: boolean;
+    type?: "bearer" | "api_key";
+    userId?: string;
+    email?: string;
+    scopes?: string[];
+    keyId?: string;
+    error?: string;
+    required?: string[];
+    provided?: string[];
+}
+interface User {
+    userId: string;
+    email: string;
+    createdAt: string;
+}
+interface CreateUserRequest {
+    email: string;
+    password: string;
+    userId?: string;
+    scopes?: string[];
+}
+interface UserListResponse {
+    users: User[];
+}
+interface ApiKey {
+    keyId: string;
+    name: string;
+    scope: string;
+    scopes: Scope[];
+    keyType: string;
+    tpsLimit: number;
+    revoked: boolean;
+    createdAt: string;
+}
+interface CreateApiKeyRequest {
+    name: string;
+    scope?: string;
+    /** Custom granular scopes */
+    scopes?: string[];
+    keyType?: string;
+    tpsLimit?: number;
+}
+interface CreateApiKeyResponse {
+    keyId: string;
+    apiKey: string;
+    name: string;
+    scope: string;
+    scopes: string[];
+}
+interface Scope {
+    scopeId: string;
+    name: string;
+    key: string;
+    description?: string;
+    createdAt: string;
+}
+interface CreateScopeRequest {
+    name: string;
+    key: string;
+    description?: string;
+}
+interface Service {
+    serviceId: string;
+    serviceName: string;
+    ownerEmail: string;
+    createdAt: string;
+    userCount: number;
+    apiKeyCount: number;
+    webhookCount: number;
+}
+interface OnboardRequest {
+    serviceName: string;
+    ownerEmail: string;
+}
+interface OnboardResponse {
+    serviceId: string;
+    serviceName: string;
+    ownerEmail: string;
+    adminKeyId: string;
+    serviceAdminApiKey: string;
+    createdAt: string;
+}
+interface Webhook {
+    webhookId: string;
+    url: string;
+    events: string[];
+    active: boolean;
+    createdAt: string;
+}
+interface RegisterWebhookRequest {
+    url: string;
+    events: string[];
+    secret?: string;
+}
+declare class EasyAuthError extends Error {
+    code: string;
+    statusCode?: number | undefined;
+    constructor(message: string, code: string, statusCode?: number | undefined);
+}
+declare class ScopeError extends EasyAuthError {
+    requiredScopes: string[];
+    providedScopes: string[];
+    constructor(message: string, requiredScopes: string[], providedScopes: string[]);
+}
+interface TokenStorage {
+    getToken(): string | null;
+    setToken(token: string): void;
+    removeToken(): void;
+}
+declare class LocalStorageTokenStorage implements TokenStorage {
+    private static readonly KEY;
+    getToken(): string | null;
+    setToken(token: string): void;
+    removeToken(): void;
+}
+declare class MemoryTokenStorage implements TokenStorage {
+    private token;
+    getToken(): string | null;
+    setToken(token: string): void;
+    removeToken(): void;
+}
+
+/**
+ * Easy Auth Client - Core Client Implementation
+ */
+
+declare class EasyAuthClient {
+    private config;
+    private tokenStorage;
+    constructor(config: EasyAuthConfig, tokenStorage?: TokenStorage);
+    private request;
+    /**
+     * Update the client's service configuration
+     */
+    configure(config: Partial<EasyAuthConfig>): void;
+    /**
+     * Get current configuration (without sensitive data)
+     */
+    getConfig(): Omit<EasyAuthConfig, "apiKey">;
+    /**
+     * Get the stored access token
+     */
+    getAccessToken(): string | null;
+    /**
+     * Store an access token
+     */
+    setAccessToken(token: string): void;
+    /**
+     * Remove the stored access token (logout)
+     */
+    clearAccessToken(): void;
+    /**
+     * Check if user is logged in
+     */
+    isLoggedIn(): boolean;
+    /**
+     * Introspect a token or API key and validate required scopes
+     */
+    introspect(request: IntrospectRequest): Promise<IntrospectResponse>;
+    /**
+     * Validate the current token with optional scope checking
+     */
+    validateWithScopes(requiredScopes?: string[]): Promise<ValidationResult>;
+    /**
+     * Check if the current user has all the required scopes
+     * Throws ScopeError if scopes are insufficient
+     */
+    requireScopes(...requiredScopes: string[]): Promise<ValidationResult>;
+    /**
+     * Execute a function only if the user has the required scopes
+     */
+    withScope<T>(scopes: string[], fn: () => Promise<T>): Promise<T>;
+    /**
+     * Login a user and store the access token
+     */
+    login(credentials: LoginCredentials): Promise<AuthToken>;
+    /**
+     * Logout the current user
+     */
+    logout(): Promise<void>;
+    /**
+     * Validate the current token or an API key
+     * @deprecated Use validateWithScopes instead
+     */
+    validate(_credential?: string): Promise<ValidationResult>;
+    /**
+     * Refresh the current token
+     */
+    refreshToken(): Promise<AuthToken>;
+    /**
+     * Create a new user (requires admin API key)
+     */
+    createUser(request: CreateUserRequest): Promise<User>;
+    /**
+     * List all users for the service
+     */
+    listUsers(): Promise<User[]>;
+    /**
+     * Delete a user
+     */
+    deleteUser(userId: string): Promise<void>;
+    /**
+     * Update user password
+     */
+    updatePassword(userId: string, oldPassword: string, newPassword: string): Promise<void>;
+    /**
+     * List custom scopes for the service
+     */
+    listScopes(): Promise<Scope[]>;
+    /**
+     * Create a custom scope
+     */
+    createScope(request: CreateScopeRequest): Promise<Scope>;
+    /**
+     * Delete a custom scope
+     */
+    deleteScope(scopeId: string): Promise<void>;
+    /**
+     * List all API keys for the service
+     */
+    listApiKeys(): Promise<ApiKey[]>;
+    /**
+     * Create a new API key with optional custom scopes
+     */
+    createApiKey(request: CreateApiKeyRequest): Promise<CreateApiKeyResponse>;
+    /**
+     * Revoke an API key
+     */
+    revokeApiKey(keyId: string): Promise<void>;
+    /**
+     * Onboard a new service (requires master admin key)
+     */
+    onboardService(request: OnboardRequest, masterAdminKey: string): Promise<OnboardResponse>;
+    /**
+     * Delete a service (requires master admin key)
+     */
+    deleteService(serviceId: string, masterAdminKey: string): Promise<void>;
+    /**
+     * List webhooks
+     */
+    listWebhooks(): Promise<Webhook[]>;
+    /**
+     * Register a webhook
+     */
+    registerWebhook(request: RegisterWebhookRequest): Promise<Webhook>;
+    /**
+     * Delete a webhook
+     */
+    deleteWebhook(webhookId: string): Promise<void>;
+}
+
+export { type ApiKey as A, type CreateApiKeyRequest as C, EasyAuthClient as E, type IntrospectRequest as I, LocalStorageTokenStorage as L, MemoryTokenStorage as M, type OnboardRequest as O, type RegisterWebhookRequest as R, type Scope as S, type TokenStorage as T, type User as U, type ValidationResult as V, type Webhook as W, type AuthToken as a, type CreateApiKeyResponse as b, type CreateScopeRequest as c, type CreateUserRequest as d, type EasyAuthConfig as e, EasyAuthError as f, type IntrospectResponse as g, type LoginCredentials as h, type OnboardResponse as i, ScopeError as j, type Service as k, type UserListResponse as l };

package/dist/index.d.mts

@@ -0,0 +1,31 @@
+export { A as ApiKey, a as AuthToken, C as CreateApiKeyRequest, b as CreateApiKeyResponse, c as CreateScopeRequest, d as CreateUserRequest, E as EasyAuthClient, e as EasyAuthConfig, f as EasyAuthError, I as IntrospectRequest, g as IntrospectResponse, L as LocalStorageTokenStorage, h as LoginCredentials, M as MemoryTokenStorage, O as OnboardRequest, i as OnboardResponse, R as RegisterWebhookRequest, S as Scope, j as ScopeError, k as Service, T as TokenStorage, U as User, l as UserListResponse, V as ValidationResult, W as Webhook } from './client-RPDHpVsj.mjs';
+
+/**
+ * Easy Auth Client
+ *
+ * Official client library for Easy Auth - Multi-tenant authentication-as-a-service
+ *
+ * @example
+ * ```typescript
+ * import { EasyAuthClient } from "@easyauth/client";
+ *
+ * const client = new EasyAuthClient({
+ *   baseUrl: "https://auth.yourapp.com",
+ *   serviceId: "svc-xxx",
+ *   apiKey: "ak-xxx",
+ * });
+ *
+ * // Login
+ * const token = await client.login({
+ *   email: "user@example.com",
+ *   password: "password123",
+ * });
+ *
+ * // Validate token
+ * const isValid = await client.validate();
+ * ```
+ */
+
+declare const VERSION = "1.0.0";
+
+export { VERSION };

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+export { A as ApiKey, a as AuthToken, C as CreateApiKeyRequest, b as CreateApiKeyResponse, c as CreateScopeRequest, d as CreateUserRequest, E as EasyAuthClient, e as EasyAuthConfig, f as EasyAuthError, I as IntrospectRequest, g as IntrospectResponse, L as LocalStorageTokenStorage, h as LoginCredentials, M as MemoryTokenStorage, O as OnboardRequest, i as OnboardResponse, R as RegisterWebhookRequest, S as Scope, j as ScopeError, k as Service, T as TokenStorage, U as User, l as UserListResponse, V as ValidationResult, W as Webhook } from './client-RPDHpVsj.js';
+
+/**
+ * Easy Auth Client
+ *
+ * Official client library for Easy Auth - Multi-tenant authentication-as-a-service
+ *
+ * @example
+ * ```typescript
+ * import { EasyAuthClient } from "@easyauth/client";
+ *
+ * const client = new EasyAuthClient({
+ *   baseUrl: "https://auth.yourapp.com",
+ *   serviceId: "svc-xxx",
+ *   apiKey: "ak-xxx",
+ * });
+ *
+ * // Login
+ * const token = await client.login({
+ *   email: "user@example.com",
+ *   password: "password123",
+ * });
+ *
+ * // Validate token
+ * const isValid = await client.validate();
+ * ```
+ */
+
+declare const VERSION = "1.0.0";
+
+export { VERSION };