@watasu/sdk 0.1.5 → 0.1.24

package/dist/template.d.ts

@@ -0,0 +1,232 @@
+import { ConnectionOpts } from './connectionConfig.js';
+export type TemplateBuildStatus = 'building' | 'waiting' | 'ready' | 'error';
+export interface BuildInfo {
+    /** First template alias. Prefer `name` for new code. */
+    alias: string;
+    /** Template name passed to the build call. */
+    name: string;
+    /** Tags assigned to this build. */
+    tags: string[];
+    /** Template identifier. */
+    templateId: string;
+    /** Build identifier. */
+    buildId: string;
+}
+export interface LogEntry {
+    timestamp?: Date;
+    level: string;
+    message: string;
+}
+export interface BuildStatusReason {
+    message: string;
+    step?: string;
+    logEntries: LogEntry[];
+}
+export interface TemplateBuildStatusResponse {
+    buildID: string;
+    templateID: string;
+    status: TemplateBuildStatus;
+    logEntries: LogEntry[];
+    logs: string[];
+    reason?: BuildStatusReason;
+}
+export interface TemplateTagInfo {
+    buildId: string;
+    tags: string[];
+}
+export interface TemplateTag {
+    tag: string;
+    buildId: string;
+    createdAt: Date;
+}
+export interface TemplateOptions {
+    fileContextPath?: string;
+    fileIgnorePatterns?: string[];
+}
+export interface CopyOptions {
+    forceUpload?: true;
+    user?: string;
+    mode?: number;
+    resolveSymlinks?: boolean;
+}
+export interface BasicBuildOptions {
+    alias?: string;
+    tags?: string[];
+    cpuCount?: number;
+    memoryMB?: number;
+    skipCache?: boolean;
+    onBuildLogs?: (entry: LogEntry) => void;
+    team?: string;
+}
+export type BuildOptions = ConnectionOpts & BasicBuildOptions;
+export type GetBuildStatusOptions = ConnectionOpts & {
+    logsOffset?: number;
+};
+export type TemplateClass = TemplateBase;
+export type CopyItem = {
+    src: string | string[];
+    dest: string;
+    forceUpload?: true;
+    user?: string;
+    mode?: number;
+    resolveSymlinks?: boolean;
+};
+export type TemplateBuilder = TemplateBase;
+export type TemplateFinal = TemplateBase;
+export type TemplateFromImage = TemplateBase;
+export type ReadyCommand = string | ReadyCmd;
+interface TemplateFileSpec {
+    path: string;
+    content_b64: string;
+    source_path?: string;
+    mode?: number;
+    user?: string;
+}
+interface BuildSpec {
+    base?: string;
+    packages?: Record<string, string[]>;
+    files?: TemplateFileSpec[];
+    setup?: string[];
+    env?: Record<string, string>;
+    start_cmd?: string;
+    ready_cmd?: string;
+}
+/** Ready-check command wrapper accepted by template builders. */
+export declare class ReadyCmd {
+    private readonly cmd;
+    constructor(cmd: string);
+    /** Return the shell command used as the ready check. */
+    getCmd(): string;
+}
+/** Return a ready check that waits for a TCP port to listen. */
+export declare function waitForPort(port: number): ReadyCmd;
+/** Return a ready check that waits for a URL to return an HTTP status code. */
+export declare function waitForURL(url: string, statusCode?: number): ReadyCmd;
+/** Alias for `waitForURL`. */
+export declare const waitForUrl: typeof waitForURL;
+/** Return a ready check that waits for a process name. */
+export declare function waitForProcess(processName: string): ReadyCmd;
+/** Return a ready check that waits for a file to exist. */
+export declare function waitForFile(filename: string): ReadyCmd;
+/** Return a ready check that waits for a fixed duration in milliseconds. */
+export declare function waitForTimeout(timeout: number): ReadyCmd;
+/** Chainable template builder for Watasu package-spec template builds. */
+export declare class TemplateBase {
+    private base;
+    private packages;
+    private files;
+    private setup;
+    private env;
+    private currentWorkdir;
+    private currentUser;
+    private startCmd;
+    private readyCmd;
+    private force;
+    private readonly fileContextPath;
+    private readonly fileIgnorePatterns;
+    constructor(options?: TemplateOptions);
+    static build(template: TemplateClass, name: string, options?: Omit<BuildOptions, 'alias'>): Promise<BuildInfo>;
+    static build(template: TemplateClass, options: BuildOptions): Promise<BuildInfo>;
+    static buildInBackground(template: TemplateClass, name: string, options?: Omit<BuildOptions, 'alias'>): Promise<BuildInfo>;
+    static buildInBackground(template: TemplateClass, options: BuildOptions): Promise<BuildInfo>;
+    static getBuildStatus(data: Pick<BuildInfo, 'templateId' | 'buildId'>, options?: GetBuildStatusOptions): Promise<TemplateBuildStatusResponse>;
+    static exists(name: string, options?: ConnectionOpts): Promise<boolean>;
+    static aliasExists(alias: string, options?: ConnectionOpts): Promise<boolean>;
+    static assignTags(targetName: string, tags: string | string[], options?: ConnectionOpts): Promise<TemplateTagInfo>;
+    static removeTags(name: string, tags: string | string[], options?: ConnectionOpts): Promise<void>;
+    static getTags(templateId: string, options?: ConnectionOpts): Promise<TemplateTag[]>;
+    static toJSON(template: TemplateClass): Promise<string>;
+    static toDockerfile(template: TemplateClass): string;
+    fromDebianImage(_variant?: string): TemplateBuilder;
+    fromUbuntuImage(_variant?: string): TemplateBuilder;
+    fromPythonImage(_version?: string): TemplateBuilder;
+    fromNodeImage(_variant?: string): TemplateBuilder;
+    fromBunImage(_variant?: string): TemplateBuilder;
+    fromBaseImage(): TemplateBuilder;
+    fromImage(_baseImage: string, _credentials?: {
+        username: string;
+        password: string;
+    }): TemplateBuilder;
+    fromAWSRegistry(_image: string, _credentials: {
+        accessKeyId: string;
+        secretAccessKey: string;
+        region: string;
+    }): TemplateBuilder;
+    fromGCPRegistry(_image: string, _credentials: {
+        serviceAccountJSON: object | string;
+    }): TemplateBuilder;
+    fromTemplate(template: string): TemplateBuilder;
+    fromDockerfile(dockerfileContentOrPath: string): TemplateBuilder;
+    copy(src: string | string[], dest: string, options?: CopyOptions): TemplateBuilder;
+    copyItems(items: CopyItem[]): TemplateBuilder;
+    remove(path: string | string[], options?: {
+        force?: boolean;
+        recursive?: boolean;
+        user?: string;
+    }): TemplateBuilder;
+    rename(src: string, dest: string, options?: {
+        force?: boolean;
+        user?: string;
+    }): TemplateBuilder;
+    makeDir(path: string | string[], options?: {
+        mode?: number;
+        user?: string;
+    }): TemplateBuilder;
+    makeSymlink(src: string, dest: string, options?: {
+        force?: boolean;
+        user?: string;
+    }): TemplateBuilder;
+    runCmd(command: string | string[], options?: {
+        user?: string;
+    }): TemplateBuilder;
+    setWorkdir(workdir: string): TemplateBuilder;
+    setUser(user: string): TemplateBuilder;
+    pipInstall(packages?: string | string[], options?: {
+        g?: boolean;
+    }): TemplateBuilder;
+    npmInstall(packages?: string | string[], options?: {
+        g?: boolean;
+        dev?: boolean;
+    }): TemplateBuilder;
+    bunInstall(packages?: string | string[], options?: {
+        g?: boolean;
+        dev?: boolean;
+    }): TemplateBuilder;
+    aptInstall(packages: string | string[], _options?: {
+        noInstallRecommends?: boolean;
+        fixMissing?: boolean;
+    }): TemplateBuilder;
+    addMcpServer(servers: string | string[]): TemplateBuilder;
+    gitClone(url: string, path?: string, options?: {
+        branch?: string;
+        depth?: number;
+        user?: string;
+    }): TemplateBuilder;
+    setStartCmd(startCommand: string, readyCommand: ReadyCommand): TemplateFinal;
+    setReadyCmd(readyCommand: ReadyCommand): TemplateFinal;
+    setEnvs(envs: Record<string, string>): TemplateBuilder;
+    skipCache(): TemplateBuilder;
+    toBuildSpec(): BuildSpec;
+    private addPackages;
+    private addCopySource;
+    private addFileSpec;
+    private resolveContextPath;
+    private ignored;
+    private commandWithContext;
+    private toDockerfile;
+}
+export interface TemplateFactory {
+    (options?: TemplateOptions): TemplateFromImage;
+    build: typeof TemplateBase.build;
+    buildInBackground: typeof TemplateBase.buildInBackground;
+    getBuildStatus: typeof TemplateBase.getBuildStatus;
+    exists: typeof TemplateBase.exists;
+    aliasExists: typeof TemplateBase.aliasExists;
+    assignTags: typeof TemplateBase.assignTags;
+    removeTags: typeof TemplateBase.removeTags;
+    getTags: typeof TemplateBase.getTags;
+    toJSON: typeof TemplateBase.toJSON;
+    toDockerfile: typeof TemplateBase.toDockerfile;
+}
+export declare const Template: TemplateFactory;
+export {};