@openpkg-ts/spec 0.32.0 → 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.
- package/dist/index.d.ts +12 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -380,6 +380,13 @@ type OpenPkgVersion = "0.2.0" | "0.3.0" | "0.4.0";
|
|
|
380
380
|
type SpecExtractionMode = "source" | "declaration-only";
|
|
381
381
|
/** Known limitations when extracting from declaration-only sources */
|
|
382
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
|
+
};
|
|
383
390
|
/** Minimal generation metadata for v0.4.0 */
|
|
384
391
|
type SpecGenerationMeta = {
|
|
385
392
|
generator?: string;
|
|
@@ -388,6 +395,10 @@ type SpecGenerationMeta = {
|
|
|
388
395
|
mode?: SpecExtractionMode;
|
|
389
396
|
/** Known limitations when in declaration-only mode */
|
|
390
397
|
limitations?: SpecExtractionLimitation[];
|
|
398
|
+
/** Schema extraction method (when using hybrid mode) */
|
|
399
|
+
schemaExtraction?: "hybrid";
|
|
400
|
+
/** Exports that were skipped during extraction */
|
|
401
|
+
skipped?: SpecSkippedExport[];
|
|
391
402
|
};
|
|
392
403
|
type OpenPkg = {
|
|
393
404
|
$schema?: string;
|
|
@@ -539,4 +550,4 @@ declare function assertSpec(spec: unknown, version?: SchemaVersion): asserts spe
|
|
|
539
550
|
* @returns Array of validation errors (empty if valid)
|
|
540
551
|
*/
|
|
541
552
|
declare function getValidationErrors(spec: unknown, version?: SchemaVersion): SpecError[];
|
|
542
|
-
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 };
|