fiftyone.geolocation 4.4.1 → 4.4.3

package/.github/workflows/monthly-copyright-update.yml

@@ -0,0 +1,21 @@
+name: Monthly Copyright Update
+
+on:
+  workflow_dispatch:
+    inputs:
+      dryrun:
+        default: false
+        type: boolean
+        description: Dry Run
+  schedule:
+    - cron: '0 1 1 * *'
+
+jobs:
+  Monthly_Copyright_Update:
+    uses: 51Degrees/common-ci/.github/workflows/monthly-copyright-update.yml@main
+    with:
+      repo-name: ${{ github.event.repository.name }}
+      org-name: ${{ github.event.repository.owner.login }}
+      dryrun: ${{ inputs.dryrun || false }}
+    secrets:
+      token: ${{ secrets.ACCESS_TOKEN }}

package/.github/workflows/nightly-documentation-update.yml

@@ -0,0 +1,21 @@
+name: Nightly Documentation Update
+
+on:
+  workflow_dispatch:
+    inputs:
+      dryrun:
+        default: false
+        type: boolean
+        description: Dry Run
+  schedule:
+    - cron: '0 1 * * *'
+
+jobs:
+  Nightly_Documentation_Update:
+    uses: 51Degrees/common-ci/.github/workflows/nightly-documentation-update.yml@main
+    with:
+      repo-name: ${{ github.event.repository.name }}
+      org-name: ${{ github.event.repository.owner.login }}
+      dryrun: ${{ inputs.dryrun || false }}
+    secrets:
+      token: ${{ secrets.ACCESS_TOKEN }}

package/.github/workflows/nightly-package-update.yml

@@ -0,0 +1,22 @@
+name: Nightly Package Update
+
+on:
+  workflow_dispatch:
+    inputs:
+      dryrun:
+        default: false
+        type: boolean
+        description: Dry Run
+  schedule:
+    - cron: '0 1 * * *'
+
+
+jobs:
+  Nightly_Package_Update:
+    uses: 51Degrees/common-ci/.github/workflows/nightly-package-update.yml@main
+    with:
+      repo-name: ${{ github.event.repository.name }}
+      org-name: ${{ github.event.repository.owner.login }}
+      dryrun: ${{ inputs.dryrun || false }}
+    secrets:
+      token: ${{ secrets.ACCESS_TOKEN }}

package/.github/workflows/nightly-prs-to-main.yml

@@ -0,0 +1,22 @@
+name: Nightly PRs to Main
+
+on:
+  workflow_dispatch:
+    inputs:
+      dryrun:
+        default: false
+        type: boolean
+        description: Dry Run
+  schedule:
+    - cron: '0 1 * * *'
+
+jobs:
+  Nightly_PRs_to_Main:
+    uses: 51Degrees/common-ci/.github/workflows/nightly-prs-to-main.yml@main
+    with:
+      repo-name: ${{ github.event.repository.name }}
+      org-name: ${{ github.event.repository.owner.login }}
+      dryrun: ${{ inputs.dryrun || false }}
+    secrets:
+      token: ${{ secrets.ACCESS_TOKEN }}
+      asset-keys: '{"DeviceDetection": "${{ secrets.DEVICE_DETECTION_KEY }}", "TestResourceKey": "${{ secrets.SUPER_RESOURCE_KEY}}"}'

package/.github/workflows/nightly-publish-to-main.yml

@@ -0,0 +1,23 @@
+name: Nightly Publish Main
+
+on:
+  workflow_dispatch:
+    inputs:
+      dryrun:
+        default: false
+        type: boolean
+        description: Dry Run
+  schedule:
+    - cron: '0 1 * * *'
+
+jobs:
+  Nightly_Publish_Main:
+    uses: 51Degrees/common-ci/.github/workflows/nightly-publish-main.yml@main
+    with:
+      repo-name: ${{ github.event.repository.name }}
+      org-name: ${{ github.event.repository.owner.login }}
+      dryrun: ${{ inputs.dryrun || false }}
+      build-platform: ubuntu-latest
+    secrets:
+      token: ${{ secrets.ACCESS_TOKEN }}
+      asset-keys: '{"DeviceDetection": "${{ secrets.DEVICE_DETECTION_KEY }}", "TestResourceKey": "${{ secrets.SUPER_RESOURCE_KEY}}", "NPMAuthToken": "${{ secrets.NPM_AUTH_TOKEN}}"}'

package/ci/README.md

@@ -1,2 +1,12 @@
 # API Specific CI/CD Approach
-This API complies with the `common-ci` approach.
+This API complies with the `common-ci` approach.
+
+The following secrets are required:
+* `ACCESS_TOKEN` - GitHub [access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#about-personal-access-tokens) for cloning repos, creating PRs, etc.
+    * Example: `github_pat_l0ng_r4nd0m_s7r1ng`
+* `SUPER_RESOURCE_KEY` - [resource key](https://51degrees.com/documentation/4.4/_info__resource_keys.html) for integration tests
+    * Example: `R4nd0m-S7r1ng`
+* `DEVICE_DETECTION_KEY` - [license key](https://51degrees.com/pricing) for downloading assets (TAC hashes file and TAC CSV data file)
+    * Example: `V3RYL0NGR4ND0M57R1NG`
+* `NPM_AUTH_TOKEN` - [NPM token](https://docs.npmjs.com/creating-and-viewing-access-tokens)  for publishing packages
+    * Example: `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`

package/ci/build-package-requirements.ps1

@@ -0,0 +1 @@
+Write-Output "No requirements needed"

package/ci/build-package.ps1

@@ -0,0 +1,14 @@
+param (
+    [Parameter(Mandatory=$true)]
+    [string]$RepoName,
+    [Parameter(Mandatory=$true)]
+    [string]$Version
+)
+
+$packages = "."
+
+$noRemote = "."
+
+./node/build-package-npm.ps1 -RepoName $RepoName -Packages $packages -NoRemote $noRemote -Version $Version
+
+exit $LASTEXITCODE

package/ci/build-project.ps1

@@ -0,0 +1,16 @@
+param (
+    [Parameter(Mandatory=$true)]
+    [string]$RepoName
+)
+
+$packages = ".";
+
+Push-Location $RepoName
+
+Remove-Item -Path ./package-lock.json -Force
+
+Pop-Location
+
+./node/build-project.ps1 -RepoName $RepoName -Packages $packages
+
+exit $LASTEXITCODE

package/ci/fetch-assets.ps1

@@ -0,0 +1 @@
+Write-Output "No assets needed"

package/ci/get-next-package-version.ps1

@@ -0,0 +1,10 @@
+param (
+    [Parameter(Mandatory=$true)]
+    [string]$RepoName,
+    [Parameter(Mandatory=$true)]
+    [string]$VariableName
+)
+
+./node/get-next-package-version.ps1 -RepoName $RepoName -VariableName $VariableName
+
+exit $LASTEXITCODE

package/ci/install-package.ps1

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

package/ci/options.json

@@ -0,0 +1,50 @@
+[
+  {
+    "Name": "Ubuntu_Node_16",
+    "Image": "ubuntu-20.04",
+    "Language": "node",
+    "LanguageVersion": "16.20.0",
+    "RunPerformance": true,
+    "PackageRequirement": true
+  },
+  {
+    "Name": "Windows_Node_16",
+    "Image": "windows-latest",
+    "Language": "node",
+    "LanguageVersion": "16.20.0",
+    "RunPerformance": true,
+    "PackageRequirement": true
+  },
+  {
+    "Name": "macOS_Node_16",
+    "Image": "macos-latest",
+    "Language": "node",
+    "LanguageVersion": "16.20.0",
+    "RunPerformance": true,
+    "PackageRequirement": true
+  },
+  {
+    "Name": "Ubuntu_Node_18",
+    "Image": "ubuntu-20.04",
+    "Language": "node",
+    "LanguageVersion": "18.16.0",
+    "RunPerformance": true,
+    "PackageRequirement": true
+  },
+  {
+    "Name": "Windows_Node_18",
+    "Image": "windows-latest",
+    "Language": "node",
+    "LanguageVersion": "18.16.0",
+    "RunPerformance": true,
+    "PackageRequirement": true
+  },
+  {
+    "Name": "macOS_Node_18",
+    "Image": "macos-latest",
+    "Language": "node",
+    "LanguageVersion": "18.16.0",
+    "RunPerformance": true,
+    "PackageRequirement": true
+  }
+]

package/ci/package-update-required.ps1

@@ -0,0 +1 @@
+Write-Output "Updates needed"

package/ci/publish-package.ps1

@@ -0,0 +1,10 @@
+param (
+    [Parameter(Mandatory=$true)]
+    [string]$RepoName,
+    [Parameter(Mandatory=$true)]
+    [boolean]$DryRun
+)
+
+./node/publish-package-npm.ps1 -RepoName $RepoName -DryRun $DryRun
+
+exit $LASTEXITCODE

package/ci/run-integration-tests.ps1

@@ -0,0 +1,22 @@
+param (
+    [Parameter(Mandatory=$true)]
+    [string]$RepoName,
+    [Parameter(Mandatory=$true)]
+    $Keys
+)
+
+Push-Location $RepoName
+
+try
+{
+    Write-Output "Running integration tests"
+    $env:RESOURCE_KEY = $Keys.TestResourceKey
+    $env:JEST_JUNIT_OUTPUT_DIR = 'test-results/integration'
+    npm run test
+} finally {
+    Pop-Location
+}
+
+if ($LASTEXITCODE -ne 0) {
+    exit $LASTEXITCODE
+}

package/ci/run-performance-tests.ps1

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

package/ci/run-unit-tests.ps1

@@ -0,0 +1,8 @@
+param (
+    [Parameter(Mandatory=$true)]
+    [string]$RepoName
+)
+
+Write-Output "No unit tests specified"
+
+exit $LASTEXITCODE

package/ci/setup-environment.ps1

@@ -0,0 +1,13 @@
+param (
+    [Parameter(Mandatory=$true)]
+    [string]$RepoName
+)
+
+./node/setup-environment.ps1 -RepoName $RepoName
+
+if ($LASTEXITCODE -ne 0) {
+    exit $LASTEXITCODE
+}
+
+
+

package/ci/update-packages.ps1

@@ -0,0 +1,10 @@
+param (
+    [Parameter(Mandatory=$true)]
+    [string]$RepoName
+)
+
+$packages = "."
+
+./node/update-packages.ps1 -RepoName $RepoName -Packages $packages
+
+exit $LASTEXITCODE

package/docs/Doxyfile

@@ -51,7 +51,7 @@ PROJECT_BRIEF          = "51Degrees Geo-Location for Node.js"
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = ../../../docs/images/logo-51Degrees-Docs.png
+PROJECT_LOGO           = ../../documentation/docs/images/logo-51Degrees-Docs.png
 
 # The PROJECT_URL tag is used to specify the URL which is linked by the
 # PROJECT_LOGO.
@@ -916,7 +916,7 @@ EXAMPLE_RECURSIVE      = YES
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             = ../../../docs/images
+IMAGE_PATH             = ../../documentation/docs/images
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1128,7 +1128,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_HEADER            =
+HTML_HEADER            = ../../documentation/docs/header.html
 
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1138,7 +1138,7 @@ HTML_HEADER            =
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = ../../../docs/footer.html
+HTML_FOOTER            = ../../documentation/docs/footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1150,7 +1150,7 @@ HTML_FOOTER            = ../../../docs/footer.html
 # obsolete.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_STYLESHEET        = ../../../docs/docs-main.min.css
+HTML_STYLESHEET        = ../../documentation/docs/docs-main.min.css
 
 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
 # cascading style sheets that are included after the standard style sheets
@@ -1173,11 +1173,13 @@ HTML_EXTRA_STYLESHEET  =
 # files will be copied as-is; there are no commands or markers available.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_FILES       = ../../../docs/images/icon-arrow-left-black.svg \
-                         ../../../docs/images/icon-arrow-right-black.svg \
-                         ../../../docs/images/icon-arrow-solid-right-mute.svg \
-                         ../../../docs/images/icon-arrow-solid-right-orange.svg \
-                         ../../../docs/images/icon-search.svg
+HTML_EXTRA_FILES       =  ../../documentation/docs/images/icon-arrow-left-black.svg \
+                          ../../documentation/docs/images/icon-arrow-right-black.svg \
+                          ../../documentation/docs/images/icon-arrow-solid-right-mute.svg \
+                          ../../documentation/docs/images/icon-arrow-solid-right-orange.svg \
+                          ../../documentation/docs/images/icon-search.svg \
+                          ../../documentation/docs/examplegrabber.js \
+                          ../../documentation/docs/search51.js
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
 # will adjust the colors in the style sheet and background images according to

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.geolocation",
-  "version": "4.4.1",
+  "version": "4.4.3",
   "description": "Geo-location services for the 51Degrees Pipeline API",
   "main": "index.js",
   "types": "types/index.d.ts",
@@ -17,21 +17,21 @@
     "Joseph Dix <joseph@51degrees.com> (https://51degrees.com)"
   ],
   "dependencies": {
-    "fiftyone.pipeline.cloudrequestengine": "^4.4.0",
-    "fiftyone.pipeline.core": "^4.4.0",
-    "fiftyone.pipeline.engines": "^4.4.0",
-    "fiftyone.pipeline.engines.fiftyone": "^4.4.0"
+    "fiftyone.pipeline.cloudrequestengine": "^4.4.8",
+    "fiftyone.pipeline.core": "^4.4.8",
+    "fiftyone.pipeline.engines": "^4.4.8",
+    "fiftyone.pipeline.engines.fiftyone": "^4.4.8"
   },
   "devDependencies": {
-    "@types/node": "^15.12.2",
+    "@types/node": "^15.14.9",
     "eslint": "^6.8.0",
     "eslint-config-standard": "^14.1.1",
-    "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-standard": "^4.0.1",
-    "jest": "^27.0.6",
-    "jest-expect-message": "^1.0.2",
+    "eslint-plugin-promise": "^4.3.1",
+    "eslint-plugin-standard": "^4.1.0",
+    "jest": "^27.5.1",
+    "jest-expect-message": "^1.1.3",
     "jest-junit": "^9.0.0"
   },
   "license": "EUPL-1.2",

package/tests/geoLocationCloud.test.js

@@ -107,20 +107,6 @@ if (isAsync) {
     await testAvailableProperties(done, pipeline, engine);
   });
 
-  test('Available Properties Digital Element', async done => {
-    if (myResourceKey === '!!YOUR_RESOURCE_KEY!!') {
-      throw new Error('No resource key is present!');
-    }
-
-    const pipeline = new GeoLocation.GeoLocationPipelineBuilder({
-      resourceKey: myResourceKey,
-      locationProvider: 'digitalelement'
-    }).build();
-    var engine = pipeline.flowElements.location_digitalelement;
-
-    await testAvailableProperties(done, pipeline, engine);
-  });
-
   test('Value Types 51Degrees', async done => {
     if (myResourceKey === '!!YOUR_RESOURCE_KEY!!') {
       throw new Error('No resource key is present!');
@@ -134,20 +120,6 @@ if (isAsync) {
 
     await testValueTypes(done, pipeline, engine);
   });
-
-  test('Value Types DigitalElement', async done => {
-    if (myResourceKey === '!!YOUR_RESOURCE_KEY!!') {
-      throw new Error('No resource key is present!');
-    }
-
-    const pipeline = new GeoLocation.GeoLocationPipelineBuilder({
-      resourceKey: myResourceKey,
-      locationProvider: 'digitalelement'
-    }).build();
-    var engine = pipeline.flowElements.location_digitalelement;
-
-    await testValueTypes(done, pipeline, engine);
-  });
 } else {
   // Skip if async is not available (e.g node 6)
   test.skip('Workaround', () => 1);

package/ci/build-and-test.yml

@@ -1,34 +0,0 @@
-trigger: none
-
-# Schedule to run overnight
-schedules:
-- cron: "0 20 * * *"
-  displayName: Daily overnight build
-  branches:
-    include:
-    - develop
-
-resources:
-  repositories:
-  - repository: ciTemplates # Id of the repository used to reference to in this script
-    type: git
-    name: common-ci # Name of the actual repository
-
-# Include the shared variables
-variables:
-- template: shared-variables.yml@ciTemplates
-- group: CIAutomation
-
-stages:
-- template: shared-build-and-test-platforms.yml
-  parameters:
-    windowsImage: $(windowsImage)
-    linuxImage: $(linuxImage)
-    macImage: $(macImage)
-    runTests: variables['RunTests']
-
-# Try to complete the corresponding pull request if
-# this is triggered by one.    
-- template: shared-auto-complete-pr-stage.yml@ciTemplates
-  parameters:
-    stageDependencies: [Windows,Linux,MacOS]

package/ci/common-ci/.github/labels.yml

@@ -1,86 +0,0 @@
-# Type labels
-- name: "type: feature-request"
-  description: New feature
-  color: 0eced4
-- name: "type: bug"
-  description: Something isn't working
-  color: d73a4a
-- name: "type: documentation"
-  description: Improvements or additions to documentation
-  color: 0075ca
-- name: "type: question"
-  description: Further information is requested
-  color: d876e3
-
-# Status Labels
-- name: "status: to be scheduled"
-  description: This item has not been scheduled for a particular release
-  color: c2e0c6
-- name: "status: assigned"
-  description: This item has been assigned to an engineer
-  color: 6ff076
-- name: "status: duplicate"
-  description: This issue or pull request already exists
-  color: cfd3d7
-- name: "status: awaiting external input"
-  description: This item is awaiting for external input
-  color: 6699ff
-- name: "status: will not fix"
-  description: This item will not be fixed
-  color: 6392fa
-- name: "status: released/4.3.0"
-  description: This change was released in the specified version
-  color: a8d131
-- name: "status: released/4.3.1"
-  description: This change was released in the specified version
-  color: 6dcc16
-- name: "status: released/4.3.2"
-  description: This change was released in the specified version
-  color: 87a457
-- name: "status: released/4.3.3"
-  description: This change was released in the specified version
-  color: 006b75
-- name: "status: released/4.3.4"
-  description: This change was released in the specified version
-  color: 99ccff
-- name: "status: released/4.3.5"
-  description: This change was released in the specified version
-  color: ccccff
-- name: "status: released/4.3.6"
-  description: This change was released in the specified version
-  color: cc88ff
-- name: "status: released/4.4.0"
-  description: This change was released in the specified version
-  color: 376842
-
-  # Scheduled Labels
-- name: "scheduled: 6th Oct 2021"
-  description: This item has been scheduled for 6th Oct 2021 release
-  color: 6ff076
-- name: "scheduled: 20th Oct 2021"
-  description: This item has been scheduled for 20th Oct 2021 release
-  color: 6ff076
-- name: "scheduled: 3rd Nov 2021"
-  description: This item has been scheduled for 3rd Nov 2021 release
-  color: 6ff076
-- name: "scheduled: 17th Nov 2021"
-  description: This item has been scheduled for 17th Nov 2021 release
-  color: 6ff076
-- name: "scheduled: 1st Dec 2021"
-  description: This item has been scheduled for 1st Dec 2021 release
-  color: 6ff076
-- name: "scheduled: 15th Dec 2021"
-  description: This item has been scheduled for 15th Dec 2021 release
-  color: 6ff076
-- name: "scheduled: 12th Jan 2022"
-  description: This item has been scheduled for 12th Jan 2022 release
-  color: 6ff076
-- name: "scheduled: 19th Jan 2022"
-  description: This item has been scheduled for 19th Jan 2022 release
-  color: 6ff076
-- name: "scheduled: 26th Jan 2022"
-  description: This item has been scheduled for 26th Jan 2022 release
-  color: 6ff076
-- name: "scheduled: 2nd Feb 2022"
-  description: This item has been scheduled for 2nd Feb 2022 release
-  color: 6ff076

package/ci/common-ci/.github/workflows/sync-labels.yml

@@ -1,52 +0,0 @@
-# This script will automatically synchronize the labels defined in the labels.yml file in this repository
-# to all other repositories.
-# Note that labels that are removed or renamed in label.yml will be deleted from all repositories.
-# Issues and PRs that are tagged with that label will have the label removed.
-name: Sync labels
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - .github/labels.yml
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: micnncim/action-label-syncer@v1
-        with:
-          manifest: .github/labels.yml
-          repository: |
-              51Degrees/caching-dotnet
-              51Degrees/cloud-issues
-              51Degrees/common-ci
-              51Degrees/common-cxx
-              51Degrees/data-file-tool
-              51Degrees/device-detection-cxx
-              51Degrees/device-detection-data
-              51Degrees/device-detection-dotnet
-              51Degrees/device-detection-go
-              51Degrees/device-detection-examples-go
-              51Degrees/device-detection-java
-              51Degrees/device-detection-nginx
-              51Degrees/device-detection-node
-              51Degrees/device-detection-php
-              51Degrees/device-detection-php-onpremise
-              51Degrees/device-detection-python
-              51Degrees/device-detection-varnish
-              51Degrees/location-dotnet
-              51Degrees/location-java
-              51Degrees/location-node
-              51Degrees/location-php
-              51Degrees/location-python
-              51Degrees/pipeline-dotnet
-              51Degrees/pipeline-java
-              51Degrees/pipeline-node
-              51Degrees/pipeline-php-cloudrequestengine
-              51Degrees/pipeline-php-core
-              51Degrees/pipeline-php-engines
-              51Degrees/pipeline-python
-              51Degrees/pipeline-specification
-              51Degrees/Renderer
-          token: ${{ secrets.LABEL_SYNC_TOKEN }}