@openpkg-ts/spec 0.41.0 → 0.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -91,6 +91,7 @@ type SpecSchemaComposite = {
91
91
  required?: string[];
92
92
  additionalProperties?: boolean | SpecSchema;
93
93
  description?: string;
94
+ deprecated?: boolean;
94
95
  } | {
95
96
  type: "function";
96
97
  signatures?: SpecSignature[];
@@ -166,6 +167,8 @@ type SpecSignature = {
166
167
  overloadIndex?: number;
167
168
  isImplementation?: boolean;
168
169
  throws?: SpecThrows[];
170
+ /** Name of the base class this signature was inherited from (e.g. a subclass constructor declared only on its base) */
171
+ inheritedFrom?: string;
169
172
  };
170
173
  /**
171
174
  * Type predicate information for type guard functions.
package/dist/index.js CHANGED
@@ -2431,12 +2431,21 @@ var openpkg_schema_default4 = {
2431
2431
  },
2432
2432
  returns: { $ref: "#/$defs/returns" },
2433
2433
  description: { type: "string" },
2434
+ tags: {
2435
+ type: "array",
2436
+ items: { $ref: "#/$defs/tag" }
2437
+ },
2438
+ examples: {
2439
+ type: "array",
2440
+ items: { $ref: "#/$defs/example" }
2441
+ },
2434
2442
  typeParameters: {
2435
2443
  type: "array",
2436
2444
  items: { $ref: "#/$defs/typeParameter" }
2437
2445
  },
2438
2446
  overloadIndex: { type: "integer", minimum: 0 },
2439
2447
  isImplementation: { type: "boolean" },
2448
+ inheritedFrom: { type: "string" },
2440
2449
  throws: {
2441
2450
  type: "array",
2442
2451
  items: { $ref: "#/$defs/throwsInfo" }
@@ -2509,6 +2518,8 @@ var openpkg_schema_default4 = {
2509
2518
  properties: { propertyName: { type: "string" } }
2510
2519
  },
2511
2520
  description: { type: "string" },
2521
+ deprecated: { type: "boolean" },
2522
+ "x-deprecated-reason": { type: "string" },
2512
2523
  default: {},
2513
2524
  minimum: { type: "number" },
2514
2525
  maximum: { type: "number" },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openpkg-ts/spec",
3
- "version": "0.41.0",
3
+ "version": "0.44.0",
4
4
  "description": "Shared schema, validation, and diff utilities for OpenPkg specs",
5
5
  "keywords": [
6
6
  "openpkg",
@@ -196,12 +196,21 @@
196
196
  },
197
197
  "returns": { "$ref": "#/$defs/returns" },
198
198
  "description": { "type": "string" },
199
+ "tags": {
200
+ "type": "array",
201
+ "items": { "$ref": "#/$defs/tag" }
202
+ },
203
+ "examples": {
204
+ "type": "array",
205
+ "items": { "$ref": "#/$defs/example" }
206
+ },
199
207
  "typeParameters": {
200
208
  "type": "array",
201
209
  "items": { "$ref": "#/$defs/typeParameter" }
202
210
  },
203
211
  "overloadIndex": { "type": "integer", "minimum": 0 },
204
212
  "isImplementation": { "type": "boolean" },
213
+ "inheritedFrom": { "type": "string" },
205
214
  "throws": {
206
215
  "type": "array",
207
216
  "items": { "$ref": "#/$defs/throwsInfo" }
@@ -274,6 +283,8 @@
274
283
  "properties": { "propertyName": { "type": "string" } }
275
284
  },
276
285
  "description": { "type": "string" },
286
+ "deprecated": { "type": "boolean" },
287
+ "x-deprecated-reason": { "type": "string" },
277
288
  "default": {},
278
289
  "minimum": { "type": "number" },
279
290
  "maximum": { "type": "number" },