Radar SDK V4 (#104)

* add typescript classes * update readme * add live-server to demo page * update license * update readme * Update README.md * add geolocation options to config * remove old logo * use .cjs for node scripts * bump-version * fix bump-version script * use .ts instead of .js file * remove ts declarations from CDN files * specify files to include in npm package * add maps ui sdk, and new demo pages * Update README.md * use express and handlebars to render demo * add support for markers * add autocomplete input * pulish demo site to github pages on release * bump version * fix tests * fix static site generation * fix broken links * use maplibre peerDependency for usage with ES Modules * Update README.md * bump version * Update README.md * Update README.md * add desired accuracy settings * add track and trip demo pages * add log conversion example * bump version * updated autocompleted stylings * persist key in demo via query params * clear publishable key on input change * fix link highlighting * fix autocomplete keyboard nav * add marker option to autocomplete results * fix postal code formatting, limit demo to us results * add map size warning, update readme * fix link * Update README.md * autocomplete style adjustments * Update README.md * fix input width scaling * send locationAuthorization in config call * add migration guide * bump version * add contributing file * Update CONTRIBUTING.md * Update README.md * radar logos link to homepage * bump-version to update readme versions * allow maplibre options in createMap * use inline style for map logo * device test ts * storage test ts * version test and json tsconfig * fix tests * remove codecov reporting * http tests - 400 is now BadRequest - util functions for http * addresses api test * context test * conversions test * geocoding tests and debug response helper * routing test * search and trips test * better test patterns * better trips test pattern * remove jest-localstorage-mock * better context test pattern * radar tests * delete js tests * mock getConfig and individually restore mocks * better mock request pattern * use Logger class for debug errors * Revert "better mock request pattern" This reverts commit a19ccb2. * Revert "mock getConfig and individually restore mocks" This reverts commit 16cdcf4. * flag for ConfigAPI.getconfig * center map based on user location option * bump version * remove useIP option * support latest maplibre as peer dep. move static build to latest release --------- Co-authored-by: Jason Liu <[email protected]>
radarlabs · Jul 21, 2023 · 4f4dcc4 · 4f4dcc4
1 parent 26dbdc8
commit 4f4dcc4
Show file tree

Hide file tree

Showing 105 changed files with 12,324 additions and 18,427 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -9,7 +9,7 @@ jobs:
           key: dependency-cache-{{ checksum "package.json" }}
       - run:
           name: Install Dependencies
-          command: npm ci --force
+          command: npm ci
       - save_cache:
           key: dependency-cache-{{ checksum "package.json" }}
           paths:
@@ -20,6 +20,3 @@ jobs:
       - store_artifacts:
           path: coverage
           prefix: coverage
-      - run:
-          name: Report Test Coverage
-          command: npm run report-coverage
diff --git a/.github/workflows/radar-pre-release-actions.yml b/.github/workflows/radar-pre-release-actions.yml
@@ -25,5 +25,5 @@ jobs:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_REGION: 'us-east-1'
-          SOURCE_DIR: 'dist/'
+          SOURCE_DIR: 'cdn/'
           DEST_DIR: ${{ github.ref_name }} # the release tag
diff --git a/.github/workflows/radar-release-actions.yml b/.github/workflows/radar-release-actions.yml
@@ -26,13 +26,18 @@ jobs:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_REGION: 'us-east-1'
-          SOURCE_DIR: 'dist/'
+          SOURCE_DIR: 'cdn/'
           DEST_DIR: ${{ github.ref_name }} # release tag
       - uses: jakejarvis/s3-sync-action@master
         env:
           AWS_S3_BUCKET: js.radar.com
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_REGION: 'us-east-1'
-          SOURCE_DIR: 'dist/'
+          SOURCE_DIR: 'cdn/'
           DEST_DIR: ${{ env.MAJOR_VERSION }} # release latest major version
+      - run: npm run compile-site
+      - uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
diff --git a/.gitignore b/.gitignore
@@ -24,5 +24,7 @@ node_modules/
 npm-debug.log
 *.framework
 dist/
+cdn/
 coverage/
+site/
 .nyc_output/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,93 @@
+# Contributing
+
+## Setup
+For local development, clone the repository and install all dev dependencies.
+
+```bash
+git clone [email protected]:radarlabs/radar-sdk-js.git
+
+cd radar-sdk-js
+
+npm install
+```
+
+## Tests
+To run tests locally, you can run the test command for a single run, or in `watch` mode.
+```bash
+npm run test
+
+npm run test:watch
+```
+
+## Demo App
+The easiest way to develop the SDK in a browser environment, is to start up the [demo app](https://radarlabs.github.io/radar-sdk-js) locally.
+
+This is a small web app that will run on a local server, and serve up the Web SDK as a locally built script tag. Any code changes will be recompiled on-the-fly (will require a browser refresh to take effect).
+
+```bash
+npm run demo
+```
+
+This will start the demo on [http://localhost:9001](http://localhost:9001). The demo app uses express to serve files, and [handlebars](https://handlebarsjs.com/) for rendering views.
+
+**Note** adding new view templates will require the server to be restarted.
+
+## `npm-link`
+If you want to run a local version of the SDK in an ES Module environment, you can use [npm link](https://docs.npmjs.com/cli/v8/commands/npm-link) to use the locally built version in your project.
+
+To setup, first link the local version of the Radar SDK
+```
+# in /radar-sdk-js
+npm run build
+npm link
+```
+
+Then in your project that has `radar-sdk-js` in its `package.json`
+```bash
+npm link radar-sdk-js
+```
+This will point the pakage in your project to use the local version of the SDK.
+
+**Note**: Make sure you're using the node.js & npm installations in both projects, especially if you're using a node manager like `nvm` or `n`.
+
+## Versions
+There is a built in utility for managing version increments:
+```bash
+npm run bump-version
+```
+This will increment the minor version in the necessary places throughout the codebase. This is required before cutting a new release otherwise tests will fail.
+
+This script will also update the version used in documentation throughout the repository.
+
+### Releases
+_This only applies to authorized contributors_
+
+New releases are managed via [Github Releases](https://github.com/radarlabs/radar-sdk-js/releases). 
+
+Creating a new release will start the Github Workflow for managing the release:
+* Run tests
+* Build artifacts
+* Release on [npm](https://www.npmjs.com/package/radar-sdk-js)
+* Deploy new script tags
+* Build Github pages for demo site
+
+*Note:* All release version should be prefixed with `v`.
+
+### Beta release
+To ship a beta release, the version should be suffixed with `-beta.<version number>`. This can be done with the `bump-version` command.
+```bash
+npm run bump-version 4.0.1-beta.1
+```
+
+Beta versions should also be set as a `pre-release`
+![image](https://github.com/radarlabs/radar-sdk-js/assets/814934/3503871c-02f9-47bd-9b62-01cfccf34e42)
+
+
+
+
+
+
+### Production release
+Production releases should not have a `-beta` suffix, and be set as the `latest` release.
+<img width="1245" alt="Screenshot 2023-07-05 at 12 31 07 PM" src="https://github.com/radarlabs/radar-sdk-js/assets/814934/de2b5f80-84e1-497b-b8f5-c74c92254f8d">
+
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,190 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2023 Radar Labs, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.