akamai-edgegrid 3.1.4 → 3.2.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # RELEASE NOTES
 
+## 3.2.0 (Apr 26, 2022)
+
+#### IMPROVEMENTS:
+* Add Typescript declaration file ([#71](https://github.com/akamai/AkamaiOPEN-edgegrid-node/issues/71))
+
 ## 3.1.4 (Mar 24, 2022)
 
 #### IMPROVEMENTS:

package/index.d.ts

@@ -0,0 +1,33 @@
+import { AxiosError, AxiosResponse } from "axios";
+
+declare class EdgeGrid {
+    constructor(clientTokenOrOptions: string | object,
+        clientSecret?: string,
+        accessToken?: string,
+        host?: string,
+        debug?: boolean);
+
+    request: object;
+    config: object;
+
+    /**
+    * Sends the request and invokes the callback function.
+    *
+    * @param  {Function} callback The callback function.
+    * @return EdgeGrid object (self)
+    */
+    send(callback: (error: AxiosError, response?: AxiosResponse, body?: string) => void): EdgeGrid;
+
+    /**
+    * Builds the request using the properties of the local config Object.
+     *
+    * @param  {Object} req The request Object. Can optionally contain a
+    *                      'headersToSign' property: An ordered list header names
+    *                      that will be included in the signature. This will be
+    *                      provided by specific APIs.
+    * @return EdgeGrid object (self)
+    */
+    auth(req: object): EdgeGrid;
+}
+
+export = EdgeGrid;

package/index.test-d.ts

@@ -0,0 +1,19 @@
+import { expectType } from 'tsd';
+import EdgeGrid = require('.')
+
+const eg = new EdgeGrid({
+    path: '/path/to/.edgerc',
+    section: 'section-name'
+});
+
+expectType<EdgeGrid>(eg)
+
+var req = {
+    path: '/diagnostic-tools/v1/locations',
+    method: 'GET',
+    headers: {},
+    body: 'bodyData'
+}
+expectType<EdgeGrid>(eg.auth(req))
+
+expectType<EdgeGrid>(eg.send((error, resp, body) => console.log(body)))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "akamai-edgegrid",
-  "version": "3.1.4",
+  "version": "3.2.0",
   "description": "Authentication handler for the Akamai OPEN EdgeGrid Authentication scheme in Node.js",
   "main": "index.js",
   "scripts": {
@@ -30,6 +30,7 @@
   },
   "devDependencies": {
     "mocha": "^9.1.3",
-    "nock": "^13.2.2"
+    "nock": "^13.2.2",
+    "tsd": "^0.20.0"
   }
 }

package/src/api.js

@@ -90,6 +90,12 @@ EdgeGrid.prototype.auth = function (req) {
     return this;
 };
 
+/**
+ * Sends the request and invokes the callback function.
+ *
+ * @param  {Function} callback The callback function.
+ * @return EdgeGrid object (self)
+ */
 EdgeGrid.prototype.send = function (callback) {
     axios(this.request).then(response => {
         callback(null, response, JSON.stringify(response.data));

package/test1/bundle.json

@@ -1,5 +0,0 @@
-{
-    "edgeworker-version": "1.0",
-    "description" : "Four Events"
-}
-

package/test1/main.js

@@ -1,15 +0,0 @@
-export function onClientRequest(request) {
-	request.addHeader('EW_CLIENT_REQ', 'Automation Client Req');
-}
-
-export function onClientResponse(request, response) {
-	response.addHeader('EW_CLIENT_RSP', 'Automation Client Rsp');
-}
-
-export function onOriginResponse(request, response) {
-  response.addHeader('EW_ORIGIN_RSP', 'Automation Origin Rsp');
-}
-
-export function onOriginRequest(request) {
-	request.addHeader('EW_ORIGIN_REQ', 'Automation Origin Req');
-}

package/test1 2/bundle.json

@@ -1,5 +0,0 @@
-{
-    "edgeworker-version": "1.0",
-    "description" : "Four Events"
-}
-

package/test1 2/main.js

@@ -1,15 +0,0 @@
-export function onClientRequest(request) {
-	request.addHeader('EW_CLIENT_REQ', 'Automation Client Req');
-}
-
-export function onClientResponse(request, response) {
-	response.addHeader('EW_CLIENT_RSP', 'Automation Client Rsp');
-}
-
-export function onOriginResponse(request, response) {
-  response.addHeader('EW_ORIGIN_RSP', 'Automation Origin Rsp');
-}
-
-export function onOriginRequest(request) {
-	request.addHeader('EW_ORIGIN_REQ', 'Automation Origin Req');
-}

package/test5/bundle.json

@@ -1,5 +0,0 @@
-{
-    "edgeworker-version": "1.0",
-    "description" : "Four Events"
-}
-

package/test5/main.js

@@ -1,15 +0,0 @@
-export function onClientRequest(request) {
-	request.addHeader('EW_CLIENT_REQ', 'Automation Client Req');
-}
-
-export function onClientResponse(request, response) {
-	response.addHeader('EW_CLIENT_RSP', 'Automation Client Rsp');
-}
-
-export function onOriginResponse(request, response) {
-  response.addHeader('EW_ORIGIN_RSP', 'Automation Origin Rsp');
-}
-
-export function onOriginRequest(request) {
-	request.addHeader('EW_ORIGIN_REQ', 'Automation Origin Req');
-}