@effected/schemastore 0.19.0 → 0.21.0

package/README.md

@@ -131,7 +131,7 @@ const program = SchemaPipeline.run(targets).pipe(
 ## What the library owns
 
 - `HostedSchema` — a schema's hosted identity (`github`, `schemastore`, `custom`), deriving `$id`, the catalog URL and the file name for the current or any advertised version.
-- `defineConfig` — the `schemastore.config.ts` contract: validated with one `Schema.Struct` per level (a typo'd key is named, every issue on an entry reported at once), a required config `name` (the base name of its catalog slice), every path and URL derived from the entry key and its identity, frozen labels resolved, a branded result the CLI recognises.
+- `defineConfig` — the `schemastore.config.ts` contract: validated with one `Schema.Struct` per level (a typo'd key is named, every issue on an entry reported at once), a required config `name` (the base name of its catalog slice), every path and URL derived from the entry key and its identity, an optional `catalog.name` display name (defaulting to the key, unique within the config) that renames the catalog entry and nothing else, frozen labels resolved, a branded result the CLI recognises.
 - `StoreDocument` — assembly: `fromSchema` / `fromSchemaResult`, the `draft07` constructor for hand-built documents, the flat `toJson()` publication shape, `serializeResult()`, `DRAFT_07_META_SCHEMA`.
 - `KeywordFamilies` — the one registry of declared non-standard keyword families (the vscode five, `x-taplo`, `x-tombi-`, `x-intellij-`, and the house `x-ai-` machine-annotation namespace). Anything outside it fails `fromSchema` with `UndeclaredAnnotationKeyError`; nothing is silently dropped.
 - `SchemaVersioning` / `SchemaVersion` — one-to-three-component version labels, `Order`, `latest`, `isPinned`, `next`, and the `fileName` / `schemaUrl` / `catalogUrls` derivations.

package/SchemastoreConfig.js

@@ -32,6 +32,7 @@ const LayoutInput = Schema.Literals(members({
 const EffectSchemaInput = Schema.declare((u) => Schema.isSchema(u), { expected: "an Effect Schema" });
 const OptionsInput = Schema.declare((u) => Predicate.isObject(u), { expected: "an object" });
 const CatalogBlockInput = Schema.Struct({
+	name: Schema.optionalKey(Schema.NonEmptyString),
 	description: Schema.String,
 	fileMatch: Schema.NonEmptyArray(Schema.String)
 });
@@ -63,6 +64,10 @@ const DECODE_OPTIONS = {
 	errors: "all"
 };
 const withoutUndefined = (input) => Predicate.isObject(input) && !Array.isArray(input) ? Object.fromEntries(Object.entries(input).filter(([, value]) => value !== void 0)) : input;
+const withoutUndefinedCatalog = (entry) => Predicate.isObject(entry) && !Array.isArray(entry) && "catalog" in entry ? {
+	...entry,
+	catalog: withoutUndefined(entry.catalog)
+} : entry;
 const decodeOrThrow = (schema, input, prefix) => Result.getOrThrowWith(Schema.decodeUnknownResult(schema)(input, DECODE_OPTIONS), (error) => /* @__PURE__ */ new Error(`defineConfig: ${prefix}${error.message.replace(/\n\s*/g, " ")}`));
 const resolveIdentity = (name, entry, defaultBaseUrl) => {
 	if (entry.hosted !== void 0) {
@@ -91,7 +96,7 @@ const resolveIdentity = (name, entry, defaultBaseUrl) => {
 };
 const resolveEntry = (name, input, defaults, outputDir) => {
 	if (!SchemaVersioning.isSimpleName(name)) return fail(`schema "${name}" must be keyed by a simple file base name (no separators, no whitespace)`);
-	const entry = decodeOrThrow(EntryInput, withoutUndefined(input), `schema "${name}" `);
+	const entry = decodeOrThrow(EntryInput, withoutUndefinedCatalog(withoutUndefined(input)), `schema "${name}" `);
 	const hosted = resolveIdentity(name, entry, defaults.baseUrl);
 	if (hosted.baseUrl === "schemastore" && entry.catalog === void 0) return fail(`schema "${name}" must declare a catalog block under baseUrl "schemastore"`);
 	const versions = hosted.resolvedVersions;
@@ -124,7 +129,8 @@ const resolveEntry = (name, input, defaults, outputDir) => {
 		url: hosted.urlFor(version)
 	}));
 	const catalog = entry.catalog === void 0 ? void 0 : CatalogEntry.assemble({
-		name,
+		name: entry.catalog.name ?? name,
+		fileBaseName: name,
 		description: entry.catalog.description,
 		fileMatch: entry.catalog.fileMatch,
 		baseUrl: hosted.catalogBase,
@@ -163,6 +169,15 @@ const assertCatalogDirHoldsOnlySlices = (catalogDir, outputDir, documents) => {
 	if (dir === normalizePath(outputDir)) fail(`catalogDir "${catalogDir}" must not be outputDir: every *.json file in it is read as a catalog slice`);
 	for (const document of documents) if (normalizePath(`${document}/..`) === dir) fail(`output path "${document}" sits in catalogDir "${catalogDir}", which holds only catalog slices`);
 };
+const assertUniqueCatalogNames = (schemas) => {
+	const owners = /* @__PURE__ */ new Map();
+	for (const schema of schemas) {
+		if (schema.catalog === void 0) continue;
+		const owner = owners.get(schema.catalog.name);
+		if (owner !== void 0) fail(`schemas "${owner}" and "${schema.name}" both name their catalog entry "${schema.catalog.name}"`);
+		owners.set(schema.catalog.name, schema.name);
+	}
+};
 const assertUniquePaths = (paths) => {
 	const seen = /* @__PURE__ */ new Set();
 	for (const p of paths) {
@@ -199,7 +214,9 @@ const assertUniquePaths = (paths) => {
 * four fields beside it); the config `name` is required (a missing one
 * fails `defineConfig: name is required — …`, naming what it is for), and
 * it and every schema key must be simple file base names; a `catalog` is required under
-* `baseUrl: "schemastore"`; an empty `schemas` record is rejected; a
+* `baseUrl: "schemastore"`; two cataloged schemas whose catalog
+* entries resolve to one `name` (a `catalog.name`, else the key) are
+* rejected, naming both keys; an empty `schemas` record is rejected; a
 * `catalogDir` that is `outputDir`, that is the merged catalog's own path,
 * or that a derived document sits directly in, is rejected (every `*.json`
 * file there is read as a catalog slice); and an output path (a target, a frozen file, this config's
@@ -238,6 +255,7 @@ const defineConfig = (input) => {
 		drift: config.drift ?? DriftPolicy.defaults.policy
 	};
 	const schemas = Object.entries(config.schemas).map(([name, entry]) => resolveEntry(name, entry, defaults, outputDir));
+	assertUniqueCatalogNames(schemas);
 	const catalogDir = config.catalogDir !== void 0 ? trimSlashes(config.catalogDir) : `${outputDir}/catalogs`;
 	const documents = schemas.flatMap((s) => [s.target.path, ...s.frozen.map((f) => f.path)]);
 	assertCatalogDirHoldsOnlySlices(catalogDir, outputDir, documents);

package/index.d.ts

@@ -1939,6 +1939,16 @@ declare const ConfigBrand: unique symbol;
  * @public
  */
 interface CatalogInput {
+  /**
+   * The entry's display name in the catalog — what an editor or SchemaStore
+   * shows. Defaults to the schema's key. Only the catalog entry's `name`
+   * changes: the key still names the file, `$id` and every catalog URL, so
+   * a versioned `<version>/<name>.json` layout keeps its short file names.
+   * Must be non-empty, and unique among the config's cataloged schemas
+   * (compared after defaulting, so it must not equal another cataloged
+   * schema's key either).
+   */
+  readonly name?: string;
   /** The catalog description. */
   readonly description: string;
   /** Glob patterns editors match files against; must be non-empty. */
@@ -2150,7 +2160,9 @@ interface SchemastoreConfig {
  * four fields beside it); the config `name` is required (a missing one
  * fails `defineConfig: name is required — …`, naming what it is for), and
  * it and every schema key must be simple file base names; a `catalog` is required under
- * `baseUrl: "schemastore"`; an empty `schemas` record is rejected; a
+ * `baseUrl: "schemastore"`; two cataloged schemas whose catalog
+ * entries resolve to one `name` (a `catalog.name`, else the key) are
+ * rejected, naming both keys; an empty `schemas` record is rejected; a
  * `catalogDir` that is `outputDir`, that is the merged catalog's own path,
  * or that a derived document sits directly in, is rejected (every `*.json`
  * file there is read as a catalog slice); and an output path (a target, a frozen file, this config's

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/schemastore",
-	"version": "0.19.0",
+	"version": "0.21.0",
 	"private": false,
 	"description": "Build, validate, version and publish SchemaStore-shaped Draft-07 JSON Schema documents from Effect Schema sources: document assembly, ajv strict-mode validation, structural lints, catalog entries, canonical JSON and a content-comparing emit pipeline.",
 	"keywords": [