rpc.models.ts 2.58 KB
///
/// 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 { TenantId } from '@shared/models/id/tenant-id';
import { RpcId } from '@shared/models/id/rpc-id';
import { DeviceId } from '@shared/models/id/device-id';
import { TableCellButtonActionDescriptor } from '@home/components/widget/lib/table-widget.models';

export enum RpcStatus {
  QUEUED = 'QUEUED',
  DELIVERED = 'DELIVERED',
  SUCCESSFUL = 'SUCCESSFUL',
  TIMEOUT = 'TIMEOUT',
  FAILED = 'FAILED',
  SENT = 'SENT',
  EXPIRED = 'EXPIRED'
}

export const rpcStatusColors = new Map<RpcStatus, string>(
  [
    [RpcStatus.QUEUED, 'black'],
    [RpcStatus.DELIVERED, 'green'],
    [RpcStatus.SUCCESSFUL, 'green'],
    [RpcStatus.TIMEOUT, 'orange'],
    [RpcStatus.FAILED, 'red'],
    [RpcStatus.SENT, 'green'],
    [RpcStatus.EXPIRED, 'red']
  ]
);

export const rpcStatusTranslation = new Map<RpcStatus, string>(
  [
    [RpcStatus.QUEUED, 'widgets.persistent-table.rpc-status.QUEUED'],
    [RpcStatus.DELIVERED, 'widgets.persistent-table.rpc-status.DELIVERED'],
    [RpcStatus.SUCCESSFUL, 'widgets.persistent-table.rpc-status.SUCCESSFUL'],
    [RpcStatus.TIMEOUT, 'widgets.persistent-table.rpc-status.TIMEOUT'],
    [RpcStatus.FAILED, 'widgets.persistent-table.rpc-status.FAILED'],
    [RpcStatus.SENT, 'widgets.persistent-table.rpc-status.SENT'],
    [RpcStatus.EXPIRED, 'widgets.persistent-table.rpc-status.EXPIRED']
  ]
);

export interface PersistentRpc {
  id: RpcId;
  createdTime: number;
  expirationTime: number;
  status: RpcStatus;
  response: any;
  request: {
    id: string;
    oneway: boolean;
    body: {
      method: string;
      params: string;
    };
    retries: null | number;
  };
  deviceId: DeviceId;
  tenantId: TenantId;
  additionalInfo?: string;
}

export interface PersistentRpcData extends PersistentRpc {
  actionCellButtons?: TableCellButtonActionDescriptor[];
  hasActions?: boolean;
}

export interface RequestData {
  method?: string;
  oneWayElseTwoWay?: boolean;
  persistentPollingInterval?: number;
  retries?: number;
  params?: object;
  additionalInfo?: object;
}