@openpkg-ts/spec 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -8,6 +8,29 @@ type SpecTag = {
 	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;
 	line?: number;
@@ -41,6 +64,7 @@ type SpecSignatureParameter = {
 	schema: SpecSchema;
 	default?: unknown;
 	rest?: boolean;
+	decorators?: SpecDecorator[];
 };
 type SpecSignatureReturn = {
 	schema: SpecSchema;
@@ -54,6 +78,7 @@ type SpecSignature = {
 	typeParameters?: SpecTypeParameter[];
 	overloadIndex?: number;
 	isImplementation?: boolean;
+	throws?: SpecThrows[];
 };
 type SpecMember = {
 	id?: string;
@@ -65,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";
@@ -91,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;
@@ -110,6 +142,9 @@ type SpecType = {
 	rawComments?: string;
 	extends?: string;
 	implements?: string[];
+	typeAliasKind?: SpecTypeAliasKind;
+	conditionalType?: SpecConditionalType;
+	mappedType?: SpecMappedType;
 };
 type OpenPkgMeta = {
 	name: string;
@@ -211,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, OpenPkgVersion, 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 };

package/dist/index.js

@@ -1285,6 +1285,31 @@ var openpkg_schema_default3 = {
         docs: {
           $ref: "#/$defs/docsMetadata",
           description: "Documentation coverage metadata for this export"
+        },
+        typeAliasKind: {
+          $ref: "#/$defs/typeAliasKind",
+          description: "Kind of type alias (for type exports)"
+        },
+        conditionalType: {
+          $ref: "#/$defs/conditionalType",
+          description: "Structural details for conditional types"
+        },
+        mappedType: {
+          $ref: "#/$defs/mappedType",
+          description: "Structural details for mapped types"
+        },
+        decorators: {
+          type: "array",
+          description: "Decorators applied to this export (class/function)",
+          items: { $ref: "#/$defs/decorator" }
+        },
+        isAugmentation: {
+          type: "boolean",
+          description: "True if this is a module augmentation (declare module)"
+        },
+        augmentedModule: {
+          type: "string",
+          description: "The module being augmented (e.g., 'express')"
         }
       }
     },
@@ -1359,6 +1384,18 @@ var openpkg_schema_default3 = {
         },
         source: {
           $ref: "#/$defs/sourceLocation"
+        },
+        typeAliasKind: {
+          $ref: "#/$defs/typeAliasKind",
+          description: "Kind of type alias"
+        },
+        conditionalType: {
+          $ref: "#/$defs/conditionalType",
+          description: "Structural details for conditional types"
+        },
+        mappedType: {
+          $ref: "#/$defs/mappedType",
+          description: "Structural details for mapped types"
         }
       }
     },
@@ -1433,6 +1470,11 @@ var openpkg_schema_default3 = {
         isImplementation: {
           type: "boolean",
           description: "True if this is the implementation signature (not user-callable)"
+        },
+        throws: {
+          type: "array",
+          description: "Exceptions that can be thrown by this signature",
+          items: { $ref: "#/$defs/throwsInfo" }
         }
       }
     },
@@ -1479,6 +1521,11 @@ var openpkg_schema_default3 = {
         rest: {
           type: "boolean",
           description: "Whether this is a rest parameter (...args)"
+        },
+        decorators: {
+          type: "array",
+          description: "Decorators applied to this parameter",
+          items: { $ref: "#/$defs/decorator" }
         }
       }
     },
@@ -1534,6 +1581,99 @@ var openpkg_schema_default3 = {
           minimum: 1
         }
       }
+    },
+    typeAliasKind: {
+      type: "string",
+      description: "Kind of type alias",
+      enum: ["alias", "conditional", "mapped", "template-literal", "infer"]
+    },
+    conditionalType: {
+      type: "object",
+      description: "Structural representation of a conditional type (T extends X ? Y : Z)",
+      required: ["checkType", "extendsType", "trueType", "falseType"],
+      properties: {
+        checkType: {
+          type: "string",
+          description: "The type being checked (T)"
+        },
+        extendsType: {
+          type: "string",
+          description: "The constraint type (X)"
+        },
+        trueType: {
+          type: "string",
+          description: "The type when condition is true (Y)"
+        },
+        falseType: {
+          type: "string",
+          description: "The type when condition is false (Z)"
+        }
+      },
+      additionalProperties: false
+    },
+    mappedType: {
+      type: "object",
+      description: "Structural representation of a mapped type ({ [K in keyof T]: ... })",
+      required: ["typeParameter"],
+      properties: {
+        typeParameter: {
+          type: "string",
+          description: "The type parameter clause (e.g., 'K in keyof T')"
+        },
+        nameType: {
+          type: "string",
+          description: "The 'as' clause for key remapping (TS 4.1+)"
+        },
+        valueType: {
+          type: "string",
+          description: "The mapped value type"
+        },
+        readonly: {
+          description: "Readonly modifier (+, -, or true for present)",
+          oneOf: [{ type: "boolean" }, { enum: ["+", "-"] }]
+        },
+        optional: {
+          description: "Optional modifier (+, -, or true for present)",
+          oneOf: [{ type: "boolean" }, { enum: ["+", "-"] }]
+        }
+      },
+      additionalProperties: false
+    },
+    decorator: {
+      type: "object",
+      description: "Decorator applied to a class, member, or parameter",
+      required: ["name"],
+      properties: {
+        name: {
+          type: "string",
+          description: "Decorator name (e.g., 'Injectable', 'Component')"
+        },
+        arguments: {
+          type: "array",
+          description: "Evaluated decorator arguments (if possible)"
+        },
+        argumentsText: {
+          type: "array",
+          description: "Raw text of decorator arguments",
+          items: { type: "string" }
+        }
+      },
+      additionalProperties: false
+    },
+    throwsInfo: {
+      type: "object",
+      description: "Information about an exception that can be thrown",
+      properties: {
+        type: {
+          type: "string",
+          description: "Exception type (e.g., 'ValidationError', 'Error')"
+        },
+        description: {
+          type: "string",
+          description: "When/why the exception is thrown"
+        }
+      },
+      additionalProperties: false
     }
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpkg-ts/spec",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Shared schema, validation, and diff utilities for OpenPkg specs",
   "keywords": [
     "openpkg",

package/schemas/v0.3.0/openpkg.schema.json

@@ -233,6 +233,31 @@
         "docs": {
           "$ref": "#/$defs/docsMetadata",
           "description": "Documentation coverage metadata for this export"
+        },
+        "typeAliasKind": {
+          "$ref": "#/$defs/typeAliasKind",
+          "description": "Kind of type alias (for type exports)"
+        },
+        "conditionalType": {
+          "$ref": "#/$defs/conditionalType",
+          "description": "Structural details for conditional types"
+        },
+        "mappedType": {
+          "$ref": "#/$defs/mappedType",
+          "description": "Structural details for mapped types"
+        },
+        "decorators": {
+          "type": "array",
+          "description": "Decorators applied to this export (class/function)",
+          "items": { "$ref": "#/$defs/decorator" }
+        },
+        "isAugmentation": {
+          "type": "boolean",
+          "description": "True if this is a module augmentation (declare module)"
+        },
+        "augmentedModule": {
+          "type": "string",
+          "description": "The module being augmented (e.g., 'express')"
         }
       }
     },
@@ -307,6 +332,18 @@
         },
         "source": {
           "$ref": "#/$defs/sourceLocation"
+        },
+        "typeAliasKind": {
+          "$ref": "#/$defs/typeAliasKind",
+          "description": "Kind of type alias"
+        },
+        "conditionalType": {
+          "$ref": "#/$defs/conditionalType",
+          "description": "Structural details for conditional types"
+        },
+        "mappedType": {
+          "$ref": "#/$defs/mappedType",
+          "description": "Structural details for mapped types"
         }
       }
     },
@@ -381,6 +418,11 @@
         "isImplementation": {
           "type": "boolean",
           "description": "True if this is the implementation signature (not user-callable)"
+        },
+        "throws": {
+          "type": "array",
+          "description": "Exceptions that can be thrown by this signature",
+          "items": { "$ref": "#/$defs/throwsInfo" }
         }
       }
     },
@@ -427,6 +469,11 @@
         "rest": {
           "type": "boolean",
           "description": "Whether this is a rest parameter (...args)"
+        },
+        "decorators": {
+          "type": "array",
+          "description": "Decorators applied to this parameter",
+          "items": { "$ref": "#/$defs/decorator" }
         }
       }
     },
@@ -482,6 +529,99 @@
           "minimum": 1
         }
       }
+    },
+    "typeAliasKind": {
+      "type": "string",
+      "description": "Kind of type alias",
+      "enum": ["alias", "conditional", "mapped", "template-literal", "infer"]
+    },
+    "conditionalType": {
+      "type": "object",
+      "description": "Structural representation of a conditional type (T extends X ? Y : Z)",
+      "required": ["checkType", "extendsType", "trueType", "falseType"],
+      "properties": {
+        "checkType": {
+          "type": "string",
+          "description": "The type being checked (T)"
+        },
+        "extendsType": {
+          "type": "string",
+          "description": "The constraint type (X)"
+        },
+        "trueType": {
+          "type": "string",
+          "description": "The type when condition is true (Y)"
+        },
+        "falseType": {
+          "type": "string",
+          "description": "The type when condition is false (Z)"
+        }
+      },
+      "additionalProperties": false
+    },
+    "mappedType": {
+      "type": "object",
+      "description": "Structural representation of a mapped type ({ [K in keyof T]: ... })",
+      "required": ["typeParameter"],
+      "properties": {
+        "typeParameter": {
+          "type": "string",
+          "description": "The type parameter clause (e.g., 'K in keyof T')"
+        },
+        "nameType": {
+          "type": "string",
+          "description": "The 'as' clause for key remapping (TS 4.1+)"
+        },
+        "valueType": {
+          "type": "string",
+          "description": "The mapped value type"
+        },
+        "readonly": {
+          "description": "Readonly modifier (+, -, or true for present)",
+          "oneOf": [{ "type": "boolean" }, { "enum": ["+", "-"] }]
+        },
+        "optional": {
+          "description": "Optional modifier (+, -, or true for present)",
+          "oneOf": [{ "type": "boolean" }, { "enum": ["+", "-"] }]
+        }
+      },
+      "additionalProperties": false
+    },
+    "decorator": {
+      "type": "object",
+      "description": "Decorator applied to a class, member, or parameter",
+      "required": ["name"],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Decorator name (e.g., 'Injectable', 'Component')"
+        },
+        "arguments": {
+          "type": "array",
+          "description": "Evaluated decorator arguments (if possible)"
+        },
+        "argumentsText": {
+          "type": "array",
+          "description": "Raw text of decorator arguments",
+          "items": { "type": "string" }
+        }
+      },
+      "additionalProperties": false
+    },
+    "throwsInfo": {
+      "type": "object",
+      "description": "Information about an exception that can be thrown",
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "Exception type (e.g., 'ValidationError', 'Error')"
+        },
+        "description": {
+          "type": "string",
+          "description": "When/why the exception is thrown"
+        }
+      },
+      "additionalProperties": false
     }
   }
 }