@c8y/ngx-components/fesm2022/c8y-ngx-components-remote-access-data.mjs.map

Angular modules for Cumulocity IoT applications

{"version":3,"file":"c8y-ngx-components-remote-access-data.mjs","sources":["../../remote-access/data/remote-access.service.ts","../../remote-access/data/c8y-ngx-components-remote-access-data.ts"],"sourcesContent":["import { inject, Injectable } from '@angular/core';\nimport { ActivatedRouteSnapshot, CanActivateFn } from '@angular/router';\nimport { FetchClient, IManagedObject } from '@c8y/client';\nimport {\n  ContextRouteService,\n  Permissions,\n  ServiceRegistry,\n  ViewContext\n} from '@c8y/ngx-components';\nimport { gettext } from '@c8y/ngx-components/gettext';\nimport { Observable, defer, shareReplay } from 'rxjs';\nimport { RemoteAccessProtocolProvider } from './remote-access-protocol-provider';\nimport { uniqWith, intersectionWith, isEqual } from 'lodash';\n\nexport interface RemoteAccessConfiguration {\n  id: string;\n  name: string;\n  hostname: string;\n  port: number;\n  protocol: string;\n  attrs?: any;\n  credentials?: any;\n  credentialsType?: string;\n}\n\nexport const CREDENTIALS_TYPES = {\n  NONE: {\n    name: 'NONE',\n    value: 'NONE',\n    label: gettext('No password')\n  },\n  USER_PASS: {\n    name: 'USER_PASS',\n    value: 'USER_PASS',\n    label: gettext('Username and password')\n  },\n  PASS_ONLY: {\n    name: 'PASS_ONLY',\n    value: 'PASS_ONLY',\n    label: gettext('Password only')\n  },\n  KEY_PAIR: {\n    name: 'KEY_PAIR',\n    value: 'KEY_PAIR',\n    label: gettext('Public/private keys')\n  },\n  CERTIFICATE: {\n    name: 'CERTIFICATE',\n    value: 'CERTIFICATE',\n    label: gettext('Certificate')\n  }\n} as const;\n\nexport const canActivateRemoteAccess: CanActivateFn = (route: ActivatedRouteSnapshot) => {\n  const permissions = inject(Permissions);\n  const remoteAccessService = inject(RemoteAccessService);\n  const contextRouteService = inject(ContextRouteService);\n  if (!permissions.hasRole(Permissions.ROLE_REMOTE_ACCESS_ADMIN)) {\n    return false;\n  }\n\n  const contextDetails = contextRouteService.getContextData(route);\n  if (contextDetails.context !== ViewContext.Device) {\n    return false;\n  }\n\n  const device = contextDetails.contextData as IManagedObject;\n  if (!device || !Array.isArray(device.c8y_SupportedOperations)) {\n    return false;\n  }\n  const supportedOperations: string[] = device.c8y_SupportedOperations;\n  if (!supportedOperations.includes('c8y_RemoteAccessConnect')) {\n    return false;\n  }\n  return remoteAccessService.isAvailable$();\n};\n\n@Injectable({\n  providedIn: 'root'\n})\nexport class RemoteAccessService {\n  private cachedIsAvailable$: Observable<boolean>;\n  readonly baseUrl = '/service/remoteaccess';\n  constructor(\n    private fetchClient: FetchClient,\n    private serviceRegistry: ServiceRegistry\n  ) {}\n\n  /**\n   * Verifies if the remote access service is available by sending a HEAD request to is's health endpoint.\n   * @returns cached Observable that emits true if the service is available, false otherwise.\n   */\n  isAvailable$(): Observable<boolean> {\n    if (!this.cachedIsAvailable$) {\n      this.cachedIsAvailable$ = defer(() => this.healthEndpointAvailable()).pipe(shareReplay(1));\n    }\n\n    return this.cachedIsAvailable$;\n  }\n\n  /**\n   * misses the leading ? for the query params\n   */\n  getAuthQueryParamsForWebsocketConnection() {\n    const { headers } = this.fetchClient.getFetchOptions();\n    const params = new URLSearchParams();\n\n    if (headers) {\n      const xsrfToken = headers['X-XSRF-TOKEN'];\n      const auth = headers['Authorization'];\n\n      if (xsrfToken) {\n        params.append('XSRF-TOKEN', xsrfToken);\n      }\n      if (auth) {\n        params.append('token', auth.replace('Bearer ', '').replace('Basic ', ''));\n      }\n    }\n\n    const paramsString = params.toString();\n    return paramsString;\n  }\n\n  /**\n   * Returns the URI for the websocket connection to the remote access service.\n   */\n  getWebSocketUri<K extends string, I extends string>(deviceId: K, configurationId: I) {\n    const authQueryParams = this.getAuthQueryParamsForWebsocketConnection();\n    const protocol = window.location.protocol === 'http:' ? 'ws' : 'wss';\n    const pathName =\n      `${protocol}://${window.location.host}${this.baseUrl}/client/${deviceId}/configurations/${configurationId}` as const;\n    return authQueryParams ? (`${pathName}?${authQueryParams}` as const) : pathName;\n  }\n\n  /**\n   * Retrieves all configurations for a given device.\n   */\n  async listConfigurations(deviceId: string): Promise<RemoteAccessConfiguration[]> {\n    const response = await this.fetchClient.fetch(\n      `${this.baseUrl}/devices/${deviceId}/configurations`\n    );\n    if (response.ok) {\n      return response.json();\n    }\n\n    throw new Error(`Failed to fetch configurations for device ${deviceId}`);\n  }\n\n  /**\n   * Deletes a configuration for a given device.\n   */\n  async deleteConfiguration(deviceId: string, configurationId: string) {\n    const response = await this.fetchClient.fetch(\n      `${this.baseUrl}/devices/${deviceId}/configurations/${configurationId}`,\n      { method: 'DELETE' }\n    );\n\n    if (response.ok) {\n      return;\n    }\n\n    throw new Error(`Failed to delete configuration for device ${deviceId}`);\n  }\n\n  /**\n   * Retrieves all available remote access protocol providers.\n   */\n  getProtocolProviders() {\n    return this.serviceRegistry.get('remoteAccessProtocolHook');\n  }\n\n  /**\n   * Retrieves all supported protocol providers for a given device.\n   * Based on the declarations in the fragment c8y_RemoteAccessSupportedProtocols of the device managed object.\n   */\n  getSupportedProtocolProvidersFor(device: IManagedObject): RemoteAccessProtocolProvider[] {\n    const { c8y_RemoteAccessSupportedProtocols = [] } = device;\n    const uniqueInput = uniqWith(\n      c8y_RemoteAccessSupportedProtocols.map(p => p.toUpperCase()),\n      isEqual\n    );\n    const supportedProviders = intersectionWith(\n      this.getProtocolProviders(),\n      uniqueInput,\n      ({ protocolName }, protocol) => protocolName?.toUpperCase() === protocol\n    );\n    return supportedProviders?.length > 0 ? supportedProviders : this.getProtocolProviders();\n  }\n\n  /**\n   * Creates a new configuration for a given device.\n   */\n  async addConfiguration(\n    deviceId: string,\n    configuration: Omit<RemoteAccessConfiguration, 'id'>\n  ): Promise<RemoteAccessConfiguration> {\n    const response = await this.fetchClient.fetch(\n      `${this.baseUrl}/devices/${deviceId}/configurations`,\n      {\n        method: 'POST',\n        headers: {\n          'Content-Type': 'application/json'\n        },\n        body: JSON.stringify(configuration)\n      }\n    );\n\n    if (response.ok) {\n      return response.json();\n    }\n\n    throw new Error(`Failed to add configuration for device ${configuration.attrs.deviceId}`);\n  }\n\n  /**\n   * Updates a configuration for a given device.\n   */\n  async updateConfiguration(\n    deviceId: string,\n    configuration: RemoteAccessConfiguration\n  ): Promise<RemoteAccessConfiguration> {\n    const response = await this.fetchClient.fetch(\n      `${this.baseUrl}/devices/${deviceId}/configurations/${configuration.id}`,\n      {\n        method: 'PUT',\n        headers: {\n          'Content-Type': 'application/json'\n        },\n        body: JSON.stringify(configuration)\n      }\n    );\n\n    if (response.ok) {\n      return response.json();\n    }\n\n    throw new Error(`Failed to update configuration for device ${configuration.attrs.deviceId}`);\n  }\n\n  /**\n   * Generates a SSH key pair for a given hostname.\n   */\n  async generateKeyPair(hostname: string): Promise<{ publicKey: string; privateKey: string }> {\n    const response = await this.fetchClient.fetch(`${this.baseUrl}/keypair/generate`, {\n      method: 'POST',\n      headers: {\n        'Content-Type': 'application/json'\n      },\n      body: JSON.stringify({ hostname })\n    });\n\n    if (response.ok) {\n      return response.json();\n    }\n\n    throw new Error(`Failed to generate key pair for ${hostname}`);\n  }\n\n  private async healthEndpointAvailable(): Promise<boolean> {\n    try {\n      const response = await this.fetchClient.fetch(`${this.baseUrl}/health`, {\n        method: 'HEAD',\n        headers: {\n          'Content-Type': 'application/json'\n        }\n      });\n\n      if (response.ok) {\n        return !!response.ok;\n      }\n    } catch (e) {\n      return false;\n    }\n  }\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;;;;;;;;AAyBa,MAAA,iBAAiB,GAAG;AAC/B,IAAA,IAAI,EAAE;AACJ,QAAA,IAAI,EAAE,MAAM;AACZ,QAAA,KAAK,EAAE,MAAM;AACb,QAAA,KAAK,EAAE,OAAO,CAAC,aAAa;AAC7B,KAAA;AACD,IAAA,SAAS,EAAE;AACT,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,KAAK,EAAE,WAAW;AAClB,QAAA,KAAK,EAAE,OAAO,CAAC,uBAAuB;AACvC,KAAA;AACD,IAAA,SAAS,EAAE;AACT,QAAA,IAAI,EAAE,WAAW;AACjB,QAAA,KAAK,EAAE,WAAW;AAClB,QAAA,KAAK,EAAE,OAAO,CAAC,eAAe;AAC/B,KAAA;AACD,IAAA,QAAQ,EAAE;AACR,QAAA,IAAI,EAAE,UAAU;AAChB,QAAA,KAAK,EAAE,UAAU;AACjB,QAAA,KAAK,EAAE,OAAO,CAAC,qBAAqB;AACrC,KAAA;AACD,IAAA,WAAW,EAAE;AACX,QAAA,IAAI,EAAE,aAAa;AACnB,QAAA,KAAK,EAAE,aAAa;AACpB,QAAA,KAAK,EAAE,OAAO,CAAC,aAAa;AAC7B;;AAGU,MAAA,uBAAuB,GAAkB,CAAC,KAA6B,KAAI;AACtF,IAAA,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;AACvC,IAAA,MAAM,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACvD,IAAA,MAAM,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;IACvD,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC,wBAAwB,CAAC,EAAE;AAC9D,QAAA,OAAO,KAAK;;IAGd,MAAM,cAAc,GAAG,mBAAmB,CAAC,cAAc,CAAC,KAAK,CAAC;IAChE,IAAI,cAAc,CAAC,OAAO,KAAK,WAAW,CAAC,MAAM,EAAE;AACjD,QAAA,OAAO,KAAK;;AAGd,IAAA,MAAM,MAAM,GAAG,cAAc,CAAC,WAA6B;AAC3D,IAAA,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,EAAE;AAC7D,QAAA,OAAO,KAAK;;AAEd,IAAA,MAAM,mBAAmB,GAAa,MAAM,CAAC,uBAAuB;IACpE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,yBAAyB,CAAC,EAAE;AAC5D,QAAA,OAAO,KAAK;;AAEd,IAAA,OAAO,mBAAmB,CAAC,YAAY,EAAE;AAC3C;MAKa,mBAAmB,CAAA;IAG9B,WACU,CAAA,WAAwB,EACxB,eAAgC,EAAA;QADhC,IAAW,CAAA,WAAA,GAAX,WAAW;QACX,IAAe,CAAA,eAAA,GAAf,eAAe;QAHhB,IAAO,CAAA,OAAA,GAAG,uBAAuB;;AAM1C;;;AAGG;IACH,YAAY,GAAA;AACV,QAAA,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC5B,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;;QAG5F,OAAO,IAAI,CAAC,kBAAkB;;AAGhC;;AAEG;IACH,wCAAwC,GAAA;QACtC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE;AACtD,QAAA,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE;QAEpC,IAAI,OAAO,EAAE;AACX,YAAA,MAAM,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC;AACzC,YAAA,MAAM,IAAI,GAAG,OAAO,CAAC,eAAe,CAAC;YAErC,IAAI,SAAS,EAAE;AACb,gBAAA,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC;;YAExC,IAAI,IAAI,EAAE;gBACR,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;;;AAI7E,QAAA,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE;AACtC,QAAA,OAAO,YAAY;;AAGrB;;AAEG;IACH,eAAe,CAAqC,QAAW,EAAE,eAAkB,EAAA;AACjF,QAAA,MAAM,eAAe,GAAG,IAAI,CAAC,wCAAwC,EAAE;AACvE,QAAA,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,KAAK,OAAO,GAAG,IAAI,GAAG,KAAK;AACpE,QAAA,MAAM,QAAQ,GACZ,CAAA,EAAG,QAAQ,CAAM,GAAA,EAAA,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAG,EAAA,IAAI,CAAC,OAAO,CAAA,QAAA,EAAW,QAAQ,CAAmB,gBAAA,EAAA,eAAe,EAAW;AACtH,QAAA,OAAO,eAAe,GAAI,CAAG,EAAA,QAAQ,CAAI,CAAA,EAAA,eAAe,CAAY,CAAA,GAAG,QAAQ;;AAGjF;;AAEG;IACH,MAAM,kBAAkB,CAAC,QAAgB,EAAA;AACvC,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAC3C,CAAA,EAAG,IAAI,CAAC,OAAO,YAAY,QAAQ,CAAA,eAAA,CAAiB,CACrD;AACD,QAAA,IAAI,QAAQ,CAAC,EAAE,EAAE;AACf,YAAA,OAAO,QAAQ,CAAC,IAAI,EAAE;;AAGxB,QAAA,MAAM,IAAI,KAAK,CAAC,6CAA6C,QAAQ,CAAA,CAAE,CAAC;;AAG1E;;AAEG;AACH,IAAA,MAAM,mBAAmB,CAAC,QAAgB,EAAE,eAAuB,EAAA;QACjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAC3C,CAAA,EAAG,IAAI,CAAC,OAAO,CAAY,SAAA,EAAA,QAAQ,CAAmB,gBAAA,EAAA,eAAe,CAAE,CAAA,EACvE,EAAE,MAAM,EAAE,QAAQ,EAAE,CACrB;AAED,QAAA,IAAI,QAAQ,CAAC,EAAE,EAAE;YACf;;AAGF,QAAA,MAAM,IAAI,KAAK,CAAC,6CAA6C,QAAQ,CAAA,CAAE,CAAC;;AAG1E;;AAEG;IACH,oBAAoB,GAAA;QAClB,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,0BAA0B,CAAC;;AAG7D;;;AAGG;AACH,IAAA,gCAAgC,CAAC,MAAsB,EAAA;AACrD,QAAA,MAAM,EAAE,kCAAkC,GAAG,EAAE,EAAE,GAAG,MAAM;QAC1D,MAAM,WAAW,GAAG,QAAQ,CAC1B,kCAAkC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,EAC5D,OAAO,CACR;QACD,MAAM,kBAAkB,GAAG,gBAAgB,CACzC,IAAI,CAAC,oBAAoB,EAAE,EAC3B,WAAW,EACX,CAAC,EAAE,YAAY,EAAE,EAAE,QAAQ,KAAK,YAAY,EAAE,WAAW,EAAE,KAAK,QAAQ,CACzE;AACD,QAAA,OAAO,kBAAkB,EAAE,MAAM,GAAG,CAAC,GAAG,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,EAAE;;AAG1F;;AAEG;AACH,IAAA,MAAM,gBAAgB,CACpB,QAAgB,EAChB,aAAoD,EAAA;AAEpD,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAC3C,CAAA,EAAG,IAAI,CAAC,OAAO,CAAY,SAAA,EAAA,QAAQ,iBAAiB,EACpD;AACE,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,OAAO,EAAE;AACP,gBAAA,cAAc,EAAE;AACjB,aAAA;AACD,YAAA,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa;AACnC,SAAA,CACF;AAED,QAAA,IAAI,QAAQ,CAAC,EAAE,EAAE;AACf,YAAA,OAAO,QAAQ,CAAC,IAAI,EAAE;;QAGxB,MAAM,IAAI,KAAK,CAAC,CAA0C,uCAAA,EAAA,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAE,CAAA,CAAC;;AAG3F;;AAEG;AACH,IAAA,MAAM,mBAAmB,CACvB,QAAgB,EAChB,aAAwC,EAAA;QAExC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAC3C,CAAA,EAAG,IAAI,CAAC,OAAO,YAAY,QAAQ,CAAA,gBAAA,EAAmB,aAAa,CAAC,EAAE,EAAE,EACxE;AACE,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,OAAO,EAAE;AACP,gBAAA,cAAc,EAAE;AACjB,aAAA;AACD,YAAA,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa;AACnC,SAAA,CACF;AAED,QAAA,IAAI,QAAQ,CAAC,EAAE,EAAE;AACf,YAAA,OAAO,QAAQ,CAAC,IAAI,EAAE;;QAGxB,MAAM,IAAI,KAAK,CAAC,CAA6C,0CAAA,EAAA,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAE,CAAA,CAAC;;AAG9F;;AAEG;IACH,MAAM,eAAe,CAAC,QAAgB,EAAA;AACpC,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAG,EAAA,IAAI,CAAC,OAAO,mBAAmB,EAAE;AAChF,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,OAAO,EAAE;AACP,gBAAA,cAAc,EAAE;AACjB,aAAA;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE;AAClC,SAAA,CAAC;AAEF,QAAA,IAAI,QAAQ,CAAC,EAAE,EAAE;AACf,YAAA,OAAO,QAAQ,CAAC,IAAI,EAAE;;AAGxB,QAAA,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,CAAA,CAAE,CAAC;;AAGxD,IAAA,MAAM,uBAAuB,GAAA;AACnC,QAAA,IAAI;AACF,YAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAG,EAAA,IAAI,CAAC,OAAO,SAAS,EAAE;AACtE,gBAAA,MAAM,EAAE,MAAM;AACd,gBAAA,OAAO,EAAE;AACP,oBAAA,cAAc,EAAE;AACjB;AACF,aAAA,CAAC;AAEF,YAAA,IAAI,QAAQ,CAAC,EAAE,EAAE;AACf,gBAAA,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE;;;QAEtB,OAAO,CAAC,EAAE;AACV,YAAA,OAAO,KAAK;;;+GA/LL,mBAAmB,EAAA,IAAA,EAAA,CAAA,EAAA,KAAA,EAAA,EAAA,CAAA,WAAA,EAAA,EAAA,EAAA,KAAA,EAAA,EAAA,CAAA,eAAA,EAAA,CAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;AAAnB,IAAA,SAAA,IAAA,CAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,mBAAmB,cAFlB,MAAM,EAAA,CAAA,CAAA;;4FAEP,mBAAmB,EAAA,UAAA,EAAA,CAAA;kBAH/B,UAAU;AAAC,YAAA,IAAA,EAAA,CAAA;AACV,oBAAA,UAAU,EAAE;AACb,iBAAA;;;AC/ED;;AAEG;;;;"}