UNPKG

2.63 kBPlain TextView Raw
1import type { BadgesField } from 'badges'
2import type Fellow from 'fellow'
3import type { Edition } from 'editions'
4
5export interface Link {
6 url: string
7 text: string
8 title?: string
9}
10
11export interface Github {
12 username: string
13 repository: string
14 slug: string
15 url: string
16 repositoryUrl: string
17}
18
19export interface FilenamesForPackageFiles {
20 [key: string]: string | null
21 projectz: string | null
22 package: string | null
23 bower: string | null
24 component: string | null
25 jquery: string | null
26}
27
28export interface DataForPackageFiles {
29 [key: string]: Record<string, any>
30}
31
32export interface FilenamesForReadmeFiles {
33 [key: string]: string | null
34 readme: string | null
35 history: string | null
36 contributing: string | null
37 backers: string | null
38 license: string | null
39}
40
41export interface DataForReadmeFiles {
42 [key: string]: string
43}
44
45export interface PackageEnhanced {
46 name?: string
47 version?: string
48 license?: string
49 description?: string
50 keywords?: string[]
51 author?: string
52 maintainers?: string[]
53 contributors?: string[]
54 bugs?: {
55 url: string
56 }
57 repository?: {
58 type: string
59 url: string
60 }
61 engines?: Record<string, string>
62 dependencies?: Record<string, string>
63 devDependencies?: Record<string, string>
64 main?: string
65}
66
67export interface ComponentEnhanced {
68 name?: string
69 version?: string
70 license?: string
71 description?: string
72 keywords?: string[]
73 demo?: string
74 main?: string
75 scripts?: string
76}
77
78export interface BowerEnhanced {
79 name?: string
80 version?: string
81 license?: string
82 description?: string
83 keywords?: string[]
84 authors?: string[]
85 main?: string
86}
87
88export type Editions = Edition[]
89
90export type EnhancedReadmesData = DataForReadmeFiles
91
92export interface EnhancedPackagesData {
93 [key: string]: any
94 filenamesForPackageFiles: FilenamesForPackageFiles
95 filenamesForReadmeFiles: FilenamesForReadmeFiles
96
97 component: ComponentEnhanced
98 bower: BowerEnhanced
99 jquery: Record<string, any>
100 package: PackageEnhanced
101 projectz: Record<string, any>
102 packages: Record<string, any>
103
104 // merged / enhanced
105 name: string
106 title: string
107 version: string
108 description: string
109 dependencies: Record<string, string>
110 devDependencies: Record<string, string>
111 badges: BadgesField
112 keywords: string[]
113 browsers: boolean
114 editions: Edition[]
115 github?: Github
116 sponsor?: never
117 sponsors: Fellow[]
118 maintainer?: never
119 maintainers: Fellow[]
120 contributors: Fellow[]
121 author?: string
122 authors: Fellow[]
123 license?: string
124 licenses?: never
125 browser?: any
126 jspm?: any
127 homepage?: string
128 repository?: {
129 url: string
130 }
131}
132
133export interface EnhancedPackagesDataWithGitHub extends EnhancedPackagesData {
134 github: Github
135}