fiftyone.devicedetection.shared 4.4.136 → 4.4.138

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.devicedetection.shared",
-  "version": "4.4.136",
+  "version": "4.4.138",
   "description": "Shared functionality for implementing device detection engine for the 51Degrees Pipeline API",
   "keywords": [
     "51degrees",
@@ -28,7 +28,8 @@
   },
   "author": "51Degrees Engineering <engineering@51degrees.com>",
   "devDependencies": {
-    "jest": "^28.1.0",
+    "@types/jest": "^28.1.8",
+    "jest": "^28.1.3",
     "jest-junit": "^13.2.0"
   },
   "license": "EUPL-1.2",
@@ -38,6 +39,7 @@
   "files": [
     "examples",
     "tests",
-    "*.js"
+    "*.js",
+    "types"
   ]
 }

package/types/errorMessages.d.ts

@@ -0,0 +1,13 @@
+export let cacheNotSupport: string;
+export let evidenceNotFound: string;
+export let dataFilePathRequired: string;
+export let fileNotFound: string;
+export let moduleDirNotFound: string;
+export let nativeModuleNotFound: string;
+export let invalidFileExtension: string;
+export let licenseKeyRequired: string;
+export let invalidPerformanceProfile: string;
+export let propertyKeyDataFiles: string;
+export let propertyNotFound: string;
+export let badDataUnsupportedVersion: string;
+export let badDataIncorrectFormat: string;

package/types/examples/dataExtension.d.ts

@@ -0,0 +1,11 @@
+export = DataExtension;
+declare class DataExtension {
+    /**
+     * Helper function to read property values from flowData
+     *
+     * @param {object} elementData Element data
+     * @param {string} propertyName Property name
+     * @returns {string} result string, either property value or error
+     * */
+    static getValueHelper(elementData: object, propertyName: string): string;
+}

package/types/examples/exampleConstants.d.ts

@@ -0,0 +1,7 @@
+export let defaultEvidenceValues: Map<string, string>[];
+export namespace fileNames {
+    let enterpriseDataFileName: string;
+    let liteDataFileName: string;
+    let uaFileName: string;
+    let evidenceFileName: string;
+}

package/types/examples/optionsExtension.d.ts

@@ -0,0 +1,46 @@
+export = OptionsExtension;
+declare class OptionsExtension {
+    /**
+     * Get element by name
+     *
+     * @param {object} options Options
+     * @param {string} elementName Element name
+     * @returns {object} Element
+     */
+    static getElement(options: object, elementName: string): object;
+    /**
+     * Get Datafile path
+     *
+     * @param {object} options Options
+     * @returns {string} Datafile path
+     */
+    static getDataFilePath(options: object): string;
+    /**
+     * Set Datafile path
+     *
+     * @param {object} options Options
+     * @param {string} newDataFilePath New Datafile path
+     */
+    static setDataFilePath(options: object, newDataFilePath: string): void;
+    /**
+     * Update Element path
+     *
+     * @param {object} options Options
+     * @param {string} appendDir New element path
+     */
+    static updateElementPath(options: object, appendDir: string): void;
+    /**
+     * Get resource Key
+     *
+     * @param {object} options Options
+     * @returns {string} Resource key
+     */
+    static getResourceKey(options: object): string;
+    /**
+     * Set resource key
+     *
+     * @param {object} options Options
+     * @param {string} resourceKey New resource key
+     */
+    static setResourceKey(options: object, resourceKey: string): void;
+}

package/types/index.d.ts

@@ -0,0 +1,47 @@
+export let errorMessages: {
+    cacheNotSupport: string;
+    evidenceNotFound: string;
+    dataFilePathRequired: string;
+    fileNotFound: string;
+    moduleDirNotFound: string;
+    nativeModuleNotFound: string;
+    invalidFileExtension: string;
+    licenseKeyRequired: string;
+    invalidPerformanceProfile: string;
+    propertyKeyDataFiles: string;
+    propertyNotFound: string;
+    badDataUnsupportedVersion: string;
+    badDataIncorrectFormat: string;
+};
+export let testConstants: {
+    envVars: {
+        superResourceKeyEnvVar: string;
+        platformResourceKeyEnvVar: string;
+        hardwareResourceKeyEnvVar: string;
+        browserResourceKeyEnvVar: string;
+        noSetHeaderResourceKeyEnvVar: string;
+        licenseKeyEnvVar: string;
+    };
+    userAgents: {
+        chromeUA: string;
+        edgeUA: string;
+        firefoxUA: string;
+        safariUA: string;
+        curlUA: string;
+    };
+};
+export let keyUtils: {
+    getNamedKey: (keyName: string) => string;
+    isInvalidKey: (keyValue: string) => boolean;
+};
+export let exampleConstants: {
+    defaultEvidenceValues: Map<string, string>[];
+    fileNames: {
+        enterpriseDataFileName: string;
+        liteDataFileName: string;
+        uaFileName: string;
+        evidenceFileName: string;
+    };
+};
+export let optionsExtension: typeof import("./examples/optionsExtension");
+export let dataExtension: typeof import("./examples/dataExtension");

package/types/tests/keyUtils.d.ts

@@ -0,0 +1,2 @@
+export function getNamedKey(keyName: string): string;
+export function isInvalidKey(keyValue: string): boolean;

package/types/tests/testConstants.d.ts

@@ -0,0 +1,15 @@
+export namespace envVars {
+    let superResourceKeyEnvVar: string;
+    let platformResourceKeyEnvVar: string;
+    let hardwareResourceKeyEnvVar: string;
+    let browserResourceKeyEnvVar: string;
+    let noSetHeaderResourceKeyEnvVar: string;
+    let licenseKeyEnvVar: string;
+}
+export namespace userAgents {
+    let chromeUA: string;
+    let edgeUA: string;
+    let firefoxUA: string;
+    let safariUA: string;
+    let curlUA: string;
+}