@openpkg-ts/spec 0.31.1 → 0.33.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.
Files changed (2) hide show
  1. package/dist/index.d.ts +13 -1
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -264,6 +264,7 @@ type SpecExport = {
264
264
  examples?: (string | SpecExample)[];
265
265
  source?: SpecSource;
266
266
  deprecated?: boolean;
267
+ deprecationReason?: string;
267
268
  flags?: Record<string, unknown>;
268
269
  tags?: SpecTag[];
269
270
  extends?: string;
@@ -379,6 +380,13 @@ type OpenPkgVersion = "0.2.0" | "0.3.0" | "0.4.0";
379
380
  type SpecExtractionMode = "source" | "declaration-only";
380
381
  /** Known limitations when extracting from declaration-only sources */
381
382
  type SpecExtractionLimitation = "No JSDoc descriptions" | "No @example tags" | "No @param descriptions";
383
+ /** Skipped info for generation metadata */
384
+ type SpecSkippedExport = {
385
+ name: string;
386
+ reason: "filtered" | "no-declaration" | "internal" | "external-unresolved";
387
+ /** Package name when reason is external-unresolved */
388
+ package?: string;
389
+ };
382
390
  /** Minimal generation metadata for v0.4.0 */
383
391
  type SpecGenerationMeta = {
384
392
  generator?: string;
@@ -387,6 +395,10 @@ type SpecGenerationMeta = {
387
395
  mode?: SpecExtractionMode;
388
396
  /** Known limitations when in declaration-only mode */
389
397
  limitations?: SpecExtractionLimitation[];
398
+ /** Schema extraction method (when using hybrid mode) */
399
+ schemaExtraction?: "hybrid";
400
+ /** Exports that were skipped during extraction */
401
+ skipped?: SpecSkippedExport[];
390
402
  };
391
403
  type OpenPkg = {
392
404
  $schema?: string;
@@ -538,4 +550,4 @@ declare function assertSpec(spec: unknown, version?: SchemaVersion): asserts spe
538
550
  * @returns Array of validation errors (empty if valid)
539
551
  */
540
552
  declare function getValidationErrors(spec: unknown, version?: SchemaVersion): SpecError[];
541
- 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 };
553
+ 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 };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openpkg-ts/spec",
3
- "version": "0.31.1",
3
+ "version": "0.33.0",
4
4
  "description": "Shared schema, validation, and diff utilities for OpenPkg specs",
5
5
  "keywords": [
6
6
  "openpkg",