@lakutata/containerd 0.0.0-stage → 3.0.0-beta.1

package/dist/types/client/BuildKit.d.ts

@@ -0,0 +1,176 @@
+import { type BigIntStats } from 'node:fs';
+import { type Writable } from 'node:stream';
+import { GRPCConnection, GRPCServerCall, type Message } from '@lakutata/grpc';
+import { type Platform } from './Platforms.js';
+import { type RegistryCredentials } from './Registry.js';
+/**
+ * The mode of a file as Go writes it (os.FileMode), the one of the stats of fsutil
+ * @param stats
+ */
+export declare function goFileMode(stats: BigIntStats): number;
+/**
+ * The expression of a pattern of the paths of fsutil (filepath.Match, ** for any directories)
+ * @param pattern
+ */
+export declare function patternExpression(pattern: string): RegExp;
+/**
+ * An entry of a directory sent: its path (relative, "/" separated), its stat of fsutil
+ */
+export type SyncEntry = {
+    path: string;
+    absolute: string;
+    stat: Message;
+    file: boolean;
+};
+/**
+ * The filters of a directory sent to BuildKit: its patterns included (the Dockerfile), excluded (its .dockerignore), its
+ * paths whose symbolic links are followed
+ */
+export type SyncFilter = {
+    include?: string[];
+    exclude?: string[];
+    followPaths?: string[];
+};
+/**
+ * The entries of a directory sent to BuildKit, in the order fsutil walks them (lexical, the directories before their
+ * content); the parents of the paths included are included
+ * @param root
+ * @param filter
+ */
+export declare function walkDirectory(root: string, filter?: SyncFilter): Promise<SyncEntry[]>;
+/**
+ * Send a directory as fsutil sends it (FileSync.DiffCopy): its stats, then the files the receiver requests, until it
+ * finishes
+ * @param call
+ * @param root
+ */
+export declare function sendDirectory(call: GRPCServerCall, root: string): Promise<void>;
+/**
+ * The options of a session of BuildKit
+ */
+export type BuildKitSessionOptions = {
+    /**
+     * Its name (the one of the build)
+     */
+    name: string;
+    /**
+     * The key of the files of its directories cached by BuildKit (the one of buildx: the path of the context)
+     */
+    sharedKey: string;
+    /**
+     * The directories it sends (context, dockerfile)
+     */
+    directories: Record<string, string>;
+    /**
+     * The credentials of a registry (registry-1.docker.io, registry.example.com:5000)
+     */
+    credentials?: (host: string) => RegistryCredentials | undefined;
+    /**
+     * Where the results exported to the client are written (the archive of the oci exporter)
+     */
+    output?: () => Writable;
+};
+/**
+ * A session of BuildKit: a connection of HTTP/2 in the stream of Control.Session, where the daemon calls its methods
+ * (the files of the directories of the build, the results exported, the credentials of the registries, its health)
+ */
+export declare class BuildKitSession {
+    #private;
+    protected readonly options: BuildKitSessionOptions;
+    readonly id: string;
+    constructor(options: BuildKitSessionOptions);
+    /**
+     * The credentials of a host of a registry (Docker Hub by its names)
+     * @param host
+     * @protected
+     */
+    protected credentials(host: string): RegistryCredentials | undefined;
+    /**
+     * Open the session: the stream of Control.Session, the methods of the session exposed by its headers
+     * @param connection
+     * @param signal
+     */
+    start(connection: GRPCConnection, signal?: AbortSignal): void;
+    /**
+     * Close the session
+     */
+    close(): void;
+}
+/**
+ * The lines of the progress of a build, as "docker build --progress=plain" shows them: the steps are numbered in their
+ * order ("#3 [2/2] RUN npm ci"), with their output, and whether they are cached, done ("#3 DONE 1.2s") or failed
+ */
+export declare class BuildKitProgress {
+    #private;
+    protected step(digest: string): {
+        number: number;
+        started: boolean;
+        ended: boolean;
+    };
+    /**
+     * The lines of a status of the build
+     * @param status
+     */
+    lines(status: Message): string[];
+    protected flush(digest: string): string[];
+}
+/**
+ * The options of a build
+ */
+export type BuildKitBuildOptions = {
+    /**
+     * The directory of the context
+     */
+    context: string;
+    /**
+     * The Dockerfile (relative to the context, or absolute): Dockerfile of the context by default
+     */
+    dockerfile?: string;
+    target?: string;
+    buildArgs?: Record<string, string>;
+    labels?: Record<string, string>;
+    /**
+     * The platforms built: the one of the workers of BuildKit by default
+     */
+    platforms?: Platform[];
+    noCache?: boolean;
+    /**
+     * Pull the base images again (their tags resolved by their registries)
+     */
+    pull?: boolean;
+    /**
+     * The name of the image (in the archive)
+     */
+    name: string;
+    /**
+     * The archive of the image (OCI image layout) written
+     */
+    output: string;
+    credentials?: (registry: string) => RegistryCredentials | undefined;
+    /**
+     * The lines of its progress
+     */
+    progress?: (line: string) => void;
+    signal?: AbortSignal;
+};
+/**
+ * Build an image with BuildKit (its Dockerfile frontend): its context and its Dockerfile sent by the session, the image
+ * exported to the client as an archive (the oci exporter); the daemon is local or remote, of any worker
+ * @param connection
+ * @param options
+ */
+export declare function buildKitBuild(connection: GRPCConnection, options: BuildKitBuildOptions): Promise<Record<string, string>>;
+/**
+ * The version of BuildKit
+ * @param connection
+ */
+export declare function buildKitVersion(connection: GRPCConnection): Promise<{
+    package: string;
+    version: string;
+    revision: string;
+}>;
+/**
+ * The platforms the workers of BuildKit build
+ * @param connection
+ */
+export declare function buildKitPlatforms(connection: GRPCConnection): Promise<Platform[]>;

package/dist/types/client/BuildKitMessages.d.ts

@@ -0,0 +1,35 @@
+import { type Schema } from '@lakutata/grpc';
+export declare const BytesMessage: Schema;
+export declare const ExporterMessage: Schema;
+export declare const SolveRequest: Schema;
+export declare const SolveResponse: Schema;
+export declare const StatusRequest: Schema;
+export declare const Vertex: Schema;
+export declare const VertexStatus: Schema;
+export declare const VertexLog: Schema;
+export declare const VertexWarning: Schema;
+export declare const StatusResponse: Schema;
+export declare const BuildkitVersion: Schema;
+export declare const InfoResponse: Schema;
+export declare const BuildKitPlatform: Schema;
+export declare const WorkerRecord: Schema;
+export declare const ListWorkersRequest: Schema;
+export declare const ListWorkersResponse: Schema;
+/**
+ * The types of the packets of fsutil
+ */
+export declare enum PacketType {
+    STAT = 0,
+    REQ = 1,
+    DATA = 2,
+    FIN = 3,
+    ERR = 4
+}
+export declare const Stat: Schema;
+export declare const Packet: Schema;
+export declare const CredentialsRequest: Schema;
+export declare const CredentialsResponse: Schema;
+export declare const FetchTokenRequest: Schema;
+export declare const FetchTokenResponse: Schema;
+export declare const HealthCheckRequest: Schema;
+export declare const HealthCheckResponse: Schema;