1.2.0

npmextra.json

@@ -15,9 +15,23 @@
       "githost": "gitlab.com",
       "gitscope": "mojoio",
       "gitrepo": "docker",
-      "description": "unofficial docker engine api abstraction package written in TypeScript",
+      "description": "Provides easy communication with Docker remote API from Node.js, with TypeScript support.",
       "npmPackagename": "@mojoio/docker",
-      "license": "MIT"
-    }
+      "license": "MIT",
+      "keywords": [
+        "Docker",
+        "API",
+        "Node.js",
+        "TypeScript",
+        "Containers",
+        "Images",
+        "Networks",
+        "Services",
+        "Secrets"
+      ]
+    }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@apiclient.xyz/docker",
-  "version": "1.0.106",
-  "description": "easy communication with docker remote api from node, TypeScript ready",
+  "version": "1.2.0",
+  "description": "Provides easy communication with Docker remote API from Node.js, with TypeScript support.",
   "private": false,
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -16,11 +16,15 @@
     "url": "git+https://gitlab.com/mojoio/docker.git"
   },
   "keywords": [
-    "docker",
-    "sock",
-    "container",
-    "request",
-    "api"
+    "Docker",
+    "API",
+    "Node.js",
+    "TypeScript",
+    "Containers",
+    "Images",
+    "Networks",
+    "Services",
+    "Secrets"
   ],
   "author": "Lossless GmbH",
   "license": "MIT",
@@ -29,25 +33,29 @@
   },
   "homepage": "https://gitlab.com/mojoio/docker#readme",
   "dependencies": {
-    "@push.rocks/lik": "^6.0.0",
-    "@push.rocks/smartfile": "^11.0.4",
-    "@push.rocks/smartjson": "^5.0.2",
-    "@push.rocks/smartlog": "^3.0.1",
+    "@push.rocks/lik": "^6.0.15",
+    "@push.rocks/smartarchive": "^4.0.36",
+    "@push.rocks/smartbucket": "^3.0.10",
+    "@push.rocks/smartfile": "^11.0.20",
+    "@push.rocks/smartjson": "^5.0.20",
+    "@push.rocks/smartlog": "^3.0.7",
     "@push.rocks/smartnetwork": "^3.0.0",
-    "@push.rocks/smartpath": "^5.0.5",
+    "@push.rocks/smartpath": "^5.0.18",
     "@push.rocks/smartpromise": "^4.0.3",
-    "@push.rocks/smartrequest": "^2.0.11",
-    "@push.rocks/smartstring": "^4.0.5",
-    "@push.rocks/smartversion": "^3.0.2",
-    "@tsclass/tsclass": "^4.0.24",
+    "@push.rocks/smartrequest": "^2.0.22",
+    "@push.rocks/smartstream": "^3.0.44",
+    "@push.rocks/smartstring": "^4.0.15",
+    "@push.rocks/smartunique": "^3.0.9",
+    "@push.rocks/smartversion": "^3.0.5",
+    "@tsclass/tsclass": "^4.0.54",
     "rxjs": "^7.5.7"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.25",
+    "@git.zone/tsbuild": "^2.1.80",
     "@git.zone/tsrun": "^1.2.12",
-    "@git.zone/tstest": "^1.0.52",
-    "@push.rocks/tapbundle": "^5.0.4",
-    "@types/node": "^20.11.16"
+    "@git.zone/tstest": "^1.0.90",
+    "@push.rocks/tapbundle": "^5.0.23",
+    "@types/node": "20.14.2"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -1,49 +1,152 @@
-# @mojoio/docker
-unofficial docker engine api abstraction package written in TypeScript
+# @apiclient.xyz/docker
 
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/docker)
-* [gitlab.com (source)](https://gitlab.com/mojoio/docker)
-* [github.com (source mirror)](https://github.com/mojoio/docker)
-* [docs (typedoc)](https://mojoio.gitlab.io/docker/)
+easy communication with docker remote api from node, TypeScript ready
 
-## Status for master
+## Install
 
-Status Category | Status Badge
--- | --
-GitLab Pipelines | [![pipeline status](https://gitlab.com/mojoio/docker/badges/master/pipeline.svg)](https://lossless.cloud)
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/mojoio/docker/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@mojoio/docker)](https://lossless.cloud)
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/mojoio/docker)](https://lossless.cloud)
-TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
-node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
-PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@mojoio/docker)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@mojoio/docker)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@mojoio/docker)](https://lossless.cloud)
-Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+To install @apiclient.xyz/docker, you can use npm (npm package manager). Run the following command in your terminal:
+
+```bash
+npm install @apiclient.xyz/docker --save
+```
+
+This command installs the package and adds it as a dependency to your project's `package.json` file.
 
 ## Usage
 
-Use TypeScript for best in class instellisense.
+The `@apiclient.xyz/docker` package provides a TypeScript-ready interface for interacting with Docker's Remote API directly from Node.js applications. It leverages TypeScript for strong type definitions, ensuring more reliable and maintainable code.
+
+### Prerequisites
+
+Before you begin, ensure:
+
+- You have Docker installed and running on your machine or a remote server.
+- You are familiar with TypeScript and have it set up in your development environment.
+
+### Getting Started
+
+First, import the required classes from the package:
 
 ```typescript
-import { DockerHost } from '@mojoio/docker'; // require Dockersock class
-
-const run = async () => {
-  const myDockerHost = new DockerHost(); // optional: you can pass a domain to the contructor, defaults to  /var/run/docker.sock
-
-  const containers = await myDockerHost.getContainers(); // promise, resolve with an array of DockerContainers
-};
+import { DockerHost, DockerContainer, DockerService, DockerNetwork } from '@apiclient.xyz/docker';
 ```
 
-## Contribution
+### Instantiate DockerHost
 
-We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+Start by creating a `DockerHost` instance. This class is the entry point to communicate with the Docker Remote API.
 
-For further information read the linked docs at the top of this readme.
+```typescript
+// Connect to local Docker instance
+const localDockerHost = new DockerHost();
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+// Or specify a custom path or URL to a Docker host
+const remoteDockerHost = new DockerHost('tcp://<REMOTE_DOCKER_HOST>:2375');
+```
 
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
+### Working with Containers
+
+#### List All Containers
+
+```typescript
+async function listAllContainers() {
+  const containers = await localDockerHost.getContainers();
+  console.log(containers);
+}
+
+listAllContainers();
+```
+
+#### Create and Remove a Container
+
+```typescript
+import { IContainerCreationDescriptor } from '@apiclient.xyz/docker';
+
+async function createAndRemoveContainer() {
+  const containerDescriptor: IContainerCreationDescriptor = {
+    Hostname: 'test-container',
+    Domainname: '',
+    // Additional settings here
+  };
+
+  // Create container
+  const container = await DockerContainer.create(localDockerHost, containerDescriptor);
+  console.log(`Container Created: ${container.Id}`);
+
+  // Remove container
+  await container.remove();
+  console.log(`Container Removed: ${container.Id}`);
+}
+
+createAndRemoveContainer();
+```
+
+### Working with Docker Services
+
+#### Create a Docker Service
+
+```typescript
+import { IServiceCreationDescriptor } from '@apiclient.xyz/docker';
+
+async function createDockerService() {
+  const serviceDescriptor: IServiceCreationDescriptor = {
+    name: 'my-service',
+    image: 'nginx:latest', // Docker Image
+    // Additional settings
+  };
+  
+  const service = await DockerService.createService(localDockerHost, serviceDescriptor);
+  console.log(`Service Created: ${service.Id}`);
+}
+
+createDockerService();
+```
+
+### Working with Docker Networks
+
+#### Listing and Creating Networks
+
+```typescript
+async function listAndCreateNetwork() {
+  // List all networks
+  const networks = await localDockerHost.getNetworks();
+  console.log(networks);
+  
+  // Create a new network
+  const network = await DockerNetwork.createNetwork(localDockerHost, {
+    Name: 'my-network'
+    // Additional settings
+  });
+  console.log(`Network Created: ${network.Id}`);
+}
+
+listAndCreateNetwork();
+```
+
+### Advanced Usage
+
+You can leverage the full potential of the Docker Remote API with `@apiclient.xyz/docker`. This includes managing images, volumes, swarms, and more. The package's design is consistent and intuitive, making it easy to extend your usage as needed.
+
+Remember, the Docker Remote API offers extensive capabilities. Always refer to the [Docker API documentation](https://docs.docker.com/engine/api/latest/) for a comprehensive list of endpoints and actions you can perform.
+
+### Conclusion
+
+`@apiclient.xyz/docker` simplifies interaction with Docker's Remote API in TypeScript projects, providing strong typing and asynchronous operations. Whether you're managing containers, images, services or networks, it offers a comprehensive toolset to perform these tasks seamlessly.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.nonci.node.ts

@@ -1,10 +1,15 @@
 import { expect, tap } from '@push.rocks/tapbundle';
+
+import * as plugins from '../ts/plugins.js';
+import * as paths from '../ts/paths.js';
+
 import * as docker from '../ts/index.js';
 
 let testDockerHost: docker.DockerHost;
 
 tap.test('should create a new Dockersock instance', async () => {
-  testDockerHost = new docker.DockerHost('http://unix:/var/run/docker.sock:');
+  testDockerHost = new docker.DockerHost({});
+  await testDockerHost.start();
   return expect(testDockerHost).toBeInstanceOf(docker.DockerHost);
 });
 
@@ -40,8 +45,10 @@ tap.test('should remove a network', async () => {
 // Images
 tap.test('should pull an image from imagetag', async () => {
   const image = await docker.DockerImage.createFromRegistry(testDockerHost, {
+    creationObject: {
       imageUrl: 'hosttoday/ht-docker-node',
       imageTag: 'alpine',
+    },
   });
   expect(image).toBeInstanceOf(docker.DockerImage);
   console.log(image);
@@ -93,7 +100,9 @@ tap.test('should create a service', async () => {
     contentArg: '{"hi": "wow"}',
   });
   const testImage = await docker.DockerImage.createFromRegistry(testDockerHost, {
-    imageUrl: 'registry.gitlab.com/hosttoday/ht-docker-static',
+    creationObject: {
+      imageUrl: 'code.foss.global/host.today/ht-docker-node:latest',
+    }
   });
   const testService = await docker.DockerService.createService(testDockerHost, {
     image: testImage,
@@ -110,4 +119,38 @@ tap.test('should create a service', async () => {
   await testSecret.remove();
 });
 
-tap.start();
+tap.skip.test('should export images', async (toolsArg) => {
+  const done = toolsArg.defer();
+  const testImage = await docker.DockerImage.createFromRegistry(testDockerHost, {
+    creationObject: {
+      imageUrl: 'code.foss.global/host.today/ht-docker-node:latest',
+    }
+  });
+  const fsWriteStream = plugins.smartfile.fsStream.createWriteStream(
+    plugins.path.join(paths.nogitDir, 'testimage.tar')
+  );
+  const exportStream = await testImage.exportToTarStream();
+  exportStream.pipe(fsWriteStream).on('finish', () => {
+    done.resolve();
+  });
+  await done.promise;
+});
+
+tap.skip.test('should import images', async (toolsArg) => {
+  const done = toolsArg.defer();
+  const fsReadStream = plugins.smartfile.fsStream.createReadStream(
+    plugins.path.join(paths.nogitDir, 'testimage.tar')
+  );
+  await docker.DockerImage.createFromTarStream(testDockerHost, {
+    tarStream: fsReadStream,
+    creationObject: {
+      imageUrl: 'code.foss.global/host.today/ht-docker-node:latest',
+    }
+  })
+});
+
+tap.test('should expose a working DockerImageStore', async () => {
+  await testDockerHost.imageStore.storeImage('hello', plugins.smartfile.fsStream.createReadStream(plugins.path.join(paths.nogitDir, 'testimage.tar')));
+})
+
+export default tap.start();

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@apiclient.xyz/docker',
-  version: '1.0.106',
-  description: 'easy communication with docker remote api from node, TypeScript ready'
+  version: '1.2.0',
+  description: 'Provides easy communication with Docker remote API from Node.js, with TypeScript support.'
 }

ts/classes.container.ts

@@ -1,8 +1,8 @@
-import * as plugins from './docker.plugins.js';
+import * as plugins from './plugins.js';
 import * as interfaces from './interfaces/index.js';
 
-import { DockerHost } from './docker.classes.host.js';
-import { logger } from './docker.logging.js';
+import { DockerHost } from './classes.host.js';
+import { logger } from './logger.js';
 
 export class DockerContainer {
   // STATIC

ts/classes.host.ts

@@ -1,8 +1,12 @@
-import * as plugins from './docker.plugins.js';
-import { DockerContainer } from './docker.classes.container.js';
-import { DockerNetwork } from './docker.classes.network.js';
-import { DockerService } from './docker.classes.service.js';
-import { logger } from './docker.logging.js';
+import * as plugins from './plugins.js';
+import * as paths from './paths.js';
+import { DockerContainer } from './classes.container.js';
+import { DockerNetwork } from './classes.network.js';
+import { DockerService } from './classes.service.js';
+import { logger } from './logger.js';
+import path from 'path';
+import { DockerImageStore } from './classes.imagestore.js';
+import { DockerImage } from './classes.image.js';
 
 export interface IAuthData {
   serveraddress: string;
@@ -10,27 +14,61 @@ export interface IAuthData {
   password: string;
 }
 
+export interface IDockerHostConstructorOptions {
+  dockerSockPath?: string;
+  imageStoreDir?: string;
+}
+
 export class DockerHost {
+  public options: IDockerHostConstructorOptions;
+
   /**
    * the path where the docker sock can be found
    */
   public socketPath: string;
   private registryToken: string = '';
+  public imageStore: DockerImageStore;
 
   /**
    * the constructor to instantiate a new docker sock instance
    * @param pathArg
    */
-  constructor(pathArg?: string) {
+  constructor(optionsArg: IDockerHostConstructorOptions) {
+    this.options = {
+      ...{
+        imageStoreDir: plugins.path.join(paths.nogitDir, 'temp-docker-image-store'),
+      },
+      ...optionsArg,
+    }
     let pathToUse: string;
-    if (pathArg) {
-      pathToUse = pathArg;
+    if (optionsArg.dockerSockPath) {
+      pathToUse = optionsArg.dockerSockPath;
+    } else if (process.env.DOCKER_HOST) {
+      pathToUse = process.env.DOCKER_HOST;
     } else if (process.env.CI) {
       pathToUse = 'http://docker:2375/';
     } else {
       pathToUse = 'http://unix:/var/run/docker.sock:';
     }
+    if (pathToUse.startsWith('unix:///')) {
+      pathToUse = pathToUse.replace('unix://', 'http://unix:');
+    }
+    if (pathToUse.endsWith('.sock')) {
+      pathToUse = pathToUse.replace('.sock', '.sock:');
+    }
+    console.log(`using docker sock at ${pathToUse}`);
     this.socketPath = pathToUse;
+    this.imageStore = new DockerImageStore(this, {
+      bucketDir: null,
+      localDirPath: this.options.imageStoreDir,
+    })
+  }
+
+  public async start() {
+    await this.imageStore.start();
+  }
+  public async stop() {
+    await this.imageStore.stop();
   }
 
   /**
@@ -51,19 +89,22 @@ export class DockerHost {
   /**
    * gets the token from the .docker/config.json file for GitLab registry
    */
-  public async getGitlabComTokenFromDockerConfig() {
+  public async getAuthTokenFromDockerConfig(registryUrlArg: string) {
     const dockerConfigPath = plugins.smartpath.get.home('~/.docker/config.json');
     const configObject = plugins.smartfile.fs.toObjectSync(dockerConfigPath);
-    const gitlabAuthBase64 = configObject.auths['registry.gitlab.com'].auth;
+    const gitlabAuthBase64 = configObject.auths[registryUrlArg].auth;
     const gitlabAuth: string = plugins.smartstring.base64.decode(gitlabAuthBase64);
     const gitlabAuthArray = gitlabAuth.split(':');
     await this.auth({
       username: gitlabAuthArray[0],
       password: gitlabAuthArray[1],
-      serveraddress: 'registry.gitlab.com',
+      serveraddress: registryUrlArg,
     });
   }
 
+  // ==============
+  // NETWORKS
+  // ==============
   /**
    * gets all networks
    */
@@ -72,9 +113,23 @@ export class DockerHost {
   }
 
   /**
-   *
+   * create a network
    */
+  public async createNetwork(optionsArg: Parameters<typeof DockerNetwork.createNetwork>[1]) {
+    return await DockerNetwork.createNetwork(this, optionsArg);
+  }
 
+  /**
+   * get a network by name
+   */
+  public async getNetworkByName(networkNameArg: string) {
+    return await DockerNetwork.getNetworkByName(this, networkNameArg);
+  }
+
+
+  // ==============
+  // CONTAINERS
+  // ==============
   /**
    * gets all containers
    */
@@ -83,6 +138,10 @@ export class DockerHost {
     return containerArray;
   }
 
+  // ==============
+  // SERVICES
+  // ==============
+
   /**
    * gets all services
    */
@@ -91,6 +150,24 @@ export class DockerHost {
     return serviceArray;
   }
 
+  // ==============
+  // IMAGES
+  // ==============
+
+  /**
+   * get all images
+   */
+  public async getImages() {
+    return await DockerImage.getImages(this);
+  }
+
+  /**
+   * get an image by name
+   */
+  public async getImageByName(imageNameArg: string) {
+    return await DockerImage.getImageByName(this, imageNameArg);
+  }
+
   /**
    *
    */
@@ -164,7 +241,7 @@ export class DockerHost {
     return response;
   }
 
-  public async requestStreaming(methodArg: string, routeArg: string, dataArg = {}) {
+  public async requestStreaming(methodArg: string, routeArg: string, readStream?: plugins.smartstream.stream.Readable) {
     const requestUrl = `${this.socketPath}${routeArg}`;
     const response = await plugins.smartrequest.request(
       requestUrl,
@@ -178,7 +255,20 @@ export class DockerHost {
         requestBody: null,
         keepAlive: false,
       },
-      true
+      true,
+      (readStream ? reqArg => {
+        let counter = 0;
+        const smartduplex = new plugins.smartstream.SmartDuplex({
+          writeFunction: async (chunkArg) => {
+            if (counter % 1000 === 0) {
+              console.log(`posting chunk ${counter}`);
+            }
+            counter++;
+            return chunkArg;
+          }
+        });
+        readStream.pipe(smartduplex).pipe(reqArg);
+      } : null),
     );
     console.log(response.statusCode);
     console.log(response.body);

ts/classes.image.ts

@@ -1,8 +1,11 @@
-import * as plugins from './docker.plugins.js';
+import * as plugins from './plugins.js';
 import * as interfaces from './interfaces/index.js';
-import { DockerHost } from './docker.classes.host.js';
-import { logger } from './docker.logging.js';
+import { DockerHost } from './classes.host.js';
+import { logger } from './logger.js';
 
+/**
+ * represents a docker image on the remote docker host
+ */
 export class DockerImage {
   // STATIC
   public static async getImages(dockerHost: DockerHost) {
@@ -14,7 +17,7 @@ export class DockerImage {
     return images;
   }
 
-  public static async findImageByName(dockerHost: DockerHost, imageNameArg: string) {
+  public static async getImageByName(dockerHost: DockerHost, imageNameArg: string) {
     const images = await this.getImages(dockerHost);
     const result = images.find((image) => {
       if (image.RepoTags) {
@@ -28,7 +31,9 @@ export class DockerImage {
 
   public static async createFromRegistry(
     dockerHostArg: DockerHost,
+    optionsArg: {
       creationObject: interfaces.IImageCreationDescriptor
+    }
   ): Promise<DockerImage> {
     // lets create a sanatized imageUrlObject
     const imageUrlObject: {
@@ -36,8 +41,8 @@ export class DockerImage {
       imageTag: string;
       imageOriginTag: string;
     } = {
-      imageUrl: creationObject.imageUrl,
-      imageTag: creationObject.imageTag,
+      imageUrl: optionsArg.creationObject.imageUrl,
+      imageTag: optionsArg.creationObject.imageTag,
       imageOriginTag: null,
     };
     if (imageUrlObject.imageUrl.includes(':')) {
@@ -65,13 +70,26 @@ export class DockerImage {
     );
     if (response.statusCode < 300) {
       logger.log('info', `Successfully pulled image ${imageUrlObject.imageUrl} from the registry`);
-      const image = await DockerImage.findImageByName(dockerHostArg, imageUrlObject.imageOriginTag);
+      const image = await DockerImage.getImageByName(dockerHostArg, imageUrlObject.imageOriginTag);
       return image;
     } else {
       logger.log('error', `Failed at the attempt of creating a new image`);
     }
   }
 
+  /**
+   * 
+   * @param dockerHostArg
+   * @param tarStreamArg
+   */
+  public static async createFromTarStream(dockerHostArg: DockerHost, optionsArg: {
+    creationObject: interfaces.IImageCreationDescriptor,
+    tarStream: plugins.smartstream.stream.Readable,
+  }) {
+    const response = await dockerHostArg.requestStreaming('POST', '/images/load', optionsArg.tarStream);
+    return response;
+  }
+
   public static async tagImageByIdOrName(
     dockerHost: DockerHost,
     idOrNameArg: string,
@@ -126,7 +144,9 @@ export class DockerImage {
    */
   public async pullLatestImageFromRegistry(): Promise<boolean> {
     const updatedImage = await DockerImage.createFromRegistry(this.dockerHost, {
+      creationObject: {
         imageUrl: this.RepoTags[0],
+      },
     });
     Object.assign(this, updatedImage);
     // TODO: Compare image digists before and after
@@ -141,4 +161,33 @@ export class DockerImage {
       return '0.0.0';
     }
   }
+
+  /**
+   * exports an image to a tar ball
+   */
+  public async exportToTarStream(): Promise<plugins.smartstream.stream.Readable> {
+    console.log(`Exporting image ${this.RepoTags[0]} to tar stream.`);
+    const response = await this.dockerHost.requestStreaming('GET', `/images/${encodeURIComponent(this.RepoTags[0])}/get`);
+    let counter = 0;
+    const webduplexStream = new plugins.smartstream.SmartDuplex({
+      writeFunction: async (chunk, tools) => {
+        if (counter % 1000 === 0)
+          console.log(`Got chunk: ${counter}`);
+        counter++;
+        return chunk;
+      }
+    });
+    response.on('data', (chunk) => {
+      if (!webduplexStream.write(chunk)) {
+        response.pause();
+        webduplexStream.once('drain', () => {
+          response.resume();
+        })
+      };
+    });
+    response.on('end', () => {
+      webduplexStream.end();
+    })
+    return webduplexStream;
+  }
 }

ts/classes.imagestore.ts

@@ -0,0 +1,108 @@
+import * as plugins from './plugins.js';
+import * as paths from './paths.js';
+import { logger } from './logger.js';
+import type { DockerHost } from './classes.host.js';
+
+export interface IDockerImageStoreConstructorOptions {
+  /**
+   * used for preparing images for longer term storage
+   */
+  localDirPath: string;
+  /**
+   * a smartbucket dir for longer term storage.
+   */
+  bucketDir: plugins.smartbucket.Directory;
+}
+
+export class DockerImageStore {
+  public options: IDockerImageStoreConstructorOptions;
+
+  constructor(dockerHost: DockerHost, optionsArg: IDockerImageStoreConstructorOptions) {
+    this.options = optionsArg;
+  }
+
+  // Method to store tar stream
+  public async storeImage(imageName: string, tarStream: plugins.smartstream.stream.Readable): Promise<void> {
+    logger.log('info', `Storing image ${imageName}...`);
+    const uniqueProcessingId = plugins.smartunique.shortId();
+
+    const initialTarDownloadPath = plugins.path.join(this.options.localDirPath, `${uniqueProcessingId}.tar`);
+    const extractionDir = plugins.path.join(this.options.localDirPath, uniqueProcessingId);
+    // Create a write stream to store the tar file
+    const writeStream = plugins.smartfile.fsStream.createWriteStream(initialTarDownloadPath);
+
+    // lets wait for the write stream to finish
+    await new Promise((resolve, reject) => {
+      tarStream.pipe(writeStream);
+      writeStream.on('finish', resolve);
+      writeStream.on('error', reject);
+    });
+    logger.log('info', `Image ${imageName} stored locally for processing. Extracting...`);
+
+    // lets process the image
+    const tarArchive = await plugins.smartarchive.SmartArchive.fromArchiveFile(initialTarDownloadPath);
+    await tarArchive.exportToFs(extractionDir);
+    logger.log('info', `Image ${imageName} extracted.`);
+    await plugins.smartfile.fs.remove(initialTarDownloadPath);
+    logger.log('info', `deleted original tar to save space.`);
+    logger.log('info', `now repackaging for s3...`);
+    const smartfileIndexJson = await plugins.smartfile.SmartFile.fromFilePath(plugins.path.join(extractionDir, 'index.json'));
+    const smartfileManifestJson = await plugins.smartfile.SmartFile.fromFilePath(plugins.path.join(extractionDir, 'manifest.json'));
+    const smartfileOciLayoutJson = await plugins.smartfile.SmartFile.fromFilePath(plugins.path.join(extractionDir, 'oci-layout'));
+    const smartfileRepositoriesJson = await plugins.smartfile.SmartFile.fromFilePath(plugins.path.join(extractionDir, 'repositories'));
+    const indexJson = JSON.parse(smartfileIndexJson.contents.toString());
+    const manifestJson = JSON.parse(smartfileManifestJson.contents.toString());
+    const ociLayoutJson = JSON.parse(smartfileOciLayoutJson.contents.toString());
+    const repositoriesJson = JSON.parse(smartfileRepositoriesJson.contents.toString());
+
+    indexJson.manifests[0].annotations['io.containerd.image.name'] = imageName;
+    manifestJson[0].RepoTags[0] = imageName;
+    const repoFirstKey = Object.keys(repositoriesJson)[0];
+    const repoFirstValue = repositoriesJson[repoFirstKey];
+    repositoriesJson[imageName] = repoFirstValue;
+    delete repositoriesJson[repoFirstKey];
+
+    smartfileIndexJson.contents = Buffer.from(JSON.stringify(indexJson, null, 2));
+    smartfileManifestJson.contents = Buffer.from(JSON.stringify(manifestJson, null, 2));
+    smartfileOciLayoutJson.contents = Buffer.from(JSON.stringify(ociLayoutJson, null, 2));
+    smartfileRepositoriesJson.contents = Buffer.from(JSON.stringify(repositoriesJson, null, 2));
+    await Promise.all([
+      smartfileIndexJson.write(),
+      smartfileManifestJson.write(),
+      smartfileOciLayoutJson.write(),
+      smartfileRepositoriesJson.write(),
+    ]);
+
+    logger.log('info', 'repackaging archive for s3...');
+    const tartools = new plugins.smartarchive.TarTools();
+    const newTarPack = await tartools.packDirectory(extractionDir);
+    const finalTarName = `${uniqueProcessingId}.processed.tar`;
+    const finalTarPath = plugins.path.join(this.options.localDirPath, finalTarName);
+    const finalWriteStream = plugins.smartfile.fsStream.createWriteStream(finalTarPath);
+    await new Promise((resolve, reject) => {
+      newTarPack.finalize();
+      newTarPack.pipe(finalWriteStream);
+      finalWriteStream.on('finish', resolve);
+      finalWriteStream.on('error', reject);
+    });
+    logger.log('ok', `Repackaged image ${imageName} for s3.`);
+    await plugins.smartfile.fs.remove(extractionDir);
+  }
+
+  public async start() {
+    await plugins.smartfile.fs.ensureEmptyDir(this.options.localDirPath);
+  }
+
+  public async stop() {}
+
+  // Method to retrieve tar stream
+  public async getImage(imageName: string): Promise<plugins.smartstream.stream.Readable> {
+    const imagePath = plugins.path.join(this.options.localDirPath, `${imageName}.tar`);
+
+    if (!(await plugins.smartfile.fs.fileExists(imagePath))) {
+      throw new Error(`Image ${imageName} does not exist.`);
+    }
+
+    return plugins.smartfile.fsStream.createReadStream(imagePath);
+  }
+}

ts/classes.network.ts

@@ -1,9 +1,9 @@
-import * as plugins from './docker.plugins.js';
+import * as plugins from './plugins.js';
 import * as interfaces from './interfaces/index.js';
 
-import { DockerHost } from './docker.classes.host.js';
-import { DockerService } from './docker.classes.service.js';
-import { logger } from './docker.logging.js';
+import { DockerHost } from './classes.host.js';
+import { DockerService } from './classes.service.js';
+import { logger } from './logger.js';
 
 export class DockerNetwork {
   public static async getNetworks(dockerHost: DockerHost): Promise<DockerNetwork[]> {

ts/classes.secret.ts

@@ -1,5 +1,5 @@
-import * as plugins from './docker.plugins.js';
-import { DockerHost } from './docker.classes.host.js';
+import * as plugins from './plugins.js';
+import { DockerHost } from './classes.host.js';
 
 // interfaces
 import * as interfaces from './interfaces/index.js';

ts/classes.service.ts

@@ -1,10 +1,10 @@
-import * as plugins from './docker.plugins.js';
+import * as plugins from './plugins.js';
 import * as interfaces from './interfaces/index.js';
 
-import { DockerHost } from './docker.classes.host.js';
-import { DockerImage } from './docker.classes.image.js';
-import { DockerSecret } from './docker.classes.secret.js';
-import { logger } from './docker.logging.js';
+import { DockerHost } from './classes.host.js';
+import { DockerImage } from './classes.image.js';
+import { DockerSecret } from './classes.secret.js';
+import { logger } from './logger.js';
 
 export class DockerService {
   // STATIC
@@ -232,7 +232,9 @@ export class DockerService {
 
     await this.reReadFromDockerEngine();
     const dockerImage = await DockerImage.createFromRegistry(this.dockerHostRef, {
+      creationObject: {
         imageUrl: this.Spec.TaskTemplate.ContainerSpec.Image,
+      }
     });
 
     const imageVersion = new plugins.smartversion.SmartVersion(dockerImage.Labels.version);

ts/docker.logging.ts

@@ -1,3 +0,0 @@
-import * as plugins from './docker.plugins.js';
-
-export const logger = new plugins.smartlog.ConsoleLog();

ts/index.ts

@@ -1,6 +1,7 @@
-export * from './docker.classes.host.js';
-export * from './docker.classes.container.js';
-export * from './docker.classes.image.js';
-export * from './docker.classes.network.js';
-export * from './docker.classes.secret.js';
-export * from './docker.classes.service.js';
+export * from './classes.host.js';
+export * from './classes.container.js';
+export * from './classes.image.js';
+export * from './classes.imagestore.js';
+export * from './classes.network.js';
+export * from './classes.secret.js';
+export * from './classes.service.js';

ts/interfaces/container.ts

@@ -1,4 +1,4 @@
-import { DockerNetwork } from '../docker.classes.network.js';
+import { DockerNetwork } from '../classes.network.js';
 
 export interface IContainerCreationDescriptor {
   Hostname: string;

ts/interfaces/service.ts

@@ -1,9 +1,9 @@
-import * as plugins from '../docker.plugins.js';
+import * as plugins from '../plugins.js';
 
 import * as interfaces from './index.js';
-import { DockerNetwork } from '../docker.classes.network.js';
-import { DockerSecret } from '../docker.classes.secret.js';
-import { DockerImage } from '../docker.classes.image.js';
+import { DockerNetwork } from '../classes.network.js';
+import { DockerSecret } from '../classes.secret.js';
+import { DockerImage } from '../classes.image.js';
 
 export interface IServiceCreationDescriptor {
   name: string;

ts/logger.ts

@@ -0,0 +1,5 @@
+import * as plugins from './plugins.js';
+import { commitinfo } from './00_commitinfo_data.js';
+
+export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo);
+logger.enableConsole();

ts/paths.ts

@@ -0,0 +1,9 @@
+import * as plugins from './plugins.js';
+
+export const packageDir = plugins.path.resolve(
+  plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
+  '../'
+);
+
+export const nogitDir = plugins.path.resolve(packageDir, '.nogit/');
+plugins.smartfile.fs.ensureDir(nogitDir);

ts/plugins.ts

@@ -5,6 +5,8 @@ export { path };
 
 // @pushrocks scope
 import * as lik from '@push.rocks/lik';
+import * as smartarchive from '@push.rocks/smartarchive';
+import * as smartbucket from '@push.rocks/smartbucket';
 import * as smartfile from '@push.rocks/smartfile';
 import * as smartjson from '@push.rocks/smartjson';
 import * as smartlog from '@push.rocks/smartlog';
@@ -13,10 +15,14 @@ import * as smartpath from '@push.rocks/smartpath';
 import * as smartpromise from '@push.rocks/smartpromise';
 import * as smartrequest from '@push.rocks/smartrequest';
 import * as smartstring from '@push.rocks/smartstring';
+import * as smartstream from '@push.rocks/smartstream';
+import * as smartunique from '@push.rocks/smartunique';
 import * as smartversion from '@push.rocks/smartversion';
 
 export {
   lik,
+  smartarchive,
+  smartbucket,
   smartfile,
   smartjson,
   smartlog,
@@ -25,6 +31,8 @@ export {
   smartpromise,
   smartrequest,
   smartstring,
+  smartstream,
+  smartunique,
   smartversion,
 };