@verdaccio/test-helper 4.0.0-next-8.7

package/src/generateUnPublishPackageMetadata.ts

@@ -0,0 +1,89 @@
+import { UnPublishManifest } from '@verdaccio/types';
+
+export function generateUnPublishPackageMetadata(
+  pkgName: string,
+  versions: string[] = ['1.0.0'],
+  distTags,
+  rev: string
+): UnPublishManifest {
+  const versionsData = versions.reduce((acc, version) => {
+    acc[version] = {
+      name: pkgName,
+      version: version,
+      main: 'index.js',
+      scripts: {
+        test: 'echo "Error: no test specified" && exit 1',
+      },
+      author: {
+        name: 'Verdaccio Maintainers',
+        email: 'verdaccio.npm@gmail.com',
+      },
+      repository: {
+        type: 'git',
+        url: 'https://github.com/verdaccio/verdaccio.git',
+      },
+      homepage: 'https://verdaccio.org',
+      funding: {
+        type: 'opencollective',
+        url: 'https://opencollective.com/verdaccio',
+      },
+      keywords: [],
+      license: 'ISC',
+      dependencies: {
+        '@verdaccio/logger-7': '^6.0.0-6-next.3',
+      },
+      bugs: {
+        url: 'https://github.com/verdaccio/verdaccio/issues',
+      },
+      devDependencies: {},
+      _id: `${pkgName}@${version}`,
+      _nodeVersion: '20.10.0',
+      _npmVersion: '10.9.0',
+      dist: {
+        integrity:
+          'sha512-qc+palHxTF5tUhtAHGikwmv7EqhybOZ3cHUvGQZ9H2a8C7VXQ0e4ZVYS7qpNvYmG3m3khfMzsmx/R96BcxaPfw==',
+        shasum: '4ece00c13d4a99722275afb6270d44ca158aaaa0',
+        tarball: `http://localhost:8000/${pkgName}/-/${pkgName}-${version}.tgz`,
+        fileCount: 3,
+        unpackedSize: 6488666,
+      },
+      contributors: [],
+      maintainers: [
+        {
+          name: 'test',
+          email: '',
+        },
+      ],
+    };
+    return acc;
+  }, {});
+
+  const timeData = versions.reduce(
+    (acc, version) => {
+      const now = new Date().toISOString();
+      acc[version] = now;
+      return acc;
+    },
+    {} as Record<string, string>
+  );
+
+  return {
+    _id: pkgName,
+    name: pkgName,
+    'dist-tags': { ...distTags },
+    versions: versionsData,
+    time: {
+      created: new Date().toISOString(),
+      modified: new Date().toISOString(),
+      ...timeData,
+    },
+    maintainers: [
+      {
+        name: 'test',
+        email: '',
+      },
+    ],
+    readme: 'ERROR: No README data found!',
+    _rev: rev,
+  };
+}

package/src/getDeprecatedPackageMetadata.ts

@@ -0,0 +1,19 @@
+import { Manifest } from '@verdaccio/types';
+
+import { generatePackageMetadata } from './generatePackageMetadata';
+import { DistTags } from './types';
+
+export function getDeprecatedPackageMetadata(
+  pkgName: string,
+  version = '1.0.0',
+  distTags: DistTags = { ['latest']: version },
+  deprecated = 'default deprecated message',
+  rev = 'rev-foo'
+): Manifest {
+  const manifest = generatePackageMetadata(pkgName, version, distTags);
+  // deprecated message requires empty attachments
+  manifest._attachments = {};
+  manifest._rev = rev;
+  manifest.versions[version].deprecated = deprecated;
+  return manifest;
+}

package/src/index.ts

@@ -0,0 +1,9 @@
+export { generatePackageMetadata } from './generatePackageMetadata';
+export { getDeprecatedPackageMetadata } from './getDeprecatedPackageMetadata';
+export { generateLocalPackageMetadata } from './generateLocalPackageMetadata';
+export { generateRemotePackageMetadata } from './generateRemotePackageMetadata';
+export { addNewVersion } from './addNewVersion';
+export { generatePublishNewVersionManifest } from './generatePublishNewVersionManifest';
+export { initializeServer } from './initializeServer';
+export { publishVersion } from './actions';
+export { generateUnPublishPackageMetadata } from './generateUnPublishPackageMetadata';

package/src/initializeServer.ts

@@ -0,0 +1,61 @@
+import buildDebug from 'debug';
+import express, { Application } from 'express';
+import os from 'node:os';
+import path from 'node:path';
+
+import { Auth } from '@verdaccio/auth';
+import { Config } from '@verdaccio/config';
+import { cryptoUtils, errorUtils } from '@verdaccio/core';
+import { setup } from '@verdaccio/logger';
+import { errorReportingMiddleware, final, handleError } from '@verdaccio/middleware';
+
+const debug = buildDebug('verdaccio:tools:helpers:server');
+
+export async function initializeServer(
+  configObject,
+  routesMiddleware: any[] = [],
+  Storage
+): Promise<Application> {
+  const app = express();
+  const logger = setup(configObject.log ?? {});
+  const config = new Config(configObject);
+  config.storage = path.join(os.tmpdir(), '/storage', cryptoUtils.generateRandomHexString());
+  // httpass would get path.basename() for configPath thus we need to create a dummy folder
+  // to avoid conflics
+  config.configPath = config.storage;
+  debug('storage: %s', config.storage);
+
+  const storage = new Storage(config, logger);
+  await storage.init(config, []);
+  const auth: Auth = new Auth(config, logger);
+  await auth.init();
+  // TODO: this might not be need it, used in apiEndpoints
+  app.use(express.json({ strict: false, limit: '10mb' }));
+  // @ts-ignore
+  app.use(errorReportingMiddleware(logger));
+  for (let route of routesMiddleware) {
+    if (route.async) {
+      const middleware = await route.routes(config, auth, storage, logger);
+      app.use(middleware);
+    } else {
+      app.use(route(config, auth, storage, logger));
+    }
+  }
+
+  // catch 404
+  app.get('/*', function (req, res, next) {
+    next(errorUtils.getNotFound('resource not found'));
+  });
+
+  // @ts-ignore
+  app.use(handleError(logger));
+  // @ts-ignore
+  app.use(final);
+
+  app.use(function (request, response) {
+    response.status(590);
+    response.json({ error: 'cannot handle this' });
+  });
+
+  return app;
+}

package/src/types.ts

@@ -0,0 +1,3 @@
+export interface DistTags {
+  [key: string]: string;
+}

package/src/utils.ts

@@ -0,0 +1,8 @@
+export const getTarball = (name: string): string => {
+  const r = name.split('/');
+  if (r.length === 1) {
+    return r[0];
+  } else {
+    return r[1];
+  }
+};

package/tests/generateUnPublishPackageMetadata.ts.spec.ts

@@ -0,0 +1,98 @@
+import { describe, expect, it } from 'vitest';
+
+// Update the import path accordingly
+import { UnPublishManifest } from '@verdaccio/types';
+
+import { generateUnPublishPackageMetadata } from '../src/generateUnPublishPackageMetadata';
+
+describe('generateUnPublishPackageMetadata', () => {
+  it('should generate metadata for a single version', () => {
+    const pkgName = 'test-package';
+    const versions = ['1.0.0'];
+    const distTags = { latest: '1.0.0' };
+    const rev = '1-abc';
+
+    const result: UnPublishManifest = generateUnPublishPackageMetadata(
+      pkgName,
+      versions,
+      distTags,
+      rev
+    );
+
+    expect(result._id).toBe(pkgName);
+    expect(result.name).toBe(pkgName);
+    expect(result['dist-tags']).toEqual(distTags);
+    expect(result.versions['1.0.0']).toBeDefined();
+    expect(result.versions['1.0.0'].name).toBe(pkgName);
+    expect(result.versions['1.0.0'].version).toBe('1.0.0');
+    expect(result._rev).toBe(rev);
+    expect(result.time?.created).toBeDefined();
+    expect(result.time?.modified).toBeDefined();
+    expect(result.time?.['1.0.0']).toBeDefined();
+  });
+
+  it('should generate metadata for multiple versions', () => {
+    const pkgName = 'test-package';
+    const versions = ['1.0.0', '2.0.0'];
+    const distTags = { latest: '2.0.0' };
+    const rev = '1-xyz';
+
+    const result: UnPublishManifest = generateUnPublishPackageMetadata(
+      pkgName,
+      versions,
+      distTags,
+      rev
+    );
+
+    expect(result._id).toBe(pkgName);
+    expect(result.name).toBe(pkgName);
+    expect(result['dist-tags']).toEqual(distTags);
+    expect(result.versions['1.0.0']).toBeDefined();
+    expect(result.versions['1.0.0'].version).toBe('1.0.0');
+    expect(result.versions['2.0.0']).toBeDefined();
+    expect(result.versions['2.0.0'].version).toBe('2.0.0');
+    expect(result._rev).toBe(rev);
+    expect(result.time?.['1.0.0']).toBeDefined();
+    expect(result.time?.['2.0.0']).toBeDefined();
+  });
+
+  it('should include default metadata fields', () => {
+    const pkgName = 'default-test';
+    const versions = ['1.0.0'];
+    const distTags = { latest: '1.0.0' };
+    const rev = '1-def';
+
+    const result: UnPublishManifest = generateUnPublishPackageMetadata(
+      pkgName,
+      versions,
+      distTags,
+      rev
+    );
+
+    const versionData = result.versions['1.0.0'];
+    expect(versionData).toMatchObject({
+      name: pkgName,
+      version: '1.0.0',
+      main: 'index.js',
+      scripts: {
+        test: 'echo "Error: no test specified" && exit 1',
+      },
+      author: {
+        name: 'Verdaccio Maintainers',
+        email: 'verdaccio.npm@gmail.com',
+      },
+      repository: {
+        type: 'git',
+        url: 'https://github.com/verdaccio/verdaccio.git',
+      },
+      homepage: 'https://verdaccio.org',
+      funding: {
+        type: 'opencollective',
+        url: 'https://opencollective.com/verdaccio',
+      },
+      license: 'ISC',
+    });
+    expect(versionData.dist).toBeDefined();
+    expect(versionData.maintainers).toContainEqual({ name: 'test', email: '' });
+  });
+});

package/tests/getDeprecatedPackageMetadata.spec.ts

@@ -0,0 +1,40 @@
+import { describe, expect, it } from 'vitest';
+
+import { Manifest } from '@verdaccio/types';
+
+import { getDeprecatedPackageMetadata } from '../src/getDeprecatedPackageMetadata';
+import { DistTags } from '../src/types';
+
+describe('getDeprecatedPackageMetadata', () => {
+  const pkgName = 'test-package';
+  const version = '2.0.0';
+  const distTags: DistTags = { latest: '2.0.0' };
+  const deprecatedMessage = 'This package version is deprecated';
+  const rev = 'rev-bar';
+
+  it('should generate a deprecated package manifest with default values', () => {
+    const result: Manifest = getDeprecatedPackageMetadata(pkgName);
+
+    expect(result.name).toBe(pkgName);
+    expect(result.versions['1.0.0'].deprecated).toBe('default deprecated message');
+    expect(result._rev).toBe('rev-foo');
+    expect(result._attachments).toEqual({});
+  });
+
+  it('should generate a deprecated package manifest with specified version, distTags, and deprecated message', () => {
+    const result: Manifest = getDeprecatedPackageMetadata(
+      pkgName,
+      version,
+      distTags,
+      deprecatedMessage,
+      rev
+    );
+
+    expect(result.name).toBe(pkgName);
+    expect(result.versions[version]).toBeDefined();
+    expect(result.versions[version].deprecated).toBe(deprecatedMessage);
+    expect(result['dist-tags']).toEqual(distTags);
+    expect(result._rev).toBe(rev);
+    expect(result._attachments).toEqual({});
+  });
+});

package/tests/metadata.spec.ts

@@ -0,0 +1,119 @@
+import { describe, expect, test } from 'vitest';
+
+import {
+  addNewVersion,
+  generateLocalPackageMetadata,
+  generatePackageMetadata,
+  generateRemotePackageMetadata,
+} from '../src';
+
+describe('generate metadata', () => {
+  describe('generatePackageMetadata', () => {
+    test('should generate package metadata', () => {
+      expect(generatePackageMetadata('foo', '1.0.0')).toBeDefined();
+    });
+
+    test('should match versions', () => {
+      const manifest = generatePackageMetadata('foo', '1.0.0');
+      expect(Object.keys(manifest.versions)).toEqual(['1.0.0']);
+    });
+
+    test('should add new versions', () => {
+      const manifest = generatePackageMetadata('foo', '1.0.0');
+      const m1 = addNewVersion(manifest, '1.0.1');
+      expect(Object.keys(m1.versions)).toEqual(['1.0.0', '1.0.1']);
+      const m = addNewVersion(m1, '1.0.2');
+      expect(Object.keys(m.versions)).toEqual(['1.0.0', '1.0.1', '1.0.2']);
+      expect(m['dist-tags'].latest).toEqual('1.0.2');
+      expect(m._distfiles['foo-1.0.2.tgz']).toEqual({
+        sha: '2c03764f651a9f016ca0b7620421457b619151b9',
+        url: 'http://localhost:5555/foo/-/foo-1.0.2.tgz',
+      });
+    });
+
+    test('should fails add repeated version', () => {
+      const manifest = generatePackageMetadata('foo', '1.0.0');
+      expect(() => Object.keys(addNewVersion(manifest, '1.0.0').versions)).toThrow();
+    });
+  });
+  describe('generateRemotePackageMetadata', () => {
+    test('should generate package metadata', () => {
+      expect(
+        generateRemotePackageMetadata('foo', '1.0.0', 'https://registry.verdaccio.org')
+      ).toBeDefined();
+    });
+
+    test('should generate package metadata with multiple versions', () => {
+      const m = generateRemotePackageMetadata('foo', '1.0.0', 'https://registry.verdaccio.org', [
+        '1.0.1',
+        '1.0.2',
+        '3.0.0',
+      ]);
+      expect(m).toBeDefined();
+      expect(Object.keys(m.versions)).toEqual(['1.0.0', '1.0.1', '1.0.2', '3.0.0']);
+      expect(Object.keys(m.time)).toEqual([
+        'modified',
+        'created',
+        '1.0.0',
+        '1.0.1',
+        '1.0.2',
+        '3.0.0',
+      ]);
+    });
+  });
+  describe('generateLocalPackageMetadata', () => {
+    test('should generate local package metadata', () => {
+      const m = generateLocalPackageMetadata('foo', '1.0.0', 'https://registry.verdaccio.org');
+      expect(m).toBeDefined();
+      expect(m._attachments['foo-1.0.0.tgz']).toEqual({
+        shasum: '2c03764f651a9f016ca0b7620421457b619151b9',
+        version: '1.0.0',
+      });
+      expect(m._distfiles).toEqual({});
+    });
+
+    test('should add new versions local', () => {
+      const manifest = generateLocalPackageMetadata('foo', '1.0.0');
+      const m1 = addNewVersion(manifest, '1.0.1', false);
+      expect(Object.keys(m1._attachments)).toEqual(['foo-1.0.0.tgz', 'foo-1.0.1.tgz']);
+      expect(Object.keys(m1._distfiles)).toEqual([]);
+      const m2 = addNewVersion(m1, '1.0.2', false);
+      expect(Object.keys(m2.versions)).toEqual(['1.0.0', '1.0.1', '1.0.2']);
+      expect(m2['dist-tags'].latest).toEqual('1.0.2');
+      expect(m2._distfiles).toEqual({});
+      expect(m2._attachments).toEqual({
+        'foo-1.0.0.tgz': {
+          shasum: '2c03764f651a9f016ca0b7620421457b619151b9',
+          version: '1.0.0',
+        },
+        'foo-1.0.1.tgz': {
+          shasum: '2c03764f651a9f016ca0b7620421457b619151b9',
+          version: '1.0.1',
+        },
+        'foo-1.0.2.tgz': {
+          shasum: '2c03764f651a9f016ca0b7620421457b619151b9',
+          version: '1.0.2',
+        },
+      });
+      const m3 = addNewVersion(m2, '1.0.3', false);
+      expect(m3._attachments).toEqual({
+        'foo-1.0.0.tgz': {
+          shasum: '2c03764f651a9f016ca0b7620421457b619151b9',
+          version: '1.0.0',
+        },
+        'foo-1.0.1.tgz': {
+          shasum: '2c03764f651a9f016ca0b7620421457b619151b9',
+          version: '1.0.1',
+        },
+        'foo-1.0.2.tgz': {
+          shasum: '2c03764f651a9f016ca0b7620421457b619151b9',
+          version: '1.0.2',
+        },
+        'foo-1.0.3.tgz': {
+          shasum: '2c03764f651a9f016ca0b7620421457b619151b9',
+          version: '1.0.3',
+        },
+      });
+    });
+  });
+});

package/tests/utils.spec.ts

@@ -0,0 +1,19 @@
+import { describe, expect, it } from 'vitest';
+
+import { getTarball } from '../src/utils';
+
+describe('getTarball', () => {
+  it('should return the name when there is no "/" in the input string', () => {
+    const input = 'simple-name';
+    const result = getTarball(input);
+
+    expect(result).toBe('simple-name');
+  });
+
+  it('should return the second part of the name when there is a "/" in the input string', () => {
+    const input = 'scope/package-name';
+    const result = getTarball(input);
+
+    expect(result).toBe('package-name');
+  });
+});

package/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./build",
+    "preserveSymlinks": true
+  },
+  "include": ["src/**/*.ts", "types/*.d.ts"],
+  "exclude": ["src/**/*.test.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "extends": "../../../tsconfig.reference.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./build",
+    "composite": true,
+    "declaration": true
+  },
+  "include": ["src/**/*.ts"],
+  "references": [
+    {
+      "path": "../../auth"
+    },
+    {
+      "path": "../../config"
+    },
+    {
+      "path": "../../utils"
+    },
+    {
+      "path": "../../middleware"
+    },
+    {
+      "path": "../../core/core"
+    }
+  ]
+}

package/types/patch.d.ts

@@ -0,0 +1,18 @@
+declare module 'jest-matcher-utils';
+declare module 'pretty-format' {
+  export type Plugin = any;
+}
+declare module '@jest/schemas' {
+  export type SnapshotFormat = any;
+}
+
+declare module 'ms';
+
+declare module '@jest/expect-utils';
+declare module 'jest';
+declare module 'expect' {
+  export type MatcherState = any;
+  export type MatcherUtils = any;
+  export type Tester = any;
+  export type EqualsFunction = any;
+}