@verdaccio/search 6.0.0-6-next.2

package/build/index.d.ts

@@ -0,0 +1 @@
+export { default as SearchMemoryIndexer } from './indexer';

package/build/indexer.d.ts

@@ -0,0 +1,37 @@
+import { Version } from '@verdaccio/types';
+type Results = any;
+declare class SearchMemoryIndexer {
+    private database;
+    private storage;
+    /**
+     * Set up the {Storage}
+     * @param {*} storage An storage reference.
+     */
+    configureStorage(storage: any): void;
+    /**
+     * Performs a query to the indexer.
+     * If the keyword is a * it returns all local elements
+     * otherwise performs a search
+     * @param {*} q the keyword
+     * @return {Array} list of results.
+     */
+    query(term: string): Promise<Results | void>;
+    /**
+     * Add a new element to index
+     * @param {*} pkg the package
+     */
+    add(pkg: Version): Promise<void>;
+    /**
+     * Remove an element from the index.
+     * @param {*} name the id element
+     */
+    remove(name: string): Promise<void>;
+    /**
+     * Force a re-index.
+     */
+    reindex(): void;
+    init(): Promise<void>;
+}
+declare const _default: SearchMemoryIndexer;
+export default _default;
+export { Results };

package/jest.config.js

@@ -0,0 +1,12 @@
+const config = require('../../jest/config');
+
+module.exports = Object.assign({}, config, {
+  coverageThreshold: {
+    global: {
+      branches: 79,
+      functions: 94,
+      lines: 87,
+      statements: 87,
+    },
+  },
+});

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@verdaccio/search",
+  "version": "6.0.0-6-next.2",
+  "description": "verdaccio search utitlity tools",
+  "main": "./build/dist.js",
+  "types": "build/index.d.ts",
+  "author": {
+    "name": "Juan Picado",
+    "email": "juanpicado19@gmail.com"
+  },
+  "repository": {
+    "type": "https",
+    "url": "https://github.com/verdaccio/verdaccio"
+  },
+  "license": "MIT",
+  "homepage": "https://verdaccio.org",
+  "keywords": [
+    "private",
+    "package",
+    "repository",
+    "registry",
+    "enterprise",
+    "modules",
+    "proxy",
+    "server",
+    "verdaccio"
+  ],
+  "engines": {
+    "node": ">=12",
+    "npm": ">=6"
+  },
+  "devDependencies": {
+    "@types/node": "16.18.10",
+    "@verdaccio/types": "11.0.0-6-next.25",
+    "@orama/orama": "1.0.0-beta.16",
+    "debug": "4.3.4",
+    "esbuild": "0.14.10"
+  },
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/verdaccio"
+  },
+  "scripts": {
+    "clean": "rimraf ./build",
+    "test": "echo 1",
+    "type-check": "tsc --noEmit -p tsconfig.build.json",
+    "build:types": "tsc --emitDeclarationOnly -p tsconfig.build.json",
+    "build:js": "babel src/ --out-dir build/ --copy-files --extensions \".ts,.tsx\" --source-maps",
+    "build": "esbuild src/index.ts --bundle --outfile=build/dist.js --platform=node --target=node12  && pnpm run build:types"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export { default as SearchMemoryIndexer } from './indexer';

package/src/indexer.ts

@@ -0,0 +1,113 @@
+import { create, insert, remove, search } from '@orama/orama';
+import buildDebug from 'debug';
+
+import { Version } from '@verdaccio/types';
+
+const debug = buildDebug('verdaccio:search:indexer');
+
+type Results = any;
+
+class SearchMemoryIndexer {
+  private database: any | undefined;
+  private storage: any;
+
+  /**
+   * Set up the {Storage}
+   * @param {*} storage An storage reference.
+   */
+  public configureStorage(storage): void {
+    this.storage = storage;
+  }
+
+  /**
+   * Performs a query to the indexer.
+   * If the keyword is a * it returns all local elements
+   * otherwise performs a search
+   * @param {*} q the keyword
+   * @return {Array} list of results.
+   */
+  public async query(term: string): Promise<Results | void> {
+    if (this.database) {
+      debug('searching %s at indexer', term);
+      const searchResult = await search(this.database, {
+        term,
+        properties: '*',
+      });
+
+      return searchResult;
+    }
+  }
+
+  /**
+   * Add a new element to index
+   * @param {*} pkg the package
+   */
+  public async add(pkg: Version): Promise<void> {
+    if (this.database) {
+      const name = pkg.name;
+      debug('adding item %s to the indexer', name);
+      insert(this.database, {
+        id: name,
+        name: name,
+        description: pkg.description,
+        version: `v${pkg.version}`,
+        keywords: pkg.keywords,
+        author: pkg._npmUser ? pkg._npmUser.name : '???',
+      });
+    }
+  }
+
+  /**
+   * Remove an element from the index.
+   * @param {*} name the id element
+   */
+  public async remove(name: string): Promise<void> {
+    if (this.database) {
+      debug('removing item %s to the indexer', name);
+      await remove(this.database, name);
+    }
+  }
+
+  /**
+   * Force a re-index.
+   */
+  public reindex(): void {
+    debug('reindexing search indexer');
+    this.storage?.getLocalDatabase((error, packages): void => {
+      if (error) {
+        // that function shouldn't produce any
+        throw error;
+      }
+      let i = packages.length;
+      if (i === 0) {
+        debug('no packages to index');
+      }
+
+      while (i--) {
+        const pkg = packages[i];
+        debug('indexing package %s', pkg?.name);
+        this.add(pkg);
+      }
+      debug('reindexed search indexer');
+    });
+  }
+
+  public async init() {
+    this.database = await create({
+      schema: {
+        id: 'string',
+        name: 'string',
+        description: 'string',
+        keywords: 'string',
+        version: 'string',
+        readme: 'string',
+      },
+    });
+
+    this.reindex();
+  }
+}
+
+export default new SearchMemoryIndexer();
+
+export { Results };

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./build"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.test.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "extends": "../../tsconfig.reference.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./build",
+    "noImplicitAny": false
+  },
+  "include": ["src/**/*.ts", "types/*.d.ts"],
+  "references": [
+    {
+      "path": "../config"
+    },
+    {
+      "path": "../core/core"
+    },
+    {
+      "path": "../logger/logger"
+    },
+    {
+      "path": "../utils"
+    }
+  ]
+}

package/types/patch.d.ts

@@ -0,0 +1,10 @@
+declare module 'jest-matcher-utils';
+declare module 'pretty-format' {
+  export type Plugin = any;
+  export type CompareKeys = any;
+}
+declare module '@jest/schemas' {
+  export type SnapshotFormat = any;
+}
+
+declare module '@szmarczak/http-timer';