UNPKG

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