src-shared/rest-api.js

/**
 *
 *    Copyright (c) 2020 Silicon Labs
 *
 *    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.
 */

/**
 * This module provides REST API Exports.
 *
 * @module REST API: REST API.
 */

const uri = {
  zclEntity: '/zcl/:entity/:id',
  saveSessionKeyValue: '/save',
  endpointIds: '/endpointIds',
  getAllSessionKeyValues: '/allKeyValues',
  shareClusterStatesAcrossEndpoints: '/shareClusterStatesAcrossEndpoints',
  generate: '/generate',
  endpoint: '/endpoint',
  endpointType: '/endpointType',
  initialState: '/initialState',
  unseenNotificationCount: '/unseenNotificationCount',
  sessionNotification: '/sessionNotification',
  packageNotification: '/packageNotification',
  packageNotificationById: '/packageNotificationById/:packageId',
  updateNotificationToSeen: '/updateNotificationToSeen',
  updateBitOfFeatureMapAttribute: '/updateBitOfFeatureMapAttribute',
  featureMapAttribute: '/featureMapAttribute',
  conformDataExists: '/conformDataExists',
  requiredElementWarning: '/requiredElementWarning',
  deleteSessionNotification: '/deleteSessionNotification',
  deletePackageNotification: 'deletePackageNotification',
  duplicateEndpoint: '/duplicateEndpoint',
  duplicateEndpointType: '/duplicateEndpointType',
  dirtyFlag: '/dirtyFlag',
  checkConformOnFeatureUpdate: '/checkConformOnFeatureUpdate',
  requiredElements: '/requiredElements',
  option: '/option',
  uiOptions: '/uiOptions',
  commandUpdate: '/command/update',
  eventUpdate: '/event/update',
  cluster: '/cluster',
  attributeUpdate: '/attribute/update',
  preview: '/preview/',
  previewName: '/preview/:name',
  previewNameIndex: '/preview/:name/:index',
  sql: '/sql',
  version: '/version',
  cache: '/cache',
  packages: `/packages`,
  getAllPackages: `/allpackages`,
  addNewPackage: `/packages/add`,
  sessionPackage: `/sessionPackage`,
  zclExtension: `/zclExtension/:entity/:extensionId`,
  zclCluster: '/zcl/cluster/',
  zclDeviceType: '/zcl/deviceType/',
  zclDomain: '/zcl/domain/',
  zclBitmap: '/zcl/bitmap/',
  zclEnum: '/zcl/enum/',
  zclStruct: '/zcl/struct/',
  zclAtomics: '/zcl/atomics/',
  endpointTypeClusters: '/zcl/endpointTypeClusters/',
  endpointTypeAttributes: '/zcl/endpointTypeAttributes/',
  endpointTypeCommands: '/zcl/endpointTypeCommands/',
  endpointTypeEvents: '/zcl/endpointTypeEvents/',
  deviceTypeClusters: '/zcl/deviceTypeClusters/',
  deviceTypeAttributes: '/zcl/deviceTypeAttributes/',
  deviceTypeCommands: '/zcl/deviceTypeCommands/',
  deviceTypeEvents: '/zcl/deviceTypeEvents/',
  deviceTypeFeatures: '/zcl/deviceTypeFeatures/',
  sessionAttempt: '/zcl/sessionAttempt',
  initializeSession: '/zcl/initializeSession',
  sessionCreate: '/zcl/sessionCreate',
  reloadSession: '/zcl/reloadSession',
  init: '/init',
  forcedExternal: '/zcl/forcedExternal',
  loadComposition: '/zcl/loadComposition'
}

const uiMode = {
  ZIGBEE: `zigbee`
}

const uc = {
  // command id
  componentTree: '/uc/component/tree',
  componentAdd: '/uc/component/add',
  componentRemove: '/uc/component/remove'
}

const ide = {
  // request
  open: '/file/open',
  close: '/file/close',
  save: '/file/save',
  saveAs: '/file/saveAs',
  rename: '/file/rename',
  move: '/file/move',
  isDirty: '/file/isDirty',

  // response
  openResponse: 'openResponse'
}

const updateKey = {
  deviceTypeRef: 'deviceTypeRef',
  endpointId: 'endpointId',
  endpointType: 'endpointType',
  endpointVersion: 'endpointVersion',
  deviceVersion: 'deviceVersion',
  networkId: 'networkId',
  parentEndpointIdentifier: 'parentEndpointIdentifier',
  profileId: 'profileId',
  deviceId: 'deviceId',
  name: 'name',
  attributeSelected: 'selectedAttributes',
  attributeSingleton: 'selectedSingleton',
  attributeBounded: 'selectedBounded',
  attributeDefault: 'defaultValue',
  attributeReporting: 'selectedReporting',
  attributeReportMin: 'reportingMin',
  attributeReportMax: 'reportingMax',
  attributeReportChange: 'reportableChange',
  attributeStorage: 'storageOption',
  init: 'init'
}

exports.param = {
  sessionId: 'sessionId',
  path: 'path',
  templatePackageId: 'templatePackageId'
}

exports.uri = uri
exports.uiMode = uiMode
exports.uc = uc
exports.ide = ide
exports.updateKey = updateKey

exports.noFilter = 'No Filter'