refactor: export type in repository

cnpm · Apr 25, 2023 · f4e2a7d · f4e2a7d
1 parent dd42eff
commit f4e2a7d
Show file tree

Hide file tree

Showing 6 changed files with 135 additions and 135 deletions.
diff --git a/app/core/service/PackageManagerService.ts b/app/core/service/PackageManagerService.ts
@@ -12,7 +12,7 @@ import { calculateIntegrity, detectInstallScript, formatTarball, getFullname, ge
 import { AbstractService } from '../../common/AbstractService';
 import { BugVersionStore } from '../../common/adapter/BugVersionStore';
 import { BUG_VERSIONS, LATEST_TAG } from '../../common/constants';
-import { PackageRepository } from '../../repository/PackageRepository';
+import { AbbreviatedPackageJSONType, AbbreviatedPackageManifestType, PackageJSONType, PackageManifestType, PackageRepository } from '../../repository/PackageRepository';
 import { PackageVersionBlockRepository } from '../../repository/PackageVersionBlockRepository';
 import { PackageVersionDownloadRepository } from '../../repository/PackageVersionDownloadRepository';
 import { DistRepository } from '../../repository/DistRepository';
@@ -40,134 +40,6 @@ import { BugVersion } from '../entity/BugVersion';
 import { RegistryManagerService } from './RegistryManagerService';
 import { Registry } from '../entity/Registry';
 
-type PackageJSONPickKey = 'name' | 'author' | 'bugs' | 'description' | 'homepage' | 'keywords' | 'license' | 'readme' | 'readmeFilename' | 'repository' | 'versions';
-
-export type PackageManifestType = Pick<PackageJSONType, PackageJSONPickKey> & {
-  _id: string;
-  _rev: string;
-  'dist-tags': Record<string, string>;
-  versions: Record<string, PackageJSONType | undefined>;
-  maintainers: AuthorType[];
-  time: {
-    created: Date;
-    modified: Date;
-    [key: string]: Date;
-  };
-} & CnpmcorePatchInfo;
-
-export type AbbreviatedPackageManifestType = Pick<PackageManifestType, 'dist-tags' | 'name'> & {
-  modified: Date;
-  versions: Record<string, AbbreviatedPackageJSONType | undefined>;
-  time?: PackageManifestType['time'];
-} & CnpmcorePatchInfo;
-
-
-type CnpmcorePatchInfo = {
-  _cnpmcore_publish_time?: Date;
-  publish_time?: number;
-  _source_registry_name?: string;
-  block?: string;
-};
-
-export type PackageJSONType = CnpmcorePatchInfo & {
-  name: string;
-  version: string;
-  readme?: string;
-  description?: string;
-  keywords?: string[];
-  homepage?: string;
-  bugs?: {
-    url?: string;
-    email?: string;
-  };
-  license?: string;
-  author?: AuthorType | string;
-  contributors?: ContributorType[] | string[];
-  maintainers?: ContributorType[] | string[];
-  files?: string[];
-  main?: string;
-  bin?: string | {
-    [key: string]: string;
-  };
-  man?: string | string[];
-  directories?: DirectoriesType;
-  repository?: RepositoryType;
-  scripts?: Record<string, string>;
-  config?: Record<string, unknown>;
-  dependencies?: DepInfo;
-  devDependencies?: DepInfo;
-  peerDependencies?: DepInfo;
-  peerDependenciesMeta?: {
-    [key: string]: {
-      optional?: boolean;
-      required?: string;
-      version?: string;
-      [key: string]: unknown;
-    };
-  };
-  bundleDependencies?: string[];
-  bundledDependencies?: string[];
-  optionalDependencies?: DepInfo;
-  engines?: {
-    node?: string;
-    npm?: string;
-    [key: string]: string | undefined;
-  };
-  os?: string[];
-  cpu?: string[];
-  preferGlobal?: boolean;
-  private?: boolean;
-  publishConfig?: {
-    access?: 'public' | 'restricted';
-    [key: string]: unknown;
-  };
-  _hasShrinkwrap?: boolean;
-  hasInstallScript?: boolean;
-  dist?: DistType;
-  workspace?: string[];
-  [key: string]: unknown;
-};
-
-type AbbreviatedKey = 'name' | 'version' | 'deprecated' | 'dependencies' | 'optionalDependencies' | 'devDependencies' | 'bundleDependencies' | 'peerDependencies' | 'peerDependenciesMeta' | 'bin' | 'os' | 'cpu' | 'libc' | 'workspaces' | 'directories' | 'dist' | 'engines' | 'hasInstallScript' | 'publish_time' | 'block' | '_hasShrinkwrap';
-export type AbbreviatedPackageJSONType = Pick<PackageJSONType, AbbreviatedKey> & CnpmcorePatchInfo;
-
-type DistType = {
-  tarball: string,
-  size: number,
-  shasum: string,
-  integrity: string,
-  [key: string]: unknown,
-};
-
-type AuthorType = {
-  name: string;
-  email?: string;
-  url?: string;
-};
-
-type ContributorType = {
-  name?: string;
-  email?: string;
-  url?: string;
-  [key: string]: unknown;
-};
-
-type DirectoriesType = {
-  lib?: string;
-  bin?: string;
-  man?: string;
-  test?: string;
-  [key: string]: string | undefined;
-};
-
-type RepositoryType = {
-  type: string;
-  url: string;
-  [key: string]: unknown;
-};
-
-type DepInfo = Record<string, string>;
-
 
 export interface PublishPackageCmd {
   // maintainer: Maintainer;

diff --git a/app/port/controller/package/SavePackageVersionController.ts b/app/port/controller/package/SavePackageVersionController.ts
@@ -18,14 +18,15 @@ import validateNpmPackageName from 'validate-npm-package-name';
 import { Static, Type } from '@sinclair/typebox';
 import { AbstractController } from '../AbstractController';
 import { getScopeAndName, FULLNAME_REG_STRING } from '../../../common/PackageUtil';
-import { PackageJSONType, PackageManagerService } from '../../../core/service/PackageManagerService';
+import { PackageManagerService } from '../../../core/service/PackageManagerService';
 import {
   VersionRule,
   TagWithVersionRule,
   Name as NameType,
   Description as DescriptionType,
 } from '../../typebox';
 import { RegistryManagerService } from '../../../core/service/RegistryManagerService';
+import { PackageJSONType } from '../../../repository/PackageRepository';
 
 type PackageVersion = Simplify<PackageJson.PackageJsonStandard & {
   name: 'string';

diff --git a/app/repository/DistRepository.ts b/app/repository/DistRepository.ts
@@ -1,8 +1,7 @@
 import { AccessLevel, SingletonProto, Inject } from '@eggjs/tegg';
 import { NFSAdapter } from '../common/adapter/NFSAdapter';
-import { PackageRepository } from './PackageRepository';
+import { PackageJSONType, PackageRepository } from './PackageRepository';
 import { Dist } from '../core/entity/Dist';
-import { PackageJSONType } from 'app/core/service/PackageManagerService';
 
 @SingletonProto({
   accessLevel: AccessLevel.PUBLIC,

diff --git a/app/repository/PackageRepository.ts b/app/repository/PackageRepository.ts
@@ -18,6 +18,134 @@ import { AbstractRepository } from './AbstractRepository';
 import { EggAppConfig } from 'egg';
 import { Bone } from 'leoric';
 
+export type PackageManifestType = Pick<PackageJSONType, PackageJSONPickKey> & {
+  _id: string;
+  _rev: string;
+  'dist-tags': Record<string, string>;
+  versions: Record<string, PackageJSONType | undefined>;
+  maintainers: AuthorType[];
+  time: {
+    created: Date;
+    modified: Date;
+    [key: string]: Date;
+  };
+} & CnpmcorePatchInfo;
+
+export type AbbreviatedPackageJSONType = Pick<PackageJSONType, AbbreviatedKey> & CnpmcorePatchInfo;
+
+export type AbbreviatedPackageManifestType = Pick<PackageManifestType, 'dist-tags' | 'name'> & {
+  modified: Date;
+  versions: Record<string, AbbreviatedPackageJSONType | undefined>;
+  time?: PackageManifestType['time'];
+} & CnpmcorePatchInfo;
+
+export type PackageJSONType = CnpmcorePatchInfo & {
+  name: string;
+  version: string;
+  readme?: string;
+  description?: string;
+  keywords?: string[];
+  homepage?: string;
+  bugs?: {
+    url?: string;
+    email?: string;
+  };
+  license?: string;
+  author?: AuthorType | string;
+  contributors?: ContributorType[] | string[];
+  maintainers?: ContributorType[] | string[];
+  files?: string[];
+  main?: string;
+  bin?: string | {
+    [key: string]: string;
+  };
+  man?: string | string[];
+  directories?: DirectoriesType;
+  repository?: RepositoryType;
+  scripts?: Record<string, string>;
+  config?: Record<string, unknown>;
+  dependencies?: DepInfo;
+  devDependencies?: DepInfo;
+  peerDependencies?: DepInfo;
+  peerDependenciesMeta?: {
+    [key: string]: {
+      optional?: boolean;
+      required?: string;
+      version?: string;
+      [key: string]: unknown;
+    };
+  };
+  bundleDependencies?: string[];
+  bundledDependencies?: string[];
+  optionalDependencies?: DepInfo;
+  engines?: {
+    node?: string;
+    npm?: string;
+    [key: string]: string | undefined;
+  };
+  os?: string[];
+  cpu?: string[];
+  preferGlobal?: boolean;
+  private?: boolean;
+  publishConfig?: {
+    access?: 'public' | 'restricted';
+    [key: string]: unknown;
+  };
+  _hasShrinkwrap?: boolean;
+  hasInstallScript?: boolean;
+  dist?: DistType;
+  workspace?: string[];
+  [key: string]: unknown;
+};
+
+type PackageJSONPickKey = 'name' | 'author' | 'bugs' | 'description' | 'homepage' | 'keywords' | 'license' | 'readme' | 'readmeFilename' | 'repository' | 'versions';
+
+type CnpmcorePatchInfo = {
+  _cnpmcore_publish_time?: Date;
+  publish_time?: number;
+  _source_registry_name?: string;
+  block?: string;
+};
+
+type AbbreviatedKey = 'name' | 'version' | 'deprecated' | 'dependencies' | 'optionalDependencies' | 'devDependencies' | 'bundleDependencies' | 'peerDependencies' | 'peerDependenciesMeta' | 'bin' | 'os' | 'cpu' | 'libc' | 'workspaces' | 'directories' | 'dist' | 'engines' | 'hasInstallScript' | 'publish_time' | 'block' | '_hasShrinkwrap';
+
+type DistType = {
+  tarball: string,
+  size: number,
+  shasum: string,
+  integrity: string,
+  [key: string]: unknown,
+};
+
+type AuthorType = {
+  name: string;
+  email?: string;
+  url?: string;
+};
+
+type ContributorType = {
+  name?: string;
+  email?: string;
+  url?: string;
+  [key: string]: unknown;
+};
+
+type DirectoriesType = {
+  lib?: string;
+  bin?: string;
+  man?: string;
+  test?: string;
+  [key: string]: string | undefined;
+};
+
+type RepositoryType = {
+  type: string;
+  url: string;
+  [key: string]: unknown;
+};
+
+type DepInfo = Record<string, string>;
+
 @SingletonProto({
   accessLevel: AccessLevel.PUBLIC,
 })

diff --git a/test/TestUtil.ts b/test/TestUtil.ts
@@ -9,7 +9,7 @@ import path from 'path';
 import crypto from 'crypto';
 import { getScopeAndName } from '../app/common/PackageUtil';
 import semver from 'semver';
-import { PackageJSONType } from 'app/core/service/PackageManagerService';
+import { PackageJSONType } from '../app/repository/PackageRepository';
 
 type PackageOptions = {
   name?: string;

diff --git a/test/port/controller/package/ShowPackageController.test.ts b/test/port/controller/package/ShowPackageController.test.ts
@@ -1,9 +1,9 @@
 import assert from 'assert';
 import { app, mock } from 'egg-mock/bootstrap';
 import { TestUtil } from 'test/TestUtil';
-import { PackageRepository } from '../../../../app/repository/PackageRepository';
+import { PackageManifestType, PackageRepository } from '../../../../app/repository/PackageRepository';
 import { BugVersion } from '../../../../app/core/entity/BugVersion';
-import { PackageManagerService, PackageManifestType } from '../../../../app/core/service/PackageManagerService';
+import { PackageManagerService } from '../../../../app/core/service/PackageManagerService';
 import { CacheService } from '../../../../app/core/service/CacheService';
 import { DistRepository } from '../../../../app/repository/DistRepository';