@openpkg-ts/spec 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -1,9 +1,12 @@
-declare const SCHEMA_VERSION = "0.2.0";
-declare const SCHEMA_URL = "https://unpkg.com/@openpkg-ts/spec/schemas/v0.2.0/openpkg.schema.json";
-declare const JSON_SCHEMA_DRAFT = "https://json-schema.org/draft/2020-12/schema";
 type SpecTag = {
 	name: string;
 	text: string;
+	paramName?: string;
+	typeAnnotation?: string;
+	reference?: string;
+	language?: string;
+	version?: string;
+	reason?: string;
 };
 type SpecSource = {
 	file?: string;
@@ -36,6 +39,8 @@ type SpecSignatureParameter = {
 	required?: boolean;
 	description?: string;
 	schema: SpecSchema;
+	default?: unknown;
+	rest?: boolean;
 };
 type SpecSignatureReturn = {
 	schema: SpecSchema;
@@ -47,6 +52,8 @@ type SpecSignature = {
 	returns?: SpecSignatureReturn;
 	description?: string;
 	typeParameters?: SpecTypeParameter[];
+	overloadIndex?: number;
+	isImplementation?: boolean;
 };
 type SpecMember = {
 	id?: string;
@@ -112,9 +119,11 @@ type OpenPkgMeta = {
 	repository?: string;
 	ecosystem?: string;
 };
+/** Supported OpenPkg spec versions */
+type OpenPkgVersion = "0.2.0" | "0.3.0";
 type OpenPkg = {
 	$schema?: string;
-	openpkg: "0.2.0";
+	openpkg: OpenPkgVersion;
 	meta: OpenPkgMeta;
 	exports: SpecExport[];
 	types?: SpecType[];
@@ -122,6 +131,9 @@ type OpenPkg = {
 	docs?: SpecDocsMetadata;
 	extensions?: SpecExtension;
 };
+declare const SCHEMA_VERSION: OpenPkgVersion;
+declare const SCHEMA_URL = "https://unpkg.com/@openpkg-ts/spec/schemas/v0.3.0/openpkg.schema.json";
+declare const JSON_SCHEMA_DRAFT = "https://json-schema.org/draft/2020-12/schema";
 declare function dereference(spec: OpenPkg): OpenPkg;
 type BreakingSeverity = "high" | "medium" | "low";
 interface CategorizedBreaking {
@@ -163,17 +175,40 @@ declare function diffSpec(oldSpec: OpenPkg, newSpec: OpenPkg): SpecDiff;
 */
 declare function categorizeBreakingChanges(breaking: string[], oldSpec: OpenPkg, newSpec: OpenPkg, memberChanges?: MemberChangeInfo[]): CategorizedBreaking[];
 declare function normalize(spec: OpenPkg): OpenPkg;
+/** Supported schema versions */
+type SchemaVersion = "0.1.0" | "0.2.0" | "0.3.0" | "latest";
 type SpecError = {
 	instancePath: string;
 	message: string;
 	keyword: string;
 };
-declare function validateSpec(spec: unknown): {
+/**
+* Validate a spec against a specific schema version.
+*
+* @param spec - The spec object to validate
+* @param version - Schema version to validate against (default: 'latest')
+* @returns Validation result
+*/
+declare function validateSpec(spec: unknown, version?: SchemaVersion): {
 	ok: true;
 } | {
 	ok: false;
 	errors: SpecError[];
 };
-declare function assertSpec(spec: unknown): asserts spec is OpenPkg;
-declare function getValidationErrors(spec: unknown): SpecError[];
-export { validateSpec, normalize, getValidationErrors, diffSpec, dereference, categorizeBreakingChanges, assertSpec, SpecVisibility, SpecTypeParameter, SpecTypeKind, SpecType, SpecTag, SpecSource, SpecSignatureReturn, SpecSignatureParameter, SpecSignature, SpecSchema, SpecMember, SpecExtension, SpecExportKind, SpecExport, SpecExample, SpecDocsMetadata, SpecDocSignal, SpecDocDrift, SpecDiff, SCHEMA_VERSION, SCHEMA_URL, OpenPkgMeta, OpenPkg, MemberChangeInfo, JSON_SCHEMA_DRAFT, CategorizedBreaking, BreakingSeverity };
+/**
+* Assert that a value is a valid OpenPkg spec.
+* Throws an error with details if validation fails.
+*
+* @param spec - The value to validate
+* @param version - Schema version to validate against (default: 'latest')
+*/
+declare function assertSpec(spec: unknown, version?: SchemaVersion): asserts spec is OpenPkg;
+/**
+* Get validation errors for a spec.
+*
+* @param spec - The spec to validate
+* @param version - Schema version to validate against (default: 'latest')
+* @returns Array of validation errors (empty if valid)
+*/
+declare function getValidationErrors(spec: unknown, version?: SchemaVersion): SpecError[];
+export { validateSpec, normalize, getValidationErrors, diffSpec, dereference, categorizeBreakingChanges, assertSpec, SpecVisibility, SpecTypeParameter, SpecTypeKind, SpecType, SpecTag, SpecSource, SpecSignatureReturn, SpecSignatureParameter, SpecSignature, SpecSchema, SpecMember, SpecExtension, SpecExportKind, SpecExport, SpecExample, SpecDocsMetadata, SpecDocSignal, SpecDocDrift, SpecDiff, SCHEMA_VERSION, SCHEMA_URL, OpenPkgVersion, OpenPkgMeta, OpenPkg, MemberChangeInfo, JSON_SCHEMA_DRAFT, CategorizedBreaking, BreakingSeverity };