@localnerve/csp-hashes 2.0.1 → 2.0.3

package/index.js

@@ -4,7 +4,7 @@
  * Return a Vinyl transform object stream to process html files for
  * generating the required CSP hashes for inline and attribute scripts, styles.
  * 
- * Copyright (c) 2022 Alex Grant (@localnerve), LocalNerve LLC
+ * Copyright (c) 2022-2023 Alex Grant (@localnerve), LocalNerve LLC
  * Licensed under the MIT license.
  */
 /* eslint-env node */

package/lib/index.js

@@ -4,7 +4,7 @@
  * Return a Vinyl transform object stream to process html files for
  * generating the required CSP hashes for inline and attribute scripts, styles.
  * 
- * Copyright (c) 2022 Alex Grant (@localnerve), LocalNerve LLC
+ * Copyright (c) 2022-2023 Alex Grant (@localnerve), LocalNerve LLC
  * Licensed under the MIT license.
  */
 import { Transform } from 'stream';

package/lib/removeCspMeta.js

@@ -4,7 +4,7 @@
  * A convenience method to remove the content of a Content-Security-Policy in a meta tag.
  * Useful for development builds that need to ignore CSP meta tags.
  * 
- * Copyright (c) 2022 Alex Grant (@localnerve), LocalNerve LLC
+ * Copyright (c) 2022-2023 Alex Grant (@localnerve), LocalNerve LLC
  * Licensed under the MIT license.
  */
 import { Transform } from 'stream';

package/license.md

@@ -1,4 +1,4 @@
-Copyright 2022, Alex Grant, LocalNerve, LLC
+Copyright 2022-2023, Alex Grant, LocalNerve, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localnerve/csp-hashes",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "Flexible library to generate CSP hashes",
   "main": "index.js",
   "type": "module",
@@ -16,9 +16,9 @@
   },
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",
-    "eslint": "^8.30.0",
-    "jest": "^29.3.1",
-    "vinyl": "^2.2.1"
+    "eslint": "^8.36.0",
+    "jest": "^29.5.0",
+    "vinyl": "^3.0.0"
   },
   "dependencies": {
     "cheerio": "^1.0.0-rc.12"

package/readme.md

@@ -8,6 +8,7 @@
 
 ## Contents
 + [Overview](#overview)
++ [Breaking Changes](#breaking-changes)
 + [API](#API)
   + [Options](#options)
     + [Callback Function](#callback-function)
@@ -15,11 +16,15 @@
 + [Example Usage](#example-usage)
   + [CSP Headers](#build-step-to-maintain-csp-headers)
   + [Meta Tag](#build-step-to-maintain-csp-meta-tags)
+  + [Non-Esm Usage](#non-esm-usage)
 + [MIT License](#license)
 
 ## Overview
 This Nodejs library generates script and style inline element and attribute hashes. It is for use in the generation of HTTP content security policy (CSP) headers or to replace/update Meta tags as a website build step. Ready for use with [Gulp](https://github.com/gulpjs/gulp).
 
+## Breaking Changes
++ As of Version 2+, this is an ES Module. See [Non-Esm Usage](#non-esm-usage) for how to use outside of ESM.
+
 ## Prerequisites
 + NodeJS 14+
 
@@ -154,6 +159,19 @@ export function stripCspMetaContents (settings) {
 }
 ```
 
+### Non-ESM usage
+As of Version 2, this package is an ES Module, making it incompatible with `require`. To use outside of ESM, you can use this with a dynamic import as in the following example:
+
+```javascript
+import('@localnerve/csp-hashes').then(({ hashstream }) => {
+  hashstream({
+    callback: (p, hashes, contents) => {
+      // do stuff
+    }
+  });
+});
+```
+
 ## LICENSE
 
 * [MIT, Alex Grant, LocalNerve, LLC](license.md)