@twin.org/api-models 0.0.1-next.1 → 0.0.1-next.10

package/dist/cjs/index.cjs

@@ -65,6 +65,46 @@ class HttpErrorHelper {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to help with handling http parameters.
+ */
+class HttpParameterHelper {
+    /**
+     * Convert list query to array.
+     * @param values The values query string.
+     * @returns The array of values.
+     */
+    static arrayFromString(values) {
+        return values?.split(",");
+    }
+    /**
+     * Convert array of values to query string.
+     * @param values The values to combine string.
+     * @returns The combined.
+     */
+    static arrayToString(values) {
+        return values?.join(",");
+    }
+    /**
+     * Convert object string to object.
+     * @param value The value query string.
+     * @returns The object.
+     */
+    static objectFromString(value) {
+        return core.Is.json(value) ? JSON.parse(value) : undefined;
+    }
+    /**
+     * Convert object to query string.
+     * @param value The value to convert to a string.
+     * @returns The converted object.
+     */
+    static objectToString(value) {
+        return core.Is.empty(value) ? undefined : JSON.stringify(value);
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -88,3 +128,4 @@ const HealthStatus = {
 
 exports.HealthStatus = HealthStatus;
 exports.HttpErrorHelper = HttpErrorHelper;
+exports.HttpParameterHelper = HttpParameterHelper;

package/dist/esm/index.mjs

@@ -1,4 +1,4 @@
-import { BaseError, GuardError, ConflictError, NotFoundError, AlreadyExistsError, UnauthorizedError, NotImplementedError, UnprocessableError } from '@twin.org/core';
+import { BaseError, GuardError, ConflictError, NotFoundError, AlreadyExistsError, UnauthorizedError, NotImplementedError, UnprocessableError, Is } from '@twin.org/core';
 import { HttpStatusCode, HeaderTypes, MimeTypes } from '@twin.org/web';
 
 // Copyright 2024 IOTA Stiftung.
@@ -63,6 +63,46 @@ class HttpErrorHelper {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to help with handling http parameters.
+ */
+class HttpParameterHelper {
+    /**
+     * Convert list query to array.
+     * @param values The values query string.
+     * @returns The array of values.
+     */
+    static arrayFromString(values) {
+        return values?.split(",");
+    }
+    /**
+     * Convert array of values to query string.
+     * @param values The values to combine string.
+     * @returns The combined.
+     */
+    static arrayToString(values) {
+        return values?.join(",");
+    }
+    /**
+     * Convert object string to object.
+     * @param value The value query string.
+     * @returns The object.
+     */
+    static objectFromString(value) {
+        return Is.json(value) ? JSON.parse(value) : undefined;
+    }
+    /**
+     * Convert object to query string.
+     * @param value The value to convert to a string.
+     * @returns The converted object.
+     */
+    static objectToString(value) {
+        return Is.empty(value) ? undefined : JSON.stringify(value);
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -84,4 +124,4 @@ const HealthStatus = {
     Error: "error"
 };
 
-export { HealthStatus, HttpErrorHelper };
+export { HealthStatus, HttpErrorHelper, HttpParameterHelper };

package/dist/types/helpers/httpParameterHelper.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Class to help with handling http parameters.
+ */
+export declare class HttpParameterHelper {
+    /**
+     * Convert list query to array.
+     * @param values The values query string.
+     * @returns The array of values.
+     */
+    static arrayFromString<T = string>(values?: string): T[] | undefined;
+    /**
+     * Convert array of values to query string.
+     * @param values The values to combine string.
+     * @returns The combined.
+     */
+    static arrayToString<T = string>(values?: T[]): string | undefined;
+    /**
+     * Convert object string to object.
+     * @param value The value query string.
+     * @returns The object.
+     */
+    static objectFromString<T = unknown>(value?: string): T | undefined;
+    /**
+     * Convert object to query string.
+     * @param value The value to convert to a string.
+     * @returns The converted object.
+     */
+    static objectToString<T = unknown>(value?: T): string | undefined;
+}

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./helpers/httpErrorHelper";
+export * from "./helpers/httpParameterHelper";
 export * from "./models/api/IServerHealthResponse";
 export * from "./models/api/IServerInfoResponse";
 export * from "./models/api/IServerSpecResponse";
@@ -26,7 +27,10 @@ export * from "./models/responses/success/IOkResponse";
 export * from "./models/routes/IBaseRoute";
 export * from "./models/routes/IRestRoute";
 export * from "./models/routes/IRestRouteEntryPoint";
+export * from "./models/routes/IRestRouteExample";
+export * from "./models/routes/IRestRouteRequestExample";
 export * from "./models/routes/IRestRouteResponseAttachmentOptions";
+export * from "./models/routes/IRestRouteResponseExample";
 export * from "./models/routes/IRestRouteResponseOptions";
 export * from "./models/routes/ISocketRoute";
 export * from "./models/routes/ITag";

package/dist/types/models/routes/IRestRoute.d.ts

@@ -1,5 +1,7 @@
 import type { HttpMethod } from "@twin.org/web";
 import type { IBaseRoute } from "./IBaseRoute";
+import type { IRestRouteRequestExample } from "./IRestRouteRequestExample";
+import type { IRestRouteResponseExample } from "./IRestRouteResponseExample";
 import type { IRestRouteResponseOptions } from "./IRestRouteResponseOptions";
 import type { IHttpRequest } from "../protocol/IHttpRequest";
 import type { IHttpRequestContext } from "../protocol/IHttpRequestContext";
@@ -47,11 +49,7 @@ export interface IRestRoute<T extends IHttpRequest = any, U extends IHttpRespons
         /**
          * Example objects for the request.
          */
-        examples?: {
-            id: string;
-            description?: string;
-            request: T;
-        }[];
+        examples?: IRestRouteRequestExample<T>[];
     };
     /**
      * The type of the response object.
@@ -68,11 +66,7 @@ export interface IRestRoute<T extends IHttpRequest = any, U extends IHttpRespons
         /**
          * Example objects of the response.
          */
-        examples?: {
-            id: string;
-            description?: string;
-            response: U;
-        }[];
+        examples?: IRestRouteResponseExample<U>[];
     }[];
     /**
      * Exclude the route from being included in the spec file.

package/dist/types/models/routes/IRestRouteExample.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Interface which defines a REST route example.
+ */
+export interface IRestRouteExample {
+    /**
+     * Example objects for the request.
+     */
+    id: string;
+    /**
+     * Description of the example.
+     */
+    description?: string;
+}

package/dist/types/models/routes/IRestRouteRequestExample.d.ts

@@ -0,0 +1,10 @@
+import type { IRestRouteExample } from "./IRestRouteExample";
+/**
+ * Interface which defines a REST route request example.
+ */
+export interface IRestRouteRequestExample<T> extends IRestRouteExample {
+    /**
+     * The example request object.
+     */
+    request: T;
+}

package/dist/types/models/routes/IRestRouteResponseExample.d.ts

@@ -0,0 +1,10 @@
+import type { IRestRouteExample } from "./IRestRouteExample";
+/**
+ * Interface which defines a REST route response example.
+ */
+export interface IRestRouteResponseExample<T> extends IRestRouteExample {
+    /**
+     * The example response object.
+     */
+    response: T;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-models - Changelog
 
-## v0.0.1
+## v0.0.1-next.10
 
 - Initial Release

package/docs/reference/classes/HttpParameterHelper.md

@@ -0,0 +1,109 @@
+# Class: HttpParameterHelper
+
+Class to help with handling http parameters.
+
+## Constructors
+
+### new HttpParameterHelper()
+
+> **new HttpParameterHelper**(): [`HttpParameterHelper`](HttpParameterHelper.md)
+
+#### Returns
+
+[`HttpParameterHelper`](HttpParameterHelper.md)
+
+## Methods
+
+### arrayFromString()
+
+> `static` **arrayFromString**\<`T`\>(`values`?): `undefined` \| `T`[]
+
+Convert list query to array.
+
+#### Type Parameters
+
+• **T** = `string`
+
+#### Parameters
+
+• **values?**: `string`
+
+The values query string.
+
+#### Returns
+
+`undefined` \| `T`[]
+
+The array of values.
+
+***
+
+### arrayToString()
+
+> `static` **arrayToString**\<`T`\>(`values`?): `undefined` \| `string`
+
+Convert array of values to query string.
+
+#### Type Parameters
+
+• **T** = `string`
+
+#### Parameters
+
+• **values?**: `T`[]
+
+The values to combine string.
+
+#### Returns
+
+`undefined` \| `string`
+
+The combined.
+
+***
+
+### objectFromString()
+
+> `static` **objectFromString**\<`T`\>(`value`?): `undefined` \| `T`
+
+Convert object string to object.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **value?**: `string`
+
+The value query string.
+
+#### Returns
+
+`undefined` \| `T`
+
+The object.
+
+***
+
+### objectToString()
+
+> `static` **objectToString**\<`T`\>(`value`?): `undefined` \| `string`
+
+Convert object to query string.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **value?**: `T`
+
+The value to convert to a string.
+
+#### Returns
+
+`undefined` \| `string`
+
+The converted object.

package/docs/reference/index.md

@@ -3,6 +3,7 @@
 ## Classes
 
 - [HttpErrorHelper](classes/HttpErrorHelper.md)
+- [HttpParameterHelper](classes/HttpParameterHelper.md)
 
 ## Interfaces
 
@@ -33,7 +34,10 @@
 - [IBaseRoute](interfaces/IBaseRoute.md)
 - [IRestRoute](interfaces/IRestRoute.md)
 - [IRestRouteEntryPoint](interfaces/IRestRouteEntryPoint.md)
+- [IRestRouteExample](interfaces/IRestRouteExample.md)
+- [IRestRouteRequestExample](interfaces/IRestRouteRequestExample.md)
 - [IRestRouteResponseAttachmentOptions](interfaces/IRestRouteResponseAttachmentOptions.md)
+- [IRestRouteResponseExample](interfaces/IRestRouteResponseExample.md)
 - [IRestRouteResponseOptions](interfaces/IRestRouteResponseOptions.md)
 - [ISocketRoute](interfaces/ISocketRoute.md)
 - [ITag](interfaces/ITag.md)

package/docs/reference/interfaces/ICreatedResponse.md

@@ -18,8 +18,8 @@ Response status code.
 
 Additional response headers.
 
-#### Location
+#### location
 
-> **Location**: `string`
+> **location**: `string`
 
 The location where the resource was created.

package/docs/reference/interfaces/IRestRoute.md

@@ -116,7 +116,7 @@ The mime type of the request, defaults to "application/json" if there is a body.
 
 #### examples?
 
-> `optional` **examples**: `object`[]
+> `optional` **examples**: [`IRestRouteRequestExample`](IRestRouteRequestExample.md)\<`T`\>[]
 
 Example objects for the request.
 

package/docs/reference/interfaces/IRestRouteExample.md

@@ -0,0 +1,24 @@
+# Interface: IRestRouteExample
+
+Interface which defines a REST route example.
+
+## Extended by
+
+- [`IRestRouteRequestExample`](IRestRouteRequestExample.md)
+- [`IRestRouteResponseExample`](IRestRouteResponseExample.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Example objects for the request.
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description of the example.

package/docs/reference/interfaces/IRestRouteRequestExample.md

@@ -0,0 +1,43 @@
+# Interface: IRestRouteRequestExample\<T\>
+
+Interface which defines a REST route request example.
+
+## Extends
+
+- [`IRestRouteExample`](IRestRouteExample.md)
+
+## Type Parameters
+
+• **T**
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Example objects for the request.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`id`](IRestRouteExample.md#id)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description of the example.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`description`](IRestRouteExample.md#description)
+
+***
+
+### request
+
+> **request**: `T`
+
+The example request object.

package/docs/reference/interfaces/IRestRouteResponseExample.md

@@ -0,0 +1,43 @@
+# Interface: IRestRouteResponseExample\<T\>
+
+Interface which defines a REST route response example.
+
+## Extends
+
+- [`IRestRouteExample`](IRestRouteExample.md)
+
+## Type Parameters
+
+• **T**
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Example objects for the request.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`id`](IRestRouteExample.md#id)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description of the example.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`description`](IRestRouteExample.md#description)
+
+***
+
+### response
+
+> **response**: `T`
+
+The example response object.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.1-next.1",
+	"version": "0.0.1-next.10",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",
@@ -13,38 +13,11 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage",
-		"build": "tspc",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"devDependencies": {
-		"@twin.org/nameof-transformer": "next",
-		"@vitest/coverage-v8": "2.1.1",
-		"@types/node": "22.5.5",
-		"copyfiles": "2.4.1",
-		"rimraf": "6.0.1",
-		"rollup": "4.21.3",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
-	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",