@c8y/client 1017.45.0 → 1017.47.0

package/lib/cjs/src/application/ApplicationService.js

@@ -337,7 +337,7 @@ class ApplicationService extends core_1.Service {
         return { res, data };
     }
     /**
-     * Dynamic options are stored on the API in a specific config: {} object. They can
+     * Dynamic options are stored on the API in a specific `config: {}` object. They can
      * be used to configure the app dynamically.
      *
      * Note: To avoids conflicts with the default Config, it is recommended

package/lib/cjs/src/application/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ApplicationService"), exports);
+__exportStar(require("./ApplicationBinaryService"), exports);
 __exportStar(require("./IApplication"), exports);
 __exportStar(require("./IApplicationBinary"), exports);
 __exportStar(require("./IApplicationInstanceDetails"), exports);

package/lib/cjs/src/application/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/application/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,iDAA+B;AAC/B,uDAAqC;AACrC,gEAA8C;AAC9C,0DAAwC;AACxC,oDAAkC;AAClC,gDAA8B;AAC9B,8CAA4B;AAC5B,4DAA0C;AAC1C,8CAA4B;AAC5B,8CAA4B;AAC5B,0DAAwC;AACxC,wDAAsC;AACtC,gEAA8C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/application/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,6DAA2C;AAC3C,iDAA+B;AAC/B,uDAAqC;AACrC,gEAA8C;AAC9C,0DAAwC;AACxC,oDAAkC;AAClC,gDAA8B;AAC9B,8CAA4B;AAC5B,4DAA0C;AAC1C,8CAA4B;AAC5B,8CAA4B;AAC5B,0DAAwC;AACxC,wDAAsC;AACtC,gEAA8C"}

package/lib/cjs/src/core/QueriesUtil.js

@@ -57,32 +57,32 @@ class QueriesUtil {
      * Builds query string from provided query object.
      *
      * @param query Object containing filters and sort order for querying managed objects. Supported filters are:
-     * - **__and** - Specifies conditions, e.g. {__and: [{__has: 'c8y_IsDevice'}, {'count': {__gt: 0}}]}.
-     * - **__or** - Specifies alternative conditions, e.g. {__or: [{__bygroupid: 10300}, {__bygroupid: 10400}]}.
-     * - **__eq** - Specified fragment must be equal to given value, e.g. {'status': 'AVAILABLE'} (no nested object required).
-     * - **__lt** - Specified fragment must be less then given value, e.g. {'count': {__lt: 10}}.
-     * - **__gt** - Specified fragment must be greater then given value, e.g. {'count': {__gt: 0}}.
-     * - **__in** - Specified fragment must be equal to one of values in the list, e.g. {'status': {__in: ['AVAILABLE', 'UNAVAILABLE']}}.
-     * - **__not** - Negates condition, e.g. {__not: {'status': 'AVAILABLE'}}.
-     * - **__bygroupid** - True if filtered managed object is assigned to given group, e.g. {__bygroupid: 10300}.
-     * - **__has** - Specified fragment must have a value defined, e.g. {__has: 'c8y_IsDevice'}.
-     * - **__useFilterQueryString** - Gets rid of the '$filter=()… $orderby=…' parts of a query and keeps only what's between the most
+     * - **__and** - Specifies conditions, e.g. `{__and: [{__has: 'c8y_IsDevice'}, {'count': {__gt: 0}}]}`.
+     * - **__or** - Specifies alternative conditions, e.g. `{__or: [{__bygroupid: 10300}, {__bygroupid: 10400}]}`.
+     * - **__eq** - Specified fragment must be equal to given value, e.g. `{'status': 'AVAILABLE'}` (no nested object required).
+     * - **__lt** - Specified fragment must be less then given value, e.g. `{'count': {__lt: 10}}`.
+     * - **__gt** - Specified fragment must be greater then given value, e.g. `{'count': {__gt: 0}}`.
+     * - **__in** - Specified fragment must be equal to one of values in the list, e.g. `{'status': {__in: ['AVAILABLE', 'UNAVAILABLE']}}`.
+     * - **__not** - Negates condition, e.g. `{__not: {'status': 'AVAILABLE'}}`.
+     * - **__bygroupid** - True if filtered managed object is assigned to given group, e.g. `{__bygroupid: 10300}`.
+     * - **__has** - Specified fragment must have a value defined, e.g. `{__has: 'c8y_IsDevice'}`.
+     * - **__useFilterQueryString** - Gets rid of the `$filter=()… $orderby=…` parts of a query and keeps only what's between the most
      *                                exterior parentheses of the $filter.
      *                                EXAMPLE: takes a query of the form
-     *                                "$filter=(name eq 'RaspPi*') $orderby=name asc"
+     *                                `$filter=(name eq 'RaspPi*') $orderby=name asc`
      *                                and turns it into
-     *                                "name eq 'RaspPi*'"
+     *                                `name eq 'RaspPi*'`
      *                                This is necessary for searching for smart groups, which are identified by their own query
      *                                that needs to be passed through.
      *
      *
      * The order is specified by an array of field paths and sort direction (1 for ascending, -1 for descending), e.g.:
-     * - {__orderby: [{'creationTime': -1}, {'name': 1}], __filter: {...}}
+     * - `{__orderby: [{'creationTime': -1}, {'name': 1}], __filter: {...}}`
      *
      * @returns {string} Returns a query string ready to be sent in request params to backend.
      *
      * **Example**
-     * <pre>
+     * ```typescript
      *   const query = {
      *     __filter: {
      *       'name': 'My Device*',
@@ -115,7 +115,7 @@ class QueriesUtil {
      *   const params = {
      *     query: queriesUtil.buildQuery(query)
      *   };
-     * </pre>
+     * ```
      */
     buildQuery(query) {
         const q = [];

package/lib/esm2015/src/application/ApplicationService.js

@@ -389,7 +389,7 @@ export class ApplicationService extends Service {
         });
     }
     /**
-     * Dynamic options are stored on the API in a specific config: {} object. They can
+     * Dynamic options are stored on the API in a specific `config: {}` object. They can
      * be used to configure the app dynamically.
      *
      * Note: To avoids conflicts with the default Config, it is recommended

package/lib/esm2015/src/application/index.js

@@ -1,4 +1,5 @@
 export * from './ApplicationService';
+export * from './ApplicationBinaryService';
 export * from './IApplication';
 export * from './IApplicationBinary';
 export * from './IApplicationInstanceDetails';

package/lib/esm2015/src/application/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/application/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/application/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC"}

package/lib/esm2015/src/core/QueriesUtil.js

@@ -55,32 +55,32 @@ export class QueriesUtil {
      * Builds query string from provided query object.
      *
      * @param query Object containing filters and sort order for querying managed objects. Supported filters are:
-     * - **__and** - Specifies conditions, e.g. {__and: [{__has: 'c8y_IsDevice'}, {'count': {__gt: 0}}]}.
-     * - **__or** - Specifies alternative conditions, e.g. {__or: [{__bygroupid: 10300}, {__bygroupid: 10400}]}.
-     * - **__eq** - Specified fragment must be equal to given value, e.g. {'status': 'AVAILABLE'} (no nested object required).
-     * - **__lt** - Specified fragment must be less then given value, e.g. {'count': {__lt: 10}}.
-     * - **__gt** - Specified fragment must be greater then given value, e.g. {'count': {__gt: 0}}.
-     * - **__in** - Specified fragment must be equal to one of values in the list, e.g. {'status': {__in: ['AVAILABLE', 'UNAVAILABLE']}}.
-     * - **__not** - Negates condition, e.g. {__not: {'status': 'AVAILABLE'}}.
-     * - **__bygroupid** - True if filtered managed object is assigned to given group, e.g. {__bygroupid: 10300}.
-     * - **__has** - Specified fragment must have a value defined, e.g. {__has: 'c8y_IsDevice'}.
-     * - **__useFilterQueryString** - Gets rid of the '$filter=()… $orderby=…' parts of a query and keeps only what's between the most
+     * - **__and** - Specifies conditions, e.g. `{__and: [{__has: 'c8y_IsDevice'}, {'count': {__gt: 0}}]}`.
+     * - **__or** - Specifies alternative conditions, e.g. `{__or: [{__bygroupid: 10300}, {__bygroupid: 10400}]}`.
+     * - **__eq** - Specified fragment must be equal to given value, e.g. `{'status': 'AVAILABLE'}` (no nested object required).
+     * - **__lt** - Specified fragment must be less then given value, e.g. `{'count': {__lt: 10}}`.
+     * - **__gt** - Specified fragment must be greater then given value, e.g. `{'count': {__gt: 0}}`.
+     * - **__in** - Specified fragment must be equal to one of values in the list, e.g. `{'status': {__in: ['AVAILABLE', 'UNAVAILABLE']}}`.
+     * - **__not** - Negates condition, e.g. `{__not: {'status': 'AVAILABLE'}}`.
+     * - **__bygroupid** - True if filtered managed object is assigned to given group, e.g. `{__bygroupid: 10300}`.
+     * - **__has** - Specified fragment must have a value defined, e.g. `{__has: 'c8y_IsDevice'}`.
+     * - **__useFilterQueryString** - Gets rid of the `$filter=()… $orderby=…` parts of a query and keeps only what's between the most
      *                                exterior parentheses of the $filter.
      *                                EXAMPLE: takes a query of the form
-     *                                "$filter=(name eq 'RaspPi*') $orderby=name asc"
+     *                                `$filter=(name eq 'RaspPi*') $orderby=name asc`
      *                                and turns it into
-     *                                "name eq 'RaspPi*'"
+     *                                `name eq 'RaspPi*'`
      *                                This is necessary for searching for smart groups, which are identified by their own query
      *                                that needs to be passed through.
      *
      *
      * The order is specified by an array of field paths and sort direction (1 for ascending, -1 for descending), e.g.:
-     * - {__orderby: [{'creationTime': -1}, {'name': 1}], __filter: {...}}
+     * - `{__orderby: [{'creationTime': -1}, {'name': 1}], __filter: {...}}`
      *
      * @returns {string} Returns a query string ready to be sent in request params to backend.
      *
      * **Example**
-     * <pre>
+     * ```typescript
      *   const query = {
      *     __filter: {
      *       'name': 'My Device*',
@@ -113,7 +113,7 @@ export class QueriesUtil {
      *   const params = {
      *     query: queriesUtil.buildQuery(query)
      *   };
-     * </pre>
+     * ```
      */
     buildQuery(query) {
         const q = [];

package/lib/src/application/ApplicationService.d.ts

@@ -226,7 +226,7 @@ export declare class ApplicationService extends Service<IApplication> {
      */
     getInstanceLog(entityOrId: string | number | IApplication, instanceName: string, params?: IApplicationInstanceLogRequestParams): Promise<IResult<IApplicationInstanceLog>>;
     /**
-     * Dynamic options are stored on the API in a specific config: {} object. They can
+     * Dynamic options are stored on the API in a specific `config: {}` object. They can
      * be used to configure the app dynamically.
      *
      * Note: To avoids conflicts with the default Config, it is recommended

package/lib/src/application/index.d.ts

@@ -1,4 +1,5 @@
 export * from './ApplicationService';
+export * from './ApplicationBinaryService';
 export * from './IApplication';
 export * from './IApplicationBinary';
 export * from './IApplicationInstanceDetails';

package/lib/src/core/QueriesUtil.d.ts

@@ -17,32 +17,32 @@ export declare class QueriesUtil {
      * Builds query string from provided query object.
      *
      * @param query Object containing filters and sort order for querying managed objects. Supported filters are:
-     * - **__and** - Specifies conditions, e.g. {__and: [{__has: 'c8y_IsDevice'}, {'count': {__gt: 0}}]}.
-     * - **__or** - Specifies alternative conditions, e.g. {__or: [{__bygroupid: 10300}, {__bygroupid: 10400}]}.
-     * - **__eq** - Specified fragment must be equal to given value, e.g. {'status': 'AVAILABLE'} (no nested object required).
-     * - **__lt** - Specified fragment must be less then given value, e.g. {'count': {__lt: 10}}.
-     * - **__gt** - Specified fragment must be greater then given value, e.g. {'count': {__gt: 0}}.
-     * - **__in** - Specified fragment must be equal to one of values in the list, e.g. {'status': {__in: ['AVAILABLE', 'UNAVAILABLE']}}.
-     * - **__not** - Negates condition, e.g. {__not: {'status': 'AVAILABLE'}}.
-     * - **__bygroupid** - True if filtered managed object is assigned to given group, e.g. {__bygroupid: 10300}.
-     * - **__has** - Specified fragment must have a value defined, e.g. {__has: 'c8y_IsDevice'}.
-     * - **__useFilterQueryString** - Gets rid of the '$filter=()… $orderby=…' parts of a query and keeps only what's between the most
+     * - **__and** - Specifies conditions, e.g. `{__and: [{__has: 'c8y_IsDevice'}, {'count': {__gt: 0}}]}`.
+     * - **__or** - Specifies alternative conditions, e.g. `{__or: [{__bygroupid: 10300}, {__bygroupid: 10400}]}`.
+     * - **__eq** - Specified fragment must be equal to given value, e.g. `{'status': 'AVAILABLE'}` (no nested object required).
+     * - **__lt** - Specified fragment must be less then given value, e.g. `{'count': {__lt: 10}}`.
+     * - **__gt** - Specified fragment must be greater then given value, e.g. `{'count': {__gt: 0}}`.
+     * - **__in** - Specified fragment must be equal to one of values in the list, e.g. `{'status': {__in: ['AVAILABLE', 'UNAVAILABLE']}}`.
+     * - **__not** - Negates condition, e.g. `{__not: {'status': 'AVAILABLE'}}`.
+     * - **__bygroupid** - True if filtered managed object is assigned to given group, e.g. `{__bygroupid: 10300}`.
+     * - **__has** - Specified fragment must have a value defined, e.g. `{__has: 'c8y_IsDevice'}`.
+     * - **__useFilterQueryString** - Gets rid of the `$filter=()… $orderby=…` parts of a query and keeps only what's between the most
      *                                exterior parentheses of the $filter.
      *                                EXAMPLE: takes a query of the form
-     *                                "$filter=(name eq 'RaspPi*') $orderby=name asc"
+     *                                `$filter=(name eq 'RaspPi*') $orderby=name asc`
      *                                and turns it into
-     *                                "name eq 'RaspPi*'"
+     *                                `name eq 'RaspPi*'`
      *                                This is necessary for searching for smart groups, which are identified by their own query
      *                                that needs to be passed through.
      *
      *
      * The order is specified by an array of field paths and sort direction (1 for ascending, -1 for descending), e.g.:
-     * - {__orderby: [{'creationTime': -1}, {'name': 1}], __filter: {...}}
+     * - `{__orderby: [{'creationTime': -1}, {'name': 1}], __filter: {...}}`
      *
      * @returns {string} Returns a query string ready to be sent in request params to backend.
      *
      * **Example**
-     * <pre>
+     * ```typescript
      *   const query = {
      *     __filter: {
      *       'name': 'My Device*',
@@ -75,7 +75,7 @@ export declare class QueriesUtil {
      *   const params = {
      *     query: queriesUtil.buildQuery(query)
      *   };
-     * </pre>
+     * ```
      */
     buildQuery(query: any): string;
     buildQueryFilter(queryFilter: any, _queryKey?: any, _glueType?: any): string;

package/lib/src/device-registration/DeviceRegistrationService.d.ts

@@ -8,7 +8,7 @@ import { IDeviceCredentials } from './IDeviceCredentials';
 export interface IDeviceBootstrapOptions {
     /**
      * If already logged in it is accessible via
-     * client.auth.getHeader, see [[BasicAuth.getHeader]]
+     * client.auth.getFetchOptions, see [[BasicAuth.getFetchOptions]]
      *
      * **Example**
      * ``` typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@c8y/client",
-  "version": "1017.45.0",
+  "version": "1017.47.0",
   "license": "Apache-2.0",
   "author": "Cumulocity",
   "description": "Client application programming interface to access the Cumulocity IoT-Platform REST services.",
@@ -9,8 +9,8 @@
     "build:cjs": "tsc -p .  --module commonjs --outDir lib/cjs",
     "build:esm2015": "tsc -p . --target es2015 --outDir lib/esm2015",
     "build:typings": "tsc -p . --emitDeclarationOnly true --declaration true --declarationDir lib",
-    "build:rollup": "rollup -c",
-    "docs": "typedoc ./src",
+    "build:rollup": "rollup -c --bundleConfigAsCjs",
+    "docs": "typedoc ./index.ts",
     "lint": "tslint --project tsconfig.json",
     "prepare": "rimraf lib && yarn build",
     "test:coverage": "jest --coverage",
@@ -46,19 +46,19 @@
     "isomorphic-cometd": "1.1.0"
   },
   "devDependencies": {
-    "@types/fs-extra": "5.0.1",
+    "@types/fs-extra": "11.0.1",
     "@types/jest": "^26.0.22",
-    "fs-extra": "5.0.0",
+    "fs-extra": "11.1.0",
     "ncp": "2.0.0",
     "rimraf": "2.6.2",
-    "rollup": "^0.57.1",
-    "rollup-plugin-commonjs": "9.2.2",
-    "rollup-plugin-node-resolve": "^3.3.0",
+    "rollup": "^3.12.0",
+    "rollup-plugin-commonjs": "10.1.0",
+    "rollup-plugin-node-resolve": "^5.2.0",
     "rollup-plugin-sourcemaps": "^0.6.3",
-    "rollup-plugin-uglify": "3.0.0",
+    "rollup-plugin-uglify": "6.0.4",
     "ts-jest": "^28.0.7",
     "tslint": "^5.9.1",
-    "typedoc": "0.11.1",
+    "typedoc": "0.23.24",
     "typescript": "4.7.4"
   }
 }

package/typedoc.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "name": "Cumulocity Web SDK",
+  "out": "./docs",
+  "exclude": ["**/*.spec.ts"],
+  "theme": "default",
+  "includeVersion": true,
+  "hideGenerator": true,
+  "excludeProtected": true,
+  "excludePrivate": true,
+  "excludeInternal": true,
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "commonjs",
+    "suppressExcessPropertyErrors": true,
+    "suppressImplicitAnyIndexErrors": true,
+  }
+}