@twin.org/api-models 0.0.1-next.3 → 0.0.1-next.5

package/dist/cjs/index.cjs

@@ -65,6 +65,64 @@ 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 the conditions string to a list of comparators.
+     * @param conditions The conditions query string.
+     * @returns The list of comparators.
+     */
+    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(",");
+        }
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -88,3 +146,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,64 @@ 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 the conditions string to a list of comparators.
+     * @param conditions The conditions query string.
+     * @returns The list of comparators.
+     */
+    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(",");
+        }
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -84,4 +142,4 @@ const HealthStatus = {
     Error: "error"
 };
 
-export { HealthStatus, HttpErrorHelper };
+export { HealthStatus, HttpErrorHelper, HttpParameterHelper };

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

@@ -0,0 +1,30 @@
+import type { IComparator } from "@twin.org/entity";
+/**
+ * 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 the conditions string to a list of comparators.
+     * @param conditions The conditions query string.
+     * @returns The list of comparators.
+     */
+    static conditionsFromString(conditions?: string): IComparator[] | undefined;
+    /**
+     * Convert the conditions to a string parameter.
+     * @param conditions The conditions to convert.
+     * @returns The string version of the comparators.
+     */
+    static conditionsToString(conditions?: IComparator[]): 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";

package/docs/changelog.md

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

package/docs/reference/classes/HttpParameterHelper.md

@@ -0,0 +1,101 @@
+# 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.
+
+***
+
+### conditionsFromString()
+
+> `static` **conditionsFromString**(`conditions`?): `undefined` \| `IComparator`[]
+
+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.

package/docs/reference/index.md

@@ -3,6 +3,7 @@
 ## Classes
 
 - [HttpErrorHelper](classes/HttpErrorHelper.md)
+- [HttpParameterHelper](classes/HttpParameterHelper.md)
 
 ## Interfaces
 

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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.5",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",
@@ -13,38 +13,12 @@
 	"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/entity": "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",