Merge pull request #3715 from hey-api/fix/spec-types

Fix/spec types

Author: mrlubos

.changeset/clear-toes-enjoy.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/spec-types": patch
+---
+
+**types**: fix: use mutable arrays

.changeset/deep-paws-call.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/spec-types": minor
+---
+
+**BREAKING**: rename `OpenAPIExtensions` to `SpecExtensions`

.changeset/olive-sides-mate.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/spec-types": minor
+---
+
+**BREAKING**: remove OpenAPI types from JSON Schema documents

.changeset/short-walls-battle.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/spec-types": patch
+---
+
+**openapi**: fix: stricter 2.0 version type

packages/shared/src/ir/types.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-namespace */
 import type { Symbol } from '@hey-api/codegen-core';
-import type { JSONSchemaDraft2020_12, OpenAPIExtensions, OpenAPIV3_1 } from '@hey-api/spec-types';
+import type { JSONSchemaDraft2020_12, OpenAPIV3_1, SpecExtensions } from '@hey-api/spec-types';
 
 import type { IRMediaType } from './mediaType';
 
@@ -22,7 +22,7 @@ interface IRComponentsObject {
   schemas?: Record<string, IRSchemaObject>;
 }
 
-export interface IROperationObject extends OpenAPIExtensions {
+export interface IROperationObject extends SpecExtensions {
   body?: IRBodyObject;
   deprecated?: boolean;
   description?: string;
@@ -46,7 +46,7 @@ export interface IRParametersObject {
 }
 
 export interface IRParameterObject
-  extends Pick<JSONSchemaDraft2020_12.Document, 'deprecated' | 'description'>, OpenAPIExtensions {
+  extends Pick<JSONSchemaDraft2020_12.Document, 'deprecated' | 'description'>, SpecExtensions {
   /**
    * Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored.
    */
@@ -130,9 +130,9 @@ export interface IRSchemaObject
       | 'pattern'
       | 'required'
       | 'title'
-      | 'example'
     >,
-    OpenAPIExtensions {
+    Pick<OpenAPIV3_1.SchemaObject, 'example'>,
+    SpecExtensions {
   /**
    * If the schema is intended to be used as an object property, it can be
    * marked as read-only or write-only. This value controls whether the schema

packages/spec-types/package.json

@@ -37,16 +37,16 @@
   ],
   "type": "module",
   "sideEffects": false,
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.d.mts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.mts"
     },
     "./package.json": "./package.json"
   },
   "scripts": {
-    "build": "tsc --build",
-    "dev": "tsc --build --watch",
+    "build": "tsdown",
+    "dev": "tsdown --watch",
     "prepublishOnly": "pnpm build",
     "typecheck": "tsgo --noEmit"
   },

…ges/spec-types/src/extensions/openapi.ts …pec-types/src/extensions/code-samples.tspackages/spec-types/src/extensions/openapi.ts renamed to packages/spec-types/src/extensions/code-samples.ts packages/spec-types/src/extensions/openapi.ts renamed to packages/spec-types/src/extensions/code-samples.ts

@@ -41,27 +41,3 @@ export interface CodeSampleObject {
    */
   source: string;
 }
-
-export interface EnumExtensions {
-  /**
-   * `x-enum-descriptions` are {@link https://stackoverflow.com/a/66471626 supported} by OpenAPI Generator.
-   */
-  'x-enum-descriptions'?: ReadonlyArray<string>;
-  /**
-   * `x-enum-varnames` are {@link https://stackoverflow.com/a/66471626 supported} by OpenAPI Generator.
-   */
-  'x-enum-varnames'?: ReadonlyArray<string>;
-  /**
-   * {@link https://github.com/RicoSuter/NSwag NSwag} generates `x-enumNames` field containing custom enum names.
-   */
-  'x-enumNames'?: ReadonlyArray<string>;
-}
-
-/**
- * OpenAPI Specification Extensions.
- *
- * See {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specification-extensions Specification Extensions}.
- */
-export interface OpenAPIExtensions {
-  [extension: `x-${string}`]: unknown;
-}

packages/spec-types/src/extensions/enum.ts

@@ -0,0 +1,14 @@
+export interface EnumExtensions {
+  /**
+   * `x-enum-descriptions` are {@link https://stackoverflow.com/a/66471626 supported} by OpenAPI Generator.
+   */
+  'x-enum-descriptions'?: Array<string>;
+  /**
+   * `x-enum-varnames` are {@link https://stackoverflow.com/a/66471626 supported} by OpenAPI Generator.
+   */
+  'x-enum-varnames'?: Array<string>;
+  /**
+   * {@link https://github.com/RicoSuter/NSwag NSwag} generates `x-enumNames` field containing custom enum names.
+   */
+  'x-enumNames'?: Array<string>;
+}

packages/spec-types/src/extensions/spec.ts

@@ -0,0 +1,8 @@
+/**
+ * Specification Extensions.
+ *
+ * See {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specification-extensions Specification Extensions}.
+ */
+export interface SpecExtensions {
+  [extension: `x-${string}`]: unknown;
+}

packages/spec-types/src/index.ts

@@ -1,9 +1,6 @@
-export type {
-  CodeSampleObject,
-  EnumExtensions,
-  LinguistLanguages,
-  OpenAPIExtensions,
-} from './extensions/openapi';
+export type { CodeSampleObject, LinguistLanguages } from './extensions/code-samples';
+export type { EnumExtensions } from './extensions/enum';
+export type { SpecExtensions } from './extensions/spec';
 export type * as JSONSchemaDraft4 from './json-schema/draft-4';
 export type * as JSONSchemaDraft2020_12 from './json-schema/draft-2020-12';
 export * as JSONSchema from './json-schema/union';