@netacea/cloudflare 5.1.21 → 5.1.22

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 5.1.22 (2023-05-16)
+
+**Note:** Version bump only for package @netacea/cloudflare
+
+
+
+
+
 ## 5.1.21 (2023-05-12)
 
 **Note:** Version bump only for package @netacea/cloudflare

package/README.md

@@ -5,37 +5,33 @@
 [![npm](https://img.shields.io/npm/v/@netacea/cloudflare.svg)](https://www.npmjs.com/package/@netacea/cloudflare)  
 [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
 
-`@netacea/cloudflare` is a package designed to add [Netacea](https://netacea.com) functionality to [Cloudflare Workers](https://workers.cloudflare.com/).
+`@netacea/cloudflare` is a package designed to add [Netacea](https://netacea.com) functionality to [Cloudflare workers](https://workers.cloudflare.com/).
 
 ## Diagrams, Testing & Tooling
 
-Additional documentation for cloudflare can be found [here](https://github.com/Netacea/JavascriptATAIntegration/blob/main/docs/integrations/CLOUDFLARE.md) in the docs folder
+Additional documentation for Cloudflare can be found [here](https://github.com/Netacea/JavascriptATAIntegration/blob/main/docs/integrations/CLOUDFLARE.md).
 
 ## Installation
 
 ### 🤠 __Wrangler__
 
-We strongly recommend installing and using [wrangler](https://github.com/cloudflare/wrangler) to manage your cloudflare workers. Wrangler is a CLI tool designed to make previewing and deploying Cloudflare Workers seamless.
+We strongly recommend installing and using [Wrangler](https://developers.cloudflare.com/workers/wrangler/) to manage your Cloudflare workers. Wrangler is a CLI tool designed to make previewing and deploying Cloudflare workers seamless.
 
-If you need to use root via wsl and are installing wrangler, you may need to run the following set of commands for a error-free install
-`sudo chmod 777 ~/root`
-`npm install -g @cloudflare/wrangler`
-`sudo chmod 700 ~/root`
-`sudo chmod -R 700 ~/root/.wrangler`
+Installation instructions can be found [here](https://developers.cloudflare.com/workers/wrangler/install-and-update/).
 
-Check you have wrangler by using 
+Check whether Wrangler is installed by using
 `wrangler --help`
 
 #### 🌻 Starting fresh
 
-If you use ssh for git, you will need to open `~/.gitconfig` and comment out the following lines while using `wrangler generate`
+When using SSH for git, you will need to create a `.gitconfig` file and include the following lines
 ```
   [url "ssh://git@github.com/"]
   insteadOf = https://github.com
 ```
-otherwise wrangler will fail to clone the project when using `wrangler generate`. 
+otherwise Wrangler will fail to clone the project when using `wrangler generate`. 
 
-After installing wrangler, you can pull the Netacea worker template by running the following:
+After installing Wrangler, you can pull the Netacea worker template by running the following:
 
 ```bash
 wrangler generate netacea-cloudflare-worker https://github.com/netacea/cloudflare-worker-template-typescript
@@ -45,30 +41,30 @@ npm i @netacea/cloudflare@latest
 npm run test
 ```
 
-The tests should pass. (If not please open an issue [here](https://github.com/Netacea/cloudflare-worker-template-typescript/issues)!
+The tests should pass (if they don't, please open an issue [here](https://github.com/Netacea/cloudflare-worker-template-typescript/issues)).
 
 Follow the `README.md` in the [cloudflare-worker-template-typescript](https://github.com/Netacea/cloudflare-worker-template-typescript) repository to get this deployed.
 
-#### ✍ Existing javascript worker
+#### ✍ Existing JavaScript worker
 
-Run the following command to install the netacea worker
+Run the following command to install the Netacea worker
 
-``` bash
-npm i @netacea/cloudflare --save
+```bash
+npm i @netacea/cloudflare
 ```
 
-Require (javascript) or import (typescript) the worker
+Import the worker
 
-``` javascript
-// JAVASCRIPT:
+```javascript
+// CommonJS:
 const NetaceaCloudflare = require('@netacea/cloudflare').default
-// TYPESCRIPT:
+// ES modules:
 import NetaceaCloudflare from '@netacea/cloudflare'
 ```
 
 Then declare a variable for the worker.
 
-``` javascript
+```javascript
 const worker = new NetaceaCloudflare({
   apiKey: 'your-api-key',
   secretKey: 'your-secret-key'
@@ -77,11 +73,40 @@ const worker = new NetaceaCloudflare({
 
 It's best security practice to **not** commit your `apiKey` and `secretKey` to any repository.
 
-Finally in your request handler, call worker.run(event, originRequest) where originRequest is a function that will return a response.
-For example a full typescript worker would look like:
+Finally in your request handler, call `worker.run(event, originRequest)` where `originRequest` is a function that will return a response.
+Below are two examples of workers written in JavaScript and TypeScript:
+
+JavaScript:
+```javascript
+const NetaceaCloudflare = require('@netacea/cloudflare').default
+
+const worker = new NetaceaCloudflare({
+  apiKey: 'your-api-key',
+  secretKey: 'your-secret-key'
+})
+
+async function handleRequestWithNetacea(event) {
+  const response = await worker.run(event, originRequest)
+  event.waitUntil(worker.ingest(event.request, response))
+  return response
+}
+
+async function originRequest(request) {
+  // Implement custom pre-fetch logic here
+  const response = await fetch(request)
+  // Implement custom post-fetch logic here
+  return response
+}
 
-``` javascript
+module.exports = {
+  handleRequestWithNetacea
+}
+```
+
+TypeScript:
+```typescript
 import NetaceaCloudflare from '@netacea/cloudflare'
+
 const worker = new NetaceaCloudflare({
   apiKey: 'your-api-key',
   secretKey: 'your-secret-key'
@@ -103,8 +128,8 @@ async function originRequest(request: Request): Promise<Response> {
 
 ## ⬆ Updating
 
+Updating the Netacea Cloudflare package can be done with the following command:
+
 ```bash
-npm i @netacea/cloudflare@latest --save
+npm i @netacea/cloudflare@latest
 ```
-
-This will update the netacea module to the latest version.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@netacea/cloudflare",
-    "version": "5.1.21",
+    "version": "5.1.22",
     "description": "Netacea Cloudflare CDN Integration",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",
@@ -16,8 +16,8 @@
     },
     "license": "ISC",
     "dependencies": {
-        "@netacea/kinesisingest": "^1.4.20",
-        "@netacea/netaceaintegrationbase": "^1.16.19",
+        "@netacea/kinesisingest": "^1.4.21",
+        "@netacea/netaceaintegrationbase": "^1.16.20",
         "jose": "^4.11.2"
     },
     "devDependencies": {
@@ -34,5 +34,5 @@
         "tsconfig-paths": "^3.9.0",
         "typescript": "^3.9.7"
     },
-    "gitHead": "1a5cfadd98b3e354bdb5f52e46bf1fd80e7f8b27"
+    "gitHead": "9ddcdbfeee58bdae09fb5034378eb76e8eb53e72"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netacea/cloudflare",
-  "version": "5.1.21",
+  "version": "5.1.22",
   "description": "Netacea Cloudflare CDN Integration",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -16,8 +16,8 @@
   },
   "license": "ISC",
   "dependencies": {
-    "@netacea/kinesisingest": "^1.4.20",
-    "@netacea/netaceaintegrationbase": "^1.16.19",
+    "@netacea/kinesisingest": "^1.4.21",
+    "@netacea/netaceaintegrationbase": "^1.16.20",
     "jose": "^4.11.2"
   },
   "devDependencies": {
@@ -34,5 +34,5 @@
     "tsconfig-paths": "^3.9.0",
     "typescript": "^3.9.7"
   },
-  "gitHead": "1a5cfadd98b3e354bdb5f52e46bf1fd80e7f8b27"
+  "gitHead": "9ddcdbfeee58bdae09fb5034378eb76e8eb53e72"
 }