fiftyone.pipeline.cloudrequestengine 4.4.98 → 4.4.100

package/cloudEngine.js

@@ -1,23 +1,23 @@
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 const engines = require('fiftyone.pipeline.engines');
@@ -27,6 +27,13 @@ const AspectDataDictionary = engines.AspectDataDictionary;
 const AspectPropertyValue = core.AspectPropertyValue;
 const BasicListEvidenceKeyFilter = core.BasicListEvidenceKeyFilter;
 
+/**
+ * @typedef {import('fiftyone.pipeline.core').Pipeline} Pipeline
+ * @typedef {import('fiftyone.pipeline.core').FlowElement} FlowElement
+ * @typedef {import('fiftyone.pipeline.core').FlowData} FlowData
+ * @typedef {import('./cloudRequestEngine')} CloudRequestEngine
+ */
+
 /**
  * This is a template for all 51Degrees cloud engines.
  * It requires the 51Degrees cloudRequestEngine to be placed in a
@@ -57,7 +64,9 @@ class CloudEngine extends Engine {
     if (!pipeline.flowElements.cloud) {
       pipeline.log('error', 'No CloudRequestEngine in Pipeline');
     }
-
+    /**
+     * @type {CloudRequestEngine}
+     */
     this._cloudRequestEngine = pipeline.flowElements.cloud;
     this._flowElement = flowElement;
   }
@@ -99,7 +108,7 @@ class CloudEngine extends Engine {
    * Internal process method for all cloud engines
    *
    * @param {FlowData} flowData FlowData to process
-   * @returns {void}
+   * @returns {Promise<void> | void} Completion promise
    */
   processInternal (flowData) {
     const engine = this;
@@ -114,10 +123,9 @@ class CloudEngine extends Engine {
         flowData.pipeline.log('error', engine.dataKey + ' not populated. ' +
         cloudData[engine.dataKey + 'nullreason'] !== null
           ? cloudData[engine.dataKey + 'nullreason']
-          : '' +
-        '\n' + 'This may be because the provided API key is not authorised for ' + engine.dataKey + ' queries.');
+          : '\nThis may be because the provided API key is not authorised for ' + engine.dataKey + ' queries.');
       } else {
-      // Loop over cloudData.device properties to check if they have a value
+        // Loop over cloudData.device properties to check if they have a value
         Object.entries(cloudData[engine.dataKey]).forEach(function ([key, value]) {
           result[key] = new AspectPropertyValue();
 

package/cloudRequestEngine.js

@@ -1,23 +1,23 @@
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 const util = require('util');
@@ -33,6 +33,7 @@ const CloudRequestError = require('./cloudRequestError');
 
 /**
  * @typedef {import('fiftyone.pipeline.core').FlowData} FlowData
+ * @typedef {import('fiftyone.pipeline.core').Evidence} Evidence
  */
 
 // Engine that makes a call to the 51Degrees cloud service
@@ -195,7 +196,7 @@ class CloudRequestEngine extends Engine {
   /**
    * Used to handle errors from http requests
    *
-   * @param {http.ServerResponse} response Responce to get errors from
+   * @param {import('http').ServerResponse} response Responce to get errors from
    * @returns {Array<CloudRequestError>} Array of CloudRequestError from response
    */
   getErrorsFromResponse (response) {
@@ -216,7 +217,7 @@ class CloudRequestEngine extends Engine {
     if (cloudErrors.length === 0 &&
       response.statusCode > 299) {
       const message = 'Cloud service returned status code ' +
-          response.statusCode + ' with content ' + content + '.';
+        response.statusCode + ' with content ' + content + '.';
       cloudErrors.push(new CloudRequestError(
         message,
         response.headers,
@@ -229,7 +230,7 @@ class CloudRequestEngine extends Engine {
   /**
    * Internal process to fetch all the properties available under a resourcekey
    *
-   * @returns {Promise} properties from the cloud server
+   * @returns {Promise<object>} properties from the cloud server
    */
   fetchProperties () {
     const engine = this;
@@ -266,6 +267,12 @@ class CloudRequestEngine extends Engine {
     });
   }
 
+  /**
+   * Properties transform
+   *
+   * @param {object} properties properties to transform
+   * @returns {object} transformed properties
+   */
   propertiesTransform (properties) {
     const result = {};
     const self = this;
@@ -285,6 +292,13 @@ class CloudRequestEngine extends Engine {
     return result;
   }
 
+  /**
+   * Meta property transform
+   *
+   * @param {string} key key to check
+   * @param {object} value properties to transform
+   * @returns {object} transformed properties
+   */
   metaPropertyTransform (key, value) {
     switch (key) {
       case 'itemproperties':
@@ -342,7 +356,7 @@ class CloudRequestEngine extends Engine {
   /**
    * Internal function to get evidenceKeys used by cloud resourcekey
    *
-   * @returns {Array} evidence key list
+   * @returns {Promise} evidence promise
    */
   getEvidenceKeys () {
     const engine = this;
@@ -371,7 +385,7 @@ class CloudRequestEngine extends Engine {
    * this is unexpected so a warning will be logged.
    *
    * @param {FlowData} flowData FlowData to get evidence from
-   * @returns {Evidence} Evidence Dictionary
+   * @returns {object} Evidence Dictionary
    */
   getContent (flowData) {
     const queryData = {};
@@ -448,7 +462,7 @@ class CloudRequestEngine extends Engine {
    * Get evidence with specified prefix.
    *
    * @param {Evidence} evidence All evidence in the flow data.
-   * @param {stirng} type Required evidence key prefix
+   * @param {string} type Required evidence key prefix
    * @returns {Evidence} Selected evidence
    */
   getSelectedEvidence (evidence, type) {
@@ -457,8 +471,8 @@ class CloudRequestEngine extends Engine {
     if (type === 'other') {
       for (const [key, value] of Object.entries(evidence)) {
         if (this.hasKeyPrefix(key, 'query') === false &&
-            this.hasKeyPrefix(key, 'header') === false &&
-            this.hasKeyPrefix(key, 'cookie') === false) {
+          this.hasKeyPrefix(key, 'header') === false &&
+          this.hasKeyPrefix(key, 'cookie') === false) {
           selectedEvidence[key] = value;
         }
       }

package/cloudRequestError.js

@@ -18,20 +18,27 @@
  * including the attribution notice(s) required under Article 5 of the EUPL
  * in the end user terms of the application under an appropriate heading,
  * such notice(s) shall fulfill the requirements of that article.
- * ********************************************************************* */
-
-class CloudRequestError extends Error {
-  constructor (message, responseHeaders, httpStatusCode) {
-    super(message);
-    this.name = this.constructor.name;
-    this.errorMessage = message;
-    this.responseHeaders = responseHeaders;
-    this.httpStatusCode = httpStatusCode;
-    // This clips the constructor invocation from the stack trace.
-    // It's not absolutely essential, but it does make the stack
-    // trace a little nicer.
-    Error.captureStackTrace(this, this.constructor);
-  }
-}
-
-module.exports = CloudRequestError;
+ * ********************************************************************* */
+
+class CloudRequestError extends Error {
+  /**
+   * Constructor for Cloud Request Error
+   *
+   * @param {string} message error message
+   * @param {*} responseHeaders response headers
+   * @param {number} httpStatusCode http status code
+   */
+  constructor (message, responseHeaders, httpStatusCode) {
+    super(message);
+    this.name = this.constructor.name;
+    this.errorMessage = message;
+    this.responseHeaders = responseHeaders;
+    this.httpStatusCode = httpStatusCode;
+    // This clips the constructor invocation from the stack trace.
+    // It's not absolutely essential, but it does make the stack
+    // trace a little nicer.
+    Error.captureStackTrace(this, this.constructor);
+  }
+}
+
+module.exports = CloudRequestError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.pipeline.cloudrequestengine",
-  "version": "4.4.98",
+  "version": "4.4.100",
   "description": "Cloud request engine for the 51Degrees Pipeline API",
   "keywords": [
     "51degrees",
@@ -10,6 +10,7 @@
     "cloud"
   ],
   "main": "index.js",
+  "types": "types/index.d.ts",
   "directories": {
     "test": "tests"
   },

package/readme.md

@@ -8,18 +8,33 @@ The 51Degrees Pipeline API is a generic web request intelligence and data proces
 
 ## This package - fiftyone.pipeline.cloudrequestengine
 
-This package uses the `engines` class created by the `fiftyone.pipeline.engines`. It makes available:
+This package uses the `engines` class created by the [`fiftyone.pipeline.engines`](/fiftyone.pipeline.engines#readme.md). It makes available:
 
 * A `Cloud Request Engine` which calls the 51Degrees cloud service to fetch properties and metadata about them based on a provided resource key. Get a resource key at https://configure.51degrees.com/
 * A `Cloud Engine` template which reads data from the Cloud Request Engine.
 
 It is used by the cloud versions of the following 51Degrees engines:
 
-- **fiftyone.devicedetection** - A device detection engine
-- **fiftyone.location** - A geolocation lookup engine
+- [**fiftyone.devicedetection**](https://github.com/51Degrees/device-detection-node#readme) - A device detection engine
+- [**fiftyone.geolocation**](https://github.com/51Degrees/location-node#readme) - A geolocation lookup engine
 
 ## Installation
 
 ```
 npm install fiftyone.pipeline.cloudrequestengine
 ```
+
+## Tests
+
+To run tests you will need to install the `jest` library.
+
+```
+npm install jest --global
+```
+
+Then, navigate to the module directory and execute:
+
+```
+npm test
+```
+

package/requestClient.js

@@ -24,9 +24,9 @@ class RequestClient {
   /**
    * Make a POST request to the specified url
    *
-   * @param {*} url The url to send a request to
-   * @param {*} data The data to send in the body of the request
-   * @param {*} origin The value to use for the Origin header when
+   * @param {string} url The url to send a request to
+   * @param {object | null} data The data to send in the body of the request
+   * @param {string | null} origin The value to use for the Origin header when
    * making the request
    * @returns {Promise} The resolve function will be passed the content
    * from the response and the reject function will be passed
@@ -100,8 +100,8 @@ class RequestClient {
   /**
    * Make a GET request to the specified url
    *
-   * @param {*} url The url to send a request to
-   * @param {*} origin The value to use for the Origin header when
+   * @param {string} url The url to send a request to
+   * @param {string | null} origin The value to use for the Origin header when
    * making the request
    * @returns {Promise} The resolve function will be passed the content
    * from the response and the reject function will be passed

package/tsconfig.json

@@ -1,21 +1,22 @@
 {
-    // Change this to match your project
-    "include": ["*"],
-    "compilerOptions": {
-      // Tells TypeScript to read JS files, as
-      // normally they are ignored as source files
-      "allowJs": true,
-      // Generate d.ts files
-      "declaration": true,
-      // This compiler run should
-      // only output d.ts files
-      "emitDeclarationOnly": true,
-      // Types should go into this directory.
-      // Removing this would place the .d.ts files
-      // next to the .js files
-      "outDir": "types",
-      "lib": ["ES2015"],
-      "moduleResolution": "Node",
-      "noImplicitAny": true
-    }
-  }
+  // Change this to match your project
+  "include": ["*"],
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    // Tells TypeScript to read JS files, as
+    // normally they are ignored as source files
+    "allowJs": true,
+    // Generate d.ts files
+    "declaration": true,
+    // This compiler run should
+    // only output d.ts files
+    "emitDeclarationOnly": true,
+    // Types should go into this directory.
+    // Removing this would place the .d.ts files
+    // next to the .js files
+    "outDir": "types",
+    "lib": ["ES2015"],
+    "moduleResolution": "Node",
+    "noImplicitAny": true
+  }
+}

package/types/cloudEngine.d.ts

@@ -1,5 +1,11 @@
 export = CloudEngine;
 declare const CloudEngine_base: typeof import("fiftyone.pipeline.engines/types/engine");
+/**
+ * @typedef {import('fiftyone.pipeline.core').Pipeline} Pipeline
+ * @typedef {import('fiftyone.pipeline.core').FlowElement} FlowElement
+ * @typedef {import('fiftyone.pipeline.core').FlowData} FlowData
+ * @typedef {import('./cloudRequestEngine')} CloudRequestEngine
+ */
 /**
  * This is a template for all 51Degrees cloud engines.
  * It requires the 51Degrees cloudRequestEngine to be placed in a
@@ -9,4 +15,42 @@ declare const CloudEngine_base: typeof import("fiftyone.pipeline.engines/types/e
  **/
 declare class CloudEngine extends CloudEngine_base {
     constructor(...args: any[]);
+    /**
+     * Handles the registration of the Cloud Engine in a pipeline.
+     * This method is called when a pipeline is registered,
+     * and it ensures that the CloudRequestEngine is present in the pipeline.
+     *
+     * @param {Pipeline} pipeline - The pipeline being registered.
+     * @param {FlowElement} flowElement - The flow element associated with the Cloud Engine.
+     */
+    handlePipelineRegistration(pipeline: Pipeline, flowElement: FlowElement): void;
+    /**
+     * @type {CloudRequestEngine}
+     */
+    _cloudRequestEngine: CloudRequestEngine;
+    _flowElement: import("fiftyone.pipeline.core/types/flowElement");
+    /**
+     * Updates the Cloud Engine when the CloudRequestEngine is ready.
+     * This method fetches properties and evidence keys from the CloudRequestEngine,
+     * updating the Cloud Engine accordingly.
+     *
+     * @param {Function} resolve - Callback to be called on successful completion.
+     * @param {Function} reject - Callback to be called if there is an error.
+     */
+    updateEngineWhenCloudRequestEngineReady(resolve: Function, reject: Function): void;
+    errors: any;
+    /**
+     * Internal process method for all cloud engines
+     *
+     * @param {FlowData} flowData FlowData to process
+     * @returns {Promise<void> | void} Completion promise
+     */
+    processInternal(flowData: FlowData): Promise<void> | void;
+}
+declare namespace CloudEngine {
+    export { Pipeline, FlowElement, FlowData, CloudRequestEngine };
 }
+type Pipeline = import("fiftyone.pipeline.core/types/pipeline");
+type FlowElement = import("fiftyone.pipeline.core/types/flowElement");
+type FlowData = import("fiftyone.pipeline.core/types/flowData");
+type CloudRequestEngine = import("./cloudRequestEngine");

package/types/cloudRequestEngine.d.ts

@@ -2,6 +2,7 @@ export = CloudRequestEngine;
 declare const CloudRequestEngine_base: typeof import("fiftyone.pipeline.engines/types/engine");
 /**
  * @typedef {import('fiftyone.pipeline.core').FlowData} FlowData
+ * @typedef {import('fiftyone.pipeline.core').Evidence} Evidence
  */
 declare class CloudRequestEngine extends CloudRequestEngine_base {
     /**
@@ -12,23 +13,95 @@ declare class CloudRequestEngine extends CloudRequestEngine_base {
      * @param {string} options.licenseKey licensekey for cloud service
      * @param {string} options.baseURL url the cloud service is located at
      * if overriding default
+     * @param {string} options.cloudRequestOrigin The value to set for the Origin
+     * header when making requests to the cloud service.
+     * This is used by the cloud service to check that the request is being
+     * made from a origin matching those allowed by the resource key.
+     * For more detail, see the 'Request Headers' section in the
+     * <a href="https://cloud.51degrees.com/api-docs/index.html">cloud documentation</a>.
+     * @param {RequestClient} options.requestClient Set predefined RequestClient.
      */
-    constructor({ resourceKey, licenseKey, baseURL }: {
+    constructor({ resourceKey, licenseKey, baseURL, cloudRequestOrigin, requestClient }: {
         resourceKey: string;
         licenseKey: string;
         baseURL: string;
+        cloudRequestOrigin: string;
+        requestClient: RequestClient;
     }, ...args: any[]);
     resourceKey: string;
     licenseKey: string;
+    cloudRequestOrigin: string;
+    requestClient: RequestClient;
     baseURL: string;
     evidenceKeys: any[];
     flowElementProperties: {};
+    /**
+     * Check if the keys and properties have been fetched.
+     *
+     * This computed property determines whether the keys of a 'flowElementProperties' object and the 'evidenceKeyFilter'
+     * array both have elements, indicating that the necessary data has been fetched and is ready for use.
+     *
+     * @returns {boolean} True if the keys and properties are fetched and ready; otherwise, false.
+     */
+    get keysAndPropertiesFetched(): boolean;
+    /**
+     * Fetches evidence keys and properties data.
+     *
+     * This method asynchronously fetches evidence keys and properties required for the operation.
+     * It uses Promises to handle data retrieval and provides callback functions for success and failure scenarios.
+     *
+     * @param {Function} resolveCallback - A callback function to be called when the data is successfully fetched.
+     * It will receive the current instance as a parameter.
+     *
+     * @param {Function} rejectCallback - A callback function to be called when an error occurs during data retrieval.
+     * It will receive the error information as a parameter.
+     */
+    fetchEvidenceKeysAndProperties(resolveCallback: Function, rejectCallback: Function): void;
+    /**
+     * Internal process for cloud engine
+     * Returns raw JSON as a "cloud" property in "cloud"
+     *
+     * @param {FlowData} flowData flowData to process
+     * @returns {Promise} data from cloud service
+     */
+    processInternal(flowData: FlowData): Promise<any>;
+    /**
+     * Typically, cloud will return errors as JSON.
+     * However, transport level errors or other failures can result in
+     * responses that are plain text. This function handles these cases.
+     *
+     * @param {string} responseBody the response data to process
+     * @returns {Array} The error messages
+     */
+    getErrorMessages(responseBody: string): any[];
+    /**
+     * Used to handle errors from http requests
+     *
+     * @param {import('http').ServerResponse} response Responce to get errors from
+     * @returns {Array<CloudRequestError>} Array of CloudRequestError from response
+     */
+    getErrorsFromResponse(response: import("http").ServerResponse): Array<CloudRequestError>;
     /**
      * Internal process to fetch all the properties available under a resourcekey
      *
-     * @returns {Promise} properties from the cloud server
+     * @returns {Promise<object>} properties from the cloud server
      */
-    fetchProperties(): Promise<any>;
+    fetchProperties(): Promise<object>;
+    /**
+     * Properties transform
+     *
+     * @param {object} properties properties to transform
+     * @returns {object} transformed properties
+     */
+    propertiesTransform(properties: object): object;
+    /**
+     * Meta property transform
+     *
+     * @param {string} key key to check
+     * @param {object} value properties to transform
+     * @returns {object} transformed properties
+     */
+    metaPropertyTransform(key: string, value: object): object;
     /**
      * Internal function to get data from cloud service
      *
@@ -41,11 +114,53 @@ declare class CloudRequestEngine extends CloudRequestEngine_base {
     /**
      * Internal function to get evidenceKeys used by cloud resourcekey
      *
-     * @returns {Array} evidence key list
+     * @returns {Promise} evidence promise
+     */
+    getEvidenceKeys(): Promise<any>;
+    /**
+     * Generate the Content to send in the POST request. The evidence keys
+     * e.g. 'query.' and 'header.' have an order of precedence. These are
+     * added to the evidence in reverse order, if there is conflict then
+     * the queryData value is overwritten.
+     * 'query.' evidence should take precedence over all other evidence.
+     * If there are evidence keys other than 'query.' that conflict then
+     * this is unexpected so a warning will be logged.
+     *
+     * @param {FlowData} flowData FlowData to get evidence from
+     * @returns {object} Evidence Dictionary
+     */
+    getContent(flowData: FlowData): object;
+    /**
+     * Add query data to the evidence.
+     *
+     * @param {FlowData} flowData FlowData for logging
+     * @param {object} queryData The destination dictionary to add query data to.
+     * @param {Evidence} allEvidence All evidence in the flow data. This is used to
+     * report which evidence keys are conflicting.
+     * @param {object} evidence Evidence to add to the query Data.
+     */
+    addQueryData(flowData: FlowData, queryData: object, allEvidence: Evidence, evidence: object): void;
+    /**
+     * Get evidence with specified prefix.
+     *
+     * @param {Evidence} evidence All evidence in the flow data.
+     * @param {string} type Required evidence key prefix
+     * @returns {Evidence} Selected evidence
+     */
+    getSelectedEvidence(evidence: Evidence, type: string): Evidence;
+    /**
+     * Check that the key of a KeyValuePair has the given prefix.
+     *
+     * @param {string} itemKey Key to check
+     * @param {string} prefix The prefix to check for.
+     * @returns {boolean} True if the key has the prefix.
      */
-    getEvidenceKeys(): any[];
+    hasKeyPrefix(itemKey: string, prefix: string): boolean;
 }
 declare namespace CloudRequestEngine {
-    export { FlowData };
+    export { FlowData, Evidence };
 }
+import RequestClient = require("./requestClient");
+import CloudRequestError = require("./cloudRequestError");
 type FlowData = import("fiftyone.pipeline.core/types/flowData");
+type Evidence = import("fiftyone.pipeline.core/types/evidence");

package/types/cloudRequestError.d.ts

@@ -0,0 +1,14 @@
+export = CloudRequestError;
+declare class CloudRequestError extends Error {
+    /**
+     * Constructor for Cloud Request Error
+     *
+     * @param {string} message error message
+     * @param {*} responseHeaders response headers
+     * @param {number} httpStatusCode http status code
+     */
+    constructor(message: string, responseHeaders: any, httpStatusCode: number);
+    errorMessage: string;
+    responseHeaders: any;
+    httpStatusCode: number;
+}

package/types/errorMessages.d.ts

@@ -0,0 +1 @@
+export let evidenceConflict: string;

package/types/index.d.ts

@@ -1,2 +1,2 @@
-export const CloudRequestEngine: typeof import("./cloudRequestEngine");
-export const CloudEngine: typeof import("./cloudEngine");
+export let CloudRequestEngine: typeof import("./cloudRequestEngine");
+export let CloudEngine: typeof import("./cloudEngine");

package/types/requestClient.d.ts

@@ -0,0 +1,32 @@
+export = RequestClient;
+declare class RequestClient {
+    /**
+     * Make a POST request to the specified url
+     *
+     * @param {string} url The url to send a request to
+     * @param {object | null} data The data to send in the body of the request
+     * @param {string | null} origin The value to use for the Origin header when
+     * making the request
+     * @returns {Promise} The resolve function will be passed the content
+     * from the response and the reject function will be passed
+     * an object with 3 properties:
+     * headers = HTTP headers in the response
+     * statusCode = HTTP status code of response
+     * content = The content of the response or an error message
+     */
+    post(url: string, data: object | null, origin: string | null): Promise<any>;
+    /**
+     * Make a GET request to the specified url
+     *
+     * @param {string} url The url to send a request to
+     * @param {string | null} origin The value to use for the Origin header when
+     * making the request
+     * @returns {Promise} The resolve function will be passed the content
+     * from the response and the reject function will be passed
+     * an object with 3 properties:
+     * headers = HTTP headers in the response
+     * statusCode = HTTP status code of response
+     * content = The content of the response or an error message
+     */
+    get(url: string, origin: string | null): Promise<any>;
+}

package/types/sharedValues.d.ts

@@ -1 +1 @@
-export const baseURLDefault: string;
+export let baseURLDefault: string;