@epilot/sdk 2.4.4-alpha.0 → 2.4.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.4.4-alpha.0",
+  "version": "2.4.4",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",

package/dist/apis/_registry.d.ts

@@ -1,8 +0,0 @@
-import type { ApiEntry, ExtensionEntry } from '../types';
-export declare const registerBuiltinApis: (registry: Map<string, ApiEntry>) => void;
-/**
- * Register non-API extensions (plain objects, not OpenAPI clients).
- * These are mounted on the SDK alongside API handles.
- * Extensions are lazy-loaded — the module is only imported on first access.
- */
-export declare const registerBuiltinExtensions: (extensions: Map<string, ExtensionEntry>) => void;

package/dist/authorize.d.ts

@@ -1,3 +0,0 @@
-import type { AxiosInstance } from 'axios';
-export type TokenArg = string | (() => string | Promise<string>);
-export declare const authorize: <T extends AxiosInstance>(client: T, token: TokenArg) => T;

package/dist/bin/cli.d.ts

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

package/dist/client-factory.d.ts

@@ -1,9 +0,0 @@
-import type { AxiosInstance } from 'axios';
-import type { Document } from 'openapi-client-axios';
-import { type TokenArg } from './authorize';
-export declare const createApiClient: <T extends AxiosInstance = AxiosInstance>(params: {
-    definition: Document;
-    token?: TokenArg | null;
-    headers?: Record<string, string>;
-    apiName?: string;
-}) => T;

package/dist/client-map.d.ts

@@ -1,102 +0,0 @@
-import type { Client as AccessTokenClient } from './types/access-token';
-import type { Client as AddressClient } from './types/address';
-import type { Client as AddressSuggestionsClient } from './types/address-suggestions';
-import type { Client as AiAgentsClient } from './types/ai-agents';
-import type { Client as AppClient } from './types/app';
-import type { Client as AuditLogsClient } from './types/audit-logs';
-import type { Client as AutomationClient } from './types/automation';
-import type { Client as BillingClient } from './types/billing';
-import type { Client as BlueprintManifestClient } from './types/blueprint-manifest';
-import type { Client as CalendarClient } from './types/calendar';
-import type { Client as ConfigurationHubClient } from './types/configuration-hub';
-import type { Client as ConsentClient } from './types/consent';
-import type { Client as CustomerPortalClient } from './types/customer-portal';
-import type { Client as DashboardClient } from './types/dashboard';
-import type { Client as DataGovernanceClient } from './types/data-governance';
-import type { Client as DeduplicationClient } from './types/deduplication';
-import type { Client as DesignClient } from './types/design';
-import type { Client as DocumentClient } from './types/document';
-import type { Client as EmailSettingsClient } from './types/email-settings';
-import type { Client as EmailTemplateClient } from './types/email-template';
-import type { Client as EntityClient } from './types/entity';
-import type { Client as EntityMappingClient } from './types/entity-mapping';
-import type { Client as EnvironmentsClient } from './types/environments';
-import type { Client as EventCatalogClient } from './types/event-catalog';
-import type { Client as FileClient } from './types/file';
-import type { Client as IbanClient } from './types/iban';
-import type { Client as IntegrationToolkitClient } from './types/integration-toolkit';
-import type { Client as JourneyClient } from './types/journey';
-import type { Client as KanbanClient } from './types/kanban';
-import type { Client as MessageClient } from './types/message';
-import type { Client as MeteringClient } from './types/metering';
-import type { Client as NotesClient } from './types/notes';
-import type { Client as NotificationClient } from './types/notification';
-import type { Client as OrganizationClient } from './types/organization';
-import type { Client as PartnerDirectoryClient } from './types/partner-directory';
-import type { Client as PermissionsClient } from './types/permissions';
-import type { Client as PricingClient } from './types/pricing';
-import type { Client as PricingTierClient } from './types/pricing-tier';
-import type { Client as PurposeClient } from './types/purpose';
-import type { Client as QueryClient } from './types/query';
-import type { Client as SandboxClient } from './types/sandbox';
-import type { Client as SharingClient } from './types/sharing';
-import type { Client as SubmissionClient } from './types/submission';
-import type { Client as TargetingClient } from './types/targeting';
-import type { Client as TemplateVariablesClient } from './types/template-variables';
-import type { Client as UserClient } from './types/user';
-import type { Client as ValidationRulesClient } from './types/validation-rules';
-import type { Client as WebhooksClient } from './types/webhooks';
-import type { Client as WorkflowClient } from './types/workflow';
-import type { Client as WorkflowDefinitionClient } from './types/workflow-definition';
-export type SDKClientMap = {
-    accessToken: AccessTokenClient;
-    address: AddressClient;
-    addressSuggestions: AddressSuggestionsClient;
-    aiAgents: AiAgentsClient;
-    app: AppClient;
-    auditLogs: AuditLogsClient;
-    automation: AutomationClient;
-    billing: BillingClient;
-    blueprintManifest: BlueprintManifestClient;
-    calendar: CalendarClient;
-    configurationHub: ConfigurationHubClient;
-    consent: ConsentClient;
-    customerPortal: CustomerPortalClient;
-    dashboard: DashboardClient;
-    dataGovernance: DataGovernanceClient;
-    deduplication: DeduplicationClient;
-    design: DesignClient;
-    document: DocumentClient;
-    emailSettings: EmailSettingsClient;
-    emailTemplate: EmailTemplateClient;
-    entity: EntityClient;
-    entityMapping: EntityMappingClient;
-    environments: EnvironmentsClient;
-    eventCatalog: EventCatalogClient;
-    file: FileClient;
-    iban: IbanClient;
-    integrationToolkit: IntegrationToolkitClient;
-    journey: JourneyClient;
-    kanban: KanbanClient;
-    message: MessageClient;
-    metering: MeteringClient;
-    notes: NotesClient;
-    notification: NotificationClient;
-    organization: OrganizationClient;
-    partnerDirectory: PartnerDirectoryClient;
-    permissions: PermissionsClient;
-    pricing: PricingClient;
-    pricingTier: PricingTierClient;
-    purpose: PurposeClient;
-    query: QueryClient;
-    sandbox: SandboxClient;
-    sharing: SharingClient;
-    submission: SubmissionClient;
-    targeting: TargetingClient;
-    templateVariables: TemplateVariablesClient;
-    user: UserClient;
-    validationRules: ValidationRulesClient;
-    webhooks: WebhooksClient;
-    workflow: WorkflowClient;
-    workflowDefinition: WorkflowDefinitionClient;
-};

package/dist/compact.d.ts

@@ -1,22 +0,0 @@
-/**
- * Compact OpenAPI definition format for reduced bundle size.
- *
- * Encodes only the fields openapi-client-axios reads at runtime:
- * paths, operationId, parameters (name, in, required, style, explode),
- * requestBody presence, servers, and $ref component parameters.
- */
-type CP = [name: string, loc: 'p' | 'q' | 'h' | 'c', ...rest: (boolean | string)[]];
-type CR = [ref: string];
-export type CompactDefinition = {
-    s: string;
-    sv?: Record<string, {
-        default: string;
-        enum?: string[];
-    }>;
-    v?: string;
-    o: [id: string, m: string, p: string, ps?: (CP | CR)[], b?: 0 | 1][];
-    cp?: Record<string, CP>;
-    pp?: Record<string, (CP | CR)[]>;
-};
-export declare const expand: (c: CompactDefinition) => Record<string, unknown>;
-export {};

package/dist/help.d.ts

@@ -1,12 +0,0 @@
-/**
- * Lazy-loaded help system — returns markdown docs for SDK APIs.
- * Each doc is loaded via dynamic import() so only the requested doc affects bundle size.
- */
-/**
- * Get help for a specific API or general SDK help.
- *
- * @example
- * await help()           // general SDK docs
- * await help('entity')   // entity API docs
- */
-export declare const help: (apiName?: string) => Promise<string>;

package/dist/large-response.d.ts

@@ -1,9 +0,0 @@
-import type { AxiosInstance } from 'axios';
-export type LargeResponseConfig = {
-    /** Enable large response handling. Default: true */
-    enabled?: boolean;
-};
-export declare const applyLargeResponseInterceptor: (params: {
-    client: AxiosInstance;
-    config: LargeResponseConfig;
-}) => void;

package/dist/openapi.d.ts

@@ -1,12 +0,0 @@
-/**
- * Lazy-loaded OpenAPI spec — returns the full OpenAPI JSON document for an API.
- * Each spec is loaded via dynamic import() so only the requested spec affects bundle size.
- */
-import type { Document } from 'openapi-client-axios';
-/**
- * Get the full OpenAPI specification for an API.
- *
- * @example
- * await openapi('entity')   // full entity OpenAPI spec
- */
-export declare const openapi: (apiName: string) => Promise<Document>;

package/dist/overrides.d.ts

@@ -1,9 +0,0 @@
-import type { ApiEntry } from './types';
-/**
- * Loads overrides from .epilot/sdk-overrides.json synchronously.
- * Only performs filesystem reads on first call - subsequent calls are no-ops.
- * Safe to call in browser environments (fs/path are dynamically required).
- */
-export declare const loadOverrides: (registry: Map<string, ApiEntry>, cwd?: string) => void;
-/** Reset override loading state (for testing) */
-export declare const _resetOverrides: () => void;

package/dist/proxy.d.ts

@@ -1,14 +0,0 @@
-import type { AxiosInstance } from 'axios';
-import type { ApiHandle } from './types';
-/**
- * Creates an ApiHandle — a proxy that exposes explicit getClient() / createClient()
- * and forwards any other property access as an operation call on the lazy singleton.
- *
- * help() and openapi() are attached to clients at creation time in client-factory.ts,
- * so they work regardless of how the client is obtained.
- */
-export declare const createApiHandle: <T extends AxiosInstance>(params: {
-    resolveClient: () => T;
-    createClient: () => T;
-    apiName?: string;
-}) => ApiHandle<T>;

package/dist/registry.d.ts

@@ -1,19 +0,0 @@
-import type { AxiosInstance } from 'axios';
-import type { Document } from 'openapi-client-axios';
-import type { ApiEntry, SDKState } from './types';
-export declare const createRegistry: () => Map<string, ApiEntry>;
-export declare const registerApi: (params: {
-    registry: Map<string, ApiEntry>;
-    name: string;
-    loader: () => Document;
-}) => void;
-export declare const resolveClient: (params: {
-    registry: Map<string, ApiEntry>;
-    name: string;
-    state: SDKState;
-}) => AxiosInstance;
-export declare const resetClient: (params: {
-    registry: Map<string, ApiEntry>;
-    name: string;
-}) => void;
-export declare const resetAllClients: (registry: Map<string, ApiEntry>) => void;

package/dist/retry.d.ts

@@ -1,11 +0,0 @@
-import type { AxiosInstance } from 'axios';
-export type RetryConfig = {
-    /** Maximum number of retries for 429 responses. Set to 0 to disable. Default: 3 */
-    maxRetries?: number;
-    /** Default delay in ms when Retry-After header is missing. Default: 1000 */
-    defaultDelayMs?: number;
-};
-export declare const applyRetryInterceptor: (params: {
-    client: AxiosInstance;
-    config: RetryConfig;
-}) => void;

package/dist/sdk.d.ts

@@ -1,29 +0,0 @@
-import type { AxiosInstance, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
-import type { TokenArg } from './authorize';
-import type { SDKClientMap } from './client-map';
-import type { LargeResponseConfig } from './large-response';
-import type { RetryConfig } from './retry';
-import type { ApiHandle, HeadersConfig } from './types';
-export type InterceptorUse = {
-    request: (fulfilled: (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig | Promise<InternalAxiosRequestConfig>, rejected?: (error: unknown) => unknown) => void;
-    response: (fulfilled: (response: AxiosResponse) => AxiosResponse | Promise<AxiosResponse>, rejected?: (error: unknown) => unknown) => void;
-};
-export type EpilotSDK = {
-    /** Set a Bearer token (static string or async function) for all clients */
-    authorize: (token: TokenArg) => void;
-    /** Set global default headers applied to all clients (e.g. x-epilot-org-id) */
-    headers: (headers: HeadersConfig) => void;
-    /** Register global axios interceptors applied to all clients */
-    interceptors: InterceptorUse;
-    /** Configure retry behavior for 429 Too Many Requests responses */
-    retry: (config: RetryConfig) => void;
-    /** Configure large response handling for S3-backed payloads */
-    largeResponse: (config: LargeResponseConfig) => void;
-    /** Get markdown docs. No args = general SDK help, with API name = API-specific docs */
-    help: (apiName?: string) => Promise<string>;
-    /** Get the full OpenAPI specification for an API (lazy-loaded) */
-    openapi: (apiName: string) => Promise<import('openapi-client-axios').Document>;
-} & {
-    [K in keyof SDKClientMap]: ApiHandle<SDKClientMap[K]>;
-} & Record<string, ApiHandle<AxiosInstance>>;
-export declare const createSDK: () => EpilotSDK;

package/dist/types.d.ts

@@ -1,53 +0,0 @@
-import type { AxiosInstance, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
-import type { Document } from 'openapi-client-axios';
-import type { LargeResponseConfig } from './large-response';
-import type { RetryConfig } from './retry';
-export type ApiEntry = {
-    loader: () => Document;
-    instance: AxiosInstance | null;
-};
-export type RequestInterceptor = {
-    type: 'request';
-    fulfilled: (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig | Promise<InternalAxiosRequestConfig>;
-    rejected?: (error: unknown) => unknown;
-};
-export type ResponseInterceptor = {
-    type: 'response';
-    fulfilled: (response: AxiosResponse) => AxiosResponse | Promise<AxiosResponse>;
-    rejected?: (error: unknown) => unknown;
-};
-export type Interceptor = RequestInterceptor | ResponseInterceptor;
-export type SDKState = {
-    token: string | null;
-    tokenFn: (() => string | Promise<string>) | null;
-    globalHeaders: Record<string, string>;
-    interceptors: Interceptor[];
-    retry: RetryConfig;
-    largeResponse: LargeResponseConfig;
-};
-export type HeadersConfig = Record<string, string>;
-export type OverridesConfig = Record<string, string>;
-/**
- * A non-API extension mounted on the SDK.
- * Unlike ApiEntry (OpenAPI-based), extensions are plain objects
- * with arbitrary methods and properties (e.g. factory functions, utilities).
- */
-export type ExtensionEntry = {
-    value: unknown;
-};
-/**
- * An API handle that provides:
- * - `getClient()` — cached singleton
- * - `createClient()` — fresh instance
- * - Any operation method (e.g. `.getEntity(...)`) — auto-resolved via lazy singleton
- */
-export type ApiHandle<T extends AxiosInstance = AxiosInstance> = {
-    /** Get the cached singleton client instance (lazy-initialized on first call) */
-    getClient: () => T;
-    /** Create a fresh client instance (not cached) */
-    createClient: () => T;
-    /** Get the full OpenAPI specification document (lazy-loaded) */
-    openapi: () => Promise<Document>;
-} & {
-    [K in keyof T]: T[K];
-};