1.3.0

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitlab-ci.yml

@@ -1,137 +0,0 @@
-# gitzone ci_default
-image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-    - .npmci_cache/
-  key: '$CI_BUILD_STAGE'
-
-stages:
-  - security
-  - test
-  - release
-  - metadata
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-auditProductionDependencies:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install --production --ignore-scripts
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=prod --production
-  tags:
-    - docker
-
-auditDevDependencies:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=dev
-  tags:
-    - docker
-  allow_failure: true
-
-# ====================
-# test stage
-# ====================
-
-testStable:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-testBuild:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci command npm run build
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-release:
-  stage: release
-  script:
-    - npmci node install stable
-    - npmci npm publish
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  allow_failure: true
-  only:
-    - tags
-  script:
-    - npmci command npm install -g tslint typescript
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-  tags:
-    - lossless
-    - docker
-    - priv
-
-trigger:
-  stage: metadata
-  script:
-    - npmci trigger
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-pages:
-  stage: metadata
-  script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command tsdoc
-  tags:
-    - lossless
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-      - public
-  allow_failure: true

.snyk

@@ -1,9 +0,0 @@
-# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.13.5
-# ignores vulnerabilities until expiry date; change duration by modifying expiry date
-ignore:
-  SNYK-JS-HTTPSPROXYAGENT-469131:
-    - '@pushrocks/smartnetwork > speedtest-net > https-proxy-agent':
-        reason: None given
-        expires: '2019-11-04T13:59:28.695Z'
-patch: {}

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

changelog.md

@@ -0,0 +1,164 @@
+# Changelog
+
+## 2024-12-23 - 1.3.0 - feat(core)
+Initial release of Docker client with TypeScript support
+
+- Provides easy communication with Docker's remote API from Node.js
+- Includes implementations for managing Docker services, networks, secrets, containers, and images
+
+## 2024-12-23 - 1.2.8 - fix(core)
+Improved the image creation process from tar stream in DockerImage class.
+
+- Enhanced `DockerImage.createFromTarStream` method to handle streamed response and parse imported image details.
+- Fixed the dependency version for `@push.rocks/smartarchive` in package.json.
+
+## 2024-10-13 - 1.2.7 - fix(core)
+Prepare patch release with minor fixes and improvements
+
+
+## 2024-10-13 - 1.2.6 - fix(core)
+Minor refactoring and code quality improvements.
+
+
+## 2024-10-13 - 1.2.5 - fix(dependencies)
+Update dependencies for stability improvements
+
+- Updated @push.rocks/smartstream to version ^3.0.46
+- Updated @push.rocks/tapbundle to version ^5.3.0
+- Updated @types/node to version 22.7.5
+
+## 2024-10-13 - 1.2.4 - fix(core)
+Refactored DockerImageStore constructor to remove DockerHost dependency
+
+- Adjusted DockerImageStore constructor to remove dependency on DockerHost
+- Updated ts/classes.host.ts to align with DockerImageStore's new constructor signature
+
+## 2024-08-21 - 1.2.3 - fix(dependencies)
+Update dependencies to the latest versions and fix image export test
+
+- Updated several dependencies to their latest versions in package.json.
+- Enabled the previously skipped 'should export images' test.
+
+## 2024-06-10 - 1.2.1-1.2.2 - Core/General
+General updates and fixes.
+
+- Fix core update
+
+## 2024-06-10 - 1.2.0 - Core
+Core updates and bug fixes.
+
+- Fix core update
+
+## 2024-06-08 - 1.2.0 - General/Core
+Major release with core enhancements.
+
+- Processing images with extraction, retagging, repackaging, and long-term storage
+
+## 2024-06-06 - 1.1.4 - General/Imagestore
+Significant feature addition.
+
+- Add feature to process images with extraction, retagging, repackaging, and long-term storage
+
+## 2024-05-08 - 1.0.112 - Images
+Add new functionality for image handling.
+
+- Can now import and export images
+- Start work on local 100% JS OCI image registry
+
+## 2024-06-05 - 1.1.0-1.1.3 - Core
+Regular updates and fixes.
+
+- Fix core update
+
+## 2024-02-02 - 1.0.105-1.0.110 - Core
+Routine core updates and fixes.
+
+- Fix core update
+
+## 2022-10-17 - 1.0.103-1.0.104 - Core
+Routine core updates.
+
+- Fix core update
+
+## 2020-10-01 - 1.0.99-1.0.102 - Core
+Routine core updates.
+
+- Fix core update
+
+## 2019-09-22 - 1.0.73-1.0.78 - Core
+Routine updates and core fixes.
+
+- Fix core update
+
+## 2019-09-13 - 1.0.60-1.0.72 - Core
+Routine updates and core fixes.
+
+- Fix core update
+
+## 2019-08-16 - 1.0.43-1.0.59 - Core
+Routine updates and core fixes.
+
+- Fix core update
+
+## 2019-08-15 - 1.0.37-1.0.42 - Core
+Routine updates and core fixes.
+
+- Fix core update
+
+## 2019-08-14 - 1.0.31-1.0.36 - Core
+Routine updates and core fixes.
+
+- Fix core update
+
+## 2019-01-10 - 1.0.27-1.0.30 - Core
+Routine updates and core fixes.
+
+- Fix core update
+
+## 2018-07-16 - 1.0.23-1.0.24 - Core
+Routine updates and core fixes.
+
+- Fix core shift to new style
+
+## 2017-07-16 - 1.0.20-1.0.22 - General
+Routine updates and fixes.
+
+- Update node_modules within npmdocker
+
+## 2017-04-02 - 1.0.18-1.0.19 - General
+Routine updates and fixes.
+
+- Work with npmdocker and npmts 7.x.x
+- CI updates
+
+## 2016-07-31 - 1.0.17 - General
+Enhancements and fixes.
+
+- Now waiting for response to be stored before ending streaming request
+- Cosmetic fix
+
+## 2016-07-29 - 1.0.14-1.0.16 - General
+Multiple updates and features added.
+
+- Fix request for change observable and add npmdocker
+- Add request typings
+
+## 2016-07-28 - 1.0.13 - Core
+Fixes and preparations.
+
+- Fixed request for newer docker
+- Prepare for npmdocker
+ 
+
+## 2016-06-16 - 1.0.0-1.0.2 - General
+Initial sequence of releases, significant feature additions and CI setups.
+
+- Implement container start and stop
+- Implement list containers and related functions
+- Add tests with in docker environment 
+
+## 2016-04-12 - unknown - Initial Commit
+Initial project setup.
+
+- Initial commit
+

npmextra.json

@@ -15,9 +15,23 @@
       "githost": "gitlab.com",
       "gitscope": "mojoio",
       "gitrepo": "docker",
-      "shortDescription": "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,53 +1,62 @@
 {
-  "name": "@mojoio/docker",
-  "version": "1.0.100",
-  "description": "easy communication with docker remote api from node, TypeScript ready",
+  "name": "@apiclient.xyz/docker",
+  "version": "1.3.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",
+  "type": "module",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/pushrocks/dockersock.git"
+    "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",
   "bugs": {
-    "url": "https://gitlab.com/pushrocks/dockersock/issues"
+    "url": "https://gitlab.com/mojoio/docker/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/dockersock#README",
+  "homepage": "https://gitlab.com/mojoio/docker#readme",
   "dependencies": {
-    "@pushrocks/lik": "^4.0.17",
-    "@pushrocks/smartfile": "^8.0.0",
-    "@pushrocks/smartjson": "^3.0.10",
-    "@pushrocks/smartlog": "^2.0.39",
-    "@pushrocks/smartnetwork": "^1.1.22",
-    "@pushrocks/smartpath": "^4.0.3",
-    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/smartrequest": "^1.1.51",
-    "@pushrocks/smartstring": "^3.0.18",
-    "@pushrocks/smartversion": "^2.0.4",
-    "@tsclass/tsclass": "^3.0.25",
-    "rxjs": "^6.6.3"
+    "@push.rocks/lik": "^6.0.15",
+    "@push.rocks/smartarchive": "^4.0.39",
+    "@push.rocks/smartbucket": "^3.0.22",
+    "@push.rocks/smartfile": "^11.0.21",
+    "@push.rocks/smartjson": "^5.0.20",
+    "@push.rocks/smartlog": "^3.0.7",
+    "@push.rocks/smartnetwork": "^3.0.0",
+    "@push.rocks/smartpath": "^5.0.18",
+    "@push.rocks/smartpromise": "^4.0.4",
+    "@push.rocks/smartrequest": "^2.0.22",
+    "@push.rocks/smartstream": "^3.0.46",
+    "@push.rocks/smartstring": "^4.0.15",
+    "@push.rocks/smartunique": "^3.0.9",
+    "@push.rocks/smartversion": "^3.0.5",
+    "@tsclass/tsclass": "^4.1.2",
+    "rxjs": "^7.5.7"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.48",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^14.11.2",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
+    "@git.zone/tsbuild": "^2.1.84",
+    "@git.zone/tsrun": "^1.2.49",
+    "@git.zone/tstest": "^1.0.90",
+    "@push.rocks/qenv": "^6.0.5",
+    "@push.rocks/tapbundle": "^5.3.0",
+    "@types/node": "22.7.5"
   },
   "files": [
     "ts/**/*",

qenv.yml

@@ -0,0 +1,6 @@
+required:
+  - S3_ENDPOINT
+  - S3_ACCESSKEY
+  - S3_ACCESSSECRET
+  - S3_BUCKET
+  

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.

scripts/testauth.ts

@@ -1,5 +1,5 @@
 import * as docker from '../ts';
-import * as smartstring from '@pushrocks/smartstring';
+import * as smartstring from '@push.rocks/smartstring';
 
 const run  = async () => {
   const dockerHost = new docker.DockerHost();

test/test.nonci.node.ts

@@ -1,17 +1,19 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as docker from '../ts/index';
+import { expect, tap } from '@push.rocks/tapbundle';
+import { Qenv } from '@push.rocks/qenv';
+
+const testQenv = new Qenv('./', './.nogit/');
+
+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;
 
-if (process.env.CI) {
-  tap.test('ci placeholder', async () => {});
-  tap.start();
-  process.exit(0);
-}
-
 tap.test('should create a new Dockersock instance', async () => {
-  testDockerHost = new docker.DockerHost('http://unix:/var/run/docker.sock:');
-  return expect(testDockerHost).to.be.instanceof(docker.DockerHost);
+  testDockerHost = new docker.DockerHost({});
+  await testDockerHost.start();
+  return expect(testDockerHost).toBeInstanceOf(docker.DockerHost);
 });
 
 tap.test('should create a docker swarm', async () => {
@@ -34,8 +36,8 @@ tap.test('should create a network', async () => {
   const newNetwork = await docker.DockerNetwork.createNetwork(testDockerHost, {
     Name: 'webgateway',
   });
-  expect(newNetwork).to.be.instanceOf(docker.DockerNetwork);
-  expect(newNetwork.Name).to.equal('webgateway');
+  expect(newNetwork).toBeInstanceOf(docker.DockerNetwork);
+  expect(newNetwork.Name).toEqual('webgateway');
 });
 
 tap.test('should remove a network', async () => {
@@ -46,10 +48,12 @@ tap.test('should remove a network', async () => {
 // Images
 tap.test('should pull an image from imagetag', async () => {
   const image = await docker.DockerImage.createFromRegistry(testDockerHost, {
-    imageUrl: 'hosttoday/ht-docker-node',
-    imageTag: 'alpine',
+    creationObject: {
+      imageUrl: 'hosttoday/ht-docker-node',
+      imageTag: 'alpine',
+    },
   });
-  expect(image).to.be.instanceOf(docker.DockerImage);
+  expect(image).toBeInstanceOf(docker.DockerImage);
   console.log(image);
 });
 
@@ -99,7 +103,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,
@@ -116,4 +122,48 @@ tap.test('should create a service', async () => {
   await testSecret.remove();
 });
 
-tap.start();
+tap.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.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 () => {
+  // lets first add am s3 target
+  const s3Descriptor = {
+    endpoint: await testQenv.getEnvVarOnDemand('S3_ENDPOINT'),
+    accessKey: await testQenv.getEnvVarOnDemand('S3_ACCESSKEY'),
+    accessSecret: await testQenv.getEnvVarOnDemand('S3_ACCESSSECRET'),
+    bucketName: await testQenv.getEnvVarOnDemand('S3_BUCKET'),
+  };
+  await testDockerHost.addS3Storage(s3Descriptor);
+
+  //
+  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

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @push.rocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@apiclient.xyz/docker',
+  version: '1.3.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';
-import * as interfaces from './interfaces';
+import * as plugins from './plugins.js';
+import * as interfaces from './interfaces/index.js';
 
-import { DockerHost } from './docker.classes.host';
-import { logger } from './docker.logging';
+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';
-import { DockerContainer } from './docker.classes.container';
-import { DockerNetwork } from './docker.classes.network';
-import { DockerService } from './docker.classes.service';
-import { logger } from './docker.logging';
+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,62 @@ 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;
+  public smartBucket: plugins.smartbucket.SmartBucket;
 
   /**
    * 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({
+      bucketDir: null,
+      localDirPath: this.options.imageStoreDir,
+    })
+  }
+
+  public async start() {
+    await this.imageStore.start();
+  }
+  public async stop() {
+    await this.imageStore.stop();
   }
 
   /**
@@ -45,27 +84,28 @@ export class DockerHost {
       throw new Error(response.body.Status);
     }
     console.log(response.body.Status);
-    this.registryToken = plugins.smartstring.base64.encode(
-      plugins.smartjson.Smartjson.stringify(authData, {})
-    );
+    this.registryToken = plugins.smartstring.base64.encode(plugins.smartjson.stringify(authData));
   }
 
   /**
    * 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
    */
@@ -74,9 +114,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
    */
@@ -85,6 +139,10 @@ export class DockerHost {
     return containerArray;
   }
 
+  // ==============
+  // SERVICES
+  // ==============
+
   /**
    * gets all services
    */
@@ -93,6 +151,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);
+  }
+
   /**
    *
    */
@@ -166,7 +242,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,
@@ -180,10 +256,40 @@ 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);
     return response;
   }
+
+  /**
+   * add s3 storage
+   * @param optionsArg
+   */
+  public async addS3Storage(optionsArg: plugins.tsclass.storage.IS3Descriptor) {
+    this.smartBucket = new plugins.smartbucket.SmartBucket(optionsArg);
+    if (!optionsArg.bucketName) {
+      throw new Error('bucketName is required');
+    }
+    const bucket = await this.smartBucket.getBucketByName(optionsArg.bucketName);
+    let wantedDirectory = await bucket.getBaseDirectory();
+    if (optionsArg.directoryPath) {
+      wantedDirectory = await wantedDirectory.getSubDirectoryByName(optionsArg.directoryPath);
+    }
+    this.imageStore.options.bucketDir = wantedDirectory;
+  }
 }

ts/classes.image.ts

@@ -0,0 +1,275 @@
+import * as plugins from './plugins.js';
+import * as interfaces from './interfaces/index.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) {
+    const images: DockerImage[] = [];
+    const response = await dockerHost.request('GET', '/images/json');
+    for (const imageObject of response.body) {
+      images.push(new DockerImage(dockerHost, imageObject));
+    }
+    return images;
+  }
+
+  public static async getImageByName(dockerHost: DockerHost, imageNameArg: string) {
+    const images = await this.getImages(dockerHost);
+    const result = images.find((image) => {
+      if (image.RepoTags) {
+        return image.RepoTags.includes(imageNameArg);
+      } else {
+        return false;
+      }
+    });
+    return result;
+  }
+
+  public static async createFromRegistry(
+    dockerHostArg: DockerHost,
+    optionsArg: {
+      creationObject: interfaces.IImageCreationDescriptor
+    }
+  ): Promise<DockerImage> {
+    // lets create a sanatized imageUrlObject
+    const imageUrlObject: {
+      imageUrl: string;
+      imageTag: string;
+      imageOriginTag: string;
+    } = {
+      imageUrl: optionsArg.creationObject.imageUrl,
+      imageTag: optionsArg.creationObject.imageTag,
+      imageOriginTag: null,
+    };
+    if (imageUrlObject.imageUrl.includes(':')) {
+      const imageUrl = imageUrlObject.imageUrl.split(':')[0];
+      const imageTag = imageUrlObject.imageUrl.split(':')[1];
+      if (imageUrlObject.imageTag) {
+        throw new Error(
+          `imageUrl ${imageUrlObject.imageUrl} can't be tagged with ${imageUrlObject.imageTag} because it is already tagged with ${imageTag}`
+        );
+      } else {
+        imageUrlObject.imageUrl = imageUrl;
+        imageUrlObject.imageTag = imageTag;
+      }
+    } else if (!imageUrlObject.imageTag) {
+      imageUrlObject.imageTag = 'latest';
+    }
+    imageUrlObject.imageOriginTag = `${imageUrlObject.imageUrl}:${imageUrlObject.imageTag}`;
+
+    // lets actually create the image
+    const response = await dockerHostArg.request(
+      'POST',
+      `/images/create?fromImage=${encodeURIComponent(
+        imageUrlObject.imageUrl
+      )}&tag=${encodeURIComponent(imageUrlObject.imageTag)}`
+    );
+    if (response.statusCode < 300) {
+      logger.log('info', `Successfully pulled image ${imageUrlObject.imageUrl} from the registry`);
+      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;
+    }
+  ): Promise<DockerImage> {
+    // Start the request for importing an image
+    const response = await dockerHostArg.requestStreaming(
+      'POST',
+      '/images/load',
+      optionsArg.tarStream
+    );
+
+    /**
+     * Docker typically returns lines like:
+     * {"stream":"Loaded image: myrepo/myimage:latest"}
+     *
+     * So we will collect those lines and parse out the final image name.
+     */
+    let rawOutput = '';
+    response.on('data', (chunk) => {
+      rawOutput += chunk.toString();
+    });
+
+    // Wrap the end event in a Promise for easier async/await usage
+    await new Promise<void>((resolve, reject) => {
+      response.on('end', () => {
+        resolve();
+      });
+      response.on('error', (err) => {
+        reject(err);
+      });
+    });
+
+    // Attempt to parse each line to find something like "Loaded image: ..."
+    let loadedImageTag: string | undefined;
+    const lines = rawOutput.trim().split('\n').filter(Boolean);
+
+    for (const line of lines) {
+      try {
+        const jsonLine = JSON.parse(line);
+        if (
+          jsonLine.stream &&
+          (jsonLine.stream.startsWith('Loaded image:') ||
+            jsonLine.stream.startsWith('Loaded image ID:'))
+        ) {
+          // Examples:
+          // "Loaded image: your-image:latest"
+          // "Loaded image ID: sha256:...."
+          loadedImageTag = jsonLine.stream
+            .replace('Loaded image: ', '')
+            .replace('Loaded image ID: ', '')
+            .trim();
+        }
+      } catch {
+        // not valid JSON, ignore
+      }
+    }
+
+    if (!loadedImageTag) {
+      throw new Error(
+        `Could not parse the loaded image info from Docker response.\nResponse was:\n${rawOutput}`
+      );
+    }
+
+    // Now try to look up that image by the "loadedImageTag".
+    // Depending on Docker’s response, it might be something like:
+    //   "myrepo/myimage:latest"  OR  "sha256:someHash..."
+    // If Docker gave you an ID (e.g. "sha256:..."), you may need a separate
+    // DockerImage.getImageById method; or if you prefer, you can treat it as a name.
+    const newlyImportedImage = await DockerImage.getImageByName(dockerHostArg, loadedImageTag);
+
+    if (!newlyImportedImage) {
+      throw new Error(
+        `Image load succeeded, but no local reference found for "${loadedImageTag}".`
+      );
+    }
+
+    logger.log(
+      'info',
+      `Successfully imported image "${loadedImageTag}".`
+    );
+
+    return newlyImportedImage;
+  }
+
+
+  public static async tagImageByIdOrName(
+    dockerHost: DockerHost,
+    idOrNameArg: string,
+    newTagArg: string
+  ) {
+    const response = await dockerHost.request(
+      'POST',
+      `/images/${encodeURIComponent(idOrNameArg)}/${encodeURIComponent(newTagArg)}`
+    );
+
+
+  }
+
+  public static async buildImage(dockerHostArg: DockerHost, dockerImageTag) {
+    // TODO: implement building an image
+  }
+
+  // INSTANCE
+  // references
+  public dockerHost: DockerHost;
+
+  // properties
+  /**
+   * the tags for an image
+   */
+  public Containers: number;
+  public Created: number;
+  public Id: string;
+  public Labels: interfaces.TLabels;
+  public ParentId: string;
+  public RepoDigests: string[];
+  public RepoTags: string[];
+  public SharedSize: number;
+  public Size: number;
+  public VirtualSize: number;
+
+  constructor(dockerHostArg, dockerImageObjectArg: any) {
+    this.dockerHost = dockerHostArg;
+    Object.keys(dockerImageObjectArg).forEach((keyArg) => {
+      this[keyArg] = dockerImageObjectArg[keyArg];
+    });
+  }
+
+  /**
+   * tag an image
+   * @param newTag
+   */
+  public async tagImage(newTag) {
+    throw new Error('.tagImage is not yet implemented');
+  }
+
+  /**
+   * pulls the latest version from the registry
+   */
+  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
+    return true;
+  }
+
+  // get stuff
+  public async getVersion() {
+    if (this.Labels && this.Labels.version) {
+      return this.Labels.version;
+    } else {
+      return '0.0.0';
+    }
+  }
+
+  /**
+   * exports an image to a tar ball
+   */
+  public async exportToTarStream(): Promise<plugins.smartstream.stream.Readable> {
+    logger.log('info', `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,114 @@
+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(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);
+    const finalTarReadStream = plugins.smartfile.fsStream.createReadStream(finalTarPath);
+    await this.options.bucketDir.fastPutStream({
+      stream: finalTarReadStream,
+      path: `${imageName}.tar`,
+    });
+    await plugins.smartfile.fs.remove(finalTarPath);
+  }
+
+  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';
-import * as interfaces from './interfaces';
+import * as plugins from './plugins.js';
+import * as interfaces from './interfaces/index.js';
 
-import { DockerHost } from './docker.classes.host';
-import { DockerService } from './docker.classes.service';
-import { logger } from './docker.logging';
+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,8 +1,8 @@
-import * as plugins from './docker.plugins';
-import { DockerHost } from './docker.classes.host';
+import * as plugins from './plugins.js';
+import { DockerHost } from './classes.host.js';
 
 // interfaces
-import * as interfaces from './interfaces';
+import * as interfaces from './interfaces/index.js';
 
 export class DockerSecret {
   // STATIC

ts/classes.service.ts

@@ -1,10 +1,10 @@
-import * as plugins from './docker.plugins';
-import * as interfaces from './interfaces';
+import * as plugins from './plugins.js';
+import * as interfaces from './interfaces/index.js';
 
-import { DockerHost } from './docker.classes.host';
-import { DockerImage } from './docker.classes.image';
-import { DockerSecret } from './docker.classes.secret';
-import { logger } from './docker.logging';
+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, {
-      imageUrl: this.Spec.TaskTemplate.ContainerSpec.Image,
+      creationObject: {
+        imageUrl: this.Spec.TaskTemplate.ContainerSpec.Image,
+      }
     });
 
     const imageVersion = new plugins.smartversion.SmartVersion(dockerImage.Labels.version);

ts/docker.classes.image.ts

@@ -1,144 +0,0 @@
-import * as plugins from './docker.plugins';
-import * as interfaces from './interfaces';
-import { DockerHost } from './docker.classes.host';
-import { logger } from './docker.logging';
-
-export class DockerImage {
-  // STATIC
-  public static async getImages(dockerHost: DockerHost) {
-    const images: DockerImage[] = [];
-    const response = await dockerHost.request('GET', '/images/json');
-    for (const imageObject of response.body) {
-      images.push(new DockerImage(dockerHost, imageObject));
-    }
-    return images;
-  }
-
-  public static async findImageByName(dockerHost: DockerHost, imageNameArg: string) {
-    const images = await this.getImages(dockerHost);
-    const result = images.find((image) => {
-      if (image.RepoTags) {
-        return image.RepoTags.includes(imageNameArg);
-      } else {
-        return false;
-      }
-    });
-    return result;
-  }
-
-  public static async createFromRegistry(
-    dockerHostArg: DockerHost,
-    creationObject: interfaces.IImageCreationDescriptor
-  ): Promise<DockerImage> {
-    // lets create a sanatized imageUrlObject
-    const imageUrlObject: {
-      imageUrl: string;
-      imageTag: string;
-      imageOriginTag: string;
-    } = {
-      imageUrl: creationObject.imageUrl,
-      imageTag: creationObject.imageTag,
-      imageOriginTag: null,
-    };
-    if (imageUrlObject.imageUrl.includes(':')) {
-      const imageUrl = imageUrlObject.imageUrl.split(':')[0];
-      const imageTag = imageUrlObject.imageUrl.split(':')[1];
-      if (imageUrlObject.imageTag) {
-        throw new Error(
-          `imageUrl ${imageUrlObject.imageUrl} can't be tagged with ${imageUrlObject.imageTag} because it is already tagged with ${imageTag}`
-        );
-      } else {
-        imageUrlObject.imageUrl = imageUrl;
-        imageUrlObject.imageTag = imageTag;
-      }
-    } else if (!imageUrlObject.imageTag) {
-      imageUrlObject.imageTag = 'latest';
-    }
-    imageUrlObject.imageOriginTag = `${imageUrlObject.imageUrl}:${imageUrlObject.imageTag}`;
-
-    // lets actually create the image
-    const response = await dockerHostArg.request(
-      'POST',
-      `/images/create?fromImage=${encodeURIComponent(
-        imageUrlObject.imageUrl
-      )}&tag=${encodeURIComponent(imageUrlObject.imageTag)}`
-    );
-    if (response.statusCode < 300) {
-      logger.log('info', `Successfully pulled image ${imageUrlObject.imageUrl} from the registry`);
-      const image = await DockerImage.findImageByName(dockerHostArg, imageUrlObject.imageOriginTag);
-      return image;
-    } else {
-      logger.log('error', `Failed at the attempt of creating a new image`);
-    }
-  }
-
-  public static async tagImageByIdOrName(
-    dockerHost: DockerHost,
-    idOrNameArg: string,
-    newTagArg: string
-  ) {
-    const response = await dockerHost.request(
-      'POST',
-      `/images/${encodeURIComponent(idOrNameArg)}/${encodeURIComponent(newTagArg)}`
-    );
-  }
-
-  public static async buildImage(dockerHostArg: DockerHost, dockerImageTag) {
-    // TODO: implement building an image
-  }
-
-  // INSTANCE
-  // references
-  public dockerHost: DockerHost;
-
-  // properties
-  /**
-   * the tags for an image
-   */
-  public Containers: number;
-  public Created: number;
-  public Id: string;
-  public Labels: interfaces.TLabels;
-  public ParentId: string;
-  public RepoDigests: string[];
-  public RepoTags: string[];
-  public SharedSize: number;
-  public Size: number;
-  public VirtualSize: number;
-
-  constructor(dockerHostArg, dockerImageObjectArg: any) {
-    this.dockerHost = dockerHostArg;
-    Object.keys(dockerImageObjectArg).forEach((keyArg) => {
-      this[keyArg] = dockerImageObjectArg[keyArg];
-    });
-  }
-
-  /**
-   * tag an image
-   * @param newTag
-   */
-  public async tagImage(newTag) {
-    throw new Error('.tagImage is not yet implemented');
-  }
-
-  /**
-   * pulls the latest version from the registry
-   */
-  public async pullLatestImageFromRegistry(): Promise<boolean> {
-    const updatedImage = await DockerImage.createFromRegistry(this.dockerHost, {
-      imageUrl: this.RepoTags[0],
-    });
-    Object.assign(this, updatedImage);
-    // TODO: Compare image digists before and after
-    return true;
-  }
-
-  // get stuff
-  public async getVersion() {
-    if (this.Labels && this.Labels.version) {
-      return this.Labels.version;
-    } else {
-      return '0.0.0';
-    }
-  }
-}

ts/docker.logging.ts

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

ts/docker.plugins.ts

@@ -1,39 +0,0 @@
-// node native path
-import * as path from 'path';
-
-export { path };
-
-// @pushrocks scope
-import * as lik from '@pushrocks/lik';
-import * as smartfile from '@pushrocks/smartfile';
-import * as smartjson from '@pushrocks/smartjson';
-import * as smartlog from '@pushrocks/smartlog';
-import * as smartnetwork from '@pushrocks/smartnetwork';
-import * as smartpath from '@pushrocks/smartpath';
-import * as smartpromise from '@pushrocks/smartpromise';
-import * as smartrequest from '@pushrocks/smartrequest';
-import * as smartstring from '@pushrocks/smartstring';
-import * as smartversion from '@pushrocks/smartversion';
-
-export {
-  lik,
-  smartfile,
-  smartjson,
-  smartlog,
-  smartnetwork,
-  smartpath,
-  smartpromise,
-  smartrequest,
-  smartstring,
-  smartversion,
-};
-
-// @tsclass scope
-import * as tsclass from '@tsclass/tsclass';
-
-export { tsclass };
-
-// third party
-import * as rxjs from 'rxjs';
-
-export { rxjs };

ts/index.ts

@@ -1,6 +1,7 @@
-export * from './docker.classes.host';
-export * from './docker.classes.container';
-export * from './docker.classes.image';
-export * from './docker.classes.network';
-export * from './docker.classes.secret';
-export * from './docker.classes.service';
+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';
+import { DockerNetwork } from '../classes.network.js';
 
 export interface IContainerCreationDescriptor {
   Hostname: string;

ts/interfaces/index.ts

@@ -1,7 +1,7 @@
-export * from './container';
-export * from './image';
-export * from './label';
-export * from './network';
-export * from './port';
-export * from './secret';
-export * from './service';
+export * from './container.js';
+export * from './image.js';
+export * from './label.js';
+export * from './network.js';
+export * from './port.js';
+export * from './secret.js';
+export * from './service.js';

ts/interfaces/secret.ts

@@ -1,4 +1,4 @@
-import * as interfaces from './';
+import * as interfaces from './index.js';
 
 export interface ISecretCreationDescriptor {
   name: string;

ts/interfaces/service.ts

@@ -1,9 +1,9 @@
-import * as plugins from '../docker.plugins';
+import * as plugins from '../plugins.js';
 
-import * as interfaces from './';
-import { DockerNetwork } from '../docker.classes.network';
-import { DockerSecret } from '../docker.classes.secret';
-import { DockerImage } from '../docker.classes.image';
+import * as interfaces from './index.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

@@ -0,0 +1,47 @@
+// node native path
+import * as path from 'path';
+
+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';
+import * as smartnetwork from '@push.rocks/smartnetwork';
+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,
+  smartnetwork,
+  smartpath,
+  smartpromise,
+  smartrequest,
+  smartstring,
+  smartstream,
+  smartunique,
+  smartversion,
+};
+
+// @tsclass scope
+import * as tsclass from '@tsclass/tsclass';
+
+export { tsclass };
+
+// third party
+import * as rxjs from 'rxjs';
+
+export { rxjs };

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}