fiftyone.geolocation 4.4.45 → 4.4.47

package/ci/generate-types.ps1

@@ -0,0 +1,8 @@
+param (
+    [Parameter(Mandatory=$true)]
+    [string]$RepoName
+)
+
+./node/generate-types.ps1 -RepoName $RepoName
+
+exit $LASTEXITCODE

package/examples/webIntegration.js

@@ -87,7 +87,7 @@ if (myResourceKey.substring(0, 2) === '!!') {
 
         let output = '';
 
-        var data = flowData.location;
+        const data = flowData.location;
         console.log(data);
         // Print results of client side processing to the page.
         output += `<h2>Example</h2>

package/geoLocationCloud.js

@@ -18,21 +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.
- * ********************************************************************* */
-
-const CloudEngine = require('fiftyone.pipeline.cloudrequestengine').CloudEngine;
-
-class GeoLocationCloud extends CloudEngine {
-  constructor ({ locationProvider }) {
-    super(...arguments);
-    if (locationProvider === 'fiftyonedegrees') {
-      this.dataKey = 'location';
-    } else if (locationProvider === 'digitalelement') {
-      this.dataKey = 'location_digitalelement';
-    } else {
-      throw "The location provider '" + locationProvider + "' was not recognized.";
-    }
-  }
-}
-
-module.exports = GeoLocationCloud;
+ * ********************************************************************* */
+
+const CloudEngine = require('fiftyone.pipeline.cloudrequestengine').CloudEngine;
+
+class GeoLocationCloud extends CloudEngine {
+  /**
+   * Constructor for GeoLocationCloud
+   *
+   * @param {object} options the options for GeoLocationCloud
+   * @param {string} options.locationProvider name of location provider
+   */
+  constructor ({ locationProvider }) {
+    super(...arguments);
+    if (locationProvider === 'fiftyonedegrees') {
+      this.dataKey = 'location';
+    } else if (locationProvider === 'digitalelement') {
+      this.dataKey = 'location_digitalelement';
+    } else {
+      throw "The location provider '" + locationProvider + "' was not recognized.";
+    }
+  }
+}
+
+module.exports = GeoLocationCloud;

package/geoLocationPipelineBuilder.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 GeoLocationCloud = require('./geoLocationCloud');
@@ -34,6 +34,7 @@ class GeoLocationPipelineBuilder extends PipelineBuilder {
      * @param {String} options.locationProvider // the provider to request data from. Either "fiftyonedegrees" or "digitalelement".
      * @param {string} options.cloudRequestOrigin The value to set the
      * Origin header to when making requests to the cloud service
+     * @param {string} options.baseURL base URL for cloud request
      *
     */
   constructor ({
@@ -54,8 +55,8 @@ class GeoLocationPipelineBuilder extends PipelineBuilder {
     // First we need the cloudRequestEngine
 
     const cloudRequestEngineOptions = {
-      resourceKey: resourceKey,
-      cloudRequestOrigin: cloudRequestOrigin
+      resourceKey,
+      cloudRequestOrigin
     };
     if (baseURL !== null) {
       cloudRequestEngineOptions.baseURL = baseURL;
@@ -65,7 +66,7 @@ class GeoLocationPipelineBuilder extends PipelineBuilder {
 
     // Then add the cloud geo-location engine
 
-    this.flowElements.push(new GeoLocationCloud({ locationProvider: locationProvider }));
+    this.flowElements.push(new GeoLocationCloud({ locationProvider }));
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.geolocation",
-  "version": "4.4.45",
+  "version": "4.4.47",
   "description": "Perform reverse geocoding using longitude and latitude to populate postal addresses",
   "keywords": [
     "51Degrees",
@@ -17,7 +17,8 @@
   },
   "scripts": {
     "test": "jest --ci --reporters=jest-junit --reporters=default --coverage --coverageReporters=cobertura",
-    "lint": "eslint . --ext .js"
+    "lint": "eslint . --ext .js",
+    "tsc": "tsc -b --force"
   },
   "author": "51Degrees Engineering <engineering@51degrees.com>",
   "dependencies": {
@@ -31,14 +32,15 @@
     "eslint": "8.57.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^23.13.2",
     "eslint-plugin-jsdoc": "^38.1.6",
+    "eslint-plugin-n": "^15.0.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.0.0",
-    "eslint-plugin-jest": "^23.13.2",
-    "eslint-plugin-n": "^15.0.0",
     "jest": "^27.5.1",
     "jest-expect-message": "^1.1.3",
-    "jest-junit": "^9.0.0"
+    "jest-junit": "^9.0.0",
+    "typescript": "^5.4.5"
   },
   "license": "EUPL-1.2",
   "bugs": {

package/tests/geoLocationCloud.test.js

@@ -103,7 +103,7 @@ if (isAsync) {
       resourceKey: myResourceKey,
       locationProvider: 'fiftyonedegrees'
     }).build();
-    var engine = pipeline.flowElements.location;
+    const engine = pipeline.flowElements.location;
 
     await testAvailableProperties(done, pipeline, engine);
   });
@@ -117,7 +117,7 @@ if (isAsync) {
       resourceKey: myResourceKey,
       locationProvider: 'fiftyonedegrees'
     }).build();
-    var engine = pipeline.flowElements.location;
+    const engine = pipeline.flowElements.location;
 
     await testValueTypes(done, pipeline, engine);
   });
@@ -136,7 +136,7 @@ async function testAvailableProperties (done, pipeline, engine) {
 
   expectedProperties[engine.dataKey].forEach(key => {
     try {
-      var apv = flowData[engine.dataKey][key];
+      const apv = flowData[engine.dataKey][key];
       if (apv === undefined) {
         done.fail(new Error(`Aspect property value for ${key} should not be undefined.`));
       }
@@ -168,9 +168,9 @@ async function testValueTypes (done, pipeline, engine) {
 
   Object.keys(engine.properties).forEach(key => {
     if (expectedProperties[engine.dataKey].includes(key)) {
-      var property = engine.properties[key.toLowerCase()];
-      var expectedType = property.type;
-      var apv = flowData[engine.dataKey][key];
+      const property = engine.properties[key.toLowerCase()];
+      const expectedType = property.type;
+      const apv = flowData[engine.dataKey][key];
 
       expect(apv).not.toBeNull();
       expect(apv).toBeDefined();
@@ -185,8 +185,8 @@ async function testValueTypes (done, pipeline, engine) {
 expect.extend({
   // Method to validate a given value has the expected type.
   toBe51DType (received, name, fodType) {
-    var valueType = typeof received;
-    var valid = false;
+    const valueType = typeof received;
+    let valid = false;
 
     switch (fodType) {
       case 'Boolean':

package/types/geoLocationCloud.d.ts

@@ -1,7 +1,13 @@
 export = GeoLocationCloud;
-declare const GeoLocationCloud_base: typeof import("fiftyone.pipeline.cloudrequestengine/types/cloudEngine");
-declare class GeoLocationCloud extends GeoLocationCloud_base {
+declare class GeoLocationCloud {
+    /**
+     * Constructor for GeoLocationCloud
+     *
+     * @param {object} options the options for GeoLocationCloud
+     * @param {string} options.locationProvider name of location provider
+     */
     constructor({ locationProvider }: {
-        locationProvider: any;
+        locationProvider: string;
     }, ...args: any[]);
+    dataKey: string;
 }

package/types/geoLocationPipelineBuilder.d.ts

@@ -7,11 +7,16 @@ declare class GeoLocationPipelineBuilder extends GeoLocationPipelineBuilder_base
        * @param {Boolean} options.shareUsage // include share usage element?
        * @param {String} options.resourceKey // resourceKey for cloud
        * @param {String} options.locationProvider // the provider to request data from. Either "fiftyonedegrees" or "digitalelement".
+       * @param {string} options.cloudRequestOrigin The value to set the
+       * Origin header to when making requests to the cloud service
+       * @param {string} options.baseURL base URL for cloud request
        *
       */
-    constructor({ shareUsage, resourceKey, locationProvider, baseURL }: {
+    constructor({ shareUsage, resourceKey, locationProvider, baseURL, cloudRequestOrigin }: {
         shareUsage: boolean;
         resourceKey: string;
         locationProvider: string;
+        cloudRequestOrigin: string;
+        baseURL: string;
     }, ...args: any[]);
 }

package/types/index.d.ts

@@ -1,2 +1,2 @@
-export const GeoLocationCloud: typeof import("./geoLocationCloud");
-export const GeoLocationPipelineBuilder: typeof import("./geoLocationPipelineBuilder");
+export let GeoLocationCloud: typeof import("./geoLocationCloud");
+export let GeoLocationPipelineBuilder: typeof import("./geoLocationPipelineBuilder");