205 lines
7.4 KiB
TypeScript

///
/// Copyright © 2016-2024 The Thingsboard Authors
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
/// http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
import { BaseData } from '@shared/models/base-data';
import { TenantId } from '@shared/models/id/tenant-id';
import { CustomerId } from '@shared/models/id/customer-id';
import { EdgeId } from '@shared/models/id/edge-id';
import { EntitySearchQuery } from '@shared/models/relation.models';
import { RuleChainId } from '@shared/models/id/rule-chain-id';
import { BaseEventBody } from '@shared/models/event.models';
import { EventId } from '@shared/models/id/event-id';
import { HasTenantId } from '@shared/models/entity.models';
export interface Edge extends BaseData<EdgeId>, HasTenantId {
tenantId?: TenantId;
customerId?: CustomerId;
name: string;
type: string;
secret: string;
routingKey: string;
label?: string;
additionalInfo?: any;
rootRuleChainId?: RuleChainId;
}
export interface EdgeInfo extends Edge {
customerTitle: string;
customerIsPublic: boolean;
}
export interface EdgeSearchQuery extends EntitySearchQuery {
edgeTypes: Array<string>;
}
export enum EdgeEventType {
DASHBOARD = 'DASHBOARD',
ASSET = 'ASSET',
DEVICE = 'DEVICE',
DEVICE_PROFILE = 'DEVICE_PROFILE',
ASSET_PROFILE = 'ASSET_PROFILE',
ENTITY_VIEW = 'ENTITY_VIEW',
ALARM = 'ALARM',
RULE_CHAIN = 'RULE_CHAIN',
RULE_CHAIN_METADATA = 'RULE_CHAIN_METADATA',
EDGE = 'EDGE',
USER = 'USER',
CUSTOMER = 'CUSTOMER',
RELATION = 'RELATION',
TENANT = 'TENANT',
TENANT_PROFILE = 'TENANT_PROFILE',
WIDGETS_BUNDLE = 'WIDGETS_BUNDLE',
WIDGET_TYPE = 'WIDGET_TYPE',
ADMIN_SETTINGS = 'ADMIN_SETTINGS',
OTA_PACKAGE = 'OTA_PACKAGE',
QUEUE = 'QUEUE'
}
export enum EdgeEventActionType {
ADDED = 'ADDED',
DELETED = 'DELETED',
UPDATED = 'UPDATED',
POST_ATTRIBUTES = 'POST_ATTRIBUTES',
ATTRIBUTES_UPDATED = 'ATTRIBUTES_UPDATED',
ATTRIBUTES_DELETED = 'ATTRIBUTES_DELETED',
TIMESERIES_UPDATED = 'TIMESERIES_UPDATED',
CREDENTIALS_UPDATED = 'CREDENTIALS_UPDATED',
ASSIGNED_TO_CUSTOMER = 'ASSIGNED_TO_CUSTOMER',
UNASSIGNED_FROM_CUSTOMER = 'UNASSIGNED_FROM_CUSTOMER',
RELATION_ADD_OR_UPDATE = 'RELATION_ADD_OR_UPDATE',
RELATION_DELETED = 'RELATION_DELETED',
RPC_CALL = 'RPC_CALL',
ALARM_ACK = 'ALARM_ACK',
ALARM_CLEAR = 'ALARM_CLEAR',
ALARM_ASSIGNED = 'ALARM_ASSIGNED',
ALARM_UNASSIGNED = 'ALARM_UNASSIGNED',
ASSIGNED_TO_EDGE = 'ASSIGNED_TO_EDGE',
UNASSIGNED_FROM_EDGE = 'UNASSIGNED_FROM_EDGE',
CREDENTIALS_REQUEST = 'CREDENTIALS_REQUEST',
ENTITY_MERGE_REQUEST = 'ENTITY_MERGE_REQUEST'
}
export enum EdgeEventStatus {
DEPLOYED = 'DEPLOYED',
PENDING = 'PENDING'
}
export const edgeEventTypeTranslations = new Map<EdgeEventType, string>(
[
[EdgeEventType.DASHBOARD, 'edge-event.type-dashboard'],
[EdgeEventType.ASSET, 'edge-event.type-asset'],
[EdgeEventType.DEVICE, 'edge-event.type-device'],
[EdgeEventType.DEVICE_PROFILE, 'edge-event.type-device-profile'],
[EdgeEventType.ASSET_PROFILE, 'edge-event.type-asset-profile'],
[EdgeEventType.ENTITY_VIEW, 'edge-event.type-entity-view'],
[EdgeEventType.ALARM, 'edge-event.type-alarm'],
[EdgeEventType.RULE_CHAIN, 'edge-event.type-rule-chain'],
[EdgeEventType.RULE_CHAIN_METADATA, 'edge-event.type-rule-chain-metadata'],
[EdgeEventType.EDGE, 'edge-event.type-edge'],
[EdgeEventType.USER, 'edge-event.type-user'],
[EdgeEventType.CUSTOMER, 'edge-event.type-customer'],
[EdgeEventType.RELATION, 'edge-event.type-relation'],
[EdgeEventType.TENANT, 'edge-event.type-tenant'],
[EdgeEventType.TENANT_PROFILE, 'edge-event.type-tenant-profile'],
[EdgeEventType.WIDGETS_BUNDLE, 'edge-event.type-widgets-bundle'],
[EdgeEventType.WIDGET_TYPE, 'edge-event.type-widgets-type'],
[EdgeEventType.ADMIN_SETTINGS, 'edge-event.type-admin-settings'],
[EdgeEventType.OTA_PACKAGE, 'edge-event.type-ota-package'],
[EdgeEventType.QUEUE, 'edge-event.type-queue']
]
);
export const edgeEventActionTypeTranslations = new Map<EdgeEventActionType, string>(
[
[EdgeEventActionType.ADDED, 'edge-event.action-type-added'],
[EdgeEventActionType.DELETED, 'edge-event.action-type-deleted'],
[EdgeEventActionType.UPDATED, 'edge-event.action-type-updated'],
[EdgeEventActionType.POST_ATTRIBUTES, 'edge-event.action-type-post-attributes'],
[EdgeEventActionType.ATTRIBUTES_UPDATED, 'edge-event.action-type-attributes-updated'],
[EdgeEventActionType.ATTRIBUTES_DELETED, 'edge-event.action-type-attributes-deleted'],
[EdgeEventActionType.TIMESERIES_UPDATED, 'edge-event.action-type-timeseries-updated'],
[EdgeEventActionType.CREDENTIALS_UPDATED, 'edge-event.action-type-credentials-updated'],
[EdgeEventActionType.ASSIGNED_TO_CUSTOMER, 'edge-event.action-type-assigned-to-customer'],
[EdgeEventActionType.UNASSIGNED_FROM_CUSTOMER, 'edge-event.action-type-unassigned-from-customer'],
[EdgeEventActionType.RELATION_ADD_OR_UPDATE, 'edge-event.action-type-relation-add-or-update'],
[EdgeEventActionType.RELATION_DELETED, 'edge-event.action-type-relation-deleted'],
[EdgeEventActionType.RPC_CALL, 'edge-event.action-type-rpc-call'],
[EdgeEventActionType.ALARM_ACK, 'edge-event.action-type-alarm-ack'],
[EdgeEventActionType.ALARM_CLEAR, 'edge-event.action-type-alarm-clear'],
[EdgeEventActionType.ALARM_ASSIGNED, 'edge-event.action-type-alarm-assigned'],
[EdgeEventActionType.ALARM_UNASSIGNED, 'edge-event.action-type-alarm-unassigned'],
[EdgeEventActionType.ASSIGNED_TO_EDGE, 'edge-event.action-type-assigned-to-edge'],
[EdgeEventActionType.UNASSIGNED_FROM_EDGE, 'edge-event.action-type-unassigned-from-edge'],
[EdgeEventActionType.CREDENTIALS_REQUEST, 'edge-event.action-type-credentials-request'],
[EdgeEventActionType.ENTITY_MERGE_REQUEST, 'edge-event.action-type-entity-merge-request']
]
);
export const bodyContentEdgeEventActionTypes: EdgeEventActionType[] = [
EdgeEventActionType.POST_ATTRIBUTES,
EdgeEventActionType.ATTRIBUTES_UPDATED,
EdgeEventActionType.ATTRIBUTES_DELETED,
EdgeEventActionType.TIMESERIES_UPDATED,
EdgeEventActionType.RPC_CALL
];
export const edgeEventStatusColor = new Map<EdgeEventStatus, string>(
[
[EdgeEventStatus.DEPLOYED, '#000000'],
[EdgeEventStatus.PENDING, '#9e9e9e']
]
);
export interface EdgeEventBody extends BaseEventBody {
type: string;
action: string;
entityId: string;
}
export interface EdgeEvent extends BaseData<EventId> {
tenantId: TenantId;
entityId: string;
edgeId: EdgeId;
action: EdgeEventActionType;
type: EdgeEventType;
uid: string;
body: string;
}
export interface EdgeInstructions {
instructions: string;
}
export enum EdgeInstructionsMethod {
ubuntu,
centos,
docker
}
export const edgeVersionAttributeKey = 'edgeVersion';
export enum EdgeConnectivityEvent {
CONNECTED= 'CONNECTED',
DISCONNECTED = 'DISCONNECTED'
}
export const EdgeConnectivityEventTranslationMap = new Map<EdgeConnectivityEvent, string>(
[
[EdgeConnectivityEvent.CONNECTED, 'edge-event.connected'],
[EdgeConnectivityEvent.DISCONNECTED, 'edge-event.disconnected']
]
);