| 1 | import { GitRepository } from './git-repository';
|
| 2 | import { Person } from './person';
|
| 3 | import { RawPackageManifest } from './raw-package-manifest';
|
| 4 |
|
| 5 | /**
|
| 6 | * `PackageManifest` represents the manifest describing a specific version
|
| 7 | * of a package.
|
| 8 | *
|
| 9 | * @remarks
|
| 10 | * For some packages, especially legacy ones,
|
| 11 | * the properties may be mistyped due to incorrect data present on the registry.
|
| 12 | *
|
| 13 | * @see {@link RawPackageManifest}
|
| 14 | */
|
| 15 | export interface PackageManifest extends RawPackageManifest {
|
| 16 | /** Package version ID (for example, `foo@1.0.0` or `@bar/baz@1.0.0`) */
|
| 17 | readonly id: string;
|
| 18 |
|
| 19 | /** Publishing timestamp */
|
| 20 | readonly createdAt: string;
|
| 21 |
|
| 22 | /**
|
| 23 | * User who published this version of the package
|
| 24 | *
|
| 25 | * @see {@link Person}
|
| 26 | */
|
| 27 | readonly publisher: Person;
|
| 28 |
|
| 29 | /** Normalized license */
|
| 30 | readonly license?: string;
|
| 31 |
|
| 32 | /** Normalized git repository */
|
| 33 | readonly gitRepository?: GitRepository;
|
| 34 |
|
| 35 | /** Name of the corresponding DefinitelyTyped package, if any */
|
| 36 | readonly definitelyTypedName?: string;
|
| 37 |
|
| 38 | /** Name of the corresponding untyped package (w.r.t. DefinitelyTyped) */
|
| 39 | readonly untypedName?: string;
|
| 40 | }
|