radar-sdk-js 3.7.1 → 4.0.0-beta.5

package/.babelrc

@@ -0,0 +1,11 @@
+{
+  "presets": [
+    [
+      "@babel/env",
+      {
+        "useBuiltIns": "usage",
+        "corejs": 3,
+      }
+    ]
+  ]
+}

package/.circleci/config.yml

@@ -0,0 +1,25 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: cimg/node:16.15
+    steps:
+      - checkout
+      - restore_cache:
+          key: dependency-cache-{{ checksum "package.json" }}
+      - run:
+          name: Install Dependencies
+          command: npm ci
+      - save_cache:
+          key: dependency-cache-{{ checksum "package.json" }}
+          paths:
+            - node_modules
+      - run:
+          name: Run Tests
+          command: npm run test
+      - store_artifacts:
+          path: coverage
+          prefix: coverage
+      - run:
+          name: Report Test Coverage
+          command: npm run report-coverage

package/.eslintrc

@@ -0,0 +1,30 @@
+{
+  "ecmaFeatures": {
+    "modules": true,
+  },
+  "env": {
+    "browser": true,
+    "mocha": true,
+    "node": true,
+  },
+  "extends": "eslint:recommended",
+  "parser": "babel-eslint",
+  "rules": {
+    "consistent-return": 0,
+    "func-names": 0,
+    "global-require": 0,
+    "max-len": 0,
+    "no-alert": 0,
+    "no-console": 0,
+    "no-param-reassign": 0,
+    "no-plusplus": 0,
+    "no-shadow": 0,
+    "no-underscore-dangle": 0,
+    "no-restricted-properties": [0, {
+      "object": "Math",
+      "property": "pow",
+    }],
+    "no-bitwise": 0,
+    "padded-blocks": 0,
+  }
+}

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,52 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: master
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: '*'
+
+jobs:
+  analyse:
+    name: Analyse
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

package/.github/workflows/radar-pre-release-actions.yml

@@ -0,0 +1,29 @@
+name: Publish beta package to npmjs
+on:
+  release:
+    types: [ prereleased ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci --force
+      - run: npm run build
+      - run: npm run test
+      - run: npm run check-beta-tag
+      - run: npm publish --tag beta
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - 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: 'cdn/'
+          DEST_DIR: ${{ github.ref_name }} # the release tag

package/.github/workflows/radar-release-actions.yml

@@ -0,0 +1,38 @@
+name: Publish package to npmjs
+on:
+  release:
+    types: [ released ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - run: echo "MAJOR_VERSION=$(echo ${{ github.ref_name }} | cut -d '.' -f 1)" >> $GITHUB_ENV
+      - run: npm ci --force
+      - run: npm run build
+      - run: npm run test
+      - run: npm run check-latest-tag
+      - run: npm publish
+      - 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: '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: 'cdn/'
+          DEST_DIR: ${{ env.MAJOR_VERSION }} # release latest major version

package/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.

package/README.md

@@ -1,24 +1,78 @@
-![Radar](https://raw.githubusercontent.com/radarlabs/react-native-radar/master/logo.png)
+<p align="center">
+  <img src="assets/logo.svg">
+</p>
 
-[![npm](https://img.shields.io/npm/v/radar-sdk-js.svg)](https://www.npmjs.com/package/radar-sdk-js)
-![CircleCI branch](https://img.shields.io/circleci/project/github/radarlabs/radar-sdk-js/master.svg)
-[![Codecov](https://img.shields.io/codecov/c/github/radarlabs/radar-sdk-js.svg)](https://codecov.io/gh/radarlabs/radar-sdk-js)
+<h4 align="center">
+  <a href="https://radar.com">Website</a> |
+  <a href="https://radar.com/blog">Blog</a> |
+  <a href="https://radar.com/documentation">Documentation</a> |
+  <a href="https://radar.com/documentation/faq">FAQ</a> |
+  <a href="mailto:support@radar.com">Support</a>
+</h4>
 
-[Radar](https://radar.com) is location data infrastructure. You can use Radar SDKs and APIs to add location context to your apps with just a few lines of code.
+<p align="center">
+  <a href="https://www.npmjs.com/package/radar-sdk-js"><img src="https://img.shields.io/npm/v/radar-sdk-js.svg" alt="npm"></a>
+  <a href="https://app.circleci.com/pipelines/github/radarlabs/radar-sdk-js"><img src="https://img.shields.io/circleci/project/github/radarlabs/radar-sdk-js/master.svg" alt="CircleCI branch"></a>
+  <a href="http://npm-stat.com/charts.html?package=radar-sdk-js"><img src="https://img.shields.io/npm/dm/radar-sdk-js.svg?style=flat-square" alt="NPM downloads"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202-blue" alt="License"></a>
+</p>
 
-## Documentation
+<p align="center">
+  ⚡ Use Radar SDKs and APIs to add location context to your apps with just a view lines of code. ⚡
+</p>
 
-See the Radar overview documentation [here](https://radar.com/documentation).
+🔥 Try it! 🔥
+* <a href="https://radar.com/demo/js">Geofencing</a>
+* <a href="Https://radar.com/demo/api">Maps APIs</a>
 
-Then, see the Radar web SDK documentation [here](https://radar.com/documentation/sdk/web).
+## ✨ Features (TODO)
+* Feature 1
+* Feature 2
+* Typescript!
+* etc...
 
-## Running locally
+## 🚀 Installation and Usage
 
-1. Clone the repo
-2. `npm install`
-3. To run the SDK in a browser, run `npm run build && node demo/server.js`, which should open a tab in your browser of choice. Modify the `/src/index.html` file as needed
-4. To run tests, run `npm run test`
+**With npm:** <br />
 
-## Support
+Add the `radar-sdk-js` package
+```bash
+# with npm
+npm install --save radar-sdk-js
+
+# with yarn
+yarn add radar-sdk-js
+```
+
+Then import as an ES Module in your project
+```js
+import Radar from 'radar-sdk-js';
+
+// initialize with your test or live publishable key
+Radar.initialize('prj_test_pk_...', { /* options */ });
+```
+
+**In your html:** <br />
+
+Add the following script in your `html` file
+```html
+<script src="https://js.radar.com/v4.0.0-beta.1/radar.min.js"></script>
+```
+
+Then initialize the Radar SDK
+```html
+<script type="text/javascript">
+  Radar.initialize('prj_test_pk_...', { /* options */ });
+</script>
+```
+
+See more examples and usage in the Radar web SDK documentation [here](https://radar.com/documentation/sdk/web).
+
+
+## 🔗 Other links
+* [Contributing](#)
+* [Migrating from 3.x to 4.x](#)
+
+## 📫 Support
 
 Have questions? We're here to help! Email us at [support@radar.com](mailto:support@radar.com).

package/assets/logo.svg

@@ -0,0 +1,8 @@
+<svg width="235" height="55" viewBox="0 0 235 55" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M67.3513 48.4815H79.4201V33.4628H82.2599L90.8382 48.4815H103.617L93.5004 31.1161C97.9375 29.4148 101.132 26.0708 101.132 20.0868V19.8521C101.132 10.9935 94.9794 6.53481 83.9164 6.53481H67.3513V48.4815ZM79.4201 25.6601V15.5695H83.3839C87.2885 15.5695 89.4183 16.9188 89.4183 20.3215V20.5561C89.4183 23.9588 87.4068 25.6601 83.3247 25.6601H79.4201Z" fill="#000257"/>
+<path d="M116.063 49.1855C121.033 49.1855 123.754 47.1321 125.233 44.9028V48.4815H135.527V28.5935C135.527 20.4388 130.084 16.9775 121.565 16.9775C113.105 16.9775 107.248 20.6148 106.775 28.0068H116.714C116.951 26.0708 118.016 24.3695 120.915 24.3695C124.287 24.3695 124.997 26.3055 124.997 29.2388V29.9428H122.039C111.745 29.9428 105.592 32.7588 105.592 39.9748C105.592 46.4868 110.502 49.1855 116.063 49.1855ZM119.731 42.0868C117.247 42.0868 116.063 40.9722 116.063 39.2122C116.063 36.6895 117.956 35.8681 122.216 35.8681H124.997V37.7455C124.997 40.3855 122.749 42.0868 119.731 42.0868Z" fill="#000257"/>
+<path d="M153.046 49.1855C157.72 49.1855 161.151 46.6628 162.689 43.4948V48.4815H173.279V4.30548H162.689V22.1401C160.915 19.0308 158.016 16.9775 153.165 16.9775C145.829 16.9775 140.031 22.5508 140.031 32.9935V33.4628C140.031 44.0815 145.888 49.1855 153.046 49.1855ZM156.773 41.1482C153.105 41.1482 150.798 38.5082 150.798 33.3455V32.8762C150.798 27.5375 152.928 24.8975 156.892 24.8975C160.796 24.8975 162.985 27.6548 162.985 32.8175V33.2868C162.985 38.5082 160.619 41.1482 156.773 41.1482Z" fill="#000257"/>
+<path d="M188.223 49.1855C193.193 49.1855 195.914 47.1321 197.393 44.9028V48.4815H207.687V28.5935C207.687 20.4388 202.245 16.9775 193.725 16.9775C185.265 16.9775 179.408 20.6148 178.935 28.0068H188.874C189.111 26.0708 190.176 24.3695 193.075 24.3695C196.447 24.3695 197.157 26.3055 197.157 29.2388V29.9428H194.199C183.905 29.9428 177.752 32.7588 177.752 39.9748C177.752 46.4868 182.662 49.1855 188.223 49.1855ZM191.891 42.0868C189.407 42.0868 188.223 40.9722 188.223 39.2122C188.223 36.6895 190.117 35.8681 194.376 35.8681H197.157V37.7455C197.157 40.3855 194.909 42.0868 191.891 42.0868Z" fill="#000257"/>
+<path d="M213.729 48.4815H224.319V33.9321C224.319 29.0041 227.869 27.0095 234.317 27.1855V17.3881C229.525 17.3295 226.271 19.3241 224.319 23.9001V17.7988H213.729V48.4815Z" fill="#000257"/>
+<path d="M45.1923 55L22.5962 0L0 55L22.5962 45.6296L45.1923 55Z" fill="#000257"/>
+</svg>