@openpkg-ts/spec 0.27.1 → 0.31.0

package/README.md

@@ -66,8 +66,8 @@ const diff = diffSpec(baseSpec, headSpec);
 
 console.log(`Added: ${diff.added.length}`);
 console.log(`Removed: ${diff.removed.length}`);
-console.log(`Modified: ${diff.modified.length}`);
 console.log(`Breaking: ${diff.breaking.length}`);
+console.log(`Docs only: ${diff.docsOnly.length}`);
 
 // Get semver recommendation
 const recommendation = recommendSemverBump(diff);
@@ -79,6 +79,21 @@ const next = calculateNextVersion('1.2.3', recommendation.bump);
 console.log(`Next version: ${next}`); // '2.0.0'
 ```
 
+### DiffOptions
+
+Filter diff results by criteria.
+
+```typescript
+import { diffSpec, type DiffOptions } from '@openpkg-ts/spec';
+
+const options: DiffOptions = {
+  includeDocsOnly: false,  // exclude documentation-only changes
+  kinds: ['function', 'class'],  // filter by export kind
+};
+
+const diff = diffSpec(oldSpec, newSpec, options);
+```
+
 ## Dereferencing
 
 Resolve `$ref` pointers in the spec.
@@ -101,6 +116,10 @@ import type {
   SpecClass,
   SpecInterface,
   SpecMeta,
+  SpecDiff,
+  DiffOptions,
+  SemverBump,
+  SemverRecommendation,
 } from '@openpkg-ts/spec';
 ```
 
@@ -117,10 +136,10 @@ import type {
 - `dereference(spec)` - Resolve $ref pointers
 
 ### Diffing
-- `diffSpec(base, head)` - Compare specs
+- `diffSpec(base, head, options?)` - Compare specs (supports `DiffOptions`)
 - `recommendSemverBump(diff)` - Suggest version bump
 - `calculateNextVersion(version, bump)` - Calculate next version
-- `categorizeBreakingChanges(diff)` - Group by severity
+- `categorizeBreakingChanges(breaking, old, new)` - Group by severity
 
 ### Types
 - `OpenPkg` - Root spec type
@@ -128,6 +147,8 @@ import type {
 - `SpecType` - Type definition
 - `SpecFunction`, `SpecClass`, `SpecInterface` - Export kinds
 - `SpecDiff` - Diff result type
+- `DiffOptions` - Diff filtering options
+- `SemverBump`, `SemverRecommendation` - Semver types
 
 ## License
 

package/dist/index.d.ts

@@ -424,9 +424,18 @@ type SpecDiff = {
 	docsOnly: string[];
 };
 /**
+* Options for diffSpec filtering.
+*/
+interface DiffOptions {
+	/** Include documentation-only changes (default: true) */
+	includeDocsOnly?: boolean;
+	/** Filter by kinds */
+	kinds?: SpecExportKind[];
+}
+/**
 * Compare two OpenPkg specs and compute differences.
 */
-declare function diffSpec(oldSpec: OpenPkg, newSpec: OpenPkg): SpecDiff;
+declare function diffSpec(oldSpec: OpenPkg, newSpec: OpenPkg, options?: DiffOptions): SpecDiff;
 /**
 * Categorize breaking changes by severity
 */
@@ -529,4 +538,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, 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, CategorizedBreaking, BreakingSeverity };
+export { validateSpec, recommendSemverBump, normalize, getValidationErrors, getAvailableVersions, diffSpec, dereference, categorizeBreakingChanges, calculateNextVersion, assertSpec, SpecVisibility, SpecTypePredicate, SpecTypeParameter, SpecTypeKind, SpecTypeAliasKind, SpecType, SpecThrows, SpecTagParam, SpecTag, SpecSource, 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 };

package/dist/index.js

@@ -68,24 +68,26 @@ function resolveTypeRef(id, lookup, seen) {
   return JSON.parse(JSON.stringify(target));
 }
 // src/diff.ts
-function diffSpec(oldSpec, newSpec) {
+function diffSpec(oldSpec, newSpec, options) {
+  const { includeDocsOnly = true, kinds } = options ?? {};
+  let oldExports = oldSpec.exports;
+  let newExports = newSpec.exports;
+  if (kinds && kinds.length > 0) {
+    const kindSet = new Set(kinds);
+    oldExports = oldExports.filter((e) => kindSet.has(e.kind));
+    newExports = newExports.filter((e) => kindSet.has(e.kind));
+  }
   const result = {
     breaking: [],
     nonBreaking: [],
     docsOnly: []
   };
-  diffCollections(result, oldSpec.exports, newSpec.exports);
+  diffCollections(result, oldExports, newExports);
   diffCollections(result, oldSpec.types ?? [], newSpec.types ?? []);
-  return result;
-}
-function toExportMap(exports) {
-  const map = new Map;
-  for (const exp of exports) {
-    if (exp && typeof exp.id === "string") {
-      map.set(exp.id, exp);
-    }
+  if (!includeDocsOnly) {
+    result.docsOnly = [];
   }
-  return map;
+  return result;
 }
 function diffCollections(result, oldItems, newItems) {
   const oldMap = toMap(oldItems);
@@ -168,8 +170,8 @@ function sortKeys(value) {
   return result;
 }
 function categorizeBreakingChanges(breaking, oldSpec, newSpec, memberChanges) {
-  const oldExportMap = toExportMap(oldSpec.exports);
-  const newExportMap = toExportMap(newSpec.exports);
+  const oldExportMap = toMap(oldSpec.exports);
+  const newExportMap = toMap(newSpec.exports);
   const categorized = [];
   for (const id of breaking) {
     const oldExport = oldExportMap.get(id);

package/package.json

@@ -1,19 +1,18 @@
 {
   "name": "@openpkg-ts/spec",
-  "version": "0.27.1",
+  "version": "0.31.0",
   "description": "Shared schema, validation, and diff utilities for OpenPkg specs",
   "keywords": [
     "openpkg",
-    "doccov",
     "json-schema",
     "validation",
     "typescript",
     "spec"
   ],
-  "homepage": "https://github.com/doccov/doccov#readme",
+  "homepage": "https://github.com/ryanwaits/openpkg-ts#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/doccov/doccov.git",
+    "url": "git+https://github.com/ryanwaits/openpkg-ts.git",
     "directory": "packages/spec"
   },
   "license": "MIT",
@@ -23,8 +22,8 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "import": "./src/index.ts",
+      "types": "./src/index.ts"
     }
   },
   "files": [