@twin.org/tools-models 0.0.3-next.16

package/docs/reference/interfaces/IOpenApiServer.md

@@ -0,0 +1,59 @@
+# Interface: IOpenApiServer
+
+An OpenAPI Server Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#server-object
+
+## Properties
+
+### url {#url}
+
+> **url**: `string`
+
+The target URL.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-3
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+A description of the server.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-3
+
+***
+
+### name? {#name}
+
+> `optional` **name?**: `string`
+
+A unique server name.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-3
+
+***
+
+### variables? {#variables}
+
+> `optional` **variables?**: `object`
+
+URL template variables.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`IOpenApiServerVariable`](IOpenApiServerVariable.md)
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-3

package/docs/reference/interfaces/IOpenApiServerVariable.md

@@ -0,0 +1,43 @@
+# Interface: IOpenApiServerVariable
+
+An OpenAPI Server Variable Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#server-variable-object
+
+## Properties
+
+### enum? {#enum}
+
+> `optional` **enum?**: `string`[]
+
+Allowed substitution values.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-4
+
+***
+
+### default {#default}
+
+> **default**: `string`
+
+The default substitution value.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-4
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+A description of the variable.
+
+#### See
+
+https://spec.openapis.org/oas/latest.html#fixed-fields-4

package/docs/reference/interfaces/IOpenApiTag.md

@@ -0,0 +1,55 @@
+# Interface: IOpenApiTag
+
+An OpenAPI Tag Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#tag-object
+
+## Properties
+
+### name {#name}
+
+> **name**: `string`
+
+The name of the tag.
+
+***
+
+### summary? {#summary}
+
+> `optional` **summary?**: `string`
+
+A short summary of the tag.
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+A description of the tag.
+
+***
+
+### externalDocs? {#externaldocs}
+
+> `optional` **externalDocs?**: [`IOpenApiExternalDocumentation`](IOpenApiExternalDocumentation.md)
+
+Additional external documentation for the tag.
+
+***
+
+### parent? {#parent}
+
+> `optional` **parent?**: `string`
+
+Parent tag name.
+
+***
+
+### kind? {#kind}
+
+> `optional` **kind?**: `string`
+
+A machine-readable category for the tag.

package/docs/reference/interfaces/IPackageJson.md

@@ -0,0 +1,295 @@
+# Interface: IPackageJson
+
+Configuration for each individual package.
+
+## See
+
+ - https://docs.npmjs.com/creating-a-package-json-file
+ - https://docs.npmjs.com/cli/v11/configuring-npm/package-json
+
+## Properties
+
+### name {#name}
+
+> **name**: `string`
+
+The name of the package.
+
+#### See
+
+ - https://docs.npmjs.com/creating-a-package-json-file#required-name-and-version-fields
+ - https://docs.npmjs.com/cli/v11/configuring-npm/package-json#name
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `string`
+
+The semantic version for the package.
+
+#### See
+
+ - https://docs.npmjs.com/creating-a-package-json-file#required-name-and-version-fields
+ - https://docs.npmjs.com/cli/v11/configuring-npm/package-json#version
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+The short description for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#description
+
+***
+
+### keywords? {#keywords}
+
+> `optional` **keywords?**: `string`[]
+
+Search keywords for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#keywords
+
+***
+
+### author? {#author}
+
+> `optional` **author?**: [`IPackageJsonPerson`](../type-aliases/IPackageJsonPerson.md)
+
+The package author.
+
+#### See
+
+ - https://docs.npmjs.com/creating-a-package-json-file#author-field
+ - https://docs.npmjs.com/cli/v11/configuring-npm/package-json#people-fields-author-contributors
+
+***
+
+### contributors? {#contributors}
+
+> `optional` **contributors?**: [`IPackageJsonPerson`](../type-aliases/IPackageJsonPerson.md)[]
+
+The contributors for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#people-fields-author-contributors
+
+***
+
+### homepage? {#homepage}
+
+> `optional` **homepage?**: `string`
+
+The project homepage.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#homepage
+
+***
+
+### repository? {#repository}
+
+> `optional` **repository?**: [`IPackageJsonRepository`](../type-aliases/IPackageJsonRepository.md)
+
+The source repository for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#repository
+
+***
+
+### bugs? {#bugs}
+
+> `optional` **bugs?**: [`IPackageJsonBugs`](../type-aliases/IPackageJsonBugs.md)
+
+The issue tracker for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bugs
+
+***
+
+### license? {#license}
+
+> `optional` **license?**: `string`
+
+The SPDX license expression for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#license
+
+***
+
+### private? {#private}
+
+> `optional` **private?**: `boolean`
+
+Whether the package is private and should not be published.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#private
+
+***
+
+### type? {#type}
+
+> `optional` **type?**: `"commonjs"` \| `"module"`
+
+The module system for .js files in the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#type
+
+***
+
+### main? {#main}
+
+> `optional` **main?**: `string`
+
+The primary package entry point.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#main
+
+***
+
+### types? {#types}
+
+> `optional` **types?**: `string`
+
+The TypeScript declaration entry point.
+
+***
+
+### bin? {#bin}
+
+> `optional` **bin?**: `string` \| [`IPackageJsonStringMap`](IPackageJsonStringMap.md)
+
+The executable entry points for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin
+
+***
+
+### files? {#files}
+
+> `optional` **files?**: `string`[]
+
+The files to include when the package is packed or published.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#files
+
+***
+
+### scripts? {#scripts}
+
+> `optional` **scripts?**: [`IPackageJsonStringMap`](IPackageJsonStringMap.md)
+
+The lifecycle scripts for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#scripts
+
+***
+
+### dependencies? {#dependencies}
+
+> `optional` **dependencies?**: [`IPackageJsonStringMap`](IPackageJsonStringMap.md)
+
+The dependencies for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#dependencies
+
+***
+
+### devDependencies? {#devdependencies}
+
+> `optional` **devDependencies?**: [`IPackageJsonStringMap`](IPackageJsonStringMap.md)
+
+The development-only dependencies for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#devdependencies
+
+***
+
+### peerDependencies? {#peerdependencies}
+
+> `optional` **peerDependencies?**: [`IPackageJsonStringMap`](IPackageJsonStringMap.md)
+
+The peer dependencies for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependencies
+
+***
+
+### optionalDependencies? {#optionaldependencies}
+
+> `optional` **optionalDependencies?**: [`IPackageJsonStringMap`](IPackageJsonStringMap.md)
+
+The optional dependencies for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#optionaldependencies
+
+***
+
+### engines? {#engines}
+
+> `optional` **engines?**: [`IPackageJsonStringMap`](IPackageJsonStringMap.md)
+
+Runtime engine constraints for the package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#engines
+
+***
+
+### publishConfig? {#publishconfig}
+
+> `optional` **publishConfig?**: [`IPackageJsonPublishConfig`](IPackageJsonPublishConfig.md)
+
+Publish-time npm configuration.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#publishconfig
+
+***
+
+### workspaces? {#workspaces}
+
+> `optional` **workspaces?**: `string`[]
+
+Workspace globs for a monorepo root package.
+
+#### See
+
+https://docs.npmjs.com/cli/v11/configuring-npm/package-json#workspaces

package/docs/reference/interfaces/IPackageJsonPublishConfig.md

@@ -0,0 +1,7 @@
+# Interface: IPackageJsonPublishConfig
+
+Publish-time npm configuration.
+
+## Indexable
+
+> \[`id`: `string`\]: `string` \| `boolean`

package/docs/reference/interfaces/IPackageJsonStringMap.md

@@ -0,0 +1,7 @@
+# Interface: IPackageJsonStringMap
+
+A map of package names to version specifiers.
+
+## Indexable
+
+> \[`id`: `string`\]: `string`

package/docs/reference/type-aliases/IOpenApiSecurityScheme.md

@@ -0,0 +1,9 @@
+# Type Alias: IOpenApiSecurityScheme
+
+> **IOpenApiSecurityScheme** = \{ `type`: `"apiKey"`; `description?`: `string`; `name`: `string`; `in`: `"query"` \| `"header"` \| `"cookie"`; `deprecated?`: `boolean`; \} \| \{ `type`: `"http"`; `description?`: `string`; `scheme`: `string`; `bearerFormat?`: `string`; `deprecated?`: `boolean`; \} \| \{ `type`: `"mutualTLS"`; `description?`: `string`; `deprecated?`: `boolean`; \} \| \{ `type`: `"oauth2"`; `description?`: `string`; `flows`: [`IOpenApiOAuthFlows`](../interfaces/IOpenApiOAuthFlows.md); `oauth2MetadataUrl?`: `string`; `deprecated?`: `boolean`; \} \| \{ `type`: `"openIdConnect"`; `description?`: `string`; `openIdConnectUrl`: `string`; `deprecated?`: `boolean`; \}
+
+An OpenAPI Security Scheme Object.
+
+## See
+
+https://spec.openapis.org/oas/latest.html#security-scheme-object

package/docs/reference/type-aliases/IPackageJsonBugs.md

@@ -0,0 +1,5 @@
+# Type Alias: IPackageJsonBugs
+
+> **IPackageJsonBugs** = `string` \| \{ `url?`: `string`; `email?`: `string`; \}
+
+A package bugs field.

package/docs/reference/type-aliases/IPackageJsonPerson.md

@@ -0,0 +1,5 @@
+# Type Alias: IPackageJsonPerson
+
+> **IPackageJsonPerson** = `string` \| \{ `name`: `string`; `email?`: `string`; `url?`: `string`; \}
+
+A package person field.

package/docs/reference/type-aliases/IPackageJsonRepository.md

@@ -0,0 +1,5 @@
+# Type Alias: IPackageJsonRepository
+
+> **IPackageJsonRepository** = `string` \| \{ `type?`: `string`; `url`: `string`; `directory?`: `string`; \}
+
+A package repository field.

package/docs/reference/type-aliases/JsonSchemaTypeNames.md

@@ -0,0 +1,5 @@
+# Type Alias: JsonSchemaTypeNames
+
+> **JsonSchemaTypeNames** = `"string"` \| `"number"` \| `"integer"` \| `"boolean"` \| `"null"` \| `"object"` \| `"array"`
+
+Default schema type names.

package/docs/reference/type-aliases/OpenApiParameterLocation.md

@@ -0,0 +1,5 @@
+# Type Alias: OpenApiParameterLocation
+
+> **OpenApiParameterLocation** = `"path"` \| `"query"` \| `"querystring"` \| `"header"` \| `"cookie"`
+
+The supported parameter locations.

package/docs/reference/type-aliases/OpenApiParameterStyle.md

@@ -0,0 +1,5 @@
+# Type Alias: OpenApiParameterStyle
+
+> **OpenApiParameterStyle** = `"matrix"` \| `"label"` \| `"simple"` \| `"form"` \| `"spaceDelimited"` \| `"pipeDelimited"` \| `"deepObject"` \| `"cookie"`
+
+The supported parameter styles.

package/docs/reference/variables/JsonSchemaTagNames.md

@@ -0,0 +1,5 @@
+# Variable: JsonSchemaTagNames
+
+> `const` **JsonSchemaTagNames**: `string`[]
+
+Supported

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -0,0 +1,51 @@
+{
+	"name": "@twin.org/tools-models",
+	"version": "0.0.3-next.16",
+	"description": "Shared models for tooling packages",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/tools.git",
+		"directory": "packages/tools-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"tools",
+		"core",
+		"foundation",
+		"utilities"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/tools/issues"
+	},
+	"homepage": "https://twindev.org"
+}