@chartcoach/catalog 0.1.4 → 0.1.5
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/LICENSE +21 -0
- package/README.md +4 -8
- package/dist/catalog/artifacts.d.ts +2 -1
- package/dist/catalog/artifacts.d.ts.map +1 -1
- package/dist/catalog/artifacts.js +5 -6
- package/dist/catalog/chartcoach-defaults.d.ts +17 -0
- package/dist/catalog/chartcoach-defaults.d.ts.map +1 -0
- package/dist/catalog/chartcoach-defaults.js +8 -0
- package/dist/catalog/labels.d.ts.map +1 -1
- package/dist/catalog/load-parquet-core.d.ts.map +1 -1
- package/dist/catalog/load-parquet-core.js +1 -3
- package/dist/catalog/manifest.d.ts.map +1 -1
- package/dist/catalog/manifest.js +1 -2
- package/dist/catalog/markdown.d.ts.map +1 -1
- package/dist/catalog/model.d.ts.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -2
- package/package.json +17 -14
- package/src/catalog/artifacts.ts +7 -12
- package/src/catalog/chartcoach-defaults.ts +17 -0
- package/src/catalog/labels.ts +3 -1
- package/src/catalog/load-parquet-core.ts +12 -15
- package/src/catalog/manifest.ts +6 -8
- package/src/catalog/markdown.ts +1 -4
- package/src/catalog/model.ts +1 -3
- package/src/index.ts +8 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 chartcoach Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
JavaScript models and parsers for chartcoach catalog artifacts.
|
|
4
4
|
|
|
5
5
|
Read the package docs at [docs.chartcoach.dev/javascript](https://docs.chartcoach.dev/javascript).
|
|
6
|
-
Read the
|
|
6
|
+
Read about the cataloging scheme at [docs.chartcoach.dev/catalog](https://docs.chartcoach.dev/catalog).
|
|
7
7
|
|
|
8
8
|
Install the package from an application root:
|
|
9
9
|
|
|
@@ -14,12 +14,8 @@ npm install @chartcoach/catalog
|
|
|
14
14
|
```ts
|
|
15
15
|
import { DEFAULT_CATALOG, loadCatalog } from "@chartcoach/catalog"
|
|
16
16
|
|
|
17
|
-
const entries = await fetch(DEFAULT_CATALOG.entriesUrl).
|
|
18
|
-
|
|
19
|
-
)
|
|
20
|
-
const manifestText = await fetch(DEFAULT_CATALOG.manifestUrl).then((response) =>
|
|
21
|
-
response.text(),
|
|
22
|
-
)
|
|
17
|
+
const entries = await (await fetch(DEFAULT_CATALOG.entriesUrl)).arrayBuffer()
|
|
18
|
+
const manifestText = await (await fetch(DEFAULT_CATALOG.manifestUrl)).text()
|
|
23
19
|
|
|
24
20
|
const catalog = await loadCatalog({ entries, manifestText })
|
|
25
21
|
const guideline = catalog.require("compare-percentages-with-bars-not-pies")
|
|
@@ -54,7 +50,7 @@ const entriesUrl = catalogArtifactUrl(
|
|
|
54
50
|
catalogArtifact(metadata, "entries"),
|
|
55
51
|
)
|
|
56
52
|
|
|
57
|
-
const entries = await fetch(entriesUrl)
|
|
53
|
+
const entries = await (await fetch(entriesUrl)).arrayBuffer()
|
|
58
54
|
```
|
|
59
55
|
|
|
60
56
|
Run package checks from the repository root:
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
export { CHARTCOACH_DEFAULTS, type ChartCoachDefaults } from "./chartcoach-defaults.js";
|
|
1
2
|
export declare const DEFAULT_CATALOG: {
|
|
2
|
-
readonly version: "0.1.
|
|
3
|
+
readonly version: "0.1.5";
|
|
3
4
|
readonly digest: "7cfd43ee820be252b8ae9058c4c36109a9c8415c6b3a5ff8a9127117b4a10c19";
|
|
4
5
|
readonly releaseRootUrl: string;
|
|
5
6
|
readonly metadataUrl: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"artifacts.d.ts","sourceRoot":"","sources":["../../src/catalog/artifacts.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"artifacts.d.ts","sourceRoot":"","sources":["../../src/catalog/artifacts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,KAAK,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAOrF,eAAO,MAAM,eAAe;;;;;;;CAOlB,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,SAAS,GAAG,eAAe,CAAC;AAEpE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,kBAAkB,EAAE,CAAC;CACjC,CAAC;AAEF,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,sBAAsB,CAgBlF;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,EAAE,UAAU,EAAE,kBAAkB,GAAG,MAAM,CAEhG;AAED,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,sBAAsB,EAChC,IAAI,EAAE,YAAY,GACjB,kBAAkB,CAMpB"}
|
|
@@ -1,11 +1,10 @@
|
|
|
1
|
+
import { CHARTCOACH_DEFAULTS } from "./chartcoach-defaults.js";
|
|
1
2
|
import { CatalogError } from "./errors.js";
|
|
2
|
-
|
|
3
|
-
const
|
|
4
|
-
const defaultCatalogVersion = "0.1.4";
|
|
5
|
-
const defaultCatalogReleaseRootUrl = new URL(`catalog/releases/${defaultCatalogVersion}/${defaultCatalogDigest}/`, `${defaultCatalogArtifactBaseUrl}/`).toString();
|
|
3
|
+
export { CHARTCOACH_DEFAULTS } from "./chartcoach-defaults.js";
|
|
4
|
+
const defaultCatalogReleaseRootUrl = new URL(`catalog/releases/${CHARTCOACH_DEFAULTS.catalogVersion}/${CHARTCOACH_DEFAULTS.catalogDigest}/`, `${CHARTCOACH_DEFAULTS.catalogArtifactBaseUrl}/`).toString();
|
|
6
5
|
export const DEFAULT_CATALOG = {
|
|
7
|
-
version:
|
|
8
|
-
digest:
|
|
6
|
+
version: CHARTCOACH_DEFAULTS.catalogVersion,
|
|
7
|
+
digest: CHARTCOACH_DEFAULTS.catalogDigest,
|
|
9
8
|
releaseRootUrl: defaultCatalogReleaseRootUrl,
|
|
10
9
|
metadataUrl: new URL("metadata.json", defaultCatalogReleaseRootUrl).toString(),
|
|
11
10
|
entriesUrl: new URL("entries.parquet", defaultCatalogReleaseRootUrl).toString(),
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export type ChartCoachDefaults = {
|
|
2
|
+
catalogArtifactBaseUrl: string;
|
|
3
|
+
catalogDigest: string;
|
|
4
|
+
catalogVersion: string;
|
|
5
|
+
guidelineUrlTemplate: string;
|
|
6
|
+
indexTopK: number;
|
|
7
|
+
lanceDocumentTable: string;
|
|
8
|
+
};
|
|
9
|
+
export declare const CHARTCOACH_DEFAULTS: {
|
|
10
|
+
readonly catalogArtifactBaseUrl: "https://artifacts.chartcoach.dev";
|
|
11
|
+
readonly catalogDigest: "7cfd43ee820be252b8ae9058c4c36109a9c8415c6b3a5ff8a9127117b4a10c19";
|
|
12
|
+
readonly catalogVersion: "0.1.5";
|
|
13
|
+
readonly guidelineUrlTemplate: "https://chartcoach.dev/guidelines/{id}";
|
|
14
|
+
readonly indexTopK: 10;
|
|
15
|
+
readonly lanceDocumentTable: "catalog_documents";
|
|
16
|
+
};
|
|
17
|
+
//# sourceMappingURL=chartcoach-defaults.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"chartcoach-defaults.d.ts","sourceRoot":"","sources":["../../src/catalog/chartcoach-defaults.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG;IAC/B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;;;;;CAOO,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export const CHARTCOACH_DEFAULTS = {
|
|
2
|
+
catalogArtifactBaseUrl: "https://artifacts.chartcoach.dev",
|
|
3
|
+
catalogDigest: "7cfd43ee820be252b8ae9058c4c36109a9c8415c6b3a5ff8a9127117b4a10c19",
|
|
4
|
+
catalogVersion: "0.1.5",
|
|
5
|
+
guidelineUrlTemplate: "https://chartcoach.dev/guidelines/{id}",
|
|
6
|
+
indexTopK: 10,
|
|
7
|
+
lanceDocumentTable: "catalog_documents",
|
|
8
|
+
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"labels.d.ts","sourceRoot":"","sources":["../../src/catalog/labels.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,SAAU,GAAG,YAAY,
|
|
1
|
+
{"version":3,"file":"labels.d.ts","sourceRoot":"","sources":["../../src/catalog/labels.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,SAAU,GAAG,YAAY,CAoB1E;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,SAAU,GAAG,MAAM,CAExE"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"load-parquet-core.d.ts","sourceRoot":"","sources":["../../src/catalog/load-parquet-core.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAkB,MAAM,SAAS,CAAC;AAElD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAIlD,MAAM,MAAM,WAAW,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CACxE,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,eAAe,CAAC;AACzD,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,WAAW,CAAC;AACtD,MAAM,MAAM,gBAAgB,
|
|
1
|
+
{"version":3,"file":"load-parquet-core.d.ts","sourceRoot":"","sources":["../../src/catalog/load-parquet-core.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAkB,MAAM,SAAS,CAAC;AAElD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAIlD,MAAM,MAAM,WAAW,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CACxE,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,eAAe,CAAC;AACzD,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,WAAW,CAAC;AACtD,MAAM,MAAM,gBAAgB,GACxB,YAAY,GACZ;IACE,OAAO,EAAE,YAAY,CAAC;IACtB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAWN,wBAAsB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAiB3E"}
|
|
@@ -32,9 +32,7 @@ function resolveLoadCatalogInput(input) {
|
|
|
32
32
|
}
|
|
33
33
|
return {
|
|
34
34
|
entries: input.entries,
|
|
35
|
-
manifest: input.manifestText === undefined
|
|
36
|
-
? input.manifest
|
|
37
|
-
: parseCatalogManifest(input.manifestText),
|
|
35
|
+
manifest: input.manifestText === undefined ? input.manifest : parseCatalogManifest(input.manifestText),
|
|
38
36
|
};
|
|
39
37
|
}
|
|
40
38
|
function isCatalogBytes(value) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../src/catalog/manifest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,eAAO,MAAM,0BAA0B,8CAA+C,CAAC;AAEvF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IACjD,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;CACnD,CAAC;AAKF,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,eAAe,
|
|
1
|
+
{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../src/catalog/manifest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,eAAO,MAAM,0BAA0B,8CAA+C,CAAC;AAEvF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IACjD,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;CACnD,CAAC;AAKF,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,eAAe,CA6FtE;AAED,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,SAAS,SAAS,EAAE,EAChC,QAAQ,EAAE,eAAe,QAmC1B"}
|
package/dist/catalog/manifest.js
CHANGED
|
@@ -13,8 +13,7 @@ export function parseCatalogManifest(markdown) {
|
|
|
13
13
|
let currentName;
|
|
14
14
|
let currentLines = [];
|
|
15
15
|
function flushDefinition() {
|
|
16
|
-
if (currentHeading !== "Section Roles" &&
|
|
17
|
-
currentHeading !== "Label Families") {
|
|
16
|
+
if (currentHeading !== "Section Roles" && currentHeading !== "Label Families") {
|
|
18
17
|
currentLines = [];
|
|
19
18
|
return;
|
|
20
19
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/catalog/markdown.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,wBAAgB,UAAU,CACxB,SAAS,EAAE,IAAI,
|
|
1
|
+
{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/catalog/markdown.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,wBAAgB,UAAU,CACxB,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,GAAG,OAAO,GAAG,cAAc,GAAG,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC,GAC9F,MAAM,CAYR"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/catalog/model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAGlD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACtC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B,CAAC;AAEF,qBAAa,OAAQ,YAAW,QAAQ,CAAC,SAAS,CAAC;IACjD,QAAQ,CAAC,UAAU,EAAE,SAAS,SAAS,EAAE,CAAC;IAC1C,QAAQ,CAAC,QAAQ,CAAC,EAAE,eAAe,CAAC;IACpC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAyB;gBAElC,UAAU,GAAE,QAAQ,CAAC,SAAS,CAAM,EAAE,OAAO,GAAE,cAAmB;IAkB9E,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAItC,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS;IAQ9B,MAAM,IAAI,MAAM,EAAE;IAIlB,YAAY,IAAI,MAAM,EAAE;
|
|
1
|
+
{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/catalog/model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAGlD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACtC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B,CAAC;AAEF,qBAAa,OAAQ,YAAW,QAAQ,CAAC,SAAS,CAAC;IACjD,QAAQ,CAAC,UAAU,EAAE,SAAS,SAAS,EAAE,CAAC;IAC1C,QAAQ,CAAC,QAAQ,CAAC,EAAE,eAAe,CAAC;IACpC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAyB;gBAElC,UAAU,GAAE,QAAQ,CAAC,SAAS,CAAM,EAAE,OAAO,GAAE,cAAmB;IAkB9E,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAItC,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS;IAQ9B,MAAM,IAAI,MAAM,EAAE;IAIlB,YAAY,IAAI,MAAM,EAAE;IAMxB,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,SAAS,CAAC;CAGzC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { Catalog, type CatalogOptions, type Guideline, type GuidelineSection } from "./catalog/model.js";
|
|
1
|
+
export { Catalog, type CatalogOptions, type Guideline, type GuidelineSection, } from "./catalog/model.js";
|
|
2
2
|
export { CatalogError } from "./catalog/errors.js";
|
|
3
|
-
export { DEFAULT_CATALOG, catalogArtifact, catalogArtifactUrl, parseCatalogReleaseMetadata, type ArtifactDescriptor, type ArtifactKind, type CatalogReleaseMetadata, } from "./catalog/artifacts.js";
|
|
3
|
+
export { CHARTCOACH_DEFAULTS, DEFAULT_CATALOG, catalogArtifact, catalogArtifactUrl, parseCatalogReleaseMetadata, type ArtifactDescriptor, type ArtifactKind, type CatalogReleaseMetadata, type ChartCoachDefaults, } from "./catalog/artifacts.js";
|
|
4
4
|
export { loadCatalog, type AsyncBuffer, type CatalogBytes, type LoadCatalogInput, type ParquetBytes, } from "./catalog/load-parquet-core.js";
|
|
5
5
|
export { type CatalogManifest, type ManifestDefinition, parseCatalogManifest, } from "./catalog/manifest.js";
|
|
6
6
|
export { parseLabel, type CatalogLabel } from "./catalog/labels.js";
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,KAAK,cAAc,EACnB,KAAK,SAAS,EACd,KAAK,gBAAgB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,2BAA2B,EAC3B,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,GACxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,WAAW,EACX,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,YAAY,GAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { Catalog } from "./catalog/model.js";
|
|
1
|
+
export { Catalog, } from "./catalog/model.js";
|
|
2
2
|
export { CatalogError } from "./catalog/errors.js";
|
|
3
|
-
export { DEFAULT_CATALOG, catalogArtifact, catalogArtifactUrl, parseCatalogReleaseMetadata, } from "./catalog/artifacts.js";
|
|
3
|
+
export { CHARTCOACH_DEFAULTS, DEFAULT_CATALOG, catalogArtifact, catalogArtifactUrl, parseCatalogReleaseMetadata, } from "./catalog/artifacts.js";
|
|
4
4
|
export { loadCatalog, } from "./catalog/load-parquet-core.js";
|
|
5
5
|
export { parseCatalogManifest, } from "./catalog/manifest.js";
|
|
6
6
|
export { parseLabel } from "./catalog/labels.js";
|
package/package.json
CHANGED
|
@@ -1,23 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@chartcoach/catalog",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.5",
|
|
4
4
|
"description": "JavaScript models and artifact parsers for the chartcoach visualization guideline catalog.",
|
|
5
|
+
"bugs": {
|
|
6
|
+
"url": "https://github.com/chartcoach/chartcoach/issues"
|
|
7
|
+
},
|
|
5
8
|
"license": "MIT",
|
|
6
9
|
"author": "Péter Ferenc Gyarmati <dev.petergy@gmail.com>",
|
|
7
10
|
"repository": {
|
|
8
11
|
"type": "git",
|
|
9
12
|
"url": "git+https://github.com/chartcoach/chartcoach.git"
|
|
10
13
|
},
|
|
11
|
-
"bugs": {
|
|
12
|
-
"url": "https://github.com/chartcoach/chartcoach/issues"
|
|
13
|
-
},
|
|
14
14
|
"files": [
|
|
15
15
|
"dist",
|
|
16
16
|
"src"
|
|
17
17
|
],
|
|
18
|
-
"publishConfig": {
|
|
19
|
-
"access": "public"
|
|
20
|
-
},
|
|
21
18
|
"type": "module",
|
|
22
19
|
"main": "./dist/index.js",
|
|
23
20
|
"types": "./dist/index.d.ts",
|
|
@@ -28,12 +25,8 @@
|
|
|
28
25
|
"default": "./dist/index.js"
|
|
29
26
|
}
|
|
30
27
|
},
|
|
31
|
-
"
|
|
32
|
-
"
|
|
33
|
-
"lint": "oxlint . && pnpm run lint:imports",
|
|
34
|
-
"lint:imports": "node scripts/check-extensionless-imports.mjs",
|
|
35
|
-
"test": "vitest run",
|
|
36
|
-
"typecheck": "tsc -p tsconfig.json --noEmit"
|
|
28
|
+
"publishConfig": {
|
|
29
|
+
"access": "public"
|
|
37
30
|
},
|
|
38
31
|
"dependencies": {
|
|
39
32
|
"hyparquet": "^1.26.1",
|
|
@@ -45,5 +38,15 @@
|
|
|
45
38
|
"tsc-alias": "^1.8.17",
|
|
46
39
|
"typescript": "^5.9.3",
|
|
47
40
|
"vitest": "^3.2.6"
|
|
41
|
+
},
|
|
42
|
+
"scripts": {
|
|
43
|
+
"build": "node scripts/build.mjs",
|
|
44
|
+
"format": "oxfmt src test scripts package.json tsconfig.json tsconfig.build.json vitest.config.ts",
|
|
45
|
+
"format:check": "oxfmt src test scripts package.json tsconfig.json tsconfig.build.json vitest.config.ts --check",
|
|
46
|
+
"lint": "oxlint .",
|
|
47
|
+
"sync:defaults": "node scripts/sync-chartcoach-defaults.mjs",
|
|
48
|
+
"sync:defaults:check": "node scripts/sync-chartcoach-defaults.mjs --check",
|
|
49
|
+
"test": "vitest run",
|
|
50
|
+
"typecheck": "tsc -p tsconfig.json --noEmit"
|
|
48
51
|
}
|
|
49
|
-
}
|
|
52
|
+
}
|
package/src/catalog/artifacts.ts
CHANGED
|
@@ -1,17 +1,15 @@
|
|
|
1
|
+
import { CHARTCOACH_DEFAULTS } from "./chartcoach-defaults";
|
|
1
2
|
import { CatalogError } from "./errors";
|
|
3
|
+
export { CHARTCOACH_DEFAULTS, type ChartCoachDefaults } from "./chartcoach-defaults";
|
|
2
4
|
|
|
3
|
-
const defaultCatalogArtifactBaseUrl = "https://artifacts.chartcoach.dev";
|
|
4
|
-
const defaultCatalogDigest =
|
|
5
|
-
"7cfd43ee820be252b8ae9058c4c36109a9c8415c6b3a5ff8a9127117b4a10c19";
|
|
6
|
-
const defaultCatalogVersion = "0.1.4";
|
|
7
5
|
const defaultCatalogReleaseRootUrl = new URL(
|
|
8
|
-
`catalog/releases/${
|
|
9
|
-
`${
|
|
6
|
+
`catalog/releases/${CHARTCOACH_DEFAULTS.catalogVersion}/${CHARTCOACH_DEFAULTS.catalogDigest}/`,
|
|
7
|
+
`${CHARTCOACH_DEFAULTS.catalogArtifactBaseUrl}/`,
|
|
10
8
|
).toString();
|
|
11
9
|
|
|
12
10
|
export const DEFAULT_CATALOG = {
|
|
13
|
-
version:
|
|
14
|
-
digest:
|
|
11
|
+
version: CHARTCOACH_DEFAULTS.catalogVersion,
|
|
12
|
+
digest: CHARTCOACH_DEFAULTS.catalogDigest,
|
|
15
13
|
releaseRootUrl: defaultCatalogReleaseRootUrl,
|
|
16
14
|
metadataUrl: new URL("metadata.json", defaultCatalogReleaseRootUrl).toString(),
|
|
17
15
|
entriesUrl: new URL("entries.parquet", defaultCatalogReleaseRootUrl).toString(),
|
|
@@ -54,10 +52,7 @@ export function parseCatalogReleaseMetadata(value: unknown): CatalogReleaseMetad
|
|
|
54
52
|
return metadata;
|
|
55
53
|
}
|
|
56
54
|
|
|
57
|
-
export function catalogArtifactUrl(
|
|
58
|
-
baseUrl: string | URL,
|
|
59
|
-
descriptor: ArtifactDescriptor,
|
|
60
|
-
): string {
|
|
55
|
+
export function catalogArtifactUrl(baseUrl: string | URL, descriptor: ArtifactDescriptor): string {
|
|
61
56
|
return new URL(descriptor.path, baseUrl).toString();
|
|
62
57
|
}
|
|
63
58
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export type ChartCoachDefaults = {
|
|
2
|
+
catalogArtifactBaseUrl: string;
|
|
3
|
+
catalogDigest: string;
|
|
4
|
+
catalogVersion: string;
|
|
5
|
+
guidelineUrlTemplate: string;
|
|
6
|
+
indexTopK: number;
|
|
7
|
+
lanceDocumentTable: string;
|
|
8
|
+
};
|
|
9
|
+
|
|
10
|
+
export const CHARTCOACH_DEFAULTS = {
|
|
11
|
+
catalogArtifactBaseUrl: "https://artifacts.chartcoach.dev",
|
|
12
|
+
catalogDigest: "7cfd43ee820be252b8ae9058c4c36109a9c8415c6b3a5ff8a9127117b4a10c19",
|
|
13
|
+
catalogVersion: "0.1.5",
|
|
14
|
+
guidelineUrlTemplate: "https://chartcoach.dev/guidelines/{id}",
|
|
15
|
+
indexTopK: 10,
|
|
16
|
+
lanceDocumentTable: "catalog_documents",
|
|
17
|
+
} as const satisfies ChartCoachDefaults;
|
package/src/catalog/labels.ts
CHANGED
|
@@ -16,7 +16,9 @@ export function parseLabel(value: unknown, context = "label"): CatalogLabel {
|
|
|
16
16
|
.split(":")
|
|
17
17
|
.map((part) => part.trim());
|
|
18
18
|
if ((parts.length !== 2 && parts.length !== 3) || parts.some((part) => part.length === 0)) {
|
|
19
|
-
throw new CatalogError(
|
|
19
|
+
throw new CatalogError(
|
|
20
|
+
`${context} must use <family>:<category> or <family>:<category>:<modifier>.`,
|
|
21
|
+
);
|
|
20
22
|
}
|
|
21
23
|
const [family, category, modifier] = parts as [string, string, string | undefined];
|
|
22
24
|
return {
|
|
@@ -13,11 +13,13 @@ export type AsyncBuffer = {
|
|
|
13
13
|
|
|
14
14
|
export type ParquetBytes = ArrayBuffer | ArrayBufferView;
|
|
15
15
|
export type CatalogBytes = ParquetBytes | AsyncBuffer;
|
|
16
|
-
export type LoadCatalogInput =
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
16
|
+
export type LoadCatalogInput =
|
|
17
|
+
| CatalogBytes
|
|
18
|
+
| {
|
|
19
|
+
entries: CatalogBytes;
|
|
20
|
+
manifest?: CatalogManifest;
|
|
21
|
+
manifestText?: string;
|
|
22
|
+
};
|
|
21
23
|
|
|
22
24
|
function normalizeParquetBytes(bytes: ParquetBytes): ArrayBuffer {
|
|
23
25
|
if (bytes instanceof ArrayBuffer) return bytes;
|
|
@@ -28,9 +30,7 @@ function normalizeParquetBytes(bytes: ParquetBytes): ArrayBuffer {
|
|
|
28
30
|
return u8.slice().buffer;
|
|
29
31
|
}
|
|
30
32
|
|
|
31
|
-
export async function loadCatalog(
|
|
32
|
-
input: LoadCatalogInput,
|
|
33
|
-
): Promise<Catalog> {
|
|
33
|
+
export async function loadCatalog(input: LoadCatalogInput): Promise<Catalog> {
|
|
34
34
|
const { entries, manifest } = resolveLoadCatalogInput(input);
|
|
35
35
|
const normalizedFile =
|
|
36
36
|
entries instanceof ArrayBuffer || ArrayBuffer.isView(entries)
|
|
@@ -61,9 +61,8 @@ function resolveLoadCatalogInput(input: LoadCatalogInput): {
|
|
|
61
61
|
|
|
62
62
|
return {
|
|
63
63
|
entries: input.entries,
|
|
64
|
-
manifest:
|
|
65
|
-
? input.manifest
|
|
66
|
-
: parseCatalogManifest(input.manifestText),
|
|
64
|
+
manifest:
|
|
65
|
+
input.manifestText === undefined ? input.manifest : parseCatalogManifest(input.manifestText),
|
|
67
66
|
};
|
|
68
67
|
}
|
|
69
68
|
|
|
@@ -71,11 +70,9 @@ function isCatalogBytes(value: LoadCatalogInput): value is CatalogBytes {
|
|
|
71
70
|
return (
|
|
72
71
|
value instanceof ArrayBuffer ||
|
|
73
72
|
ArrayBuffer.isView(value) ||
|
|
74
|
-
(
|
|
75
|
-
typeof value === "object" &&
|
|
73
|
+
(typeof value === "object" &&
|
|
76
74
|
value !== null &&
|
|
77
75
|
typeof (value as AsyncBuffer).byteLength === "number" &&
|
|
78
|
-
typeof (value as AsyncBuffer).slice === "function"
|
|
79
|
-
)
|
|
76
|
+
typeof (value as AsyncBuffer).slice === "function")
|
|
80
77
|
);
|
|
81
78
|
}
|
package/src/catalog/manifest.ts
CHANGED
|
@@ -33,10 +33,7 @@ export function parseCatalogManifest(markdown: string): CatalogManifest {
|
|
|
33
33
|
let currentLines: string[] = [];
|
|
34
34
|
|
|
35
35
|
function flushDefinition() {
|
|
36
|
-
if (
|
|
37
|
-
currentHeading !== "Section Roles" &&
|
|
38
|
-
currentHeading !== "Label Families"
|
|
39
|
-
) {
|
|
36
|
+
if (currentHeading !== "Section Roles" && currentHeading !== "Label Families") {
|
|
40
37
|
currentLines = [];
|
|
41
38
|
return;
|
|
42
39
|
}
|
|
@@ -87,9 +84,7 @@ export function parseCatalogManifest(markdown: string): CatalogManifest {
|
|
|
87
84
|
) {
|
|
88
85
|
flushDefinition();
|
|
89
86
|
if (!title) {
|
|
90
|
-
throw new CatalogError(
|
|
91
|
-
`Manifest heading ${currentHeading} contains an empty subheading.`,
|
|
92
|
-
);
|
|
87
|
+
throw new CatalogError(`Manifest heading ${currentHeading} contains an empty subheading.`);
|
|
93
88
|
}
|
|
94
89
|
currentName = title;
|
|
95
90
|
currentLines = [];
|
|
@@ -119,7 +114,10 @@ export function parseCatalogManifest(markdown: string): CatalogManifest {
|
|
|
119
114
|
};
|
|
120
115
|
}
|
|
121
116
|
|
|
122
|
-
export function validateManifestCoverage(
|
|
117
|
+
export function validateManifestCoverage(
|
|
118
|
+
guidelines: readonly Guideline[],
|
|
119
|
+
manifest: CatalogManifest,
|
|
120
|
+
) {
|
|
123
121
|
const usedRoles = new Set<string>();
|
|
124
122
|
const usedFamilies = new Set<string>();
|
|
125
123
|
|
package/src/catalog/markdown.ts
CHANGED
|
@@ -3,10 +3,7 @@ import { stringify as stringifyYaml } from "yaml";
|
|
|
3
3
|
import type { Guideline } from "./model";
|
|
4
4
|
|
|
5
5
|
export function toMarkdown(
|
|
6
|
-
guideline: Pick<
|
|
7
|
-
Guideline,
|
|
8
|
-
"id" | "title" | "bibliography" | "description" | "labels" | "body"
|
|
9
|
-
>,
|
|
6
|
+
guideline: Pick<Guideline, "id" | "title" | "bibliography" | "description" | "labels" | "body">,
|
|
10
7
|
): string {
|
|
11
8
|
const frontmatter = {
|
|
12
9
|
id: guideline.id,
|
package/src/catalog/model.ts
CHANGED
|
@@ -72,9 +72,7 @@ export class Catalog implements Iterable<Guideline> {
|
|
|
72
72
|
|
|
73
73
|
sectionRoles(): string[] {
|
|
74
74
|
return sortedUnique(
|
|
75
|
-
this.guidelines.flatMap((guideline) =>
|
|
76
|
-
guideline.sections.map((section) => section.role),
|
|
77
|
-
),
|
|
75
|
+
this.guidelines.flatMap((guideline) => guideline.sections.map((section) => section.role)),
|
|
78
76
|
);
|
|
79
77
|
}
|
|
80
78
|
|
package/src/index.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
|
-
export {
|
|
1
|
+
export {
|
|
2
|
+
Catalog,
|
|
3
|
+
type CatalogOptions,
|
|
4
|
+
type Guideline,
|
|
5
|
+
type GuidelineSection,
|
|
6
|
+
} from "./catalog/model";
|
|
2
7
|
export { CatalogError } from "./catalog/errors";
|
|
3
8
|
export {
|
|
9
|
+
CHARTCOACH_DEFAULTS,
|
|
4
10
|
DEFAULT_CATALOG,
|
|
5
11
|
catalogArtifact,
|
|
6
12
|
catalogArtifactUrl,
|
|
@@ -8,6 +14,7 @@ export {
|
|
|
8
14
|
type ArtifactDescriptor,
|
|
9
15
|
type ArtifactKind,
|
|
10
16
|
type CatalogReleaseMetadata,
|
|
17
|
+
type ChartCoachDefaults,
|
|
11
18
|
} from "./catalog/artifacts";
|
|
12
19
|
export {
|
|
13
20
|
loadCatalog,
|