fiftyone.devicedetection.cloud 4.4.137 → 4.4.138

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.devicedetection.cloud",
-  "version": "4.4.137",
+  "version": "4.4.138",
   "description": "Device detection cloud services for the 51Degrees Pipeline API",
   "keywords": [
     "51degrees",
@@ -54,6 +54,6 @@
   },
   "files": [
     "*.js",
-    "*.ts"
+    "types"
   ]
 }

package/types/constants.d.ts

@@ -0,0 +1,2 @@
+export let EVIDENCE_QUERY_NATIVE_MODEL_KEY: string;
+export let EVIDENCE_QUERY_TAC_KEY: string;

package/types/deviceDetectionCloud.d.ts

@@ -0,0 +1,10 @@
+export = DeviceDetectionCloud;
+declare const DeviceDetectionCloud_base: typeof import("fiftyone.pipeline.cloudrequestengine/types/cloudEngine");
+/**
+ * The deviceDetction cloud engine requires the 51Degrees
+ * cloudRequestEngine to be placed in a pipeline before it.
+ * It takes that raw JSON response and parses it to extract the
+ * device part. It also uses this data to generate a list of properties
+ **/
+declare class DeviceDetectionCloud extends DeviceDetectionCloud_base {
+}

package/types/deviceDetectionCloudPipelineBuilder.d.ts

@@ -0,0 +1,35 @@
+export = DeviceDetectionCloudPipelineBuilder;
+declare const DeviceDetectionCloudPipelineBuilder_base: typeof import("fiftyone.pipeline.core/types/pipelineBuilder");
+/**
+ * Extension of pipelineBuilder class that allows for the quick
+ * generation of a device detection cloud pipeline. Adds share usage,
+ * caching.
+ */
+declare class DeviceDetectionCloudPipelineBuilder extends DeviceDetectionCloudPipelineBuilder_base {
+    /**
+     * Constructor for DeviceDetectionCloudPipelineBuilder
+     *
+     * @param {object} options the options for the pipeline builder
+     * @param {string} options.licenceKeys license key(s) used by the
+     * data file update service. A key can be obtained from the
+     * 51Degrees website: https://51degrees.com/pricing.
+     * This parameter MUST be set when using a data file.
+     * If you do not wish to use a key then you can specify
+     * an empty string, but this will cause automatic updates
+     * to be disabled.
+     * @param {string} options.resourceKey resourceKey
+     * @param {number} options.cacheSize size of the default cache
+     * (includes cache if set).
+     * @param {string} options.cloudEndPoint Choose a non default endpoint
+     * for the cloud request engine
+     * @param {string} options.cloudRequestOrigin The value to set the
+     * Origin header to when making requests to the cloud service
+     */
+    constructor({ licenceKeys, resourceKey, cacheSize, cloudEndPoint, cloudRequestOrigin }: {
+        licenceKeys: string;
+        resourceKey: string;
+        cacheSize: number;
+        cloudEndPoint: string;
+        cloudRequestOrigin: string;
+    }, ...args: any[]);
+}

package/types/hardwareProfileCloudEngine.d.ts

@@ -0,0 +1,19 @@
+export = HardwareProfileCloudEngine;
+declare const HardwareProfileCloudEngine_base: typeof import("fiftyone.pipeline.cloudrequestengine/types/cloudEngine");
+/**
+ * This Cloud Aspect Engine enables the parsing of 'hardware profile'
+ * responses from the 51Degrees cloud service.
+ */
+declare class HardwareProfileCloudEngine extends HardwareProfileCloudEngine_base {
+    /**
+     * Process internal FlowData cloud data for devices,
+     * set them as FlowData elements
+     *
+     * @param {FlowData} flowData The FlowData object
+     */
+    processInternal(flowData: FlowData): void;
+}
+declare namespace HardwareProfileCloudEngine {
+    export { FlowData };
+}
+type FlowData = import("fiftyone.pipeline.core/types/flowData");

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export let DeviceDetectionCloud: typeof import("./deviceDetectionCloud");
+export let DeviceDetectionCloudPipelineBuilder: typeof import("./deviceDetectionCloudPipelineBuilder");
+export let HardwareProfileCloudEngine: typeof import("../fiftyone.devicedetection.cloud/hardwareProfileCloudEngine");