@twin.org/tools-models 0.0.3-next.18 → 0.0.3-next.20

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/es/index.js CHANGED
@@ -15,6 +15,8 @@ export * from "./models/openApi/IOpenApiMediaType.js";
15
15
  export * from "./models/openApi/IOpenApiOAuthFlow.js";
16
16
  export * from "./models/openApi/IOpenApiOAuthFlows.js";
17
17
  export * from "./models/openApi/IOpenApiParameter.js";
18
+ export * from "./models/openApi/OpenApiParameterLocation.js";
19
+ export * from "./models/openApi/OpenApiParameterStyle.js";
18
20
  export * from "./models/openApi/IOpenApiPathItem.js";
19
21
  export * from "./models/openApi/IOpenApiPathMethod.js";
20
22
  export * from "./models/openApi/IOpenApiReference.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,oCAAoC,CAAC;AACnD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wCAAwC,CAAC;AACvD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mDAAmD,CAAC;AAClE,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,sCAAsC,CAAC;AACrD,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,yCAAyC,CAAC;AACxD,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,iDAAiD,CAAC;AAChE,cAAc,4CAA4C,CAAC;AAC3D,cAAc,oCAAoC,CAAC;AACnD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,sCAAsC,CAAC;AACrD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAClE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,+CAA+C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/jsonSchema/IJsonSchema.js\";\nexport * from \"./models/jsonSchema/jsonSchemaTagNames.js\";\nexport * from \"./models/jsonSchema/jsonSchemaTypeNames.js\";\nexport * from \"./models/openApi/IOpenApi.js\";\nexport * from \"./models/openApi/IOpenApiComponents.js\";\nexport * from \"./models/openApi/IOpenApiContact.js\";\nexport * from \"./models/openApi/IOpenApiExample.js\";\nexport * from \"./models/openApi/IOpenApiExternalDocumentation.js\";\nexport * from \"./models/openApi/IOpenApiHeader.js\";\nexport * from \"./models/openApi/IOpenApiInfo.js\";\nexport * from \"./models/openApi/IOpenApiLicense.js\";\nexport * from \"./models/openApi/IOpenApiMediaType.js\";\nexport * from \"./models/openApi/IOpenApiOAuthFlow.js\";\nexport * from \"./models/openApi/IOpenApiOAuthFlows.js\";\nexport * from \"./models/openApi/IOpenApiParameter.js\";\nexport * from \"./models/openApi/IOpenApiPathItem.js\";\nexport * from \"./models/openApi/IOpenApiPathMethod.js\";\nexport * from \"./models/openApi/IOpenApiReference.js\";\nexport * from \"./models/openApi/IOpenApiRequestBody.js\";\nexport * from \"./models/openApi/IOpenApiResponse.js\";\nexport * from \"./models/openApi/IOpenApiResponses.js\";\nexport * from \"./models/openApi/IOpenApiSecurityRequirement.js\";\nexport * from \"./models/openApi/IOpenApiSecurityScheme.js\";\nexport * from \"./models/openApi/IOpenApiServer.js\";\nexport * from \"./models/openApi/IOpenApiServerVariable.js\";\nexport * from \"./models/openApi/IOpenApiTag.js\";\nexport * from \"./models/openApi/openApiConstants.js\";\nexport * from \"./models/packageJson/IPackageJson.js\";\nexport * from \"./models/packageJson/IPackageJsonBugs.js\";\nexport * from \"./models/packageJson/IPackageJsonPerson.js\";\nexport * from \"./models/packageJson/IPackageJsonPublishConfig.js\";\nexport * from \"./models/packageJson/IPackageJsonRepository.js\";\nexport * from \"./models/packageJson/IPackageJsonStringMap.js\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,oCAAoC,CAAC;AACnD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wCAAwC,CAAC;AACvD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mDAAmD,CAAC;AAClE,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,sCAAsC,CAAC;AACrD,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,yCAAyC,CAAC;AACxD,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,iDAAiD,CAAC;AAChE,cAAc,4CAA4C,CAAC;AAC3D,cAAc,oCAAoC,CAAC;AACnD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,sCAAsC,CAAC;AACrD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAClE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,+CAA+C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/jsonSchema/IJsonSchema.js\";\nexport * from \"./models/jsonSchema/jsonSchemaTagNames.js\";\nexport * from \"./models/jsonSchema/jsonSchemaTypeNames.js\";\nexport * from \"./models/openApi/IOpenApi.js\";\nexport * from \"./models/openApi/IOpenApiComponents.js\";\nexport * from \"./models/openApi/IOpenApiContact.js\";\nexport * from \"./models/openApi/IOpenApiExample.js\";\nexport * from \"./models/openApi/IOpenApiExternalDocumentation.js\";\nexport * from \"./models/openApi/IOpenApiHeader.js\";\nexport * from \"./models/openApi/IOpenApiInfo.js\";\nexport * from \"./models/openApi/IOpenApiLicense.js\";\nexport * from \"./models/openApi/IOpenApiMediaType.js\";\nexport * from \"./models/openApi/IOpenApiOAuthFlow.js\";\nexport * from \"./models/openApi/IOpenApiOAuthFlows.js\";\nexport * from \"./models/openApi/IOpenApiParameter.js\";\nexport * from \"./models/openApi/OpenApiParameterLocation.js\";\nexport * from \"./models/openApi/OpenApiParameterStyle.js\";\nexport * from \"./models/openApi/IOpenApiPathItem.js\";\nexport * from \"./models/openApi/IOpenApiPathMethod.js\";\nexport * from \"./models/openApi/IOpenApiReference.js\";\nexport * from \"./models/openApi/IOpenApiRequestBody.js\";\nexport * from \"./models/openApi/IOpenApiResponse.js\";\nexport * from \"./models/openApi/IOpenApiResponses.js\";\nexport * from \"./models/openApi/IOpenApiSecurityRequirement.js\";\nexport * from \"./models/openApi/IOpenApiSecurityScheme.js\";\nexport * from \"./models/openApi/IOpenApiServer.js\";\nexport * from \"./models/openApi/IOpenApiServerVariable.js\";\nexport * from \"./models/openApi/IOpenApiTag.js\";\nexport * from \"./models/openApi/openApiConstants.js\";\nexport * from \"./models/packageJson/IPackageJson.js\";\nexport * from \"./models/packageJson/IPackageJsonBugs.js\";\nexport * from \"./models/packageJson/IPackageJsonPerson.js\";\nexport * from \"./models/packageJson/IPackageJsonPublishConfig.js\";\nexport * from \"./models/packageJson/IPackageJsonRepository.js\";\nexport * from \"./models/packageJson/IPackageJsonStringMap.js\";\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"IOpenApiParameter.js","sourceRoot":"","sources":["../../../../src/models/openApi/IOpenApiParameter.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IOpenApiExample } from \"./IOpenApiExample.js\";\nimport type { IOpenApiMediaType } from \"./IOpenApiMediaType.js\";\nimport type { IOpenApiReference } from \"./IOpenApiReference.js\";\nimport type { IJsonSchema } from \"../jsonSchema/IJsonSchema.js\";\n\n/**\n * The supported parameter locations.\n */\nexport type OpenApiParameterLocation = \"path\" | \"query\" | \"querystring\" | \"header\" | \"cookie\";\n\n/**\n * The supported parameter styles.\n */\nexport type OpenApiParameterStyle =\n\t| \"matrix\"\n\t| \"label\"\n\t| \"simple\"\n\t| \"form\"\n\t| \"spaceDelimited\"\n\t| \"pipeDelimited\"\n\t| \"deepObject\"\n\t| \"cookie\";\n\n/**\n * An OpenAPI Parameter Object.\n * @see https://spec.openapis.org/oas/latest.html#parameter-object\n */\nexport interface IOpenApiParameter {\n\t/**\n\t * The name of the parameter.\n\t */\n\tname: string;\n\n\t/**\n\t * The location of the parameter.\n\t */\n\tin: OpenApiParameterLocation;\n\n\t/**\n\t * A brief description of the parameter.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * Whether the parameter is required.\n\t */\n\trequired?: boolean;\n\n\t/**\n\t * Whether the parameter is deprecated.\n\t */\n\tdeprecated?: boolean;\n\n\t/**\n\t * Whether empty values are allowed for query parameters.\n\t */\n\tallowEmptyValue?: boolean;\n\n\t/**\n\t * A shorthand example for the parameter.\n\t */\n\texample?: unknown;\n\n\t/**\n\t * Named examples for the parameter.\n\t */\n\texamples?: {\n\t\t[id: string]: IOpenApiExample | IOpenApiReference;\n\t};\n\n\t/**\n\t * The serialization style for the parameter.\n\t */\n\tstyle?: OpenApiParameterStyle;\n\n\t/**\n\t * Whether exploded serialization is used.\n\t */\n\texplode?: boolean;\n\n\t/**\n\t * Whether reserved characters may pass through unchanged.\n\t */\n\tallowReserved?: boolean;\n\n\t/**\n\t * The schema describing the parameter.\n\t */\n\tschema?: IJsonSchema;\n\n\t/**\n\t * Content-based parameter serialization.\n\t */\n\tcontent?: {\n\t\t[contentType: string]: IOpenApiMediaType | IOpenApiReference;\n\t};\n}\n"]}
1
+ {"version":3,"file":"IOpenApiParameter.js","sourceRoot":"","sources":["../../../../src/models/openApi/IOpenApiParameter.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IOpenApiExample } from \"./IOpenApiExample.js\";\nimport type { IOpenApiMediaType } from \"./IOpenApiMediaType.js\";\nimport type { IOpenApiReference } from \"./IOpenApiReference.js\";\nimport type { OpenApiParameterLocation } from \"./OpenApiParameterLocation.js\";\nimport type { OpenApiParameterStyle } from \"./OpenApiParameterStyle.js\";\nimport type { IJsonSchema } from \"../jsonSchema/IJsonSchema.js\";\n\n/**\n * An OpenAPI Parameter Object.\n * @see https://spec.openapis.org/oas/latest.html#parameter-object\n */\nexport interface IOpenApiParameter {\n\t/**\n\t * The name of the parameter.\n\t */\n\tname: string;\n\n\t/**\n\t * The location of the parameter.\n\t */\n\tin: OpenApiParameterLocation;\n\n\t/**\n\t * A brief description of the parameter.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * Whether the parameter is required.\n\t */\n\trequired?: boolean;\n\n\t/**\n\t * Whether the parameter is deprecated.\n\t */\n\tdeprecated?: boolean;\n\n\t/**\n\t * Whether empty values are allowed for query parameters.\n\t */\n\tallowEmptyValue?: boolean;\n\n\t/**\n\t * A shorthand example for the parameter.\n\t */\n\texample?: unknown;\n\n\t/**\n\t * Named examples for the parameter.\n\t */\n\texamples?: {\n\t\t[id: string]: IOpenApiExample | IOpenApiReference;\n\t};\n\n\t/**\n\t * The serialization style for the parameter.\n\t */\n\tstyle?: OpenApiParameterStyle;\n\n\t/**\n\t * Whether exploded serialization is used.\n\t */\n\texplode?: boolean;\n\n\t/**\n\t * Whether reserved characters may pass through unchanged.\n\t */\n\tallowReserved?: boolean;\n\n\t/**\n\t * The schema describing the parameter.\n\t */\n\tschema?: IJsonSchema;\n\n\t/**\n\t * Content-based parameter serialization.\n\t */\n\tcontent?: {\n\t\t[contentType: string]: IOpenApiMediaType | IOpenApiReference;\n\t};\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2024 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=OpenApiParameterLocation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OpenApiParameterLocation.js","sourceRoot":"","sources":["../../../../src/models/openApi/OpenApiParameterLocation.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The supported parameter locations.\n */\nexport type OpenApiParameterLocation = \"path\" | \"query\" | \"querystring\" | \"header\" | \"cookie\";\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2024 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=OpenApiParameterStyle.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OpenApiParameterStyle.js","sourceRoot":"","sources":["../../../../src/models/openApi/OpenApiParameterStyle.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The supported parameter styles.\n */\nexport type OpenApiParameterStyle =\n\t| \"matrix\"\n\t| \"label\"\n\t| \"simple\"\n\t| \"form\"\n\t| \"spaceDelimited\"\n\t| \"pipeDelimited\"\n\t| \"deepObject\"\n\t| \"cookie\";\n"]}
@@ -13,6 +13,8 @@ export * from "./models/openApi/IOpenApiMediaType.js";
13
13
  export * from "./models/openApi/IOpenApiOAuthFlow.js";
14
14
  export * from "./models/openApi/IOpenApiOAuthFlows.js";
15
15
  export * from "./models/openApi/IOpenApiParameter.js";
16
+ export * from "./models/openApi/OpenApiParameterLocation.js";
17
+ export * from "./models/openApi/OpenApiParameterStyle.js";
16
18
  export * from "./models/openApi/IOpenApiPathItem.js";
17
19
  export * from "./models/openApi/IOpenApiPathMethod.js";
18
20
  export * from "./models/openApi/IOpenApiReference.js";
@@ -1,15 +1,9 @@
1
1
  import type { IOpenApiExample } from "./IOpenApiExample.js";
2
2
  import type { IOpenApiMediaType } from "./IOpenApiMediaType.js";
3
3
  import type { IOpenApiReference } from "./IOpenApiReference.js";
4
+ import type { OpenApiParameterLocation } from "./OpenApiParameterLocation.js";
5
+ import type { OpenApiParameterStyle } from "./OpenApiParameterStyle.js";
4
6
  import type { IJsonSchema } from "../jsonSchema/IJsonSchema.js";
5
- /**
6
- * The supported parameter locations.
7
- */
8
- export type OpenApiParameterLocation = "path" | "query" | "querystring" | "header" | "cookie";
9
- /**
10
- * The supported parameter styles.
11
- */
12
- export type OpenApiParameterStyle = "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | "cookie";
13
7
  /**
14
8
  * An OpenAPI Parameter Object.
15
9
  * @see https://spec.openapis.org/oas/latest.html#parameter-object
@@ -0,0 +1,4 @@
1
+ /**
2
+ * The supported parameter locations.
3
+ */
4
+ export type OpenApiParameterLocation = "path" | "query" | "querystring" | "header" | "cookie";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * The supported parameter styles.
3
+ */
4
+ export type OpenApiParameterStyle = "matrix" | "label" | "simple" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject" | "cookie";
package/docs/changelog.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.0.3-next.20](https://github.com/twinfoundation/tools/compare/tools-models-v0.0.3-next.19...tools-models-v0.0.3-next.20) (2026-03-20)
4
+
5
+
6
+ ### Features
7
+
8
+ * alternate path and query param schemas ([e7487e3](https://github.com/twinfoundation/tools/commit/e7487e3bf4ccee3f52245ca27bc7cc160ab391b8))
9
+
10
+ ## [0.0.3-next.19](https://github.com/twinfoundation/tools/compare/tools-models-v0.0.3-next.18...tools-models-v0.0.3-next.19) (2026-03-19)
11
+
12
+
13
+ ### Miscellaneous Chores
14
+
15
+ * **tools-models:** Synchronize repo versions
16
+
3
17
  ## [0.0.3-next.18](https://github.com/twinfoundation/tools/compare/tools-models-v0.0.3-next.17...tools-models-v0.0.3-next.18) (2026-03-19)
4
18
 
5
19
 
@@ -36,9 +36,9 @@
36
36
  ## Type Aliases
37
37
 
38
38
  - [JsonSchemaTypeNames](type-aliases/JsonSchemaTypeNames.md)
39
+ - [IOpenApiSecurityScheme](type-aliases/IOpenApiSecurityScheme.md)
39
40
  - [OpenApiParameterLocation](type-aliases/OpenApiParameterLocation.md)
40
41
  - [OpenApiParameterStyle](type-aliases/OpenApiParameterStyle.md)
41
- - [IOpenApiSecurityScheme](type-aliases/IOpenApiSecurityScheme.md)
42
42
  - [IPackageJsonBugs](type-aliases/IPackageJsonBugs.md)
43
43
  - [IPackageJsonPerson](type-aliases/IPackageJsonPerson.md)
44
44
  - [IPackageJsonRepository](type-aliases/IPackageJsonRepository.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/tools-models",
3
- "version": "0.0.3-next.18",
3
+ "version": "0.0.3-next.20",
4
4
  "description": "Shared models for tooling packages",
5
5
  "repository": {
6
6
  "type": "git",