@theholocron/registry-doc 1.0.0 → 1.2.0

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/dist/index.d.mts CHANGED
@@ -1,20 +1,24 @@
1
+ import { n as LinksRegistry, t as LinkEntry } from "./types-D_DQs1mo.mjs";
1
2
  //#region src/index.d.ts
2
- type LinkEntry = {
3
- slug: string;
4
- package: string;
5
- docsUrl: string;
6
- npmUrl: string;
7
- githubUrl: string;
8
- sandboxUrl?: string;
9
- };
10
- type LinksRegistry = Record<string, LinkEntry>;
11
3
  declare const getOrg: () => string;
12
4
  declare const getScope: () => string;
13
5
  declare const getDocsBaseUrl: () => string;
14
6
  declare const getGitHubBaseUrl: () => string;
15
- declare const getRegistry: () => LinksRegistry;
7
+ declare const getCli: () => LinksRegistry;
16
8
  declare const getClients: () => LinksRegistry;
9
+ declare const getConfigs: () => LinksRegistry;
10
+ declare const getDocs: () => LinksRegistry;
17
11
  declare const getPlugins: () => LinksRegistry;
18
- declare const getPackage: (_slug: string) => LinkEntry | undefined;
12
+ declare const getSkills: () => LinksRegistry;
13
+ declare const getTemplates: () => LinksRegistry;
14
+ declare const getThemes: () => LinksRegistry;
15
+ declare const getUtils: () => LinksRegistry;
16
+ declare const getHolocron: () => {
17
+ [x: string]: LinkEntry;
18
+ };
19
+ declare const getRegistry: () => {
20
+ [x: string]: LinkEntry;
21
+ };
22
+ declare const getPackage: (slug: string) => LinkEntry;
19
23
  //#endregion
20
- export { LinkEntry, LinksRegistry, getClients, getDocsBaseUrl, getGitHubBaseUrl, getOrg, getPackage, getPlugins, getRegistry, getScope };
24
+ export { type LinkEntry, type LinksRegistry, getCli, getClients, getConfigs, getDocs, getDocsBaseUrl, getGitHubBaseUrl, getHolocron, getOrg, getPackage, getPlugins, getRegistry, getScope, getSkills, getTemplates, getThemes, getUtils };
package/dist/index.mjs CHANGED
@@ -1,14 +1,215 @@
1
+ //#region src/constants.ts
2
+ const ORG = "theholocron";
3
+ const SCOPE = `@${ORG}`;
4
+ const DOCS_BASE = process.env["DOCS_BASE_URL"] ?? "https://docs.theholocron.dev";
5
+ const GITHUB_BASE = `https://github.com/${ORG}`;
6
+ const NPM_BASE = "https://www.npmjs.com/package";
7
+ //#endregion
8
+ //#region src/clients.ts
9
+ const github$6 = `${GITHUB_BASE}/clients`;
10
+ function makeClientEntry(slug, docsPath, sandboxUrl) {
11
+ const pkg = `${SCOPE}/${slug}`;
12
+ return {
13
+ slug,
14
+ package: pkg,
15
+ docsUrl: `${DOCS_BASE}/clients/${docsPath}`,
16
+ npmUrl: `${NPM_BASE}/${pkg}`,
17
+ githubUrl: github$6,
18
+ sandboxUrl
19
+ };
20
+ }
21
+ const clients = {
22
+ "clerk-client": makeClientEntry("clerk-client", "clerk"),
23
+ "cloudflare-client": makeClientEntry("cloudflare-client", "cloudflare"),
24
+ "confluence-client": makeClientEntry("confluence-client", "confluence"),
25
+ "doppler-client": makeClientEntry("doppler-client", "doppler"),
26
+ "github-client": makeClientEntry("github-client", "github"),
27
+ "google-client": makeClientEntry("google-client", "google"),
28
+ "http-client": makeClientEntry("http-client", "http"),
29
+ "infisical-client": makeClientEntry("infisical-client", "infisical"),
30
+ "jira-client": makeClientEntry("jira-client", "jira"),
31
+ "neon-client": makeClientEntry("neon-client", "neon"),
32
+ "posthog-client": makeClientEntry("posthog-client", "posthog"),
33
+ "postman-client": makeClientEntry("postman-client", "postman"),
34
+ "sentry-client": makeClientEntry("sentry-client", "sentry"),
35
+ "vercel-client": makeClientEntry("vercel-client", "vercel"),
36
+ "zendesk-client": makeClientEntry("zendesk-client", "zendesk")
37
+ };
38
+ //#endregion
39
+ //#region src/configs.ts
40
+ const github$5 = `${GITHUB_BASE}/configs`;
41
+ function makeConfigEntry(slug, docsPath) {
42
+ const pkg = `${SCOPE}/${slug}`;
43
+ return {
44
+ slug,
45
+ package: pkg,
46
+ docsUrl: `${DOCS_BASE}/configs/${docsPath}`,
47
+ npmUrl: `${NPM_BASE}/${pkg}`,
48
+ githubUrl: github$5
49
+ };
50
+ }
51
+ const configs = {
52
+ "astro-config": makeConfigEntry("astro-config", "astro"),
53
+ "browserslist-config": makeConfigEntry("browserslist-config", "browserslist"),
54
+ "commitlint-config": makeConfigEntry("commitlint-config", "commitlint"),
55
+ "devmoji-config": makeConfigEntry("devmoji-config", "devmoji"),
56
+ "eslint-config": makeConfigEntry("eslint-config", "eslint"),
57
+ "holocron-config": makeConfigEntry("holocron-config", "holocron"),
58
+ "lighthouse-config": makeConfigEntry("lighthouse-config", "lighthouse"),
59
+ "lint-staged-config": makeConfigEntry("lint-staged-config", "lint-staged"),
60
+ "prettier-config": makeConfigEntry("prettier-config", "prettier"),
61
+ "semantic-release-config": makeConfigEntry("semantic-release-config", "semantic-release"),
62
+ "storybook-config": makeConfigEntry("storybook-config", "storybook"),
63
+ "stylelint-config": makeConfigEntry("stylelint-config", "stylelint"),
64
+ tsconfig: makeConfigEntry("tsconfig", "tsconfig"),
65
+ "tsdown-config": makeConfigEntry("tsdown-config", "tsdown"),
66
+ "vite-config": makeConfigEntry("vite-config", "vite"),
67
+ "vitest-config": makeConfigEntry("vitest-config", "vitest")
68
+ };
69
+ //#endregion
70
+ //#region src/docs.ts
71
+ const github$4 = `${GITHUB_BASE}/docs`;
72
+ function makeDocsEntry(slug, docsPath) {
73
+ const pkg = `${SCOPE}/${slug}`;
74
+ return {
75
+ slug,
76
+ package: pkg,
77
+ docsUrl: `${DOCS_BASE}/docs/${docsPath}`,
78
+ npmUrl: `${NPM_BASE}/${pkg}`,
79
+ githubUrl: github$4
80
+ };
81
+ }
82
+ const docs = { "registry-doc": makeDocsEntry("registry-doc", "registry-doc") };
83
+ //#endregion
84
+ //#region src/holocron.ts
85
+ const github$3 = `${GITHUB_BASE}/holocron`;
86
+ function makeHolocronEntry(slug, docsPath) {
87
+ const pkg = `${SCOPE}/${slug}`;
88
+ return {
89
+ slug,
90
+ package: pkg,
91
+ docsUrl: `${DOCS_BASE}/holocron/${docsPath}`,
92
+ npmUrl: `${NPM_BASE}/${pkg}`,
93
+ githubUrl: github$3
94
+ };
95
+ }
96
+ const cli = { cli: makeHolocronEntry("cli", "cli") };
97
+ const plugins = {
98
+ "holocron-plugin-1password": makeHolocronEntry("holocron-plugin-1password", "plugins/1password"),
99
+ "holocron-plugin-clerk": makeHolocronEntry("holocron-plugin-clerk", "plugins/clerk"),
100
+ "holocron-plugin-cloudflare": makeHolocronEntry("holocron-plugin-cloudflare", "plugins/cloudflare"),
101
+ "holocron-plugin-discord": makeHolocronEntry("holocron-plugin-discord", "plugins/discord"),
102
+ "holocron-plugin-doppler": makeHolocronEntry("holocron-plugin-doppler", "plugins/doppler"),
103
+ "holocron-plugin-github": makeHolocronEntry("holocron-plugin-github", "plugins/github"),
104
+ "holocron-plugin-infisical": makeHolocronEntry("holocron-plugin-infisical", "plugins/infisical"),
105
+ "holocron-plugin-neon": makeHolocronEntry("holocron-plugin-neon", "plugins/neon"),
106
+ "holocron-plugin-posthog": makeHolocronEntry("holocron-plugin-posthog", "plugins/posthog"),
107
+ "holocron-plugin-postman": makeHolocronEntry("holocron-plugin-postman", "plugins/postman"),
108
+ "holocron-plugin-sentry": makeHolocronEntry("holocron-plugin-sentry", "plugins/sentry"),
109
+ "holocron-plugin-slack": makeHolocronEntry("holocron-plugin-slack", "plugins/slack"),
110
+ "holocron-plugin-vercel": makeHolocronEntry("holocron-plugin-vercel", "plugins/vercel")
111
+ };
112
+ //#endregion
113
+ //#region src/skills.ts
114
+ const github$2 = `${GITHUB_BASE}/skills`;
115
+ function makeSkillEntry(slug, docsPath) {
116
+ const pkg = `${SCOPE}/${slug}`;
117
+ return {
118
+ slug,
119
+ package: pkg,
120
+ docsUrl: `${DOCS_BASE}/skills/${docsPath}`,
121
+ npmUrl: `${NPM_BASE}/${pkg}`,
122
+ githubUrl: github$2
123
+ };
124
+ }
125
+ const skills = { skills: makeSkillEntry("skills", "skills") };
126
+ //#endregion
127
+ //#region src/templates.ts
128
+ function makeTemplateEntry(slug, docsPath) {
129
+ const pkg = `${SCOPE}/${slug}`;
130
+ return {
131
+ slug,
132
+ package: pkg,
133
+ docsUrl: `${DOCS_BASE}/templates/${docsPath}`,
134
+ npmUrl: `${NPM_BASE}/${pkg}`,
135
+ githubUrl: `${GITHUB_BASE}/${slug}`
136
+ };
137
+ }
138
+ const templates = {
139
+ "cli-template": makeTemplateEntry("cli-template", "cli"),
140
+ "monorepo-react-template": makeTemplateEntry("monorepo-react-template", "monorepo-react"),
141
+ "monorepo-template": makeTemplateEntry("monorepo-template", "monorepo"),
142
+ "nextjs-template": makeTemplateEntry("nextjs-template", "nextjs"),
143
+ "node-template": makeTemplateEntry("node-template", "node"),
144
+ "react-template": makeTemplateEntry("react-template", "react")
145
+ };
146
+ //#endregion
147
+ //#region src/themes.ts
148
+ const github$1 = `${GITHUB_BASE}/themes`;
149
+ function makeThemeEntry(slug, docsPath) {
150
+ const pkg = `${SCOPE}/${slug}`;
151
+ return {
152
+ slug,
153
+ package: pkg,
154
+ docsUrl: `${DOCS_BASE}/themes/${docsPath}`,
155
+ npmUrl: `${NPM_BASE}/${pkg}`,
156
+ githubUrl: github$1
157
+ };
158
+ }
159
+ const themes = { "docs-theme": makeThemeEntry("docs-theme", "docs") };
160
+ //#endregion
161
+ //#region src/utils.ts
162
+ const github = `${GITHUB_BASE}/utils`;
163
+ function makeUtilEntry(slug, docsPath) {
164
+ const pkg = `${SCOPE}/${slug}`;
165
+ return {
166
+ slug,
167
+ package: pkg,
168
+ docsUrl: `${DOCS_BASE}/utils/${docsPath}`,
169
+ npmUrl: `${NPM_BASE}/${pkg}`,
170
+ githubUrl: github
171
+ };
172
+ }
173
+ const utils = {
174
+ "array-utils": makeUtilEntry("array-utils", "array"),
175
+ "date-time-utils": makeUtilEntry("date-time-utils", "date-time"),
176
+ "env-utils": makeUtilEntry("env-utils", "env"),
177
+ "location-utils": makeUtilEntry("location-utils", "location"),
178
+ "misc-utils": makeUtilEntry("misc-utils", "misc"),
179
+ "storage-utils": makeUtilEntry("storage-utils", "storage"),
180
+ "string-utils": makeUtilEntry("string-utils", "string"),
181
+ "uri-utils": makeUtilEntry("uri-utils", "uri")
182
+ };
183
+ //#endregion
1
184
  //#region src/index.ts
2
- const getOrg = () => "theholocron";
3
- const getScope = () => "@theholocron";
4
- const getDocsBaseUrl = () => process.env["DOCS_BASE_URL"] ?? "https://docs.theholocron.dev";
5
- const getGitHubBaseUrl = () => "https://github.com/theholocron";
185
+ const getOrg = () => ORG;
186
+ const getScope = () => SCOPE;
187
+ const getDocsBaseUrl = () => DOCS_BASE;
188
+ const getGitHubBaseUrl = () => GITHUB_BASE;
189
+ const getCli = () => cli;
190
+ const getClients = () => clients;
191
+ const getConfigs = () => configs;
192
+ const getDocs = () => docs;
193
+ const getPlugins = () => plugins;
194
+ const getSkills = () => skills;
195
+ const getTemplates = () => templates;
196
+ const getThemes = () => themes;
197
+ const getUtils = () => utils;
198
+ const getHolocron = () => ({
199
+ ...cli,
200
+ ...plugins
201
+ });
6
202
  const getRegistry = () => ({
7
- ...getClients(),
8
- ...getPlugins()
203
+ ...clients,
204
+ ...cli,
205
+ ...plugins,
206
+ ...configs,
207
+ ...utils,
208
+ ...themes,
209
+ ...docs,
210
+ ...skills,
211
+ ...templates
9
212
  });
10
- const getClients = () => ({});
11
- const getPlugins = () => ({});
12
- const getPackage = (_slug) => void 0;
213
+ const getPackage = (slug) => getRegistry()[slug];
13
214
  //#endregion
14
- export { getClients, getDocsBaseUrl, getGitHubBaseUrl, getOrg, getPackage, getPlugins, getRegistry, getScope };
215
+ export { getCli, getClients, getConfigs, getDocs, getDocsBaseUrl, getGitHubBaseUrl, getHolocron, getOrg, getPackage, getPlugins, getRegistry, getScope, getSkills, getTemplates, getThemes, getUtils };
@@ -0,0 +1,12 @@
1
+ //#region src/types.d.ts
2
+ type LinkEntry = {
3
+ slug: string;
4
+ package: string;
5
+ docsUrl: string;
6
+ npmUrl: string;
7
+ githubUrl: string;
8
+ sandboxUrl?: string;
9
+ };
10
+ type LinksRegistry = Record<string, LinkEntry>;
11
+ //#endregion
12
+ export { LinksRegistry as n, LinkEntry as t };
@@ -1,4 +1,4 @@
1
- import { LinksRegistry } from "./index.mjs";
1
+ import { n as LinksRegistry } from "./types-D_DQs1mo.mjs";
2
2
  //#region src/validate.d.ts
3
3
  interface ValidationResult {
4
4
  valid: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theholocron/registry-doc",
3
- "version": "1.0.0",
3
+ "version": "1.2.0",
4
4
  "description": "Cross-repo package registry and link utilities for docs.",
5
5
  "homepage": "https://docs.theholocron.dev/docs/registry-doc",
6
6
  "bugs": "https://github.com/theholocron/docs/issues",