@jayxuz/verdaccio-offline-storage 3.0.0 → 3.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayxuz/verdaccio-offline-storage",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Verdaccio storage plugin that treats local package cache as first class citizen for offline environments",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -39,7 +39,7 @@
     "node": ">=18.0.0"
   },
   "license": "MIT",
-  "repository": "https://github.com/g3ngar/verdaccio-offline-storage",
-  "author": "g3ngar <gengar@nauta.cu>",
-  "homepage": "https://github.com/g3ngar/verdaccio-offline-storage"
+  "repository": "https://github.com/jayxuz/verdaccio-offline-sync/packages/verdaccio-offline-storage",
+  "author": "jayxuz",
+  "homepage": "https://github.com/jayxuz/verdaccio-offline-sync/packages/verdaccio-offline-storage"
 }

package/src-backup/OfflinePackageStorage.js

@@ -1,122 +0,0 @@
-import { readdir } from 'fs';
-import { basename } from 'path';
-import cmp from 'semver-compare';
-import LocalFS from '@verdaccio/local-storage/lib/local-fs';
-
-/**
- * `IPackageStorage` used internally for packages I/O operations.
- *
- * This works just like the `IPackageStorage` used by the local-storage plugin but modifying
- * the packages definition files (the local-storage `package.json` files) so only the locally
- * available versions appears in the definition. This does **NOT** modifies the original
- * `package.json` file stored in the local-storage cache, meaning that all the modifications are
- * done on the fly, on demand and in memory.
- *
- * @see https://verdaccio.org/docs/en/plugin-storage#api
- * @see https://github.com/verdaccio/monorepo/tree/master/plugins/local-storage
- */
-export default class OfflinePackageStorage extends LocalFS {
-  constructor(path, logger, config) {
-    super(path, logger);
-    this.config = config;
-  }
-  /**
-   * Computes a package's definition that only lists the locally available versions.
-   *
-   * @param {string} name Package name.
-   * @param cb Callback to invoke with the computed definition.
-   */
-  readPackage(name, cb) {
-    const packageAccess = this.config.getMatchedPackagesSpec(name);
-    // It's offline if set explicitly in the config or if no proxy is defined for the package
-    const offline = this.config.offline || !packageAccess.proxy || !packageAccess.proxy.length;
-    if (!offline) {
-      this.logger.trace(
-        {
-          packageName: name,
-        },
-        '[verdaccio-offline-storage/readPackage] Resolving package @{packageName} in online mode'
-      );
-      super.readPackage(name, cb);
-      return;
-    }
-    this.logger.trace(
-      {
-        packageName: name,
-      },
-      '[verdaccio-offline-storage/readPackage] Resolving package @{packageName} in offline mode'
-    );
-    super.readPackage(name, (err, data) => {
-      if (err) {
-        cb(err);
-      } else {
-        this.logger.trace(
-          {
-            packageName: name,
-          },
-          '[verdaccio-offline-storage/readPackage] Discovering local versions for package: @{packageName}'
-        );
-        readdir(this.path, (err, items) => {
-          if (err) {
-            this.logger.trace(
-              {
-                err,
-                packageName: name,
-              },
-              '[verdaccio-offline-storage/readPackage/readdir] Error discovering package "@{packageName}" files: @{err}'
-            );
-            cb(err);
-          } else {
-            const localVersions = items
-              .filter(item => item.endsWith('.tgz'))
-              .map(item => item.substring(basename(name).length + 1, item.length - 4));
-            this.logger.trace(
-              {
-                packageName: name,
-                count: localVersions.length,
-              },
-              '[verdaccio-offline-storage/readPackage/readdir] Discovered @{count} items for package: @{packageName}'
-            );
-            const allVersions = Object.keys(data.versions);
-            const originalVersionCount = allVersions.length;
-            this.logger.trace(
-              {
-                packageName: name,
-                count: originalVersionCount,
-              },
-              '[verdaccio-offline-storage/readPackage/readdir] Analyzing @{count} declared versions for package: @{packageName}'
-            );
-            for (const version of allVersions) {
-              if (!localVersions.includes(version)) {
-                delete data.versions[version];
-                this.logger.trace(
-                  {
-                    packageName: name,
-                    version,
-                  },
-                  '[verdaccio-offline-storage/readPackage/readdir] Removed @{packageName}@@{version}'
-                );
-              }
-            }
-            this.logger.trace(
-              {
-                packageName: name,
-                count: originalVersionCount - Object.keys(data.versions).length,
-              },
-              '[verdaccio-offline-storage/readPackage/readdir] Removed @{count} versions for package: @{packageName}'
-            );
-            data['dist-tags'].latest = Object.keys(data.versions).sort((a, b) => cmp(b, a))[0];
-            this.logger.trace(
-              {
-                packageName: name,
-                latest: data['dist-tags'].latest,
-              },
-              '[verdaccio-offline-storage/readPackage/readdir] Set latest version to @{latest} for package: @{packageName}'
-            );
-            cb(null, data);
-          }
-        });
-      }
-    });
-  }
-}

package/src-backup/OfflineStoragePlugin.js

@@ -1,102 +0,0 @@
-import { join } from 'path';
-import { readdir } from 'fs';
-import LocalDatabase from '@verdaccio/local-storage';
-import OfflinePackageStorage from './OfflinePackageStorage';
-
-/**
- * Verdaccio storage plugin (`IPluginStorage`) that provides only the locally available versions of
- * packages cached in a local-storage storage.
- *
- * Basically, this is just like local-storage but modifying on the fly the available packages list
- * and the packages definitions without altering the original files in the local-storage storage.
- *
- * @see https://verdaccio.org/docs/en/plugin-storage
- * @see https://github.com/verdaccio/monorepo/tree/master/plugins/local-storage
- */
-export default class OfflineStoragePlugin extends LocalDatabase {
-  constructor(config, options) {
-    super(config, options.logger);
-    // eslint-disable-next-line no-console
-    if (config.offline) {
-      options.logger.warn({}, 'Offline mode set explicitly in config. All packages will be resolved in offline mode.');
-    } else {
-      options.logger.warn(
-        {},
-        'Offline mode NOT set explicitly in config. Only packages with no `proxy` will be resolved in offline mode.'
-      );
-    }
-  }
-
-  /**
-   * Retrieves all the locally available packages names. Packages with no cached versions (only
-   * `package.json` file in the directory) are ignored.
-   *
-   * @param callback: The callback to invoke with the found packages names.
-   * @see https://verdaccio.org/docs/en/plugin-storage#api
-   */
-  get(callback) {
-    const packages = [];
-    this.search(
-      (item, cb) => {
-        this.logger.debug(
-          {
-            packageName: item.name,
-          },
-          '[verdaccio-offline-storage/get/search] discovering local versions for package: @{packageName}'
-        );
-        readdir(item.path, (err, items) => {
-          if (err) {
-            this.logger.trace(
-              {
-                err,
-                packageName: item.name,
-              },
-              '[verdaccio-offline-storage/get/search/readdir] error discovering package "@{packageName}" files: @{err}'
-            );
-            cb(err);
-          } else {
-            if (items.find(item => item.endsWith('.tgz'))) {
-              packages.push(item.name);
-              this.logger.trace(
-                {
-                  packageName: item.name,
-                },
-                '[verdaccio-offline-storage/get/search/readdir] found locally available package: "@{packageName}"'
-              );
-            } else {
-              this.logger.trace(
-                {
-                  packageName: item.name,
-                },
-                '[verdaccio-offline-storage/get/search/readdir] no locally available version found for package: "@{packageName}"'
-              );
-            }
-            cb();
-          }
-        });
-      },
-      () => {
-        this.data.list = packages;
-        callback(null, packages);
-        this.logger.trace(
-          {
-            totalItems: packages.length,
-          },
-          'verdaccio-offline-storage: [get] full list of packages (@{totalItems}) has been fetched'
-        );
-      },
-      name => !name.startsWith('.') // so `.{sinopia|verdaccio}-db.json` gets ignored
-    );
-  }
-
-  /**
-   * Returns the `IPackageStorage` used internally for packages I/O operations.
-   *
-   * @param {string} packageName Package name.
-   * @return {OfflinePackageStorage}
-   * @see https://verdaccio.org/docs/en/plugin-storage#api
-   */
-  getPackageStorage(packageName) {
-    return new OfflinePackageStorage(join(this.config.storage, packageName), this.logger, this.config);
-  }
-}

package/src-backup/plugin.js

@@ -1,4 +0,0 @@
-/**
- * The verdaccio-offline-storage plugin entry point.
- */
-export { default } from './OfflineStoragePlugin';