@signageos/front-applet 7.1.1 → 8.0.0

package/es6/FrontApplet/Error/errorHelper.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEnrichedStack = exports.createError = void 0;
+exports.createError = createError;
+exports.getEnrichedStack = getEnrichedStack;
 const NO_STACK_MSG = 'Stack trace is not available for this type of error.';
 function createError(errorTransferObject) {
     const { message } = errorTransferObject;
@@ -12,7 +13,6 @@ function createError(errorTransferObject) {
     });
     return errorToReturn;
 }
-exports.createError = createError;
 function getEnrichedStack(error) {
     const { type, message, code, stackTrace, pathToDocs, origin, originStack } = error;
     const suggestion = getErrorSuggestion(code, error.suggestion, pathToDocs);
@@ -29,16 +29,15 @@ function getEnrichedStack(error) {
     stringToReturn += stackTrace ? 'Stack' + ': ' + stackTrace : 'Stack' + ': ' + NO_STACK_MSG;
     return stringToReturn;
 }
-exports.getEnrichedStack = getEnrichedStack;
 function getErrorSuggestion(code, suggestion, pathToDocs) {
-    const DOCS_HOST_URL = 'https://docs.signageos.io';
+    const DEVELOPER_DOCS_HOST_URL = 'https://developers.signageos.io';
     const BEFORE_LINK_MSG = 'More information on';
     let LINK_TO_ERROR;
     if (pathToDocs) {
-        LINK_TO_ERROR = `${DOCS_HOST_URL}${pathToDocs}`;
+        LINK_TO_ERROR = `${DEVELOPER_DOCS_HOST_URL}${pathToDocs}`;
     }
     else {
-        LINK_TO_ERROR = `${DOCS_HOST_URL}/search?key=error%20${code}`;
+        LINK_TO_ERROR = `${DEVELOPER_DOCS_HOST_URL}/search?key=error%20${code}`;
     }
     let suggestionToReturn = suggestion ? suggestion + '\n' : '';
     suggestionToReturn += `${BEFORE_LINK_MSG} ${LINK_TO_ERROR}`;

package/es6/FrontApplet/Error/errorHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"errorHelper.js","sourceRoot":"","sources":["../../../src/FrontApplet/Error/errorHelper.ts"],"names":[],"mappings":";;;AAAA,MAAM,YAAY,GAAG,sDAAsD,CAAC;AAa5E,SAAgB,WAAW,CAAC,mBAA4C;IACvE,MAAM,EAAE,OAAO,EAAE,GAAG,mBAAmB,CAAC;IACxC,MAAM,aAAa,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IACzC,aAAa,CAAC,KAAK,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;IAC5D,aAAa,CAAC,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;IAE9C,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QACvD,aAAqB,CAAC,GAAG,CAAC,GAAI,mBAA2B,CAAC,GAAG,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,OAAO,aAAa,CAAC;AACtB,CAAC;AAXD,kCAWC;AAED,SAAgB,gBAAgB,CAAC,KAA8B;IAC9D,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IACnF,MAAM,UAAU,GAAG,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC1E,IAAI,cAAc,GAAG,EAAE,CAAC;IAExB,cAAc,IAAI,IAAI,GAAG,IAAI,GAAG,OAAO,GAAG,IAAI,CAAC;IAC/C,cAAc,IAAI,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAC9C,cAAc,IAAI,YAAY,GAAG,IAAI,GAAG,UAAU,GAAG,IAAI,CAAC;IAC1D,cAAc,IAAI,MAAM,CAAC,CAAC,CAAC,QAAQ,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAChE,cAAc,IAAI,WAAW;QAC5B,CAAC,CAAC,aAAa,GAAG,IAAI,GAAG,WAAW,GAAG,IAAI;QAC3C,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW;YACvB,CAAC,CAAC,aAAa,GAAG,IAAI,GAAG,YAAY,GAAG,IAAI;YAC5C,CAAC,CAAC,EAAE,CAAC;IACP,cAAc,IAAI,UAAU,CAAC,CAAC,CAAC,OAAO,GAAG,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,OAAO,GAAG,IAAI,GAAG,YAAY,CAAC;IAE3F,OAAO,cAAc,CAAC;AACvB,CAAC;AAjBD,4CAiBC;AAED,SAAS,kBAAkB,CAAC,IAAY,EAAE,UAAmB,EAAE,UAAmB;IACjF,MAAM,aAAa,GAAG,2BAA2B,CAAC;IAClD,MAAM,eAAe,GAAG,qBAAqB,CAAC;IAC9C,IAAI,aAAqB,CAAC;IAE1B,IAAI,UAAU,EAAE;QACf,aAAa,GAAG,GAAG,aAAa,GAAG,UAAU,EAAE,CAAC;KAChD;SAAM;QACN,aAAa,GAAG,GAAG,aAAa,uBAAuB,IAAI,EAAE,CAAC;KAC9D;IAED,IAAI,kBAAkB,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,kBAAkB,IAAI,GAAG,eAAe,IAAI,aAAa,EAAE,CAAC;IAE5D,OAAO,kBAAkB,CAAC;AAC3B,CAAC"}
+{"version":3,"file":"errorHelper.js","sourceRoot":"","sources":["../../../src/FrontApplet/Error/errorHelper.ts"],"names":[],"mappings":";;AAaA,kCAWC;AAED,4CAiBC;AA3CD,MAAM,YAAY,GAAG,sDAAsD,CAAC;AAa5E,SAAgB,WAAW,CAAC,mBAA4C;IACvE,MAAM,EAAE,OAAO,EAAE,GAAG,mBAAmB,CAAC;IACxC,MAAM,aAAa,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IACzC,aAAa,CAAC,KAAK,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;IAC5D,aAAa,CAAC,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;IAE9C,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QACvD,aAAqB,CAAC,GAAG,CAAC,GAAI,mBAA2B,CAAC,GAAG,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,OAAO,aAAa,CAAC;AACtB,CAAC;AAED,SAAgB,gBAAgB,CAAC,KAA8B;IAC9D,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IACnF,MAAM,UAAU,GAAG,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC1E,IAAI,cAAc,GAAG,EAAE,CAAC;IAExB,cAAc,IAAI,IAAI,GAAG,IAAI,GAAG,OAAO,GAAG,IAAI,CAAC;IAC/C,cAAc,IAAI,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAC9C,cAAc,IAAI,YAAY,GAAG,IAAI,GAAG,UAAU,GAAG,IAAI,CAAC;IAC1D,cAAc,IAAI,MAAM,CAAC,CAAC,CAAC,QAAQ,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAChE,cAAc,IAAI,WAAW;QAC5B,CAAC,CAAC,aAAa,GAAG,IAAI,GAAG,WAAW,GAAG,IAAI;QAC3C,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW;YACvB,CAAC,CAAC,aAAa,GAAG,IAAI,GAAG,YAAY,GAAG,IAAI;YAC5C,CAAC,CAAC,EAAE,CAAC;IACP,cAAc,IAAI,UAAU,CAAC,CAAC,CAAC,OAAO,GAAG,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,OAAO,GAAG,IAAI,GAAG,YAAY,CAAC;IAE3F,OAAO,cAAc,CAAC;AACvB,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAY,EAAE,UAAmB,EAAE,UAAmB;IACjF,MAAM,uBAAuB,GAAG,iCAAiC,CAAC;IAClE,MAAM,eAAe,GAAG,qBAAqB,CAAC;IAC9C,IAAI,aAAqB,CAAC;IAE1B,IAAI,UAAU,EAAE,CAAC;QAChB,aAAa,GAAG,GAAG,uBAAuB,GAAG,UAAU,EAAE,CAAC;IAC3D,CAAC;SAAM,CAAC;QACP,aAAa,GAAG,GAAG,uBAAuB,uBAAuB,IAAI,EAAE,CAAC;IACzE,CAAC;IAED,IAAI,kBAAkB,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,kBAAkB,IAAI,GAAG,eAAe,IAAI,aAAa,EAAE,CAAC;IAE5D,OAAO,kBAAkB,CAAC;AAC3B,CAAC"}

package/es6/FrontApplet/Exchange/Exchange.js

@@ -1,29 +1,22 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createExchange = void 0;
+exports.createExchange = createExchange;
 function createExchange(messagePrefix, postMessage) {
     const messageNameToType = (name) => {
         return [messagePrefix, name].join('.');
     };
-    const typedPostMessage = (message) => __awaiter(this, void 0, void 0, function* () {
+    const typedPostMessage = async (message) => {
         const type = messageNameToType(message.type);
-        message = Object.assign(Object.assign({}, message), { type });
+        message = {
+            ...message,
+            type,
+        };
         return postMessage(message);
-    });
+    };
     return {
         messageNameToType,
         postMessage: typedPostMessage,
         createNamespaced: (namespace) => createExchange(messageNameToType(namespace), postMessage),
     };
 }
-exports.createExchange = createExchange;
 //# sourceMappingURL=Exchange.js.map

package/es6/FrontApplet/Exchange/Exchange.js.map

@@ -1 +1 @@
-{"version":3,"file":"Exchange.js","sourceRoot":"","sources":["../../../src/FrontApplet/Exchange/Exchange.ts"],"names":[],"mappings":";;;;;;;;;;;;AASA,SAAgB,cAAc,CAAY,aAAqB,EAAE,WAA8B;IAC9F,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,EAAE;QAC1C,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxC,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,CAAO,OAAiB,EAAsB,EAAE;QACxE,MAAM,IAAI,GAAG,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,OAAO,mCACH,OAAO,KACV,IAAI,GACJ,CAAC;QACF,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC,CAAA,CAAC;IACF,OAAO;QACN,iBAAiB;QACjB,WAAW,EAAE,gBAAgB;QAC7B,gBAAgB,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,cAAc,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC;KAClG,CAAC;AACH,CAAC;AAjBD,wCAiBC"}
+{"version":3,"file":"Exchange.js","sourceRoot":"","sources":["../../../src/FrontApplet/Exchange/Exchange.ts"],"names":[],"mappings":";;AASA,wCAiBC;AAjBD,SAAgB,cAAc,CAAY,aAAqB,EAAE,WAA8B;IAC9F,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,EAAE;QAC1C,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxC,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,KAAK,EAAE,OAAiB,EAAsB,EAAE;QACxE,MAAM,IAAI,GAAG,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,OAAO,GAAG;YACT,GAAG,OAAO;YACV,IAAI;SACJ,CAAC;QACF,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC,CAAC;IACF,OAAO;QACN,iBAAiB;QACjB,WAAW,EAAE,gBAAgB;QAC7B,gBAAgB,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,cAAc,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC;KAClG,CAAC;AACH,CAAC"}

package/es6/FrontApplet/FileSystem/FileSystem.d.ts

@@ -2,32 +2,187 @@ import IPostMessage from '../IPostMessage';
 import { IStorageUnit, IFilePath, IFile, IHeaders, ICopyFileOptions, IMoveFileOptions } from './types';
 import StorageUnitsChangedMessage from './StorageUnitsChangedMessage';
 import IFileSystem from './IFileSystem';
+import { HashAlgorithm } from './HashAlgorithm';
+/**
+ * The `sos.fileSystem` API groups together methods for low-level access to the file system. The File System API supports both internal and
+ * external storage.
+ *
+ * :::warning
+ *
+ * File System directory structure is **PERSISTENT** and is **NOT** automatically deleted through `Applet Reload` power action!
+ * Applet Reload only deletes `/data` directory which is reserved for simplified [Offline Cache API](./offline). Use
+ * `deleteFile()` to clear the device storage file system.
+ *
+ * :::
+ */
 export default class FileSystem implements IFileSystem {
     private messagePrefix;
     private postMessage;
     static MESSAGE_PREFIX: string;
     private eventEmitter;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `listStorageUnits()` method lists all available storage units. All devices always have one internal storage device (with
+     * `removable: false`) and zero or more external devices. The capacity values are in bytes.
+     */
     listStorageUnits(): Promise<IStorageUnit[]>;
+    /**
+     * A shorthand method for listing only the internal storage units (i.e. those with the `removable: false`). The capacity values are in bytes.
+     */
+    listInternalStorageUnits(): Promise<IStorageUnit[]>;
+    /**
+     * The `onStorageUnitsChanged()` method sets up a listener, which is called whenever the list of storage units changes.
+     */
     onStorageUnitsChanged(listener: () => void): void;
+    /**
+     * The `removeStorageUnitsChangedListener()` method removes a listener, previously added by `onStorageUnitsChanged()`
+     */
     removeStorageUnitsChangedListener(listener: () => void): void;
+    /**
+     * The `removeAllListeners()` method removes all listeners, previously added by `removeAllListeners()`
+     */
     removeAllListeners(): void;
+    /**
+     * The `listFiles()` method lists all files and directories in the specified path (nested files are not included).
+     *
+     * @throws If the path does not exist or it is a file.
+     */
     listFiles(directoryPath: IFilePath): Promise<IFilePath[]>;
+    /**
+     * The `exists()` method checks whether a file or directory exists.
+     */
     exists(filePath: IFilePath): Promise<boolean>;
+    /**
+     * The `getFile()` method returns runtime information about a file path, such as local url, last modified date or size.
+     */
     getFile(filePath: IFilePath): Promise<IFile | null>;
+    /**
+     * The `writeFile()` method writes string content to the file specified by `filePath`. If the file does exist, it is created. If the directory
+     * does not exist, an error is thrown.
+     *
+     * @throws If the parent directory does not exist or the `filePath` is a directory.
+     */
     writeFile(filePath: IFilePath, contents: string): Promise<void>;
+    /**
+     * The `writeFile()` method appends string content to the file specified by `filePath`. If the file does exist, it is created. If the directory
+     * does not exist, an error is thrown.
+     *
+     * @throws If the parent directory does not exist or the `filePath` is a directory.
+     */
     appendFile(filePath: IFilePath, contents: string): Promise<void>;
+    /**
+     * The `readFile()` method returns content of the file specified by `filePath`. The file has to be a text file, otherwise the content will be
+     * mangled.
+     *
+     * @throws If the file does not exist.
+     */
     readFile(filePath: IFilePath): Promise<string>;
+    /**
+     * The `copyFile()` method creates a copy of file at `sourceFilePath` to `destinationFilePath`.
+     *
+     * @param options.overwrite If not set or set to `false`, an error will be thrown if `destinationFilePath` already exists.
+     *
+     * @throws If the source file does not exists or parent of the destination file path does not exists. It also throws if the
+     * `options.overwrite` is not set and the destination file path already exists.
+     */
     copyFile(sourceFilePath: IFilePath, destinationFilePath: IFilePath, options?: ICopyFileOptions): Promise<void>;
+    /**
+     * The `moveFile()` method moves a file from `sourceFilePath` to `destinationFilePath`.
+     *
+     * @throws If the source file does not exists or parent of the destination file path does not exists. It also throws if the
+     * `options.overwrite` is not set and the destination file path already exists.
+     */
     moveFile(sourceFilePath: IFilePath, destinationFilePath: IFilePath, options?: IMoveFileOptions): Promise<void>;
+    /**
+     * The `deleteFile()` method deletes the file specified by `filePath`. To remove a directory set `recursive` to `true`.
+     *
+     * @throws If the file does not exists or if `recursive` is set to false and the file path is a directory.
+     */
     deleteFile(filePath: IFilePath, recursive: boolean): Promise<void>;
+    /**
+     * The `downloadFile()` method download a file from `sourceUri` and saves it to the specified path. If the file already exists it is
+     * overwritten. Optionally, headers for the download request may be specified. A HEAD request is always sent first to get `content-length`
+     * of the downloaded file.
+     *
+     * :::warning
+     * - For every download request, our app makes HEAD request for `content-length` header on that downloaded file.
+     * - Windows platform can download only files smaller then 4GB.
+     * :::
+     *
+     * #### Encoding
+     *
+     * All downloads respect a standard of `Encoding` with optional compression of files. See [Mozilla standard Accept Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding) and [Content Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding).
+     *
+     * Download file method is always sending optional following headers:
+     * ```
+     * Accept-Encoding: gzip
+     * Accept-Encoding: compress
+     * Accept-Encoding: deflate
+     * Accept-Encoding: br
+     * Accept-Encoding: identity
+     * Accept-Encoding: *
+     * ```
+     *
+     * If the server understands the `Encoding` standard, it compresses files using `gzip` algorithm before the files are sent to the client. If so, the response will contain the following headers:
+     * ```
+     * Content-Encoding: gzip
+     * Content-Encoding: compress
+     * Content-Encoding: deflate
+     * Content-Encoding: br
+     * ```
+     * So the data communication is compressed under the hood. The client will automatically decompress data before it's saved to a specified location path. So from JS API point of view, there is no requirement to decompress data by itself.
+     *
+     * The standard is supported on all following platforms:
+     *
+     * - WebOS 3+
+     * - Tizen 2.4+
+     * - Brightsign
+     * - Raspberry Pi
+     * - Windows
+     *
+     * @throws If the network request fails, parent directory does not exist, or the file path is a directory.
+     */
     downloadFile(filePath: IFilePath, sourceUri: string, headers?: IHeaders): Promise<void>;
+    /**
+     * The `decompressFile()` method decompresses the file at `archiveFilePath` into a new file specified by `destinationDirectoryPath`.
+     *
+     * @throws If the archive file path does not exist, it is not a valid archive file or the destination directory does not exist.
+     */
     extractFile(archiveFilePath: IFilePath, destinationDirectoryPath: IFilePath, method: string): Promise<void>;
+    /**
+     * The `createArchive()` method creates an arch file at `archiveFilePath` from `archiveEntries` files.
+     *
+     * :::warning
+     *
+     * This function is available only on Tizen devices.
+     *
+     * :::
+     */
     createArchive(archiveFilePath: IFilePath, archiveEntries: IFilePath[]): Promise<void>;
-    getFileChecksum(filePath: IFilePath, hashType: string): Promise<string>;
+    /**
+     * The `getChecksumFile()` method computes a checksum of the file specified by `filePath`.
+     *
+     * @throws If the file does not exist or it is a directory.
+     */
+    getFileChecksum(filePath: IFilePath, hashType: HashAlgorithm): Promise<string>;
+    /**
+     * The `createDirectory()` method create a new directory at specified path.
+     *
+     * @throws If the directory already exists or its parent directory does not exist.
+     */
     createDirectory(directoryPath: IFilePath): Promise<void>;
+    /**
+     * The `isDirectory()` method checks whether the file path points to a directory.
+     *
+     * @throws If the file path does not exist.
+     */
     isDirectory(filePath: IFilePath): Promise<boolean>;
+    /**
+     * The `link()` method creates a symbolic link to `sourceFilePath` (existing path) from `destinationFilePath` (new path).
+     */
     link(sourceFilePath: IFilePath, destinationFilePath: IFilePath): Promise<void>;
+    /** @internal */
     handleMessageData(data: StorageUnitsChangedMessage): void;
     private getMessage;
 }