@github/hydro-analytics-client 2.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +15 -0
- package/package.json +57 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020 GitHub
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Hydro Analytics Client
|
|
2
|
+
|
|
3
|
+
This client sdk provides an easy way to send page views and events to the Hydro Analytics API
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
`npm i -S @github/hydro-analytics-client`
|
|
8
|
+
|
|
9
|
+
## Setup
|
|
10
|
+
|
|
11
|
+
See [the API docs](docs/api.md) for instructions on using the `AnalyticsClient`
|
|
12
|
+
|
|
13
|
+
## Publishing
|
|
14
|
+
|
|
15
|
+
When you are ready to release a new version, create a new [GitHub Release](https://github.com/github/hydro-analytics-client/releases) with the desired version number. Once the release is created, a GitHub Action will automatically publish the package to the NPM registry.
|
package/package.json
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@github/hydro-analytics-client",
|
|
3
|
+
"version": "2.3.1",
|
|
4
|
+
"description": "Client SDK for Hydro Analytics",
|
|
5
|
+
"main": "./dist/index.js",
|
|
6
|
+
"module": "dist/index.js",
|
|
7
|
+
"type": "module",
|
|
8
|
+
"types": "dist/index.d.ts",
|
|
9
|
+
"files": [
|
|
10
|
+
"dist"
|
|
11
|
+
],
|
|
12
|
+
"scripts": {
|
|
13
|
+
"lint": "eslint '**/*.ts'",
|
|
14
|
+
"test": "npm run jest && npm run lint",
|
|
15
|
+
"test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch",
|
|
16
|
+
"jest": "NODE_OPTIONS=--experimental-vm-modules jest",
|
|
17
|
+
"clean": "rm -rf dist",
|
|
18
|
+
"prebuild": "npm run clean",
|
|
19
|
+
"build": "tsc",
|
|
20
|
+
"size-limit": "npm run build && size-limit",
|
|
21
|
+
"prepublishOnly": "npm run build && size-limit"
|
|
22
|
+
},
|
|
23
|
+
"repository": {
|
|
24
|
+
"type": "git",
|
|
25
|
+
"url": "git+https://github.com/github/hydro-analytics-client.git"
|
|
26
|
+
},
|
|
27
|
+
"keywords": [],
|
|
28
|
+
"author": "",
|
|
29
|
+
"prettier": "@github/prettier-config",
|
|
30
|
+
"license": "MIT",
|
|
31
|
+
"bugs": {
|
|
32
|
+
"url": "https://github.com/github/hydro-analytics-client/issues"
|
|
33
|
+
},
|
|
34
|
+
"homepage": "https://github.com/github/hydro-analytics-client#readme",
|
|
35
|
+
"size-limit": [
|
|
36
|
+
{
|
|
37
|
+
"limit": "10kb",
|
|
38
|
+
"path": "dist/index.js"
|
|
39
|
+
}
|
|
40
|
+
],
|
|
41
|
+
"devDependencies": {
|
|
42
|
+
"@github/prettier-config": "0.0.4",
|
|
43
|
+
"@size-limit/preset-small-lib": "^9.0.0",
|
|
44
|
+
"@types/jest": "^27.0.3",
|
|
45
|
+
"eslint": "^8.3.0",
|
|
46
|
+
"eslint-plugin-compat": "^4.2.0",
|
|
47
|
+
"eslint-plugin-escompat": "^3.1.0",
|
|
48
|
+
"eslint-plugin-github": "^4.3.5",
|
|
49
|
+
"eslint-plugin-i18n-text": "^1.0.1",
|
|
50
|
+
"jest": "^27.4.3",
|
|
51
|
+
"prettier": "^2.5.0",
|
|
52
|
+
"size-limit": "^7.0.3",
|
|
53
|
+
"ts-jest": "^27.0.7",
|
|
54
|
+
"ts-node": "^10.4.0",
|
|
55
|
+
"typescript": "^4.5.2"
|
|
56
|
+
}
|
|
57
|
+
}
|