Merge branch 'release-25.4' into 'main'

Release 25.4

See merge request nwac/sdk-ts!95

Author: slahtine

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Version 4.2.0
+
+Changes:
+- Introduced support for Geofencing API
+- Introduced support for Number Verification API
+
+Fixes:
+- Updated mocking libraries to deal with deprecated dependencies
+
 ## Version 4.1.1
 
 Fixes:

Jenkinsfile

@@ -56,6 +56,7 @@ pipeline {
     NAC_TOKEN_PROD = credentials('NAC_TOKEN_PROD')
     TEAMS_WEBHOOK = credentials('TEAMS_WEBHOOK')
     NPM_AUTH_TOKEN = credentials('NPM_AUTH_TOKEN')
+    SDK_NOTIFICATION_SERVER_URL = credentials('SDK_NOTIFICATION_SERVER_URL')
     SONAR_PATH = "/opt/sonar-scanner/bin"
     SONAR_TOKEN = "sonar-token"
   }
@@ -119,7 +120,7 @@ pipeline {
           script {
             sh """
               env | grep gitlab
-              https_proxy="http://fihel1d-proxy.emea.nsn-net.net:8080" npm run integration
+              http_proxy="http://fihel1d-proxy.emea.nsn-net.net:8080" https_proxy="http://fihel1d-proxy.emea.nsn-net.net:8080" npm run integration
             """
           }
         }        

examples/number-verification.ts

@@ -0,0 +1,75 @@
+import express, { Express, Request, Response } from "express";
+import { NetworkAsCodeClient } from "network-as-code";
+
+
+// Initialize the client object with your application key
+const client = new NetworkAsCodeClient("<your-application-key-here>");
+
+
+// Then, create a device object for the phone number you want to check */
+const device = client.devices.get({
+    // The phone number accepts the "+" sign, but not spaces or "()" marks
+    phoneNumber: "+3637123456"
+});
+
+
+/* This authorization_endpoint should be requested by the end user device and not in the backend
+ of your application, since the requesting device is used to determine authorization 
+ for the particular device. You could, for example,
+ handle this by presenting the user with a link or a button to click to initiate the redirect flow.
+ You must provide a redirectUri, where the authorization code will be delivered.
+ See the express example provided below.
+
+ You can add a state value of your choosing to test for CSRF attacks. Your application then should check, 
+ that the state value given to the authorization endpoint matches the one returned to the redirect uri.
+ If the state values do not match, there has likely been a CSRF attack. In this case your application
+ should return a 401 Unauthorized error code. */
+
+const redirectUri = "https://my-example/redirect";
+const scope = "number-verification:verify";
+const loginHint = device.phoneNumber;
+const state = "foobar";
+
+// create a callbacklink
+const callback = await client.authentication.createAuthenticationLink(
+    redirectUri,
+    scope,
+    loginHint,
+    state
+);
+
+
+// Example of a redirectUri to use to receive the authorization code from the authorization endpoint
+const app: Express = express();
+const port = process.env.PORT || 3000;
+
+app.use(express.json());
+
+app.get("/redirect", (req: Request, res: Response) => {
+    res.send(`This is your authorization code: ${req.query.code}`)
+
+    res.status(200).end();
+});
+
+app.listen(port, () => {
+    console.log(`[server]: Server is running at http://localhost:${port}`);
+});
+
+
+
+
+// Add your authorization code here.
+const code = "NaC-authorization-code";
+
+
+/* You can use the Number Verification API with the obtained authorization code.
+ The verifyNumber endpoint will respond with a true or false value. */
+const verificationResult = await device.verifyNumber(code);
+
+console.log(verificationResult);
+
+// The getPhoneNumber endpoint will respond with the phone number of the used Device.
+
+const phoneNumber = await device.getPhoneNumber(code);
+
+console.log(phoneNumber) // "+123456789"

examples/sim-swap.ts

@@ -1,4 +1,4 @@
-import { NetworkAsCodeClient } from "../src";
+import { NetworkAsCodeClient } from "network-as-code";
 
 const client = new NetworkAsCodeClient("<your-token>");
 

integration-tests/configClient.ts

@@ -12,3 +12,8 @@ export const configureClient = (): NetworkAsCodeClient => {
     );
     return client;
 }
+
+export const configureNotificationServerUrl = () : string => {
+    const notificationUrl = `${process.env["SDK_NOTIFICATION_SERVER_URL"]}typescript`;
+    return notificationUrl 
+}

integration-tests/congestionInsights.itest.ts

@@ -9,7 +9,7 @@ let device: Device;
 beforeAll(() => {
     client = configureClient()
     device = client.devices.get({
-        phoneNumber: "+3670123456",
+        phoneNumber: "+3672123456",
     });
 });
 

integration-tests/deviceStatus.itest.ts

@@ -1,10 +1,16 @@
 import { NetworkAsCodeClient } from "../src";
 import "dotenv/config";
 import { Device } from "../src/models/device";
-import { configureClient } from "./configClient";
+import { configureClient, configureNotificationServerUrl } from "./configClient";
+import { ProxyAgent } from "proxy-agent";
+import fetch from "node-fetch";
+
 
 let client: NetworkAsCodeClient;
 let device: Device;
+let notificationUrl: string;
+let agent : ProxyAgent
+
 
 beforeAll(() => {
     client = configureClient();
@@ -16,20 +22,38 @@ beforeAll(() => {
             publicPort: 80,
         },
     });
+    notificationUrl = configureNotificationServerUrl();
+    agent = new ProxyAgent();
 });
 
 describe("Device Status", () => {
     it("can create a connectivity subscription and delete it", async () => {
         const subscription = await client.deviceStatus.subscribe(
             device,
             "org.camaraproject.device-status.v0.connectivity-data",
-            "https://example.com/notify"
+            `${notificationUrl}/notify`
         );
-
         expect(subscription.eventSubscriptionId).toBeDefined();
 
+        await new Promise(resolve => setTimeout(resolve, 5 * 1000));
+        let notification = await fetch(`${notificationUrl}/device-status/get/${subscription.eventSubscriptionId}`,
+            {
+                method: "GET",
+                agent: agent
+            }
+        );
+
+        const data = await notification.json();
+
+        expect(data).not.toBeNull();
+        notification = await fetch(`${notificationUrl}/device-status/delete/${subscription.eventSubscriptionId}`,
+            { 
+                method: 'DELETE',
+                agent: agent
+            });
+
         subscription.delete();
-    });
+    },20 * 1000);
 
     it("can create a connectivity subscription with expiry", async () => {
         const tomorrowDate = new Date(Date.now() + 24 * 60 * 60 * 1000);
@@ -38,7 +62,7 @@ describe("Device Status", () => {
         const subscription = await client.deviceStatus.subscribe(
             device,
             "org.camaraproject.device-status.v0.connectivity-data",
-            "https://example.com/notify",
+            `${notificationUrl}/notify`,
             {
                 subscriptionExpireTime: tomorrowDate,
             }
@@ -48,14 +72,31 @@ describe("Device Status", () => {
             new Date(tomorrowDate.toISOString().replace(".000", ""))
         );
 
+        await new Promise(resolve => setTimeout(resolve, 5 * 1000));
+        let notification = await fetch(`${notificationUrl}/device-status/get/${subscription.eventSubscriptionId}`,
+            {
+                method: "GET",
+                agent: agent
+            }
+        );
+
+        const data = await notification.json();
+
+        expect(data).not.toBeNull();
+        notification = await fetch(`${notificationUrl}/device-status/delete/${subscription.eventSubscriptionId}`,
+            { 
+                method: 'DELETE',
+                agent: agent
+            });
+
         subscription.delete();
-    });
+    },20 * 1000);
 
     it("can create a connectivity subscription with other optional arguments", async () => {
         const subscription = await client.deviceStatus.subscribe(
             device,
             "org.camaraproject.device-status.v0.connectivity-data",
-            "https://example.com/notify",
+            `${notificationUrl}/notify`,
             {
                 maxNumberOfReports: 2,
                 notificationAuthToken: "my-token",
@@ -66,8 +107,25 @@ describe("Device Status", () => {
         expect(subscription.maxNumOfReports).toEqual(2);
         expect(subscription.notificationAuthToken).toEqual("my-token");
 
+        await new Promise(resolve => setTimeout(resolve, 5 * 1000));
+        let notification = await fetch(`${notificationUrl}/device-status/get/${subscription.eventSubscriptionId}`,
+            {
+                method: "GET",
+                agent: agent
+            }
+        );
+
+        const data = await notification.json();
+
+        expect(data).not.toBeNull();
+        notification = await fetch(`${notificationUrl}/device-status/delete/${subscription.eventSubscriptionId}`,
+            { 
+                method: 'DELETE',
+                agent: agent
+            });
+
         subscription.delete();
-    });
+    },20 * 1000);
 
     it("can get a subscription by id", async () => {
         const subscription = await client.deviceStatus.subscribe(