@openpkg-ts/spec 0.4.1 → 0.6.0

package/dist/index.d.ts

@@ -1,9 +1,35 @@
-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 SpecTypeAliasKind = "alias" | "conditional" | "mapped" | "template-literal" | "infer";
+type SpecConditionalType = {
+	checkType: string;
+	extendsType: string;
+	trueType: string;
+	falseType: string;
+};
+type SpecMappedType = {
+	typeParameter: string;
+	nameType?: string;
+	valueType?: string;
+	readonly?: "+" | "-" | true;
+	optional?: "+" | "-" | true;
+};
+type SpecDecorator = {
+	name: string;
+	arguments?: unknown[];
+	argumentsText?: string[];
+};
+type SpecThrows = {
+	type?: string;
+	description?: string;
 };
 type SpecSource = {
 	file?: string;
@@ -36,6 +62,9 @@ type SpecSignatureParameter = {
 	required?: boolean;
 	description?: string;
 	schema: SpecSchema;
+	default?: unknown;
+	rest?: boolean;
+	decorators?: SpecDecorator[];
 };
 type SpecSignatureReturn = {
 	schema: SpecSchema;
@@ -47,6 +76,9 @@ type SpecSignature = {
 	returns?: SpecSignatureReturn;
 	description?: string;
 	typeParameters?: SpecTypeParameter[];
+	overloadIndex?: number;
+	isImplementation?: boolean;
+	throws?: SpecThrows[];
 };
 type SpecMember = {
 	id?: string;
@@ -58,6 +90,7 @@ type SpecMember = {
 	flags?: Record<string, unknown>;
 	schema?: SpecSchema;
 	signatures?: SpecSignature[];
+	decorators?: SpecDecorator[];
 };
 type SpecExportKind = "function" | "class" | "variable" | "interface" | "type" | "enum" | "module" | "namespace" | "reference" | "external";
 type SpecTypeKind = "class" | "interface" | "type" | "enum" | "external";
@@ -84,6 +117,12 @@ type SpecExport = {
 	tags?: SpecTag[];
 	extends?: string;
 	implements?: string[];
+	typeAliasKind?: SpecTypeAliasKind;
+	conditionalType?: SpecConditionalType;
+	mappedType?: SpecMappedType;
+	decorators?: SpecDecorator[];
+	isAugmentation?: boolean;
+	augmentedModule?: string;
 };
 type SpecType = {
 	id: string;
@@ -103,6 +142,9 @@ type SpecType = {
 	rawComments?: string;
 	extends?: string;
 	implements?: string[];
+	typeAliasKind?: SpecTypeAliasKind;
+	conditionalType?: SpecConditionalType;
+	mappedType?: SpecMappedType;
 };
 type OpenPkgMeta = {
 	name: string;
@@ -112,9 +154,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 +166,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 {
@@ -164,7 +211,7 @@ 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" | "latest";
+type SchemaVersion = "0.1.0" | "0.2.0" | "0.3.0" | "latest";
 type SpecError = {
 	instancePath: string;
 	message: string;
@@ -199,4 +246,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, 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 };
+export { validateSpec, normalize, getValidationErrors, diffSpec, dereference, categorizeBreakingChanges, assertSpec, SpecVisibility, SpecTypeParameter, SpecTypeKind, SpecTypeAliasKind, SpecType, SpecThrows, SpecTag, SpecSource, SpecSignatureReturn, SpecSignatureParameter, SpecSignature, SpecSchema, SpecMember, SpecMappedType, SpecExtension, SpecExportKind, SpecExport, SpecExample, SpecDocsMetadata, SpecDocSignal, SpecDocDrift, SpecDiff, SpecDecorator, SpecConditionalType, SCHEMA_VERSION, SCHEMA_URL, OpenPkgVersion, OpenPkgMeta, OpenPkg, MemberChangeInfo, JSON_SCHEMA_DRAFT, CategorizedBreaking, BreakingSeverity };