googlemaps / js-url-signature Goto Github PK

View Code? Open in Web Editor NEW

6.0 7.0 8.0 1.75 MB

Sign a URL for Google Maps Platform requests.

License: Apache License 2.0

JavaScript 33.39% TypeScript 66.61%

google maps signature url google-maps googlemaps utility-library

js-url-signature's Introduction

Google Maps JavaScript URL Signing

Description

Sign a URL for Google Maps Platform requests.

Warning: It is not recommended to use this library in client side applications to avoid exposing the secret used to sign the URL.

Install

Available via npm as the package @googlemaps/url-signature.

npm i @googlemaps/url-signature

Documentation

Check out the reference documentation.

Example

Create a signature for a Google Maps request URL or url string.

const signature = createSignature("https://example.com/some-path?foo=bar", "secret");

Returns a new URL having a signature parameter.

const signedUrl = signUrl("https://example.com/some-path?foo=bar", "secret");
signedUrl.href; // "https://example.com/some-path?foo=bar&signature=..."

Create a signature for a path and query string using Hmac SHA1.

const signature = createSignatureForPathAndQuery("/some-path?foo=bar", "secret");

Note: This is not an officially supported Google product

js-url-signature's People

Contributors

Stargazers

Watchers

Forkers

shahmirn isabella232 alifsamad045 eudoroolivares2016 zackdotcomputer developers81828182 guieco

js-url-signature's Issues

1.0.33 release requires `core-js` but states no dependency

We're currently using @googlemaps/google-maps-services-js which has the following dependency on this module

{
  "dependencies": {
    "@googlemaps/url-signature": "^1.0.4",
    ...
  }
}

Unfortunately it would appear that changes to the build process for this module have manifested in the latest release (1.0.33) dist/index.umd.js requiring imports from core-js.

We're currently working around the issue by using npm overrides but I was wondering if it was intentional that core-js hadn't been added to dependencies or peerDependencies for this module.

Upgrade crypto-js as the current have critical vulneravility

Upgrage crypto-js to the 4.2.0 version.

Errors related to source map with Webpack 5

When trying to build a project with Webpack 5 that includes this library, we get a bunch of source map errors.

Compiled with warnings.

Failed to parse source map from '/Users/shahmirn/dev/logistics-platform/node_modules/@googlemaps/url-signature/src/index.ts' file: Error: ENOENT: no such file or directory, open '/Users/shahmirn/dev/logistics-platform/node_modules/@googlemaps/url-signature/src/index.ts'

Search for the keywords to learn more about each warning.
To ignore, add // eslint-disable-next-line to the line before.

WARNING in ../../node_modules/@googlemaps/url-signature/dist/index.esm.js
Module Warning (from ../../node_modules/source-map-loader/dist/cjs.js):
Failed to parse source map from '/Users/shahmirn/dev/logistics-platform/node_modules/@googlemaps/url-signature/src/index.ts' file: Error: ENOENT: no such file or directory, open '/Users/shahmirn/dev/logistics-platform/node_modules/@googlemaps/url-signature/src/index.ts'

webpack compiled with 1 warning

The automated release is failing 🚨

🚨 The automated release from the `main` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://wombat-dressing-room.appspot.com.

Good luck with your project ✨

Your semantic-release bot 📦🚀