@openpkg-ts/spec 0.45.0 → 0.47.0

package/dist/index.d.ts

@@ -294,6 +294,7 @@ type SpecType = {
 	description?: string;
 	schema?: SpecSchema;
 	type?: string | SpecSchema;
+	typeParameters?: SpecTypeParameter[];
 	members?: SpecMember[];
 	source?: SpecSource;
 	tags?: SpecTag[];
@@ -598,6 +599,8 @@ declare function getSchemaType(schema: SpecSchema): string;
 type ConcreteSchemaVersion = "0.1.0" | "0.2.0" | "0.3.0" | "0.4.0";
 /** Supported schema versions */
 type SchemaVersion = ConcreteSchemaVersion | "latest";
+/** Current/latest schema version */
+declare const LATEST_VERSION: ConcreteSchemaVersion;
 type SpecError = {
 	instancePath: string;
 	message: string;
@@ -636,4 +639,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, SpecDiff, SpecDecorator, SpecConditionalType, SemverRecommendation, SemverBump, SCHEMA_VERSION, SCHEMA_URL_MIRROR, SCHEMA_URL, OpenPkgVersion, OpenPkgMeta, OpenPkg, MemberChangeInfo, 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, 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

@@ -47,7 +47,17 @@ function dereference(spec) {
       const record = value;
       const ref = readTypeRef(record);
       if (ref) {
-        return resolveTypeRef(ref, typeLookup, seen);
+        const resolved = resolveTypeRef(ref, typeLookup, seen);
+        const siblings = {};
+        for (const [key, nested] of Object.entries(record)) {
+          if (key === "$ref")
+            continue;
+          siblings[key] = visit(nested, seen);
+        }
+        if (Object.keys(siblings).length === 0) {
+          return resolved;
+        }
+        return { ...siblings, ...resolved };
       }
       const next = {};
       for (const [key, nested] of Object.entries(record)) {
@@ -1961,7 +1971,7 @@ var openpkg_schema_default3 = {
             enum: { type: "array" },
             const: { description: "Constant value" },
             items: { $ref: "#/$defs/schema" },
-            prefixedItems: {
+            prefixItems: {
               type: "array",
               items: { $ref: "#/$defs/schema" },
               description: "Tuple element schemas (draft-2020-12)"
@@ -2293,7 +2303,21 @@ var openpkg_schema_default4 = {
       type: "object",
       properties: {
         generator: { type: "string" },
-        timestamp: { type: "string", format: "date-time" }
+        timestamp: { type: "string", format: "date-time" },
+        mode: { type: "string", enum: ["source", "declaration-only"] },
+        schemaExtraction: { type: "string", enum: ["hybrid"] },
+        limitations: { type: "array", items: { type: "string" } },
+        skipped: {
+          type: "array",
+          items: {
+            type: "object",
+            required: ["name", "reason"],
+            properties: {
+              name: { type: "string" },
+              reason: { type: "string" }
+            }
+          }
+        }
       }
     },
     presentationMeta: {
@@ -2398,7 +2422,12 @@ var openpkg_schema_default4 = {
         rawComments: { type: "string" },
         typeAliasKind: { $ref: "#/$defs/typeAliasKind" },
         conditionalType: { $ref: "#/$defs/conditionalType" },
-        mappedType: { $ref: "#/$defs/mappedType" }
+        mappedType: { $ref: "#/$defs/mappedType" },
+        external: { type: "boolean" },
+        typeParameters: {
+          type: "array",
+          items: { $ref: "#/$defs/typeParameter" }
+        }
       }
     },
     tag: {
@@ -2484,20 +2513,32 @@ var openpkg_schema_default4 = {
         description: { type: "string" }
       }
     },
+    jsonSchemaType: {
+      enum: ["string", "number", "integer", "boolean", "object", "array", "null"]
+    },
     schema: {
       oneOf: [
-        { type: "string" },
         { type: "boolean" },
         {
           type: "object",
           properties: {
             $schema: { type: "string" },
-            type: { type: "string" },
+            type: {
+              oneOf: [
+                { $ref: "#/$defs/jsonSchemaType" },
+                {
+                  type: "array",
+                  items: { $ref: "#/$defs/jsonSchemaType" },
+                  minItems: 1,
+                  uniqueItems: true
+                }
+              ]
+            },
             format: { type: "string" },
             enum: { type: "array" },
             const: {},
             items: { $ref: "#/$defs/schema" },
-            prefixedItems: {
+            prefixItems: {
               type: "array",
               items: { $ref: "#/$defs/schema" }
             },
@@ -2507,31 +2548,65 @@ var openpkg_schema_default4 = {
             },
             required: { type: "array", items: { type: "string" } },
             additionalProperties: {
-              oneOf: [{ type: "boolean" }, { type: "object" }]
+              oneOf: [{ type: "boolean" }, { $ref: "#/$defs/schema" }]
+            },
+            patternProperties: {
+              type: "object",
+              additionalProperties: { $ref: "#/$defs/schema" }
+            },
+            propertyNames: { $ref: "#/$defs/schema" },
+            $defs: {
+              type: "object",
+              additionalProperties: { $ref: "#/$defs/schema" }
             },
             anyOf: { type: "array", items: { $ref: "#/$defs/schema" } },
             allOf: { type: "array", items: { $ref: "#/$defs/schema" } },
             oneOf: { type: "array", items: { $ref: "#/$defs/schema" } },
+            not: { $ref: "#/$defs/schema" },
             $ref: { type: "string" },
             discriminator: {
               type: "object",
               properties: { propertyName: { type: "string" } }
             },
+            title: { type: "string" },
             description: { type: "string" },
             deprecated: { type: "boolean" },
-            "x-deprecated-reason": { type: "string" },
+            readOnly: { type: "boolean" },
             default: {},
+            examples: { type: "array" },
             minimum: { type: "number" },
             maximum: { type: "number" },
             exclusiveMinimum: { type: "number" },
             exclusiveMaximum: { type: "number" },
+            multipleOf: { type: "number" },
             minLength: { type: "integer" },
             maxLength: { type: "integer" },
             pattern: { type: "string" },
             minItems: { type: "integer" },
             maxItems: { type: "integer" },
             uniqueItems: { type: "boolean" },
-            signatures: { type: "array", items: { $ref: "#/$defs/signature" } }
+            contains: { $ref: "#/$defs/schema" },
+            minProperties: { type: "integer" },
+            maxProperties: { type: "integer" },
+            "x-ts-type": { type: "string" },
+            "x-ts-function": { type: "boolean" },
+            "x-ts-method": { type: "boolean" },
+            "x-ts-signatures": { type: "array", items: { $ref: "#/$defs/signature" } },
+            "x-ts-type-arguments": { type: "array", items: { $ref: "#/$defs/schema" } },
+            "x-ts-type-predicate": {
+              type: "object",
+              required: ["parameterName", "type"],
+              properties: {
+                parameterName: { type: "string" },
+                type: { $ref: "#/$defs/schema" }
+              }
+            },
+            "x-ts-package": { type: "string" },
+            "x-ts-default": { type: "string" },
+            "x-ts-index-key": { type: "string", enum: ["number"] },
+            "x-ts-accessor": { type: "string", enum: ["getter", "setter"] },
+            "x-enum-members": { type: "array" },
+            "x-deprecated-reason": { type: "string" }
           }
         }
       ]
@@ -2730,6 +2805,7 @@ export {
   SCHEMA_VERSION,
   SCHEMA_URL_MIRROR,
   SCHEMA_URL,
+  LATEST_VERSION,
   KIND_SLUGS,
   KIND_LABELS,
   JSON_SCHEMA_DRAFT,

package/package.json

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

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

@@ -723,7 +723,7 @@
             "enum": { "type": "array" },
             "const": { "description": "Constant value" },
             "items": { "$ref": "#/$defs/schema" },
-            "prefixedItems": {
+            "prefixItems": {
               "type": "array",
               "items": { "$ref": "#/$defs/schema" },
               "description": "Tuple element schemas (draft-2020-12)"

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

@@ -58,7 +58,21 @@
       "type": "object",
       "properties": {
         "generator": { "type": "string" },
-        "timestamp": { "type": "string", "format": "date-time" }
+        "timestamp": { "type": "string", "format": "date-time" },
+        "mode": { "type": "string", "enum": ["source", "declaration-only"] },
+        "schemaExtraction": { "type": "string", "enum": ["hybrid"] },
+        "limitations": { "type": "array", "items": { "type": "string" } },
+        "skipped": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["name", "reason"],
+            "properties": {
+              "name": { "type": "string" },
+              "reason": { "type": "string" }
+            }
+          }
+        }
       }
     },
     "presentationMeta": {
@@ -163,7 +177,12 @@
         "rawComments": { "type": "string" },
         "typeAliasKind": { "$ref": "#/$defs/typeAliasKind" },
         "conditionalType": { "$ref": "#/$defs/conditionalType" },
-        "mappedType": { "$ref": "#/$defs/mappedType" }
+        "mappedType": { "$ref": "#/$defs/mappedType" },
+        "external": { "type": "boolean" },
+        "typeParameters": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/typeParameter" }
+        }
       }
     },
     "tag": {
@@ -249,20 +268,32 @@
         "description": { "type": "string" }
       }
     },
+    "jsonSchemaType": {
+      "enum": ["string", "number", "integer", "boolean", "object", "array", "null"]
+    },
     "schema": {
       "oneOf": [
-        { "type": "string" },
         { "type": "boolean" },
         {
           "type": "object",
           "properties": {
             "$schema": { "type": "string" },
-            "type": { "type": "string" },
+            "type": {
+              "oneOf": [
+                { "$ref": "#/$defs/jsonSchemaType" },
+                {
+                  "type": "array",
+                  "items": { "$ref": "#/$defs/jsonSchemaType" },
+                  "minItems": 1,
+                  "uniqueItems": true
+                }
+              ]
+            },
             "format": { "type": "string" },
             "enum": { "type": "array" },
             "const": {},
             "items": { "$ref": "#/$defs/schema" },
-            "prefixedItems": {
+            "prefixItems": {
               "type": "array",
               "items": { "$ref": "#/$defs/schema" }
             },
@@ -272,31 +303,65 @@
             },
             "required": { "type": "array", "items": { "type": "string" } },
             "additionalProperties": {
-              "oneOf": [{ "type": "boolean" }, { "type": "object" }]
+              "oneOf": [{ "type": "boolean" }, { "$ref": "#/$defs/schema" }]
+            },
+            "patternProperties": {
+              "type": "object",
+              "additionalProperties": { "$ref": "#/$defs/schema" }
+            },
+            "propertyNames": { "$ref": "#/$defs/schema" },
+            "$defs": {
+              "type": "object",
+              "additionalProperties": { "$ref": "#/$defs/schema" }
             },
             "anyOf": { "type": "array", "items": { "$ref": "#/$defs/schema" } },
             "allOf": { "type": "array", "items": { "$ref": "#/$defs/schema" } },
             "oneOf": { "type": "array", "items": { "$ref": "#/$defs/schema" } },
+            "not": { "$ref": "#/$defs/schema" },
             "$ref": { "type": "string" },
             "discriminator": {
               "type": "object",
               "properties": { "propertyName": { "type": "string" } }
             },
+            "title": { "type": "string" },
             "description": { "type": "string" },
             "deprecated": { "type": "boolean" },
-            "x-deprecated-reason": { "type": "string" },
+            "readOnly": { "type": "boolean" },
             "default": {},
+            "examples": { "type": "array" },
             "minimum": { "type": "number" },
             "maximum": { "type": "number" },
             "exclusiveMinimum": { "type": "number" },
             "exclusiveMaximum": { "type": "number" },
+            "multipleOf": { "type": "number" },
             "minLength": { "type": "integer" },
             "maxLength": { "type": "integer" },
             "pattern": { "type": "string" },
             "minItems": { "type": "integer" },
             "maxItems": { "type": "integer" },
             "uniqueItems": { "type": "boolean" },
-            "signatures": { "type": "array", "items": { "$ref": "#/$defs/signature" } }
+            "contains": { "$ref": "#/$defs/schema" },
+            "minProperties": { "type": "integer" },
+            "maxProperties": { "type": "integer" },
+            "x-ts-type": { "type": "string" },
+            "x-ts-function": { "type": "boolean" },
+            "x-ts-method": { "type": "boolean" },
+            "x-ts-signatures": { "type": "array", "items": { "$ref": "#/$defs/signature" } },
+            "x-ts-type-arguments": { "type": "array", "items": { "$ref": "#/$defs/schema" } },
+            "x-ts-type-predicate": {
+              "type": "object",
+              "required": ["parameterName", "type"],
+              "properties": {
+                "parameterName": { "type": "string" },
+                "type": { "$ref": "#/$defs/schema" }
+              }
+            },
+            "x-ts-package": { "type": "string" },
+            "x-ts-default": { "type": "string" },
+            "x-ts-index-key": { "type": "string", "enum": ["number"] },
+            "x-ts-accessor": { "type": "string", "enum": ["getter", "setter"] },
+            "x-enum-members": { "type": "array" },
+            "x-deprecated-reason": { "type": "string" }
           }
         }
       ]