@openpkg-ts/spec 0.48.1 → 0.50.0

package/dist/index.d.ts

@@ -11,6 +11,18 @@ type SpecTagParam = {
 	/** Whether param is marked optional with [brackets] */
 	optional?: boolean;
 };
+/**
+* An inline TSDoc tag (`{@link Foo}`, `{@label Transport}`) found in a text field.
+*
+* Additive and side-car: the tag is left in place in the text it came from, so
+* `{@link}` still reads naturally in prose and existing consumers are unaffected.
+*/
+type SpecInlineTag = {
+	/** Tag name without the `@` (e.g., "link", "label") */
+	name: string;
+	/** Tag content as written, trimmed (e.g., "sendBatch", "Transport") */
+	text: string;
+};
 type SpecTag = {
 	/** Tag name (e.g., "param", "returns", "example") */
 	name: string;
@@ -18,6 +30,8 @@ type SpecTag = {
 	text: string;
 	/** Structured data for @param tags */
 	param?: SpecTagParam;
+	/** Inline TSDoc tags found in `text` */
+	inlineTags?: SpecInlineTag[];
 };
 type SpecTypeAliasKind = "alias" | "conditional" | "mapped" | "template-literal" | "infer";
 type SpecConditionalType = {
@@ -121,6 +135,8 @@ type SpecExample = {
 	title?: string;
 	description?: string;
 	language?: SpecExampleLanguage;
+	/** Inline TSDoc tags found in this example's text */
+	inlineTags?: SpecInlineTag[];
 };
 type SpecExtension = Record<string, unknown>;
 /** Presentation metadata for an export/type (moved from inline fields) */
@@ -152,6 +168,8 @@ type SpecSignatureParameter = {
 	default?: unknown;
 	rest?: boolean;
 	decorators?: SpecDecorator[];
+	/** Inline TSDoc tags found in `description` */
+	inlineTags?: SpecInlineTag[];
 };
 type SpecSignatureReturn = {
 	schema: SpecSchema;
@@ -169,6 +187,8 @@ type SpecSignature = {
 	throws?: SpecThrows[];
 	/** Name of the base class this signature was inherited from (e.g. a subclass constructor declared only on its base) */
 	inheritedFrom?: string;
+	/** Inline TSDoc tags found in `description` */
+	inlineTags?: SpecInlineTag[];
 };
 /**
 * Type predicate information for type guard functions.
@@ -257,6 +277,8 @@ type SpecMember = {
 	decorators?: SpecDecorator[];
 	deprecated?: boolean;
 	deprecationReason?: string;
+	/** Inline TSDoc tags found in `description` */
+	inlineTags?: SpecInlineTag[];
 };
 type SpecInheritedMember = SpecMember & {
 	/** Name of the class this member was inherited from */
@@ -286,6 +308,8 @@ type SpecExport = {
 	conditionalType?: SpecConditionalType;
 	mappedType?: SpecMappedType;
 	decorators?: SpecDecorator[];
+	/** Inline TSDoc tags found in `description` */
+	inlineTags?: SpecInlineTag[];
 };
 type SpecType = {
 	id: string;
@@ -306,6 +330,8 @@ type SpecType = {
 	mappedType?: SpecMappedType;
 	/** Whether this type is from an external package (node_modules) */
 	external?: boolean;
+	/** Inline TSDoc tags found in `description` */
+	inlineTags?: SpecInlineTag[];
 };
 type OpenPkgMeta = {
 	name: string;
@@ -639,4 +665,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, resolveRef, recommendSemverBump, normalize, isVoidSchema, isTupleSchema, isStringSchema, isRefSchema, isOneOfSchema, isObjectSchema, isNumberSchema, isNullSchema, isNeverSchema, isIntegerSchema, isFunctionSchema, isBooleanSchema, isArraySchema, isAnySchema, isAnyOfSchema, isAllOfSchema, getValidationErrors, getSchemaType, getAvailableVersions, flattenAnyOf, 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, SpecError, SpecDiff, SpecDecorator, SpecConditionalType, SemverRecommendation, SemverBump, SchemaVersion, SCHEMA_VERSION, SCHEMA_URL_MIRROR, SCHEMA_URL, OpenPkgVersion, OpenPkgMeta, OpenPkg, MemberChangeInfo, LATEST_VERSION, KIND_SLUGS, KIND_LABELS, JSON_SCHEMA_DRAFT, JSONSchemaExtensions, GenerationIssueSeverity, GenerationIssue, EntryPointDetectionMethod, DisplayKind, DiffOptions, DISPLAY_KIND_ORDER, CategorizedBreaking, BreakingSeverity };
+export { validateSpec, resolveRef, recommendSemverBump, normalize, isVoidSchema, isTupleSchema, isStringSchema, isRefSchema, isOneOfSchema, isObjectSchema, isNumberSchema, isNullSchema, isNeverSchema, isIntegerSchema, isFunctionSchema, isBooleanSchema, isArraySchema, isAnySchema, isAnyOfSchema, isAllOfSchema, getValidationErrors, getSchemaType, getAvailableVersions, flattenAnyOf, 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, SpecInlineTag, SpecInheritedMember, SpecGenerationMeta, SpecGenerationInfo, SpecExtractionMode, SpecExtractionLimitation, SpecExtensions, SpecExtension, SpecExportKind, SpecExport, SpecExampleLanguage, SpecExample, SpecError, SpecDiff, SpecDecorator, SpecConditionalType, SemverRecommendation, SemverBump, SchemaVersion, SCHEMA_VERSION, SCHEMA_URL_MIRROR, SCHEMA_URL, OpenPkgVersion, OpenPkgMeta, OpenPkg, MemberChangeInfo, LATEST_VERSION, KIND_SLUGS, KIND_LABELS, JSON_SCHEMA_DRAFT, JSONSchemaExtensions, GenerationIssueSeverity, GenerationIssue, EntryPointDetectionMethod, DisplayKind, DiffOptions, DISPLAY_KIND_ORDER, CategorizedBreaking, BreakingSeverity };

package/dist/index.js

@@ -167,7 +167,14 @@ function toMap(items) {
   }
   return map;
 }
-var DOC_KEYS = new Set(["description", "examples", "tags", "rawComments", "source"]);
+var DOC_KEYS = new Set([
+  "description",
+  "examples",
+  "tags",
+  "inlineTags",
+  "rawComments",
+  "source"
+]);
 function isDocOnlyChange(a, b) {
   const structuralA = normalizeForComparison(removeDocFields(a));
   const structuralB = normalizeForComparison(removeDocFields(b));
@@ -463,6 +470,9 @@ function normalizeTag(tag) {
   if (tag.param) {
     result.param = tag.param;
   }
+  if (tag.inlineTags && tag.inlineTags.length > 0) {
+    result.inlineTags = tag.inlineTags;
+  }
   return result;
 }
 function normalizeMember(member) {
@@ -2389,6 +2399,10 @@ var openpkg_schema_default4 = {
         decorators: {
           type: "array",
           items: { $ref: "#/$defs/decorator" }
+        },
+        inlineTags: {
+          type: "array",
+          items: { $ref: "#/$defs/inlineTag" }
         }
       }
     },
@@ -2424,6 +2438,10 @@ var openpkg_schema_default4 = {
         conditionalType: { $ref: "#/$defs/conditionalType" },
         mappedType: { $ref: "#/$defs/mappedType" },
         external: { type: "boolean" },
+        inlineTags: {
+          type: "array",
+          items: { $ref: "#/$defs/inlineTag" }
+        },
         typeParameters: {
           type: "array",
           items: { $ref: "#/$defs/typeParameter" }
@@ -2436,7 +2454,20 @@ var openpkg_schema_default4 = {
       properties: {
         name: { type: "string" },
         text: { type: "string" },
-        param: { $ref: "#/$defs/tagParam" }
+        param: { $ref: "#/$defs/tagParam" },
+        inlineTags: {
+          type: "array",
+          items: { $ref: "#/$defs/inlineTag" }
+        }
+      },
+      additionalProperties: false
+    },
+    inlineTag: {
+      type: "object",
+      required: ["name", "text"],
+      properties: {
+        name: { type: "string" },
+        text: { type: "string" }
       },
       additionalProperties: false
     },
@@ -2478,6 +2509,10 @@ var openpkg_schema_default4 = {
         throws: {
           type: "array",
           items: { $ref: "#/$defs/throwsInfo" }
+        },
+        inlineTags: {
+          type: "array",
+          items: { $ref: "#/$defs/inlineTag" }
         }
       }
     },
@@ -2503,6 +2538,10 @@ var openpkg_schema_default4 = {
         decorators: {
           type: "array",
           items: { $ref: "#/$defs/decorator" }
+        },
+        inlineTags: {
+          type: "array",
+          items: { $ref: "#/$defs/inlineTag" }
         }
       }
     },
@@ -2589,6 +2628,7 @@ var openpkg_schema_default4 = {
             minProperties: { type: "integer" },
             maxProperties: { type: "integer" },
             "x-ts-type": { type: "string" },
+            "x-ts-declared": { type: "string" },
             "x-ts-function": { type: "boolean" },
             "x-ts-method": { type: "boolean" },
             "x-ts-signatures": { type: "array", items: { $ref: "#/$defs/signature" } },
@@ -2682,7 +2722,11 @@ var openpkg_schema_default4 = {
             code: { type: "string" },
             title: { type: "string" },
             description: { type: "string" },
-            language: { $ref: "#/$defs/exampleLanguage" }
+            language: { $ref: "#/$defs/exampleLanguage" },
+            inlineTags: {
+              type: "array",
+              items: { $ref: "#/$defs/inlineTag" }
+            }
           },
           additionalProperties: false
         }
@@ -2704,7 +2748,8 @@ var openpkg_schema_default4 = {
         flags: { type: "object", additionalProperties: true },
         schema: { $ref: "#/$defs/schema" },
         signatures: { type: "array", items: { $ref: "#/$defs/signature" } },
-        decorators: { type: "array", items: { $ref: "#/$defs/decorator" } }
+        decorators: { type: "array", items: { $ref: "#/$defs/decorator" } },
+        inlineTags: { type: "array", items: { $ref: "#/$defs/inlineTag" } }
       }
     }
   }

package/package.json

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

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

@@ -144,6 +144,10 @@
         "decorators": {
           "type": "array",
           "items": { "$ref": "#/$defs/decorator" }
+        },
+        "inlineTags": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/inlineTag" }
         }
       }
     },
@@ -179,6 +183,10 @@
         "conditionalType": { "$ref": "#/$defs/conditionalType" },
         "mappedType": { "$ref": "#/$defs/mappedType" },
         "external": { "type": "boolean" },
+        "inlineTags": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/inlineTag" }
+        },
         "typeParameters": {
           "type": "array",
           "items": { "$ref": "#/$defs/typeParameter" }
@@ -191,7 +199,20 @@
       "properties": {
         "name": { "type": "string" },
         "text": { "type": "string" },
-        "param": { "$ref": "#/$defs/tagParam" }
+        "param": { "$ref": "#/$defs/tagParam" },
+        "inlineTags": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/inlineTag" }
+        }
+      },
+      "additionalProperties": false
+    },
+    "inlineTag": {
+      "type": "object",
+      "required": ["name", "text"],
+      "properties": {
+        "name": { "type": "string" },
+        "text": { "type": "string" }
       },
       "additionalProperties": false
     },
@@ -233,6 +254,10 @@
         "throws": {
           "type": "array",
           "items": { "$ref": "#/$defs/throwsInfo" }
+        },
+        "inlineTags": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/inlineTag" }
         }
       }
     },
@@ -258,6 +283,10 @@
         "decorators": {
           "type": "array",
           "items": { "$ref": "#/$defs/decorator" }
+        },
+        "inlineTags": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/inlineTag" }
         }
       }
     },
@@ -344,6 +373,7 @@
             "minProperties": { "type": "integer" },
             "maxProperties": { "type": "integer" },
             "x-ts-type": { "type": "string" },
+            "x-ts-declared": { "type": "string" },
             "x-ts-function": { "type": "boolean" },
             "x-ts-method": { "type": "boolean" },
             "x-ts-signatures": { "type": "array", "items": { "$ref": "#/$defs/signature" } },
@@ -437,7 +467,11 @@
             "code": { "type": "string" },
             "title": { "type": "string" },
             "description": { "type": "string" },
-            "language": { "$ref": "#/$defs/exampleLanguage" }
+            "language": { "$ref": "#/$defs/exampleLanguage" },
+            "inlineTags": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/inlineTag" }
+            }
           },
           "additionalProperties": false
         }
@@ -459,7 +493,8 @@
         "flags": { "type": "object", "additionalProperties": true },
         "schema": { "$ref": "#/$defs/schema" },
         "signatures": { "type": "array", "items": { "$ref": "#/$defs/signature" } },
-        "decorators": { "type": "array", "items": { "$ref": "#/$defs/decorator" } }
+        "decorators": { "type": "array", "items": { "$ref": "#/$defs/decorator" } },
+        "inlineTags": { "type": "array", "items": { "$ref": "#/$defs/inlineTag" } }
       }
     }
   }