@grove-dev/core 0.3.2 → 0.4.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/README.md +58 -0
- package/dist/audit.d.ts +43 -0
- package/dist/audit.d.ts.map +1 -0
- package/dist/audit.js +26 -0
- package/dist/audit.js.map +1 -0
- package/dist/build-data.d.ts.map +1 -1
- package/dist/build-data.js +1 -0
- package/dist/build-data.js.map +1 -1
- package/dist/collections.d.ts +72 -0
- package/dist/collections.d.ts.map +1 -0
- package/dist/collections.js +83 -0
- package/dist/collections.js.map +1 -0
- package/dist/collector.d.ts +10 -0
- package/dist/collector.d.ts.map +1 -0
- package/dist/collector.js +9 -0
- package/dist/collector.js.map +1 -0
- package/dist/contributors.d.ts.map +1 -1
- package/dist/contributors.js +21 -16
- package/dist/contributors.js.map +1 -1
- package/dist/directory-taxonomy.d.ts +8 -0
- package/dist/directory-taxonomy.d.ts.map +1 -1
- package/dist/directory-taxonomy.js +15 -1
- package/dist/directory-taxonomy.js.map +1 -1
- package/dist/github.d.ts +13 -0
- package/dist/github.d.ts.map +1 -1
- package/dist/github.js +50 -0
- package/dist/github.js.map +1 -1
- package/dist/index.d.ts +14 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +18 -2
- package/dist/index.js.map +1 -1
- package/dist/llms.d.ts +24 -0
- package/dist/llms.d.ts.map +1 -1
- package/dist/llms.js +62 -25
- package/dist/llms.js.map +1 -1
- package/dist/page-document.d.ts +126 -0
- package/dist/page-document.d.ts.map +1 -0
- package/dist/page-document.js +201 -0
- package/dist/page-document.js.map +1 -0
- package/dist/prepare.d.ts +2 -0
- package/dist/prepare.d.ts.map +1 -1
- package/dist/prepare.js +4 -1
- package/dist/prepare.js.map +1 -1
- package/dist/related.d.ts +3 -0
- package/dist/related.d.ts.map +1 -0
- package/dist/related.js +18 -0
- package/dist/related.js.map +1 -0
- package/dist/robots.d.ts +6 -0
- package/dist/robots.d.ts.map +1 -0
- package/dist/robots.js +21 -0
- package/dist/robots.js.map +1 -0
- package/dist/schema.d.ts +49 -0
- package/dist/schema.d.ts.map +1 -1
- package/dist/schema.js +38 -0
- package/dist/schema.js.map +1 -1
- package/dist/site-artifacts.d.ts +14 -0
- package/dist/site-artifacts.d.ts.map +1 -0
- package/dist/site-artifacts.js +92 -0
- package/dist/site-artifacts.js.map +1 -0
- package/dist/sitemap.d.ts +7 -0
- package/dist/sitemap.d.ts.map +1 -1
- package/dist/sitemap.js +18 -0
- package/dist/sitemap.js.map +1 -1
- package/package.json +1 -1
package/dist/github.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"github.js","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,kBAAkB,CAAC,GAAuB;IACxD,IAAI,CAAC,GAAG;QAAE,OAAO,SAAS,CAAC;IAC3B,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;IACzF,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACvB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACtB,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IACtC,OAAO;QACL,KAAK;QACL,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;KACjC,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,IAAY,EAAE,KAAc;IACpD,MAAM,OAAO,GAA2B;QACtC,MAAM,EAAE,6BAA6B;QACrC,sBAAsB,EAAE,YAAY;QACpC,YAAY,EAAE,OAAO;KACtB,CAAC;IACF,IAAI,KAAK;QAAE,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAC;IAErD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,yBAAyB,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3E,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,CAAC;IACzC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,KAAK,GAAG,EAAE,CAAC;QACrF,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;IACxF,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,cAAc,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,QAAQ,IAAI,EAAE,CAAC,CAAC;IACtF,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAgC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC7G,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,GAAkB,EAAE,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY;IAC5F,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,UAAU,CAAC,UAAU,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;IAClF,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAErD,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,UAAU,CAAC,UAAU,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,kBAAkB,EAAE,KAAK,CAAC,CAAC,CAAC;IAC3G,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEvC,OAAO;QACL,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;QAClC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;QAC3C,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QACtC,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC;QAC5C,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QAChC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QAChC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI;QAC1C,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI;QAC5C,eAAe,EAAE,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,IAAI;QAC7D,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI;QACpE,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;QACnH,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI;QACzC,aAAa,EAAE,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"github.js","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,kBAAkB,CAAC,GAAuB;IACxD,IAAI,CAAC,GAAG;QAAE,OAAO,SAAS,CAAC;IAC3B,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;IACzF,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACvB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACtB,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IACtC,OAAO;QACL,KAAK;QACL,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;KACjC,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,IAAY,EAAE,KAAc;IACpD,MAAM,OAAO,GAA2B;QACtC,MAAM,EAAE,6BAA6B;QACrC,sBAAsB,EAAE,YAAY;QACpC,YAAY,EAAE,OAAO;KACtB,CAAC;IACF,IAAI,KAAK;QAAE,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAC;IAErD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,yBAAyB,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3E,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,CAAC;IACzC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,KAAK,GAAG,EAAE,CAAC;QACrF,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;IACxF,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,cAAc,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,QAAQ,IAAI,EAAE,CAAC,CAAC;IACtF,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAgC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC7G,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,GAAkB,EAAE,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY;IAC5F,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,UAAU,CAAC,UAAU,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;IAClF,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAErD,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,UAAU,CAAC,UAAU,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,kBAAkB,EAAE,KAAK,CAAC,CAAC,CAAC;IAC3G,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEvC,OAAO;QACL,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;QAClC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;QAC3C,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QACtC,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC;QAC5C,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC;QACvC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QAChC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QAChC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;QAC9B,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;QACxB,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;QACrC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI;QAC1C,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI;QAC5C,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI;QAC5C,eAAe,EAAE,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,IAAI;QAC7D,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI;QACpE,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;QACnH,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI;QACzC,aAAa,EAAE,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC;QAC5C,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;QAChC,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;QACvC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;QACjC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;KAC1B,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAAwB,EACxB,cAAmD;IAEnD,MAAM,kBAAkB,GAAI,cAAc,EAAE,UAAkD,IAAI,EAAE,CAAC;IACrG,MAAM,KAAK,GAA4B;QACrC,UAAU,EAAE;YACV,GAAG,kBAAkB;YACrB,SAAS,EAAE,QAAQ,CAAC,QAAQ;YAC5B,gBAAgB,EAAE,QAAQ,CAAC,KAAK;YAChC,WAAW,EAAE,QAAQ,CAAC,KAAK;YAC3B,iBAAiB,EAAE,QAAQ,CAAC,UAAU;YACtC,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,SAAS,EAAE,QAAQ,CAAC,QAAQ;YAC5B,UAAU,EAAE,QAAQ,CAAC,SAAS;YAC9B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,cAAc,EAAE,QAAQ,CAAC,aAAa;YACtC,OAAO,EAAE,QAAQ,CAAC,OAAO;gBACvB,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE;gBACvD,CAAC,CAAC,IAAI;YACR,MAAM,EAAE,QAAQ,CAAC,MAAM;SACxB;KACF,CAAC;IACF,IAAI,QAAQ,CAAC,eAAe,EAAE,CAAC;QAC7B,KAAK,CAAC,eAAe,GAAG,QAAQ,CAAC,eAAe,CAAC;IACnD,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACtB,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;IACrC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
*/
|
|
10
10
|
export { defineConfig, loadConfig } from "./config.js";
|
|
11
11
|
export type { GroveConfig, GroveConfigInput } from "./schema.js";
|
|
12
|
-
export { blueprintSchema, resourceKindSchema, healthStatusSchema, healthTierSchema, healthBlockSchema, healthEntrySchema, healthFileSchema, decisionSchema, decisionsFileSchema, overrideSchema, overridesFileSchema, projectRecordSchema, resourceRecordSchema, entityRecordSchema, resourceSchema, recordsFileSchema, projectTypeSchema, resourceTypeSchema, entityTypeSchema, appLabelSchema, scoreSchema, linksSchema, githubRepositorySchema, githubMetadataSchema, githubLicenseSchema, blueprintKind, } from "./schema.js";
|
|
12
|
+
export { blueprintSchema, resourceKindSchema, healthStatusSchema, healthTierSchema, healthBlockSchema, healthEntrySchema, healthFileSchema, decisionSchema, decisionsFileSchema, overrideSchema, overridesFileSchema, projectRecordSchema, resourceRecordSchema, entityRecordSchema, resourceSchema, recordsFileSchema, projectTypeSchema, resourceTypeSchema, entityTypeSchema, appLabelSchema, scoreSchema, linksSchema, githubRepositorySchema, githubMetadataSchema, githubLicenseSchema, blueprintKind, auditSchema, } from "./schema.js";
|
|
13
13
|
export type { Blueprint, ResourceKind, DecisionVisibility, Resource, ProjectRecord, ResourceRecord, EntityRecord, IndexRecord, IndexProjectRecord, IndexResourceRecord, IndexEntityRecord, HealthStatus, HealthTier, HealthEntry, HealthFile, Decision, DecisionsFile, Override, OverridesFile, ProjectType, ResourceType, EntityType, AppLabel, Score, Links, GithubMetadata, GithubRepository, } from "./schema.js";
|
|
14
14
|
export { generate } from "./build-data.js";
|
|
15
15
|
export type { GenerateResult, RecordsFullPayload, RecordsIndexPayload } from "./build-data.js";
|
|
@@ -19,9 +19,11 @@ export { stringifyRecordYaml } from "./schema.js";
|
|
|
19
19
|
export { buildSitemap, buildSitemapXml } from "./sitemap.js";
|
|
20
20
|
export { buildLlmsTxt, buildLlmsFullTxt, buildLlmsFiles } from "./llms.js";
|
|
21
21
|
export type { LlmsInput, LlmsRecordInput, LlmsResult } from "./llms.js";
|
|
22
|
+
export { buildOgImageSvg, buildSiteArtifacts } from "./site-artifacts.js";
|
|
23
|
+
export type { SiteArtifactStats, SiteArtifactsResult, } from "./site-artifacts.js";
|
|
22
24
|
export { pickCleanupCandidates, cleanupStale } from "./decisions.js";
|
|
23
25
|
export type { CleanupCandidate, CleanupReport } from "./decisions.js";
|
|
24
|
-
export { parseGithubRepoUrl, fetchGithubMetadata } from "./github.js";
|
|
26
|
+
export { parseGithubRepoUrl, fetchGithubMetadata, buildGithubSyncPatch } from "./github.js";
|
|
25
27
|
export type { GithubRepoRef } from "./github.js";
|
|
26
28
|
export { enrichFromGithubHtml } from "./enrich.js";
|
|
27
29
|
export type { EnrichedFields, EnrichResult } from "./enrich.js";
|
|
@@ -45,4 +47,14 @@ export * from "./directory-repo.js";
|
|
|
45
47
|
export * from "./directory-scores.js";
|
|
46
48
|
export * from "./directory-search.js";
|
|
47
49
|
export * from "./directory-taxonomy.js";
|
|
50
|
+
export { DEFAULT_BUDGET, evaluateBudget, } from "./audit.js";
|
|
51
|
+
export type { PageType, Profile, PageManifestEntry, LighthouseScores, LighthouseMetrics, AuditResult, BudgetConfig, BudgetViolation, } from "./audit.js";
|
|
52
|
+
export { definePageDocument, siteSchema, collectionSchema, recordSchema, contentSchema, buildJsonLd, validateJsonLd, } from "./page-document.js";
|
|
53
|
+
export type { DocumentPageType, OpenGraphMetadata, TwitterMetadata, PageMetadata, LinkedDocument, JsonLdNode, PageDiscovery, PageIdentity, PageDocument, Crumb, SiteInput, CollectionInput, RecordInput, ContentInput, JsonLdValidationIssue, } from "./page-document.js";
|
|
54
|
+
export { buildRobotsTxt, isIndexableFilterPath } from "./robots.js";
|
|
55
|
+
export { filterEntries, rankEntries, } from "./collections.js";
|
|
56
|
+
export type { CollectionKind, RankingPreset, CollectionQuery, CollectionRanking, CollectionEditorial, CollectionSeo, Collection, CollectionEntry, } from "./collections.js";
|
|
57
|
+
export { runCollection } from "./collector.js";
|
|
58
|
+
export type { CollectionResult } from "./collector.js";
|
|
59
|
+
export { findRelated } from "./related.js";
|
|
48
60
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACvD,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGjE,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,WAAW,EACX,sBAAsB,EACtB,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACvD,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGjE,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,WAAW,EACX,sBAAsB,EACtB,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,EACb,WAAW,GACZ,MAAM,aAAa,CAAC;AAGrB,YAAY,EACV,SAAS,EACT,YAAY,EACZ,kBAAkB,EAClB,QAAQ,EACR,aAAa,EACb,cAAc,EACd,YAAY,EACZ,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,WAAW,EACX,UAAU,EACV,QAAQ,EACR,aAAa,EACb,QAAQ,EACR,aAAa,EACb,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,KAAK,EACL,KAAK,EACL,cAAc,EACd,gBAAgB,GACjB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,YAAY,EAAE,cAAc,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC/F,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,YAAY,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAG3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAGlD,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAG7D,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3E,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAGxE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC1E,YAAY,EACV,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACrE,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAGtE,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC5F,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAGjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAGhE,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAG5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,YAAY,EACV,WAAW,EACX,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGzD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAG7C,OAAO,EACL,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,eAAe,CAAC;AACvB,YAAY,EACV,cAAc,EACd,aAAa,EACb,YAAY,GACb,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC7D,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGnE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAOrE,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAM3F,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AAExC,OAAO,EACL,cAAc,EACd,cAAc,GACf,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,QAAQ,EACR,OAAO,EACP,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,eAAe,GAChB,MAAM,YAAY,CAAC;AAOpB,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,WAAW,EACX,cAAc,GACf,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EACV,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,UAAU,EACV,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,KAAK,EACL,SAAS,EACT,eAAe,EACf,WAAW,EACX,YAAY,EACZ,qBAAqB,GACtB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAGpE,OAAO,EACL,aAAa,EACb,WAAW,GACZ,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,cAAc,EACd,aAAa,EACb,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,aAAa,EACb,UAAU,EACV,eAAe,GAChB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,YAAY,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
// ── Config ────────────────────────────────────────────────────────────
|
|
11
11
|
export { defineConfig, loadConfig } from "./config.js";
|
|
12
12
|
// ── Schemas (Zod) ─────────────────────────────────────────────────────
|
|
13
|
-
export { blueprintSchema, resourceKindSchema, healthStatusSchema, healthTierSchema, healthBlockSchema, healthEntrySchema, healthFileSchema, decisionSchema, decisionsFileSchema, overrideSchema, overridesFileSchema, projectRecordSchema, resourceRecordSchema, entityRecordSchema, resourceSchema, recordsFileSchema, projectTypeSchema, resourceTypeSchema, entityTypeSchema, appLabelSchema, scoreSchema, linksSchema, githubRepositorySchema, githubMetadataSchema, githubLicenseSchema, blueprintKind, } from "./schema.js";
|
|
13
|
+
export { blueprintSchema, resourceKindSchema, healthStatusSchema, healthTierSchema, healthBlockSchema, healthEntrySchema, healthFileSchema, decisionSchema, decisionsFileSchema, overrideSchema, overridesFileSchema, projectRecordSchema, resourceRecordSchema, entityRecordSchema, resourceSchema, recordsFileSchema, projectTypeSchema, resourceTypeSchema, entityTypeSchema, appLabelSchema, scoreSchema, linksSchema, githubRepositorySchema, githubMetadataSchema, githubLicenseSchema, blueprintKind, auditSchema, } from "./schema.js";
|
|
14
14
|
// ── Build pipeline ───────────────────────────────────────────────────
|
|
15
15
|
export { generate } from "./build-data.js";
|
|
16
16
|
export { prepareDirectory } from "./prepare.js";
|
|
@@ -20,10 +20,12 @@ export { stringifyRecordYaml } from "./schema.js";
|
|
|
20
20
|
export { buildSitemap, buildSitemapXml } from "./sitemap.js";
|
|
21
21
|
// ── llms.txt ─────────────────────────────────────────────────────────
|
|
22
22
|
export { buildLlmsTxt, buildLlmsFullTxt, buildLlmsFiles } from "./llms.js";
|
|
23
|
+
// ── Config-driven public artifacts ──────────────────────────────────
|
|
24
|
+
export { buildOgImageSvg, buildSiteArtifacts } from "./site-artifacts.js";
|
|
23
25
|
// ── Cleanup ──────────────────────────────────────────────────────────
|
|
24
26
|
export { pickCleanupCandidates, cleanupStale } from "./decisions.js";
|
|
25
27
|
// ── GitHub: parsing + REST metadata ──────────────────────────────────
|
|
26
|
-
export { parseGithubRepoUrl, fetchGithubMetadata } from "./github.js";
|
|
28
|
+
export { parseGithubRepoUrl, fetchGithubMetadata, buildGithubSyncPatch } from "./github.js";
|
|
27
29
|
// ── GitHub: HTML enrichment (token-free fallback) ────────────────────
|
|
28
30
|
export { enrichFromGithubHtml } from "./enrich.js";
|
|
29
31
|
// ── GitHub: client helpers (V1 public subset) ────────────────────────
|
|
@@ -55,4 +57,18 @@ export * from "./directory-repo.js";
|
|
|
55
57
|
export * from "./directory-scores.js";
|
|
56
58
|
export * from "./directory-search.js";
|
|
57
59
|
export * from "./directory-taxonomy.js";
|
|
60
|
+
export { DEFAULT_BUDGET, evaluateBudget, } from "./audit.js";
|
|
61
|
+
// ── PageDocument: unified page-level contract + JSON-LD registry ────
|
|
62
|
+
// Every page in a Grove project declares a `PageDocument` and the
|
|
63
|
+
// framework emits all SEO metadata (title, description, canonical, OG,
|
|
64
|
+
// Twitter, JSON-LD) from this single source. `validateJsonLd` is the
|
|
65
|
+
// build-time well-formedness check that runs over the node graph.
|
|
66
|
+
export { definePageDocument, siteSchema, collectionSchema, recordSchema, contentSchema, buildJsonLd, validateJsonLd, } from "./page-document.js";
|
|
67
|
+
// ── Robots + filter URL policy ───────────────────────────────────────
|
|
68
|
+
export { buildRobotsTxt, isIndexableFilterPath } from "./robots.js";
|
|
69
|
+
// ── Collection engine (query, ranking, editorial) ────────────────────
|
|
70
|
+
export { filterEntries, rankEntries, } from "./collections.js";
|
|
71
|
+
// ── Collection runner + related resolver ─────────────────────────────
|
|
72
|
+
export { runCollection } from "./collector.js";
|
|
73
|
+
export { findRelated } from "./related.js";
|
|
58
74
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,yEAAyE;AACzE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGvD,yEAAyE;AACzE,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,WAAW,EACX,sBAAsB,EACtB,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,yEAAyE;AACzE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGvD,yEAAyE;AACzE,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,WAAW,EACX,sBAAsB,EACtB,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,EACb,WAAW,GACZ,MAAM,aAAa,CAAC;AAiCrB,wEAAwE;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAGhD,uEAAuE;AACvE,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,wEAAwE;AACxE,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE7D,wEAAwE;AACxE,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAG3E,uEAAuE;AACvE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAM1E,wEAAwE;AACxE,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGrE,wEAAwE;AACxE,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAG5F,wEAAwE;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGnD,wEAAwE;AACxE,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAE5D,yEAAyE;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAQrD,yEAAyE;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,wEAAwE;AACxE,OAAO,EACL,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,eAAe,CAAC;AAMvB,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAG7D,yEAAyE;AACzE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAErE,yEAAyE;AACzE,2EAA2E;AAC3E,mEAAmE;AACnE,iEAAiE;AACjE,uDAAuD;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGhD,uEAAuE;AACvE,mEAAmE;AACnE,wEAAwE;AACxE,oDAAoD;AACpD,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AAExC,OAAO,EACL,cAAc,EACd,cAAc,GACf,MAAM,YAAY,CAAC;AAYpB,uEAAuE;AACvE,kEAAkE;AAClE,uEAAuE;AACvE,qEAAqE;AACrE,kEAAkE;AAClE,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,WAAW,EACX,cAAc,GACf,MAAM,oBAAoB,CAAC;AAmB5B,wEAAwE;AACxE,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEpE,wEAAwE;AACxE,OAAO,EACL,aAAa,EACb,WAAW,GACZ,MAAM,kBAAkB,CAAC;AAY1B,wEAAwE;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}
|
package/dist/llms.d.ts
CHANGED
|
@@ -25,6 +25,30 @@ export interface LlmsResult {
|
|
|
25
25
|
indexed: number;
|
|
26
26
|
}
|
|
27
27
|
export declare function buildLlmsTxt(input: LlmsInput, config: GroveConfig): string;
|
|
28
|
+
export interface LlmsFullSite {
|
|
29
|
+
name: string;
|
|
30
|
+
url: string;
|
|
31
|
+
description: string;
|
|
32
|
+
}
|
|
33
|
+
export interface LlmsFullRecord {
|
|
34
|
+
url: string;
|
|
35
|
+
title: string;
|
|
36
|
+
description: string;
|
|
37
|
+
stack?: string;
|
|
38
|
+
license?: string;
|
|
39
|
+
}
|
|
40
|
+
interface LlmsFullCatalogInput {
|
|
41
|
+
site: LlmsFullSite;
|
|
42
|
+
records: LlmsFullRecord[];
|
|
43
|
+
taxonomies: Array<{
|
|
44
|
+
url: string;
|
|
45
|
+
title: string;
|
|
46
|
+
description?: string;
|
|
47
|
+
}>;
|
|
48
|
+
updatedAt: string;
|
|
49
|
+
}
|
|
28
50
|
export declare function buildLlmsFullTxt(input: LlmsInput, config: GroveConfig): string;
|
|
51
|
+
export declare function buildLlmsFullTxt(input: LlmsFullCatalogInput): string;
|
|
29
52
|
export declare function buildLlmsFiles(input: LlmsInput, cwd?: string, config?: GroveConfig): Promise<LlmsResult>;
|
|
53
|
+
export {};
|
|
30
54
|
//# sourceMappingURL=llms.d.ts.map
|
package/dist/llms.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"llms.d.ts","sourceRoot":"","sources":["../src/llms.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,WAAW,EAAc,MAAM,aAAa,CAAC;AAG3D,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAsED,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAG,MAAM,CAkB1E;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAG,MAAM,
|
|
1
|
+
{"version":3,"file":"llms.d.ts","sourceRoot":"","sources":["../src/llms.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,WAAW,EAAc,MAAM,aAAa,CAAC;AAG3D,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAsED,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAG,MAAM,CAkB1E;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,oBAAoB;IAC5B,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,UAAU,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACxE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC;AAChF,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,oBAAoB,GAAG,MAAM,CAAC;AAqEtE,wBAAsB,cAAc,CAClC,KAAK,EAAE,SAAS,EAChB,GAAG,SAAgB,EACnB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,UAAU,CAAC,CAerB"}
|
package/dist/llms.js
CHANGED
|
@@ -76,31 +76,68 @@ Use /llms-full.txt for record-level details. Prefer detail pages for citations.
|
|
|
76
76
|
`;
|
|
77
77
|
}
|
|
78
78
|
export function buildLlmsFullTxt(input, config) {
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
.
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
79
|
+
// Discriminate on input shape rather than `config` presence: a caller that
|
|
80
|
+
// mistakenly passes a catalog-shaped input alongside a config would otherwise
|
|
81
|
+
// be routed into the legacy path and crash on missing legacy fields.
|
|
82
|
+
if ("generatedAt" in input) {
|
|
83
|
+
const legacyInput = input;
|
|
84
|
+
const siteUrl = (legacyInput.siteUrl ?? config?.site.url ?? "").replace(/\/$/, "");
|
|
85
|
+
const indexSlug = config ? directorySlug(config) : "items";
|
|
86
|
+
const visible = legacyInput.records.filter((r) => r.visibility !== "hide" && r.visibility !== "remove");
|
|
87
|
+
const plural = config ? pluralLabel(config) : "Records";
|
|
88
|
+
const index = visible.map(buildIndexLine).join("\n");
|
|
89
|
+
const sections = visible
|
|
90
|
+
.map((record) => buildDetailSection(record, siteUrl, indexSlug))
|
|
91
|
+
.join("\n\n");
|
|
92
|
+
return [
|
|
93
|
+
`# ${config?.site.name ?? legacyInput.siteUrl ?? "Directory"} — full directory`,
|
|
94
|
+
"",
|
|
95
|
+
`> Generated ${legacyInput.generatedAt} from ${legacyInput.records.length} records.`,
|
|
96
|
+
`> Source: ${siteUrl}/${indexSlug} · Regenerate with \`pnpm build\`.`,
|
|
97
|
+
"",
|
|
98
|
+
"Each section below mirrors one record detail page.",
|
|
99
|
+
"",
|
|
100
|
+
"## Index",
|
|
101
|
+
"",
|
|
102
|
+
index,
|
|
103
|
+
"",
|
|
104
|
+
sections ? `## ${plural}` : "",
|
|
105
|
+
"",
|
|
106
|
+
sections,
|
|
107
|
+
"",
|
|
108
|
+
].join("\n");
|
|
109
|
+
}
|
|
110
|
+
const catalogInput = input;
|
|
111
|
+
const lines = [];
|
|
112
|
+
lines.push(`# ${catalogInput.site.name} — full catalog`);
|
|
113
|
+
lines.push("");
|
|
114
|
+
lines.push(`> ${catalogInput.site.description}`);
|
|
115
|
+
lines.push(`Updated: ${catalogInput.updatedAt}`);
|
|
116
|
+
lines.push("");
|
|
117
|
+
lines.push(`Site: ${catalogInput.site.url}`);
|
|
118
|
+
lines.push("");
|
|
119
|
+
lines.push("## Taxonomies");
|
|
120
|
+
for (const taxonomy of catalogInput.taxonomies) {
|
|
121
|
+
lines.push(`### ${taxonomy.title}`);
|
|
122
|
+
lines.push("");
|
|
123
|
+
if (taxonomy.description)
|
|
124
|
+
lines.push(taxonomy.description);
|
|
125
|
+
lines.push(`URL: ${taxonomy.url}`);
|
|
126
|
+
lines.push("");
|
|
127
|
+
}
|
|
128
|
+
lines.push("## Records");
|
|
129
|
+
for (const record of catalogInput.records) {
|
|
130
|
+
lines.push(`### ${record.title}`);
|
|
131
|
+
lines.push("");
|
|
132
|
+
lines.push(record.description);
|
|
133
|
+
if (record.stack)
|
|
134
|
+
lines.push(`Stack: ${record.stack}`);
|
|
135
|
+
if (record.license)
|
|
136
|
+
lines.push(`License: ${record.license}`);
|
|
137
|
+
lines.push(`URL: ${record.url}`);
|
|
138
|
+
lines.push("");
|
|
139
|
+
}
|
|
140
|
+
return lines.join("\n");
|
|
104
141
|
}
|
|
105
142
|
export async function buildLlmsFiles(input, cwd = process.cwd(), config) {
|
|
106
143
|
const cfg = config ?? (await loadConfig(cwd));
|
package/dist/llms.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"llms.js","sourceRoot":"","sources":["../src/llms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAoB,UAAU,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA8BpC,MAAM,eAAe,GAA2B;IAC9C,mBAAmB,EAAE,UAAU;IAC/B,cAAc,EAAE,WAAW;IAC3B,eAAe,EAAE,UAAU;CAC5B,CAAC;AAEF,MAAM,gBAAgB,GAA2B;IAC/C,mBAAmB,EAAE,UAAU;IAC/B,cAAc,EAAE,WAAW;IAC3B,eAAe,EAAE,UAAU;CAC5B,CAAC;AAEF,SAAS,aAAa,CAAC,MAAmB;IACxC,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,IAAI,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC;AACjF,CAAC;AAED,SAAS,WAAW,CAAC,MAAmB;IACtC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC;IACpF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED,SAAS,IAAI,CAAC,KAAa;IACzB,qEAAqE;IACrE,gEAAgE;IAChE,iEAAiE;IACjE,wCAAwC;IACxC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAChC,CAAC;AAED,SAAS,QAAQ,CAAC,KAAa,EAAE,GAAW;IAC1C,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,cAAc,CAAC,MAAuB;IAC7C,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;IACrD,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;IACnC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,GAAG,CAAC;IAClC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC;IAChC,OAAO,MAAM,MAAM,CAAC,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,MAAM,KAAK,MAAM,KAAK,OAAO,IAAI,EAAE,CAAC;AAC/F,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAuB,EACvB,OAAe,EACf,SAAiB;IAEjB,MAAM,KAAK,GAAa;QACtB,OAAO,MAAM,CAAC,IAAI,EAAE;QACpB,EAAE;QACF,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE;QACjD,EAAE;QACF,WAAW,MAAM,CAAC,IAAI,EAAE;QACxB,eAAe,MAAM,CAAC,QAAQ,IAAI,GAAG,EAAE;QACvC,YAAY,MAAM,CAAC,KAAK,IAAI,GAAG,EAAE;QACjC,YAAY,MAAM,CAAC,KAAK,IAAI,CAAC,EAAE;QAC/B,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;QACpD,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;QACjD,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,eAAe,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE;QAC7D,UAAU,OAAO,IAAI,SAAS,IAAI,MAAM,CAAC,IAAI,EAAE;QAC/C,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;QAC9E,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;KAChE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAClB,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAgB,EAAE,MAAmB;IAChE,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5E,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAClC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,MAAM,IAAI,CAAC,CAAC,UAAU,KAAK,QAAQ,CAC5D,CAAC;IACF,OAAO,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI;;EAE5B,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO;;aAEnC,OAAO,IAAI,SAAS;mBACd,OAAO,CAAC,MAAM;cACnB,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;;;;;CAKzE,CAAC;AACF,CAAC;
|
|
1
|
+
{"version":3,"file":"llms.js","sourceRoot":"","sources":["../src/llms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAoB,UAAU,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA8BpC,MAAM,eAAe,GAA2B;IAC9C,mBAAmB,EAAE,UAAU;IAC/B,cAAc,EAAE,WAAW;IAC3B,eAAe,EAAE,UAAU;CAC5B,CAAC;AAEF,MAAM,gBAAgB,GAA2B;IAC/C,mBAAmB,EAAE,UAAU;IAC/B,cAAc,EAAE,WAAW;IAC3B,eAAe,EAAE,UAAU;CAC5B,CAAC;AAEF,SAAS,aAAa,CAAC,MAAmB;IACxC,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,IAAI,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC;AACjF,CAAC;AAED,SAAS,WAAW,CAAC,MAAmB;IACtC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC;IACpF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED,SAAS,IAAI,CAAC,KAAa;IACzB,qEAAqE;IACrE,gEAAgE;IAChE,iEAAiE;IACjE,wCAAwC;IACxC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAChC,CAAC;AAED,SAAS,QAAQ,CAAC,KAAa,EAAE,GAAW;IAC1C,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,cAAc,CAAC,MAAuB;IAC7C,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;IACrD,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;IACnC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,GAAG,CAAC;IAClC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC;IAChC,OAAO,MAAM,MAAM,CAAC,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,MAAM,KAAK,MAAM,KAAK,OAAO,IAAI,EAAE,CAAC;AAC/F,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAuB,EACvB,OAAe,EACf,SAAiB;IAEjB,MAAM,KAAK,GAAa;QACtB,OAAO,MAAM,CAAC,IAAI,EAAE;QACpB,EAAE;QACF,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE;QACjD,EAAE;QACF,WAAW,MAAM,CAAC,IAAI,EAAE;QACxB,eAAe,MAAM,CAAC,QAAQ,IAAI,GAAG,EAAE;QACvC,YAAY,MAAM,CAAC,KAAK,IAAI,GAAG,EAAE;QACjC,YAAY,MAAM,CAAC,KAAK,IAAI,CAAC,EAAE;QAC/B,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;QACpD,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;QACjD,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,eAAe,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE;QAC7D,UAAU,OAAO,IAAI,SAAS,IAAI,MAAM,CAAC,IAAI,EAAE;QAC/C,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;QAC9E,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;KAChE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAClB,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAgB,EAAE,MAAmB;IAChE,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5E,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAClC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,MAAM,IAAI,CAAC,CAAC,UAAU,KAAK,QAAQ,CAC5D,CAAC;IACF,OAAO,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI;;EAE5B,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO;;aAEnC,OAAO,IAAI,SAAS;mBACd,OAAO,CAAC,MAAM;cACnB,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;;;;;CAKzE,CAAC;AACF,CAAC;AAyBD,MAAM,UAAU,gBAAgB,CAC9B,KAAuC,EACvC,MAAoB;IAEpB,2EAA2E;IAC3E,8EAA8E;IAC9E,qEAAqE;IACrE,IAAI,aAAa,IAAI,KAAK,EAAE,CAAC;QAC3B,MAAM,WAAW,GAAG,KAAkB,CAAC;QACvC,MAAM,OAAO,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACnF,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC3D,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,CACxC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,MAAM,IAAI,CAAC,CAAC,UAAU,KAAK,QAAQ,CAC5D,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,OAAO;aACrB,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;aAC/D,IAAI,CAAC,MAAM,CAAC,CAAC;QAChB,OAAO;YACL,KAAK,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,mBAAmB;YAC/E,EAAE;YACF,eAAe,WAAW,CAAC,WAAW,SAAS,WAAW,CAAC,OAAO,CAAC,MAAM,WAAW;YACpF,aAAa,OAAO,IAAI,SAAS,oCAAoC;YACrE,EAAE;YACF,oDAAoD;YACpD,EAAE;YACF,UAAU;YACV,EAAE;YACF,KAAK;YACL,EAAE;YACF,QAAQ,CAAC,CAAC,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE;YAC9B,EAAE;YACF,QAAQ;YACR,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;IAED,MAAM,YAAY,GAAG,KAA6B,CAAC;IACnD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,CAAC;IACzD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACjD,KAAK,CAAC,IAAI,CAAC,YAAY,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;IACjD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,SAAS,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAC7C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC5B,KAAK,MAAM,QAAQ,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;QACpC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,IAAI,QAAQ,CAAC,WAAW;YAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC3D,KAAK,CAAC,IAAI,CAAC,QAAQ,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACzB,KAAK,MAAM,MAAM,IAAI,YAAY,CAAC,OAAO,EAAE,CAAC;QAC1C,KAAK,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC/B,IAAI,MAAM,CAAC,KAAK;YAAE,KAAK,CAAC,IAAI,CAAC,UAAU,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACvD,IAAI,MAAM,CAAC,OAAO;YAAE,KAAK,CAAC,IAAI,CAAC,YAAY,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7D,KAAK,CAAC,IAAI,CAAC,QAAQ,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,KAAgB,EAChB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,MAAoB;IAEpB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACpD,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;IAClD,MAAM,SAAS,CAAC,OAAO,EAAE,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;IAC3D,MAAM,SAAS,CAAC,QAAQ,EAAE,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;IAChE,OAAO;QACL,OAAO;QACP,QAAQ;QACR,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAC3B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,MAAM,IAAI,CAAC,CAAC,UAAU,KAAK,QAAQ,CAC5D,CAAC,MAAM;KACT,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* PageDocument — the unified page-level contract for every page in a Grove
|
|
3
|
+
* project. A `PageDocument` declares the page's identity, its rendered
|
|
4
|
+
* metadata (title, description, OG, Twitter), the JSON-LD nodes it wants
|
|
5
|
+
* emitted, and its discovery profile (sitemap, llms, related links).
|
|
6
|
+
*
|
|
7
|
+
* Everything the framework renders in `<head>` (title, description,
|
|
8
|
+
* canonical, OG, Twitter, JSON-LD) is derived from this single model.
|
|
9
|
+
* `definePageDocument` is the canonical constructor — it validates the
|
|
10
|
+
* invariants (title present, OG URL matches canonical, etc.) so callers
|
|
11
|
+
* can't accidentally construct a malformed document.
|
|
12
|
+
*
|
|
13
|
+
* The JSON-LD registry (`siteSchema`, `collectionSchema`, `recordSchema`,
|
|
14
|
+
* `contentSchema`, `buildJsonLd`) is a small blueprint layer: each schema
|
|
15
|
+
* function takes a typed input and returns the JSON-LD node graph that
|
|
16
|
+
* `GroveDocumentHead` will serialize into `<script type="application/ld+json">`.
|
|
17
|
+
*
|
|
18
|
+
* `validateJsonLd` is the validator that runs over a node graph and
|
|
19
|
+
* reports well-formedness issues (missing @context, relative URLs, duplicate
|
|
20
|
+
* @ids, invalid dates). It is designed to be wired into the build pipeline
|
|
21
|
+
* so a malformed page fails fast.
|
|
22
|
+
*/
|
|
23
|
+
export type DocumentPageType = "home" | "directory" | "collection" | "record" | "content" | "empty" | "404";
|
|
24
|
+
export interface OpenGraphMetadata {
|
|
25
|
+
title: string;
|
|
26
|
+
description: string;
|
|
27
|
+
url: string;
|
|
28
|
+
image: string;
|
|
29
|
+
type: "website" | "article";
|
|
30
|
+
siteName?: string;
|
|
31
|
+
}
|
|
32
|
+
export interface TwitterMetadata {
|
|
33
|
+
card: "summary" | "summary_large_image";
|
|
34
|
+
site?: string;
|
|
35
|
+
creator?: string;
|
|
36
|
+
}
|
|
37
|
+
export interface PageMetadata {
|
|
38
|
+
title: string;
|
|
39
|
+
description: string;
|
|
40
|
+
robots: string;
|
|
41
|
+
openGraph: OpenGraphMetadata;
|
|
42
|
+
twitter: TwitterMetadata;
|
|
43
|
+
}
|
|
44
|
+
export interface LinkedDocument {
|
|
45
|
+
url: string;
|
|
46
|
+
title: string;
|
|
47
|
+
description?: string;
|
|
48
|
+
}
|
|
49
|
+
export interface JsonLdNode {
|
|
50
|
+
"@context": "https://schema.org";
|
|
51
|
+
"@type": string | string[];
|
|
52
|
+
"@id"?: string;
|
|
53
|
+
[key: string]: unknown;
|
|
54
|
+
}
|
|
55
|
+
export interface PageDiscovery {
|
|
56
|
+
includeInSitemap: boolean;
|
|
57
|
+
includeInLlms: boolean;
|
|
58
|
+
relatedLinks: LinkedDocument[];
|
|
59
|
+
}
|
|
60
|
+
export interface PageIdentity {
|
|
61
|
+
type: DocumentPageType;
|
|
62
|
+
canonical: URL;
|
|
63
|
+
language: string;
|
|
64
|
+
hreflang?: string[];
|
|
65
|
+
}
|
|
66
|
+
export interface PageDocument {
|
|
67
|
+
identity: PageIdentity;
|
|
68
|
+
metadata: PageMetadata;
|
|
69
|
+
structuredData: JsonLdNode[];
|
|
70
|
+
discovery: PageDiscovery;
|
|
71
|
+
}
|
|
72
|
+
export declare function definePageDocument(input: PageDocument): PageDocument;
|
|
73
|
+
export interface Crumb {
|
|
74
|
+
url: string;
|
|
75
|
+
name: string;
|
|
76
|
+
}
|
|
77
|
+
export interface SiteInput {
|
|
78
|
+
url: string;
|
|
79
|
+
name: string;
|
|
80
|
+
description?: string;
|
|
81
|
+
orgName: string;
|
|
82
|
+
orgUrl: string;
|
|
83
|
+
orgLogo?: string;
|
|
84
|
+
}
|
|
85
|
+
export declare function siteSchema(input: SiteInput): JsonLdNode[];
|
|
86
|
+
export interface CollectionInput {
|
|
87
|
+
url: string;
|
|
88
|
+
name: string;
|
|
89
|
+
description: string;
|
|
90
|
+
items: Array<{
|
|
91
|
+
url: string;
|
|
92
|
+
name: string;
|
|
93
|
+
}>;
|
|
94
|
+
crumbs: Crumb[];
|
|
95
|
+
}
|
|
96
|
+
export declare function collectionSchema(input: CollectionInput): JsonLdNode[];
|
|
97
|
+
export interface RecordInput {
|
|
98
|
+
url: string;
|
|
99
|
+
name: string;
|
|
100
|
+
description: string;
|
|
101
|
+
kind: "application" | "article";
|
|
102
|
+
repoUrl?: string;
|
|
103
|
+
license?: string;
|
|
104
|
+
crumbs: Crumb[];
|
|
105
|
+
}
|
|
106
|
+
export declare function recordSchema(input: RecordInput): JsonLdNode[];
|
|
107
|
+
export interface ContentInput {
|
|
108
|
+
url: string;
|
|
109
|
+
headline: string;
|
|
110
|
+
description: string;
|
|
111
|
+
author: string;
|
|
112
|
+
datePublished?: string;
|
|
113
|
+
crumbs: Crumb[];
|
|
114
|
+
}
|
|
115
|
+
export declare function contentSchema(input: ContentInput): JsonLdNode[];
|
|
116
|
+
export declare function buildJsonLd(input: SiteInput): JsonLdNode[];
|
|
117
|
+
export declare function buildJsonLd(input: CollectionInput): JsonLdNode[];
|
|
118
|
+
export declare function buildJsonLd(input: RecordInput): JsonLdNode[];
|
|
119
|
+
export declare function buildJsonLd(input: ContentInput): JsonLdNode[];
|
|
120
|
+
export interface JsonLdValidationIssue {
|
|
121
|
+
code: "missing-context" | "missing-type" | "relative-url" | "duplicate-id" | "invalid-date";
|
|
122
|
+
field?: string;
|
|
123
|
+
message: string;
|
|
124
|
+
}
|
|
125
|
+
export declare function validateJsonLd(nodes: JsonLdNode[]): JsonLdValidationIssue[];
|
|
126
|
+
//# sourceMappingURL=page-document.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"page-document.d.ts","sourceRoot":"","sources":["../src/page-document.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,MAAM,MAAM,gBAAgB,GACxB,MAAM,GACN,WAAW,GACX,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,OAAO,GACP,KAAK,CAAC;AAEV,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,SAAS,GAAG,qBAAqB,CAAC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,iBAAiB,CAAC;IAC7B,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,oBAAoB,CAAC;IACjC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,aAAa,EAAE,OAAO,CAAC;IACvB,YAAY,EAAE,cAAc,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,gBAAgB,CAAC;IACvB,SAAS,EAAE,GAAG,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,YAAY,CAAC;IACvB,QAAQ,EAAE,YAAY,CAAC;IACvB,cAAc,EAAE,UAAU,EAAE,CAAC;IAC7B,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,YAAY,CAcpE;AAED,MAAM,WAAW,KAAK;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,UAAU,EAAE,CAkBzD;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC5C,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,eAAe,GAAG,UAAU,EAAE,CAoCrE;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,aAAa,GAAG,SAAS,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,EAAE,CAyB7D;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,UAAU,EAAE,CAuB/D;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,SAAS,GAAG,UAAU,EAAE,CAAC;AAC5D,wBAAgB,WAAW,CAAC,KAAK,EAAE,eAAe,GAAG,UAAU,EAAE,CAAC;AAClE,wBAAgB,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,EAAE,CAAC;AAC9D,wBAAgB,WAAW,CAAC,KAAK,EAAE,YAAY,GAAG,UAAU,EAAE,CAAC;AAS/D,MAAM,WAAW,qBAAqB;IACpC,IAAI,EACA,iBAAiB,GACjB,cAAc,GACd,cAAc,GACd,cAAc,GACd,cAAc,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAID,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,qBAAqB,EAAE,CAiD3E"}
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* PageDocument — the unified page-level contract for every page in a Grove
|
|
3
|
+
* project. A `PageDocument` declares the page's identity, its rendered
|
|
4
|
+
* metadata (title, description, OG, Twitter), the JSON-LD nodes it wants
|
|
5
|
+
* emitted, and its discovery profile (sitemap, llms, related links).
|
|
6
|
+
*
|
|
7
|
+
* Everything the framework renders in `<head>` (title, description,
|
|
8
|
+
* canonical, OG, Twitter, JSON-LD) is derived from this single model.
|
|
9
|
+
* `definePageDocument` is the canonical constructor — it validates the
|
|
10
|
+
* invariants (title present, OG URL matches canonical, etc.) so callers
|
|
11
|
+
* can't accidentally construct a malformed document.
|
|
12
|
+
*
|
|
13
|
+
* The JSON-LD registry (`siteSchema`, `collectionSchema`, `recordSchema`,
|
|
14
|
+
* `contentSchema`, `buildJsonLd`) is a small blueprint layer: each schema
|
|
15
|
+
* function takes a typed input and returns the JSON-LD node graph that
|
|
16
|
+
* `GroveDocumentHead` will serialize into `<script type="application/ld+json">`.
|
|
17
|
+
*
|
|
18
|
+
* `validateJsonLd` is the validator that runs over a node graph and
|
|
19
|
+
* reports well-formedness issues (missing @context, relative URLs, duplicate
|
|
20
|
+
* @ids, invalid dates). It is designed to be wired into the build pipeline
|
|
21
|
+
* so a malformed page fails fast.
|
|
22
|
+
*/
|
|
23
|
+
export function definePageDocument(input) {
|
|
24
|
+
if (!input.metadata.title.trim()) {
|
|
25
|
+
throw new Error("PageDocument: title is required");
|
|
26
|
+
}
|
|
27
|
+
if (!input.metadata.description.trim()) {
|
|
28
|
+
throw new Error("PageDocument: description is required");
|
|
29
|
+
}
|
|
30
|
+
if (input.metadata.title === input.metadata.description) {
|
|
31
|
+
throw new Error("PageDocument: title and description must differ");
|
|
32
|
+
}
|
|
33
|
+
if (input.metadata.openGraph.url !== input.identity.canonical.toString()) {
|
|
34
|
+
throw new Error("PageDocument: openGraph.url must equal identity.canonical");
|
|
35
|
+
}
|
|
36
|
+
return input;
|
|
37
|
+
}
|
|
38
|
+
export function siteSchema(input) {
|
|
39
|
+
return [
|
|
40
|
+
{
|
|
41
|
+
"@context": "https://schema.org",
|
|
42
|
+
"@type": ["WebSite", "Organization"],
|
|
43
|
+
"@id": `${input.url}#site`,
|
|
44
|
+
url: input.url,
|
|
45
|
+
name: input.name,
|
|
46
|
+
...(input.description ? { description: input.description } : {}),
|
|
47
|
+
publisher: {
|
|
48
|
+
"@type": "Organization",
|
|
49
|
+
"@id": `${input.orgUrl}#org`,
|
|
50
|
+
name: input.orgName,
|
|
51
|
+
url: input.orgUrl,
|
|
52
|
+
...(input.orgLogo ? { logo: input.orgLogo } : {}),
|
|
53
|
+
},
|
|
54
|
+
},
|
|
55
|
+
];
|
|
56
|
+
}
|
|
57
|
+
export function collectionSchema(input) {
|
|
58
|
+
if (input.crumbs.length < 2) {
|
|
59
|
+
throw new Error("collectionSchema: breadcrumbs must contain at least 2 items");
|
|
60
|
+
}
|
|
61
|
+
const page = {
|
|
62
|
+
"@context": "https://schema.org",
|
|
63
|
+
"@type": ["CollectionPage", "WebPage"],
|
|
64
|
+
"@id": `${input.url}#page`,
|
|
65
|
+
url: input.url,
|
|
66
|
+
name: input.name,
|
|
67
|
+
description: input.description,
|
|
68
|
+
};
|
|
69
|
+
const list = {
|
|
70
|
+
"@context": "https://schema.org",
|
|
71
|
+
"@type": "ItemList",
|
|
72
|
+
numberOfItems: input.items.length,
|
|
73
|
+
itemListElement: input.items.map((item, i) => ({
|
|
74
|
+
"@type": "ListItem",
|
|
75
|
+
position: i + 1,
|
|
76
|
+
url: item.url,
|
|
77
|
+
name: item.name,
|
|
78
|
+
})),
|
|
79
|
+
};
|
|
80
|
+
const crum = {
|
|
81
|
+
"@context": "https://schema.org",
|
|
82
|
+
"@type": "BreadcrumbList",
|
|
83
|
+
itemListElement: input.crumbs.map((c, i) => ({
|
|
84
|
+
"@type": "ListItem",
|
|
85
|
+
position: i + 1,
|
|
86
|
+
name: c.name,
|
|
87
|
+
item: c.url,
|
|
88
|
+
})),
|
|
89
|
+
};
|
|
90
|
+
return [page, list, crum];
|
|
91
|
+
}
|
|
92
|
+
export function recordSchema(input) {
|
|
93
|
+
const isApp = input.kind === "application";
|
|
94
|
+
const main = {
|
|
95
|
+
"@context": "https://schema.org",
|
|
96
|
+
"@type": isApp
|
|
97
|
+
? ["SoftwareApplication", "SoftwareSourceCode"]
|
|
98
|
+
: ["CreativeWork", "WebPage"],
|
|
99
|
+
"@id": `${input.url}#record`,
|
|
100
|
+
url: input.url,
|
|
101
|
+
name: input.name,
|
|
102
|
+
description: input.description,
|
|
103
|
+
...(isApp && input.repoUrl ? { codeRepository: input.repoUrl } : {}),
|
|
104
|
+
...(input.license ? { license: input.license } : {}),
|
|
105
|
+
};
|
|
106
|
+
const crum = {
|
|
107
|
+
"@context": "https://schema.org",
|
|
108
|
+
"@type": "BreadcrumbList",
|
|
109
|
+
itemListElement: input.crumbs.map((c, i) => ({
|
|
110
|
+
"@type": "ListItem",
|
|
111
|
+
position: i + 1,
|
|
112
|
+
name: c.name,
|
|
113
|
+
item: c.url,
|
|
114
|
+
})),
|
|
115
|
+
};
|
|
116
|
+
return [main, crum];
|
|
117
|
+
}
|
|
118
|
+
export function contentSchema(input) {
|
|
119
|
+
return [
|
|
120
|
+
{
|
|
121
|
+
"@context": "https://schema.org",
|
|
122
|
+
"@type": ["Article", "WebPage"],
|
|
123
|
+
"@id": `${input.url}#article`,
|
|
124
|
+
url: input.url,
|
|
125
|
+
headline: input.headline,
|
|
126
|
+
description: input.description,
|
|
127
|
+
author: { "@type": "Organization", name: input.author },
|
|
128
|
+
...(input.datePublished ? { datePublished: input.datePublished } : {}),
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
"@context": "https://schema.org",
|
|
132
|
+
"@type": "BreadcrumbList",
|
|
133
|
+
itemListElement: input.crumbs.map((c, i) => ({
|
|
134
|
+
"@type": "ListItem",
|
|
135
|
+
position: i + 1,
|
|
136
|
+
name: c.name,
|
|
137
|
+
item: c.url,
|
|
138
|
+
})),
|
|
139
|
+
},
|
|
140
|
+
];
|
|
141
|
+
}
|
|
142
|
+
export function buildJsonLd(input) {
|
|
143
|
+
if ("orgName" in input)
|
|
144
|
+
return siteSchema(input);
|
|
145
|
+
if ("items" in input)
|
|
146
|
+
return collectionSchema(input);
|
|
147
|
+
if ("kind" in input)
|
|
148
|
+
return recordSchema(input);
|
|
149
|
+
if ("headline" in input)
|
|
150
|
+
return contentSchema(input);
|
|
151
|
+
throw new Error("buildJsonLd: unknown schema input");
|
|
152
|
+
}
|
|
153
|
+
const URL_FIELDS = new Set(["url", "codeRepository", "logo", "image", "sameAs"]);
|
|
154
|
+
export function validateJsonLd(nodes) {
|
|
155
|
+
const issues = [];
|
|
156
|
+
const seen = new Set();
|
|
157
|
+
for (const node of nodes) {
|
|
158
|
+
if (node["@context"] !== "https://schema.org") {
|
|
159
|
+
issues.push({
|
|
160
|
+
code: "missing-context",
|
|
161
|
+
message: "@context must be https://schema.org",
|
|
162
|
+
});
|
|
163
|
+
}
|
|
164
|
+
if (!node["@type"]) {
|
|
165
|
+
issues.push({ code: "missing-type", message: "@type is required" });
|
|
166
|
+
}
|
|
167
|
+
if (node["@id"]) {
|
|
168
|
+
if (seen.has(node["@id"])) {
|
|
169
|
+
issues.push({
|
|
170
|
+
code: "duplicate-id",
|
|
171
|
+
message: `Duplicate @id: ${node["@id"]}`,
|
|
172
|
+
});
|
|
173
|
+
}
|
|
174
|
+
seen.add(node["@id"]);
|
|
175
|
+
}
|
|
176
|
+
for (const [field, value] of Object.entries(node)) {
|
|
177
|
+
if (field.startsWith("@"))
|
|
178
|
+
continue;
|
|
179
|
+
if (URL_FIELDS.has(field) &&
|
|
180
|
+
typeof value === "string" &&
|
|
181
|
+
!/^https?:\/\//.test(value)) {
|
|
182
|
+
issues.push({
|
|
183
|
+
code: "relative-url",
|
|
184
|
+
field,
|
|
185
|
+
message: `${field} must be absolute: ${value}`,
|
|
186
|
+
});
|
|
187
|
+
}
|
|
188
|
+
if (field === "datePublished" &&
|
|
189
|
+
typeof value === "string" &&
|
|
190
|
+
isNaN(Date.parse(value))) {
|
|
191
|
+
issues.push({
|
|
192
|
+
code: "invalid-date",
|
|
193
|
+
field,
|
|
194
|
+
message: `datePublished invalid: ${value}`,
|
|
195
|
+
});
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
return issues;
|
|
200
|
+
}
|
|
201
|
+
//# sourceMappingURL=page-document.js.map
|