@forge/bridge 5.0.0-next.1 → 5.0.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/bridge
 
+## 5.0.0-next.2
+
+### Minor Changes
+
+- c618633: Serialise and deserialise blob objects in the event API
+
 ## 5.0.0-next.1
 
 ### Major Changes

package/out/events/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAYxC,eAAO,MAAM,MAAM;kBARE,MAAM,YAAY,GAAG,KAAG,QAAQ,IAAI,CAAC;gBAIvC,MAAM,uBAAuB,GAAG,KAAK,GAAG,KAAG,QAAQ,YAAY,CAAC;CAOlF,CAAC"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AA8BxC,eAAO,MAAM,MAAM;kBApBQ,MAAM,YAAY,GAAG,KAAG,QAAQ,IAAI,CAAC;gBAQ7C,MAAM,uBAAuB,GAAG,KAAK,GAAG,KAAG,QAAQ,YAAY,CAAC;CAelF,CAAC"}

package/out/events/events.js

@@ -2,12 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.events = void 0;
 const bridge_1 = require("../bridge");
+const serialiseBlob_1 = require("./serialiseBlob");
 const callBridge = (0, bridge_1.getCallBridge)();
-const emit = (event, payload) => {
-    return callBridge('emit', { event, payload });
+const emit = async (event, payload) => {
+    let newPayload = payload;
+    if ((0, serialiseBlob_1.containsBlobs)(payload)) {
+        newPayload = await (0, serialiseBlob_1.serialiseBlobsInPayload)(payload);
+    }
+    return callBridge('emit', { event, payload: newPayload });
 };
 const on = (event, callback) => {
-    return callBridge('on', { event, callback });
+    const wrappedCallback = (payload) => {
+        let newPayload = payload;
+        if ((0, serialiseBlob_1.containsSerialisedBlobs)(payload)) {
+            newPayload = (0, serialiseBlob_1.deserialiseBlobsInPayload)(payload);
+        }
+        return callback(newPayload);
+    };
+    return callBridge('on', { event, callback: wrappedCallback });
 };
 exports.events = {
     emit,

package/out/events/serialiseBlob.d.ts

@@ -0,0 +1,5 @@
+export declare const serialiseBlobsInPayload: (payload: unknown) => Promise<unknown>;
+export declare const deserialiseBlobsInPayload: (payload: unknown) => unknown;
+export declare const containsBlobs: (payload: unknown) => boolean;
+export declare const containsSerialisedBlobs: (payload: unknown) => boolean;
+//# sourceMappingURL=serialiseBlob.d.ts.map

package/out/events/serialiseBlob.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialiseBlob.d.ts","sourceRoot":"","sources":["../../src/events/serialiseBlob.ts"],"names":[],"mappings":"AAsCA,eAAO,MAAM,uBAAuB,YAAmB,OAAO,KAAG,QAAQ,OAAO,CAyB/E,CAAC;AAGF,eAAO,MAAM,yBAAyB,YAAa,OAAO,KAAG,OAyB5D,CAAC;AAEF,eAAO,MAAM,aAAa,YAAa,OAAO,KAAG,OAchD,CAAC;AAEF,eAAO,MAAM,uBAAuB,YAAa,OAAO,KAAG,OAc1D,CAAC"}

package/out/events/serialiseBlob.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.containsSerialisedBlobs = exports.containsBlobs = exports.deserialiseBlobsInPayload = exports.serialiseBlobsInPayload = void 0;
+const blobParser_1 = require("../utils/blobParser");
+const isPlainObject = (value) => {
+    if (typeof value !== 'object' || value === null)
+        return false;
+    if (Object.prototype.toString.call(value) !== '[object Object]')
+        return false;
+    const proto = Object.getPrototypeOf(value);
+    if (proto === null)
+        return true;
+    const Ctor = Object.prototype.hasOwnProperty.call(proto, 'constructor') && proto.constructor;
+    return (typeof Ctor === 'function' &&
+        Ctor instanceof Ctor &&
+        Function.prototype.call(Ctor) === Function.prototype.call(value));
+};
+const blobToBase64WithMetadata = async (blob) => {
+    const base64Data = await (0, blobParser_1.blobToBase64)(blob);
+    return {
+        data: base64Data,
+        type: blob.type
+    };
+};
+const base64WithMetadataToBlob = (metadata) => {
+    return (0, blobParser_1.base64ToBlob)(metadata.data, metadata.type);
+};
+const serialiseBlobsInPayload = async (payload) => {
+    if (payload instanceof Blob) {
+        const blobData = await blobToBase64WithMetadata(payload);
+        return {
+            ...blobData,
+            __isBlobData: true
+        };
+    }
+    if (Array.isArray(payload)) {
+        return Promise.all(payload.map((item) => (0, exports.serialiseBlobsInPayload)(item)));
+    }
+    if (payload && isPlainObject(payload)) {
+        const entries = await Promise.all(Object.entries(payload).map(async ([key, value]) => [key, await (0, exports.serialiseBlobsInPayload)(value)]));
+        return Object.fromEntries(entries);
+    }
+    return payload;
+};
+exports.serialiseBlobsInPayload = serialiseBlobsInPayload;
+const deserialiseBlobsInPayload = (payload) => {
+    if (payload && isPlainObject(payload) && '__isBlobData' in payload) {
+        const typedData = payload;
+        return base64WithMetadataToBlob({
+            data: typedData.data,
+            type: typedData.type
+        });
+    }
+    if (Array.isArray(payload)) {
+        return payload.map((item) => (0, exports.deserialiseBlobsInPayload)(item));
+    }
+    if (payload && isPlainObject(payload)) {
+        const result = {};
+        for (const [key, value] of Object.entries(payload)) {
+            result[key] = (0, exports.deserialiseBlobsInPayload)(value);
+        }
+        return result;
+    }
+    return payload;
+};
+exports.deserialiseBlobsInPayload = deserialiseBlobsInPayload;
+const containsBlobs = (payload) => {
+    if (payload instanceof Blob) {
+        return true;
+    }
+    if (Array.isArray(payload)) {
+        return payload.some((item) => (0, exports.containsBlobs)(item));
+    }
+    if (payload && isPlainObject(payload)) {
+        return Object.values(payload).some((value) => (0, exports.containsBlobs)(value));
+    }
+    return false;
+};
+exports.containsBlobs = containsBlobs;
+const containsSerialisedBlobs = (payload) => {
+    if (payload && isPlainObject(payload) && '__isBlobData' in payload) {
+        return true;
+    }
+    if (Array.isArray(payload)) {
+        return payload.some((item) => (0, exports.containsSerialisedBlobs)(item));
+    }
+    if (payload && isPlainObject(payload)) {
+        return Object.values(payload).some((value) => (0, exports.containsSerialisedBlobs)(value));
+    }
+    return false;
+};
+exports.containsSerialisedBlobs = containsSerialisedBlobs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "5.0.0-next.1",
+  "version": "5.0.0-next.2",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",