generator-verdaccio-plugin 3.0.1 → 4.0.0-next.2

package/generators/app/templates/javascript/auth/src/index.js

@@ -1,35 +0,0 @@
-/**
- * Custom Verdaccio Authenticate Plugin.
- */
-class AuthCustomPlugin {
-  constructor(config, options) {
-    return this;
-  }
-  /**
-   * Authenticate an user.
-   * @param user user to log
-   * @param password provided password
-   * @param cb callback function
-   */
-  authenticate(user, password, cb) {
-    // here your code
-  }
-
-  /**
-   * check grants for such user.
-   */
-  allow_access() {
-    // in case of restrict the access
-  }
-
-  /**
-   * check grants to publish
-   */
-  allow_publish() {
-    // in cass to check if has permission to publish
-  }
-}
-
-module.exports = (config, options) => {
-  return new AuthCustomPlugin(config, options);
-};

package/generators/app/templates/javascript/common/README.md

@@ -1,22 +0,0 @@
-# <%= name %>
-
-<%- (description || '').split('\n').map(function (line) {
-  return '> ' + line
-}).join('\n') %>
-
----
-
-## development
-
-See the [verdaccio contributing guide](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md) for instructions setting up your development environment. 
-Once you have completed that, use the following npm tasks.
-
-  - `npm run build`
-
-    Build a distributable archive
-
-  - `npm run test`
-
-    Run unit test
-
-For more information about any of these commands run `npm run ${task} -- --help`.

package/generators/app/templates/javascript/common/babelrc

@@ -1,3 +0,0 @@
-{
-  "presets": ["@verdaccio", {typescript: false} ]
-}

package/generators/app/templates/javascript/common/editorconfig

@@ -1,12 +0,0 @@
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-# 2 space indentation
-[{.,}*.{js,yml,yaml}]
-indent_style = space
-indent_size = 2

package/generators/app/templates/javascript/common/eslintignore

@@ -1,2 +0,0 @@
-node_modules
-lib

package/generators/app/templates/javascript/common/eslintrc

@@ -1,3 +0,0 @@
-{
-  "extends": ["@verdaccio"]
-}

package/generators/app/templates/javascript/common/gitignore

@@ -1,3 +0,0 @@
-npm-debug.log*
-node_modules
-/lib/

package/generators/app/templates/javascript/common/index.js

@@ -1 +0,0 @@
-module.exports = require('./lib/index.js');

package/generators/app/templates/javascript/common/jest.config.js

@@ -1,10 +0,0 @@
-module.exports = {
-  name: 'verdaccio-<%= name %>',
-  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
-  transform: {
-    '^.+\\.(js|jsx|ts|tsx)$': 'babel-jest',
-  },
-  verbose: true,
-  collectCoverage: true,
-  coveragePathIgnorePatterns: ['node_modules'],
-};

package/generators/app/templates/javascript/common/npmignore

@@ -1,4 +0,0 @@
-src/
-.eslintrc
-.babelrc
-test/

package/generators/app/templates/javascript/common/travis.yml

@@ -1,6 +0,0 @@
-language: node_js
-node_js:
-  - "8"
-  - "10"
-sudo: false
-script: npm install . && npm run test

package/generators/app/templates/javascript/middleware/_package.json

@@ -1,34 +0,0 @@
-{
-  "name": "<%= name %>",
-  "version": "0.0.1",
-  "description": "<%= description %>",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": ["lib/"],
-  "engines": {
-    "node": ">=10"
-  },
-  "dependencies": {
-    "@verdaccio/commons-api": "^9.6.1",
-    "express": "^4.17.1"
-  },
-  "devDependencies": {
-    "@verdaccio/babel-preset": "^9.6.1",
-    "@verdaccio/eslint-config": "^9.3.2",
-    "eslint": "^6.6.0",
-    "jest": "^26.0.1 ",
-    "prettier": "^1.19.1",
-    "standard-version": "^8.0.0"
-  },
-  "keywords": "[<%= keywords %>]",
-  "license": "<%= license %>",
-  "repository": "<%= repository %>",
-  "author": "<%= authorName %> <<%= authorEmail %>>",
-  "scripts": {
-    "build": "npm run build:types && npm run build:js",
-    "build:js": "babel src/ --out-dir lib --extensions \".ts,.tsx\"",
-    "build:types": "tsc --emitDeclarationOnly",
-    "test": "jest",
-    "lint": "eslint \"**/*.{js,ts}\""
-  }
-}

package/generators/app/templates/javascript/middleware/src/index.js

@@ -1,8 +0,0 @@
-class VerdaccioMiddlewarePlugin {
-  constructor(config, options) {}
-  register_middlewares(app, auth, storage) {}
-}
-
-module.exports = (config, options) => {
-  return new VerdaccioMiddlewarePlugin(config, options);
-};

package/generators/app/templates/javascript/storage/_package.json

@@ -1,33 +0,0 @@
-{
-  "name": "<%= name %>",
-  "version": "0.0.1",
-  "description": "<%= description %>",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": ["lib/"],
-  "engines": {
-    "node": ">=10"
-  },
-  "dependencies": {
-    "@verdaccio/commons-api": "^9.6.1"
-  },
-  "devDependencies": {
-    "@verdaccio/babel-preset": "^9.6.1",
-    "@verdaccio/eslint-config": "^9.3.2",
-    "eslint": "^6.6.0",
-    "jest": "^26.0.1 ",
-    "prettier": "^1.19.1",
-    "standard-version": "^8.0.0"
-  },
-  "keywords": "[<%= keywords %>]",
-  "license": "<%= license %>",
-  "repository": "<%= repository %>",
-  "author": "<%= authorName %> <<%= authorEmail %>>",
-  "scripts": {
-    "build": "npm run build:types && npm run build:js",
-    "build:js": "babel src/ --out-dir lib --extensions \".ts,.tsx\"",
-    "build:types": "tsc --emitDeclarationOnly",
-    "test": "jest",
-    "lint": "eslint \"**/*.{js,ts}\""
-  }
-}

package/generators/app/templates/javascript/storage/src/PackageStorage.js

@@ -1,153 +0,0 @@
-import { UploadTarball, ReadTarball } from "@verdaccio/streams";
-import { getNotFound, getConflict, getInternalError } from '@verdaccio/commons-api';
-
-
-export default class StoragePluginManage {
-  constructor(packageName, helper, config, logger) {
-    this.logger = logger;
-    this.packageName = packageName;
-    this.config = config;
-  }
-
-  /**
-   * Handle a metadata update and
-   * @param name
-   * @param updateHandler
-   * @param onWrite
-   * @param transformPackage
-   * @param onEnd
-   */
-  updatePackage(name, updateHandler, onWrite, transformPackage, onEnd) {
-    /**
-     * Example of implementation:
-      this.customStore.get().then((pkg: Package) => {
-        updateHandler(pkg, function onUpdateFinish(err) {
-          if (err) {
-            onEnd(err);
-          } else {
-            onWrite(name, pkg, onEnd);
-          }
-        })
-      });
-     */
-  }
-
-  /**
-   * Delete a specific file (tarball or package.json)
-   * @param fileName
-   * @param callback
-   */
-  deletePackage(fileName, callback) {
-     /**
-     * Example of implementation:
-     this.customStore.delete(fileName,  (err) => {
-        if (err) {
-          callback(err);
-        } else {
-          callback(null);
-        }
-      })
-     */
-  }
-
-  /**
-   * Delete a package (folder, path)
-   * This happens after all versions ar tarballs have been removed.
-   * @param callback
-   */
-  removePackage(callback) {
-    /**
-     * Example of implementation:
-      this.customStore.removePackage((err) => {
-        if (err) {
-          callback(err);
-        } else {
-          callback(null);
-        }
-      })
-     */
-  }
-
- /**
-   * Publish a new package (version).
-   * @param name
-   * @param data
-   * @param callback
-   */
-  createPackage(name, metadata, cb) {
-    /**
-     * Example of implementation:
-     * this.customStore.create(name, data).then(err => {
-        if (err.notFound) {
-          callback(getNotFound());
-        } else if (err.alreadyExist) {
-          callback(getConflict());
-        } else {
-          callback(null);
-        }
-      })
-     */
-  }
-
-  /**
-   * Perform write anobject to the storage.
-   * Similar to updatePackage but without middleware handlers
-   * @param pkgName package name
-   * @param pkg package metadata
-   * @param callback
-   */
-  savePackage(name, value, cb) {
-     /*
-      Example of implementation:
-      this.cumstomStore.write(pkgName, pkgName).then(data => {
-        callback(null);
-      }).catch(err => {
-        callback(getInternalError(err.message));
-      })
-    */
-  }
-
-  /**
-   * Read a package from storage
-   * @param pkgName package name
-   * @param callback
-   */
-  readPackage(name, cb) {
-    /**
-     * Example of implementation:
-     * this.customStorage.read(name, (err, pkg: Package) => {
-          if (err.fooError) {
-            callback(getInternalError(err))
-          } else if (err.barError) {
-            callback(getNotFound());
-          } else {
-            callback(null, pkg)
-          }
-      });
-     */
-  }
-
-  /**
-   * Create writtable stream (write a tarball)
-   * @param name
-   */
-  writeTarball(name) {
-     /**
-       * Example of implementation:
-       * const stream = new UploadTarball({});
-         return stream;
-       */
-  }
-
-  /**
-   * Create a readable stream (read a from a tarball)
-   * @param name
-   */
-  readTarball(name) {
-    /**
-     * Example of implementation:
-     * const stream = new ReadTarball({});
-       return stream;
-     */
-  }
-};

package/generators/app/templates/javascript/storage/src/index.js

@@ -1 +0,0 @@
-export { default } from './plugin';

package/generators/app/templates/javascript/storage/src/plugin.js

@@ -1,106 +0,0 @@
-import PackageStorage from './PackageStorage';
-
-class VerdaccioStoragePlugin {
-  constructor(config, options) {
-    this.config = config;
-    this.logger = options.logger;
-  }
-
-  async getSecret() {
-     /**
-     * return await resolveSecret();
-     */
-  }
-
-  async setSecret(secret) {
-     /**
-     * return await getYourSecret();
-     */
-  }
-
-  /**
-   * Add a new element.
-   * @param {*} name
-   * @return {Error|*}
-   */
-  add(name, cb) {}
-
-  search(onPackage, onEnd, validateName) {
-     /**
-     * Example of implementation:
-     * try {
-     *  someApi.getPackages((items) => {
-     *   items.map(() => {
-     *     if (validateName(item.name)) {
-     *       onPackage(item);
-     *     }
-     *   });
-     *  onEnd();
-     * } catch(err) {
-     *   onEnd(err);
-     * }
-     * });
-     */
-  }
-
-  /**
-   * Remove an element from the database.
-   * @param {*} name
-   * @return {Error|*}
-   */
-  remove(name, callback) {
-     /**
-     * Example of implementation
-      database.getPackage(name, (item, err) => {
-        if (err) {
-          callback(getInternalError('your own message here'));
-        }
-
-        // if all goes well we return nothing
-        callback(null);
-      }
-    */
-  }
-
-  /**
-   * Return all database elements.
-   * @return {Array}
-   */
-  get(callback) {
-      /*
-      Example of implementation
-      database.getAll((allItems, err) => {
-        callback(err, allItems);
-      })
-    */
-  }
-
-  /**
-   * Create an instance of the `PackageStorage`
-   * @param packageInfo
-   */
-  getPackageStorage(packageInfo) {
-    return new PackageStorage(this.config, packageInfo, this.logger);
-  }
-
-  /**
-   * All methods for npm token support
-   * more info here https://github.com/verdaccio/verdaccio/pull/1427
-   */
-
-  saveToken(token) {
-    throw new Error('Method not implemented.');
-  }
-
-  deleteToken(user, tokenKey) {
-    throw new Error('Method not implemented.');
-  }
-
-  readTokens(filter) {
-    throw new Error('Method not implemented.');
-  }
-}
-
-export default (config, options) => {
-  return new VerdaccioStoragePlugin(config, options);
-};

package/generators/app/templates/typescript/common/babelrc

@@ -1,3 +0,0 @@
-{
-  "presets": ["@verdaccio"]
-}

package/generators/app/templates/typescript/common/index.ts

@@ -1,3 +0,0 @@
-import VerdaccioPlugin from './lib/index';
-
-export default VerdaccioPlugin;

package/generators/app/templates/typescript/common/travis.yml

@@ -1,6 +0,0 @@
-language: node_js
-node_js:
-  - "8"
-  - "10"
-sudo: false
-script: npm install . && npm run test

package/generators/app/types.d.ts

@@ -1,10 +0,0 @@
-export declare type propsTypes = {
-    name?: string;
-    pluginType?: string;
-    description?: string;
-    githubUsername?: string;
-    authorName?: string;
-    authorEmail?: string;
-    keywords?: Array<string>;
-    lang?: string;
-};

package/generators/app/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/generators/app/types.ts

@@ -1,10 +0,0 @@
-export type propsTypes = {
-  name?: string;
-  pluginType?: string;
-  description?: string;
-  githubUsername?: string;
-  authorName?: string;
-  authorEmail?: string;
-  keywords?: Array<string>;
-  lang?: string;
-};