Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build/update-release-rules #10

Merged
merged 10 commits into from
Jul 7, 2022
14 changes: 13 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 1.0.0-test.1 (2022-06-27)
# 1.0.0 (2022-06-30)


### Features
Expand All @@ -11,3 +11,15 @@
* Revert "ci: add NODE_AUTH_TOKEN" ([26889f9](https://github.com/fingerprintjs/fingerprintjs-pro-svelte/commit/26889f9be7f05e7de3b6933032f57ca43c992860))
* Revert "chore(release): 1.0.0-test.1 [skip ci]" ([ea82f6e](https://github.com/fingerprintjs/fingerprintjs-pro-svelte/commit/ea82f6ef29a3da1ee8df9e6102d7b8352e1ce2f8))
* Revert "chore(release): 1.0.0-test.1 [skip ci]" ([4e77e01](https://github.com/fingerprintjs/fingerprintjs-pro-svelte/commit/4e77e013d396096e327408ef088fafc85a491256))

# 1.0.0-test.1 (2022-06-27)

### Features

- Add svelte integration ([ee5bfb0](https://github.com/fingerprintjs/fingerprintjs-pro-svelte/commit/ee5bfb0255fc7d49696c8e267ef3600736b5d736))

### Reverts

- Revert "ci: add NODE_AUTH_TOKEN" ([26889f9](https://github.com/fingerprintjs/fingerprintjs-pro-svelte/commit/26889f9be7f05e7de3b6933032f57ca43c992860))
- Revert "chore(release): 1.0.0-test.1 [skip ci]" ([ea82f6e](https://github.com/fingerprintjs/fingerprintjs-pro-svelte/commit/ea82f6ef29a3da1ee8df9e6102d7b8352e1ce2f8))
- Revert "chore(release): 1.0.0-test.1 [skip ci]" ([4e77e01](https://github.com/fingerprintjs/fingerprintjs-pro-svelte/commit/4e77e013d396096e327408ef088fafc85a491256))
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
<p align="center">
<a href="https://fingerprintjs.com">
<img src="https://raw.githubusercontent.com/fingerprintjs/fingerprintjs-pro-svelte/main/resources/logo.svg" alt="FingerprintJS" width="312px" />
<a href="https://fingerprint.com">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/fingerprintjs/fingerprintjs-pro-svelte/main/resources/logo_light.svg" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/fingerprintjs/fingerprintjs-pro-svelte/main/resources/logo_dark.svg" />
<img src="https://raw.githubusercontent.com/fingerprintjs/fingerprintjs-pro-svelte/main/resources/logo_dark.svg" alt="Fingerprint" width="312px" />
</picture>
</a>

</p>
<p align="center">
<a href="https://github.com/fingerprintjs/fingerprintjs-pro-svelte/actions/workflows/release.yml">
Expand All @@ -26,12 +31,12 @@

# FingerprintJS Pro Svelte

FingerprintJS Pro Svelte is an easy-to-use Svelte library for [FingerprintJS Pro](https://fingerprintjs.com/) that also
FingerprintJS Pro Svelte is an easy-to-use Svelte library for [FingerprintJS Pro](https://fingerprint.com/) that also
works with [svelte-kit](https://kit.svelte.dev/).
Example apps can be found in the [examples](./examples) folder.
This package works with FingerprintJS Pro, it is not compatible with open-source FingerprintJS. You can learn more about
the difference between FingerprintJS Pro and open-source FingerprintJS in
the [official documentation](https://dev.fingerprintjs.com/docs/pro-vs-open-source).
the [official documentation](https://dev.fingerprint.com/docs/pro-vs-open-source).

## Installation

Expand All @@ -48,13 +53,13 @@ npm install @fingerprintjs/fingerprintjs-pro-svelte
## Getting started

In order to identify visitors, you'll need a FingerprintJS Pro account (you
can [sign up for free](https://dashboard.fingerprintjs.com/signup/)).
can [sign up for free](https://dashboard.fingerprint.com/signup/)).
You can learn more about API keys in
the [official FingerprintJS Pro documentation](https://dev.fingerprintjs.com/docs/quick-start-guide).
the [official FingerprintJS Pro documentation](https://dev.fingerprint.com/docs/quick-start-guide).

1. Wrap your application (or component) in `FpjsProvider`. You can specify multiple configuration options. \
Set a region if you have chosen a non-global region during registration. Please refer to
the [Regions page](https://dev.fingerprintjs.com/docs/regions).
the [Regions page](https://dev.fingerprint.com/docs/regions).

```svelte
// App.svelte
Expand Down Expand Up @@ -116,16 +121,16 @@ See the full code in example apps located in [examples folder](./examples).
:warning: **WARNING** If you use data from `extendedResult`, please pay additional attention to caching strategy.

FingerprintJS Pro uses API calls as the basis for billing.
Our [best practices](https://dev.fingerprintjs.com/docs/caching-visitor-information) strongly recommend using cache to
Our [best practices](https://dev.fingerprint.com/docs/caching-visitor-information) strongly recommend using cache to
optimise API calls rate. The Library uses the SessionStorage cache strategy by default.

Some fields from the [extendedResult](https://dev.fingerprintjs.com/docs/js-agent#extendedresult) (e.g `ip`
Some fields from the [extendedResult](https://dev.fingerprint.com/docs/js-agent#extendedresult) (e.g `ip`
or `lastSeenAt`) might change for the same visitor. If you need exact current data, it is recommended to
pass `ignoreCache=true` inside `getData` function.

## Documentation

You can find API reference [here](https://fingerprintjs.github.io/fingerprintjs-pro-svelte/).

This library uses [FingerprintJS Pro agent](https://fingerprintjs.com/github/) internally. The documentation for the
FingerprintJS Pro agent is available on https://dev.fingerprintjs.com/docs.
This library uses [FingerprintJS Pro agent](https://fingerprint.com/github/) internally. The documentation for the
FingerprintJS Pro agent is available on https://dev.fingerprint.com/docs.
22 changes: 17 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@fingerprintjs/fingerprintjs-pro-svelte",
"version": "1.0.0-test.1",
"version": "1.0.0",
"description": "FingerprintJS Pro integration for Svelte",
"author": "Fingerprint, Inc (https://fingerprint.com)",
"license": "MIT",
Expand Down Expand Up @@ -47,8 +47,10 @@
"devDependencies": {
"@commitlint/cli": "^17.0.2",
"@commitlint/config-conventional": "^17.0.2",
"@semantic-release/changelog": "^6.0.1",
"@semantic-release/git": "^10.0.1",
"@semantic-release/changelog": "6.0.1",
"@semantic-release/git": "10.0.1",
"@semantic-release/github": "8.0.4",
"@semantic-release/npm": "9.0.1",
"@sveltejs/adapter-auto": "next",
"@sveltejs/kit": "next",
"@testing-library/svelte": "^3.1.3",
Expand All @@ -67,7 +69,7 @@
"lint-staged": "^13.0.2",
"prettier": "^2.6.2",
"prettier-plugin-svelte": "^2.7.0",
"semantic-release": "^19.0.3",
"semantic-release": "19.0.3",
"svelte": "^3.30.1",
"svelte-check": "^2.7.1",
"svelte-jester": "^2.3.2",
Expand Down Expand Up @@ -102,7 +104,17 @@
}
],
"plugins": [
"@semantic-release/commit-analyzer",
[
"@semantic-release/commit-analyzer",
{
"releaseRules": [
{
"type": "docs",
"release": "patch"
}
]
}
],
"@semantic-release/release-notes-generator",
"@semantic-release/changelog",
[
Expand Down
16 changes: 0 additions & 16 deletions resources/logo.svg

This file was deleted.

Loading