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

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/templates/typescript/middleware/_package.json

@@ -1,41 +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": {
-    "@types/jest": "^24.0.21",
-    "@types/node": "^12.12.5",
-    "@types/express": "^4.17.1",
-    "@typescript-eslint/eslint-plugin": "^2.12.0",
-    "@verdaccio/babel-preset": "^9.6.1",
-    "@verdaccio/eslint-config": "^9.3.2",
-    "@verdaccio/types": "^9.5.0",
-    "eslint": "^6.6.0",
-    "jest": "^26.0.1 ",
-    "prettier": "^1.19.1",
-    "standard-version": "^8.0.0",
-    "typescript": "^3.9.5"
-  },
-  "keywords": ["<%= keywords %>"],
-  "license": "<%= license %>",
-  "repository": "<%= repository %>",
-  "author": "<%= authorName %> <<%= authorEmail %>>",
-  "scripts": {
-    "release": "standard-version -a -s",
-    "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/typescript/middleware/src/index.ts

@@ -1,35 +0,0 @@
-import { Logger, IPluginMiddleware, IBasicAuth, IStorageManager, PluginOptions } from '@verdaccio/types';
-import { Router, Request, Response, NextFunction, Application } from 'express';
-
-import { CustomConfig } from '../types/index';
-
-export default class VerdaccioMiddlewarePlugin implements IPluginMiddleware<CustomConfig> {
-  public logger: Logger;
-  public foo: string;
-  public constructor(config: CustomConfig, options: PluginOptions<CustomConfig>) {
-    this.foo = config.foo !== undefined ? config.strict_ssl : true;
-    this.logger = options.logger;
-  }
-
-  public register_middlewares(
-    app: Application,
-    auth: IBasicAuth<CustomConfig>,
-    /* eslint @typescript-eslint/no-unused-vars: off */
-    _storage: IStorageManager<CustomConfig>
-  ): void {
-    /**
-     * This is just an example of implementation
-    // eslint new-cap:off
-      const router = Router();
-      router.post(
-        '/custom-endpoint',
-        (req: Request, res: Response & { report_error?: Function }, next: NextFunction): void => {
-          const encryptedString = auth.aesEncrypt(Buffer.from(this.foo, 'utf8'));
-          res.setHeader('X-Verdaccio-Token-Plugin', encryptedString.toString());
-          next();
-        }
-      );
-      app.use('/-/npm/something-new', router);
-    */
-  }
-}

package/generators/app/templates/typescript/middleware/types/index.ts

@@ -1,5 +0,0 @@
-import { Config } from '@verdaccio/types';
-
-export interface CustomConfig extends Config {
-  foo: string;
-}

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

@@ -1,40 +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": "^8.5.0",
-    "@verdaccio/streams": "^9.6.1"
-  },
-  "devDependencies": {
-    "@types/jest": "^24.0.21",
-    "@types/node": "^12.12.5",
-    "@types/express": "^4.17.1",
-    "@typescript-eslint/eslint-plugin": "^2.12.0",
-    "@verdaccio/babel-preset": "^9.6.1",
-    "@verdaccio/eslint-config": "^9.3.2",
-    "@verdaccio/types": "^9.5.0",
-    "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": {
-    "release": "standard-version -a -s",
-    "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/typescript/storage/src/PackageStorage.ts

@@ -1,183 +0,0 @@
-import {
-  Callback,
-  Logger,
-  ILocalPackageManager,
-  StorageUpdateCallback,
-  PackageTransformer,
-  StorageWriteCallback,
-  CallbackAction,
-  Package,
-  ReadPackageCallback
-} from "@verdaccio/types";
-import { UploadTarball, ReadTarball } from "@verdaccio/streams";
-import { getNotFound, getConflict, getInternalError } from '@verdaccio/commons-api';
-
-import { CustomConfig } from "../types/index";
-export default class StoragePluginManage implements ILocalPackageManager {
-  public logger: Logger;
-  public packageName: string;
-  public config: CustomConfig;
-
-  public constructor(
-    config: CustomConfig,
-    packageName: string,
-    logger: 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
-   */
-  public updatePackage(
-    name: string,
-    updateHandler: StorageUpdateCallback,
-    onWrite: StorageWriteCallback,
-    transformPackage: PackageTransformer,
-    onEnd: CallbackAction
-  ): void {
-    /**
-     * 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
-   */
-  public deletePackage(fileName: string, callback: CallbackAction): void {
-    /**
-     * 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
-   */
-  public removePackage(callback: CallbackAction): void {
-    /**
-     * 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
-   */
-  public createPackage(
-    name: string,
-    data: Package,
-    callback: CallbackAction
-  ): void {
-    /**
-     * 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
-   */
-  public savePackage(pkgName: string, pkg: Package, callback: CallbackAction): void {
-    /*
-      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
-   */
-  public readPackage(pkgName: string, callback: ReadPackageCallback): void {
-    /**
-     * 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
-   */
-  public writeTarball(name: string): UploadTarball {
-      /**
-       * Example of implementation:
-       * const stream = new UploadTarball({});
-         return stream;
-       */
-
-  }
-
-  /**
-   * Create a readable stream (read a from a tarball)
-   * @param name
-   */
-  public readTarball(name: string): ReadTarball {
-    /**
-     * Example of implementation:
-     * const stream = new ReadTarball({});
-       return stream;
-     */
-  }
-}

package/generators/app/templates/typescript/storage/src/index.ts

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

package/generators/app/templates/typescript/storage/src/plugin.ts

@@ -1,140 +0,0 @@
-import {
-  Logger,
-  Callback,
-  IPluginStorage,
-  PluginOptions,
-  IPackageStorage,
-  TokenFilter,
-  Token,
-  Config,
-  onEndSearchPackage,
-  onSearchPackage,
-  onValidatePackage
-} from '@verdaccio/types';
-import { getInternalError } from '@verdaccio/commons-api';
-
-import { CustomConfig } from '../types/index';
-
-import PackageStorage from './PackageStorage';
-
-export default class VerdaccioStoragePlugin implements IPluginStorage<CustomConfig> {
-  config: CustomConfig & Config;
-  version?: string;
-  public logger: Logger;
-  public constructor(
-    config: CustomConfig,
-    options: PluginOptions<CustomConfig>
-  ) {
-    this.config = config;
-    this.logger = options.logger;
-  }
-
-  /**
-   *
-   */
-  public async getSecret(): Promise<string> {
-    /**
-     * return await resolveSecret();
-     */
-  }
-
-  public async setSecret(secret: string): Promise<any> {
-    /**
-     * return await getYourSecret();
-     */
-  }
-
-  /**
-   * Add a new element.
-   * @param {*} name
-   * @return {Error|*}
-   */
-  public add(name: string, callback: Callback): void {
-
-  }
-
-  /**
-   * Perform a search in your registry
-   * @param onPackage
-   * @param onEnd
-   * @param validateName
-   */
-  public search(
-    onPackage: onSearchPackage,
-    onEnd: onEndSearchPackage,
-    validateName: onValidatePackage
-  ): void {
-    /**
-     * 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|*}
-   */
-  public remove(name: string, callback: Callback): void {
-    /**
-     * 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}
-   */
-  public get(callback: Callback): void {
-    /*
-      Example of implementation
-      database.getAll((allItems, err) => {
-        callback(err, allItems);
-      })
-    */
-  }
-
-  /**
-   * Create an instance of the `PackageStorage`
-   * @param packageInfo
-   */
-  public getPackageStorage(packageInfo: string): IPackageStorage {
-    return new PackageStorage(this.config, packageInfo, this.logger);
-  }
-
-  /**
-   * All methods for npm token support
-   * more info here https://github.com/verdaccio/verdaccio/pull/1427
-   */
-
-  public saveToken(token: Token): Promise<any> {
-    throw new Error('Method not implemented.');
-  }
-
-  public deleteToken(user: string, tokenKey: string): Promise<any> {
-    throw new Error('Method not implemented.');
-  }
-
-  public readTokens(filter: TokenFilter): Promise<Token[]> {
-    throw new Error('Method not implemented.');
-  }
-}

package/generators/app/templates/typescript/storage/types/index.ts

@@ -1,5 +0,0 @@
-import { Config } from '@verdaccio/types';
-
-export interface CustomConfig extends Config {
-  foo: string;
-}

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;
-};