@webex/plugin-encryption 3.8.0 → 3.8.1-next.2

package/coverage/lcov-report/sorter.js

@@ -1,196 +0,0 @@
-/* eslint-disable */
-var addSorting = (function() {
-    'use strict';
-    var cols,
-        currentSort = {
-            index: 0,
-            desc: false
-        };
-
-    // returns the summary table element
-    function getTable() {
-        return document.querySelector('.coverage-summary');
-    }
-    // returns the thead element of the summary table
-    function getTableHeader() {
-        return getTable().querySelector('thead tr');
-    }
-    // returns the tbody element of the summary table
-    function getTableBody() {
-        return getTable().querySelector('tbody');
-    }
-    // returns the th element for nth column
-    function getNthColumn(n) {
-        return getTableHeader().querySelectorAll('th')[n];
-    }
-
-    function onFilterInput() {
-        const searchValue = document.getElementById('fileSearch').value;
-        const rows = document.getElementsByTagName('tbody')[0].children;
-        for (let i = 0; i < rows.length; i++) {
-            const row = rows[i];
-            if (
-                row.textContent
-                    .toLowerCase()
-                    .includes(searchValue.toLowerCase())
-            ) {
-                row.style.display = '';
-            } else {
-                row.style.display = 'none';
-            }
-        }
-    }
-
-    // loads the search box
-    function addSearchBox() {
-        var template = document.getElementById('filterTemplate');
-        var templateClone = template.content.cloneNode(true);
-        templateClone.getElementById('fileSearch').oninput = onFilterInput;
-        template.parentElement.appendChild(templateClone);
-    }
-
-    // loads all columns
-    function loadColumns() {
-        var colNodes = getTableHeader().querySelectorAll('th'),
-            colNode,
-            cols = [],
-            col,
-            i;
-
-        for (i = 0; i < colNodes.length; i += 1) {
-            colNode = colNodes[i];
-            col = {
-                key: colNode.getAttribute('data-col'),
-                sortable: !colNode.getAttribute('data-nosort'),
-                type: colNode.getAttribute('data-type') || 'string'
-            };
-            cols.push(col);
-            if (col.sortable) {
-                col.defaultDescSort = col.type === 'number';
-                colNode.innerHTML =
-                    colNode.innerHTML + '<span class="sorter"></span>';
-            }
-        }
-        return cols;
-    }
-    // attaches a data attribute to every tr element with an object
-    // of data values keyed by column name
-    function loadRowData(tableRow) {
-        var tableCols = tableRow.querySelectorAll('td'),
-            colNode,
-            col,
-            data = {},
-            i,
-            val;
-        for (i = 0; i < tableCols.length; i += 1) {
-            colNode = tableCols[i];
-            col = cols[i];
-            val = colNode.getAttribute('data-value');
-            if (col.type === 'number') {
-                val = Number(val);
-            }
-            data[col.key] = val;
-        }
-        return data;
-    }
-    // loads all row data
-    function loadData() {
-        var rows = getTableBody().querySelectorAll('tr'),
-            i;
-
-        for (i = 0; i < rows.length; i += 1) {
-            rows[i].data = loadRowData(rows[i]);
-        }
-    }
-    // sorts the table using the data for the ith column
-    function sortByIndex(index, desc) {
-        var key = cols[index].key,
-            sorter = function(a, b) {
-                a = a.data[key];
-                b = b.data[key];
-                return a < b ? -1 : a > b ? 1 : 0;
-            },
-            finalSorter = sorter,
-            tableBody = document.querySelector('.coverage-summary tbody'),
-            rowNodes = tableBody.querySelectorAll('tr'),
-            rows = [],
-            i;
-
-        if (desc) {
-            finalSorter = function(a, b) {
-                return -1 * sorter(a, b);
-            };
-        }
-
-        for (i = 0; i < rowNodes.length; i += 1) {
-            rows.push(rowNodes[i]);
-            tableBody.removeChild(rowNodes[i]);
-        }
-
-        rows.sort(finalSorter);
-
-        for (i = 0; i < rows.length; i += 1) {
-            tableBody.appendChild(rows[i]);
-        }
-    }
-    // removes sort indicators for current column being sorted
-    function removeSortIndicators() {
-        var col = getNthColumn(currentSort.index),
-            cls = col.className;
-
-        cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
-        col.className = cls;
-    }
-    // adds sort indicators for current column being sorted
-    function addSortIndicators() {
-        getNthColumn(currentSort.index).className += currentSort.desc
-            ? ' sorted-desc'
-            : ' sorted';
-    }
-    // adds event listeners for all sorter widgets
-    function enableUI() {
-        var i,
-            el,
-            ithSorter = function ithSorter(i) {
-                var col = cols[i];
-
-                return function() {
-                    var desc = col.defaultDescSort;
-
-                    if (currentSort.index === i) {
-                        desc = !currentSort.desc;
-                    }
-                    sortByIndex(i, desc);
-                    removeSortIndicators();
-                    currentSort.index = i;
-                    currentSort.desc = desc;
-                    addSortIndicators();
-                };
-            };
-        for (i = 0; i < cols.length; i += 1) {
-            if (cols[i].sortable) {
-                // add the click event handler on the th so users
-                // dont have to click on those tiny arrows
-                el = getNthColumn(i).querySelector('.sorter').parentElement;
-                if (el.addEventListener) {
-                    el.addEventListener('click', ithSorter(i));
-                } else {
-                    el.attachEvent('onclick', ithSorter(i));
-                }
-            }
-        }
-    }
-    // adds sorting functionality to the UI
-    return function() {
-        if (!getTable()) {
-            return;
-        }
-        cols = loadColumns();
-        loadData();
-        addSearchBox();
-        addSortIndicators();
-        enableUI();
-    };
-})();
-
-window.addEventListener('load', addSorting);

package/coverage/lcov.info

@@ -1,215 +0,0 @@
-TN:
-SF:src/cypher/constants.ts
-FNF:0
-FNH:0
-DA:1,1
-DA:2,1
-DA:3,1
-DA:4,1
-DA:5,1
-LF:5
-LH:5
-BRF:0
-BRH:0
-end_of_record
-TN:
-SF:src/cypher/index.ts
-FN:12,<instance_members_initializer>
-FN:25,Cypher
-FN:34,register
-FN:58,deregister
-FN:98,downloadAndDecryptFile
-FNF:5
-FNH:5
-FNDA:22,<instance_members_initializer>
-FNDA:22,Cypher
-FNDA:3,register
-FNDA:3,deregister
-FNDA:5,downloadAndDecryptFile
-DA:1,1
-DA:2,1
-DA:3,1
-DA:4,1
-DA:5,1
-DA:6,1
-DA:7,1
-DA:8,1
-DA:9,1
-DA:10,1
-DA:11,1
-DA:12,1
-DA:13,22
-DA:14,1
-DA:15,1
-DA:16,1
-DA:17,1
-DA:18,1
-DA:19,1
-DA:20,1
-DA:21,1
-DA:22,1
-DA:23,1
-DA:24,1
-DA:25,1
-DA:26,22
-DA:27,22
-DA:28,22
-DA:29,1
-DA:30,1
-DA:31,1
-DA:32,1
-DA:33,1
-DA:34,1
-DA:35,3
-DA:36,1
-DA:37,1
-DA:38,1
-DA:39,1
-DA:40,2
-DA:41,2
-DA:42,2
-DA:43,2
-DA:44,1
-DA:45,1
-DA:46,2
-DA:47,2
-DA:48,1
-DA:49,1
-DA:50,1
-DA:51,2
-DA:52,2
-DA:53,1
-DA:54,1
-DA:55,1
-DA:56,1
-DA:57,1
-DA:58,1
-DA:59,3
-DA:60,1
-DA:61,1
-DA:62,1
-DA:63,1
-DA:64,2
-DA:65,2
-DA:66,2
-DA:67,2
-DA:68,1
-DA:69,1
-DA:70,2
-DA:71,2
-DA:72,1
-DA:73,1
-DA:74,1
-DA:75,2
-DA:76,2
-DA:77,1
-DA:78,1
-DA:79,1
-DA:80,1
-DA:81,1
-DA:82,1
-DA:83,1
-DA:84,1
-DA:85,1
-DA:86,1
-DA:87,1
-DA:88,1
-DA:89,1
-DA:90,1
-DA:91,1
-DA:92,1
-DA:93,1
-DA:94,1
-DA:95,1
-DA:96,1
-DA:97,1
-DA:98,1
-DA:99,5
-DA:100,5
-DA:101,5
-DA:102,5
-DA:103,5
-DA:104,5
-DA:105,5
-DA:106,5
-DA:107,5
-DA:108,5
-DA:109,5
-DA:110,5
-DA:111,5
-DA:112,5
-DA:113,5
-DA:114,5
-DA:115,5
-DA:116,5
-DA:117,5
-DA:118,5
-DA:119,5
-DA:120,5
-DA:121,5
-DA:122,0
-DA:123,0
-DA:124,0
-DA:125,0
-DA:126,0
-DA:127,5
-DA:128,5
-DA:129,5
-DA:130,2
-DA:131,2
-DA:132,2
-DA:133,5
-DA:134,5
-DA:135,5
-DA:136,1
-DA:137,1
-DA:138,1
-DA:139,1
-DA:140,4
-DA:141,4
-DA:142,4
-DA:143,4
-DA:144,3
-DA:145,3
-DA:146,3
-DA:147,5
-DA:148,1
-DA:149,1
-DA:150,1
-DA:151,1
-DA:152,1
-DA:153,1
-DA:154,1
-DA:155,1
-DA:156,5
-DA:157,1
-DA:158,1
-DA:159,1
-LF:159
-LH:154
-BRDA:12,0,0,22
-BRDA:25,1,0,22
-BRDA:34,2,0,3
-BRDA:35,3,0,1
-BRDA:39,4,0,2
-BRDA:43,5,0,1
-BRDA:47,6,0,1
-BRDA:58,7,0,3
-BRDA:59,8,0,1
-BRDA:63,9,0,2
-BRDA:67,10,0,1
-BRDA:71,11,0,1
-BRDA:98,12,0,5
-BRDA:119,13,0,2
-BRDA:120,14,0,2
-BRDA:121,15,0,0
-BRDA:129,16,0,3
-BRDA:129,17,0,2
-BRDA:135,18,0,4
-BRDA:135,19,0,1
-BRDA:139,20,0,4
-BRDA:143,21,0,3
-BRDA:147,22,0,1
-BRF:23
-BRH:22
-end_of_record

package/dist/constants.js

@@ -1,6 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -1 +0,0 @@
-null

package/dist/cypher/cypher.types.js

@@ -1,6 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-//# sourceMappingURL=cypher.types.js.map

package/dist/cypher/cypher.types.js.map

@@ -1 +0,0 @@
-null

package/dist/encryption/constants.js

@@ -1,12 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.ENCRYPTION = exports.DECRYPTION_SUCCESS = exports.DECRYPTION_IN_PROGRESS = exports.DECRYPTION_FAILED = exports.DECRYPTION = void 0;
-const ENCRYPTION = exports.ENCRYPTION = 'cypher';
-const DECRYPTION = exports.DECRYPTION = 'decryption';
-const DECRYPTION_FAILED = exports.DECRYPTION_FAILED = 'decryptionFailed';
-const DECRYPTION_IN_PROGRESS = exports.DECRYPTION_IN_PROGRESS = 'decryptionInProgress';
-const DECRYPTION_SUCCESS = exports.DECRYPTION_SUCCESS = 'decryptionSuccess';
-//# sourceMappingURL=constants.js.map

package/dist/encryption/constants.js.map

@@ -1 +0,0 @@
-null

package/dist/encryption/encryption.types.js

@@ -1,6 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-//# sourceMappingURL=encryption.types.js.map

package/dist/encryption/encryption.types.js.map

@@ -1 +0,0 @@
-null

package/dist/encryption/index.js

@@ -1,84 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _webexCore = require("@webex/webex-core");
-var _constants = require("./constants");
-/* eslint-disable no-unused-expressions */
-
-/**
- * @description Encryption APIs for KMS
- * @class
- */
-class Cypher extends _webexCore.WebexPlugin {
-  namespace = _constants.ENCRYPTION;
-  constructor(...args) {
-    super(...args);
-    // @ts-ignore
-    this.$webex = this.webex;
-  }
-
-  /**
-   * Downloads and decrypts a file from the given URI.
-   *
-   * @param {string} fileUri - The URI of the file to be decrypted.
-   * @param {FileDownloadOptions} options - The options for file download.
-   * @returns {Promise<ArrayBuffer>} A promise that resolves to the decrypted ArrayBuffer.
-   * @throws {Error} If the file download or decryption fails.
-   *
-   * @example
-   * ```typescript
-   * const decryptedBuf = await webex.cypher.downloadAndDecryptFile('https://example.com/encrypted-file?JWE=eyJhbGci&keyUri=kms://example.com/keys/1234', {useFileService: false});
-   * const file = new File([decryptedBuf], "myFileName.jpeg", {type: 'image/jpeg'});
-   * ```
-   */
-  async downloadAndDecryptFile(fileUri, {
-    useFileService = false,
-    ...options
-  } = {}) {
-    // Sample fileUri: https://someserver.com/3cc29537-7f39-4cce-b204-a529960997fcab9375d8-4fd4-4788-bb12-18426674e95b.jpg?keyUri=kms://kms.wbx2.com/keys/79be16-a4dd-4195-93ef-a72604509aca&JWE=eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0..EHYI5SmnFisaOJgv.6Ie3Zui7LFtAr4eWMSnxXAzfi8Cgixcy2b9jy9cImDWvBjjvJQfwik7qvZewCaq-u8lhtTbjEzsJLeVtOKhW_9RoZt3U0RQ-cKaSh2RaK3N_mvuH7_BsoXCMf5zxaqP1HD-3jXUtVSnqFYvEGdGRWxTCWK-PK9BoIUjX6v5t22CUNYbBQBuHizLWvrGAM0UkSvFNRX5n07Xd3WVJ7OnIhYi0JvOb50lbZIrBn27AQL-_CIKoOQxQLkW9zmVACsVpHxLZx9wIo9XYsBYADRTZaw_l_uTiosAd2P1QAGHgLr_Q_qf1wGUn3eGhmptpPx-YCSJikvs2DttwWOg_-vg4jI3EiIXlc0gGsDnleeNRguCLtrks0PMz5hOp5_w9Z5EW05Cx2UAztnp1hE9_nCvPP9wTzdHsG3flkK82HMbPpeVStWvWmAlzp24vTw2KzYrCemdS2AkrShWsNt6_G7_G8nB4RhUnZ11MKaduE5jYpCXNcTx84RBYwA.vqYHCx8uIn-IMQAsPvrw
-    // KeyUri: An attachment level unique ID generated by Webex KMS post encryption of an attachment. In order to
-    // decrypt an attachment, KeyUri is a required parameter.
-    // JWE: JWE can be decrypted using KMS key to obtain the SCR key.
-    // Decrypting an attachment requires the SCR key parameter.
-    // We need to download the encrypted file from the given URI and then decrypt it using the SCR key.
-    // The decrypted file is then returned.
-
-    // step 1: parse the fileUri to get the keyUri and JWE
-    // step 2: if keyUri and JWE are not present in the fileUri, use the options
-    // step 3: use the keyUri to decrypt the JWE to get the SCR
-    // step 4: download the file from the fileUri and decrypt it using the SCR
-
-    // Parse the fileUri & JWE to get the keyUri using urlSearchParams
-    const url = new URL(fileUri);
-    let keyUri = url.searchParams.get('keyUri');
-    let JWE = url.searchParams.get('JWE');
-
-    // Check if the keyUri and JWE are present, else take it from options
-    if (!keyUri || !JWE) {
-      keyUri = options.keyUri;
-      JWE = options.jwe;
-    }
-
-    // Check if the keyUri and JWE are present, else throw an error
-    if (!keyUri || !JWE) {
-      throw new Error('KeyUri and JWE are required to decrypt the file. Either provide them in the fileUri or in the options.');
-    }
-    try {
-      // Decrypt the JWE to get the SCR
-      const scr = await this.$webex.internal.encryption.decryptScr(keyUri, JWE);
-
-      // Start the download and decryption process, returning a promise
-
-      return this.$webex.internal.encryption.download(fileUri, scr, {
-        useFileService
-      });
-    } catch (error) {
-      throw new Error(`Failed to decrypt the JWE: ${error.message}`);
-    }
-  }
-}
-var _default = exports.default = Cypher;
-//# sourceMappingURL=index.js.map

package/dist/encryption/index.js.map

@@ -1 +0,0 @@
-null

package/dist/types/constants.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/cypher/cypher.types.d.ts

@@ -1,25 +0,0 @@
-/**
- * Options for downloading a file with encryption.
- */
-interface FileDownloadOptions {
-    /**
-     * Indicates whether to use the file service for downloading.
-     * If true, the webex files service will be used.
-     * If false or undefined, the file will be downloaded directly from the URL.
-     */
-    useFileService?: boolean;
-    /**
-     * The JSON Web Encryption (JWE) string used for decrypting the file.
-     * This is a required parameter if the url does not contain the JWE.
-     */
-    jwe?: string;
-    /**
-     * The URI of the key used for decrypting the file.
-     * This is a required parameter if the url does not contain the keyUri.
-     */
-    keyUri?: string;
-}
-interface IEncryption {
-    downloadAndDecryptFile(fileUri: string, options: FileDownloadOptions): Promise<ArrayBuffer>;
-}
-export type { IEncryption, FileDownloadOptions };

package/dist/types/encryption/constants.d.ts

@@ -1,5 +0,0 @@
-export declare const ENCRYPTION = "cypher";
-export declare const DECRYPTION = "decryption";
-export declare const DECRYPTION_FAILED = "decryptionFailed";
-export declare const DECRYPTION_IN_PROGRESS = "decryptionInProgress";
-export declare const DECRYPTION_SUCCESS = "decryptionSuccess";

package/dist/types/encryption/encryption.types.d.ts

@@ -1,25 +0,0 @@
-/**
- * Options for downloading a file with encryption.
- */
-interface FileDownloadOptions {
-    /**
-     * Indicates whether to use the file service for downloading.
-     * If true, the webex files service will be used.
-     * If false or undefined, the file will be downloaded directly from the URL.
-     */
-    useFileService?: boolean;
-    /**
-     * The JSON Web Encryption (JWE) string used for decrypting the file.
-     * This is a required parameter if the url does not contain the JWE.
-     */
-    jwe?: string;
-    /**
-     * The URI of the key used for decrypting the file.
-     * This is a required parameter if the url does not contain the keyUri.
-     */
-    keyUri?: string;
-}
-interface IEncryption {
-    downloadAndDecryptFile(fileUri: string, options: FileDownloadOptions): Promise<ArrayBuffer>;
-}
-export type { IEncryption, FileDownloadOptions };

package/dist/types/encryption/index.d.ts

@@ -1,27 +0,0 @@
-import { WebexPlugin } from '@webex/webex-core';
-import { FileDownloadOptions, IEncryption } from './encryption.types';
-/**
- * @description Encryption APIs for KMS
- * @class
- */
-declare class Cypher extends WebexPlugin implements IEncryption {
-    readonly namespace = "cypher";
-    private readonly $webex;
-    constructor(...args: any[]);
-    /**
-     * Downloads and decrypts a file from the given URI.
-     *
-     * @param {string} fileUri - The URI of the file to be decrypted.
-     * @param {FileDownloadOptions} options - The options for file download.
-     * @returns {Promise<ArrayBuffer>} A promise that resolves to the decrypted ArrayBuffer.
-     * @throws {Error} If the file download or decryption fails.
-     *
-     * @example
-     * ```typescript
-     * const decryptedBuf = await webex.cypher.downloadAndDecryptFile('https://example.com/encrypted-file?JWE=eyJhbGci&keyUri=kms://example.com/keys/1234', {useFileService: false});
-     * const file = new File([decryptedBuf], "myFileName.jpeg", {type: 'image/jpeg'});
-     * ```
-     */
-    downloadAndDecryptFile(fileUri: string, { useFileService, ...options }?: FileDownloadOptions): Promise<ArrayBuffer>;
-}
-export default Cypher;

package/junit.xml

@@ -1,27 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<testsuites name="jest tests" tests="11" failures="0" errors="0" time="2.132">
-  <testsuite name="Cypher" errors="0" failures="0" skipped="0" timestamp="2025-05-06T09:39:24" time="1.83" tests="11">
-    <testcase classname="Cypher downloadAndDecryptFile should throw an error if keyUri and JWE are not present in fileUri or options" name="Cypher downloadAndDecryptFile should throw an error if keyUri and JWE are not present in fileUri or options" time="0.015">
-    </testcase>
-    <testcase classname="Cypher downloadAndDecryptFile should use keyUri and JWE from options if not present in fileUri" name="Cypher downloadAndDecryptFile should use keyUri and JWE from options if not present in fileUri" time="0.003">
-    </testcase>
-    <testcase classname="Cypher downloadAndDecryptFile should decrypt and download the file successfully" name="Cypher downloadAndDecryptFile should decrypt and download the file successfully" time="0.003">
-    </testcase>
-    <testcase classname="Cypher downloadAndDecryptFile should throw an error if decryption fails" name="Cypher downloadAndDecryptFile should throw an error if decryption fails" time="0.002">
-    </testcase>
-    <testcase classname="Cypher downloadAndDecryptFile should throw an error if download fails" name="Cypher downloadAndDecryptFile should throw an error if download fails" time="0.002">
-    </testcase>
-    <testcase classname="Cypher register should register the device and connect to Mercury" name="Cypher register should register the device and connect to Mercury" time="0.003">
-    </testcase>
-    <testcase classname="Cypher register should log already registered message if device is already registered" name="Cypher register should log already registered message if device is already registered" time="0.002">
-    </testcase>
-    <testcase classname="Cypher register should log an error if device registration fails" name="Cypher register should log an error if device registration fails" time="0.004">
-    </testcase>
-    <testcase classname="Cypher deregister should deregister the device from WDM" name="Cypher deregister should deregister the device from WDM" time="0.002">
-    </testcase>
-    <testcase classname="Cypher deregister should log an error if device deregistration fails" name="Cypher deregister should log an error if device deregistration fails" time="0.002">
-    </testcase>
-    <testcase classname="Cypher deregister should not deregister if device is not registered" name="Cypher deregister should not deregister if device is not registered" time="0.004">
-    </testcase>
-  </testsuite>
-</testsuites>