@shopfront/bridge 2.0.6 → 2.0.7

package/LISCENCE.md

@@ -1,5 +1,5 @@
-Copyright 2019 Shopfront
+Copyright 2025 Shopfront
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/lib/APIs/Database/Database.js

@@ -10,7 +10,6 @@ export class Database extends BaseDatabase {
     async callMethod(table, method, args) {
         const databaseRequest = `DatabaseRequest-${Math.random()}-${Date.now()}`;
         const promise = new Promise((res, rej) => {
-            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_DATABASE_REQUEST") {
                     return;

package/lib/Application.js

@@ -238,7 +238,6 @@ export class Application extends BaseApplication {
     async getCurrentSale() {
         const saleRequest = `SaleRequest-${Date.now().toString()}`;
         const promise = new Promise(res => {
-            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_CURRENT_SALE") {
                     return;
@@ -277,7 +276,6 @@ export class Application extends BaseApplication {
     async createSale(sale) {
         const createSaleRequest = `CreateSaleRequest-${Date.now().toString()}`;
         const promise = new Promise(res => {
-            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_CREATE_SALE") {
                     return;
@@ -317,7 +315,6 @@ export class Application extends BaseApplication {
     async getLocation() {
         const locationRequest = `LocationRequest-${Date.now().toString()}`;
         const promise = new Promise(res => {
-            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_LOCATION") {
                     return;
@@ -383,7 +380,6 @@ export class Application extends BaseApplication {
     sendAudioRequest(type, data) {
         const request = `AudioRequest-${type}-${Date.now().toString()}`;
         const promise = new Promise(res => {
-            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_AUDIO_REQUEST") {
                     return;
@@ -442,7 +438,6 @@ export class Application extends BaseApplication {
     async getOption(option, defaultValue) {
         const request = `OptionRequest-${Date.now().toString()}`;
         const promise = new Promise(res => {
-            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_OPTION") {
                     return;
@@ -531,7 +526,6 @@ export class Application extends BaseApplication {
         await this.generateSigningKey();
         const request = `TokenRequest-${Date.now().toString()}`;
         const promise = new Promise(res => {
-            // eslint-disable-next-line jsdoc/require-jsdoc
             const listener = (event, data) => {
                 if (event !== "RESPONSE_SECURE_KEY") {
                     return;

package/lib/Events/UIPipeline.d.ts

@@ -12,15 +12,10 @@ export declare class UIPipeline extends BaseEvent<UIPPipelineIncomingData, Maybe
     constructor(callback: FromShopfrontCallbacks["UI_PIPELINE"]);
     /**
      * @inheritDoc
-     * @param data
-     * @param bridge
      */
     emit(data: UIPPipelineIncomingData, bridge: Bridge): Promise<FromShopfrontReturns["UI_PIPELINE"]>;
     /**
      * Sends the response data to Shopfront
-     * @param bridge
-     * @param data
-     * @param id
      */
     static respond(bridge: BaseBridge, data: FromShopfrontReturns["UI_PIPELINE"], id: string): Promise<void>;
 }

package/lib/Events/UIPipeline.js

@@ -6,8 +6,6 @@ export class UIPipeline extends BaseEvent {
     }
     /**
      * @inheritDoc
-     * @param data
-     * @param bridge
      */
     async emit(data, bridge) {
         const context = {
@@ -28,9 +26,6 @@ export class UIPipeline extends BaseEvent {
     }
     /**
      * Sends the response data to Shopfront
-     * @param bridge
-     * @param data
-     * @param id
      */
     static async respond(bridge, data, id) {
         bridge.sendMessage(ToShopfront.RESPONSE_UI_PIPELINE, data, id);

package/lib/Mocks/MockApplication.d.ts

@@ -92,7 +92,7 @@ export declare class MockApplication extends BaseApplication {
     /**
      * @inheritDoc
      */
-    protected sendAudioRequest(type: SoundEvents, data?: unknown, options?: AudioRequestOptions): Promise<{
+    protected sendAudioRequest(_type: SoundEvents, _data?: unknown, options?: AudioRequestOptions): Promise<{
         success: boolean;
         message?: string;
     }>;

package/lib/Mocks/MockApplication.js

@@ -241,7 +241,7 @@ export class MockApplication extends BaseApplication {
     /**
      * @inheritDoc
      */
-    async sendAudioRequest(type, data, options) {
+    async sendAudioRequest(_type, _data, options) {
         if (options) {
             if (!options.hasPermission) {
                 return {

package/lib/Utilities/ActionEventRegistrar.d.ts

@@ -4,19 +4,14 @@ declare class ActionEventRegistrar {
     constructor();
     /**
      * Registers an event action listener
-     * @param id
-     * @param action
      */
     add(id: string, action: BaseAction<undefined>): void;
     /**
      * Removes an event action listener
-     * @param id
      */
     remove(id: string): void;
     /**
      * Invokes the registered action event listener
-     * @param id
-     * @param data
      */
     fire(id: string, data: unknown): void;
     /**

package/lib/Utilities/ActionEventRegistrar.js

@@ -4,15 +4,12 @@ class ActionEventRegistrar {
     }
     /**
      * Registers an event action listener
-     * @param id
-     * @param action
      */
     add(id, action) {
         this.events[id] = action;
     }
     /**
      * Removes an event action listener
-     * @param id
      */
     remove(id) {
         // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
@@ -20,8 +17,6 @@ class ActionEventRegistrar {
     }
     /**
      * Invokes the registered action event listener
-     * @param id
-     * @param data
      */
     fire(id, data) {
         if (typeof this.events[id] === "undefined") {

package/lib/Utilities/SaleCreate.d.ts

@@ -25,6 +25,5 @@ export interface SaleData extends BaseSaleData {
 }
 /**
  * Builds a Shopfront sale from the embedded sale data
- * @param sale
  */
 export declare function buildSaleData(sale: Sale): SaleData;

package/lib/Utilities/SaleCreate.js

@@ -1,6 +1,5 @@
 /**
  * Builds a Shopfront sale product from the embedded product data
- * @param product
  */
 function buildSaleProductData(product) {
     const price = product.getPrice();
@@ -23,7 +22,6 @@ function buildSaleProductData(product) {
 }
 /**
  * Builds a Shopfront sale from the embedded sale data
- * @param sale
  */
 export function buildSaleData(sale) {
     const customer = sale.getCustomer();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@shopfront/bridge",
-    "version": "2.0.6",
+    "version": "2.0.7",
     "main": "./lib/index.js",
     "license": "ISC",
     "description": "The bridge used to embed your application within Shopfront",
@@ -19,18 +19,41 @@
     "type": "module",
     "private": false,
     "devDependencies": {
-        "@onshopfront/core": "^0.1.89",
+        "@auto-it/all-contributors": "^11.3.0",
+        "@auto-it/jira": "^11.3.0",
+        "@onshopfront/core": "^0.1.97",
+        "auto": "^11.3.0",
+        "husky": "^9.1.7",
         "ts-jest-resolver": "^2.0.1",
-        "typescript": "^5.5.4",
-        "typescript-eslint": "^8.34.0"
+        "typescript": "^5.9.3"
     },
     "scripts": {
         "type-check": "tsc --noEmit",
         "type-check:watch": "npm run-script type-check --watch",
         "build": "tsc",
         "watch": "tsc -w",
-        "lint": "eslint . --fix",
-        "test": "npx @onshopfront/core test",
-        "prepublishOnly": "npm run build"
+        "lint": "npx core lint .",
+        "lint:commit:run": "npx core lint-commit",
+        "lint:pr:run": "npx core lint-pr --target-branch origin/master",
+        "test": "npx @onshopfront/core test"
+    },
+    "auto": {
+        "plugins": [
+            "npm",
+            "all-contributors",
+            [
+                "jira",
+                "https://onshopfront.atlassian.net"
+            ],
+            "released"
+        ],
+        "author": {
+            "name": "Auto Release",
+            "email": "nick@shopfront.com.au"
+        }
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org",
+        "access": "public"
     }
 }

package/.github/workflows/npm-publish.yml

@@ -1,40 +0,0 @@
-name: Pack and Distribute
-on:
-    release:
-        types: [created]
-jobs:
-    build:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v4
-            - uses: actions/setup-node@v3
-              with:
-                  node-version: '20.x'
-                  registry-url: 'https://registry.npmjs.org/'
-            - run: |
-                  echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> .npmrc
-            - run: npm ci
-            - run: npm run-script build
-              env:
-                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-    publish-npm:
-        needs: build
-        runs-on: ubuntu-latest
-        permissions:
-            contents: read
-            id-token: write
-            packages: read
-        steps:
-            - uses: actions/checkout@v4
-            - uses: actions/setup-node@v3
-              with:
-                  node-version: '20.x'
-                  registry-url: 'https://registry.npmjs.org/'
-            - run: |
-                  echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> .npmrc
-            - run: npm ci
-            - run: npm publish --provenance --access public
-              env:
-                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-                  NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}