3.0.1

.gitignore

@@ -1,5 +1,20 @@
-.idea/
-ts/*.js
-ts/*.js.map
-node_modules
-test/
+.nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -0,0 +1,137 @@
+# 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

.npmignore

@@ -1,5 +0,0 @@
-.idea/
-ts/*.js
-ts/*.js.map
-node_modules
-test/

.travis.yml

@@ -1,11 +0,0 @@
-language: node_js
-node_js:
-- 4.2.4
-deploy:
-  provider: npm
-  email: npm@lossless.digital
-  api_key:
-    secure: JNfCkELIH8XfYpK6KMwT3p8lT6LWWzpFwTdD1CY6KYKYBL5F3JtaNrVA/5qtXR3QtxQ71pMDuMMTpAUWkcK4/faZn/ZIavsi5b1bXGSwqSez6p70d5Ob4prxvFnjAGUZ0zbfIxhmpMCfFiYLoAYyNAcnlqqKaNI+ARrTFApVuihrpaJj6DyChVY5VbzqIoErDiMYO+BxqPvqzfqabtanCJo2LVgCdZ2RuNMSEUqkn/J9fJoy6+MpgMrNIm/S6e+sCt9VVqVqfxy89SYBc2rmTVaaMlhy6AMbRPVhLqLBn/u4303/5MZlPsAWcyL03GNv3UC1WPaNbA/FNcK3Hxp++p+2hTu/BPes7WWD6/GLilbjt12dRaRlSojlU8BpNd/IzSEnnwFvl68XFoOjaF97lHqoh4W9eeF5Yjd1IcKk2A5ZMS8G/MTblPHDU5AoEKAjTZgf9ntC9iWfEEZYbVuwHcHUONkGfYuTe/nCxRaiCbnUyyEG3I5Gf2+bUyEQSl69pnlhCEDPmD0c+KOz9UPlW833iJ3dQboTcF3TF05nW/YFtLFF5IVgXss+QsBAtuDVj4OJ56b4WJyrFCjr5GgGPI4GjCpDVt8MU1yWRpRycJssKtxAdH5o4WdVPLqIIhf1NJP9xemTaXIQ6EzymxzXKyh9ynp58k+ojUUYb722i7Q=
-  on:
-    tags: true
-    repo: pushrocks/remotezip

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "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"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

dist_ts/index.d.ts

@@ -0,0 +1 @@
+export * from './smartarchive.classes.smartarchive.js';

dist_ts/index.js

@@ -0,0 +1,2 @@
+export * from './smartarchive.classes.smartarchive.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLHdDQUF3QyxDQUFDIn0=

dist_ts/smartarchive.classes.smartarchive.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" resolution-mode="require"/>
+import * as plugins from './smartarchive.plugins.js';
+export declare class SmartArchive {
+    archiveDirectory: string;
+    constructor();
+    /**
+     * extracts an archive from a given url
+     */
+    extractArchiveFromUrlToFs(urlArg: string, targetDir: string): Promise<void>;
+    /**
+     * extracts an archive from a given filePath on disk
+     * @param filePathArg
+     * @param targetDir
+     */
+    extractArchiveFromFilePathToFs(filePathArg: string, targetDir: string): Promise<void>;
+    /**
+     * extracts to Observable
+     */
+    extractArchiveFromBufferToObservable(bufferArg: Buffer): Promise<plugins.smartrx.rxjs.ReplaySubject<plugins.smartfile.Smartfile>>;
+    /**
+     * extracts to Observable
+     */
+    extractArchiveFromUrlToObservable(urlArg: string): Promise<plugins.smartrx.rxjs.ReplaySubject<plugins.smartfile.Smartfile>>;
+}

dist_ts/smartarchive.classes.smartarchive.js

@@ -0,0 +1,84 @@
+import * as plugins from './smartarchive.plugins.js';
+import * as paths from './smartarchive.paths.js';
+import 'tar';
+export class SmartArchive {
+    constructor() { }
+    /**
+     * extracts an archive from a given url
+     */
+    async extractArchiveFromUrlToFs(urlArg, targetDir) {
+        const parsedPath = plugins.path.parse(urlArg);
+        const uniqueFileName = plugins.smartunique.uni() + parsedPath.ext;
+        plugins.smartfile.fs.ensureDir(paths.nogitDir); // TODO: totally remove caching needs
+        const downloadPath = plugins.path.join(paths.nogitDir, uniqueFileName);
+        const downloadedArchive = (await plugins.smartrequest.getBinary(urlArg)).body;
+        await plugins.smartfile.memory.toFs(downloadedArchive, downloadPath);
+        await this.extractArchiveFromFilePathToFs(downloadPath, targetDir);
+        await plugins.smartfile.fs.remove(downloadPath);
+    }
+    /**
+     * extracts an archive from a given filePath on disk
+     * @param filePathArg
+     * @param targetDir
+     */
+    async extractArchiveFromFilePathToFs(filePathArg, targetDir) {
+        const parsedPath = plugins.path.parse(filePathArg);
+        switch (parsedPath.ext) {
+            case '.tgz':
+                console.log(`detected a .tgz archive`);
+                await plugins.tar.extract({
+                    file: filePathArg,
+                    cwd: targetDir,
+                });
+                break;
+        }
+    }
+    /**
+     * extracts to Observable
+     */
+    async extractArchiveFromBufferToObservable(bufferArg) {
+        const intake = new plugins.streamfunction.Intake();
+        const replaySubject = new plugins.smartrx.rxjs.ReplaySubject();
+        const readableStream = intake.getReadableStream();
+        const extractPipeStop = plugins.tarStream.extract();
+        extractPipeStop.on('entry', (header, stream, next) => {
+            let fileBuffer;
+            stream.on('data', (chunkArg) => {
+                if (!fileBuffer) {
+                    fileBuffer = chunkArg;
+                }
+                else {
+                    fileBuffer = Buffer.concat([fileBuffer, chunkArg]);
+                }
+            });
+            stream.on('end', () => {
+                replaySubject.next(new plugins.smartfile.Smartfile({
+                    base: null,
+                    contentBuffer: fileBuffer,
+                    path: `./${header.name}`
+                }));
+                next();
+            });
+            stream.resume();
+        });
+        extractPipeStop.on('finish', () => {
+            replaySubject.complete();
+        });
+        // lets run the stream
+        readableStream
+            .pipe(plugins.gunzipMaybe())
+            .pipe(extractPipeStop);
+        intake.pushData(bufferArg);
+        intake.signalEnd();
+        return replaySubject;
+    }
+    /**
+     * extracts to Observable
+     */
+    async extractArchiveFromUrlToObservable(urlArg) {
+        const response = await plugins.smartrequest.getBinary(urlArg);
+        const replaySubject = this.extractArchiveFromBufferToObservable(response.body);
+        return replaySubject;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhcmNoaXZlLmNsYXNzZXMuc21hcnRhcmNoaXZlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRhcmNoaXZlLmNsYXNzZXMuc21hcnRhcmNoaXZlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sMkJBQTJCLENBQUM7QUFDckQsT0FBTyxLQUFLLEtBQUssTUFBTSx5QkFBeUIsQ0FBQztBQUNqRCxPQUF3QixLQUFLLENBQUM7QUFFOUIsTUFBTSxPQUFPLFlBQVk7SUFFdkIsZ0JBQWUsQ0FBQztJQUVoQjs7T0FFRztJQUNJLEtBQUssQ0FBQyx5QkFBeUIsQ0FBQyxNQUFjLEVBQUUsU0FBaUI7UUFDdEUsTUFBTSxVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDOUMsTUFBTSxjQUFjLEdBQUcsT0FBTyxDQUFDLFdBQVcsQ0FBQyxHQUFHLEVBQUUsR0FBRyxVQUFVLENBQUMsR0FBRyxDQUFDO1FBQ2xFLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxxQ0FBcUM7UUFDckYsTUFBTSxZQUFZLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLFFBQVEsRUFBRSxjQUFjLENBQUMsQ0FBQztRQUN2RSxNQUFNLGlCQUFpQixHQUFHLENBQUMsTUFBTSxPQUFPLENBQUMsWUFBWSxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQztRQUM5RSxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxpQkFBaUIsRUFBRSxZQUFZLENBQUMsQ0FBQztRQUNyRSxNQUFNLElBQUksQ0FBQyw4QkFBOEIsQ0FBQyxZQUFZLEVBQUUsU0FBUyxDQUFDLENBQUM7UUFDbkUsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDbEQsQ0FBQztJQUVEOzs7O09BSUc7SUFDSSxLQUFLLENBQUMsOEJBQThCLENBQUMsV0FBbUIsRUFBRSxTQUFpQjtRQUNoRixNQUFNLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUNuRCxRQUFRLFVBQVUsQ0FBQyxHQUFHLEVBQUU7WUFDdEIsS0FBSyxNQUFNO2dCQUNULE9BQU8sQ0FBQyxHQUFHLENBQUMseUJBQXlCLENBQUMsQ0FBQztnQkFDdkMsTUFBTSxPQUFPLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQztvQkFDeEIsSUFBSSxFQUFFLFdBQVc7b0JBQ2pCLEdBQUcsRUFBRSxTQUFTO2lCQUNmLENBQUMsQ0FBQztnQkFDSCxNQUFNO1NBQ1Q7SUFDSCxDQUFDO0lBRUQ7O09BRUc7SUFDSSxLQUFLLENBQUMsb0NBQW9DLENBQy9DLFNBQWlCO1FBRWpCLE1BQU0sTUFBTSxHQUFHLElBQUksT0FBTyxDQUFDLGNBQWMsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUNuRCxNQUFNLGFBQWEsR0FBRyxJQUFJLE9BQU8sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLGFBQWEsRUFBK0IsQ0FBQztRQUM1RixNQUFNLGNBQWMsR0FBRyxNQUFNLENBQUMsaUJBQWlCLEVBQUUsQ0FBQztRQUNsRCxNQUFNLGVBQWUsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLE9BQU8sRUFBRSxDQUFDO1FBQ3BELGVBQWUsQ0FBQyxFQUFFLENBQUMsT0FBTyxFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxJQUFJLEVBQUUsRUFBRTtZQUNuRCxJQUFJLFVBQWtCLENBQUM7WUFDdkIsTUFBTSxDQUFDLEVBQUUsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUUsRUFBRTtnQkFDN0IsSUFBSSxDQUFDLFVBQVUsRUFBRTtvQkFDZixVQUFVLEdBQUcsUUFBUSxDQUFDO2lCQUN2QjtxQkFBTTtvQkFDTCxVQUFVLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDLFVBQVUsRUFBRSxRQUFRLENBQUMsQ0FBQyxDQUFDO2lCQUNwRDtZQUNILENBQUMsQ0FBQyxDQUFDO1lBQ0gsTUFBTSxDQUFDLEVBQUUsQ0FBQyxLQUFLLEVBQUUsR0FBRyxFQUFFO2dCQUNwQixhQUFhLENBQUMsSUFBSSxDQUNoQixJQUFJLE9BQU8sQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDO29CQUM5QixJQUFJLEVBQUUsSUFBSTtvQkFDVixhQUFhLEVBQUUsVUFBVTtvQkFDekIsSUFBSSxFQUFFLEtBQUssTUFBTSxDQUFDLElBQUksRUFBRTtpQkFDekIsQ0FBQyxDQUNILENBQUM7Z0JBQ0YsSUFBSSxFQUFFLENBQUM7WUFDVCxDQUFDLENBQUMsQ0FBQztZQUNILE1BQU0sQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUNsQixDQUFDLENBQUMsQ0FBQztRQUNILGVBQWUsQ0FBQyxFQUFFLENBQUMsUUFBUSxFQUFFLEdBQUcsRUFBRTtZQUNoQyxhQUFhLENBQUMsUUFBUSxFQUFFLENBQUM7UUFDM0IsQ0FBQyxDQUFDLENBQUM7UUFDSCxzQkFBc0I7UUFDdEIsY0FBYzthQUNYLElBQUksQ0FBQyxPQUFPLENBQUMsV0FBVyxFQUFFLENBQUM7YUFDM0IsSUFBSSxDQUFDLGVBQWUsQ0FBQyxDQUFDO1FBQ3pCLE1BQU0sQ0FBQyxRQUFRLENBQUMsU0FBUyxDQUFDLENBQUM7UUFDM0IsTUFBTSxDQUFDLFNBQVMsRUFBRSxDQUFDO1FBQ25CLE9BQU8sYUFBYSxDQUFDO0lBQ3ZCLENBQUM7SUFFRDs7T0FFRztJQUNLLEtBQUssQ0FBQyxpQ0FBaUMsQ0FDN0MsTUFBYztRQUVkLE1BQU0sUUFBUSxHQUFHLE1BQU0sT0FBTyxDQUFDLFlBQVksQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDOUQsTUFBTSxhQUFhLEdBQUcsSUFBSSxDQUFDLG9DQUFvQyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUMvRSxPQUFPLGFBQWEsQ0FBQztJQUN2QixDQUFDO0NBQ0YifQ==

dist_ts/smartarchive.paths.d.ts

@@ -0,0 +1,2 @@
+export declare const packageDir: string;
+export declare const nogitDir: string;

dist_ts/smartarchive.paths.js

@@ -0,0 +1,4 @@
+import * as plugins from './smartarchive.plugins.js';
+export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../');
+export const nogitDir = plugins.path.join(packageDir, './.nogit');
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhcmNoaXZlLnBhdGhzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRhcmNoaXZlLnBhdGhzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sMkJBQTJCLENBQUM7QUFFckQsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLHdCQUF3QixDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsS0FBSyxDQUFDLENBQUM7QUFDcEgsTUFBTSxDQUFDLE1BQU0sUUFBUSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRSxVQUFVLENBQUMsQ0FBQyJ9

dist_ts/smartarchive.plugins.d.ts

@@ -0,0 +1,13 @@
+import * as path from 'path';
+export { path };
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartpath from '@pushrocks/smartpath';
+import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartunique from '@pushrocks/smartunique';
+import * as streamfunction from '@pushrocks/streamfunction';
+import * as smartrx from '@pushrocks/smartrx';
+export { smartfile, smartpath, smartrequest, smartunique, streamfunction, smartrx };
+import gunzipMaybe from 'gunzip-maybe';
+import tar from 'tar';
+import tarStream from 'tar-stream';
+export { gunzipMaybe, tar, tarStream };

dist_ts/smartarchive.plugins.js

@@ -0,0 +1,18 @@
+// node native scope
+import * as path from 'path';
+export { path };
+// @pushrocks scope
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartpath from '@pushrocks/smartpath';
+import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartunique from '@pushrocks/smartunique';
+import * as streamfunction from '@pushrocks/streamfunction';
+import * as smartrx from '@pushrocks/smartrx';
+export { smartfile, smartpath, smartrequest, smartunique, streamfunction, smartrx };
+// third party scope
+import gunzipMaybe from 'gunzip-maybe';
+// @ts-ignore
+import tar from 'tar';
+import tarStream from 'tar-stream';
+export { gunzipMaybe, tar, tarStream };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhcmNoaXZlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGFyY2hpdmUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxvQkFBb0I7QUFDcEIsT0FBTyxLQUFLLElBQUksTUFBTSxNQUFNLENBQUM7QUFFN0IsT0FBTyxFQUFFLElBQUksRUFBRSxDQUFDO0FBRWhCLG1CQUFtQjtBQUNuQixPQUFPLEtBQUssU0FBUyxNQUFNLHNCQUFzQixDQUFDO0FBQ2xELE9BQU8sS0FBSyxTQUFTLE1BQU0sc0JBQXNCLENBQUM7QUFDbEQsT0FBTyxLQUFLLFlBQVksTUFBTSx5QkFBeUIsQ0FBQztBQUN4RCxPQUFPLEtBQUssV0FBVyxNQUFNLHdCQUF3QixDQUFDO0FBQ3RELE9BQU8sS0FBSyxjQUFjLE1BQU0sMkJBQTJCLENBQUM7QUFDNUQsT0FBTyxLQUFLLE9BQU8sTUFBTSxvQkFBb0IsQ0FBQztBQUU5QyxPQUFPLEVBQUUsU0FBUyxFQUFFLFNBQVMsRUFBRSxZQUFZLEVBQUUsV0FBVyxFQUFFLGNBQWMsRUFBRSxPQUFPLEVBQUUsQ0FBQztBQUVwRixvQkFBb0I7QUFDcEIsT0FBTyxXQUFXLE1BQU0sY0FBYyxDQUFDO0FBRXZDLGFBQWE7QUFDYixPQUFPLEdBQUcsTUFBTSxLQUFLLENBQUM7QUFDdEIsT0FBTyxTQUFTLE1BQU0sWUFBWSxDQUFDO0FBRW5DLE9BQU8sRUFBRSxXQUFXLEVBQUUsR0FBRyxFQUFFLFNBQVMsRUFBRSxDQUFDIn0=

index.d.ts

@@ -1,25 +0,0 @@
-/// <reference path="ts/typings/tsd.d.ts" />
-declare module RemotezipPlugins {
-    var init: () => {
-        beautylog: any;
-        gulp: any;
-        g: {
-            unzip: any;
-            remoteSrc: any;
-        };
-        path: any;
-    };
-}
-declare var plugins: {
-    beautylog: any;
-    gulp: any;
-    g: {
-        unzip: any;
-        remoteSrc: any;
-    };
-    path: any;
-};
-declare var remotezip: (options: {
-    from: string;
-    toPath: string;
-}) => void;

index.js

@@ -1,39 +0,0 @@
-#!/usr/bin/env node
-
-/// <reference path="./index.ts" />
-var RemotezipPlugins;
-(function (RemotezipPlugins) {
-    RemotezipPlugins.init = function () {
-        var plugins = {
-            beautylog: require("beautylog"),
-            gulp: require("gulp"),
-            g: {
-                unzip: require("gulp-unzip"),
-                remoteSrc: require("gulp-remote-src")
-            },
-            path: require("path")
-        };
-        return plugins;
-    };
-})(RemotezipPlugins || (RemotezipPlugins = {}));
-/// <reference path="./typings/tsd.d.ts" />
-/// <reference path="./remotezip.plugins.ts" />
-var plugins = RemotezipPlugins.init();
-var remotezip = function (options) {
-    if (!plugins.path.isAbsolute(options.toPath)) {
-        plugins.beautylog.error("Please supply remotezip with an absolute path");
-        return;
-    }
-    ;
-    plugins.gulp.task('default', function () {
-        plugins.beautylog.log('Now trying to download and extract...');
-        var stream = plugins.g.remoteSrc(["master.zip"], {
-            base: "https://github.com/UmbrellaZone/legaldocs/archive/"
-        })
-            .pipe(plugins.g.unzip())
-            .pipe(plugins.gulp.dest(options.toPath));
-        return stream;
-    });
-    plugins.gulp.start.apply(plugins.gulp, ['default']);
-};
-module.exports = remotezip;

license

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Push.Rocks
+Copyright (c) 2016 Lossless GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

npmextra.json

@@ -0,0 +1,17 @@
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartarchive",
+      "shortDescription": "work with archives",
+      "npmPackagename": "@pushrocks/smartarchive",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,30 +1,58 @@
 {
-  "name": "remotezip",
-  "version": "1.0.0",
-  "description": "work with remote zip files",
-  "main": "index.js",
+  "name": "@pushrocks/smartarchive",
+  "version": "3.0.1",
+  "description": "work with archives",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(npmts)",
-    "testm": "(npm test) && (node test.js)"
+    "test": "(tstest test/ --web)",
+    "build": "tsbuild  --web --allowimplicitany"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/pushrocks/remotezip.git"
+    "url": "git+https://github.com/pushrocks/smartarchive.git"
   },
-  "author": "Lossless Digital UG (haftungsbeschraenkt)",
+  "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/pushrocks/remotezip/issues"
+    "url": "https://github.com/pushrocks/smartarchive/issues"
   },
-  "homepage": "https://github.com/pushrocks/remotezip#readme",
+  "homepage": "https://github.com/pushrocks/smartarchive#readme",
   "dependencies": {
-    "beautylog": "^2.0.2",
-    "gulp": "^3.9.0",
-    "gulp-remote-src": "^0.4.0",
-    "gulp-unzip": "^0.1.3",
-    "remotefile": "0.0.14"
+    "@pushrocks/smartfile": "^9.0.6",
+    "@pushrocks/smartpath": "^5.0.5",
+    "@pushrocks/smartrequest": "^1.1.56",
+    "@pushrocks/smartrx": "^2.0.25",
+    "@pushrocks/smartunique": "^3.0.3",
+    "@pushrocks/streamfunction": "^4.0.1",
+    "@types/gunzip-maybe": "^1.4.0",
+    "@types/tar-stream": "^2.2.2",
+    "gunzip-maybe": "^1.4.2",
+    "tar": "^6.1.11",
+    "tar-stream": "^2.2.0"
   },
   "devDependencies": {
-    "npmts": "1.0.9"
-  }
+    "@gitzone/tsbuild": "^2.1.61",
+    "@gitzone/tstest": "^1.0.70",
+    "@pushrocks/tapbundle": "^5.0.3",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "private": false,
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,56 @@
+# @pushrocks/smartarchive
+work with archives
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartarchive)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartarchive)
+* [github.com (source mirror)](https://github.com/pushrocks/smartarchive)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartarchive/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartarchive/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartarchive/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartarchive)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartarchive)](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/@pushrocks/smartarchive)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartarchive)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartarchive)](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)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+```javascript
+import * as smartarchive from 'smartarchive';
+smartarchive
+  .get({
+    from: 'https://example.com/example.zip',
+    toPath: '/some/local/absolute/path',
+  })
+  .then(/*...*/);
+```
+
+For further information read the linked docs at the top of this README.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+
+## Contribution
+
+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). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test.js

@@ -1,4 +1,10 @@
 /// <reference path="./typings/tsd.d.ts" />
 var remotezip = require("./index.js");
 var path = require("path");
-remotezip({ from: "https://github.com/UmbrellaZone/legaldocs/archive/master.zip", toPath: path.resolve("./test/") });
+remotezip.get({
+    from: "https://github.com/UmbrellaZone/legaldocs/archive/master.zip",
+    toPath: path.resolve("./test/"),
+    cb: function () {
+        console.log("This is a callback");
+    }
+});

test/test.ts

@@ -0,0 +1,96 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as path from 'path';
+import * as smartpath from '@pushrocks/smartpath';
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartrequest from '@pushrocks/smartrequest';
+
+const testPlugins = {
+  path,
+  smartfile,
+  smartrequest,
+};
+
+const testPaths = {
+  nogitDir: testPlugins.path.join(smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../.nogit/'),
+  remoteDir: testPlugins.path.join(smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../.nogit/remote'),
+};
+
+import * as smartarchive from '../ts/index.js';
+
+tap.preTask('should prepare .nogit dir', async () => {
+  await testPlugins.smartfile.fs.ensureDir(testPaths.remoteDir);
+});
+
+tap.preTask('should prepare downloads', async (tools) => {
+  const downloadedFile: Buffer = (
+    await testPlugins.smartrequest.getBinary(
+      'https://verdaccio.lossless.one/@pushrocks%2fwebsetup/-/websetup-2.0.14.tgz'
+    )
+  ).body;
+  await testPlugins.smartfile.memory.toFs(
+    downloadedFile,
+    testPlugins.path.join(testPaths.nogitDir, 'test.tgz')
+  );
+});
+
+tap.test('should extract existing files on disk', async () => {
+  const testSmartarchive = new smartarchive.SmartArchive();
+  await testSmartarchive.extractArchiveFromFilePathToFs(
+    testPlugins.path.join(testPaths.nogitDir, 'test.tgz'),
+    testPlugins.path.join(testPaths.nogitDir)
+  );
+});
+
+tap.test('should download a package from the registry', async () => {
+  const testSmartarchive = new smartarchive.SmartArchive();
+  await testSmartarchive.extractArchiveFromUrlToFs(
+    'https://verdaccio.lossless.one/@pushrocks%2fsmartfile/-/smartfile-7.0.11.tgz',
+    testPaths.remoteDir
+  );
+});
+
+tap.test('should extract a package using tarStream', async (tools) => {
+  const done = tools.defer();
+  const testSmartarchive = new smartarchive.SmartArchive();
+  const testTgzBuffer = (
+    await testPlugins.smartfile.Smartfile.fromFilePath(
+      testPlugins.path.join(testPaths.nogitDir, 'test.tgz')
+    )
+  ).contentBuffer;
+  const extractionFileObservable = await testSmartarchive.extractArchiveFromBufferToObservable(
+    testTgzBuffer
+  );
+  const subscription = extractionFileObservable.subscribe(
+    (file) => {
+      console.log(file.path);
+    },
+    (err) => {
+      console.log(err);
+    },
+    () => {
+      done.resolve();
+    }
+  );
+  await done.promise;
+});
+
+tap.test('should extract a file from url to replaySubject', async (tools) => {
+  const done = tools.defer();
+  const testSmartarchive = new smartarchive.SmartArchive();
+  const extractionFileObservable = await testSmartarchive.extractArchiveFromUrlToObservable(
+    'https://verdaccio.lossless.one/@pushrocks%2fwebsetup/-/websetup-2.0.14.tgz'
+  );
+  const subscription = extractionFileObservable.subscribe((file) => {
+    console.log(file.path);
+  },
+  (err) => {
+    console.log(err);
+  },
+  () => {
+    done.resolve();
+  });
+  await done.promise;
+});
+
+tap.start();

ts/index.ts

@@ -1,26 +1 @@
-/// <reference path="./typings/tsd.d.ts" />
-/// <reference path="./remotezip.plugins.ts" />
-
-var plugins = RemotezipPlugins.init();
-
-var remotezip = function(options:{from:string,toPath:string}){
-
-    if(!plugins.path.isAbsolute(options.toPath)){ //check wether supplied path is absolute
-        plugins.beautylog.error("Please supply remotezip with an absolute path");
-        return;
-    };
-
-    plugins.gulp.task('default',function () {
-        plugins.beautylog.log('Now trying to download and extract...');
-        var stream = plugins.g.remoteSrc(["master.zip"],{
-            base:"https://github.com/UmbrellaZone/legaldocs/archive/"
-        })
-            .pipe(plugins.g.unzip())
-            .pipe(plugins.gulp.dest(options.toPath));
-        return stream;
-    });
-
-    plugins.gulp.start.apply(plugins.gulp, ['default']);
-};
-
-module.exports = remotezip;
+export * from './smartarchive.classes.smartarchive.js';

ts/remotezip.plugins.ts

@@ -1,15 +0,0 @@
-/// <reference path="./index.ts" />
-module RemotezipPlugins {
-    export var init = function() {
-        var plugins = {
-            beautylog: require("beautylog"),
-            gulp: require("gulp"),
-            g:{
-                unzip: require("gulp-unzip"),
-                remoteSrc: require("gulp-remote-src")
-            },
-            path: require("path")
-        };
-        return plugins;
-    }
-}

ts/smartarchive.classes.smartarchive.ts

@@ -0,0 +1,94 @@
+import * as plugins from './smartarchive.plugins.js';
+import * as paths from './smartarchive.paths.js';
+import { extract } from 'tar';
+
+export class SmartArchive {
+  public archiveDirectory: string;
+  constructor() {}
+
+  /**
+   * extracts an archive from a given url
+   */
+  public async extractArchiveFromUrlToFs(urlArg: string, targetDir: string) {
+    const parsedPath = plugins.path.parse(urlArg);
+    const uniqueFileName = plugins.smartunique.uni() + parsedPath.ext;
+    plugins.smartfile.fs.ensureDir(paths.nogitDir); // TODO: totally remove caching needs
+    const downloadPath = plugins.path.join(paths.nogitDir, uniqueFileName);
+    const downloadedArchive = (await plugins.smartrequest.getBinary(urlArg)).body;
+    await plugins.smartfile.memory.toFs(downloadedArchive, downloadPath);
+    await this.extractArchiveFromFilePathToFs(downloadPath, targetDir);
+    await plugins.smartfile.fs.remove(downloadPath);
+  }
+
+  /**
+   * extracts an archive from a given filePath on disk
+   * @param filePathArg
+   * @param targetDir
+   */
+  public async extractArchiveFromFilePathToFs(filePathArg: string, targetDir: string) {
+    const parsedPath = plugins.path.parse(filePathArg);
+    switch (parsedPath.ext) {
+      case '.tgz':
+        console.log(`detected a .tgz archive`);
+        await plugins.tar.extract({
+          file: filePathArg,
+          cwd: targetDir,
+        });
+        break;
+    }
+  }
+
+  /**
+   * extracts to Observable
+   */
+  public async extractArchiveFromBufferToObservable(
+    bufferArg: Buffer
+  ): Promise<plugins.smartrx.rxjs.ReplaySubject<plugins.smartfile.Smartfile>> {
+    const intake = new plugins.streamfunction.Intake();
+    const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<plugins.smartfile.Smartfile>();
+    const readableStream = intake.getReadableStream();
+    const extractPipeStop = plugins.tarStream.extract();
+    extractPipeStop.on('entry', (header, stream, next) => {
+      let fileBuffer: Buffer;
+      stream.on('data', (chunkArg) => {
+        if (!fileBuffer) {
+          fileBuffer = chunkArg;
+        } else {
+          fileBuffer = Buffer.concat([fileBuffer, chunkArg]);
+        }
+      });
+      stream.on('end', () => {
+        replaySubject.next(
+          new plugins.smartfile.Smartfile({
+            base: null, // no working directory for this one
+            contentBuffer: fileBuffer,
+            path: `./${header.name}`
+          })
+        );
+        next();
+      });
+      stream.resume();
+    });
+    extractPipeStop.on('finish', () => {
+      replaySubject.complete();
+    });
+    // lets run the stream
+    readableStream
+      .pipe(plugins.gunzipMaybe())
+      .pipe(extractPipeStop);
+    intake.pushData(bufferArg);
+    intake.signalEnd();
+    return replaySubject;
+  }
+
+  /**
+   * extracts to Observable
+   */
+   public async extractArchiveFromUrlToObservable(
+    urlArg: string
+  ): Promise<plugins.smartrx.rxjs.ReplaySubject<plugins.smartfile.Smartfile>> {
+    const response = await plugins.smartrequest.getBinary(urlArg);
+    const replaySubject = this.extractArchiveFromBufferToObservable(response.body);
+    return replaySubject;
+  }
+}

ts/smartarchive.paths.ts

@@ -0,0 +1,4 @@
+import * as plugins from './smartarchive.plugins.js';
+
+export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../');
+export const nogitDir = plugins.path.join(packageDir, './.nogit');

ts/smartarchive.plugins.ts

@@ -0,0 +1,23 @@
+// node native scope
+import * as path from 'path';
+
+export { path };
+
+// @pushrocks scope
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartpath from '@pushrocks/smartpath';
+import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartunique from '@pushrocks/smartunique';
+import * as streamfunction from '@pushrocks/streamfunction';
+import * as smartrx from '@pushrocks/smartrx';
+
+export { smartfile, smartpath, smartrequest, smartunique, streamfunction, smartrx };
+
+// third party scope
+import gunzipMaybe from 'gunzip-maybe';
+
+// @ts-ignore
+import tar from 'tar';
+import tarStream from 'tar-stream';
+
+export { gunzipMaybe, tar, tarStream };

ts/test.ts

@@ -1,4 +0,0 @@
-/// <reference path="./typings/tsd.d.ts" />
-var remotezip = require("./index.js");
-var path = require("path");
-remotezip({from:"https://github.com/UmbrellaZone/legaldocs/archive/master.zip",toPath:path.resolve("./test/")});

ts/tsd.json

@@ -1,12 +0,0 @@
-{
-  "version": "v4",
-  "repo": "borisyankov/DefinitelyTyped",
-  "ref": "master",
-  "path": "typings",
-  "bundle": "typings/tsd.d.ts",
-  "installed": {
-    "node/node.d.ts": {
-      "commit": "efa0c1196d7280640e624ac1e7fa604502e7bd63"
-    }
-  }
-}

ts/typings/tsd.d.ts

@@ -1 +0,0 @@
-/// <reference path="node/node.d.ts" />

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext"
+  }
+}

tslint.json

@@ -0,0 +1,17 @@
+{
+  "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"
+}