@netacea/f5 1.4.2 → 1.5.2

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 (4) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +16 -1
  3. package/dist/package.json +4 -4
  4. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -3,6 +3,33 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [1.5.2](https://github.com/Netacea/JavascriptATAIntegration/compare/@netacea/f5@1.5.1...@netacea/f5@1.5.2) (2022-06-01)
7
+
8
+ **Note:** Version bump only for package @netacea/f5
9
+
10
+
11
+
12
+
13
+
14
+ ## [1.5.1](https://github.com/Netacea/JavascriptATAIntegration/compare/@netacea/f5@1.5.0...@netacea/f5@1.5.1) (2022-05-26)
15
+
16
+ **Note:** Version bump only for package @netacea/f5
17
+
18
+
19
+
20
+
21
+
22
+ # [1.5.0](https://github.com/Netacea/JavascriptATAIntegration/compare/@netacea/f5@1.4.2...@netacea/f5@1.5.0) (2022-04-29)
23
+
24
+
25
+ ### Features
26
+
27
+ * **Akamai:** ING-155: remove all .npmrc files ([07774ad](https://github.com/Netacea/JavascriptATAIntegration/commit/07774ad034a9a3076adae131cf784e1e22fea73e))
28
+
29
+
30
+
31
+
32
+
6
33
  ## [1.4.2](https://github.com/Netacea/JavascriptATAIntegration/compare/@netacea/f5@1.4.1...@netacea/f5@1.4.2) (2022-03-23)
7
34
 
8
35
  **Note:** Version bump only for package @netacea/f5
package/README.md CHANGED
@@ -1,4 +1,5 @@
1
1
  # Netacea F5
2
+
2
3
  ![Netacea Header](https://assets.ntcacdn.net/header.jpg)
3
4
 
4
5
  [![npm](https://img.shields.io/npm/v/@netacea/f5.svg)](https://www.npmjs.com/package/@netacea/f5)  
@@ -6,15 +7,20 @@
6
7
 
7
8
  `@netacea/f5` is a package designed to add [Netacea](https://netacea.com) functionality to F5.
8
9
 
9
- # Installation
10
+ ## Installation
11
+
10
12
  ### 🌻 Starting fresh
13
+
11
14
  Contact one of the Netacea support teams for the TCL code to run. Code examples are below.
12
15
 
13
16
  ### ✍ Existing ILX Workspace
17
+
14
18
  Run the following command to install the netacea worker
19
+
15
20
  ``` bash
16
21
  npm i @netacea/f5 --save
17
22
  ```
23
+
18
24
  Require (javascript) or import (typescript) the worker
19
25
 
20
26
  ``` javascript
@@ -23,7 +29,9 @@ const NetaceaF5 = require('@netacea/f5').default
23
29
  // TYPESCRIPT:
24
30
  import NetaceaF5 from '@netacea/f5'
25
31
  ```
32
+
26
33
  Then declare a variable for the worker and register the handlers.
34
+
27
35
  ``` javascript
28
36
  const worker = new NetaceaF5({
29
37
  apiKey: 'your-api-key',
@@ -32,9 +40,11 @@ const worker = new NetaceaF5({
32
40
  netacea.registerMitigateHandler(ilx)
33
41
  netacea.registerIngestHandler(ilx)
34
42
  ```
43
+
35
44
  It's best security practice to **not** commit your `apiKey` and `secretKey` to any repository.
36
45
 
37
46
  Example Typescript:
47
+
38
48
  ``` typescript
39
49
  import NetaceaF5, { F5ConstructorArgs, IlxServer } from '@netacea/f5'
40
50
  import * as NetaceaConfig from './NetaceaConfig.json'
@@ -47,8 +57,11 @@ netacea.registerIngestHandler(ilx)
47
57
 
48
58
  ilx.listen()
49
59
  ```
60
+
50
61
  ## 🥇 Examples
62
+
51
63
  Example Javascript:
64
+
52
65
  ``` javascript
53
66
  const NetaceaF5 = require('@netacea/f5').default
54
67
  const worker = new NetaceaF5({
@@ -65,7 +78,9 @@ netacea.registerIngestHandler(ilx)
65
78
  ```
66
79
 
67
80
  ## ⬆ Updating
81
+
68
82
  ```bash
69
83
  npm i @netacea/f5@latest --save
70
84
  ```
85
+
71
86
  This will update the netacea module to the latest version.
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@netacea/f5",
3
- "version": "1.4.2",
3
+ "version": "1.5.2",
4
4
  "description": "Netacea F5 CDN integration",
5
5
  "main": "dist/src/index.js",
6
6
  "types": "dist/src/index.d.ts",
@@ -27,9 +27,9 @@
27
27
  "typescript": "^3.9.7"
28
28
  },
29
29
  "dependencies": {
30
- "@netacea/netaceaintegrationbase": "^1.9.0",
31
- "@netacea/netaceaintegrationtestrunner": "^1.4.0",
30
+ "@netacea/netaceaintegrationbase": "^1.10.2",
31
+ "@netacea/netaceaintegrationtestrunner": "^1.5.2",
32
32
  "f5-nodejs": "^1.0.0"
33
33
  },
34
- "gitHead": "fd7d2a7a3bc83f2e585e49c8ce2c5dd0f39dbddd"
34
+ "gitHead": "b1189a7ca84ca3da0401f5dfe4a8ef2de3a27a2a"
35
35
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@netacea/f5",
3
- "version": "1.4.2",
3
+ "version": "1.5.2",
4
4
  "description": "Netacea F5 CDN integration",
5
5
  "main": "dist/src/index.js",
6
6
  "types": "dist/src/index.d.ts",
@@ -27,9 +27,9 @@
27
27
  "typescript": "^3.9.7"
28
28
  },
29
29
  "dependencies": {
30
- "@netacea/netaceaintegrationbase": "^1.9.0",
31
- "@netacea/netaceaintegrationtestrunner": "^1.4.0",
30
+ "@netacea/netaceaintegrationbase": "^1.10.2",
31
+ "@netacea/netaceaintegrationtestrunner": "^1.5.2",
32
32
  "f5-nodejs": "^1.0.0"
33
33
  },
34
- "gitHead": "fd7d2a7a3bc83f2e585e49c8ce2c5dd0f39dbddd"
34
+ "gitHead": "b1189a7ca84ca3da0401f5dfe4a8ef2de3a27a2a"
35
35
  }