@block-auth.io/node 0.0.0-stage → 0.1.0

package/dist/routes-DR0gMSlM.d.cts

@@ -0,0 +1,132 @@
+declare const DEFAULT_WS_URL = "wss://wss.block-auth.io";
+interface BlockAuthRole {
+    slug?: string;
+    name?: string;
+    [key: string]: unknown;
+}
+interface AuthorizeResult {
+    url: string;
+    expiresAt: string;
+}
+interface TokenResult {
+    address: string;
+    did?: string;
+    signedNonce?: number;
+    signedAt?: string;
+    signedExpiredAt: string;
+    roles: BlockAuthRole[];
+    externalId?: string | null;
+}
+interface WebhookEvent {
+    event: string;
+    apiKey: string;
+    address: string;
+    externalId?: string | null;
+    sessionId?: string | null;
+    reason?: string;
+    iat: number;
+    jti: string;
+}
+interface AuthCodeClientOptions {
+    wsUrl?: string;
+    timeoutMs?: number;
+    fetch?: typeof fetch;
+}
+declare function sha256Hex(value: string): string;
+declare function buildWsServerApiUrl(path: string, wsUrl?: string): string;
+declare class AuthCodeClient {
+    readonly apiKey: string;
+    private readonly secretHash;
+    private readonly wsUrl;
+    private readonly timeoutMs;
+    private readonly fetchImpl;
+    constructor(apiKey: string, apiSecret: string, options?: AuthCodeClientOptions);
+    authorize(redirectUri: string, state: string, responseMode?: string): Promise<AuthorizeResult>;
+    exchangeCode(code: string, redirectUri: string, codeVerifier?: string, linkExternalId?: string): Promise<TokenResult>;
+    signOut(address: string): Promise<{
+        closed?: number;
+    }>;
+    revokeLink(externalId: string): Promise<{
+        revoked: boolean;
+    }>;
+    verifyWebhook(rawBody: string | Buffer, timestamp: string | undefined, signature: string | undefined, maxSkewSeconds?: number): WebhookEvent;
+    private post;
+}
+
+declare const DEFAULT_BASE_PATH = "/auth/blockauth";
+declare const ROUTE_NAMES: readonly ["code", "me", "logout", "link", "webhook"];
+type RouteName = (typeof ROUTE_NAMES)[number];
+interface SessionUser {
+    address: string;
+    did: string;
+    roles: BlockAuthRole[];
+    externalId: string | null;
+    loggedInAt: number;
+    expiresAt: number;
+    data?: Record<string, unknown>;
+}
+interface SessionStore {
+    get(key: string): unknown | Promise<unknown>;
+    set(key: string, value: unknown): void | Promise<void>;
+    remove(key: string): void | Promise<void>;
+    regenerate(): void | Promise<void>;
+}
+interface AppUser {
+    id: string | number;
+    linked?: boolean;
+}
+interface RouteContext {
+    session: SessionStore;
+    request?: unknown;
+}
+interface RouteResponse {
+    status: number;
+    body: Record<string, unknown>;
+}
+type MaybePromise<T> = T | Promise<T>;
+interface BlockAuthRoutesOptions {
+    apiKey: string;
+    apiSecret: string;
+    appUrl?: string;
+    allowedOrigins?: string[];
+    sessionKey?: string;
+    maxSessionSeconds?: number;
+    basePath?: string;
+    routes?: Partial<Record<RouteName, boolean>>;
+    onLogin?: (user: SessionUser, context: RouteContext) => MaybePromise<Record<string, unknown> | false | void>;
+    onLogout?: (user: SessionUser, context: RouteContext) => MaybePromise<void>;
+    appUser?: (context: RouteContext) => MaybePromise<AppUser | null | undefined>;
+    onLinked?: (appUserId: string | number, user: TokenResult, context: RouteContext) => MaybePromise<void>;
+    onSignout?: (event: WebhookEvent) => MaybePromise<void>;
+    onUnlinked?: (event: WebhookEvent) => MaybePromise<void>;
+    isReplay?: (jti: string, event: WebhookEvent) => MaybePromise<boolean>;
+    isRevoked?: (user: SessionUser) => MaybePromise<boolean>;
+    webhookMaxSkewSeconds?: number;
+    wsUrl?: string;
+    timeoutMs?: number;
+    client?: AuthCodeClient;
+    logger?: (message: string, error?: unknown) => void;
+}
+declare class BlockAuthRoutes {
+    readonly client: AuthCodeClient;
+    readonly basePath: string;
+    readonly allowedOrigins: ReadonlySet<string>;
+    private readonly options;
+    private readonly sessionKey;
+    private readonly enabled;
+    constructor(options: BlockAuthRoutesOptions);
+    currentUser(context: RouteContext): Promise<SessionUser | null>;
+    code(body: unknown, context: RouteContext): Promise<RouteResponse>;
+    me(context: RouteContext): Promise<RouteResponse>;
+    logout(context: RouteContext): Promise<RouteResponse>;
+    linkStatus(context: RouteContext): Promise<RouteResponse>;
+    link(body: unknown, context: RouteContext): Promise<RouteResponse>;
+    webhook(rawBody: string | Buffer, timestamp?: string, signature?: string): Promise<RouteResponse>;
+    dispatch(method: string, path: string, rawBody: string | Buffer, header: (name: string) => string | undefined, context: RouteContext): Promise<RouteResponse | null>;
+    private codeParams;
+    private expiresAt;
+    private resolveAppUser;
+    private log;
+}
+
+export { type AppUser as A, BlockAuthRoutes as B, DEFAULT_BASE_PATH as D, type RouteResponse as R, type SessionStore as S, type TokenResult as T, type WebhookEvent as W, AuthCodeClient as a, type AuthCodeClientOptions as b, type AuthorizeResult as c, type BlockAuthRole as d, type BlockAuthRoutesOptions as e, DEFAULT_WS_URL as f, type RouteContext as g, type RouteName as h, type SessionUser as i, buildWsServerApiUrl as j, sha256Hex as s };

package/dist/routes-DR0gMSlM.d.ts

@@ -0,0 +1,132 @@
+declare const DEFAULT_WS_URL = "wss://wss.block-auth.io";
+interface BlockAuthRole {
+    slug?: string;
+    name?: string;
+    [key: string]: unknown;
+}
+interface AuthorizeResult {
+    url: string;
+    expiresAt: string;
+}
+interface TokenResult {
+    address: string;
+    did?: string;
+    signedNonce?: number;
+    signedAt?: string;
+    signedExpiredAt: string;
+    roles: BlockAuthRole[];
+    externalId?: string | null;
+}
+interface WebhookEvent {
+    event: string;
+    apiKey: string;
+    address: string;
+    externalId?: string | null;
+    sessionId?: string | null;
+    reason?: string;
+    iat: number;
+    jti: string;
+}
+interface AuthCodeClientOptions {
+    wsUrl?: string;
+    timeoutMs?: number;
+    fetch?: typeof fetch;
+}
+declare function sha256Hex(value: string): string;
+declare function buildWsServerApiUrl(path: string, wsUrl?: string): string;
+declare class AuthCodeClient {
+    readonly apiKey: string;
+    private readonly secretHash;
+    private readonly wsUrl;
+    private readonly timeoutMs;
+    private readonly fetchImpl;
+    constructor(apiKey: string, apiSecret: string, options?: AuthCodeClientOptions);
+    authorize(redirectUri: string, state: string, responseMode?: string): Promise<AuthorizeResult>;
+    exchangeCode(code: string, redirectUri: string, codeVerifier?: string, linkExternalId?: string): Promise<TokenResult>;
+    signOut(address: string): Promise<{
+        closed?: number;
+    }>;
+    revokeLink(externalId: string): Promise<{
+        revoked: boolean;
+    }>;
+    verifyWebhook(rawBody: string | Buffer, timestamp: string | undefined, signature: string | undefined, maxSkewSeconds?: number): WebhookEvent;
+    private post;
+}
+
+declare const DEFAULT_BASE_PATH = "/auth/blockauth";
+declare const ROUTE_NAMES: readonly ["code", "me", "logout", "link", "webhook"];
+type RouteName = (typeof ROUTE_NAMES)[number];
+interface SessionUser {
+    address: string;
+    did: string;
+    roles: BlockAuthRole[];
+    externalId: string | null;
+    loggedInAt: number;
+    expiresAt: number;
+    data?: Record<string, unknown>;
+}
+interface SessionStore {
+    get(key: string): unknown | Promise<unknown>;
+    set(key: string, value: unknown): void | Promise<void>;
+    remove(key: string): void | Promise<void>;
+    regenerate(): void | Promise<void>;
+}
+interface AppUser {
+    id: string | number;
+    linked?: boolean;
+}
+interface RouteContext {
+    session: SessionStore;
+    request?: unknown;
+}
+interface RouteResponse {
+    status: number;
+    body: Record<string, unknown>;
+}
+type MaybePromise<T> = T | Promise<T>;
+interface BlockAuthRoutesOptions {
+    apiKey: string;
+    apiSecret: string;
+    appUrl?: string;
+    allowedOrigins?: string[];
+    sessionKey?: string;
+    maxSessionSeconds?: number;
+    basePath?: string;
+    routes?: Partial<Record<RouteName, boolean>>;
+    onLogin?: (user: SessionUser, context: RouteContext) => MaybePromise<Record<string, unknown> | false | void>;
+    onLogout?: (user: SessionUser, context: RouteContext) => MaybePromise<void>;
+    appUser?: (context: RouteContext) => MaybePromise<AppUser | null | undefined>;
+    onLinked?: (appUserId: string | number, user: TokenResult, context: RouteContext) => MaybePromise<void>;
+    onSignout?: (event: WebhookEvent) => MaybePromise<void>;
+    onUnlinked?: (event: WebhookEvent) => MaybePromise<void>;
+    isReplay?: (jti: string, event: WebhookEvent) => MaybePromise<boolean>;
+    isRevoked?: (user: SessionUser) => MaybePromise<boolean>;
+    webhookMaxSkewSeconds?: number;
+    wsUrl?: string;
+    timeoutMs?: number;
+    client?: AuthCodeClient;
+    logger?: (message: string, error?: unknown) => void;
+}
+declare class BlockAuthRoutes {
+    readonly client: AuthCodeClient;
+    readonly basePath: string;
+    readonly allowedOrigins: ReadonlySet<string>;
+    private readonly options;
+    private readonly sessionKey;
+    private readonly enabled;
+    constructor(options: BlockAuthRoutesOptions);
+    currentUser(context: RouteContext): Promise<SessionUser | null>;
+    code(body: unknown, context: RouteContext): Promise<RouteResponse>;
+    me(context: RouteContext): Promise<RouteResponse>;
+    logout(context: RouteContext): Promise<RouteResponse>;
+    linkStatus(context: RouteContext): Promise<RouteResponse>;
+    link(body: unknown, context: RouteContext): Promise<RouteResponse>;
+    webhook(rawBody: string | Buffer, timestamp?: string, signature?: string): Promise<RouteResponse>;
+    dispatch(method: string, path: string, rawBody: string | Buffer, header: (name: string) => string | undefined, context: RouteContext): Promise<RouteResponse | null>;
+    private codeParams;
+    private expiresAt;
+    private resolveAppUser;
+    private log;
+}
+
+export { type AppUser as A, BlockAuthRoutes as B, DEFAULT_BASE_PATH as D, type RouteResponse as R, type SessionStore as S, type TokenResult as T, type WebhookEvent as W, AuthCodeClient as a, type AuthCodeClientOptions as b, type AuthorizeResult as c, type BlockAuthRole as d, type BlockAuthRoutesOptions as e, DEFAULT_WS_URL as f, type RouteContext as g, type RouteName as h, type SessionUser as i, buildWsServerApiUrl as j, sha256Hex as s };

package/package.json

@@ -1,6 +1,55 @@
 {
   "name": "@block-auth.io/node",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Block-Auth backend SDK for Node.js: login code exchange, backend routes, sessions and webhooks.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./express": {
+      "types": "./dist/express.d.ts",
+      "import": "./dist/express.js",
+      "require": "./dist/express.cjs"
+    }
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "engines": {
+    "node": ">=18.17"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch --no-clean",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src"
+  },
+  "peerDependencies": {
+    "express": "^4.18.0 || ^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "express": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "@types/express-session": "^1.18.0",
+    "@types/node": "^22.0.0",
+    "express": "^5.1.0",
+    "express-session": "^1.18.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.5.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}