@roxyon/deploy-core 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,168 @@
+import { Ignore } from 'ignore';
+import { RuntimeName, DeployKind, Roxyon } from '@roxyon/api-client';
+export { DeployKind } from '@roxyon/api-client';
+
+/** Always excluded, regardless of ignore files — build artefacts and VCS/OS cruft. */
+declare const ALWAYS_IGNORE: string[];
+/** Build the ignore matcher: `.roxyonignore` if present, else `.gitignore`, plus the always-list. */
+declare function buildIgnore(root: string): Promise<Ignore>;
+/** Recursively list files under `root` that survive the ignore matcher (POSIX-relative paths). */
+declare function listFiles(root: string, ig: Ignore): Promise<string[]>;
+interface PackResult {
+    buffer: Buffer;
+    files: string[];
+    bytes: number;
+}
+/**
+ * Create a deterministic gzipped tarball of `root` (minus ignored paths).
+ * `prefix`, when given, is prepended to every entry path inside the archive.
+ */
+declare function packDirectory(root: string, opts?: {
+    prefix?: string;
+    maxBytes?: number;
+}): Promise<PackResult>;
+/** Total on-disk size of a set of files. */
+declare function measure(root: string, files: string[]): Promise<number>;
+
+interface Detection {
+    runtime: RuntimeName;
+    /** why we think so — shown to the user, who can override */
+    reason: string;
+    /** best-guess start command for a server runtime */
+    start?: string;
+}
+/** Best-effort project-type detection. Deterministic; the caller confirms. */
+declare function detectRuntime(root: string): Promise<Detection>;
+
+interface ProjectConfig {
+    name: string;
+    /** `Applications.objectId`, filled after the first `app`-kind deploy. */
+    application?: string;
+    /** Route host — `Domains.Name`. */
+    host: string;
+    /** Sub-path under the host's docroot / source tree. `""` = root. */
+    folder: string;
+    runtime: RuntimeName;
+    runtimeVersion?: string;
+    preset?: string;
+    kind: DeployKind;
+    /** Local build command (LumenJS / static). Empty for server runtimes. */
+    build?: string;
+    /** Directory the build writes to (relative to project root). */
+    outDir?: string;
+    /** Web-process start command (app kind only). */
+    start?: string;
+    /** Serve the app on the host instead of the host's own files. */
+    public?: boolean;
+}
+declare const PROJECT_FILE = "roxyon.json";
+declare function projectConfigPath(cwd?: string): string;
+declare function loadProjectConfig(cwd?: string): Promise<ProjectConfig | undefined>;
+declare function saveProjectConfig(config: ProjectConfig, cwd?: string): Promise<string>;
+interface BuildConfigInput {
+    cwd: string;
+    runtime: RuntimeName;
+    host: string;
+    folder?: string;
+    name?: string;
+    start?: string;
+}
+/**
+ * Produce a `ProjectConfig` from a resolved runtime + host. Shared by the CLI's
+ * `roxyon init` and the MCP `roxyon_init` tool so both write the same shape.
+ */
+declare function buildProjectConfig(input: BuildConfigInput): ProjectConfig;
+
+interface DeployReporter {
+    /** A high-level phase change ("Building", "Uploading", "Live"). */
+    step?: (msg: string) => void;
+    /** A single build- or runtime-log line. */
+    log?: (line: string) => void;
+}
+interface DeployParams {
+    cwd: string;
+    /** An authenticated client. */
+    roxyon: Roxyon;
+    /** Subscription objectId / Name to prefer when the account has several. */
+    preferredSubscription?: string;
+    /** Run the configured build command (default true). */
+    build?: boolean;
+    /** For app deploys: poll until running/failed (default true). */
+    follow?: boolean;
+    pollMs?: number;
+    timeoutMs?: number;
+    reporter?: DeployReporter;
+    /** Override the build-command runner (default: spawn a shell). */
+    runCommand?: (command: string, cwd: string, reporter?: DeployReporter) => Promise<number>;
+}
+type DeployOutcome = {
+    kind: 'static';
+    ok: true;
+    url: string;
+    files: number;
+    config: ProjectConfig;
+} | {
+    kind: 'app';
+    ok: true;
+    application: string;
+    status: string;
+    revision: number;
+    url?: string;
+    config: ProjectConfig;
+    logs: string[];
+} | {
+    kind: 'app';
+    ok: false;
+    application: string;
+    status: string;
+    error: string;
+    config: ProjectConfig;
+    logs: string[];
+};
+declare class DeployError extends Error {
+    readonly code: 'no-config' | 'auth' | 'bad-host' | 'build-failed' | 'no-build-output' | 'upload-failed' | 'create-failed';
+    constructor(message: string, code: DeployError['code']);
+}
+/**
+ * Build (if configured), archive, upload, and — for app runtimes — poll until
+ * the deploy settles. Self-contained: one `/account/context` call validates the
+ * host (works with a session token or a `roxp_` PAT), and the console creates
+ * the application on the first deploy — the new id is written back to
+ * `roxyon.json`.
+ */
+declare function deployProject(params: DeployParams): Promise<DeployOutcome>;
+
+/**
+ * Default build-command runner: spawn a shell, stream output to the reporter.
+ * Callers in a non-local context (a hosted server) can pass their own.
+ */
+declare function runShellCommand(command: string, cwd: string, reporter?: DeployReporter): Promise<number>;
+
+/**
+ * Stored login for Roxyon tooling — `~/.roxyon/config.json`, mode 0600. Written
+ * by `roxyon login`; read by the CLI and the MCP server alike.
+ */
+interface Credentials {
+    sessionToken: string;
+    refreshToken?: string;
+    userId: string;
+    email?: string;
+    /** Preferred subscription (objectId / Name) when the account has several. */
+    subscription?: string;
+    savedAt: string;
+}
+interface Endpoints {
+    apiUrl?: string;
+    consoleUrl?: string;
+}
+declare function credentialsDir(): string;
+declare function credentialsPath(): string;
+/** Endpoint overrides from the environment (`ROXYON_API_URL`, `ROXYON_CONSOLE_URL`). */
+declare function endpointsFromEnv(): Endpoints;
+/** A token supplied out-of-band (CI, or an MCP host env). Skips the stored login. */
+declare function tokenFromEnv(): string | undefined;
+declare function loadCredentials(): Promise<Credentials | undefined>;
+declare function saveCredentials(creds: Credentials): Promise<string>;
+declare function clearCredentials(): Promise<void>;
+
+export { ALWAYS_IGNORE, type BuildConfigInput, type Credentials, DeployError, type DeployOutcome, type DeployParams, type DeployReporter, type Detection, type Endpoints, PROJECT_FILE, type PackResult, type ProjectConfig, buildIgnore, buildProjectConfig, clearCredentials, credentialsDir, credentialsPath, deployProject, detectRuntime, endpointsFromEnv, listFiles, loadCredentials, loadProjectConfig, measure, packDirectory, projectConfigPath, runShellCommand, saveCredentials, saveProjectConfig, tokenFromEnv };

package/dist/index.d.ts

@@ -0,0 +1,168 @@
+import { Ignore } from 'ignore';
+import { RuntimeName, DeployKind, Roxyon } from '@roxyon/api-client';
+export { DeployKind } from '@roxyon/api-client';
+
+/** Always excluded, regardless of ignore files — build artefacts and VCS/OS cruft. */
+declare const ALWAYS_IGNORE: string[];
+/** Build the ignore matcher: `.roxyonignore` if present, else `.gitignore`, plus the always-list. */
+declare function buildIgnore(root: string): Promise<Ignore>;
+/** Recursively list files under `root` that survive the ignore matcher (POSIX-relative paths). */
+declare function listFiles(root: string, ig: Ignore): Promise<string[]>;
+interface PackResult {
+    buffer: Buffer;
+    files: string[];
+    bytes: number;
+}
+/**
+ * Create a deterministic gzipped tarball of `root` (minus ignored paths).
+ * `prefix`, when given, is prepended to every entry path inside the archive.
+ */
+declare function packDirectory(root: string, opts?: {
+    prefix?: string;
+    maxBytes?: number;
+}): Promise<PackResult>;
+/** Total on-disk size of a set of files. */
+declare function measure(root: string, files: string[]): Promise<number>;
+
+interface Detection {
+    runtime: RuntimeName;
+    /** why we think so — shown to the user, who can override */
+    reason: string;
+    /** best-guess start command for a server runtime */
+    start?: string;
+}
+/** Best-effort project-type detection. Deterministic; the caller confirms. */
+declare function detectRuntime(root: string): Promise<Detection>;
+
+interface ProjectConfig {
+    name: string;
+    /** `Applications.objectId`, filled after the first `app`-kind deploy. */
+    application?: string;
+    /** Route host — `Domains.Name`. */
+    host: string;
+    /** Sub-path under the host's docroot / source tree. `""` = root. */
+    folder: string;
+    runtime: RuntimeName;
+    runtimeVersion?: string;
+    preset?: string;
+    kind: DeployKind;
+    /** Local build command (LumenJS / static). Empty for server runtimes. */
+    build?: string;
+    /** Directory the build writes to (relative to project root). */
+    outDir?: string;
+    /** Web-process start command (app kind only). */
+    start?: string;
+    /** Serve the app on the host instead of the host's own files. */
+    public?: boolean;
+}
+declare const PROJECT_FILE = "roxyon.json";
+declare function projectConfigPath(cwd?: string): string;
+declare function loadProjectConfig(cwd?: string): Promise<ProjectConfig | undefined>;
+declare function saveProjectConfig(config: ProjectConfig, cwd?: string): Promise<string>;
+interface BuildConfigInput {
+    cwd: string;
+    runtime: RuntimeName;
+    host: string;
+    folder?: string;
+    name?: string;
+    start?: string;
+}
+/**
+ * Produce a `ProjectConfig` from a resolved runtime + host. Shared by the CLI's
+ * `roxyon init` and the MCP `roxyon_init` tool so both write the same shape.
+ */
+declare function buildProjectConfig(input: BuildConfigInput): ProjectConfig;
+
+interface DeployReporter {
+    /** A high-level phase change ("Building", "Uploading", "Live"). */
+    step?: (msg: string) => void;
+    /** A single build- or runtime-log line. */
+    log?: (line: string) => void;
+}
+interface DeployParams {
+    cwd: string;
+    /** An authenticated client. */
+    roxyon: Roxyon;
+    /** Subscription objectId / Name to prefer when the account has several. */
+    preferredSubscription?: string;
+    /** Run the configured build command (default true). */
+    build?: boolean;
+    /** For app deploys: poll until running/failed (default true). */
+    follow?: boolean;
+    pollMs?: number;
+    timeoutMs?: number;
+    reporter?: DeployReporter;
+    /** Override the build-command runner (default: spawn a shell). */
+    runCommand?: (command: string, cwd: string, reporter?: DeployReporter) => Promise<number>;
+}
+type DeployOutcome = {
+    kind: 'static';
+    ok: true;
+    url: string;
+    files: number;
+    config: ProjectConfig;
+} | {
+    kind: 'app';
+    ok: true;
+    application: string;
+    status: string;
+    revision: number;
+    url?: string;
+    config: ProjectConfig;
+    logs: string[];
+} | {
+    kind: 'app';
+    ok: false;
+    application: string;
+    status: string;
+    error: string;
+    config: ProjectConfig;
+    logs: string[];
+};
+declare class DeployError extends Error {
+    readonly code: 'no-config' | 'auth' | 'bad-host' | 'build-failed' | 'no-build-output' | 'upload-failed' | 'create-failed';
+    constructor(message: string, code: DeployError['code']);
+}
+/**
+ * Build (if configured), archive, upload, and — for app runtimes — poll until
+ * the deploy settles. Self-contained: one `/account/context` call validates the
+ * host (works with a session token or a `roxp_` PAT), and the console creates
+ * the application on the first deploy — the new id is written back to
+ * `roxyon.json`.
+ */
+declare function deployProject(params: DeployParams): Promise<DeployOutcome>;
+
+/**
+ * Default build-command runner: spawn a shell, stream output to the reporter.
+ * Callers in a non-local context (a hosted server) can pass their own.
+ */
+declare function runShellCommand(command: string, cwd: string, reporter?: DeployReporter): Promise<number>;
+
+/**
+ * Stored login for Roxyon tooling — `~/.roxyon/config.json`, mode 0600. Written
+ * by `roxyon login`; read by the CLI and the MCP server alike.
+ */
+interface Credentials {
+    sessionToken: string;
+    refreshToken?: string;
+    userId: string;
+    email?: string;
+    /** Preferred subscription (objectId / Name) when the account has several. */
+    subscription?: string;
+    savedAt: string;
+}
+interface Endpoints {
+    apiUrl?: string;
+    consoleUrl?: string;
+}
+declare function credentialsDir(): string;
+declare function credentialsPath(): string;
+/** Endpoint overrides from the environment (`ROXYON_API_URL`, `ROXYON_CONSOLE_URL`). */
+declare function endpointsFromEnv(): Endpoints;
+/** A token supplied out-of-band (CI, or an MCP host env). Skips the stored login. */
+declare function tokenFromEnv(): string | undefined;
+declare function loadCredentials(): Promise<Credentials | undefined>;
+declare function saveCredentials(creds: Credentials): Promise<string>;
+declare function clearCredentials(): Promise<void>;
+
+export { ALWAYS_IGNORE, type BuildConfigInput, type Credentials, DeployError, type DeployOutcome, type DeployParams, type DeployReporter, type Detection, type Endpoints, PROJECT_FILE, type PackResult, type ProjectConfig, buildIgnore, buildProjectConfig, clearCredentials, credentialsDir, credentialsPath, deployProject, detectRuntime, endpointsFromEnv, listFiles, loadCredentials, loadProjectConfig, measure, packDirectory, projectConfigPath, runShellCommand, saveCredentials, saveProjectConfig, tokenFromEnv };