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

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,310 @@
+# Third-party notices
+
+Parts of `@lakutata/containerd` are derived from the third-party projects listed below. They are rewritten in
+TypeScript; the original copyright notices and license terms are reproduced here as required.
+
+## containerd 1.7.27
+
+Copyright The containerd Authors. Licensed under the Apache License, Version 2.0 (reproduced below).
+
+The messages of the API of containerd (their fields and their numbers, from its `api/` protobuf definitions):
+`src/client/Messages.ts`; the defaults of the specifications of the containers (the capabilities, the mounts, the masked
+and read only paths, the devices, from its `oci/` package): `src/client/Spec.ts`; its default profile of seccomp (from
+its `contrib/seccomp` package): `src/client/Seccomp.ts`; the identifiers of the chains of the
+layers and the labels of its garbage collection: `src/client/ImageStore.ts`.
+
+The metrics of the cgroups v1 and v2 (their fields and their numbers, from the `stats` protobuf definitions of
+github.com/containerd/cgroups, Copyright The containerd Authors, Apache License 2.0): `src/client/Messages.ts`.
+
+Modifications: no protobuf definitions are included; the messages are written as the schemas of the encoder of this
+package (`src/client/Protobuf.ts`), with the fields this package uses only.
+
+## nerdctl 2.0
+
+Copyright The containerd Authors. Licensed under the Apache License, Version 2.0 (reproduced below).
+
+The labels of the containers (`nerdctl/name`, `nerdctl/hostname`, `nerdctl/platform`, `nerdctl/log-uri`,
+`nerdctl/state-dir`, `nerdctl/networks`, `nerdctl/mounts`) and the composition of the options of the containers:
+`src/client/ContainerStore.ts`.
+
+Modifications: no code of nerdctl is included; its conventions are followed so that nerdctl lists the containers.
+
+## BuildKit 0.16
+
+Copyright The BuildKit Authors. Licensed under the Apache License, Version 2.0 (reproduced below).
+
+The messages of the API of BuildKit and of its session (their fields and their numbers, from its
+`api/services/control`, `session/filesync` and `session/auth` protobuf definitions): `src/client/BuildKitMessages.ts`;
+the session (the methods exposed by its headers, the connection of HTTP/2 in its stream) and the lines of the
+progress of the builds: `src/client/BuildKit.ts`.
+
+Modifications: no protobuf definitions are included; the messages are written as the schemas of the encoder of this
+package, with the fields this package uses only.
+
+## fsutil
+
+Copyright Tõnis Tiigi. Licensed under the MIT License (reproduced below).
+
+The protocol of the directories sent to BuildKit (its packets and its stats, the order of its walk, the modes of Go):
+`src/client/BuildKit.ts`, `src/client/BuildKitMessages.ts`.
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2017 Tõnis Tiigi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
+
+## @balena/dockerignore 1.0.2
+
+Copyright 2020 Balena Ltd. under the Apache License, Version 2.0 (reproduced below).
+Copyright 2018 Zeit Inc. under the MIT License (reproduced below).
+
+The rules of the `.dockerignore` files: `src/client/DockerIgnore.ts`.
+
+Modifications: rewritten in TypeScript; only the matching of the paths of a build context is kept.
+
+## The MIT License of Zeit Inc.
+
+```
+Copyright 2018 Zeit Inc.
+
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+```
+
+
+## Apache License, Version 2.0
+
+```
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```

package/dist/cjs/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[]>;