1.0.22

.gitlab-ci.yml

@@ -19,23 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+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=moderate
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartnpm",
-  "version": "1.0.15",
+  "version": "1.0.22",
   "private": false,
   "description": "interface with npm to retrieve package information",
   "main": "dist_ts/index.js",
@@ -9,23 +9,23 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.22",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.2.1",
-    "@types/node": "^13.9.1",
-    "tslint": "^6.1.0",
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tstest": "^1.0.52",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "@types/node": "^14.14.41",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
     "@pushrocks/consolecolor": "^2.0.1",
-    "@pushrocks/smartarchive": "^1.0.12",
-    "@pushrocks/smartfile": "^7.0.11",
-    "@pushrocks/smartlog": "^2.0.21",
-    "@pushrocks/smartrequest": "^1.1.47",
+    "@pushrocks/smartarchive": "^2.0.4",
+    "@pushrocks/smartfile": "^8.0.9",
+    "@pushrocks/smartpromise": "^3.1.3",
+    "@pushrocks/smartrequest": "^1.1.51",
     "package-json": "^6.5.0"
   },
   "files": [
@@ -39,5 +39,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,25 +8,25 @@ interface with npm to retrieve package information
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartnpm/)
 
 ## Status for master
-[![pipeline status](https://gitlab.com/pushrocks/smartnpm/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartnpm/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartnpm/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartnpm/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartnpm.svg)](https://www.npmjs.com/package/@pushrocks/smartnpm)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartnpm/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartnpm)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartnpm/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartnpm/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartnpm)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartnpm)](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/smartnpm)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartnpm)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartnpm)](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.
 
-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). :)

test/test.ts

@@ -17,7 +17,7 @@ tap.test('should create valid instances', async () => {
 
 tap.test('should produce a valid search string and this return npmts', async () => {
   const packages = await npmRegistry.searchOnNpm({
-    name: '@pushrocks/smartupdate'
+    name: '@pushrocks/smartupdate',
   });
   expect(packages[0].name).to.equal('@pushrocks/smartupdate');
 });
@@ -25,7 +25,7 @@ tap.test('should produce a valid search string and this return npmts', async ()
 // lets test things with the verdaccio registry
 tap.test('should create a verdaccio registry', async () => {
   verdaccioRegistry = new NpmRegistry({
-    npmRegistryUrl: 'https://verdaccio.lossless.one'
+    npmRegistryUrl: 'https://verdaccio.lossless.one',
   });
   expect(verdaccioRegistry).to.be.instanceOf(smartnpm.NpmRegistry);
 });
@@ -39,8 +39,9 @@ tap.test('should get package from verdaccio', async () => {
 tap.test('should get a specific file from a package', async () => {
   const bundleFile = await verdaccioRegistry.getFileFromPackage(
     '@pushrocks/websetup',
-    'dist_bundle/bundle.js'
+    'ts/index.ts'
   );
+  console.log(bundleFile.contentBuffer.toString());
 });
 
 tap.start();

ts/smartnpm.classes.npmpackage.ts

@@ -48,9 +48,9 @@ export class NpmPackage {
   } = null;
   public searchScore: number = null;
 
-  public npmRegistry: NpmRegistry;
+  public npmRegistryRef: NpmRegistry;
   constructor(npmRegistryArg: NpmRegistry) {
-    this.npmRegistry = npmRegistryArg;
+    this.npmRegistryRef = npmRegistryArg;
   }
 
   /**
@@ -58,6 +58,38 @@ export class NpmPackage {
    */
   public async saveToDisk(targetDir: string) {
     const smartarchiveInstance = new plugins.smartarchive.SmartArchive();
-    await smartarchiveInstance.extractArchiveFromUrl(this.dist.tarball, targetDir);
+    await smartarchiveInstance.extractArchiveFromUrlToFs(this.dist.tarball, targetDir);
+  }
+
+  /**
+   * saves the package to memory
+   */
+  public async saveToMemory() {}
+
+  /**
+   * get file from package
+   */
+  public async getFileFromPackage(filePath: string): Promise<plugins.smartfile.Smartfile> {
+    const done = plugins.smartpromise.defer<plugins.smartfile.Smartfile>();
+    const smartarchiveInstance = new plugins.smartarchive.SmartArchive();
+    const fileObservable = await smartarchiveInstance.extractArchiveFromUrlToObservable(
+      this.dist.tarball
+    );
+    const wantedFilePath = plugins.path.join('package', filePath);
+    const subscription = fileObservable.subscribe(
+      (fileArg) => {
+        if (fileArg.path === wantedFilePath) {
+          done.resolve(fileArg);
+          subscription.unsubscribe();
+        }
+      },
+      (err) => {
+        console.log(err);
+      },
+      () => {
+        subscription.unsubscribe();
+      }
+    );
+    return done.promise;
   }
 }

ts/smartnpm.classes.npmregistry.ts

@@ -18,11 +18,11 @@ export class NpmRegistry {
 
   constructor(optionsArg: INpmRegistryConstructorOptions = {}) {
     const defaultOptions: INpmRegistryConstructorOptions = {
-      npmRegistryUrl: 'https://registry.npmjs.org'
+      npmRegistryUrl: 'https://registry.npmjs.org',
     };
     this.options = {
       ...defaultOptions,
-      ...optionsArg
+      ...optionsArg,
     };
   }
 
@@ -33,7 +33,7 @@ export class NpmRegistry {
   public async getPackageInfo(packageName: string): Promise<NpmPackage> {
     const fullMetadata = await plugins.packageJson(packageName, {
       registryUrl: this.options.npmRegistryUrl,
-      fullMetadata: true
+      fullMetadata: true,
     });
     const npmPackage = await NpmPackage.createFromFullMetadata(this, fullMetadata);
     return npmPackage;
@@ -45,6 +45,7 @@ export class NpmRegistry {
    * @param targetDir
    */
   public async savePackageToDisk(packageName: string, targetDir: string): Promise<void> {
+    plugins.smartfile.fs.ensureDirSync(paths.nogitDir);
     const npmPackage = await this.getPackageInfo(packageName);
     await npmPackage.saveToDisk(targetDir);
   }
@@ -52,15 +53,18 @@ export class NpmRegistry {
   /**
    * gets a file from a package as Smartfile
    */
-  public async getFileFromPackage(packageName: string, filePath: string) {
-    const baseDir = plugins.path.join(paths.nogitDir, packageName.replace('/', '__'));
+  public async getFileFromPackage(packageNameArg: string, filePath: string): Promise<plugins.smartfile.Smartfile> {
+    const npmPackage = await this.getPackageInfo(packageNameArg);
+    return npmPackage.getFileFromPackage(filePath);
+  }
+
+  public async getPackageAsSmartfileVirtualDir(packageNameArg: string): Promise<plugins.smartfile.VirtualDirectory> {
+    const baseDir = plugins.path.join(paths.nogitDir, packageNameArg.replace('/', '__'));
     await plugins.smartfile.fs.ensureDir(baseDir);
-    await this.savePackageToDisk(packageName, baseDir);
-    const smartfile = await plugins.smartfile.Smartfile.fromFilePath(
-      plugins.path.join(baseDir, 'package', filePath)
-    );
+    await this.savePackageToDisk(packageNameArg, baseDir);
+    const virtualDir = await plugins.smartfile.VirtualDirectory.fromFsDirPath(baseDir);
     await plugins.smartfile.fs.remove(baseDir);
-    return smartfile;
+    return virtualDir;
   }
 
   /**
@@ -134,9 +138,8 @@ export class NpmRegistry {
       addToSearchString(`author:${searchObjectArg.maintenanceWeight}`);
     }
 
-    plugins.smartlog.defaultLogger.log(
-      'info',
-      `Search on npm for ${plugins.consolecolor.coloredString(searchString, 'pink')}`
+    console.log(
+      `info: Search on npm for ${plugins.consolecolor.coloredString(searchString, 'pink')}`
     );
 
     let body: any;

ts/smartnpm.paths.ts

@@ -2,4 +2,3 @@ import * as plugins from './smartnpm.plugins';
 
 export const packageDir = plugins.path.join(__dirname, '../');
 export const nogitDir = plugins.path.join(packageDir, '.nogit/');
-plugins.smartfile.fs.ensureDirSync(nogitDir);

ts/smartnpm.plugins.ts

@@ -7,11 +7,10 @@ export { path };
 import * as consolecolor from '@pushrocks/consolecolor';
 import * as smartarchive from '@pushrocks/smartarchive';
 import * as smartfile from '@pushrocks/smartfile';
-import * as smartlog from '@pushrocks/smartlog';
-smartlog.defaultLogger.enableConsole();
+import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrequest from '@pushrocks/smartrequest';
 
-export { consolecolor, smartarchive, smartfile, smartlog, smartrequest };
+export { consolecolor, smartarchive, smartfile, smartpromise, smartrequest };
 
 // third party scope
 import packageJson from 'package-json';