@fat-zebra/sdk 1.5.1 → 1.5.3-beta.1

package/.idea/fatzebra-js.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/fatzebra-js.iml" filepath="$PROJECT_DIR$/.idea/fatzebra-js.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/README.dev.md

@@ -130,6 +130,39 @@ The deployed SDKs are available from the following URLs.
 * Sandbox: https://cdn.pmnts-sandbox.io/sdk/v1/fatzebra.js
 * Production: https://cdn.pmnts.io/sdk/v1/fatzebra.js
 
+## Release react npm package
+
+Prerequisite: it is essential that you have been added to the https://www.npmjs.com/ group account.
+
+To release the react npm package
+
+``` 
+    git checkout master 
+    git pull 
+```
+
+then run 
+
+```
+    npm run npm:publish
+```
+
+You will be prompted with: 
+
+```
+enter (y) for minor release or (n) for patch release
+```
+
+if it is a major release i.e. a breaking change please update the script/consult with management as major release would indicate a breaking change.
+
+You will then see the project build and finally be prompted to:
+```
+Press ENTER to open in the browser...
+```
+
+from here enter your 2FA code and voila! You have published a new version of the SDK. Go tell some merchants.
+
+
 ## Release Management
 
 The release of the sdk follows a weekly schedule. In the beginning of a new release cycle, do the following
@@ -147,3 +180,8 @@ The release of the sdk follows a weekly schedule. In the beginning of a new rele
 11. Push git tag. `git push origin vX.X.X`.
 
 Upon successful CI , a new entry with title 'Merged in release/vX.X,X' will be visible in the master branch page. This provides us with a clear view of what gets released in the past. Moreoever, we can quickly find out the list of features/bug fixes in a release by referring to the PR of the release candidate.
+
+
+## Rollback management
+
+The CDN is now versioned across staging, sandbox and production environments. The pipeline will upload a version to override the existing deployment, but also a version of the build to a folder in s3. The folder will be a shortened version of the commit hash. This will allow us to advise merchants to rollback to a specific working commit hash, or for us to test different versions in gazelle to facilitate a rollback if necessary.

package/README.md

@@ -1 +1,4 @@
-# Fat Zebra SDK
+# Fat Zebra SDK
+
+## Change log
+Monday 8th - updated the package to consume version from a version.ts file, rather than from package.json.

package/build-styles.js

@@ -3,7 +3,14 @@ const path = require('path');
 
 // Define the source file and the destination folder
 const sourceFile = path.join(__dirname, './src/styles.css');
-const destinationFolder = path.join(__dirname, 'dist/' + process.env.ENVIRONMENT);
+
+let destinationFolder;
+if (process.env.REACT) {
+  destinationFolder = path.join(__dirname, 'dist');
+} else {
+  destinationFolder = path.join(__dirname, 'dist/' + process.env.ENVIRONMENT);
+}
+
 const destinationFile = path.join(destinationFolder, 'fatzebra.css');
 
 // Copy the file

package/dist/index.js

@@ -1,9 +1,10 @@
 import "ts-polyfill";
 import "custom-event-polyfill";
-import { FatZebra } from "./main";
+const FatZebra = require("./main").FatZebra;
 import { PublicEvent } from "./shared/types";
 import { Environment } from "./shared/env";
 export { PublicEvent, Environment };
-if (typeof window !== "undefined") {
+// Assign window.FatZebra conditionally
+if (typeof window !== "undefined" && FatZebra) {
     window.FatZebra = FatZebra;
 }

package/dist/sca/cardinal.js

@@ -21,7 +21,7 @@ export const defaultConfig = {
     timeout: 8000,
     maxRequestRetries: 3,
     logging: {
-        level: 'verbose'
+        level: 'on'
     }
 };
 export default class CardinalManager {
@@ -50,7 +50,6 @@ export default class CardinalManager {
         });
     }
     setup(jwt) {
-        console.log("CARDINAL SETUP", jwt);
         window.Cardinal.setup(CardinalWorkflow.INIT, { jwt });
     }
     onPaymentValidated(handler) {

package/dist/sca/index.js

@@ -90,7 +90,6 @@ class Sca {
                 this.sessionId = paymentsSetupCompleteResponse.sessionId;
                 this.perform3DS({ sessionID: paymentsSetupCompleteResponse.sessionId });
             }));
-            console.log("CARDINAL SETUP GOES HERE");
             this._cardinal.setup(cardinalJwt);
         });
     }

package/dist/shared/util.d.ts

@@ -2,5 +2,5 @@ declare const toCamelCase: (s: string) => string;
 declare const toSnakeCase: (s: string) => string;
 declare const toObjectWithSnakeCaseKeys: (o: any) => any;
 declare const toObjectWithCamelCaseKeys: (o: any) => any;
-declare const getSdkVersionNumber: () => any;
+declare const getSdkVersionNumber: () => string;
 export { toCamelCase, toSnakeCase, toObjectWithCamelCaseKeys, toObjectWithSnakeCaseKeys, getSdkVersionNumber, };

package/dist/shared/util.js

@@ -1,4 +1,4 @@
-const _package = require('../../package.json');
+import { version } from '../version';
 const toCamelCase = (s) => {
     return s.replace(/_([a-z])/g, (g) => g[1].toUpperCase());
 };
@@ -77,6 +77,6 @@ const toObjectWithCamelCaseKeys = (o) => {
     return converted;
 };
 const getSdkVersionNumber = () => {
-    return _package.version;
+    return version;
 };
 export { toCamelCase, toSnakeCase, toObjectWithCamelCaseKeys, toObjectWithSnakeCaseKeys, getSdkVersionNumber, };

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare const version = "1.5.2";

package/dist/version.js

@@ -0,0 +1 @@
+export const version = '1.5.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fat-zebra/sdk",
-  "version": "1.5.1",
+  "version": "1.5.3-beta.1",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -9,14 +9,15 @@
     "build:staging": "cp .env.staging .env && export ENVIRONMENT=staging && npx webpack --config webpack.config.dev.js && node build-styles.js",
     "build:sandbox": "cp .env.sandbox .env && export ENVIRONMENT=sandbox && npx webpack --config webpack.config.prod.js && node build-styles.js",
     "build:production": "cp .env.production .env && export ENVIRONMENT=production && npx webpack --config webpack.config.prod.js && node build-styles.js",
-    "build:package": "yarn tsc -p tsconfig.package.json && node build-styles.js",
+    "build:package": "tsc -p tsconfig.package.json && REACT=true ENVIRONMENT=production node build-styles.js",
     "start:local:api": "export MERCHANT_MODE=api && npm run build:local --watch && webpack serve --config webpack.config.dev.js --open 'Google Chrome'",
     "start:local:hpp": "export MERCHANT_MODE=hpp && npm run build:local --watch && webpack serve --config webpack.config.dev.js --open 'Google Chrome'",
     "start:staging:api": "export MERCHANT_MODE=api && npm run build:staging --watch && webpack serve --config webpack.config.dev.js --open 'Google Chrome'",
     "start:staging:hpp": "export MERCHANT_MODE=hpp && npm run build:staging --watch && webpack serve --config webpack.config.dev.js --open 'Google Chrome'",
     "start:staging:es5": "export MERCHANT_MODE=es5 && npm run build:staging --watch && webpack serve --config webpack.config.dev.js --open 'Google Chrome'",
     "start:docker": "npm run build:dev --watch && webpack serve --config webpack.config.dev.js --host 0.0.0.0",
-    "generate:jwt": "node scripts/generate-access-token.js"
+    "generate:jwt": "node scripts/generate-access-token.js",
+    "npm:publish": "node scripts/release-package.js"
   },
   "keywords": [],
   "author": "",
@@ -30,7 +31,7 @@
     "@types/nock": "^11.1.0",
     "@types/react": "^18.2.15",
     "@types/react-dom": "^18.2.7",
-    "audit-ci": "^3.0.0",
+    "audit-ci": "^6.6.1",
     "dotenv": "^16.0.1",
     "dotenv-webpack": "^8.0.0",
     "ejs": "^3.0.1",
@@ -52,7 +53,7 @@
   },
   "dependencies": {
     "ajv": "^6.12.3",
-    "axios": "^0.21.1",
+    "axios": "^1.6.4",
     "custom-event-polyfill": "^1.0.7",
     "ts-polyfill": "^3.8.2",
     "url-template": "^3.1.0"
@@ -61,4 +62,4 @@
     "react": ">= 16",
     "react-dom": ">= 16"
   }
-}
+}

package/scripts/release-package.js

@@ -0,0 +1,113 @@
+const { execSync } = require('child_process');
+const shell = process.env.SHELL;
+
+const readline = require('node:readline').createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+const fs = require('fs');
+const path = require('path');
+/**
+ * Builds and publishes to npm (for production)
+ *
+ */
+function publish() {
+  console.log("running build...");
+  try {
+    // Running the command synchronously and inheriting the shell
+    execSync(`${shell} -c "npm run build:package && npm publish"`, { stdio: 'inherit' });
+  } catch (error) {
+    // This will catch any errors that occur during the execution of the command
+    console.error(`Execution error: ${error}`);
+    console.error(`stderr: ${error.stderr}`);
+  }
+}
+
+/**
+ * Writes version number to package.json and to another file to read from
+ *
+ * @param {string} path - path to where the file will be written (package.json | version.ts).
+ * @param {string} content - content of file (version number).
+ */
+function writeToFile(path, content) {
+  fs.writeFileSync(path, content, 'utf8', (err) => {
+    if (err) {
+      console.error('Error writing version to file:', err);
+    } else {
+      console.log(`content: ${content} written to ${path}`);
+    }
+  });
+}
+
+/**
+ * take data from package.json and applies increment (depending on major/minor upgrade)
+ *
+ * @param {string} data - package.json data
+ * @param {string} releaseType - minor or major release
+ * @returns {Object|null} The updated package.json object with the incremented version, or null if parsing fails.
+ */
+function increment(data, releaseType) {
+  let packageJson;
+  try {
+    packageJson = JSON.parse(data);
+  } catch (parseErr) {
+    console.error('Error parsing package.json:', parseErr);
+    return;
+  }
+
+  let [major, minor, patch] = packageJson.version.split('.').map(Number);
+
+  if (releaseType === 'minor') {
+    minor++;
+    patch = 0; // Reset patch version on minor update
+  } else {
+    patch++;
+  }
+
+  packageJson.version = [major, minor, patch].join('.');
+  return packageJson
+}
+
+/**
+ * Increments the version number in package.json based on the release type.
+ *
+ * @param {string} releaseType - The type of release (minor or patch).
+ */
+function incrementAndPublish(releaseType) {
+  const packagePath = path.join(__dirname, '../package.json');
+  const versionPath = path.join(__dirname, '../src/version.ts')
+  fs.readFile(packagePath, 'utf8', (err, data) => {
+    if (err) {
+      console.error('Error reading package.json:', err);
+      return;
+    }
+
+    let packageJson = increment(data, releaseType)
+
+    writeToFile(packagePath, JSON.stringify(packageJson, null, 2))
+    const fileContent = `export const version = '${packageJson.version}';\n`;
+    writeToFile(versionPath, fileContent)
+    publish()
+  });
+}
+
+/**
+ * Asks the user whether the release is a minor release or a patch.
+ */
+function askReleaseType() {
+  readline.question(`enter (y) for minor release or (n) for patch release `, releaseType => {
+    releaseType = releaseType.trim().toLowerCase();
+
+    if (releaseType === 'y') {
+      incrementAndPublish('minor');
+    } else if (releaseType === 'n') {
+      incrementAndPublish('patch');
+    } else {
+      console.log("Please answer 'y' (yes) or 'n' (no).");
+      askReleaseType(); // Recursively ask again if the input is not y/n
+    }
+  });
+}
+
+askReleaseType();
+

package/tsconfig.package.json

@@ -3,6 +3,7 @@
     "declaration": true,
     "outDir": "./dist/",
     "jsx": "react",
+    "skipLibCheck": true,
     "esModuleInterop": true,
     "sourceMap": false,
     "noImplicitAny": true,
@@ -16,7 +17,7 @@
     "isolatedModules": true,
   },
   "include": [
-    "./src/**/*"
+    "./src/**/*",
   ],
   "exclude": [
     "node_modules",