react-spatial 1.5.2 → 1.5.3

package/.github/workflows/conventional-pr-title.yml

@@ -0,0 +1,21 @@
+name: Check PR title
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: aslafy-z/conventional-pr-title-action@v2.2.0
+        with:
+          success-state: Title follows the specification.
+          failure-state: Title does not follow the specification.
+          context-name: conventional-pr-title
+          preset: conventional-changelog-angular@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/main.yml

@@ -0,0 +1,28 @@
+name: main
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+
+      - name: Run linting and tests
+        run: |
+          yarn install --frozen-lockfile
+          yarn lint
+          yarn test
+        env:
+          CI: true

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn commitlint --edit $1

package/.husky/post-checkout

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn install --frozen-lockfile

package/.husky/post-merge

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn install --frozen-lockfile

package/.husky/post-rebase

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn install --frozen-lockfile

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+sort && CI=true npx lint-staged

package/.nvmrc

@@ -0,0 +1 @@
+16

package/.whitesource

@@ -0,0 +1,8 @@
+##########################################################
+####    WhiteSource Integration configuration file    ####
+##########################################################
+
+# Configuration #
+#---------------#
+ws.repo.scan=true
+vulnerable.check.run.conclusion.level=failure

package/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [1.5.2](https://github.com/geops/react-spatial/compare/v1.5.1...v1.5.2) (2023-06-28)
+
+### [1.5.1](https://github.com/geops/react-spatial/compare/v1.5.0...v1.5.1) (2023-06-28)
+
+## [1.5.0](https://github.com/geops/react-spatial/compare/v1.4.1...v1.5.0) (2023-04-28)
+
+
+### Features
+
+* update react 18 and clean dependencies ([9064937](https://github.com/geops/react-spatial/commit/9064937aa975f072a84b0ad82e791e79ed129c8f))
+
+### [1.4.1](https://github.com/geops/react-spatial/compare/v1.4.0...v1.4.1) (2023-04-28)
+
+
+### Bug Fixes
+
+* use a more intuitive zooming behavior ([2d43f31](https://github.com/geops/react-spatial/commit/2d43f3189096b2195e0b550e8fb2d9d994746a8a))
+
+## [1.4.0](https://github.com/geops/react-spatial/compare/v1.3.2...v1.4.0) (2023-01-09)
+
+
+### Features
+
+* **CanvasSaveButton:** add extraData.qrCode option to insert QR code in canvas export  ([#700](https://github.com/geops/react-spatial/issues/700)) ([16be889](https://github.com/geops/react-spatial/commit/16be889d97682c2a2d21c2fa17d55cae205e09da))
+
+### [1.3.2](https://github.com/geops/react-spatial/compare/v1.3.1...v1.3.2) (2022-12-15)
+
+
+### Bug Fixes
+
+* fix use of baselayers permalink and baselayerswitcher ([#699](https://github.com/geops/react-spatial/issues/699)) ([23af45f](https://github.com/geops/react-spatial/commit/23af45f5681cc50cfc4c60502b71c161a478fe71))
+
+### [1.3.1](https://github.com/geops/react-spatial/compare/v1.3.1-beta.0...v1.3.1) (2022-12-15)
+
+
+### Bug Fixes
+
+* fix detection of base layer in permalink ([9099ba7](https://github.com/geops/react-spatial/commit/9099ba704d15c670e87f8cb9245f06f159078f3e))
+
+## [1.3.0](https://github.com/geops/react-spatial/compare/v1.3.0-beta.1...v1.3.0) (2022-11-14)
+
+
+### Bug Fixes
+
+* **LayerTree:** add input and toggle props for layer tree renderItemContent ([#697](https://github.com/geops/react-spatial/issues/697)) ([8df5237](https://github.com/geops/react-spatial/commit/8df5237482373dc9c9de1ab9cfecefaf3472dcba))
+
+### [1.2.2](https://github.com/geops/react-spatial/compare/v1.2.1...v1.2.2) (2022-07-22)
+
+### [1.2.1](https://github.com/geops/react-spatial/compare/v1.2.0...v1.2.1) (2022-07-22)
+
+
+### Bug Fixes
+
+* make component better work with nextjs image sand routing ([#694](https://github.com/geops/react-spatial/issues/694)) ([85871fe](https://github.com/geops/react-spatial/commit/85871fe2201ecad0de76442bc9d77815bfe6db27))
+
+## [1.2.0](https://github.com/geops/react-spatial/compare/v1.0.35...v1.2.0) (2022-06-20)
+
+
+### Features
+
+* use standard-version and commitlint for automatic versioning and changelog ([#690](https://github.com/geops/react-spatial/issues/690)) ([2c83f00](https://github.com/geops/react-spatial/commit/2c83f00c05f5b76b3f7e38978fb022d7cebfbcfc))

package/DEVELOP.md

@@ -0,0 +1,113 @@
+# Develop
+
+## Create new component
+
+Follow the [guidelines](https://github.com/geops/react-spatial/tree/master/src/components).
+
+## Create new theme
+
+Follow the [guidelines](https://github.com/geops/react-spatial/tree/master/src/themes).
+
+## Documentation
+
+We are using [react-styleguidist](https://react-styleguidist.js.org/).
+Documentation and examples are available [here](https://react-spatial.geops.de/).
+
+Build the doc:
+
+```bash
+yarn doc
+```
+
+Run the doc on [`locahost:6060`](http://locahost:6060/):
+
+```bash
+yarn start
+```
+
+## Tests
+
+We are using [jest]([https://react-styleguidist.js.org/](https://jestjs.io/docs/en/getting-started.html)) and [enzyme]([https://github.com/airbnb/enzyme](https://airbnb.io/enzyme/)).
+
+Run the tests in watch mode:
+
+```bash
+yarn test --watch
+```
+
+## Coverage
+
+Run coverage:
+
+```bash
+yarn coverage
+```
+
+Then open the file `coverage/lcov-report/index.html` in your browser.
+
+## Publish on [npmjs.com](https://www.npmjs.com/package/react-spatial)
+
+Run publish:
+
+```bash
+publish:public
+```
+You need to enter the new version number in the command line.
+Then the new version must be published on [npmjs.com](https://www.npmjs.com/package/react-spatial).
+
+## Publish a development version on [npmjs.com](https://www.npmjs.com/package/react-spatial)
+
+This version WILL NOT be displayed to other in [npmjs.com](https://www.npmjs.com/package/react-spatial).
+
+Run publish:
+
+```bash
+publish:beta
+```
+
+You need to enter the new version number in the command line.
+Append `-beta.0` to the current version or increase the beta number.
+Then the new version must be published on [npmjs.com](https://www.npmjs.com/package/react-spatial) with the tag beta.
+
+## How to use SVG
+
+Before adding an SVG file in this folder please clean it using [svgo](https://www.npmjs.com/package/svgo) or [svgomg](https://jakearchibald.github.io/svgomg/).
+
+After optimization, verify you can use it Openlayers using this [code sandbox](https://codesandbox.io/s/5w5o4mqwlk).
+
+By default the svg loader will load the svg file as a react component if you want to load svg file as a base64 data URI use the extension .url.svg :
+
+```javascript
+// Import as a React component:
+import NorthArrow from 'northArrow.svg';
+// Use: <NorthArrow />
+
+// Import as a base64 data URI (or with an url the file is too big):
+import northArrow from 'northArrow.url.svg';
+// northArrow = "data:image/svg+xml;base64,PHN2ZyB4...."
+```
+
+You could also use others loaders (ex: svg-inline-loader , svg-url-loader ...) .
+To use these loaders just adapt the extension of the svg file and add the loader config in styleguide.config.js, then you will be able to use it like this :
+
+```javascript
+// Import as an inline svg:
+import northArrow from 'northArrow.svginline.svg';
+// northArrow = "<svg xmlns='http://www.w3.org/2000/svg' height='192' ...> ... </svg>"
+
+// Import as an encoded inline svg data URI (or with an url the file is too big):
+import northArrow from 'northArrow.svgurl.svg';
+// northArrow = "data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' height='192' ...%3E ... %3C/svg%3E"
+```
+
+## How to use SVG with a dynamic size
+
+In case you want your SVG fits perfectly his parent div you need to remove `width` and `height` attributes of `<svg>` and replace it by a `viewBox` property, like this:
+
+Replace
+
+    `<svg width="192" height="192">`
+
+by
+
+    `<svg viewBox="0 0 192 192">`

package/__mocks__/mapbox-gl.js

@@ -0,0 +1,11 @@
+/* eslint-disable class-methods-use-this */
+class Map {
+  isStyleLoaded() {}
+
+  getCanvas() {}
+
+  once() {}
+}
+module.exports = {
+  Map,
+};

package/__mocks__/resize-observer-polyfill.js

@@ -0,0 +1,9 @@
+/* eslint-disable */
+export default class ResizeObserver {
+  constructor(onResize) {
+    ResizeObserver.onResize = onResize;
+  }
+  observe() {}
+  unobserve() {}
+  disconnect() {}
+}

package/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: ['@babel/preset-env', '@babel/preset-react'],
+};

package/commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

package/data/topic1.js

@@ -0,0 +1,119 @@
+import Style from 'ol/style/Style';
+import Circle from 'ol/style/Circle';
+import Stroke from 'ol/style/Stroke';
+import Fill from 'ol/style/Fill';
+
+const topic1 = {
+  id: 'topic1',
+  name: 'Topic 1',
+  visible: true,
+  children: [
+    {
+      name: 'OSM Baselayer',
+      visible: true,
+      isBaseLayer: true,
+      data: {
+        type: 'xyz',
+        url: 'https://c.tile.openstreetmap.org/{z}/{x}/{y}.png',
+      },
+    },
+    {
+      name: 'Other layers',
+      visible: true,
+      type: 'parent',
+      children: [
+        {
+          name: 'Countries Borders',
+          visible: false,
+          data: {
+            type: 'vectorLayer',
+            url:
+              'https://openlayers.org/en/latest/examples/data/geojson/' +
+              'countries.geojson',
+          },
+        },
+        {
+          name: 'USA Population Density',
+          visible: true,
+          data: {
+            type: 'wmts',
+            url:
+              'https://services.arcgisonline.com/arcgis/rest/services/' +
+              'Demographics/USA_Population_Density/MapServer/WMTS/?layer=0' +
+              '&style=default&tilematrixset=EPSG%3A3857&Service=WMTS&' +
+              'Request=GetTile&Version=1.0.0&Format=image%2Fpng&',
+            projection: 'EPSG:3857',
+          },
+        },
+      ],
+    },
+    {
+      name: 'Vector sample layers',
+      visible: true,
+      radioGroup: 'radio',
+      children: [
+        {
+          name: 'Points Samples',
+          radioGroup: 'vectorLayers',
+          visible: false,
+          data: {
+            style: new Style({
+              image: new Circle({
+                radius: 5,
+                fill: new Fill({
+                  color: '#ff0000',
+                }),
+              }),
+            }),
+            type: 'vectorLayer',
+            url:
+              'https://raw.githubusercontent.com/openlayers/openlayers/' +
+              '3c64018b3754cf605ea19cbbe4c8813304da2539/examples/data/geojson/' +
+              'point-samples.geojson',
+          },
+        },
+        {
+          name: 'Lines Samples',
+          radioGroup: 'vectorLayers',
+          visible: true,
+          data: {
+            style: new Style({
+              stroke: new Stroke({
+                color: '#ffcc33',
+                width: 2,
+              }),
+            }),
+            type: 'vectorLayer',
+            url:
+              'https://raw.githubusercontent.com/openlayers/openlayers/' +
+              '3c64018b3754cf605ea19cbbe4c8813304da2539/examples/data/geojson/' +
+              'line-samples.geojson',
+          },
+        },
+        {
+          name: 'Polygons Samples',
+          radioGroup: 'vectorLayers',
+          visible: false,
+          data: {
+            style: new Style({
+              stroke: new Stroke({
+                color: '#7dff8f',
+                width: 3,
+              }),
+              fill: new Fill({
+                color: 'rgba(125, 255, 143, 0.2)',
+              }),
+            }),
+            type: 'vectorLayer',
+            url:
+              'https://raw.githubusercontent.com/openlayers/openlayers/' +
+              '3c64018b3754cf605ea19cbbe4c8813304da2539/examples/data/geojson/' +
+              'polygon-samples.geojson',
+          },
+        },
+      ],
+    },
+  ],
+};
+
+export default topic1;

package/data/topic2.js

@@ -0,0 +1,28 @@
+const topic2 = {
+  id: 'topic2',
+  name: 'Topic 2',
+  visible: false,
+  children: [
+    {
+      name: 'OSM Baselayer',
+      visible: true,
+      isBaseLayer: true,
+      data: {
+        type: 'xyz',
+        url: 'https://c.tile.openstreetmap.org/{z}/{x}/{y}.png',
+      },
+    },
+    {
+      name: 'Countries Borders',
+      visible: true,
+      data: {
+        type: 'vectorLayer',
+        url:
+          'https://openlayers.org/en/latest/examples/data/geojson/' +
+          'countries.geojson',
+      },
+    },
+  ],
+};
+
+export default topic2;

package/doc/README.md

@@ -0,0 +1,21 @@
+# Documentation in react-spatial
+
+Two documentation tools are combined:
+- react-styleguidist (https://github.com/styleguidist/react-styleguidist)
+- documentation.js (https://github.com/documentationjs/documentation)
+
+the folder published by netlify is doc/build (netlify.toml).
+
+## Commands
+
+Styleguidist documentation is visible (with hot reload) with the cmd:
+'yarn start'
+
+## Configuration
+
+Variables shared among both documentation are written in /doc/doc-config.json
+
+- Styleguidist: 'styleguide.config.js
+    one component need to be overwritten:
+    - 'StyleGuideRenderer': to customize the style of the page, with our own
+        header, ribbon footer, etc.

package/doc/doc-config.json

@@ -0,0 +1,4 @@
+{
+  "appName": "react-spatial",
+  "githubRepo": "https://github.com/geops/react-spatial"
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-spatial",
   "description": "Components to build React map apps.",
-  "version": "1.5.2",
+  "version": "1.5.3",
   "license": "MIT",
   "dependencies": {
     "@geops/geops-ui": "0.1.13",
@@ -99,9 +99,10 @@
     "lint": "eslint 'src/**/*.js' && stylelint 'src/**/*.css' 'src/**/*.scss'",
     "postbuild": "cp package.json build/ && cd src && find .  -name '*.scss' | cpio -pdm ../build",
     "prebuild": "rm -rf build/",
-    "publish:beta": "yarn release -- --prerelease beta --skip.changelog && git push origin HEAD && yarn run build && git push --tags && yarn publish build/ --tag beta",
+    "prepare": "is-ci || husky install",
+    "publish:beta": "yarn release -- --prerelease beta --skip.changelog && git push origin HEAD && yarn run build && git push --tags && HUSKY=0 yarn publish build/ --tag beta",
     "publish:beta:dryrun": "yarn release -- --prerelease beta --dry-run --skip.changelog",
-    "publish:public": "yarn release && git push origin HEAD && yarn build  && git push --tags && yarn publish build/",
+    "publish:public": "yarn release && git push origin HEAD && yarn build  && git push --tags && HUSKY=0 yarn publish build/",
     "publish:public:dryrun": "yarn release --dry-run",
     "release": "standard-version",
     "start": "styleguidist server",

package/pull_request_template.md

@@ -0,0 +1,16 @@
+# How to
+
+<!--  Please provide a test link and quick description how to see the change -->
+
+# Others
+
+<!-- Thanks for the PR! Feel free to add or remove items if there are not necessary. -->
+
+- [ ] It's not a hack or at least an unauthorized hack :).
+- [ ] The images added are optimized.
+- [ ] Everything in ticket description has been fixed.
+- [ ] The author of the MR has made its own review before assigning the reviewer.
+- [ ] The title means something for a human being and follows the [conventional commits](https://www.conventionalcommits.org/) specification.
+- [ ] The title contains [WIP] if it's necessary.
+- [ ] Labels applied. if it's a release? a hotfix?
+- [ ] Tests added.

package/renovate.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["config:js-lib", "schedule:monthly"],
+  "assignees": ["@friedjoff"]
+}

package/scripts/read-pkg-json.js

@@ -0,0 +1,17 @@
+const pjson = require('../package.json');
+
+const { peerDependencies } = pjson;
+
+const packageKeys = Object.keys(peerDependencies);
+
+const arg = process.argv[2];
+
+if (arg === 'add') {
+  console.log(`yarn install --force`);
+} else if (arg === 'remove') {
+  console.log(
+    `rm -rf ${packageKeys.map((p) => `node_modules/${p}`).join(' ')}`,
+  );
+} else {
+  console.log('echo "wrong argument."');
+}