@xyd-js/core 0.1.0-xyd.9 → 0.1.0-xyd.96
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +537 -0
- package/LICENSE +21 -0
- package/dist/index.d.ts +953 -111
- package/dist/index.js +0 -17
- package/dist/index.js.map +1 -1
- package/index.ts +3 -2
- package/package.json +11 -2
- package/src/types/metadata.ts +123 -0
- package/src/types/seo.ts +475 -0
- package/src/types/settings.ts +547 -231
- package/tsconfig.json +1 -0
- package/tsconfig.tsup.json +6 -0
- package/tsup.config.ts +2 -1
- package/dist/index.d.mts +0 -187
- package/dist/index.mjs +0 -1
- package/dist/index.mjs.map +0 -1
- package/src/types/content.ts +0 -9
package/tsconfig.json
CHANGED
package/tsup.config.ts
CHANGED
|
@@ -2,7 +2,7 @@ import {defineConfig, Options} from 'tsup';
|
|
|
2
2
|
|
|
3
3
|
const config: Options = {
|
|
4
4
|
entry: ['index.ts'],
|
|
5
|
-
format: ['esm'
|
|
5
|
+
format: ['esm'], // Output both ESM and CJS formats
|
|
6
6
|
target: 'node16', // Ensure compatibility with Node.js 16
|
|
7
7
|
dts: {
|
|
8
8
|
entry: 'index.ts', // Specify the entry for DTS
|
|
@@ -16,6 +16,7 @@ const config: Options = {
|
|
|
16
16
|
options.external = ['node:fs/promises']; // Mark 'node:fs/promises' as external
|
|
17
17
|
options.loader = {'.js': 'jsx'}; // Ensure proper handling of .js files
|
|
18
18
|
},
|
|
19
|
+
tsconfig: 'tsconfig.tsup.json',
|
|
19
20
|
ignoreWatch: ['node_modules', 'dist', '.git', 'build'] // Exclude unnecessary directories
|
|
20
21
|
}
|
|
21
22
|
|
package/dist/index.d.mts
DELETED
|
@@ -1,187 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
|
|
3
|
-
interface FrontMatter {
|
|
4
|
-
title: string | {
|
|
5
|
-
title: string;
|
|
6
|
-
code: string;
|
|
7
|
-
};
|
|
8
|
-
group?: string[];
|
|
9
|
-
}
|
|
10
|
-
type PageFrontMatter = {
|
|
11
|
-
[page: string]: FrontMatter;
|
|
12
|
-
};
|
|
13
|
-
|
|
14
|
-
interface Settings {
|
|
15
|
-
styling?: Styling;
|
|
16
|
-
structure?: Structure;
|
|
17
|
-
api?: API;
|
|
18
|
-
integrations?: Integrations;
|
|
19
|
-
redirects?: Redirects[];
|
|
20
|
-
seo?: SEO;
|
|
21
|
-
}
|
|
22
|
-
interface Styling {
|
|
23
|
-
name: string;
|
|
24
|
-
logo?: string | Logo | React.JSX.Element;
|
|
25
|
-
favicon?: string;
|
|
26
|
-
colors?: Colors;
|
|
27
|
-
theme?: ThemeType;
|
|
28
|
-
layout?: LayoutType;
|
|
29
|
-
background?: Background;
|
|
30
|
-
backgroundImage?: string;
|
|
31
|
-
font?: FontDetailsType | {
|
|
32
|
-
headings?: FontDetailsType;
|
|
33
|
-
body?: FontDetailsType;
|
|
34
|
-
};
|
|
35
|
-
modeToggle?: ModeToggle;
|
|
36
|
-
sidebar?: StyleSidebar;
|
|
37
|
-
topbar?: Topbar;
|
|
38
|
-
search?: SearchType;
|
|
39
|
-
rounded?: Rounded;
|
|
40
|
-
}
|
|
41
|
-
interface Logo {
|
|
42
|
-
light?: string;
|
|
43
|
-
dark?: string;
|
|
44
|
-
href?: string;
|
|
45
|
-
}
|
|
46
|
-
interface Colors {
|
|
47
|
-
primary: string;
|
|
48
|
-
light?: string;
|
|
49
|
-
dark?: string;
|
|
50
|
-
background?: {
|
|
51
|
-
light: string;
|
|
52
|
-
dark: string;
|
|
53
|
-
};
|
|
54
|
-
}
|
|
55
|
-
interface Background {
|
|
56
|
-
style?: "gradient" | "grid" | "windows";
|
|
57
|
-
}
|
|
58
|
-
interface FontDetailsType {
|
|
59
|
-
family: string;
|
|
60
|
-
weight?: number;
|
|
61
|
-
url?: string;
|
|
62
|
-
format?: "woff" | "woff2";
|
|
63
|
-
}
|
|
64
|
-
interface ModeToggle {
|
|
65
|
-
default?: "light" | "dark";
|
|
66
|
-
isHidden?: boolean;
|
|
67
|
-
}
|
|
68
|
-
interface StyleSidebar {
|
|
69
|
-
items: "container" | "card" | "border" | "undecorated";
|
|
70
|
-
}
|
|
71
|
-
interface Topbar {
|
|
72
|
-
style: "default" | "gradient";
|
|
73
|
-
}
|
|
74
|
-
type ThemeType = "gusto" | "poetry" | "plato" | "picasso";
|
|
75
|
-
type LayoutType = "app" | "default";
|
|
76
|
-
type SearchType = "side" | "top";
|
|
77
|
-
type Rounded = "default" | "sharp";
|
|
78
|
-
interface Structure {
|
|
79
|
-
sidebar: (SidebarMulti | Sidebar)[];
|
|
80
|
-
header?: Header[];
|
|
81
|
-
topbarCtaButton?: CallToAction;
|
|
82
|
-
versions?: string[];
|
|
83
|
-
anchors?: AnchorRoot;
|
|
84
|
-
footerSocials?: FooterSocials;
|
|
85
|
-
feedback?: Feedback;
|
|
86
|
-
search?: Search;
|
|
87
|
-
}
|
|
88
|
-
interface SidebarMulti {
|
|
89
|
-
match: string;
|
|
90
|
-
items: Sidebar[];
|
|
91
|
-
}
|
|
92
|
-
interface Sidebar {
|
|
93
|
-
group?: string;
|
|
94
|
-
pages?: (string | Sidebar)[];
|
|
95
|
-
icon?: string;
|
|
96
|
-
iconType?: string;
|
|
97
|
-
}
|
|
98
|
-
interface SubHeader {
|
|
99
|
-
match: string;
|
|
100
|
-
name: string;
|
|
101
|
-
items: Header[];
|
|
102
|
-
}
|
|
103
|
-
interface Header {
|
|
104
|
-
name?: string;
|
|
105
|
-
url?: string;
|
|
106
|
-
sub?: SubHeader;
|
|
107
|
-
}
|
|
108
|
-
interface CallToAction {
|
|
109
|
-
type?: "link" | "github";
|
|
110
|
-
url?: string;
|
|
111
|
-
name?: string;
|
|
112
|
-
style?: "pill" | "roundedRectangle";
|
|
113
|
-
arrow?: boolean;
|
|
114
|
-
}
|
|
115
|
-
interface Anchor {
|
|
116
|
-
icon?: string | React.JSX.Element;
|
|
117
|
-
name?: string;
|
|
118
|
-
url?: string;
|
|
119
|
-
}
|
|
120
|
-
interface AnchorRoot {
|
|
121
|
-
bottom: Anchor[];
|
|
122
|
-
}
|
|
123
|
-
interface FooterSocials {
|
|
124
|
-
[key: string]: string;
|
|
125
|
-
property: string;
|
|
126
|
-
}
|
|
127
|
-
interface Feedback {
|
|
128
|
-
thumbsRating?: boolean;
|
|
129
|
-
suggestEdit?: boolean;
|
|
130
|
-
raiseIssue?: boolean;
|
|
131
|
-
}
|
|
132
|
-
interface Search {
|
|
133
|
-
prompt?: string;
|
|
134
|
-
}
|
|
135
|
-
type APIFile = string | string[] | {
|
|
136
|
-
[id: string]: string;
|
|
137
|
-
};
|
|
138
|
-
interface API {
|
|
139
|
-
info?: APIInfo;
|
|
140
|
-
openapi?: APIFile;
|
|
141
|
-
graphql?: APIFile;
|
|
142
|
-
sources?: APIFile;
|
|
143
|
-
match?: {
|
|
144
|
-
graphql?: string;
|
|
145
|
-
openapi?: string;
|
|
146
|
-
};
|
|
147
|
-
}
|
|
148
|
-
interface APIInfo {
|
|
149
|
-
baseUrl?: string;
|
|
150
|
-
auth?: APIAuth;
|
|
151
|
-
name?: string;
|
|
152
|
-
inputPrefix?: string;
|
|
153
|
-
playground?: APIPlayground;
|
|
154
|
-
request?: APIInfoRequest;
|
|
155
|
-
paramFields?: ApiParamFields;
|
|
156
|
-
}
|
|
157
|
-
interface APIAuth {
|
|
158
|
-
method: "bearer" | "basic" | "key";
|
|
159
|
-
}
|
|
160
|
-
interface APIPlayground {
|
|
161
|
-
mode?: "show" | "simple" | "hide";
|
|
162
|
-
}
|
|
163
|
-
interface APIInfoRequest {
|
|
164
|
-
example?: {
|
|
165
|
-
languages?: string[];
|
|
166
|
-
};
|
|
167
|
-
}
|
|
168
|
-
interface ApiParamFields {
|
|
169
|
-
expanded: "all" | "topLevel" | "topLevelOneOfs" | "none";
|
|
170
|
-
}
|
|
171
|
-
interface Integrations {
|
|
172
|
-
analytics?: Analytics;
|
|
173
|
-
}
|
|
174
|
-
interface Analytics {
|
|
175
|
-
livesession: {
|
|
176
|
-
trackId: string;
|
|
177
|
-
};
|
|
178
|
-
}
|
|
179
|
-
interface Redirects {
|
|
180
|
-
source: string;
|
|
181
|
-
destination: string;
|
|
182
|
-
}
|
|
183
|
-
interface SEO {
|
|
184
|
-
indexHiddenPages: boolean;
|
|
185
|
-
}
|
|
186
|
-
|
|
187
|
-
export type { API, APIAuth, APIFile, APIInfo, APIInfoRequest, APIPlayground, Analytics, Anchor, AnchorRoot, ApiParamFields, Background, CallToAction, Colors, Feedback, FontDetailsType, FooterSocials, FrontMatter, Header, Integrations, LayoutType, Logo, ModeToggle, PageFrontMatter, Redirects, Rounded, SEO, Search, SearchType, Settings, Sidebar, SidebarMulti, Structure, StyleSidebar, Styling, SubHeader, ThemeType, Topbar };
|
package/dist/index.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
//# sourceMappingURL=index.mjs.map
|
package/dist/index.mjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|
package/src/types/content.ts
DELETED