@xylabs/pixel 1.1.5 → 1.1.6

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.
Files changed (3) hide show
  1. package/README.md +24 -4
  2. package/jest.config.cjs +4 -0
  3. package/package.json +41 -42
package/README.md CHANGED
@@ -14,6 +14,8 @@
14
14
 
15
15
  - [Title](#sdk-pixel-js)
16
16
  - [Description](#description)
17
+ - [Install](#install)
18
+ - [Scripts](#scripts)
17
19
  - [Maintainers](#maintainers)
18
20
  - [License](#license)
19
21
  - [Credits](#credits)
@@ -22,9 +24,27 @@
22
24
 
23
25
  SDK for User Event Reporting
24
26
 
27
+ ## Install
28
+
29
+ Using npm:
30
+
31
+ ```sh
32
+ npm i --save @xylabs/sdk-js
33
+ ```
34
+
35
+ Using yarn:
36
+
37
+ ```sh
38
+ yarn add @xylabs/sdk-js
39
+ ```
40
+
41
+ ## Scripts
42
+
43
+ See [ts-scripts](https://github.com/xylabs/ts-scripts/blob/main/README.md) for list of shared scripts.
44
+
25
45
  ## Maintainers
26
46
 
27
- - Arie Trouw
47
+ - [Arie Trouw](https://github.com/arietrouw) (<https://arietrouw.com>)
28
48
 
29
49
  ## License
30
50
 
@@ -39,13 +59,13 @@ Made with 🔥and ❄️ by [XY Labs](https://xylabs.com)
39
59
  [npm-badge]: https://img.shields.io/npm/v/@xylabs/pixel.svg
40
60
  [npm-link]: https://www.npmjs.com/package/@xylabs/pixel
41
61
 
42
- [bch-badge]: https://bettercodehub.com/edge/badge/xylabs/sdk-pixel-js?branch=master
62
+ [bch-badge]: https://bettercodehub.com/edge/badge/xylabs/sdk-pixel-js?branch=main
43
63
  [bch-link]: https://bettercodehub.com/results/xylabs/sdk-pixel-js
44
64
 
45
- [codacy-badge]: https://app.codacy.com/project/badge/Grade/tbd
65
+ [codacy-badge]: https://app.codacy.com/project/badge/Grade/c5405a253a0d489a98b2aa711c3c0824
46
66
  [codacy-link]: https://www.codacy.com/gh/xylabs/sdk-pixel-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-pixel-js&utm_campaign=Badge_Grade
47
67
 
48
- [codeclimate-badge]: https://api.codeclimate.com/v1/badges/tbd/maintainability
68
+ [codeclimate-badge]: https://api.codeclimate.com/v1/badges/c926665bade6b2493e32/maintainability
49
69
  [codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-pixel-js/maintainability
50
70
 
51
71
  [snyk-badge]: https://snyk.io/test/github/xylabs/sdk-pixel-js/badge.svg?targetFile=package.json
package/jest.config.cjs ADDED
@@ -0,0 +1,4 @@
1
+ module.exports = {
2
+ preset: 'ts-jest',
3
+ testEnvironment: 'node',
4
+ }
package/package.json CHANGED
@@ -1,30 +1,12 @@
1
1
  {
2
- "name": "@xylabs/pixel",
3
- "homepage": "https://xylabs.com",
4
- "bugs": {
5
- "url": "https://github.com/xylabs/sdk-pixel-js/issues",
6
- "email": "support@xylabs.com"
7
- },
8
- "description": "Event Client for xylabs ESB",
9
2
  "author": {
3
+ "email": "support@xylabs.com",
10
4
  "name": "XY Labs Development Team",
11
- "url": "https://xylabs.com",
12
- "email": "support@xylabs.com"
13
- },
14
- "license": "LGPL-3.0",
15
- "private": false,
16
- "repository": {
17
- "type": "git",
18
- "url": "https://github.com/xylabs/sdk-pixel-js.git"
5
+ "url": "https://xylabs.com"
19
6
  },
20
- "version": "1.1.5",
21
- "main": "dist/index.js",
22
- "module": "dist/index.js",
23
- "types": "dist/index.d.ts",
24
- "sideEffects": false,
25
- "type": "module",
26
- "publishConfig": {
27
- "access": "public"
7
+ "bugs": {
8
+ "email": "support@xylabs.com",
9
+ "url": "https://github.com/xylabs/sdk-pixel-js/issues"
28
10
  },
29
11
  "dependencies": {
30
12
  "async-mutex": "^0.3.2",
@@ -34,37 +16,54 @@
34
16
  "md5": "^2.3.0",
35
17
  "randombytes": "^2.1.0"
36
18
  },
37
- "peerDependencies": {
38
- "@xylabs/sdk-js": "^2",
39
- "axios": "^0",
40
- "rollbar": "^2"
41
- },
42
- "scripts": {
43
- "build": "rm -r -f dist && yarn deps && yarn lint && yarn lint-pkg && yarn compile",
44
- "compile": "tsc -p tsconfig.build.json",
45
- "deploy": "yarn version --patch && yarn build && yarn publish",
46
- "lint-pkg": "npmPkgJsonLint .",
47
- "test": "jest"
48
- },
19
+ "description": "Event Client for xylabs ESB",
49
20
  "devDependencies": {
50
- "@types/jest": "^27.0.2",
21
+ "@types/bn.js": "^5.1.0",
22
+ "@types/jest": "^27.0.3",
51
23
  "@types/js-cookie": "^3.0.1",
52
24
  "@types/lodash": "^4.14.177",
53
25
  "@types/md5": "^2.3.1",
54
26
  "@types/node": "^16",
55
27
  "@types/randombytes": "^2.0.0",
56
- "@xylabs/eslint-config": "^2.0.33",
57
- "@xylabs/sdk-js": "^2.3.4",
58
- "@xylabs/ts-scripts": "1.0.17",
28
+ "@xylabs/eslint-config": "^2.1.4",
29
+ "@xylabs/sdk-js": "^2.3.9",
30
+ "@xylabs/ts-scripts": "1.0.23",
59
31
  "axios": "^0.24.0",
32
+ "bn.js": "^5.2.0",
60
33
  "eslint": "^8",
61
34
  "jest": "^27.3.1",
62
35
  "npm-package-json-lint": "^5.4.2",
63
36
  "npm-package-json-lint-config-default": "^3.0.0",
64
- "prettier": "^2.4.1",
37
+ "prettier": "^2.5.0",
65
38
  "rollbar": "^2",
66
39
  "ts-jest": "^27.0.7",
67
40
  "ts-node": "^10.4.0",
68
- "typescript": "^4.4.4"
69
- }
41
+ "typescript": "^4.5.2"
42
+ },
43
+ "homepage": "https://xylabs.com",
44
+ "license": "LGPL-3.0",
45
+ "main": "dist/index.js",
46
+ "module": "dist/index.js",
47
+ "name": "@xylabs/pixel",
48
+ "peerDependencies": {
49
+ "@xylabs/sdk-js": "^2",
50
+ "axios": "^0",
51
+ "rollbar": "^2"
52
+ },
53
+ "private": false,
54
+ "publishConfig": {
55
+ "access": "public"
56
+ },
57
+ "repository": {
58
+ "type": "git",
59
+ "url": "https://github.com/xylabs/sdk-pixel-js.git"
60
+ },
61
+ "scripts": {
62
+ "lint-pkg": "npmPkgJsonLint .",
63
+ "test": "jest"
64
+ },
65
+ "sideEffects": false,
66
+ "type": "module",
67
+ "types": "dist/index.d.ts",
68
+ "version": "1.1.6"
70
69
  }