@limetech/lime-web-components-interfaces - npm Package Compare versions

Comparing version 2.2.0 to 2.4.0

CHANGELOG.md

@@ -6,2 +6,13 @@ # Change Log
 
+# [2.4.0](https://github.com/Lundalogik/lime-web-components/compare/v2.3.0...v2.4.0) (2020-03-30)
+
+
+### Features
+
+* **limeobject:** add method for loading relations into the state ([d5cd8b9](https://github.com/Lundalogik/lime-web-components/commit/d5cd8b9e9a4565130b172f892b5d31210b7eef9f))
+
+
+
+
+
 # [2.2.0](https://github.com/Lundalogik/lime-web-components/compare/v2.1.0...v2.2.0) (2019-12-20)
@@ -8,0 +19,0 @@

dist/service/state/limeobjects-service.interface.d.ts

@@ -0,1 +1,2 @@
+import { Expression } from '../../query.interface';
 import { StateService } from '../state-service.interface';
@@ -11,2 +12,13 @@ export interface LimeobjectsStateService extends StateService {
     /**
+     * Load related objects into the state
+     *
+     * @param {string} limetype name of the limetype of the owning limeobject
+     * @param {number} id the id of the owning limeobject
+     * @param {string} property name of the property that contain the relations
+     * @param {LoadOptions} options options about the objects to load
+     *
+     * @returns {ObjectResponse} list of related objects together with total count of objects
+     */
+    loadRelations(limetype: string, id: number, property: string, options?: LoadOptions): Promise<ObjectResponse>;
+    /**
      * Reload the specified limeobject and update corresponding views in the webclient
@@ -25,1 +37,25 @@ *
 }
+export interface LoadOptions {
+    /**
+     * Maximum number of objects to load
+     */
+    limit?: number;
+    /**
+     * Offset of the objects to load
+     */
+    offset?: number;
+    /**
+     * Filter to apply to the objects
+     */
+    filter?: Expression;
+}
+export interface ObjectResponse {
+    /**
+     * The objects that matched the query
+     */
+    objects: object[];
+    /**
+     * Total number of objects that exist matching the query
+     */
+    totalCount: number;
+}

package.json

 {
   "name": "@limetech/lime-web-components-interfaces",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "author": "Lime Technologies",
@@ -33,3 +33,3 @@ "homepage": "https://github.com/Lundalogik/lime-web-components",
   },
-  "gitHead": "22fd9c8a45f334439b7fee79957e569e664ab8d8"
+  "gitHead": "351a91e6ecdd5ada1f87441419e4437d47a977b4"
 }

No alert changes

Improved metrics

Total package byte prevSize

39265

increased by3.69%

Lines of code

1082

increased by3.44%

No dependency changes