@tsed/openspec 8.34.0 → 8.36.0

package/lib/types/openspec2/OS2Operation.d.ts

@@ -1,9 +1,9 @@
+import { OS2Parameter } from "./OS2Parameter.js";
+import { OS2Response } from "./OS2Response.js";
 import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
 import { OpenSpecHash } from "../common/OpenSpecHash.js";
 import { OpenSpecRef } from "../common/OpenSpecRef.js";
 import { OpenSpecSecurity } from "../common/OpenSpecSecurity.js";
-import { OS2Parameter } from "./OS2Parameter.js";
-import { OS2Response } from "./OS2Response.js";
 export interface OS2Operation {
     /**
      * A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

package/lib/types/openspec2/OS2Parameter.d.ts

@@ -1,5 +1,5 @@
-import { OpenSpecTypes } from "../common/OpenSpecTypes.js";
 import { OS2BaseSchema, OS2Schema } from "./OS2Schema.js";
+import { OpenSpecTypes } from "../common/OpenSpecTypes.js";
 export type OS2BaseParameter = {
     name: string;
     in: "body" | "query" | "path" | "header" | "formData";

package/lib/types/openspec2/OS2Paths.d.ts

@@ -1,7 +1,7 @@
-import { OpenSpecPath } from "../common/OpenSpecPath.js";
-import { OpenSpecRef } from "../common/OpenSpecRef.js";
 import { OS2Operation } from "./OS2Operation.js";
 import { OS2Parameter } from "./OS2Parameter.js";
+import { OpenSpecPath } from "../common/OpenSpecPath.js";
+import { OpenSpecRef } from "../common/OpenSpecRef.js";
 export interface OS2Paths extends OpenSpecPath<OS2Operation> {
     parameters?: (OS2Parameter | OpenSpecRef)[];
 }

package/lib/types/openspec2/OS2Response.d.ts

@@ -1,6 +1,6 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
 import { OS2Header } from "./OS2Header.js";
 import { OS2Schema } from "./OS2Schema.js";
+import { OpenSpecHash } from "../common/OpenSpecHash.js";
 export interface OS2Response {
     /**
      * A short description of the response. GFM syntax can be used for rich text representation.

package/lib/types/openspec2/OS2Schema.d.ts

@@ -1,5 +1,5 @@
-import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
 import { OpenSpecBaseJsonSchema, OpenSpecJsonSchema } from "../common/OpenSpecJsonSchema.js";
+import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
 import { OpenSpecRef } from "../common/OpenSpecRef.js";
 import { OpenSpecXML } from "../common/OpenSpecXML.js";
 export interface OS2XML {

package/lib/types/openspec2/OpenSpec2.d.ts

@@ -1,13 +1,13 @@
-import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OpenSpecInfo } from "../common/OpenSpecInfo.js";
-import { OpenSpecSecurity } from "../common/OpenSpecSecurity.js";
-import { OpenSpecTag } from "../common/OpenSpecTag.js";
 import { OS2BodyParameter, OS2QueryParameter } from "./OS2Parameter.js";
 import { OS2Paths } from "./OS2Paths.js";
 import { OS2Response } from "./OS2Response.js";
 import { OS2Schema } from "./OS2Schema.js";
 import { OS2Security } from "./OS2Security.js";
+import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
+import { OpenSpecHash } from "../common/OpenSpecHash.js";
+import { OpenSpecInfo } from "../common/OpenSpecInfo.js";
+import { OpenSpecSecurity } from "../common/OpenSpecSecurity.js";
+import { OpenSpecTag } from "../common/OpenSpecTag.js";
 export interface OpenSpec2 {
     /**
      * Specifies the Swagger Specification version being used. It can be used by the Swagger UI and other clients to interpret the API listing. The value MUST be "2.0".

package/lib/types/openspec3/OS3Callbacks.d.ts

@@ -1,4 +1,4 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
 import { OS3Paths } from "./OS3Paths.js";
 import { OS3Schema } from "./OS3Schema.js";
+import { OpenSpecHash } from "../common/OpenSpecHash.js";
 export type OS3Callbacks<Schema = OS3Schema> = OpenSpecHash<OpenSpecHash<OS3Paths<Schema>>>;

package/lib/types/openspec3/OS3Components.d.ts

@@ -1,4 +1,3 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
 import { OS3Callbacks } from "./OS3Callbacks.js";
 import { OS3Example } from "./OS3Example.js";
 import { OS3Header } from "./OS3Header.js";
@@ -8,6 +7,7 @@ import { OS3RequestBody } from "./OS3RequestBody.js";
 import { OS3Response } from "./OS3Response.js";
 import { OS3Schema } from "./OS3Schema.js";
 import { OS3Security } from "./OS3Security.js";
+import { OpenSpecHash } from "../common/OpenSpecHash.js";
 export interface OS3Components<Schema = OS3Schema> {
     /**
      * An object to hold reusable [Schema Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#schemaObject).

package/lib/types/openspec3/OS3Encoding.d.ts

@@ -1,5 +1,5 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
 import { OS3Header } from "./OS3Header.js";
+import { OpenSpecHash } from "../common/OpenSpecHash.js";
 export interface OS3Encoding {
     /**
      * The `Content-Type` for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - application/json; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types.

package/lib/types/openspec3/OS3Header.d.ts

@@ -1,6 +1,6 @@
+import { OS3Schema } from "./OS3Schema.js";
 import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
 import { OpenSpecRef } from "../common/OpenSpecRef.js";
-import { OS3Schema } from "./OS3Schema.js";
 export interface OS3Header<Schema = OS3Schema> {
     /**
      * A description of the header. CommonMark syntax MAY be used for rich text representation.

package/lib/types/openspec3/OS3Link.d.ts

@@ -1,5 +1,5 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
 import { OS3Server } from "./OS3Server.js";
+import { OpenSpecHash } from "../common/OpenSpecHash.js";
 export interface OS3Link {
     /**
      * A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.

package/lib/types/openspec3/OS3MediaType.d.ts

@@ -1,8 +1,8 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OpenSpecRef } from "../common/OpenSpecRef.js";
 import { OS3Encoding } from "./OS3Encoding.js";
 import { OS3Example } from "./OS3Example.js";
 import { OS3Schema } from "./OS3Schema.js";
+import { OpenSpecHash } from "../common/OpenSpecHash.js";
+import { OpenSpecRef } from "../common/OpenSpecRef.js";
 export interface OS3MediaType<Schema = OS3Schema> {
     /**
      * The schema defining the type used for the request body.

package/lib/types/openspec3/OS3Operation.d.ts

@@ -1,12 +1,12 @@
-import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OpenSpecSecurity } from "../common/OpenSpecSecurity.js";
 import { OS3Callbacks } from "./OS3Callbacks.js";
 import { OS3Parameter } from "./OS3Parameter.js";
 import { OS3RequestBody } from "./OS3RequestBody.js";
 import { OS3Response } from "./OS3Response.js";
 import { OS3Schema } from "./OS3Schema.js";
 import { OS3Server } from "./OS3Server.js";
+import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
+import { OpenSpecHash } from "../common/OpenSpecHash.js";
+import { OpenSpecSecurity } from "../common/OpenSpecSecurity.js";
 export interface OS3Operation<Schema = OS3Schema, Parameter = OS3Parameter<Schema>, Response = OpenSpecHash<OS3Response<Schema>>> {
     /**
      * Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.

package/lib/types/openspec3/OS3Parameter.d.ts

@@ -1,8 +1,8 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OpenSpecRef } from "../common/OpenSpecRef.js";
 import { OS3Example } from "./OS3Example.js";
 import { OS3MediaType } from "./OS3MediaType.js";
 import { OS3Schema } from "./OS3Schema.js";
+import { OpenSpecHash } from "../common/OpenSpecHash.js";
+import { OpenSpecRef } from "../common/OpenSpecRef.js";
 export type OS3StyleParameter = "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject";
 export interface OS3Parameter<Schema = OS3Schema> {
     /**

package/lib/types/openspec3/OS3Paths.d.ts

@@ -1,9 +1,9 @@
-import { OpenSpecPath } from "../common/OpenSpecPath.js";
-import { OpenSpecRef } from "../common/OpenSpecRef.js";
 import { OS3Operation } from "./OS3Operation.js";
 import { OS3Parameter } from "./OS3Parameter.js";
 import { OS3Schema } from "./OS3Schema.js";
 import { OS3Server } from "./OS3Server.js";
+import { OpenSpecPath } from "../common/OpenSpecPath.js";
+import { OpenSpecRef } from "../common/OpenSpecRef.js";
 export interface OS3Paths<Schema = OS3Schema> extends OpenSpecPath<OS3Operation<Schema>> {
     /**
      * An optional, string summary, intended to apply to all operations in this path.

package/lib/types/openspec3/OS3RequestBody.d.ts

@@ -1,8 +1,8 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OpenSpecRef } from "../common/OpenSpecRef.js";
 import { OS3Example } from "./OS3Example.js";
 import { OS3MediaType } from "./OS3MediaType.js";
 import { OS3Schema } from "./OS3Schema.js";
+import { OpenSpecHash } from "../common/OpenSpecHash.js";
+import { OpenSpecRef } from "../common/OpenSpecRef.js";
 export interface OS3RequestBody<Schema = OS3Schema> {
     /**
      * A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

package/lib/types/openspec3/OS3Response.d.ts

@@ -1,9 +1,9 @@
-import { OpenSpecHash } from "../common/OpenSpecHash.js";
-import { OpenSpecRef } from "../common/OpenSpecRef.js";
 import { OS3Header } from "./OS3Header.js";
 import { OS3Link } from "./OS3Link.js";
 import { OS3MediaType } from "./OS3MediaType.js";
 import { OS3Schema } from "./OS3Schema.js";
+import { OpenSpecHash } from "../common/OpenSpecHash.js";
+import { OpenSpecRef } from "../common/OpenSpecRef.js";
 export interface OS3Response<Schema = OS3Schema, Header = OS3Header<Schema>> {
     /**
      * A short description of the response. CommonMark syntax MAY be used for rich text representation.

package/lib/types/openspec3/OS3Schema.d.ts

@@ -1,5 +1,5 @@
-import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
 import { OpenSpecBaseJsonSchema, OpenSpecJsonSchema } from "../common/OpenSpecJsonSchema.js";
+import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
 import { OpenSpecRef } from "../common/OpenSpecRef.js";
 import { OpenSpecXML } from "../common/OpenSpecXML.js";
 export interface OS3BaseSchema extends OpenSpecBaseJsonSchema {

package/lib/types/openspec3/OpenSpec3.d.ts

@@ -1,12 +1,12 @@
+import { OS3Components } from "./OS3Components.js";
+import { OS3Paths } from "./OS3Paths.js";
+import { OS3Schema } from "./OS3Schema.js";
+import { OS3Server } from "./OS3Server.js";
 import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs.js";
 import { OpenSpecHash } from "../common/OpenSpecHash.js";
 import { OpenSpecInfo } from "../common/OpenSpecInfo.js";
 import { OpenSpecSecurity } from "../common/OpenSpecSecurity.js";
 import { OpenSpecTag } from "../common/OpenSpecTag.js";
-import { OS3Components } from "./OS3Components.js";
-import { OS3Paths } from "./OS3Paths.js";
-import { OS3Schema } from "./OS3Schema.js";
-import { OS3Server } from "./OS3Server.js";
 export interface OpenSpec3<Schema = OS3Schema> {
     /**
      * This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses. The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version string.

package/package.json

@@ -1,9 +1,19 @@
 {
   "name": "@tsed/openspec",
+  "version": "8.36.0",
   "description": "OpenSpec2 and OpenSpec3 interfaces declarations for TypeScript application",
-  "type": "module",
-  "version": "8.34.0",
+  "keywords": [
+    "JsonSchema",
+    "OAS2",
+    "OAS3",
+    "OpenSpec",
+    "TypeScript",
+    "interfaces",
+    "open-spec",
+    "swagger"
+  ],
   "source": "./src/index.ts",
+  "type": "module",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
@@ -20,20 +30,9 @@
     "barrels": "barrels",
     "build:ts": "tsc --build tsconfig.esm.json"
   },
-  "keywords": [
-    "TypeScript",
-    "interfaces",
-    "OpenSpec",
-    "open-spec",
-    "swagger",
-    "OAS3",
-    "OAS2",
-    "JsonSchema"
-  ],
   "devDependencies": {
-    "@tsed/barrels": "8.34.0",
-    "@tsed/typescript": "8.34.0",
-    "eslint": "9.12.0",
+    "@tsed/barrels": "8.36.0",
+    "@tsed/typescript": "8.36.0",
     "typescript": "6.0.2"
   },
   "dependencies": {},