@deviceinsight/ng-ui-api-client 10.36.0-SNAPSHOT

package/lib/esm/index.js

@@ -0,0 +1,43 @@
+export * from './src/aggregation';
+export * from './src/asset';
+export * from './src/authorities';
+export * from './src/assetDefinition';
+export * from './src/assetGroup';
+export * from './src/assetGroupHierarchies';
+export * from './src/assetGroupDefinition';
+export * from './src/blobox';
+export * from './src/configuration';
+export * from './src/datapoint';
+export * from './src/adxData';
+export * from './src/dataProcessingDefinition';
+export * from './src/kpi';
+export * from './src/event';
+export * from './src/locale';
+export * from './src/grantedAccess';
+export * from './src/namedquery';
+export * from './src/oauth';
+export * from './src/property';
+export * from './src/pagination';
+export * from './src/role';
+export * from './src/ruleDefinition';
+export * from './src/notificationTemplates';
+export * from './src/subscription';
+export * from './src/units';
+export * from './src/user';
+export * from './src/userGroup';
+export * from './src/licenses';
+export * from './src/version';
+export * from './src/remoteservice';
+export * from './src/preparedCommand';
+export * from './src/commands';
+export * from './src/authorizationServers';
+export * from './src/dryRun';
+export * from './src/shadowKeys';
+export * from './src/bundles';
+export * from './src/auditLog';
+export * from './src/powerBi';
+export * from './src/tsi';
+export * from './src/ux4iot';
+export * from './src/adx';
+export * from './src/initialAccountGroupAssignmentRules';
+export { getAxios, setAxios, setAxiosConfig } from './src/axios';

package/lib/esm/src/adx.d.ts

@@ -0,0 +1,22 @@
+import { DataType } from './datapoint';
+export declare type AdxValuesQueryResult = {
+    asset: {
+        urn: string;
+        datapoints: Array<{
+            name: string;
+            values: Array<[string, unknown]>;
+        }>;
+    };
+};
+/**
+ * @param assetUrn
+ * @param datapoints
+ * @param datatype
+ * @param tsFrom
+ * @param tsTo
+ * @param groupBy kusto timespan, i.e. 1d, 2h, 1.5m
+ * @param deduplication
+ */
+export declare function queryDatapointValues(assetUrn: string, datapoints: string[], datatype: DataType, tsFrom: number, tsTo: number, groupBy?: string | null, deduplication?: boolean | null): Promise<AdxValuesQueryResult>;
+export declare function queryLastDatapointsValue(assetUrn: string, datapoints: string[], datatype: DataType, tsFrom?: number, tsTo?: number): Promise<AdxValuesQueryResult>;
+//# sourceMappingURL=adx.d.ts.map

package/lib/esm/src/adx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adx.d.ts","sourceRoot":"","sources":["../../../src/adx.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAC;AAcrC,oBAAY,oBAAoB,GAAG;IAClC,KAAK,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,KAAK,CAAC;YACjB,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;SACjC,CAAC,CAAC;KACH,CAAC;CACF,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CACzC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAAE,EACpB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,EACvB,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,GAC5B,OAAO,CAAC,oBAAoB,CAAC,CAgB/B;AAED,wBAAsB,wBAAwB,CAC7C,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAAE,EACpB,QAAQ,EAAE,QAAQ,EAClB,MAAM,CAAC,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,oBAAoB,CAAC,CAgB/B"}

package/lib/esm/src/adx.js

@@ -0,0 +1,44 @@
+import { getAxios } from './axios';
+const DataTypeToAdxDatapointType = {
+    BOOLEAN: 'boolean',
+    DOUBLE: 'double',
+    LONG: 'long',
+    TEXT: 'string',
+    GEO_POSITION: 'geo_position',
+    STRUCTURED: 'structured'
+};
+/**
+ * @param assetUrn
+ * @param datapoints
+ * @param datatype
+ * @param tsFrom
+ * @param tsTo
+ * @param groupBy kusto timespan, i.e. 1d, 2h, 1.5m
+ * @param deduplication
+ */
+export async function queryDatapointValues(assetUrn, datapoints, datatype, tsFrom, tsTo, groupBy, deduplication) {
+    const queryParameters = {
+        datapoints,
+        datatype: DataTypeToAdxDatapointType[datatype],
+        tsFrom: new Date(tsFrom).toISOString(),
+        tsTo: new Date(tsTo).toISOString()
+    };
+    if (groupBy != null)
+        queryParameters.groupBy = groupBy;
+    if (deduplication != null)
+        queryParameters.deduplication = deduplication;
+    const response = await getAxios().post(`/v2/assets/${assetUrn}/datapointValues`, queryParameters);
+    return response.data;
+}
+export async function queryLastDatapointsValue(assetUrn, datapoints, datatype, tsFrom, tsTo) {
+    const queryParameters = {
+        datapoints,
+        datatype: DataTypeToAdxDatapointType[datatype]
+    };
+    if (tsFrom != null && tsTo != null) {
+        queryParameters.tsFrom = new Date(tsFrom).toISOString();
+        queryParameters.tsTo = new Date(tsTo).toISOString();
+    }
+    const response = await getAxios().post(`/v2/assets/${assetUrn}/datapointValues/latest`, queryParameters);
+    return response.data;
+}

package/lib/esm/src/adxData.d.ts

@@ -0,0 +1,57 @@
+import { DatapointValueGeoPositionType, DataType } from './datapoint';
+import { PaginationRequestAdxData, PaginationSettingsAdxData } from './pagination';
+export declare type StructuredDatapointsNodeDataType = 'string' | 'number' | 'array';
+export declare type PropertyNode = {
+    propertyPath: string;
+    datatypes: StructuredDatapointsNodeDataType[];
+};
+export declare type StructuredDatapointPropertyNodes = {
+    assetUrn: string;
+    datapointName: string;
+    propertyNodes: PropertyNode[];
+    resultLimitExceeded: boolean;
+};
+export declare type DistinctValuesResponse = {
+    assetUrn: string;
+    datapointName: string;
+    propertyPath: string;
+    distinctValues: number[] | string[] | boolean[];
+    resultLimitExceeded: boolean;
+};
+declare type Condition = {
+    propertyPath?: string;
+    operator: 'is' | 'larger_than' | 'larger_or_equal_than' | 'less_than' | 'less_or_equal_than' | 'contains' | 'exists';
+    value: string | number | boolean | number[] | string[] | boolean[];
+};
+export declare type AdxDistinctValuesDataType = 'double' | 'long' | 'boolean' | 'text' | 'geo_position' | 'structured';
+export declare const DataTypeToAdxDistinctDatapointType: Record<DataType, AdxDistinctValuesDataType>;
+declare type Filter = {
+    assetUrn: string;
+    datapointName: string;
+    datatype: AdxDistinctValuesDataType;
+    conditions: Condition[];
+};
+export declare type PaginationRequestPropertyAdxData = {
+    sort: string;
+    page: number;
+    size: number;
+};
+declare type DatapointValueContent = string | number | DatapointValueGeoPositionType | NestedDatapointValue;
+declare type NestedDatapointValue = Record<string, string | number>;
+declare type DatapointValue = {
+    timestamp: string;
+    assetUrn: string;
+    datapointName: string;
+    value: DatapointValueContent;
+};
+export declare type DatapointValuesResponse = {
+    content: DatapointValue[];
+    pagination: PaginationSettingsAdxData;
+    queryId: string;
+};
+export declare const getStructuredDatapointPropertyNodes: (assetUrn: string, datapointName: string, datatype: DataType, tsFrom: string, tsTo: string) => Promise<StructuredDatapointPropertyNodes>;
+export declare const getStructuredDatapointDistinctValues: (assetUrn: string, datapointName: string, datatype: DataType, tsFrom: string, tsTo: string, propertyPath?: string | undefined) => Promise<DistinctValuesResponse>;
+export declare const getDatapointValuesByFilters: (start: string, end: string, filters: Filter[], paginationSettings: PaginationRequestAdxData) => Promise<DatapointValuesResponse>;
+export declare const getDatapointValuesByQueryId: (paginationSettings: PaginationRequestAdxData, queryId: string) => Promise<DatapointValuesResponse>;
+export {};
+//# sourceMappingURL=adxData.d.ts.map

package/lib/esm/src/adxData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adxData.d.ts","sourceRoot":"","sources":["../../../src/adxData.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,6BAA6B,EAAE,QAAQ,EAAC,MAAM,aAAa,CAAC;AACpE,OAAO,EAAC,wBAAwB,EAAE,yBAAyB,EAAqC,MAAM,cAAc,CAAC;AAErH,oBAAY,gCAAgC,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE7E,oBAAY,YAAY,GAAG;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,gCAAgC,EAAE,CAAC;CAC9C,CAAC;AAEF,oBAAY,gCAAgC,GAAG;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,mBAAmB,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,oBAAY,sBAAsB,GAAG;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;IAChD,mBAAmB,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,aAAK,SAAS,GAAG;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,EACL,IAAI,GACJ,aAAa,GACb,sBAAsB,GACtB,WAAW,GACX,oBAAoB,GACpB,UAAU,GACV,QAAQ,CAAC;IACZ,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;CACnE,CAAC;AAEF,oBAAY,yBAAyB,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,cAAc,GAAG,YAAY,CAAC;AAE/G,eAAO,MAAM,kCAAkC,EAAE,MAAM,CAAC,QAAQ,EAAE,yBAAyB,CAO1F,CAAC;AAEF,aAAK,MAAM,GAAG;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,yBAAyB,CAAC;IACpC,UAAU,EAAE,SAAS,EAAE,CAAC;CACxB,CAAC;AAEF,oBAAY,gCAAgC,GAAG;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAUF,aAAK,qBAAqB,GAAG,MAAM,GAAG,MAAM,GAAG,6BAA6B,GAAG,oBAAoB,CAAC;AACpG,aAAK,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;AAE5D,aAAK,cAAc,GAAG;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,qBAAqB,CAAC;CAC7B,CAAC;AAEF,oBAAY,uBAAuB,GAAG;IACrC,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,UAAU,EAAE,yBAAyB,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,eAAO,MAAM,mCAAmC,aACrC,MAAM,iBACD,MAAM,YACX,QAAQ,UACV,MAAM,QACR,MAAM,KACV,QAAQ,gCAAgC,CAS1C,CAAC;AAEF,eAAO,MAAM,oCAAoC,aACtC,MAAM,iBACD,MAAM,YACX,QAAQ,UACV,MAAM,QACR,MAAM,wCAEV,QAAQ,sBAAsB,CAiBhC,CAAC;AAEF,eAAO,MAAM,2BAA2B,UAChC,MAAM,OACR,MAAM,WACF,MAAM,EAAE,sBACG,wBAAwB,KAC1C,QAAQ,uBAAuB,CAWjC,CAAC;AAEF,eAAO,MAAM,2BAA2B,uBACnB,wBAAwB,WACnC,MAAM,KACb,QAAQ,uBAAuB,CAGjC,CAAC"}

package/lib/esm/src/adxData.js

@@ -0,0 +1,64 @@
+import { extractData, getAxios } from './axios';
+import { paginationSettingsAdxToQueryParams } from './pagination';
+export const DataTypeToAdxDistinctDatapointType = {
+    BOOLEAN: 'boolean',
+    DOUBLE: 'double',
+    LONG: 'long',
+    TEXT: 'text',
+    GEO_POSITION: 'geo_position',
+    STRUCTURED: 'structured'
+};
+export const getStructuredDatapointPropertyNodes = (assetUrn, datapointName, datatype, tsFrom, tsTo) => {
+    const queryParameters = {
+        datatype: DataTypeToAdxDistinctDatapointType[datatype],
+        start: tsFrom,
+        end: tsTo
+    };
+    return getAxios()
+        .get(`/v2/assets/${assetUrn}/datapoints/${datapointName}/propertyNodes`, { params: queryParameters })
+        .then(extractData);
+};
+export const getStructuredDatapointDistinctValues = (assetUrn, datapointName, datatype, tsFrom, tsTo, propertyPath // Optional because it's not needed for primitive datapoints
+) => {
+    const queryParameters = {
+        datatype: DataTypeToAdxDistinctDatapointType[datatype],
+        start: tsFrom,
+        end: tsTo,
+        propertyPath: propertyPath || ''
+    };
+    if (propertyPath) {
+        queryParameters.propertyPath = propertyPath;
+    }
+    return getAxios()
+        .get(`/v2/assets/${assetUrn}/datapoints/${datapointName}/distinctValues`, {
+        params: queryParameters
+    })
+        .then(extractData);
+};
+export const getDatapointValuesByFilters = (start, end, filters, paginationSettings) => {
+    const requestPayload = {
+        interval: {
+            start,
+            end
+        },
+        filters
+    };
+    const queryString = buildDatapointValuesQueryString(paginationSettings);
+    return getAxios().post(`/v2/assets/datapointValues${queryString}`, requestPayload).then(extractData);
+};
+export const getDatapointValuesByQueryId = (paginationSettings, queryId) => {
+    const queryString = buildDatapointValuesQueryString(paginationSettings);
+    return getAxios().get(`/v2/assets/datapointValues/${queryId}${queryString}`).then(extractData);
+};
+const buildDatapointValuesQueryString = (paginationSettings) => {
+    const queryParams = paginationSettingsAdxToQueryParams(paginationSettings);
+    let params = {};
+    if (queryParams !== undefined) {
+        params = {
+            page: queryParams.page.toString(),
+            size: queryParams.size.toString(),
+            sort: queryParams.sort
+        };
+    }
+    return Object.keys(params).length > 0 ? `?${new URLSearchParams(params).toString()}` : '';
+};

package/lib/esm/src/aggregation.d.ts

@@ -0,0 +1,38 @@
+declare type AggregationGrouping = {
+    field: string;
+    size?: number;
+    numberInterval?: number;
+    dateInterval?: string;
+    precision?: number;
+    minDocCount?: number;
+};
+declare type AggregationSorting = {
+    columnName: string;
+    order: 'asc' | 'desc';
+};
+export declare type MetricFunction = 'avg' | 'cardinality' | 'max' | 'min' | 'sum' | 'count' | 'stats' | 'percentile' | 'percentileRanks';
+declare type AggregationMetric = {
+    function: MetricFunction;
+    field: string;
+    columnName: string;
+};
+export declare type AggregationConfig = {
+    query: string;
+    aggregationGrouping: AggregationGrouping[];
+    aggregationMetrics: AggregationMetric[];
+    aggregationSorting: AggregationSorting;
+};
+declare type Column = {
+    columnName: string;
+    datatype: string;
+};
+declare type Row = Record<string, any>;
+export declare type AggregationResult = {
+    groupingColumns: Column[];
+    metricColumns: Column[];
+    totalHits: number;
+    rows: Row;
+};
+export declare const fetchAggregation: (aggregationConfig: AggregationConfig) => Promise<any>;
+export {};
+//# sourceMappingURL=aggregation.d.ts.map

package/lib/esm/src/aggregation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregation.d.ts","sourceRoot":"","sources":["../../../src/aggregation.ts"],"names":[],"mappings":"AAEA,aAAK,mBAAmB,GAAG;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,aAAK,kBAAkB,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC;CACtB,CAAC;AAEF,oBAAY,cAAc,GACvB,KAAK,GACL,aAAa,GACb,KAAK,GACL,KAAK,GACL,KAAK,GACL,OAAO,GACP,OAAO,GACP,YAAY,GACZ,iBAAiB,CAAC;AAErB,aAAK,iBAAiB,GAAG;IACxB,QAAQ,EAAE,cAAc,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,oBAAY,iBAAiB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB,EAAE,mBAAmB,EAAE,CAAC;IAC3C,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;IACxC,kBAAkB,EAAE,kBAAkB,CAAC;CACvC,CAAC;AAEF,aAAK,MAAM,GAAG;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,aAAK,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE/B,oBAAY,iBAAiB,GAAG;IAC/B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,GAAG,CAAC;CACV,CAAC;AAEF,eAAO,MAAM,gBAAgB,sBAAuB,iBAAiB,KAAG,QAAQ,GAAG,CACJ,CAAC"}

package/lib/esm/src/aggregation.js

@@ -0,0 +1,2 @@
+import { extractData, getAxios } from './axios';
+export const fetchAggregation = (aggregationConfig) => getAxios().post('/v2/assets/aggregation', aggregationConfig).then(extractData);

package/lib/esm/src/asset.d.ts

@@ -0,0 +1,90 @@
+import { Pageable, PaginationSettings } from './pagination';
+import { PropertyValues } from './property';
+export declare type GatewayTransportChannel = 'JUMP' | 'IOTHUB';
+export declare type AssetNew = {
+    assetDefinitionId: number | null | undefined;
+    name: string;
+    urn: string;
+    gatewayId: number | null | undefined;
+    properties: PropertyValues;
+    shadow?: PropertyValues;
+    isGateway: boolean;
+    transportChannel?: GatewayTransportChannel;
+    assetGroupIds: Array<number>;
+    ancestorAssetGroupIds: Array<number>;
+    certificateBootstrapping?: boolean;
+    timeZone?: string;
+};
+export declare type Asset = AssetNew & {
+    id: number;
+};
+export declare type Gateway = Asset & {
+    isGateway: true;
+    gatewayId: null;
+};
+export declare type CertificateDetails = {
+    content: string;
+    createdAt: number;
+    revokedAt: number;
+    lastUsedAt: number;
+};
+export declare type GeoDistanceParams = {
+    distance: string;
+    geoField: string;
+    pinLocation: string;
+};
+export declare type GeoBoundingBoxParams = {
+    geoField: string;
+    topLeft: string;
+    bottomRight: string;
+};
+export declare const fetchAssetWithShadowById: (id: number) => Promise<Asset>;
+export declare const fetchGatewayById: (id: number) => Promise<Gateway>;
+export declare const fetchAssetByUrn: (urn: string) => Promise<Asset>;
+export declare type FetchAssetsParams = {
+    id?: number;
+    name?: string;
+    urn?: string;
+    assetType?: 'ASSET' | 'GATEWAY';
+    assetGroup?: number;
+    assignedToAnyAssetGroup?: boolean;
+    gatewayId?: number;
+    gatewayUrn?: string;
+    ruleId?: number;
+    assetGroupRuleId?: number;
+    processingDefinitionId?: number;
+    assetGroupProcessingDefinitionId?: number;
+    shadow?: boolean;
+};
+export declare const fetchAssets: (queryParams?: FetchAssetsParams | undefined, paginationSettings?: PaginationSettings | undefined) => Promise<Pageable<Asset>>;
+export declare const fetchAssetsByUrn: (urn: string | string[]) => Promise<Array<Asset>>;
+export declare const fetchAssetsByAssetGroupId: (assetGroupId: number, shadow?: boolean | undefined, paginationSettings?: PaginationSettings | undefined) => Promise<Pageable<Asset>>;
+export declare const fetchAssetsByRuleId: (ruleId: number) => Promise<Array<Asset>>;
+export declare const fetchAssetsByDataProcessingDefinitionId: (dataProcessingDefinitionId: number) => Promise<Array<Asset>>;
+export declare const createAsset: (asset: AssetNew) => Promise<Asset>;
+export declare const updateAsset: (asset: Asset) => Promise<Asset>;
+export declare const deleteAsset: (id: number) => Promise<any>;
+export declare const searchAssets: (query: string, paginationSettings?: PaginationSettings | undefined) => Promise<Pageable<Asset>>;
+export declare const searchAssetsWithOpenEvents: (query: string, paginationSettings?: PaginationSettings | undefined) => Promise<Pageable<Asset>>;
+export declare const searchAssetsByProperty: (property: string, value: string | number, paginationSettings?: PaginationSettings | undefined) => Promise<Pageable<Asset>>;
+export declare const searchGateways: (query: string, paginationSettings: PaginationSettings) => Promise<Pageable<Gateway>>;
+export declare const searchAssetsWithGeoDistance: (query: string, paginationSettings: PaginationSettings, geoDistanceParams: GeoDistanceParams) => Promise<Pageable<Asset>>;
+export declare const searchAssetsByGeoBoundingBox: (query: string, paginationSettings: PaginationSettings, { geoField, topLeft, bottomRight }: GeoBoundingBoxParams) => Promise<Pageable<Asset>>;
+export declare const fetchAssetGroupIds: (assetId: number) => Promise<Array<number>>;
+export declare const assignAssetGroup: (assetId: number, assetGroupId: number) => Promise<any>;
+export declare const unassignAssetGroup: (assetId: number, assetGroupId: number) => Promise<any>;
+export declare const updateAssetGroupIds: (assetId: number, assetGroupIds: Array<number>) => Promise<any>;
+export declare const assignGateway: (assetId: number, gatewayId: number) => Promise<any>;
+export declare const unassignGateway: (assetId: number) => Promise<any>;
+export declare const getGatewayConfigurationsSyncStatus: (assetId: number) => Promise<any>;
+export declare const triggerGatewayConfigurationsSync: (assetId: number) => Promise<any>;
+export declare const retrieveAssetBootstrapJson: (assetUrn: string) => Promise<any>;
+export declare const retrieveAssetBootstrapShellCommand: (assetUrn: string) => Promise<any>;
+export declare const getGatewayCertificateSummary: (assetUrn: string) => Promise<any>;
+export declare const getCertificateDetails: (assetUrn: string, fingerPrint: string) => Promise<CertificateDetails>;
+export declare const revokeGatewayCertificate: (assetUrn: string, fingerprint: string) => Promise<any>;
+export declare const revokeAllGatewayCertificates: (assetUrn: string) => Promise<any>;
+export declare const fetchGatewayCommandResponses: (gatewayId: number, commandId: number) => Promise<Array<any>>;
+export declare const requestApplicationLogCommand: (gatewayId: number) => Promise<any>;
+export declare const fetchGatewayCapabilities: (gatewayId: number) => Promise<Array<string>>;
+//# sourceMappingURL=asset.d.ts.map

package/lib/esm/src/asset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../../src/asset.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,QAAQ,EAAE,kBAAkB,EAAkC,MAAM,cAAc,CAAC;AAC3F,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAC;AAG1C,oBAAY,uBAAuB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAExD,oBAAY,QAAQ,GAAG;IACtB,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC,UAAU,EAAE,cAAc,CAAC;IAC3B,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IAC3C,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,qBAAqB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,oBAAY,KAAK,GAAG,QAAQ,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAC;CACX,CAAC;AAEF,oBAAY,OAAO,GAAG,KAAK,GAAG;IAC7B,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,oBAAY,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,oBAAY,oBAAoB,GAAG;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,eAAO,MAAM,wBAAwB,OAAQ,MAAM,KAAG,QAAQ,KAAK,CAElE,CAAC;AAEF,eAAO,MAAM,gBAAgB,OAAQ,MAAM,KAAG,QAAQ,OAAO,CAE5D,CAAC;AAEF,eAAO,MAAM,eAAe,QAAS,MAAM,KAAG,QAAQ,KAAK,CAI1D,CAAC;AAEF,oBAAY,iBAAiB,GAAG;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAC1C,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,WAAW,wGAGrB,QAAQ,SAAS,KAAK,CAAC,CAIzB,CAAC;AAEF,eAAO,MAAM,gBAAgB,QAAS,MAAM,GAAG,MAAM,EAAE,KAAG,QAAQ,MAAM,KAAK,CAAC,CAE7E,CAAC;AAEF,eAAO,MAAM,yBAAyB,iBACvB,MAAM,wFAGlB,QAAQ,SAAS,KAAK,CAAC,CAEzB,CAAC;AAEF,eAAO,MAAM,mBAAmB,WAAY,MAAM,KAAG,QAAQ,MAAM,KAAK,CAAC,CAExE,CAAC;AAEF,eAAO,MAAM,uCAAuC,+BAAgC,MAAM,KAAG,QAAQ,MAAM,KAAK,CAAC,CAEhH,CAAC;AAEF,eAAO,MAAM,WAAW,UAAW,QAAQ,KAAG,QAAQ,KAAK,CAM1D,CAAC;AAEF,eAAO,MAAM,WAAW,UAAW,KAAK,KAAG,QAAQ,KAAK,CAQvD,CAAC;AAEF,eAAO,MAAM,WAAW,OAAQ,MAAM,KAAG,QAAQ,GAAG,CAEnD,CAAC;AAEF,eAAO,MAAM,YAAY,UAAW,MAAM,0DAA4C,QAAQ,SAAS,KAAK,CAAC,CAoB5G,CAAC;AAEF,eAAO,MAAM,0BAA0B,UAC/B,MAAM,0DAEX,QAAQ,SAAS,KAAK,CAAC,CAqBzB,CAAC;AAEF,eAAO,MAAM,sBAAsB,aACxB,MAAM,SACT,MAAM,GAAG,MAAM,0DAEpB,QAAQ,SAAS,KAAK,CAAC,CAmBzB,CAAC;AAEF,eAAO,MAAM,cAAc,UAAW,MAAM,sBAAsB,kBAAkB,KAAG,QAAQ,SAAS,OAAO,CAAC,CAE/G,CAAC;AAEF,eAAO,MAAM,2BAA2B,UAChC,MAAM,sBACO,kBAAkB,qBACnB,iBAAiB,KAClC,QAAQ,SAAS,KAAK,CAAC,CA2BzB,CAAC;AAEF,eAAO,MAAM,4BAA4B,UACjC,MAAM,sBACO,kBAAkB,sCACJ,oBAAoB,KACpD,QAAQ,SAAS,KAAK,CAAC,CA0BzB,CAAC;AAEF,eAAO,MAAM,kBAAkB,YAAa,MAAM,KAAG,QAAQ,MAAM,MAAM,CAAC,CAEzE,CAAC;AAEF,eAAO,MAAM,gBAAgB,YAAa,MAAM,gBAAgB,MAAM,KAAG,QAAQ,GAAG,CAEnF,CAAC;AAEF,eAAO,MAAM,kBAAkB,YAAa,MAAM,gBAAgB,MAAM,KAAG,QAAQ,GAAG,CAErF,CAAC;AAEF,eAAO,MAAM,mBAAmB,YAAmB,MAAM,iBAAiB,MAAM,MAAM,CAAC,KAAG,QAAQ,GAAG,CAYpG,CAAC;AAEF,eAAO,MAAM,aAAa,YAAa,MAAM,aAAa,MAAM,KAAG,QAAQ,GAAG,CAI7E,CAAC;AAEF,eAAO,MAAM,eAAe,YAAa,MAAM,KAAG,QAAQ,GAAG,CAE5D,CAAC;AAEF,eAAO,MAAM,kCAAkC,YAAa,MAAM,KAAG,QAAQ,GAAG,CAE/E,CAAC;AAEF,eAAO,MAAM,gCAAgC,YAAa,MAAM,KAAG,QAAQ,GAAG,CAE7E,CAAC;AAEF,eAAO,MAAM,0BAA0B,aAAc,MAAM,KAAG,QAAQ,GAAG,CAExE,CAAC;AAEF,eAAO,MAAM,kCAAkC,aAAc,MAAM,KAAG,QAAQ,GAAG,CAYhF,CAAC;AAEF,eAAO,MAAM,4BAA4B,aAAc,MAAM,KAAG,QAAQ,GAAG,CAI1E,CAAC;AAEF,eAAO,MAAM,qBAAqB,aAAc,MAAM,eAAe,MAAM,KAAG,QAAQ,kBAAkB,CAIvG,CAAC;AAEF,eAAO,MAAM,wBAAwB,aAAc,MAAM,eAAe,MAAM,KAAG,QAAQ,GAAG,CAE3F,CAAC;AAEF,eAAO,MAAM,4BAA4B,aAAc,MAAM,KAAG,QAAQ,GAAG,CAE1E,CAAC;AAEF,eAAO,MAAM,4BAA4B,cAAe,MAAM,aAAa,MAAM,KAAG,QAAQ,MAAM,GAAG,CAAC,CAErG,CAAC;AAEF,eAAO,MAAM,4BAA4B,cAAe,MAAM,KAAG,QAAQ,GAAG,CAa3E,CAAC;AAEF,eAAO,MAAM,wBAAwB,cAAe,MAAM,KAAG,QAAQ,MAAM,MAAM,CAAC,CAEjF,CAAC"}

package/lib/esm/src/asset.js

@@ -0,0 +1,245 @@
+import { extractData, getAxios } from './axios';
+import { paginationSettingsToQueryParams } from './pagination';
+import { fetchAssetGroupsById } from './assetGroup';
+export const fetchAssetWithShadowById = (id) => {
+    return getAxios().get(`/v2/assets/${id}/shadow`).then(extractData);
+};
+export const fetchGatewayById = (id) => {
+    return getAxios().get(`/v2/gateways/${id}`).then(extractData);
+};
+export const fetchAssetByUrn = (urn) => {
+    return getAxios()
+        .get(`/v2/assets/urn/${encodeURIComponent(urn)}`)
+        .then(extractData);
+};
+export const fetchAssets = (queryParams, paginationSettings) => {
+    return getAxios()
+        .get('/v2/assets', { params: { ...queryParams, ...paginationSettingsToQueryParams(paginationSettings) } })
+        .then(extractData);
+};
+export const fetchAssetsByUrn = (urn) => {
+    return getAxios().get('/v2/assets', { params: { urn } }).then(extractData);
+};
+export const fetchAssetsByAssetGroupId = (assetGroupId, shadow, paginationSettings) => {
+    return fetchAssets({ assetGroup: assetGroupId, shadow }, paginationSettings);
+};
+export const fetchAssetsByRuleId = (ruleId) => {
+    return fetchAssets({ ruleId }).then(({ content }) => content);
+};
+export const fetchAssetsByDataProcessingDefinitionId = (dataProcessingDefinitionId) => {
+    return fetchAssets({ processingDefinitionId: dataProcessingDefinitionId }).then(({ content }) => content);
+};
+export const createAsset = (asset) => {
+    if (asset.isGateway) {
+        return getAxios().post(`/v2/gateways`, asset).then(extractData);
+    }
+    else {
+        return getAxios().post(`/v2/assets`, asset).then(extractData);
+    }
+};
+export const updateAsset = (asset) => {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const { assetGroupIds, ...formData } = asset;
+    if (asset.isGateway) {
+        return getAxios().put(`/v2/gateways/${asset.id}`, formData).then(extractData);
+    }
+    else {
+        return getAxios().put(`/v2/assets/${asset.id}`, formData).then(extractData);
+    }
+};
+export const deleteAsset = (id) => {
+    return getAxios().delete(`/v2/assets/${id}`);
+};
+export const searchAssets = (query, paginationSettings) => {
+    const settings = paginationSettings || {
+        page: 0,
+        size: 1000,
+        sort: null
+    };
+    const { page, size, sort } = settings;
+    return getAxios()
+        .post(`/v2/assets/search`, query || '*:*', {
+        params: {
+            page,
+            size,
+            sort: (sort && `${sort.property},${sort.direction}`) || '',
+            ignoreCase: true
+        },
+        headers: {
+            'Content-Type': 'text/plain'
+        }
+    })
+        .then(extractData);
+};
+export const searchAssetsWithOpenEvents = (query, paginationSettings) => {
+    const settings = paginationSettings || {
+        page: 0,
+        size: 1000,
+        sort: null
+    };
+    const { page, size, sort } = settings;
+    return getAxios()
+        .post(`/v2/assets/search`, query || '*:*', {
+        params: {
+            page,
+            size,
+            sort: (sort && `${sort.property},${sort.direction}`) || '',
+            ignoreCase: true,
+            assetsWithEventsOnly: true
+        },
+        headers: {
+            'Content-Type': 'text/plain'
+        }
+    })
+        .then(extractData);
+};
+export const searchAssetsByProperty = (property, value, paginationSettings) => {
+    const settings = paginationSettings || {
+        page: 0,
+        size: 1000,
+        sort: null
+    };
+    const { page, size, sort } = settings;
+    return getAxios()
+        .get(`/v2/assets/search`, {
+        params: {
+            property,
+            value,
+            page,
+            size,
+            sort: (sort && `${sort.property},${sort.direction}`) || '',
+            ignoreCase: true
+        }
+    })
+        .then(extractData);
+};
+export const searchGateways = (query, paginationSettings) => {
+    return searchAssets(`${query} isGateway:true`, paginationSettings);
+};
+export const searchAssetsWithGeoDistance = (query, paginationSettings, geoDistanceParams) => {
+    const settings = paginationSettings || {
+        page: 0,
+        size: 1000,
+        sort: ''
+    };
+    const { page, size, sort } = settings;
+    const { distance, geoField, pinLocation } = geoDistanceParams;
+    return getAxios()
+        .post(`/v2/assets/geoDistance`, {
+        distance,
+        geoField,
+        pinLocation,
+        query: query || '*:*'
+    }, {
+        params: {
+            ignoreCase: true,
+            page,
+            size,
+            sort: (sort && `${sort.property},${sort.direction}`) || ''
+        }
+    })
+        .then(extractData);
+};
+export const searchAssetsByGeoBoundingBox = (query, paginationSettings, { geoField, topLeft, bottomRight }) => {
+    const settings = paginationSettings || {
+        page: 0,
+        size: 1000,
+        sort: ''
+    };
+    const { page, size, sort } = settings;
+    return getAxios()
+        .post(`/v2/assets/geoBoundingBox`, {
+        geoField,
+        query: query || '*:*',
+        topLeft,
+        bottomRight
+    }, {
+        params: {
+            ignoreCase: true,
+            page,
+            size,
+            sort: sort ? `${sort.property},${sort.direction}` : ''
+        }
+    })
+        .then(extractData);
+};
+export const fetchAssetGroupIds = (assetId) => {
+    return getAxios().get(`/v2/assets/${assetId}/groups`).then(extractData);
+};
+export const assignAssetGroup = (assetId, assetGroupId) => {
+    return getAxios().put(`/v2/assets/${assetId}/groups/${assetGroupId}`);
+};
+export const unassignAssetGroup = (assetId, assetGroupId) => {
+    return getAxios().delete(`/v2/assets/${assetId}/groups/${assetGroupId}`);
+};
+export const updateAssetGroupIds = async (assetId, assetGroupIds) => {
+    const oldAssetGroupIds = await fetchAssetGroupIds(assetId);
+    let availableOldAssetGroupIds = [];
+    if (oldAssetGroupIds.length > 0) {
+        availableOldAssetGroupIds = (await fetchAssetGroupsById(oldAssetGroupIds)).map(({ id }) => id);
+    }
+    const addedAssetGroupIds = assetGroupIds.filter((id) => !oldAssetGroupIds.includes(id));
+    const removedAssetGroupIds = availableOldAssetGroupIds.filter((id) => assetGroupIds && !assetGroupIds.includes(id));
+    return Promise.all([
+        ...addedAssetGroupIds.map((assetGroupId) => assignAssetGroup(assetId, assetGroupId)),
+        ...removedAssetGroupIds.map((assetGroupId) => unassignAssetGroup(assetId, assetGroupId))
+    ]);
+};
+export const assignGateway = (assetId, gatewayId) => {
+    return getAxios().put(`/v2/assets/${assetId}/gatewayAssignment`, {
+        gatewayId
+    });
+};
+export const unassignGateway = (assetId) => {
+    return getAxios().delete(`/v2/assets/${assetId}/gatewayAssignment`);
+};
+export const getGatewayConfigurationsSyncStatus = (assetId) => {
+    return getAxios().get(`/v2/gateways/${assetId}/configurationSyncStatus`).then(extractData);
+};
+export const triggerGatewayConfigurationsSync = (assetId) => {
+    return getAxios().post(`/v2/gateways/${assetId}/configurationSync`);
+};
+export const retrieveAssetBootstrapJson = (assetUrn) => {
+    return getAxios().post(`/beta/gateways/urn/${encodeURIComponent(assetUrn)}/bootstrap.json`);
+};
+export const retrieveAssetBootstrapShellCommand = (assetUrn) => {
+    return getAxios()
+        .post(`/beta/gateways/urn/${encodeURIComponent(assetUrn)}/bootstrapCommandLine`, {}, {
+        headers: {
+            Accept: 'text/plain'
+        }
+    })
+        .then(extractData);
+};
+export const getGatewayCertificateSummary = (assetUrn) => {
+    return getAxios()
+        .get(`/v2/gateways/urn/${encodeURIComponent(assetUrn)}/certificates`)
+        .then(extractData);
+};
+export const getCertificateDetails = (assetUrn, fingerPrint) => {
+    return getAxios()
+        .get(`/v2/gateways/urn/${encodeURIComponent(assetUrn)}/certificates/${fingerPrint}`)
+        .then(extractData);
+};
+export const revokeGatewayCertificate = (assetUrn, fingerprint) => {
+    return getAxios().put(`/v2/gateways/urn/${encodeURIComponent(assetUrn)}/certificates/${fingerprint}/revocation`);
+};
+export const revokeAllGatewayCertificates = (assetUrn) => {
+    return getAxios().put(`/v2/gateways/urn/${encodeURIComponent(assetUrn)}/certificates/revocation`);
+};
+export const fetchGatewayCommandResponses = (gatewayId, commandId) => {
+    return getAxios().get(`/v2/gateways/${gatewayId}/commands/${commandId}/responses`).then(extractData);
+};
+export const requestApplicationLogCommand = (gatewayId) => {
+    return getAxios()
+        .post(`/v2/gateways/${gatewayId}/commands`, {
+        expirySeconds: 60,
+        content: {
+            type: 'transmitApplicationLogCommand'
+        }
+    }, {})
+        .then(extractData);
+};
+export const fetchGatewayCapabilities = (gatewayId) => {
+    return getAxios().get(`/v2/gateways/${gatewayId}/capabilities`).then(extractData);
+};

package/lib/esm/src/assetDefinition.d.ts

@@ -0,0 +1,28 @@
+import { Datapoint } from './datapoint';
+export declare type AssetDefinitionProperty = {
+    key: string;
+    required: boolean;
+};
+export declare type AssetDefinitionStaticProperty = {
+    key: string;
+    value: string | number | boolean | null | undefined;
+};
+export declare type AssetDefinitionNew = {
+    name: string;
+    properties: AssetDefinitionProperty[];
+    staticProperties: AssetDefinitionStaticProperty[];
+    datapoints: Datapoint[];
+};
+export declare type AssetDefinition = AssetDefinitionNew & {
+    id: number;
+};
+export declare function fetchAssetDefinitions(): Promise<Array<AssetDefinition>>;
+export declare function fetchAssetDefinition(id: number): Promise<AssetDefinition>;
+export declare function deleteAssetDefinition(id: number): Promise<void>;
+export declare function updateAssetDefinition(assetDefinition: AssetDefinition): Promise<AssetDefinition>;
+export declare function createAssetDefinition(assetDefinition: AssetDefinitionNew): Promise<AssetDefinition>;
+export declare function createAssetDefinitionDatapoint(assetDefinitionId: number, datapoint: Datapoint): Promise<void>;
+export declare function createAssetDefinitionDatapoints(assetDefinitionId: number, datapoints: Map<string, Datapoint>): Promise<void>;
+export declare function deleteAssetDefinitionDatapoint(assetDefinitionId: number, datapointName: string): Promise<void>;
+export declare function updateAssetDefinitionDatapoint(assetDefinitionId: number, datapoint: Datapoint): Promise<void>;
+//# sourceMappingURL=assetDefinition.d.ts.map