@twin.org/data-processing-rest-client 0.0.1-next.6 → 0.0.1-next.7

package/dist/cjs/index.cjs

@@ -35,7 +35,7 @@ class DataProcessingClient extends apiCore.BaseRestClient {
         core.Guards.stringValue(this.CLASS_NAME, "ruleGroup.id", ruleGroup.id);
         core.Guards.stringValue(this.CLASS_NAME, "ruleGroup.label", ruleGroup.label);
         core.Guards.array(this.CLASS_NAME, "ruleGroup.rules", ruleGroup.rules);
-        await this.fetch("/rule-group/:id", "POST", {
+        await this.fetch("/rule-group/:id", "PUT", {
             pathParams: {
                 id: ruleGroup.id
             },
@@ -107,6 +107,22 @@ class DataProcessingClient extends apiCore.BaseRestClient {
         });
         return core.ObjectHelper.fromExtended(result.body);
     }
+    /**
+     * Query the rule group entries.
+     * @param cursor The cursor to request the next page of entities.
+     * @param pageSize The maximum number of entities in a page.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    async query(cursor, pageSize) {
+        const response = await this.fetch("/", "GET", {
+            query: {
+                cursor,
+                pageSize
+            }
+        });
+        return response.body;
+    }
 }
 
 exports.DataProcessingClient = DataProcessingClient;

package/dist/esm/index.mjs

@@ -33,7 +33,7 @@ class DataProcessingClient extends BaseRestClient {
         Guards.stringValue(this.CLASS_NAME, "ruleGroup.id", ruleGroup.id);
         Guards.stringValue(this.CLASS_NAME, "ruleGroup.label", ruleGroup.label);
         Guards.array(this.CLASS_NAME, "ruleGroup.rules", ruleGroup.rules);
-        await this.fetch("/rule-group/:id", "POST", {
+        await this.fetch("/rule-group/:id", "PUT", {
             pathParams: {
                 id: ruleGroup.id
             },
@@ -105,6 +105,22 @@ class DataProcessingClient extends BaseRestClient {
         });
         return ObjectHelper.fromExtended(result.body);
     }
+    /**
+     * Query the rule group entries.
+     * @param cursor The cursor to request the next page of entities.
+     * @param pageSize The maximum number of entities in a page.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    async query(cursor, pageSize) {
+        const response = await this.fetch("/", "GET", {
+            query: {
+                cursor,
+                pageSize
+            }
+        });
+        return response.body;
+    }
 }
 
 export { DataProcessingClient };

package/dist/types/dataProcessingClient.d.ts

@@ -47,4 +47,21 @@ export declare class DataProcessingClient extends BaseRestClient implements IDat
      * @returns The converted data.
      */
     convert(data: Uint8Array, overrideMimeType?: string): Promise<unknown>;
+    /**
+     * Query the rule group entries.
+     * @param cursor The cursor to request the next page of entities.
+     * @param pageSize The maximum number of entities in a page.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    query(cursor?: string, pageSize?: number): Promise<{
+        /**
+         * The entities, which can be partial if a limited keys list was provided.
+         */
+        entities: IRuleGroup[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more entities.
+         */
+        cursor?: string;
+    }>;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/data-processing-rest-client - Changelog
 
-## v0.0.1-next.6
+## v0.0.1-next.7
 
 - Initial Release

package/docs/reference/classes/DataProcessingClient.md

@@ -193,3 +193,36 @@ The converted data.
 #### Implementation of
 
 `IDataProcessingComponent.convert`
+
+***
+
+### query()
+
+> **query**(`cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `IRuleGroup`[]; `cursor`: `string`; \}\>
+
+Query the rule group entries.
+
+#### Parameters
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<\{ `entities`: `IRuleGroup`[]; `cursor`: `string`; \}\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+#### Implementation of
+
+`IDataProcessingComponent.query`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/data-processing-rest-client",
-	"version": "0.0.1-next.6",
+	"version": "0.0.1-next.7",
 	"description": "Data processing contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -17,7 +17,7 @@
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
-		"@twin.org/data-processing-models": "0.0.1-next.6",
+		"@twin.org/data-processing-models": "0.0.1-next.7",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"