@ckies/library - npm Package Compare versions

Comparing version 0.0.6 to 0.1.0

dist/index.d.ts

 export { Cookie } from './lib/Cookie';
-export { CKies, CookieOptions, CookieType } from './lib/CKies';
+export { CKies as ckies, CookieOptions, CookieType } from './lib/CKies';

dist/index.js

@@ -6,5 +6,5 @@ "use strict";
 var CKies_1 = require("./lib/CKies");
-exports.CKies = CKies_1.CKies;
+exports.ckies = CKies_1.CKies;
 exports.CookieOptions = CKies_1.CookieOptions;
 exports.CookieType = CKies_1.CookieType;
 //# sourceMappingURL=index.js.map

package.json

@@ -10,3 +10,5 @@ {
     "lint": "tslint src/**/*.ts",
-    "build": "tsc"
+    "build": "yarn build:library; yarn build:browser",
+    "build:library": "tsc",
+    "build:browser": "webpack"
   },
@@ -17,4 +19,12 @@ "repository": {
   },
-  "keywords": [],
-  "author": "Cookies.WTF <[e-mail]>",
+  "keywords": [
+    "cookies",
+    "gdpr",
+    "privacy",
+    "builder",
+    "policy",
+    "settings",
+    "browser"
+  ],
+  "author": "Sebastian Müller <[e-mail]>",
   "license": "MIT",
@@ -31,4 +41,7 @@ "bugs": {
     "ts-jest": "^22.4.4",
+    "ts-loader": "^4.3.0",
     "tslint": "^5.10.0",
-    "typescript": "^2.8.3"
+    "typescript": "^2.8.3",
+    "webpack": "^4.8.3",
+    "webpack-cli": "^2.1.3"
   },
@@ -49,3 +62,3 @@ "jest": {
   },
-  "version": "0.0.6"
+  "version": "0.1.0"
 }

README.md

@@ -1,1 +0,27 @@
-# Library
+# Library
+
+Approach to offer a generic tooling for GDPR-compliant cookie handling. Use `@ckies/library` in your JavaScript or TypeScript projects, or use it as a drop-in solution for static projects.
+
+## Usage
+
+### Custom Build Process
+
+```javascript
+import { ckies } from '@ckies/library'
+
+if (ckies.useMarketing()) {
+  console.log('Marketing cookies are allowed!')
+}
+```
+
+### Hosted Library
+
+```html
+<script src="ckies.min.js"></script>
+
+<script>
+  if (ckies.useMarketing()) {
+    console.log('Marketing cookies are allowed!')
+  }
+</script>
+```

tests/lib/CKies.test.ts

@@ -1,7 +0,5 @@
-import {
-  CKies,
-  CONFIG_EXPIRATION,
-  CookieType
-} from '../../src/lib/CKies'
+import { ckies as CKies, CookieType } from '../../src'
+import { CONFIG_EXPIRATION } from '../../src/lib/CKies'
 
+
 describe('CKies', () => {
@@ -8,0 +6,0 @@ describe('CONFIGE_EXPIRATION', () => {

tests/lib/Cookie.test.ts

@@ -1,2 +0,2 @@
-import { Cookie } from '../../src/lib/Cookie'
+import { Cookie } from '../../src'
 
@@ -3,0 +3,0 @@ describe('Cookie', () => {

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

230143

increased by77.54%

Number of package files

18

increased by20%

Lines of code

266

increased by11.76%

Number of lines in readme file

27

increased by2600%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

10

increased by42.86%

No dependency changes