@twin.org/api-models 0.0.1-next.7 → 0.0.1-next.9

package/dist/cjs/index.cjs

@@ -88,71 +88,20 @@ class HttpParameterHelper {
         return values?.join(",");
     }
     /**
-     * Convert the conditions string to a list of comparators.
-     * @param conditions The conditions query string.
-     * @returns The list of comparators.
+     * Convert object string to object.
+     * @param value The value query string.
+     * @returns The object.
      */
-    static conditionsFromString(conditions) {
-        const conditionParts = conditions?.split(",") ?? [];
-        const conditionsList = [];
-        for (const conditionPart of conditionParts) {
-            const parts = conditionPart.split("|");
-            if (parts.length === 3) {
-                conditionsList.push({
-                    property: parts[0],
-                    comparison: parts[1],
-                    value: parts[2]
-                });
-            }
-        }
-        return conditionsList.length === 0 ? undefined : conditionsList;
-    }
-    /**
-     * Convert the conditions to a string parameter.
-     * @param conditions The conditions to convert.
-     * @returns The string version of the comparators.
-     */
-    static conditionsToString(conditions) {
-        if (core.Is.arrayValue(conditions)) {
-            const conditionsList = [];
-            for (const conditionPart of conditions) {
-                conditionsList.push(`${conditionPart.property}|${conditionPart.comparison}|${conditionPart.value}`);
-            }
-            return conditionsList.join(",");
-        }
+    static objectFromString(value) {
+        return core.Coerce.object(value);
     }
     /**
-     * Convert the sort string to a list of sort properties.
-     * @param sortProperties The sort properties query string.
-     * @returns The list of sort properties.
+     * Convert object to query string.
+     * @param value The value to convert to a string.
+     * @returns The converted object.
      */
-    static sortPropertiesFromString(sortProperties) {
-        const sortParts = sortProperties?.split(",") ?? [];
-        const sortPropertyList = [];
-        for (const conditionPart of sortParts) {
-            const parts = conditionPart.split("|");
-            if (parts.length === 2) {
-                sortPropertyList.push({
-                    property: parts[0],
-                    sortDirection: parts[1]
-                });
-            }
-        }
-        return sortPropertyList.length === 0 ? undefined : sortPropertyList;
-    }
-    /**
-     * Convert the sort properties to a string parameter.
-     * @param sortProperties The sort properties to convert.
-     * @returns The string version of the sort properties.
-     */
-    static sortPropertiesToString(sortProperties) {
-        if (core.Is.arrayValue(sortProperties)) {
-            const sortPropertyList = [];
-            for (const conditionPart of sortProperties) {
-                sortPropertyList.push(`${conditionPart.property}|${conditionPart.sortDirection}`);
-            }
-            return sortPropertyList.join(",");
-        }
+    static objectToString(value) {
+        return core.Is.object(value) ? JSON.stringify(value) : undefined;
     }
 }
 

package/dist/esm/index.mjs

@@ -1,4 +1,4 @@
-import { BaseError, GuardError, ConflictError, NotFoundError, AlreadyExistsError, UnauthorizedError, NotImplementedError, UnprocessableError, Is } from '@twin.org/core';
+import { BaseError, GuardError, ConflictError, NotFoundError, AlreadyExistsError, UnauthorizedError, NotImplementedError, UnprocessableError, Coerce, Is } from '@twin.org/core';
 import { HttpStatusCode, HeaderTypes, MimeTypes } from '@twin.org/web';
 
 // Copyright 2024 IOTA Stiftung.
@@ -86,71 +86,20 @@ class HttpParameterHelper {
         return values?.join(",");
     }
     /**
-     * Convert the conditions string to a list of comparators.
-     * @param conditions The conditions query string.
-     * @returns The list of comparators.
+     * Convert object string to object.
+     * @param value The value query string.
+     * @returns The object.
      */
-    static conditionsFromString(conditions) {
-        const conditionParts = conditions?.split(",") ?? [];
-        const conditionsList = [];
-        for (const conditionPart of conditionParts) {
-            const parts = conditionPart.split("|");
-            if (parts.length === 3) {
-                conditionsList.push({
-                    property: parts[0],
-                    comparison: parts[1],
-                    value: parts[2]
-                });
-            }
-        }
-        return conditionsList.length === 0 ? undefined : conditionsList;
-    }
-    /**
-     * Convert the conditions to a string parameter.
-     * @param conditions The conditions to convert.
-     * @returns The string version of the comparators.
-     */
-    static conditionsToString(conditions) {
-        if (Is.arrayValue(conditions)) {
-            const conditionsList = [];
-            for (const conditionPart of conditions) {
-                conditionsList.push(`${conditionPart.property}|${conditionPart.comparison}|${conditionPart.value}`);
-            }
-            return conditionsList.join(",");
-        }
+    static objectFromString(value) {
+        return Coerce.object(value);
     }
     /**
-     * Convert the sort string to a list of sort properties.
-     * @param sortProperties The sort properties query string.
-     * @returns The list of sort properties.
+     * Convert object to query string.
+     * @param value The value to convert to a string.
+     * @returns The converted object.
      */
-    static sortPropertiesFromString(sortProperties) {
-        const sortParts = sortProperties?.split(",") ?? [];
-        const sortPropertyList = [];
-        for (const conditionPart of sortParts) {
-            const parts = conditionPart.split("|");
-            if (parts.length === 2) {
-                sortPropertyList.push({
-                    property: parts[0],
-                    sortDirection: parts[1]
-                });
-            }
-        }
-        return sortPropertyList.length === 0 ? undefined : sortPropertyList;
-    }
-    /**
-     * Convert the sort properties to a string parameter.
-     * @param sortProperties The sort properties to convert.
-     * @returns The string version of the sort properties.
-     */
-    static sortPropertiesToString(sortProperties) {
-        if (Is.arrayValue(sortProperties)) {
-            const sortPropertyList = [];
-            for (const conditionPart of sortProperties) {
-                sortPropertyList.push(`${conditionPart.property}|${conditionPart.sortDirection}`);
-            }
-            return sortPropertyList.join(",");
-        }
+    static objectToString(value) {
+        return Is.object(value) ? JSON.stringify(value) : undefined;
     }
 }
 

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

@@ -1,4 +1,3 @@
-import type { IComparator, SortDirection } from "@twin.org/entity";
 /**
  * Class to help with handling http parameters.
  */
@@ -16,33 +15,15 @@ export declare class HttpParameterHelper {
      */
     static arrayToString<T = string>(values?: T[]): string | undefined;
     /**
-     * Convert the conditions string to a list of comparators.
-     * @param conditions The conditions query string.
-     * @returns The list of comparators.
+     * Convert object string to object.
+     * @param value The value query string.
+     * @returns The object.
      */
-    static conditionsFromString(conditions?: string): IComparator[] | undefined;
+    static objectFromString<T = unknown>(value?: string): T | undefined;
     /**
-     * Convert the conditions to a string parameter.
-     * @param conditions The conditions to convert.
-     * @returns The string version of the comparators.
+     * Convert object to query string.
+     * @param value The value to convert to a string.
+     * @returns The converted object.
      */
-    static conditionsToString(conditions?: IComparator[]): string | undefined;
-    /**
-     * Convert the sort string to a list of sort properties.
-     * @param sortProperties The sort properties query string.
-     * @returns The list of sort properties.
-     */
-    static sortPropertiesFromString<T = unknown>(sortProperties?: string): {
-        property: keyof T;
-        sortDirection: SortDirection;
-    }[] | undefined;
-    /**
-     * Convert the sort properties to a string parameter.
-     * @param sortProperties The sort properties to convert.
-     * @returns The string version of the sort properties.
-     */
-    static sortPropertiesToString<T = unknown>(sortProperties?: {
-        property: keyof T;
-        sortDirection: SortDirection;
-    }[]): string | undefined;
+    static objectToString<T = unknown>(value?: T): string | undefined;
 }

package/dist/types/index.d.ts

@@ -27,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-next.7
+## v0.0.1-next.9
 
 - Initial Release

package/docs/reference/classes/HttpParameterHelper.md

@@ -62,51 +62,11 @@ The combined.
 
 ***
 
-### conditionsFromString()
+### objectFromString()
 
-> `static` **conditionsFromString**(`conditions`?): `undefined` \| `IComparator`[]
+> `static` **objectFromString**\<`T`\>(`value`?): `undefined` \| `T`
 
-Convert the conditions string to a list of comparators.
-
-#### Parameters
-
-• **conditions?**: `string`
-
-The conditions query string.
-
-#### Returns
-
-`undefined` \| `IComparator`[]
-
-The list of comparators.
-
-***
-
-### conditionsToString()
-
-> `static` **conditionsToString**(`conditions`?): `undefined` \| `string`
-
-Convert the conditions to a string parameter.
-
-#### Parameters
-
-• **conditions?**: `IComparator`[]
-
-The conditions to convert.
-
-#### Returns
-
-`undefined` \| `string`
-
-The string version of the comparators.
-
-***
-
-### sortPropertiesFromString()
-
-> `static` **sortPropertiesFromString**\<`T`\>(`sortProperties`?): `undefined` \| `object`[]
-
-Convert the sort string to a list of sort properties.
+Convert object string to object.
 
 #### Type Parameters
 
@@ -114,23 +74,23 @@ Convert the sort string to a list of sort properties.
 
 #### Parameters
 
-• **sortProperties?**: `string`
+• **value?**: `string`
 
-The sort properties query string.
+The value query string.
 
 #### Returns
 
-`undefined` \| `object`[]
+`undefined` \| `T`
 
-The list of sort properties.
+The object.
 
 ***
 
-### sortPropertiesToString()
+### objectToString()
 
-> `static` **sortPropertiesToString**\<`T`\>(`sortProperties`?): `undefined` \| `string`
+> `static` **objectToString**\<`T`\>(`value`?): `undefined` \| `string`
 
-Convert the sort properties to a string parameter.
+Convert object to query string.
 
 #### Type Parameters
 
@@ -138,12 +98,12 @@ Convert the sort properties to a string parameter.
 
 #### Parameters
 
-• **sortProperties?**: `object`[]
+• **value?**: `T`
 
-The sort properties to convert.
+The value to convert to a string.
 
 #### Returns
 
 `undefined` \| `string`
 
-The string version of the sort properties.
+The converted object.

package/docs/reference/index.md

@@ -34,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/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.7",
+	"version": "0.0.1-next.9",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",
@@ -15,7 +15,6 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},