@openpkg-ts/spec 0.24.0 → 0.26.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 +9 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -375,10 +375,18 @@ type SpecGenerationInfo = {
|
|
|
375
375
|
};
|
|
376
376
|
/** Supported OpenPkg spec versions */
|
|
377
377
|
type OpenPkgVersion = "0.2.0" | "0.3.0" | "0.4.0";
|
|
378
|
+
/** Extraction mode indicating source type */
|
|
379
|
+
type SpecExtractionMode = "source" | "declaration-only";
|
|
380
|
+
/** Known limitations when extracting from declaration-only sources */
|
|
381
|
+
type SpecExtractionLimitation = "No JSDoc descriptions" | "No @example tags" | "No @param descriptions";
|
|
378
382
|
/** Minimal generation metadata for v0.4.0 */
|
|
379
383
|
type SpecGenerationMeta = {
|
|
380
384
|
generator?: string;
|
|
381
385
|
timestamp?: string;
|
|
386
|
+
/** Extraction mode: 'source' (full .ts) or 'declaration-only' (.d.ts) */
|
|
387
|
+
mode?: SpecExtractionMode;
|
|
388
|
+
/** Known limitations when in declaration-only mode */
|
|
389
|
+
limitations?: SpecExtractionLimitation[];
|
|
382
390
|
};
|
|
383
391
|
type OpenPkg = {
|
|
384
392
|
$schema?: string;
|
|
@@ -521,4 +529,4 @@ declare function assertSpec(spec: unknown, version?: SchemaVersion): asserts spe
|
|
|
521
529
|
* @returns Array of validation errors (empty if valid)
|
|
522
530
|
*/
|
|
523
531
|
declare function getValidationErrors(spec: unknown, version?: SchemaVersion): SpecError[];
|
|
524
|
-
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, 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 };
|
|
532
|
+
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 };
|