@hoststack.dev/sdk 0.2.1 → 0.4.0

package/dist/index.d.cts

@@ -32,6 +32,12 @@ interface CreateServiceInput {
     name: string;
     type: string;
     projectId?: string;
+    /**
+     * v66 P5: bind the new service to a specific environment in the
+     * project. Omit to default to the project's Production env. Find or
+     * list envs with `client.environments.list(teamId, projectId)`.
+     */
+    environmentId?: number;
     gitUrl?: string;
     branch?: string;
     buildCommand?: string;
@@ -137,6 +143,11 @@ interface CreateDatabaseInput {
     name: string;
     engine: DatabaseEngine;
     projectId: number;
+    /**
+     * v66 P5: bind the new database to a specific environment in the
+     * project. Omit to default to the project's Production env.
+     */
+    environmentId?: number;
     version?: string;
     plan?: 'free' | 'starter' | 'standard' | 'pro';
     region?: string;
@@ -152,6 +163,36 @@ interface DatabaseCredentials {
     database: string;
     connectionUrl: string;
 }
+/**
+ * A persistent disk attached to a service. Survives redeploys and
+ * container restarts. One service can have multiple volumes; each one is
+ * identified by a short `name` and a `mountPath` inside the container.
+ */
+interface Volume {
+    id: number;
+    publicId: string;
+    name: string;
+    mountPath: string;
+    sizeGb: number;
+    status: 'pending' | 'active' | 'deleting';
+    serviceId: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateVolumeInput {
+    /** Lowercase alphanumeric and hyphens, ≤64 chars. Used as the docker
+     *  volume identifier — change with care once data is written. */
+    name: string;
+    /** In-container absolute path where the volume mounts. */
+    mountPath: string;
+    /** Disk size in GB. 1–100, default 1. Counts against your plan's
+     *  storage quota and is metered for billing. */
+    sizeGb?: number;
+}
+interface UpdateVolumeInput {
+    mountPath?: string;
+    sizeGb?: number;
+}
 interface Domain {
     id: number;
     publicId: string;
@@ -324,6 +365,15 @@ declare class DeploysResource {
     cancel(teamId: IdInput, serviceId: IdInput, deployId: IdInput): Promise<void>;
     /** Rollback to a previous deploy. */
     rollback(teamId: IdInput, serviceId: IdInput, deployId: IdInput): Promise<void>;
+    /**
+     * v66 P5: promote a built deploy to a sibling service in another
+     * environment. Reuses the source deploy's docker image (no rebuild).
+     * If no sibling service exists in the target env yet, the API auto-
+     * creates one by cloning the source service's config.
+     */
+    promote(teamId: IdInput, serviceId: IdInput, deployId: IdInput, targetEnvironmentId: number): Promise<{
+        deploy: Deploy;
+    }>;
     /**
      * Get build logs for a deploy.
      *
@@ -371,6 +421,76 @@ declare class DomainsResource {
     verify(teamId: IdInput, domainId: IdInput): Promise<void>;
 }
 
+interface Environment {
+    id: number;
+    publicId: string;
+    projectId: number;
+    name: string;
+    type: 'production' | 'staging' | 'development' | 'preview';
+    isDefault: boolean;
+    isProtected: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateEnvironmentInput {
+    name: string;
+    type: 'production' | 'staging' | 'development' | 'preview';
+    isProtected?: boolean;
+}
+interface UpdateEnvironmentInput {
+    name?: string;
+    isDefault?: boolean;
+    isProtected?: boolean;
+}
+/**
+ * v66 P5: programmatic env management. Each project has at least a
+ * Production env auto-created at project creation; you can add more
+ * via `create` and bind services/databases to them via the
+ * `environmentId` field on those resources' create inputs.
+ *
+ * @example
+ * ```ts
+ * const { environment: staging } = await client.environments.create(
+ *   teamId,
+ *   projectId,
+ *   { name: 'Staging', type: 'staging' }
+ * );
+ * await client.services.create(teamId, {
+ *   projectId,
+ *   environmentId: staging.id,
+ *   name: 'api',
+ *   type: 'web_service',
+ *   // ...
+ * });
+ * ```
+ */
+declare class EnvironmentsResource {
+    private client;
+    constructor(client: HostStack);
+    /** List all environments for a project. */
+    list(teamId: IdInput, projectId: IdInput): Promise<{
+        environments: Environment[];
+    }>;
+    /** Get a single environment by id. */
+    get(teamId: IdInput, projectId: IdInput, envId: IdInput): Promise<{
+        environment: Environment;
+    }>;
+    /** Create a new environment in the given project. */
+    create(teamId: IdInput, projectId: IdInput, data: CreateEnvironmentInput): Promise<{
+        environment: Environment;
+    }>;
+    /** Update environment metadata (name, default flag, protected flag). */
+    update(teamId: IdInput, projectId: IdInput, envId: IdInput, data: UpdateEnvironmentInput): Promise<{
+        environment: Environment;
+    }>;
+    /**
+     * Delete an environment. The API blocks delete when the env still
+     * has services or databases attached — destroy them first or move
+     * them to another env. Cannot delete the project's default env.
+     */
+    delete(teamId: IdInput, projectId: IdInput, envId: IdInput): Promise<void>;
+}
+
 declare class EnvVarsResource {
     private client;
     constructor(client: HostStack);
@@ -475,13 +595,31 @@ declare class ServicesResource {
     updateConfig(teamId: IdInput, serviceId: IdInput, data: UpdateServiceConfigInput): Promise<{
         config: ServiceConfig;
     }>;
-    /** Get runtime logs for a service. */
+    /**
+     * Get runtime logs for a service.
+     *
+     * `since`/`until` accept either an ISO-8601 timestamp or a short
+     * relative offset like `-5m`, `-1h`, `-2d`.
+     *
+     * `search` does case-insensitive substring filtering server-side
+     * (≤100 chars). `countOnly` returns just `{ count: N }` for cheap
+     * polling — useful when you want to know "how many error lines in the
+     * last 5 minutes" without paying the bytes.
+     */
     getRuntimeLogs(teamId: IdInput, serviceId: IdInput, options?: {
         lines?: number;
+        limit?: number;
         since?: string;
+        until?: string;
         stream?: 'stdout' | 'stderr';
+        level?: 'stdout' | 'stderr' | 'info' | 'warn' | 'error' | 'debug';
+        search?: string;
+        grep?: string;
+        countOnly?: boolean;
     }): Promise<{
         logs: LogEntry[] | string;
+    } | {
+        count: number;
     }>;
     /**
      * Stream runtime logs for a service by polling the logs endpoint.
@@ -498,6 +636,53 @@ declare class ServicesResource {
     streamLogs(teamId: IdInput, serviceId: IdInput, options?: StreamLogsOptions): AsyncGenerator<LogEntry>;
 }
 
+/**
+ * Manage persistent disks attached to a service.
+ *
+ * Volumes mount a writable disk into a service's container at the path you
+ * choose, surviving redeploys and container restarts. One service can have
+ * multiple volumes; each one is identified by a short `name` and a
+ * `mountPath`.
+ *
+ * Renderers porting from render.yaml: a volume here is the same concept as
+ * Render's `disk:` block. Use {@link create} to attach one programmatically,
+ * or declare it in `hoststack.yaml` for IaC workflows.
+ *
+ * @example
+ * ```ts
+ * await client.volumes.create(team, service, {
+ *   name: 'data',
+ *   mountPath: '/var/data',
+ *   sizeGb: 10,
+ * });
+ * ```
+ */
+declare class VolumesResource {
+    private client;
+    constructor(client: HostStack);
+    /** List volumes attached to a service. */
+    list(teamId: IdInput, serviceId: IdInput): Promise<{
+        volumes: Volume[];
+    }>;
+    /** Attach a new volume to a service. Triggers provisioning on the host. */
+    create(teamId: IdInput, serviceId: IdInput, data: CreateVolumeInput): Promise<{
+        volume: Volume;
+    }>;
+    /**
+     * Update a volume's mountPath or sizeGb. Resizes that take effect on the
+     * next deploy; mountPath changes require a redeploy to remount.
+     */
+    update(teamId: IdInput, serviceId: IdInput, volumeId: IdInput, data: UpdateVolumeInput): Promise<{
+        volume: Volume;
+    }>;
+    /**
+     * Detach and deprovision a volume. The underlying disk is destroyed —
+     * back up any data first. Async: the row is marked `deleting` and the
+     * agent finalises the removal once it acks.
+     */
+    delete(teamId: IdInput, serviceId: IdInput, volumeId: IdInput): Promise<void>;
+}
+
 /** A numeric id or a publicId string (e.g. 42, "42", "svc_abc…"). */
 type IdInput = number | string;
 interface HostStackOptions {
@@ -524,10 +709,17 @@ type ResolveScope = {
 } | {
     kind: 'domain';
     teamId: number;
+} | {
+    kind: 'volume';
+    teamId: number;
+    serviceId: number;
 } | {
     kind: 'envVar';
     teamId: number;
     serviceId: number;
+} | {
+    kind: 'environment';
+    teamId: number;
 } | {
     kind: 'cronExecution';
     teamId: number;
@@ -549,8 +741,12 @@ declare class HostStack {
     readonly domains: DomainsResource;
     /** Manage service environment variables. */
     readonly envVars: EnvVarsResource;
+    /** v66: manage environments (production/staging/development/preview) per project. */
+    readonly environments: EnvironmentsResource;
     /** Manage cron job executions. */
     readonly cron: CronResource;
+    /** Manage persistent disks attached to services. */
+    readonly volumes: VolumesResource;
     constructor(options: HostStackOptions);
     /**
      * Make an authenticated request to the HostStack API.
@@ -614,4 +810,4 @@ declare function buildPaginationQuery(params?: PaginationParams): string;
  */
 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 };
+export { type ActivityLogEntry, type AddDomainInput, AuthenticationError, type BulkSetEnvVarsInput, type CreateDatabaseInput, type CreateEnvVarInput, type CreateEnvironmentInput, type CreateProjectInput, type CreateServiceInput, type CronExecution, type Database, type DatabaseCredentials, type Deploy, type Domain, type EnvVar, type Environment, 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 UpdateEnvironmentInput, type UpdateProjectInput, type UpdateServiceConfigInput, type UpdateServiceInput, type User, buildPaginationQuery, wrapArray };

package/dist/index.d.ts

@@ -32,6 +32,12 @@ interface CreateServiceInput {
     name: string;
     type: string;
     projectId?: string;
+    /**
+     * v66 P5: bind the new service to a specific environment in the
+     * project. Omit to default to the project's Production env. Find or
+     * list envs with `client.environments.list(teamId, projectId)`.
+     */
+    environmentId?: number;
     gitUrl?: string;
     branch?: string;
     buildCommand?: string;
@@ -137,6 +143,11 @@ interface CreateDatabaseInput {
     name: string;
     engine: DatabaseEngine;
     projectId: number;
+    /**
+     * v66 P5: bind the new database to a specific environment in the
+     * project. Omit to default to the project's Production env.
+     */
+    environmentId?: number;
     version?: string;
     plan?: 'free' | 'starter' | 'standard' | 'pro';
     region?: string;
@@ -152,6 +163,36 @@ interface DatabaseCredentials {
     database: string;
     connectionUrl: string;
 }
+/**
+ * A persistent disk attached to a service. Survives redeploys and
+ * container restarts. One service can have multiple volumes; each one is
+ * identified by a short `name` and a `mountPath` inside the container.
+ */
+interface Volume {
+    id: number;
+    publicId: string;
+    name: string;
+    mountPath: string;
+    sizeGb: number;
+    status: 'pending' | 'active' | 'deleting';
+    serviceId: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateVolumeInput {
+    /** Lowercase alphanumeric and hyphens, ≤64 chars. Used as the docker
+     *  volume identifier — change with care once data is written. */
+    name: string;
+    /** In-container absolute path where the volume mounts. */
+    mountPath: string;
+    /** Disk size in GB. 1–100, default 1. Counts against your plan's
+     *  storage quota and is metered for billing. */
+    sizeGb?: number;
+}
+interface UpdateVolumeInput {
+    mountPath?: string;
+    sizeGb?: number;
+}
 interface Domain {
     id: number;
     publicId: string;
@@ -324,6 +365,15 @@ declare class DeploysResource {
     cancel(teamId: IdInput, serviceId: IdInput, deployId: IdInput): Promise<void>;
     /** Rollback to a previous deploy. */
     rollback(teamId: IdInput, serviceId: IdInput, deployId: IdInput): Promise<void>;
+    /**
+     * v66 P5: promote a built deploy to a sibling service in another
+     * environment. Reuses the source deploy's docker image (no rebuild).
+     * If no sibling service exists in the target env yet, the API auto-
+     * creates one by cloning the source service's config.
+     */
+    promote(teamId: IdInput, serviceId: IdInput, deployId: IdInput, targetEnvironmentId: number): Promise<{
+        deploy: Deploy;
+    }>;
     /**
      * Get build logs for a deploy.
      *
@@ -371,6 +421,76 @@ declare class DomainsResource {
     verify(teamId: IdInput, domainId: IdInput): Promise<void>;
 }
 
+interface Environment {
+    id: number;
+    publicId: string;
+    projectId: number;
+    name: string;
+    type: 'production' | 'staging' | 'development' | 'preview';
+    isDefault: boolean;
+    isProtected: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateEnvironmentInput {
+    name: string;
+    type: 'production' | 'staging' | 'development' | 'preview';
+    isProtected?: boolean;
+}
+interface UpdateEnvironmentInput {
+    name?: string;
+    isDefault?: boolean;
+    isProtected?: boolean;
+}
+/**
+ * v66 P5: programmatic env management. Each project has at least a
+ * Production env auto-created at project creation; you can add more
+ * via `create` and bind services/databases to them via the
+ * `environmentId` field on those resources' create inputs.
+ *
+ * @example
+ * ```ts
+ * const { environment: staging } = await client.environments.create(
+ *   teamId,
+ *   projectId,
+ *   { name: 'Staging', type: 'staging' }
+ * );
+ * await client.services.create(teamId, {
+ *   projectId,
+ *   environmentId: staging.id,
+ *   name: 'api',
+ *   type: 'web_service',
+ *   // ...
+ * });
+ * ```
+ */
+declare class EnvironmentsResource {
+    private client;
+    constructor(client: HostStack);
+    /** List all environments for a project. */
+    list(teamId: IdInput, projectId: IdInput): Promise<{
+        environments: Environment[];
+    }>;
+    /** Get a single environment by id. */
+    get(teamId: IdInput, projectId: IdInput, envId: IdInput): Promise<{
+        environment: Environment;
+    }>;
+    /** Create a new environment in the given project. */
+    create(teamId: IdInput, projectId: IdInput, data: CreateEnvironmentInput): Promise<{
+        environment: Environment;
+    }>;
+    /** Update environment metadata (name, default flag, protected flag). */
+    update(teamId: IdInput, projectId: IdInput, envId: IdInput, data: UpdateEnvironmentInput): Promise<{
+        environment: Environment;
+    }>;
+    /**
+     * Delete an environment. The API blocks delete when the env still
+     * has services or databases attached — destroy them first or move
+     * them to another env. Cannot delete the project's default env.
+     */
+    delete(teamId: IdInput, projectId: IdInput, envId: IdInput): Promise<void>;
+}
+
 declare class EnvVarsResource {
     private client;
     constructor(client: HostStack);
@@ -475,13 +595,31 @@ declare class ServicesResource {
     updateConfig(teamId: IdInput, serviceId: IdInput, data: UpdateServiceConfigInput): Promise<{
         config: ServiceConfig;
     }>;
-    /** Get runtime logs for a service. */
+    /**
+     * Get runtime logs for a service.
+     *
+     * `since`/`until` accept either an ISO-8601 timestamp or a short
+     * relative offset like `-5m`, `-1h`, `-2d`.
+     *
+     * `search` does case-insensitive substring filtering server-side
+     * (≤100 chars). `countOnly` returns just `{ count: N }` for cheap
+     * polling — useful when you want to know "how many error lines in the
+     * last 5 minutes" without paying the bytes.
+     */
     getRuntimeLogs(teamId: IdInput, serviceId: IdInput, options?: {
         lines?: number;
+        limit?: number;
         since?: string;
+        until?: string;
         stream?: 'stdout' | 'stderr';
+        level?: 'stdout' | 'stderr' | 'info' | 'warn' | 'error' | 'debug';
+        search?: string;
+        grep?: string;
+        countOnly?: boolean;
     }): Promise<{
         logs: LogEntry[] | string;
+    } | {
+        count: number;
     }>;
     /**
      * Stream runtime logs for a service by polling the logs endpoint.
@@ -498,6 +636,53 @@ declare class ServicesResource {
     streamLogs(teamId: IdInput, serviceId: IdInput, options?: StreamLogsOptions): AsyncGenerator<LogEntry>;
 }
 
+/**
+ * Manage persistent disks attached to a service.
+ *
+ * Volumes mount a writable disk into a service's container at the path you
+ * choose, surviving redeploys and container restarts. One service can have
+ * multiple volumes; each one is identified by a short `name` and a
+ * `mountPath`.
+ *
+ * Renderers porting from render.yaml: a volume here is the same concept as
+ * Render's `disk:` block. Use {@link create} to attach one programmatically,
+ * or declare it in `hoststack.yaml` for IaC workflows.
+ *
+ * @example
+ * ```ts
+ * await client.volumes.create(team, service, {
+ *   name: 'data',
+ *   mountPath: '/var/data',
+ *   sizeGb: 10,
+ * });
+ * ```
+ */
+declare class VolumesResource {
+    private client;
+    constructor(client: HostStack);
+    /** List volumes attached to a service. */
+    list(teamId: IdInput, serviceId: IdInput): Promise<{
+        volumes: Volume[];
+    }>;
+    /** Attach a new volume to a service. Triggers provisioning on the host. */
+    create(teamId: IdInput, serviceId: IdInput, data: CreateVolumeInput): Promise<{
+        volume: Volume;
+    }>;
+    /**
+     * Update a volume's mountPath or sizeGb. Resizes that take effect on the
+     * next deploy; mountPath changes require a redeploy to remount.
+     */
+    update(teamId: IdInput, serviceId: IdInput, volumeId: IdInput, data: UpdateVolumeInput): Promise<{
+        volume: Volume;
+    }>;
+    /**
+     * Detach and deprovision a volume. The underlying disk is destroyed —
+     * back up any data first. Async: the row is marked `deleting` and the
+     * agent finalises the removal once it acks.
+     */
+    delete(teamId: IdInput, serviceId: IdInput, volumeId: IdInput): Promise<void>;
+}
+
 /** A numeric id or a publicId string (e.g. 42, "42", "svc_abc…"). */
 type IdInput = number | string;
 interface HostStackOptions {
@@ -524,10 +709,17 @@ type ResolveScope = {
 } | {
     kind: 'domain';
     teamId: number;
+} | {
+    kind: 'volume';
+    teamId: number;
+    serviceId: number;
 } | {
     kind: 'envVar';
     teamId: number;
     serviceId: number;
+} | {
+    kind: 'environment';
+    teamId: number;
 } | {
     kind: 'cronExecution';
     teamId: number;
@@ -549,8 +741,12 @@ declare class HostStack {
     readonly domains: DomainsResource;
     /** Manage service environment variables. */
     readonly envVars: EnvVarsResource;
+    /** v66: manage environments (production/staging/development/preview) per project. */
+    readonly environments: EnvironmentsResource;
     /** Manage cron job executions. */
     readonly cron: CronResource;
+    /** Manage persistent disks attached to services. */
+    readonly volumes: VolumesResource;
     constructor(options: HostStackOptions);
     /**
      * Make an authenticated request to the HostStack API.
@@ -614,4 +810,4 @@ declare function buildPaginationQuery(params?: PaginationParams): string;
  */
 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 };
+export { type ActivityLogEntry, type AddDomainInput, AuthenticationError, type BulkSetEnvVarsInput, type CreateDatabaseInput, type CreateEnvVarInput, type CreateEnvironmentInput, type CreateProjectInput, type CreateServiceInput, type CronExecution, type Database, type DatabaseCredentials, type Deploy, type Domain, type EnvVar, type Environment, 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 UpdateEnvironmentInput, type UpdateProjectInput, type UpdateServiceConfigInput, type UpdateServiceInput, type User, buildPaginationQuery, wrapArray };