@openpkg-ts/spec 0.34.1 → 0.35.1

package/dist/index.d.ts

@@ -414,6 +414,14 @@ type OpenPkg = {
 declare const SCHEMA_VERSION: OpenPkgVersion;
 declare const SCHEMA_URL = "https://unpkg.com/@openpkg-ts/spec/schemas/v0.4.0/openpkg.schema.json";
 declare const JSON_SCHEMA_DRAFT = "https://json-schema.org/draft/2020-12/schema";
+/** The 6 kinds relevant for UI display (excludes namespace, module, reference, external). */
+type DisplayKind = Extract<SpecExportKind, "function" | "class" | "interface" | "type" | "enum" | "variable">;
+/** Canonical display order for UI-facing kind groups. */
+declare const DISPLAY_KIND_ORDER: DisplayKind[];
+/** Human-readable plural labels for every kind. */
+declare const KIND_LABELS: Record<SpecExportKind, string>;
+/** URL-safe slug for every kind. */
+declare const KIND_SLUGS: Record<SpecExportKind, string>;
 declare function dereference(spec: OpenPkg): OpenPkg;
 type BreakingSeverity = "high" | "medium" | "low";
 interface CategorizedBreaking {
@@ -510,8 +518,10 @@ declare function recommendSemverBump(diff: SpecDiff): SemverRecommendation;
 */
 declare function calculateNextVersion(currentVersion: string, bump: SemverBump): string;
 declare function normalize(spec: OpenPkg): OpenPkg;
+/** Concrete schema versions (excludes 'latest' alias) */
+type ConcreteSchemaVersion = "0.1.0" | "0.2.0" | "0.3.0" | "0.4.0";
 /** Supported schema versions */
-type SchemaVersion = "0.1.0" | "0.2.0" | "0.3.0" | "0.4.0" | "latest";
+type SchemaVersion = ConcreteSchemaVersion | "latest";
 type SpecError = {
 	instancePath: string;
 	message: string;
@@ -550,4 +560,4 @@ declare function assertSpec(spec: unknown, version?: SchemaVersion): asserts spe
 * @returns Array of validation errors (empty if valid)
 */
 declare function getValidationErrors(spec: unknown, version?: SchemaVersion): SpecError[];
-export { validateSpec, recommendSemverBump, normalize, getValidationErrors, getAvailableVersions, diffSpec, dereference, categorizeBreakingChanges, calculateNextVersion, assertSpec, SpecVisibility, SpecTypePredicate, SpecTypeParameter, SpecTypeKind, SpecTypeAliasKind, SpecType, SpecThrows, SpecTagParam, SpecTag, SpecSource, SpecSkippedExport, SpecSignatureReturn, SpecSignatureParameter, SpecSignature, SpecSchemaRef, SpecSchemaPrimitive, SpecSchemaGeneric, SpecSchemaFallback, SpecSchemaComposite, SpecSchemaCombinator, SpecSchema, SpecPresentationMeta, SpecMember, SpecMappedType, SpecInheritedMember, SpecGenerationMeta, SpecGenerationInfo, SpecExtractionMode, SpecExtractionLimitation, SpecExtensions, SpecExtension, SpecExportKind, SpecExport, SpecExampleLanguage, SpecExample, SpecDiff, SpecDecorator, SpecConditionalType, SemverRecommendation, SemverBump, SCHEMA_VERSION, SCHEMA_URL, OpenPkgVersion, OpenPkgMeta, OpenPkg, MemberChangeInfo, JSON_SCHEMA_DRAFT, JSONSchemaExtensions, GenerationIssueSeverity, GenerationIssue, EntryPointDetectionMethod, DiffOptions, CategorizedBreaking, BreakingSeverity };
+export { validateSpec, recommendSemverBump, normalize, getValidationErrors, getAvailableVersions, diffSpec, dereference, categorizeBreakingChanges, calculateNextVersion, assertSpec, SpecVisibility, SpecTypePredicate, SpecTypeParameter, SpecTypeKind, SpecTypeAliasKind, SpecType, SpecThrows, SpecTagParam, SpecTag, SpecSource, SpecSkippedExport, SpecSignatureReturn, SpecSignatureParameter, SpecSignature, SpecSchemaRef, SpecSchemaPrimitive, SpecSchemaGeneric, SpecSchemaFallback, SpecSchemaComposite, SpecSchemaCombinator, SpecSchema, SpecPresentationMeta, SpecMember, SpecMappedType, SpecInheritedMember, SpecGenerationMeta, SpecGenerationInfo, SpecExtractionMode, SpecExtractionLimitation, SpecExtensions, SpecExtension, SpecExportKind, SpecExport, SpecExampleLanguage, SpecExample, SpecDiff, SpecDecorator, SpecConditionalType, SemverRecommendation, SemverBump, SCHEMA_VERSION, SCHEMA_URL, OpenPkgVersion, OpenPkgMeta, OpenPkg, MemberChangeInfo, KIND_SLUGS, KIND_LABELS, JSON_SCHEMA_DRAFT, JSONSchemaExtensions, GenerationIssueSeverity, GenerationIssue, EntryPointDetectionMethod, DisplayKind, DiffOptions, DISPLAY_KIND_ORDER, CategorizedBreaking, BreakingSeverity };

package/dist/index.js

@@ -2,9 +2,41 @@
 var SCHEMA_VERSION = "0.4.0";
 var SCHEMA_URL = "https://unpkg.com/@openpkg-ts/spec/schemas/v0.4.0/openpkg.schema.json";
 var JSON_SCHEMA_DRAFT = "https://json-schema.org/draft/2020-12/schema";
+var DISPLAY_KIND_ORDER = [
+  "function",
+  "class",
+  "interface",
+  "type",
+  "enum",
+  "variable"
+];
+var KIND_LABELS = {
+  function: "Functions",
+  class: "Classes",
+  interface: "Interfaces",
+  type: "Types",
+  enum: "Enums",
+  variable: "Variables",
+  namespace: "Namespaces",
+  module: "Modules",
+  reference: "References",
+  external: "External"
+};
+var KIND_SLUGS = {
+  function: "functions",
+  class: "classes",
+  interface: "interfaces",
+  type: "types",
+  enum: "enums",
+  variable: "variables",
+  namespace: "namespaces",
+  module: "modules",
+  reference: "references",
+  external: "externals"
+};
 // src/deref.ts
 function dereference(spec) {
-  const clone = JSON.parse(JSON.stringify(spec));
+  const clone = structuredClone(spec);
   const typeLookup = buildTypeLookup(clone.types);
   const visit = (value, seen) => {
     if (Array.isArray(value)) {
@@ -63,9 +95,9 @@ function resolveTypeRef(id, lookup, seen) {
   }
   seen.add(id);
   if (target.schema) {
-    return JSON.parse(JSON.stringify(target.schema));
+    return structuredClone(target.schema);
   }
-  return JSON.parse(JSON.stringify(target));
+  return structuredClone(target);
 }
 // src/diff.ts
 function diffSpec(oldSpec, newSpec, options) {
@@ -281,7 +313,9 @@ function calculateNextVersion(currentVersion, bump) {
   if (!match) {
     return currentVersion;
   }
-  let [, major, minor, patch] = match.map(Number);
+  let major = parseInt(match[1], 10);
+  let minor = parseInt(match[2], 10);
+  let patch = parseInt(match[3], 10);
   switch (bump) {
     case "major":
       major++;
@@ -332,30 +366,9 @@ function normalizeGeneration(gen) {
   }
   return gen;
 }
-function normalizeExport(item) {
-  const clone = structuredClone(item);
-  for (const field of arrayFieldsByExport) {
-    if (!Array.isArray(clone[field])) {
-      clone[field] = [];
-    }
-  }
-  if (clone.type !== undefined && typeof clone.type !== "string") {
-    if (!clone.schema) {
-      clone.schema = clone.type;
-    }
-    delete clone.type;
-  }
-  if (clone.tags && clone.tags.length > 0) {
-    clone.tags = clone.tags.map(normalizeTag);
-  }
-  if (clone.members && clone.members.length > 0) {
-    clone.members = clone.members.map(normalizeMember);
-  }
-  return clone;
-}
-function normalizeType(item) {
+function normalizeEntry(item, arrayFields) {
   const clone = structuredClone(item);
-  for (const field of arrayFieldsByType) {
+  for (const field of arrayFields) {
     if (!Array.isArray(clone[field])) {
       clone[field] = [];
     }
@@ -374,6 +387,8 @@ function normalizeType(item) {
   }
   return clone;
 }
+var normalizeExport = (item) => normalizeEntry(item, arrayFieldsByExport);
+var normalizeType = (item) => normalizeEntry(item, arrayFieldsByType);
 function normalizeTag(tag) {
   const result = {
     name: tag.name,
@@ -2586,5 +2601,8 @@ export {
   assertSpec,
   SCHEMA_VERSION,
   SCHEMA_URL,
-  JSON_SCHEMA_DRAFT
+  KIND_SLUGS,
+  KIND_LABELS,
+  JSON_SCHEMA_DRAFT,
+  DISPLAY_KIND_ORDER
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpkg-ts/spec",
-  "version": "0.34.1",
+  "version": "0.35.1",
   "description": "Shared schema, validation, and diff utilities for OpenPkg specs",
   "keywords": [
     "openpkg",