@hoststack.dev/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,488 @@
+interface Project {
+    id: number;
+    publicId: string;
+    name: string;
+    slug: string;
+    description?: string | null;
+    region: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateProjectInput {
+    name: string;
+    description?: string;
+    region?: string;
+}
+interface UpdateProjectInput {
+    name?: string;
+    description?: string;
+}
+interface Service {
+    id: number;
+    publicId: string;
+    name: string;
+    type: string;
+    status: string;
+    internalUrl?: string | null;
+    projectId: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateServiceInput {
+    name: string;
+    type: string;
+    projectId?: string;
+    gitUrl?: string;
+    branch?: string;
+    buildCommand?: string;
+    startCommand?: string;
+}
+interface UpdateServiceInput {
+    name?: string;
+}
+interface ServiceConfig {
+    buildCommand?: string | null;
+    startCommand?: string | null;
+    branch?: string | null;
+    rootDirectory?: string | null;
+    dockerfilePath?: string | null;
+    autoDeploy?: boolean;
+    instanceCount?: number;
+    plan?: string;
+}
+interface UpdateServiceConfigInput {
+    buildCommand?: string;
+    startCommand?: string;
+    branch?: string;
+    rootDirectory?: string;
+    dockerfilePath?: string;
+    autoDeploy?: boolean;
+    instanceCount?: number;
+    plan?: string;
+}
+interface Deploy {
+    id: number;
+    publicId: string;
+    status: string;
+    trigger: string;
+    commitHash?: string | null;
+    commitMessage?: string | null;
+    createdAt: string;
+    startedAt?: string | null;
+    finishedAt?: string | null;
+}
+interface TriggerDeployInput {
+    clearCache?: boolean;
+}
+interface Database {
+    id: number;
+    publicId: string;
+    name: string;
+    type: string;
+    status: string;
+    version?: string | null;
+    projectId: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateDatabaseInput {
+    name: string;
+    type: string;
+    projectId: number;
+    version?: string;
+}
+interface UpdateDatabaseInput {
+    name?: string;
+}
+interface DatabaseCredentials {
+    host: string;
+    port: number;
+    username: string;
+    password: string;
+    database: string;
+    connectionUrl: string;
+}
+interface Domain {
+    id: number;
+    publicId?: string;
+    domain: string;
+    status: string;
+    verified: boolean;
+    serviceId?: number | null;
+    createdAt: string;
+}
+interface AddDomainInput {
+    domain: string;
+    serviceId?: string;
+}
+interface UpdateDomainInput {
+    serviceId?: string;
+}
+interface EnvVar {
+    id: number;
+    publicId?: string;
+    key: string;
+    value: string;
+    isSecret: boolean;
+}
+interface CreateEnvVarInput {
+    key: string;
+    value: string;
+    isSecret?: boolean;
+}
+interface UpdateEnvVarInput {
+    key?: string;
+    value?: string;
+    isSecret?: boolean;
+}
+interface BulkSetEnvVarsInput {
+    envVars: Array<{
+        key: string;
+        value: string;
+        isSecret?: boolean;
+    }>;
+}
+interface User {
+    id: number;
+    name: string;
+    email: string;
+    avatarUrl?: string | null;
+}
+interface Team {
+    id: number;
+    name: string;
+    slug: string;
+    role: string;
+}
+interface MeResponse {
+    user: User;
+    team?: Team;
+}
+interface ServiceMetrics {
+    cpu: number;
+    memory: number;
+    network: number;
+    requests: number;
+}
+interface CronExecution {
+    id: number;
+    publicId: string;
+    status: string;
+    startedAt?: string | null;
+    finishedAt?: string | null;
+    exitCode?: number | null;
+    triggeredBy?: string | null;
+    createdAt: string;
+}
+interface ActivityLogEntry {
+    id: number;
+    action: string;
+    resourceType: string;
+    resourceId: string;
+    userId: number;
+    userName: string;
+    metadata?: Record<string, unknown>;
+    createdAt: string;
+}
+
+declare class CronResource {
+    private client;
+    constructor(client: HostStack);
+    /** List cron executions for a service. */
+    list(teamId: number, serviceId: string, options?: {
+        limit?: number;
+    }): Promise<{
+        executions: CronExecution[];
+    }>;
+    /** Get a single cron execution by ID. */
+    get(teamId: number, serviceId: string, executionId: string): Promise<{
+        execution: CronExecution;
+    }>;
+    /** Trigger an immediate cron execution. */
+    trigger(teamId: number, serviceId: string): Promise<{
+        execution: CronExecution;
+    }>;
+}
+
+declare class DatabasesResource {
+    private client;
+    constructor(client: HostStack);
+    /** List all databases for a project. */
+    list(teamId: number, projectId: number): Promise<{
+        databases: Database[];
+    }>;
+    /** Get a single database by ID. */
+    get(teamId: number, databaseId: string): Promise<{
+        database: Database;
+    }>;
+    /** Create a new database. */
+    create(teamId: number, data: CreateDatabaseInput): Promise<{
+        database: Database;
+    }>;
+    /** Update a database. */
+    update(teamId: number, databaseId: string, data: UpdateDatabaseInput): Promise<{
+        database: Database;
+    }>;
+    /** Delete a database. */
+    delete(teamId: number, databaseId: string): Promise<void>;
+    /** Suspend a database. */
+    suspend(teamId: number, databaseId: string): Promise<void>;
+    /** Resume a suspended database. */
+    resume(teamId: number, databaseId: string): Promise<void>;
+    /** Get connection credentials. */
+    getCredentials(teamId: number, databaseId: string): Promise<{
+        credentials: DatabaseCredentials;
+    }>;
+    /** Reset the database password. */
+    resetPassword(teamId: number, databaseId: string): Promise<void>;
+}
+
+declare class DeploysResource {
+    private client;
+    constructor(client: HostStack);
+    /** List deploys for a service. */
+    list(teamId: number, serviceId: string): Promise<{
+        deploys: Deploy[];
+    }>;
+    /** Get a single deploy by ID. */
+    get(teamId: number, serviceId: string, deployId: string): Promise<{
+        deploy: Deploy;
+    }>;
+    /** Trigger a new deploy. */
+    trigger(teamId: number, serviceId: string, data?: TriggerDeployInput): Promise<{
+        deploy: Deploy;
+    }>;
+    /** Cancel an in-progress deploy. */
+    cancel(teamId: number, serviceId: string, deployId: string): Promise<void>;
+    /** Rollback to a previous deploy. */
+    rollback(teamId: number, serviceId: string, deployId: string): Promise<void>;
+    /** Get build logs for a deploy. */
+    getLogs(teamId: number, serviceId: string, deployId: string): Promise<{
+        logs: string;
+    }>;
+}
+
+declare class DomainsResource {
+    private client;
+    constructor(client: HostStack);
+    /** List all domains for the active team. */
+    list(teamId: number): Promise<{
+        domains: Domain[];
+    }>;
+    /** Add a custom domain. */
+    add(teamId: number, data: AddDomainInput): Promise<{
+        domain: Domain;
+    }>;
+    /** Update a domain. */
+    update(teamId: number, domainId: string, data: UpdateDomainInput): Promise<{
+        domain: Domain;
+    }>;
+    /** Remove a domain. */
+    remove(teamId: number, domainId: string): Promise<void>;
+    /** Verify domain DNS configuration. */
+    verify(teamId: number, domainId: string): Promise<void>;
+}
+
+declare class EnvVarsResource {
+    private client;
+    constructor(client: HostStack);
+    /** List all environment variables for a service. */
+    list(teamId: number, serviceId: string): Promise<{
+        envVars: EnvVar[];
+    }>;
+    /** Create a new environment variable. */
+    create(teamId: number, serviceId: string, data: CreateEnvVarInput): Promise<{
+        envVar: EnvVar;
+    }>;
+    /** Update an environment variable. */
+    update(teamId: number, serviceId: string, envVarId: string, data: UpdateEnvVarInput): Promise<{
+        envVar: EnvVar;
+    }>;
+    /** Delete an environment variable. */
+    delete(teamId: number, serviceId: string, envVarId: string): Promise<void>;
+    /** Bulk set environment variables (create or update). */
+    bulkSet(teamId: number, serviceId: string, data: BulkSetEnvVarsInput): Promise<void>;
+}
+
+declare class ProjectsResource {
+    private client;
+    constructor(client: HostStack);
+    /** List all projects for the active team. */
+    list(teamId: number): Promise<{
+        projects: Project[];
+    }>;
+    /** Get a single project by ID. */
+    get(teamId: number, projectId: string): Promise<{
+        project: Project;
+    }>;
+    /** Create a new project. */
+    create(teamId: number, data: CreateProjectInput): Promise<{
+        project: Project;
+    }>;
+    /** Update a project. */
+    update(teamId: number, projectId: string, data: UpdateProjectInput): Promise<{
+        project: Project;
+    }>;
+    /** Delete a project. */
+    delete(teamId: number, projectId: string): Promise<void>;
+}
+
+interface LogEntry$1 {
+    timestamp: string;
+    level?: string | null;
+    stream?: string | null;
+    message: string;
+}
+interface StreamLogsOptions {
+    /** Filter by stream: 'stdout' or 'stderr'. */
+    stream?: 'stdout' | 'stderr';
+    /** Number of historical lines to fetch on first poll (default: 100). */
+    initialLines?: number;
+    /** Poll interval in milliseconds (default: 2000). */
+    pollInterval?: number;
+    /** AbortSignal to stop streaming. */
+    signal?: AbortSignal;
+}
+
+interface LogEntry {
+    timestamp: string;
+    level?: string | null;
+    stream?: string | null;
+    message: string;
+}
+declare class ServicesResource {
+    private client;
+    constructor(client: HostStack);
+    /** List all services for the active team. */
+    list(teamId: number): Promise<{
+        services: Service[];
+    }>;
+    /** Get a single service by ID. */
+    get(teamId: number, serviceId: string): Promise<{
+        service: Service;
+    }>;
+    /** Create a new service. */
+    create(teamId: number, data: CreateServiceInput): Promise<{
+        service: Service;
+    }>;
+    /** Update a service. */
+    update(teamId: number, serviceId: string, data: UpdateServiceInput): Promise<{
+        service: Service;
+    }>;
+    /** Delete a service. */
+    delete(teamId: number, serviceId: string): Promise<void>;
+    /** Suspend a service. */
+    suspend(teamId: number, serviceId: string): Promise<void>;
+    /** Resume a suspended service. */
+    resume(teamId: number, serviceId: string): Promise<void>;
+    /** Get service metrics. */
+    getMetrics(teamId: number, serviceId: string): Promise<{
+        metrics: ServiceMetrics;
+    }>;
+    /** Get service configuration. */
+    getConfig(teamId: number, serviceId: string): Promise<{
+        config: ServiceConfig;
+    }>;
+    /** Update service configuration. */
+    updateConfig(teamId: number, serviceId: string, data: UpdateServiceConfigInput): Promise<{
+        config: ServiceConfig;
+    }>;
+    /** Get runtime logs for a service. */
+    getRuntimeLogs(teamId: number, serviceId: string, options?: {
+        lines?: number;
+        since?: string;
+        stream?: 'stdout' | 'stderr';
+    }): Promise<{
+        logs: LogEntry[] | string;
+    }>;
+    /**
+     * Stream runtime logs for a service by polling the logs endpoint.
+     * Yields log entries as they appear. Use an AbortController to stop.
+     *
+     * @example
+     * ```ts
+     * const ac = new AbortController();
+     * for await (const entry of client.services.streamLogs(teamId, serviceId, { signal: ac.signal })) {
+     *   console.log(entry.message);
+     * }
+     * ```
+     */
+    streamLogs(teamId: number, serviceId: string, options?: StreamLogsOptions): AsyncGenerator<LogEntry>;
+}
+
+interface HostStackOptions {
+    /** Your HostStack API key (hs_live_... or hs_test_...). */
+    apiKey: string;
+    /** Base URL of the HostStack API. Defaults to https://api.hoststack.dev */
+    baseUrl?: string;
+}
+declare class HostStack {
+    private apiKey;
+    private baseUrl;
+    /** Manage projects. */
+    readonly projects: ProjectsResource;
+    /** Manage services (web, worker, cron). */
+    readonly services: ServicesResource;
+    /** Trigger and manage deployments. */
+    readonly deploys: DeploysResource;
+    /** Manage databases (Postgres, Redis). */
+    readonly databases: DatabasesResource;
+    /** Manage custom domains. */
+    readonly domains: DomainsResource;
+    /** Manage service environment variables. */
+    readonly envVars: EnvVarsResource;
+    /** Manage cron job executions. */
+    readonly cron: CronResource;
+    constructor(options: HostStackOptions);
+    /**
+     * Make an authenticated request to the HostStack API.
+     * Used internally by resource classes. Can also be used for custom API calls.
+     */
+    request<T>(method: string, path: string, body?: unknown): Promise<T>;
+}
+
+declare class HostStackError extends Error {
+    readonly statusCode: number;
+    constructor(statusCode: number, message: string);
+}
+declare class AuthenticationError extends HostStackError {
+    constructor(message?: string);
+}
+declare class NotFoundError extends HostStackError {
+    constructor(message?: string);
+}
+declare class RateLimitError extends HostStackError {
+    constructor(message?: string);
+}
+
+/**
+ * Standard pagination parameters for list requests.
+ */
+interface PaginationParams {
+    /** Maximum number of items to return. */
+    limit?: number;
+    /** Number of items to skip. */
+    offset?: number;
+}
+/**
+ * A paginated response wrapper.
+ */
+interface PaginatedResponse<T> {
+    items: T[];
+    total: number;
+    limit: number;
+    offset: number;
+    hasMore: boolean;
+}
+/**
+ * Builds a query string from pagination params.
+ * Returns an empty string if no params are set.
+ */
+declare function buildPaginationQuery(params?: PaginationParams): string;
+/**
+ * Wraps a plain array result into a PaginatedResponse.
+ * Useful when the API returns a flat array without pagination metadata.
+ */
+declare function wrapArray<T>(items: T[], params?: PaginationParams): PaginatedResponse<T>;
+
+export { type ActivityLogEntry, type AddDomainInput, AuthenticationError, type BulkSetEnvVarsInput, type CreateDatabaseInput, type CreateEnvVarInput, type CreateProjectInput, type CreateServiceInput, type CronExecution, type Database, type DatabaseCredentials, type Deploy, type Domain, type EnvVar, HostStack, HostStackError, type HostStackOptions, type LogEntry$1 as LogEntry, type MeResponse, NotFoundError, type PaginatedResponse, type PaginationParams, type Project, RateLimitError, type Service, type ServiceConfig, type ServiceMetrics, type StreamLogsOptions, type Team, type TriggerDeployInput, type UpdateDatabaseInput, type UpdateDomainInput, type UpdateEnvVarInput, type UpdateProjectInput, type UpdateServiceConfigInput, type UpdateServiceInput, type User, buildPaginationQuery, wrapArray };