@push.rocks/smartnpm 2.0.3

package/dist_ts/smartnpm.plugins.js

@@ -0,0 +1,18 @@
+// node native modules
+import * as path from 'path';
+export { path };
+// @pushrocks scope
+import * as consolecolor from '@pushrocks/consolecolor';
+import * as levelcache from '@pushrocks/levelcache';
+import * as smartarchive from '@pushrocks/smartarchive';
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartpath from '@pushrocks/smartpath';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartversion from '@pushrocks/smartversion';
+import * as smarttime from '@pushrocks/smarttime';
+export { consolecolor, levelcache, smartarchive, smartfile, smartpath, smartpromise, smartrequest, smartversion, smarttime };
+// third party scope
+import packageJson from 'package-json';
+export { packageJson };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRucG0ucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0bnBtLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsc0JBQXNCO0FBQ3RCLE9BQU8sS0FBSyxJQUFJLE1BQU0sTUFBTSxDQUFDO0FBRTdCLE9BQU8sRUFBRSxJQUFJLEVBQUUsQ0FBQztBQUVoQixtQkFBbUI7QUFDbkIsT0FBTyxLQUFLLFlBQVksTUFBTSx5QkFBeUIsQ0FBQztBQUN4RCxPQUFPLEtBQUssVUFBVSxNQUFNLHVCQUF1QixDQUFDO0FBQ3BELE9BQU8sS0FBSyxZQUFZLE1BQU0seUJBQXlCLENBQUM7QUFDeEQsT0FBTyxLQUFLLFNBQVMsTUFBTSxzQkFBc0IsQ0FBQztBQUNsRCxPQUFPLEtBQUssU0FBUyxNQUFNLHNCQUFzQixDQUFDO0FBQ2xELE9BQU8sS0FBSyxZQUFZLE1BQU0seUJBQXlCLENBQUM7QUFDeEQsT0FBTyxLQUFLLFlBQVksTUFBTSx5QkFBeUIsQ0FBQztBQUN4RCxPQUFPLEtBQUssWUFBWSxNQUFNLHlCQUF5QixDQUFDO0FBQ3hELE9BQU8sS0FBSyxTQUFTLE1BQU0sc0JBQXNCLENBQUM7QUFFbEQsT0FBTyxFQUFFLFlBQVksRUFBRSxVQUFVLEVBQUUsWUFBWSxFQUFFLFNBQVMsRUFBRSxTQUFTLEVBQUUsWUFBWSxFQUFFLFlBQVksRUFBRSxZQUFZLEVBQUUsU0FBUyxFQUFFLENBQUM7QUFFN0gsb0JBQW9CO0FBQ3BCLE9BQU8sV0FBVyxNQUFNLGNBQWMsQ0FBQztBQUV2QyxPQUFPLEVBQUUsV0FBVyxFQUFFLENBQUMifQ==

package/npmextra.json

@@ -0,0 +1,17 @@
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartnpm",
+      "shortDescription": "interface with npm to retrieve package information",
+      "npmPackagename": "@pushrocks/smartnpm",
+      "license": "MIT"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@push.rocks/smartnpm",
+  "version": "2.0.3",
+  "private": false,
+  "description": "interface with npm to retrieve package information",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
+  "author": "Lossless GmbH",
+  "license": "MIT",
+  "scripts": {
+    "test": "(tstest test/)",
+    "build": "(tsbuild --web --allowimplicitany)"
+  },
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.63",
+    "@gitzone/tsrun": "^1.2.35",
+    "@gitzone/tstest": "^1.0.71",
+    "@pushrocks/tapbundle": "^5.0.3",
+    "@types/node": "^17.0.41"
+  },
+  "dependencies": {
+    "@pushrocks/consolecolor": "^2.0.1",
+    "@pushrocks/levelcache": "^3.0.2",
+    "@pushrocks/smartarchive": "^3.0.6",
+    "@pushrocks/smartfile": "^10.0.1",
+    "@pushrocks/smartpath": "^5.0.5",
+    "@pushrocks/smartpromise": "^3.1.7",
+    "@pushrocks/smartrequest": "^1.1.56",
+    "@pushrocks/smarttime": "^3.0.45",
+    "@pushrocks/smartversion": "^3.0.2",
+    "package-json": "^7.0.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
+}

package/readme.md

@@ -0,0 +1,39 @@
+# @pushrocks/smartnpm
+interface with npm to retrieve package information
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartnpm)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartnpm)
+* [github.com (source mirror)](https://github.com/pushrocks/smartnpm)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartnpm/)
+
+## Status for master
+
+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.
+
+## 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)

package/ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartnpm',
+  version: '2.0.3',
+  description: 'interface with npm to retrieve package information'
+}

package/ts/index.ts

@@ -0,0 +1,4 @@
+import * as plugins from './smartnpm.plugins.js';
+
+export * from './smartnpm.classes.npmregistry.js';
+export * from './smartnpm.classes.npmpackage.js';

package/ts/smartnpm.classes.npmpackage.ts

@@ -0,0 +1,187 @@
+import * as plugins from './smartnpm.plugins.js';
+import { NpmRegistry } from './smartnpm.classes.npmregistry.js';
+import { PackageDisttag } from './smartnpm.classes.packagedisttag.js';
+import { PackageVersion, IVersionData } from './smartnpm.classes.packageversion.js';
+
+export class NpmPackage {
+  public static async createFromFullMetadataAndVersionData(
+    npmRegistryArg: NpmRegistry,
+    fullMetadataArg: plugins.packageJson.FullMetadata,
+    versionsDataArg: {
+      name: string;
+      'dist-tags': { [key: string]: string };
+      versions: { [key: string]: IVersionData };
+    }
+  ) {
+    const npmPackage = new NpmPackage(npmRegistryArg);
+    Object.assign(npmPackage, fullMetadataArg);
+    npmPackage.allVersions = [];
+    npmPackage.allDistTags = [];
+    for (const versionArg of Object.keys(versionsDataArg.versions)) {
+      const packageVersion = PackageVersion.createFromVersionData(
+        versionsDataArg.versions[versionArg]
+      );
+      npmPackage.allVersions.push(packageVersion);
+    }
+    for (const distTagArg of Object.keys(versionsDataArg['dist-tags'])) {
+      const packageDistTag = new PackageDisttag(
+        distTagArg,
+        versionsDataArg['dist-tags'][distTagArg]
+      );
+      npmPackage.allDistTags.push(packageDistTag);
+    }
+    return npmPackage;
+  }
+
+  // INSTANCE
+  public name: string = null;
+  public scope: string = null;
+  public version: string = null;
+  public allVersions: PackageVersion[];
+  public allDistTags: PackageDisttag[];
+  public description: string = null;
+  public keywords: string[] = null;
+  public date: string;
+  public license: string;
+  public links: {
+    npm: string;
+    homepage: string;
+    repository: string;
+    bugs: string;
+  };
+  public author: {
+    name: 'Lossless GmbH';
+  };
+  public publisher: {
+    username: 'gitzone';
+    email: 'npm@git.zone';
+  };
+  public maintainers: any = null;
+  public dist: {
+    integrity: string;
+    shasum: string;
+    tarball: string;
+  };
+  public score: {
+    final: number;
+    detail: {
+      quality: number;
+      popularity: number;
+      maintenance: number;
+    };
+  } = null;
+  public searchScore: number = null;
+
+  public npmRegistryRef: NpmRegistry;
+  constructor(npmRegistryArg: NpmRegistry) {
+    this.npmRegistryRef = npmRegistryArg;
+  }
+
+  /**
+   * saves the package to disk
+   */
+  public async saveToDisk(targetDir: string) {
+    const smartarchiveInstance = new plugins.smartarchive.SmartArchive();
+    await smartarchiveInstance.extractArchiveFromUrlToFs(this.dist.tarball, targetDir);
+  }
+
+  /**
+   * saves the complete package to cache
+   */
+  public async saveToCache() {}
+
+  /**
+   * get files from package
+   */
+  public async getFilesFromPackage(
+    filePath: string,
+    optionsArg: {
+      distTag?: string;
+      version?: string;
+    },
+    returnOnFirstArg = false
+  ): Promise<plugins.smartfile.Smartfile[]> {
+    const done = plugins.smartpromise.defer<plugins.smartfile.Smartfile[]>();
+    const smartarchiveInstance = new plugins.smartarchive.SmartArchive();
+    let tarballUrl = this.dist?.tarball;
+    if (optionsArg?.version || optionsArg?.distTag) {
+      if (optionsArg.distTag && optionsArg.version) {
+        throw new Error('Please either specify version OR disttag, not both.');
+      }
+      let targetVersionString: string;
+      if (optionsArg.distTag) {
+        const targetDistTag = this.allDistTags.find((distTag) => {
+          return distTag.name === optionsArg.distTag;
+        });
+        if (targetDistTag) {
+          targetVersionString = targetDistTag.targetVersion;
+        }
+      } else {
+        targetVersionString = optionsArg.version;
+      }
+
+      // lets find the best matching release
+      const bestMatchingVersion = this.getBestMatchingVersion(targetVersionString);
+      if (!bestMatchingVersion) {
+        return null;
+      }
+      tarballUrl = this.allVersions.find(
+        (packageVersion) => packageVersion.version === bestMatchingVersion
+      ).dist.tarball;
+    }
+    const fileObservable = await smartarchiveInstance.extractArchiveFromUrlToObservable(tarballUrl);
+    const wantedFilePath = plugins.path.join('package', filePath);
+    const allMatchingFiles: plugins.smartfile.Smartfile[] = [];
+    const subscription = fileObservable.subscribe(
+      (fileArg) => {
+        // returnOnFirstArg requires exact match
+        if (returnOnFirstArg && fileArg.path === wantedFilePath) {
+          // lets resolve with the wanted file
+          done.resolve([fileArg]);
+          subscription.unsubscribe();
+        } else if(!returnOnFirstArg && fileArg.path.startsWith(wantedFilePath)) {
+          allMatchingFiles.push(fileArg);
+        }
+      },
+      (err) => {
+        console.log(err);
+      },
+      () => {
+        done.resolve(allMatchingFiles);
+        subscription.unsubscribe();
+      }
+    );
+    return done.promise;
+  }
+
+  /**
+   * get files from package
+   */
+   public async getFileFromPackage(
+    filePath: string,
+    optionsArg?: {
+      distTag?: string;
+      version?: string;
+    }
+  ): Promise<plugins.smartfile.Smartfile> {
+    const result = await this.getFilesFromPackage(filePath, optionsArg, true);
+    return result[0] || null;
+  }
+
+  /**
+   * updates the package with information from the registry
+   */
+  update() {}
+
+  /** */
+  public getBestMatchingVersion(versionArg: string): string {
+    // lets find the best matching release
+    const targetVersion = plugins.smartversion.SmartVersion.fromFuzzyString(versionArg);
+    const versionStrings = this.allVersions.map((packageVersion) => packageVersion.version);
+    const bestMatchingVersion = targetVersion.getBestMatch(versionStrings);
+    if (!bestMatchingVersion) {
+      return null;
+    }
+    return bestMatchingVersion;
+  }
+}

package/ts/smartnpm.classes.npmregistry.ts

@@ -0,0 +1,228 @@
+import * as plugins from './smartnpm.plugins.js';
+import * as paths from './smartnpm.paths.js';
+
+// interfaces
+import { ISearchObject } from './smartnpm.interfaces.js';
+
+// classes
+import { NpmPackage } from './smartnpm.classes.npmpackage.js';
+import { ICacheDescriptor, RegistryCache } from './smartnpm.classes.registrycache.js';
+
+export interface INpmRegistryConstructorOptions {
+  npmRegistryUrl?: string;
+}
+
+export class NpmRegistry {
+  public options: INpmRegistryConstructorOptions;
+  public registryCache: RegistryCache;
+  private searchDomain = 'https://api.npms.io/v2/search?q=';
+
+  constructor(optionsArg: INpmRegistryConstructorOptions = {}) {
+    const defaultOptions: INpmRegistryConstructorOptions = {
+      npmRegistryUrl: 'https://registry.npmjs.org',
+    };
+    this.options = {
+      ...defaultOptions,
+      ...optionsArg,
+    };
+    this.registryCache = new RegistryCache(this);
+  }
+
+  /**
+   * gets info about a package
+   * @param packageName
+   */
+  public async getPackageInfo(packageName: string): Promise<NpmPackage> {
+    const fullMetadata = await plugins.packageJson(packageName, {
+      registryUrl: this.options.npmRegistryUrl,
+      fullMetadata: true,
+    }).catch(err => {
+      console.log(err);
+      return null;
+    });
+    const versionData = await plugins.packageJson(packageName, {
+      registryUrl: this.options.npmRegistryUrl,
+      allVersions: true
+    });
+    const npmPackage = await NpmPackage.createFromFullMetadataAndVersionData(this, fullMetadata, versionData as any);
+    return npmPackage;
+  }
+
+  /**
+   * saves a package to disk
+   * @param packageName
+   * @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);
+  }
+
+  /**
+   * gets a file from a package as Smartfile
+   */
+  public async getFileFromPackage(packageNameArg: string, filePathArg: string, optionsArg?: {
+    distTag?: string;
+    version?: string;
+  }): Promise<plugins.smartfile.Smartfile> {
+    // lets create a cache descriptor
+    const cacheDescriptor: ICacheDescriptor = {
+      registryUrl: this.options.npmRegistryUrl,
+      packageName: packageNameArg,
+      filePath: filePathArg,
+      distTag: optionsArg?.distTag,
+      version: optionsArg?.version
+    };
+
+    // lets see if we have something cached
+    const cachedFile: plugins.smartfile.Smartfile = await this.registryCache.getCachedFile(cacheDescriptor);
+    
+    // lets handle both occasions
+    if (!cachedFile) {
+      const npmPackage = await this.getPackageInfo(packageNameArg);
+      if (!optionsArg?.version && !optionsArg?.distTag) {
+        const latestAvailable = npmPackage.allDistTags.find(packageArg => packageArg.name === 'latest');
+        if (!latestAvailable) {
+          optionsArg = {
+            version: npmPackage.getBestMatchingVersion('*')
+          };
+        }
+      }
+      const fileResult = await npmPackage.getFileFromPackage(filePathArg, optionsArg);
+      if (fileResult) {
+        this.registryCache.cacheSmartFile(cacheDescriptor, fileResult);
+      }
+      return fileResult;
+    } else {
+      return cachedFile;
+    }
+  }
+
+  public async getFilesFromPackage(packageNameArg: string, filePath: string, optionsArg?: {
+    distTag?: string;
+    version?: string;
+  }): Promise<plugins.smartfile.Smartfile[]> {
+    const npmPackage = await this.getPackageInfo(packageNameArg);
+    if (!optionsArg?.version && !optionsArg?.distTag) {
+      const latestAvailable = npmPackage.allDistTags.find(packageDistTagArg => packageDistTagArg.name === 'latest');
+      if (!latestAvailable) {
+        optionsArg = {
+          version: npmPackage.getBestMatchingVersion('*')
+        };
+      }
+    }
+    return npmPackage.getFilesFromPackage(filePath, optionsArg);
+  }
+
+  public async getPackageAsSmartfileVirtualDir(packageNameArg: string): Promise<plugins.smartfile.VirtualDirectory> {
+    /**
+     * TODO: rewrite as memory only
+     */
+    const baseDir = plugins.path.join(paths.nogitDir, packageNameArg.replace('/', '__'));
+    await plugins.smartfile.fs.ensureDir(baseDir);
+    await this.savePackageToDisk(packageNameArg, baseDir);
+    const virtualDir = await plugins.smartfile.VirtualDirectory.fromFsDirPath(baseDir);
+    await plugins.smartfile.fs.remove(baseDir);
+    return virtualDir;
+  }
+
+  /**
+   * searches for a package on npm
+   * @param searchObjectArg
+   */
+  public async searchOnNpm(searchObjectArg: ISearchObject) {
+    if (this.options.npmRegistryUrl !== 'https://registry.npmjs.org') {
+      throw Error(`cannot search registries other than registry.gitlab.com`);
+    }
+    let searchString = '';
+    const addToSearchString = (addStringArg: string) => {
+      searchString = `${searchString}+${addStringArg}`;
+    };
+
+    // name
+    if (searchObjectArg.name) {
+      searchString = `${searchObjectArg.name}`;
+    }
+
+    // metadata
+    if (searchObjectArg.author) {
+      addToSearchString(`author:${searchObjectArg.author}`);
+    }
+    if (searchObjectArg.maintainer) {
+      addToSearchString(`maintainer:${searchObjectArg.maintainer}`);
+    }
+    if (searchObjectArg.scope) {
+      addToSearchString(`scope:${searchObjectArg.scope}`);
+    }
+
+    // status
+    if (searchObjectArg.deprecated) {
+      if (searchObjectArg.deprecated === true) {
+        addToSearchString(`is:deprecated`);
+      } else {
+        addToSearchString(`not:deprecated`);
+      }
+    }
+    if (searchObjectArg.unstable) {
+      if (searchObjectArg.unstable === true) {
+        addToSearchString(`is:unstable`);
+      } else {
+        addToSearchString(`not:unstable`);
+      }
+    }
+    if (searchObjectArg.insecure) {
+      if (searchObjectArg.insecure === true) {
+        addToSearchString(`is:insecure`);
+      } else {
+        addToSearchString(`not:insecure`);
+      }
+    }
+
+    // search behaviour
+    if (searchObjectArg.boostExact) {
+      addToSearchString(`boost-exact:${searchObjectArg.boostExact}`);
+    }
+    if (searchObjectArg.scoreEffect) {
+      addToSearchString(`score-effect:${searchObjectArg.scoreEffect}`);
+    }
+
+    // analytics
+    if (searchObjectArg.qualityWeight) {
+      addToSearchString(`author:${searchObjectArg.qualityWeight}`);
+    }
+    if (searchObjectArg.popularityWeight) {
+      addToSearchString(`author:${searchObjectArg.popularityWeight}`);
+    }
+    if (searchObjectArg.maintenanceWeight) {
+      addToSearchString(`author:${searchObjectArg.maintenanceWeight}`);
+    }
+
+    console.log(
+      `info: Search on npm for ${plugins.consolecolor.coloredString(searchString, 'pink')}`
+    );
+
+    let body: any;
+    try {
+      const response = await plugins.smartrequest.getJson(this.searchDomain + searchString, {});
+      body = response.body;
+    } catch {
+      // we do nothing
+    }
+
+    // lets create the packageArray
+    const packageArray: NpmPackage[] = [];
+
+    // if request failed just return it empty
+    if (!body || typeof body === 'string') {
+      return packageArray;
+    }
+
+    for (const packageSearchInfoArg of body.results) {
+      const npmPackage = await this.getPackageInfo(packageSearchInfoArg.package.name);
+      packageArray.push(npmPackage);
+    }
+
+    return packageArray;
+  }
+}

package/ts/smartnpm.classes.packagedisttag.ts

@@ -0,0 +1,11 @@
+import * as plugins from './smartnpm.plugins.js';
+
+export class PackageDisttag {
+  name: string;
+  targetVersion: string;
+
+  constructor(nameArg: string, targetVersionArg: string) {
+    this.name = nameArg;
+    this.targetVersion = targetVersionArg;
+  }
+}

package/ts/smartnpm.classes.packageversion.ts

@@ -0,0 +1,31 @@
+import * as plugins from './smartnpm.plugins.js';
+
+export interface IVersionData {
+  name: string;
+  version: string;
+  dependencies: { [key: string]: string };
+  devDependencies: { [key: string]: string };
+  dist: {
+    integrity: string;
+    shasum: string;
+    tarball: string;
+  };
+}
+
+export class PackageVersion implements IVersionData {
+  public static createFromVersionData(versionDataArg: IVersionData) {
+    const packageVersion = new PackageVersion();
+    Object.assign(packageVersion, versionDataArg);
+    return packageVersion;
+  }
+
+  name: string;
+  version: string;
+  dependencies: { [key: string]: string };
+  devDependencies: { [key: string]: string };
+  dist: {
+    integrity: string;
+    shasum: string;
+    tarball: string;
+  };
+}

package/ts/smartnpm.classes.registrycache.ts

@@ -0,0 +1,50 @@
+import { NpmRegistry } from './smartnpm.classes.npmregistry.js';
+import * as plugins from './smartnpm.plugins.js';
+
+
+export interface ICacheDescriptor {
+  registryUrl: string;
+  packageName: string;
+  filePath: string;
+  distTag?: string;
+  version?: string;
+}
+
+export class RegistryCache {
+  npmregistryRef: NpmRegistry;
+  public levelCache: plugins.levelcache.LevelCache;
+
+  constructor(npmRegistryRefArg: NpmRegistry) {
+    this.npmregistryRef = npmRegistryRefArg;
+    this.levelCache = new plugins.levelcache.LevelCache({
+      cacheId: encodeURIComponent(this.npmregistryRef.options.npmRegistryUrl),
+      
+    });
+  }
+
+  public async getCachedFile (cacheDescriptorArg: ICacheDescriptor): Promise<plugins.smartfile.Smartfile> {
+    const cacheEntry = await this.levelCache.retrieveCacheEntryByKey(this.getCacheDescriptorAsString(cacheDescriptorArg));
+    if (cacheEntry) {
+      return plugins.smartfile.Smartfile.fromFoldedJson(cacheEntry.contents.toString());
+    }
+    return null;
+  }
+
+  public async cacheSmartFile (cacheDescriptorArg: ICacheDescriptor, smartfileArg: plugins.smartfile.Smartfile) {
+    if (smartfileArg && cacheDescriptorArg.version) {
+      await this.levelCache.storeCacheEntryByKey(this.getCacheDescriptorAsString(cacheDescriptorArg), new plugins.levelcache.CacheEntry({
+        contents: Buffer.from(smartfileArg.foldToJson()),
+        ttl: plugins.smarttime.getMilliSecondsFromUnits({hours: 1})
+      }));
+    } else {
+      await this.levelCache.storeCacheEntryByKey(this.getCacheDescriptorAsString(cacheDescriptorArg), new plugins.levelcache.CacheEntry({
+        contents: Buffer.from(smartfileArg.foldToJson()),
+        ttl: plugins.smarttime.getMilliSecondsFromUnits({minutes: 1})
+      }));
+    }
+  }
+
+  public getCacheDescriptorAsString(cacheDescriptorArg?: ICacheDescriptor) {
+    return `${cacheDescriptorArg.registryUrl}//+//${cacheDescriptorArg.packageName}//+//${cacheDescriptorArg.filePath}//+//${cacheDescriptorArg.distTag || cacheDescriptorArg.version}`;
+  }
+}

package/ts/smartnpm.interfaces.ts

@@ -0,0 +1,24 @@
+export interface ISearchObject {
+  // name
+  name?: string;
+
+  // metadata
+  author?: string;
+  maintainer?: string;
+  scope?: string;
+  keywords?: string[];
+
+  // status
+  deprecated?: boolean;
+  unstable?: boolean;
+  insecure?: boolean;
+
+  // search behaviour
+  boostExact?: boolean;
+  scoreEffect?: number;
+
+  // Analytics
+  qualityWeight?: number;
+  popularityWeight?: number;
+  maintenanceWeight?: number;
+}

package/ts/smartnpm.paths.ts

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