@vekil/app-sdk 0.4.0

package/dist/runtime.d.cts

@@ -0,0 +1,188 @@
+import { IncomingMessage, ServerResponse } from 'node:http';
+import { A as AppSignatureAlgorithm, a as AppPublicSigningJwk, b as AppCompleteInstallationRequest, c as AppCompleteInstallationResponse, d as AppDisconnectInstallationRequest, e as AppDisconnectInstallationResponse, f as AppExecuteActionRequest, g as AppExecuteActionResponse, h as AppRuntimeHealthResponse, i as AppPlanActionRequest, j as AppPlanActionResponse, k as AppPrepareInstallationRequest, l as AppPrepareInstallationResponse, m as AppManifest, n as AppJwks, o as AppRuntimeHealthStatus } from './signature-envelope-DzT4yjFP.cjs';
+import { webcrypto } from 'node:crypto';
+import 'zod';
+
+interface AppPrivateSigningJwk extends webcrypto.JsonWebKey {
+    alg: typeof AppSignatureAlgorithm.ED25519;
+    crv: "Ed25519";
+    d: string;
+    kid: string;
+    kty: "OKP";
+    use: "sig";
+    x: string;
+}
+interface AppProtocolSigningIdentity {
+    issuer: string;
+    keyId: string;
+    privateKeyJwk: AppPrivateSigningJwk;
+}
+declare function readAppProtocolSigningIdentity({ issuer, keyId, privateJwkBase64url }: {
+    issuer: string;
+    keyId?: string;
+    privateJwkBase64url?: string;
+}): AppProtocolSigningIdentity | null;
+declare function deriveAppPublicSigningJwk(identity: AppProtocolSigningIdentity): AppPublicSigningJwk;
+
+interface AppJwksResolver {
+    resolve(jwksUrl: string, keyId: string): Promise<AppPublicSigningJwk | null>;
+}
+
+interface AppSignatureReplayClaim {
+    audience: string;
+    expiresAt: Date;
+    issuer: string;
+    keyId: string;
+    nonce: string;
+}
+interface AppSignatureReplayStore {
+    claim(input: AppSignatureReplayClaim): Promise<boolean>;
+}
+
+type RuntimeMethod = "GET" | "POST";
+type RuntimeHeaders = Headers | Record<string, string | string[] | undefined>;
+interface AppRuntimeV1ServerRequest {
+    body: string;
+    headers: RuntimeHeaders;
+    method: RuntimeMethod;
+    path: string;
+}
+interface AppRuntimeV1ServerResponse {
+    body: string;
+    headers: Record<string, string>;
+    statusCode: number;
+}
+interface AppRuntimeV1Handlers {
+    completeInstallation(request: AppCompleteInstallationRequest): Promise<AppCompleteInstallationResponse>;
+    disconnectInstallation(request: AppDisconnectInstallationRequest): Promise<AppDisconnectInstallationResponse>;
+    executeAction(request: AppExecuteActionRequest): Promise<AppExecuteActionResponse>;
+    health(): Promise<AppRuntimeHealthResponse>;
+    planAction(request: AppPlanActionRequest): Promise<AppPlanActionResponse>;
+    prepareInstallation(request: AppPrepareInstallationRequest): Promise<AppPrepareInstallationResponse>;
+}
+interface AppRuntimeV1ServerConfig {
+    appId: string;
+    appVersion: string;
+    handlers: AppRuntimeV1Handlers;
+    manifest: AppManifest;
+    jwksResolver?: AppJwksResolver;
+    nonceFactory?: () => string;
+    now?: () => Date;
+    platformIssuer: string;
+    platformJwksUrl: string;
+    replayStore: AppSignatureReplayStore;
+    signatureLifetimeMs?: number;
+    signingIdentity: AppProtocolSigningIdentity;
+}
+declare enum AppRuntimeV1ServerErrorCode {
+    ROUTE_NOT_FOUND = "APP_RUNTIME_V1_ROUTE_NOT_FOUND",
+    REQUEST_TOO_LARGE = "APP_RUNTIME_V1_REQUEST_TOO_LARGE",
+    REQUEST_JSON_INVALID = "APP_RUNTIME_V1_REQUEST_JSON_INVALID",
+    REQUEST_SCHEMA_INVALID = "APP_RUNTIME_V1_REQUEST_SCHEMA_INVALID",
+    REQUEST_IDENTITY_INVALID = "APP_RUNTIME_V1_REQUEST_IDENTITY_INVALID",
+    REQUEST_SIGNATURE_INVALID = "APP_RUNTIME_V1_REQUEST_SIGNATURE_INVALID"
+}
+declare class AppRuntimeV1ServerError extends Error {
+    readonly code: AppRuntimeV1ServerErrorCode;
+    readonly statusCode: number;
+    constructor({ code, message, statusCode }: {
+        code: AppRuntimeV1ServerErrorCode;
+        message: string;
+        statusCode: number;
+    });
+}
+declare class AppRuntimeV1Server {
+    private readonly appId;
+    private readonly appVersion;
+    private readonly handlers;
+    private readonly manifest;
+    private readonly jwksResolver;
+    private readonly nonceFactory;
+    private readonly now;
+    private readonly platformIssuer;
+    private readonly platformJwksUrl;
+    private readonly replayStore;
+    private readonly signatureLifetimeMs;
+    private readonly signingIdentity;
+    constructor(config: AppRuntimeV1ServerConfig);
+    handle(request: AppRuntimeV1ServerRequest): Promise<AppRuntimeV1ServerResponse>;
+    private handleSignedRoute;
+    private verifyRequest;
+    private invokeAndSign;
+}
+
+declare class DevelopmentAppSignatureReplayStore implements AppSignatureReplayStore {
+    private readonly claims;
+    private readonly now;
+    constructor({ now }?: {
+        now?: () => number;
+    });
+    claim(input: AppSignatureReplayClaim): Promise<boolean>;
+    clear(): void;
+    private removeExpiredClaims;
+}
+declare function createDevelopmentReplayStore(input?: {
+    now?: () => number;
+}): DevelopmentAppSignatureReplayStore;
+
+interface RemoteAppRuntimeConfig {
+    handlers: AppRuntimeV1Handlers;
+    jwksResolver?: AppJwksResolver;
+    manifest: unknown;
+    platformIssuer?: string;
+    platformJwksUrl: string;
+    replayStore: AppSignatureReplayStore;
+    signingIdentity: AppProtocolSigningIdentity;
+}
+declare class RemoteAppRuntime {
+    readonly manifest: AppManifest;
+    private readonly jwks;
+    private readonly jwksPath;
+    private readonly server;
+    constructor(config: RemoteAppRuntimeConfig);
+    getJwks(): AppJwks;
+    handle(request: Request): Promise<Response>;
+    handleNodeRequest(request: IncomingMessage, response: ServerResponse): Promise<void>;
+}
+declare function createRemoteAppRuntime(config: RemoteAppRuntimeConfig): RemoteAppRuntime;
+declare function readRemoteAppFetchRequestBody(request: Request): Promise<string>;
+
+interface AppRuntimeBindings {
+    readonly appId: string;
+    readonly appVersion: string;
+    actionId(key: string): string;
+    artifactId(key: string): string;
+    capabilityId(key: string): string;
+    intentId(key: string): string;
+    knowledgeId(key: string): string;
+    outcomeId(key: string): string;
+    publicActionId(key: string): string;
+    resourceId(key: string): string;
+    triggerId(key: string): string;
+}
+declare function createAppRuntimeBindings(manifestInput: unknown): AppRuntimeBindings;
+
+declare function createAppRuntimeHealthResponse({ manifest: manifestInput, status, checkedAt, message }: {
+    manifest: unknown;
+    status: AppRuntimeHealthStatus;
+    checkedAt?: Date;
+    message?: string;
+}): AppRuntimeHealthResponse;
+
+interface AppRuntimeKeyMaterial {
+    jwks: AppJwks;
+    keyId: string;
+    privateJwkBase64url: string;
+    signingIdentity: AppProtocolSigningIdentity;
+}
+declare function generateAppRuntimeKeyMaterial({ manifest: manifestInput, keyId }: {
+    manifest: unknown;
+    keyId?: string;
+}): AppRuntimeKeyMaterial;
+declare function readAppRuntimeSigningIdentity({ manifest: manifestInput, keyId, privateJwkBase64url }: {
+    manifest: unknown;
+    keyId?: string;
+    privateJwkBase64url?: string;
+}): AppProtocolSigningIdentity | null;
+
+export { type AppJwksResolver, type AppPrivateSigningJwk, type AppProtocolSigningIdentity, type AppRuntimeBindings, type AppRuntimeKeyMaterial, type AppRuntimeV1Handlers, AppRuntimeV1Server, type AppRuntimeV1ServerConfig, AppRuntimeV1ServerError, AppRuntimeV1ServerErrorCode, type AppRuntimeV1ServerRequest, type AppRuntimeV1ServerResponse, type AppSignatureReplayClaim, type AppSignatureReplayStore, DevelopmentAppSignatureReplayStore, RemoteAppRuntime, type RemoteAppRuntimeConfig, createAppRuntimeBindings, createAppRuntimeHealthResponse, createDevelopmentReplayStore, createRemoteAppRuntime, deriveAppPublicSigningJwk, generateAppRuntimeKeyMaterial, readAppProtocolSigningIdentity, readAppRuntimeSigningIdentity, readRemoteAppFetchRequestBody };

package/dist/runtime.d.ts

@@ -0,0 +1,188 @@
+import { IncomingMessage, ServerResponse } from 'node:http';
+import { A as AppSignatureAlgorithm, a as AppPublicSigningJwk, b as AppCompleteInstallationRequest, c as AppCompleteInstallationResponse, d as AppDisconnectInstallationRequest, e as AppDisconnectInstallationResponse, f as AppExecuteActionRequest, g as AppExecuteActionResponse, h as AppRuntimeHealthResponse, i as AppPlanActionRequest, j as AppPlanActionResponse, k as AppPrepareInstallationRequest, l as AppPrepareInstallationResponse, m as AppManifest, n as AppJwks, o as AppRuntimeHealthStatus } from './signature-envelope-DzT4yjFP.js';
+import { webcrypto } from 'node:crypto';
+import 'zod';
+
+interface AppPrivateSigningJwk extends webcrypto.JsonWebKey {
+    alg: typeof AppSignatureAlgorithm.ED25519;
+    crv: "Ed25519";
+    d: string;
+    kid: string;
+    kty: "OKP";
+    use: "sig";
+    x: string;
+}
+interface AppProtocolSigningIdentity {
+    issuer: string;
+    keyId: string;
+    privateKeyJwk: AppPrivateSigningJwk;
+}
+declare function readAppProtocolSigningIdentity({ issuer, keyId, privateJwkBase64url }: {
+    issuer: string;
+    keyId?: string;
+    privateJwkBase64url?: string;
+}): AppProtocolSigningIdentity | null;
+declare function deriveAppPublicSigningJwk(identity: AppProtocolSigningIdentity): AppPublicSigningJwk;
+
+interface AppJwksResolver {
+    resolve(jwksUrl: string, keyId: string): Promise<AppPublicSigningJwk | null>;
+}
+
+interface AppSignatureReplayClaim {
+    audience: string;
+    expiresAt: Date;
+    issuer: string;
+    keyId: string;
+    nonce: string;
+}
+interface AppSignatureReplayStore {
+    claim(input: AppSignatureReplayClaim): Promise<boolean>;
+}
+
+type RuntimeMethod = "GET" | "POST";
+type RuntimeHeaders = Headers | Record<string, string | string[] | undefined>;
+interface AppRuntimeV1ServerRequest {
+    body: string;
+    headers: RuntimeHeaders;
+    method: RuntimeMethod;
+    path: string;
+}
+interface AppRuntimeV1ServerResponse {
+    body: string;
+    headers: Record<string, string>;
+    statusCode: number;
+}
+interface AppRuntimeV1Handlers {
+    completeInstallation(request: AppCompleteInstallationRequest): Promise<AppCompleteInstallationResponse>;
+    disconnectInstallation(request: AppDisconnectInstallationRequest): Promise<AppDisconnectInstallationResponse>;
+    executeAction(request: AppExecuteActionRequest): Promise<AppExecuteActionResponse>;
+    health(): Promise<AppRuntimeHealthResponse>;
+    planAction(request: AppPlanActionRequest): Promise<AppPlanActionResponse>;
+    prepareInstallation(request: AppPrepareInstallationRequest): Promise<AppPrepareInstallationResponse>;
+}
+interface AppRuntimeV1ServerConfig {
+    appId: string;
+    appVersion: string;
+    handlers: AppRuntimeV1Handlers;
+    manifest: AppManifest;
+    jwksResolver?: AppJwksResolver;
+    nonceFactory?: () => string;
+    now?: () => Date;
+    platformIssuer: string;
+    platformJwksUrl: string;
+    replayStore: AppSignatureReplayStore;
+    signatureLifetimeMs?: number;
+    signingIdentity: AppProtocolSigningIdentity;
+}
+declare enum AppRuntimeV1ServerErrorCode {
+    ROUTE_NOT_FOUND = "APP_RUNTIME_V1_ROUTE_NOT_FOUND",
+    REQUEST_TOO_LARGE = "APP_RUNTIME_V1_REQUEST_TOO_LARGE",
+    REQUEST_JSON_INVALID = "APP_RUNTIME_V1_REQUEST_JSON_INVALID",
+    REQUEST_SCHEMA_INVALID = "APP_RUNTIME_V1_REQUEST_SCHEMA_INVALID",
+    REQUEST_IDENTITY_INVALID = "APP_RUNTIME_V1_REQUEST_IDENTITY_INVALID",
+    REQUEST_SIGNATURE_INVALID = "APP_RUNTIME_V1_REQUEST_SIGNATURE_INVALID"
+}
+declare class AppRuntimeV1ServerError extends Error {
+    readonly code: AppRuntimeV1ServerErrorCode;
+    readonly statusCode: number;
+    constructor({ code, message, statusCode }: {
+        code: AppRuntimeV1ServerErrorCode;
+        message: string;
+        statusCode: number;
+    });
+}
+declare class AppRuntimeV1Server {
+    private readonly appId;
+    private readonly appVersion;
+    private readonly handlers;
+    private readonly manifest;
+    private readonly jwksResolver;
+    private readonly nonceFactory;
+    private readonly now;
+    private readonly platformIssuer;
+    private readonly platformJwksUrl;
+    private readonly replayStore;
+    private readonly signatureLifetimeMs;
+    private readonly signingIdentity;
+    constructor(config: AppRuntimeV1ServerConfig);
+    handle(request: AppRuntimeV1ServerRequest): Promise<AppRuntimeV1ServerResponse>;
+    private handleSignedRoute;
+    private verifyRequest;
+    private invokeAndSign;
+}
+
+declare class DevelopmentAppSignatureReplayStore implements AppSignatureReplayStore {
+    private readonly claims;
+    private readonly now;
+    constructor({ now }?: {
+        now?: () => number;
+    });
+    claim(input: AppSignatureReplayClaim): Promise<boolean>;
+    clear(): void;
+    private removeExpiredClaims;
+}
+declare function createDevelopmentReplayStore(input?: {
+    now?: () => number;
+}): DevelopmentAppSignatureReplayStore;
+
+interface RemoteAppRuntimeConfig {
+    handlers: AppRuntimeV1Handlers;
+    jwksResolver?: AppJwksResolver;
+    manifest: unknown;
+    platformIssuer?: string;
+    platformJwksUrl: string;
+    replayStore: AppSignatureReplayStore;
+    signingIdentity: AppProtocolSigningIdentity;
+}
+declare class RemoteAppRuntime {
+    readonly manifest: AppManifest;
+    private readonly jwks;
+    private readonly jwksPath;
+    private readonly server;
+    constructor(config: RemoteAppRuntimeConfig);
+    getJwks(): AppJwks;
+    handle(request: Request): Promise<Response>;
+    handleNodeRequest(request: IncomingMessage, response: ServerResponse): Promise<void>;
+}
+declare function createRemoteAppRuntime(config: RemoteAppRuntimeConfig): RemoteAppRuntime;
+declare function readRemoteAppFetchRequestBody(request: Request): Promise<string>;
+
+interface AppRuntimeBindings {
+    readonly appId: string;
+    readonly appVersion: string;
+    actionId(key: string): string;
+    artifactId(key: string): string;
+    capabilityId(key: string): string;
+    intentId(key: string): string;
+    knowledgeId(key: string): string;
+    outcomeId(key: string): string;
+    publicActionId(key: string): string;
+    resourceId(key: string): string;
+    triggerId(key: string): string;
+}
+declare function createAppRuntimeBindings(manifestInput: unknown): AppRuntimeBindings;
+
+declare function createAppRuntimeHealthResponse({ manifest: manifestInput, status, checkedAt, message }: {
+    manifest: unknown;
+    status: AppRuntimeHealthStatus;
+    checkedAt?: Date;
+    message?: string;
+}): AppRuntimeHealthResponse;
+
+interface AppRuntimeKeyMaterial {
+    jwks: AppJwks;
+    keyId: string;
+    privateJwkBase64url: string;
+    signingIdentity: AppProtocolSigningIdentity;
+}
+declare function generateAppRuntimeKeyMaterial({ manifest: manifestInput, keyId }: {
+    manifest: unknown;
+    keyId?: string;
+}): AppRuntimeKeyMaterial;
+declare function readAppRuntimeSigningIdentity({ manifest: manifestInput, keyId, privateJwkBase64url }: {
+    manifest: unknown;
+    keyId?: string;
+    privateJwkBase64url?: string;
+}): AppProtocolSigningIdentity | null;
+
+export { type AppJwksResolver, type AppPrivateSigningJwk, type AppProtocolSigningIdentity, type AppRuntimeBindings, type AppRuntimeKeyMaterial, type AppRuntimeV1Handlers, AppRuntimeV1Server, type AppRuntimeV1ServerConfig, AppRuntimeV1ServerError, AppRuntimeV1ServerErrorCode, type AppRuntimeV1ServerRequest, type AppRuntimeV1ServerResponse, type AppSignatureReplayClaim, type AppSignatureReplayStore, DevelopmentAppSignatureReplayStore, RemoteAppRuntime, type RemoteAppRuntimeConfig, createAppRuntimeBindings, createAppRuntimeHealthResponse, createDevelopmentReplayStore, createRemoteAppRuntime, deriveAppPublicSigningJwk, generateAppRuntimeKeyMaterial, readAppProtocolSigningIdentity, readAppRuntimeSigningIdentity, readRemoteAppFetchRequestBody };