@finos/legend-lego 1.1.70 → 1.2.0

package/lib/download-helper/DownloadHelper.service-worker.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare function handleDownloadMessage(event: ExtendableMessageEvent): void;
+//# sourceMappingURL=DownloadHelper.service-worker.d.ts.map

package/lib/download-helper/DownloadHelper.service-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DownloadHelper.service-worker.d.ts","sourceRoot":"","sources":["../../src/download-helper/DownloadHelper.service-worker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAsCH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,sBAAsB,GAAG,IAAI,CAezE"}

package/lib/download-helper/DownloadHelper.service-worker.js

@@ -0,0 +1,96 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const TAG_REQUEST = 'download-request';
+const TAG_RESPONSE = 'download-response';
+const STREAM_CLOSED = '#stream-closed';
+const STREAM_ABORTED = '#stream-aborted';
+// will interact from `createWritableStreamFromMessageChannel`
+function createReadableStreamFromMessagePort(port) {
+    return new ReadableStream({
+        start(controller) {
+            port.onmessage = ({ data }) => {
+                if (data === STREAM_CLOSED) {
+                    return controller.close();
+                }
+                if (data === STREAM_ABORTED) {
+                    controller.error('aborted');
+                    return undefined;
+                }
+                controller.enqueue(data);
+                return undefined;
+            };
+        },
+    });
+}
+const entries = new Map();
+export function handleDownloadMessage(event) {
+    const data = event.data;
+    if (event.data && event.data.tag === TAG_REQUEST) {
+        const port = event.ports[0];
+        if (port === undefined) {
+            throw new Error('Port 1 expected to handle download request');
+        }
+        const entry = [
+            createReadableStreamFromMessagePort(port),
+            data,
+            port,
+        ];
+        entries.set(data.url, entry);
+        port.postMessage({ tag: TAG_RESPONSE, downloadUrl: data.url });
+    }
+}
+function handleDownloadFetch(event) {
+    const url = event.request.url;
+    const entry = entries.get(url);
+    if (entry) {
+        entries.delete(url);
+        const [stream, data] = entry;
+        const { filename } = data;
+        const headers = new Headers({
+            'Content-Type': 'application/octet-stream; charset=utf-8',
+            'Content-Disposition': `attachment; filename*=UTF-8''${filename}`,
+            'Content-Security-Policy': "default-src 'none'",
+        });
+        // TODO: add trace
+        // console.log('responding to ffetch', stream);
+        event.respondWith(new Response(stream, { headers }));
+    }
+}
+function handleInstall(event) {
+    // TODO: add trace
+    // console.log('service worker install', event);
+    event.waitUntil(self.skipWaiting());
+}
+function handleActivate(event) {
+    // TODO: add trace
+    // console.log('service worker activate', event);
+    event.waitUntil(self.clients.claim());
+}
+function handleMessage(event) {
+    // TODO: add trace
+    // console.log('service worker message', event);
+    handleDownloadMessage(event);
+}
+function handleFetch(event) {
+    // TODO: add trace
+    // console.log('service worker fetch', event);
+    handleDownloadFetch(event);
+}
+self.addEventListener('install', handleInstall);
+self.addEventListener('activate', handleActivate);
+self.addEventListener('message', handleMessage);
+self.addEventListener('fetch', handleFetch);
+//# sourceMappingURL=DownloadHelper.service-worker.js.map

package/lib/download-helper/DownloadHelper.service-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DownloadHelper.service-worker.js","sourceRoot":"","sources":["../../src/download-helper/DownloadHelper.service-worker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,WAAW,GAAG,kBAAkB,CAAC;AACvC,MAAM,YAAY,GAAG,mBAAmB,CAAC;AAEzC,MAAM,aAAa,GAAG,gBAAgB,CAAC;AACvC,MAAM,cAAc,GAAG,iBAAiB,CAAC;AAEzC,8DAA8D;AAC9D,SAAS,mCAAmC,CAC1C,IAAiB;IAEjB,OAAO,IAAI,cAAc,CAAC;QACxB,KAAK,CAAC,UAAU;YACd,IAAI,CAAC,SAAS,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;gBAC5B,IAAI,IAAI,KAAK,aAAa,EAAE;oBAC1B,OAAO,UAAU,CAAC,KAAK,EAAE,CAAC;iBAC3B;gBACD,IAAI,IAAI,KAAK,cAAc,EAAE;oBAC3B,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;oBAC5B,OAAO,SAAS,CAAC;iBAClB;gBACD,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACzB,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC;QACJ,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAQD,MAAM,OAAO,GACX,IAAI,GAAG,EAAE,CAAC;AAEZ,MAAM,UAAU,qBAAqB,CAAC,KAA6B;IACjE,MAAM,IAAI,GAAG,KAAK,CAAC,IAAuB,CAAC;IAC3C,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,WAAW,EAAE;QAChD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5B,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;SAC/D;QACD,MAAM,KAAK,GAAmD;YAC5D,mCAAmC,CAAC,IAAI,CAAC;YACzC,IAAI;YACJ,IAAI;SACL,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7B,IAAI,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;KAChE;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAiB;IAC5C,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;IAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAE/B,IAAI,KAAK,EAAE;QACT,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC;QAC7B,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC;YAC1B,cAAc,EAAE,yCAAyC;YACzD,qBAAqB,EAAE,gCAAgC,QAAQ,EAAE;YACjE,yBAAyB,EAAE,oBAAoB;SAChD,CAAC,CAAC;QACH,kBAAkB;QAClB,+CAA+C;QAC/C,KAAK,CAAC,WAAW,CAAC,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;KACtD;AACH,CAAC;AAMD,SAAS,aAAa,CAAC,KAAsB;IAC3C,kBAAkB;IAClB,gDAAgD;IAChD,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,cAAc,CAAC,KAAsB;IAC5C,kBAAkB;IAClB,iDAAiD;IACjD,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,aAAa,CAAC,KAA6B;IAClD,kBAAkB;IAClB,gDAAgD;IAChD,qBAAqB,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,WAAW,CAAC,KAAiB;IACpC,kBAAkB;IAClB,8CAA8C;IAC9C,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;AAChD,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;AAClD,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;AAChD,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC"}

package/lib/download-helper/__test-utils__/MockedDownloadHelper.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare function downloadStream(): Promise<void>;
+export declare function registerDownloadHelperServiceWorker(): void;
+//# sourceMappingURL=MockedDownloadHelper.d.ts.map

package/lib/download-helper/__test-utils__/MockedDownloadHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockedDownloadHelper.d.ts","sourceRoot":"","sources":["../../../src/download-helper/__test-utils__/MockedDownloadHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,wBAAsB,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAG;AACxD,wBAAgB,mCAAmC,IAAI,IAAI,CAAG"}

package/lib/download-helper/__test-utils__/MockedDownloadHelper.js

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export async function downloadStream() { }
+export function registerDownloadHelperServiceWorker() { }
+//# sourceMappingURL=MockedDownloadHelper.js.map

package/lib/download-helper/__test-utils__/MockedDownloadHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockedDownloadHelper.js","sourceRoot":"","sources":["../../../src/download-helper/__test-utils__/MockedDownloadHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,CAAC,KAAK,UAAU,cAAc,KAAmB,CAAC;AACxD,MAAM,UAAU,mCAAmC,KAAU,CAAC"}

package/lib/download-helper/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare function downloadStream(responseBody: ReadableStream, filename: string): Promise<void>;
+export declare function registerDownloadHelperServiceWorker(): void;
+//# sourceMappingURL=index.d.ts.map

package/lib/download-helper/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/download-helper/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAqGH,wBAAsB,cAAc,CAClC,YAAY,EAAE,cAAc,EAC5B,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC,CAsBf;AAED,wBAAgB,mCAAmC,IAAI,IAAI,CAa1D"}

package/lib/download-helper/index.js

@@ -0,0 +1,120 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var DOWNLOAD_EVENTS;
+(function (DOWNLOAD_EVENTS) {
+    DOWNLOAD_EVENTS["TAG_REQUEST"] = "download-request";
+    DOWNLOAD_EVENTS["TAG_RESPONSE"] = "download-response";
+    DOWNLOAD_EVENTS["STREAM_CLOSED"] = "#stream-closed";
+    DOWNLOAD_EVENTS["STREAM_ABORTED"] = "#stream-aborted";
+})(DOWNLOAD_EVENTS || (DOWNLOAD_EVENTS = {}));
+function createWritableStreamFromMessageChannel(channel) {
+    return new WritableStream({
+        write(chunk) {
+            channel.port1.postMessage(chunk);
+        },
+        close() {
+            channel.port1.postMessage(DOWNLOAD_EVENTS.STREAM_CLOSED);
+        },
+        abort() {
+            channel.port1.postMessage(DOWNLOAD_EVENTS.STREAM_ABORTED);
+            closeMessagePort(channel.port1);
+            closeMessagePort(channel.port2);
+        },
+    });
+}
+function closeMessagePort(port) {
+    port.onmessage = null;
+    port.close();
+}
+async function getServiceWorker() {
+    if (!('serviceWorker' in navigator)) {
+        return Promise.reject(new Error('Service worker is not available. Service Worker requires HTTPS protocol'));
+    }
+    return navigator.serviceWorker
+        .getRegistration()
+        .then((workerRegistration) => {
+        if (workerRegistration === undefined) {
+            return undefined;
+        }
+        const pending = workerRegistration.installing ?? workerRegistration.waiting;
+        return (workerRegistration.active ??
+            new Promise((resolve) => {
+                // if not activated, add listener to waiting or installing registration
+                const listener = () => {
+                    if (pending?.state === 'activated') {
+                        pending.removeEventListener('statechange', listener);
+                        resolve(workerRegistration.active ?? undefined);
+                    }
+                };
+                pending?.addEventListener('statechange', listener);
+            }));
+    });
+}
+function createDownloadRequest(filename) {
+    const PREFIX = 6;
+    const prefix = String(Math.random()).slice(-PREFIX);
+    const url = new URL(`${prefix}/${filename}`, window.location.href).toString();
+    return { tag: DOWNLOAD_EVENTS.TAG_REQUEST, filename, url };
+}
+function handleServiceWorkerDownloadResponse(event) {
+    const data = event.data;
+    if (data?.tag === DOWNLOAD_EVENTS.TAG_RESPONSE && data.downloadUrl.length) {
+        openInIframe(data.downloadUrl);
+    }
+}
+function openInIframe(src) {
+    const iframe = document.createElement('iframe');
+    iframe.hidden = true;
+    iframe.src = src;
+    document.body.appendChild(iframe);
+    return iframe;
+}
+export async function downloadStream(responseBody, filename) {
+    // creates communication channel with service worker with response handler
+    const channel = new MessageChannel();
+    channel.port1.onmessage = handleServiceWorkerDownloadResponse;
+    // grabs service worker and handles it download along with response channel port
+    const serviceWorker = await getServiceWorker();
+    if (!serviceWorker) {
+        return;
+    }
+    const downloadRequest = createDownloadRequest(filename);
+    serviceWorker.postMessage(downloadRequest, [channel.port2]);
+    // creates new data stream over communication channel and pipes given stream in it
+    responseBody
+        .pipeTo(createWritableStreamFromMessageChannel(channel))
+        .then(() => {
+        // TODO: trace success
+    })
+        .catch(() => {
+        // TODO: fail
+    });
+}
+export function registerDownloadHelperServiceWorker() {
+    if ('serviceWorker' in navigator) {
+        navigator.serviceWorker
+            .register(new URL('./DownloadHelper.service-worker.js', import.meta.url))
+            .then((reg) => {
+            // TODO: add trace
+            // console.debug('register service worker success', reg);
+        })
+            .catch((error) => {
+            // TODO: add trace
+            // console.debug('register service worker error', error);
+        });
+    }
+}
+//# sourceMappingURL=index.js.map

package/lib/download-helper/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/download-helper/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,IAAK,eAKJ;AALD,WAAK,eAAe;IAClB,mDAAgC,CAAA;IAChC,qDAAkC,CAAA;IAClC,mDAAgC,CAAA;IAChC,qDAAkC,CAAA;AACpC,CAAC,EALI,eAAe,KAAf,eAAe,QAKnB;AAED,SAAS,sCAAsC,CAC7C,OAAuB;IAEvB,OAAO,IAAI,cAAc,CAAC;QACxB,KAAK,CAAC,KAAK;YACT,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QACD,KAAK;YACH,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QAC3D,CAAC;QACD,KAAK;YACH,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;YAC1D,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAClC,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAiB;IACzC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACtB,IAAI,CAAC,KAAK,EAAE,CAAC;AACf,CAAC;AAaD,KAAK,UAAU,gBAAgB;IAC7B,IAAI,CAAC,CAAC,eAAe,IAAI,SAAS,CAAC,EAAE;QACnC,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,KAAK,CACP,yEAAyE,CAC1E,CACF,CAAC;KACH;IACD,OAAO,SAAS,CAAC,aAAa;SAC3B,eAAe,EAAE;SACjB,IAAI,CAAC,CAAC,kBAAkB,EAAE,EAAE;QAC3B,IAAI,kBAAkB,KAAK,SAAS,EAAE;YACpC,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,OAAO,GACX,kBAAkB,CAAC,UAAU,IAAI,kBAAkB,CAAC,OAAO,CAAC;QAC9D,OAAO,CACL,kBAAkB,CAAC,MAAM;YACzB,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACtB,uEAAuE;gBACvE,MAAM,QAAQ,GAAG,GAAS,EAAE;oBAC1B,IAAI,OAAO,EAAE,KAAK,KAAK,WAAW,EAAE;wBAClC,OAAO,CAAC,mBAAmB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;wBACrD,OAAO,CAAC,kBAAkB,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC;qBACjD;gBACH,CAAC,CAAC;gBACF,OAAO,EAAE,gBAAgB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YACrD,CAAC,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,qBAAqB,CAC5B,QAAgB;IAEhB,MAAM,MAAM,GAAG,CAAC,CAAC;IACjB,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;IACpD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,MAAM,IAAI,QAAQ,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC9E,OAAO,EAAE,GAAG,EAAE,eAAe,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;AAC7D,CAAC;AAED,SAAS,mCAAmC,CAC1C,KAA6D;IAE7D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACxB,IAAI,IAAI,EAAE,GAAG,KAAK,eAAe,CAAC,YAAY,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;QACzE,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KAChC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,GAAW;IAC/B,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAClC,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,YAA4B,EAC5B,QAAgB;IAEhB,0EAA0E;IAC1E,MAAM,OAAO,GAAG,IAAI,cAAc,EAAE,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,SAAS,GAAG,mCAAmC,CAAC;IAE9D,gFAAgF;IAChF,MAAM,aAAa,GAAG,MAAM,gBAAgB,EAAE,CAAC;IAC/C,IAAI,CAAC,aAAa,EAAE;QAClB,OAAO;KACR;IACD,MAAM,eAAe,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACxD,aAAa,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAE5D,kFAAkF;IAClF,YAAY;SACT,MAAM,CAAC,sCAAsC,CAAC,OAAO,CAAC,CAAC;SACvD,IAAI,CAAC,GAAG,EAAE;QACT,sBAAsB;IACxB,CAAC,CAAC;SACD,KAAK,CAAC,GAAG,EAAE;QACV,aAAa;IACf,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,mCAAmC;IACjD,IAAI,eAAe,IAAI,SAAS,EAAE;QAChC,SAAS,CAAC,aAAa;aACpB,QAAQ,CAAC,IAAI,GAAG,CAAC,oCAAoC,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACxE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;YACZ,kBAAkB;YAClB,yDAAyD;QAC3D,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,kBAAkB;YAClB,yDAAyD;QAC3D,CAAC,CAAC,CAAC;KACN;AACH,CAAC"}

package/lib/index.css

@@ -1,4 +1,4 @@
-/** @license @finos/legend-lego v1.1.70
+/** @license @finos/legend-lego v1.2.0
  * Copyright (c) 2020-present, Goldman Sachs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finos/legend-lego",
-  "version": "1.1.70",
+  "version": "1.2.0",
   "description": "Legend shared advanced application components and building blocks",
   "keywords": [
     "legend",
@@ -26,6 +26,8 @@
     "./code-editor/test/MockedMonacoEditor.js": "./lib/code-editor/__test-utils__/MockedMonacoEditor.js",
     "./data-grid": "./lib/data-grid/index.js",
     "./graph-editor": "./lib/graph-editor/index.js",
+    "./download-helper": "./lib/download-helper/index.js",
+    "./download-helper/test/MockedDownloadHelper.js": "./lib/download-helper/__test-utils__/MockedDownloadHelper.js",
     "./lib/index.css": "./lib/index.css"
   },
   "module": "lib/index.js",
@@ -63,10 +65,10 @@
     "@ag-grid-enterprise/server-side-row-model": "30.2.0",
     "@ag-grid-enterprise/side-bar": "30.2.0",
     "@ag-grid-enterprise/status-bar": "30.2.0",
-    "@finos/legend-application": "15.0.63",
-    "@finos/legend-art": "7.1.16",
-    "@finos/legend-graph": "31.6.7",
-    "@finos/legend-shared": "10.0.30",
+    "@finos/legend-application": "15.0.64",
+    "@finos/legend-art": "7.1.17",
+    "@finos/legend-graph": "31.7.0",
+    "@finos/legend-shared": "10.0.31",
     "@types/css-font-loading-module": "0.0.10",
     "@types/react": "18.2.31",
     "@types/react-dom": "18.2.14",
@@ -78,7 +80,7 @@
     "react-dom": "18.2.0"
   },
   "devDependencies": {
-    "@finos/legend-dev-utils": "2.0.82",
+    "@finos/legend-dev-utils": "2.1.0",
     "@jest/globals": "29.7.0",
     "cross-env": "7.0.3",
     "eslint": "8.52.0",

package/src/download-helper/DownloadHelper.service-worker.ts

@@ -0,0 +1,120 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const TAG_REQUEST = 'download-request';
+const TAG_RESPONSE = 'download-response';
+
+const STREAM_CLOSED = '#stream-closed';
+const STREAM_ABORTED = '#stream-aborted';
+
+// will interact from `createWritableStreamFromMessageChannel`
+function createReadableStreamFromMessagePort(
+  port: MessagePort,
+): ReadableStream {
+  return new ReadableStream({
+    start(controller) {
+      port.onmessage = ({ data }) => {
+        if (data === STREAM_CLOSED) {
+          return controller.close();
+        }
+        if (data === STREAM_ABORTED) {
+          controller.error('aborted');
+          return undefined;
+        }
+        controller.enqueue(data);
+        return undefined;
+      };
+    },
+  });
+}
+
+interface DownloadRequest {
+  tag: string;
+  filename: string;
+  url: string;
+}
+
+const entries: Map<string, [ReadableStream, DownloadRequest, MessagePort]> =
+  new Map();
+
+export function handleDownloadMessage(event: ExtendableMessageEvent): void {
+  const data = event.data as DownloadRequest;
+  if (event.data && event.data.tag === TAG_REQUEST) {
+    const port = event.ports[0];
+    if (port === undefined) {
+      throw new Error('Port 1 expected to handle download request');
+    }
+    const entry: [ReadableStream, DownloadRequest, MessagePort] = [
+      createReadableStreamFromMessagePort(port),
+      data,
+      port,
+    ];
+    entries.set(data.url, entry);
+    port.postMessage({ tag: TAG_RESPONSE, downloadUrl: data.url });
+  }
+}
+
+function handleDownloadFetch(event: FetchEvent): void {
+  const url = event.request.url;
+  const entry = entries.get(url);
+
+  if (entry) {
+    entries.delete(url);
+    const [stream, data] = entry;
+    const { filename } = data;
+    const headers = new Headers({
+      'Content-Type': 'application/octet-stream; charset=utf-8',
+      'Content-Disposition': `attachment; filename*=UTF-8''${filename}`,
+      'Content-Security-Policy': "default-src 'none'",
+    });
+    // TODO: add trace
+    // console.log('responding to ffetch', stream);
+    event.respondWith(new Response(stream, { headers }));
+  }
+}
+
+// ------------------ Service Worker Lifecycle ------------------
+
+declare const self: ServiceWorkerGlobalScope;
+
+function handleInstall(event: ExtendableEvent): void {
+  // TODO: add trace
+  // console.log('service worker install', event);
+  event.waitUntil(self.skipWaiting());
+}
+
+function handleActivate(event: ExtendableEvent): void {
+  // TODO: add trace
+  // console.log('service worker activate', event);
+  event.waitUntil(self.clients.claim());
+}
+
+function handleMessage(event: ExtendableMessageEvent): void {
+  // TODO: add trace
+  // console.log('service worker message', event);
+  handleDownloadMessage(event);
+}
+
+function handleFetch(event: FetchEvent): void {
+  // TODO: add trace
+  // console.log('service worker fetch', event);
+  handleDownloadFetch(event);
+}
+
+self.addEventListener('install', handleInstall);
+self.addEventListener('activate', handleActivate);
+self.addEventListener('message', handleMessage);
+self.addEventListener('fetch', handleFetch);

package/src/download-helper/__test-utils__/MockedDownloadHelper.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export async function downloadStream(): Promise<void> {}
+export function registerDownloadHelperServiceWorker(): void {}

package/src/download-helper/index.ts

@@ -0,0 +1,156 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+enum DOWNLOAD_EVENTS {
+  TAG_REQUEST = 'download-request',
+  TAG_RESPONSE = 'download-response',
+  STREAM_CLOSED = '#stream-closed',
+  STREAM_ABORTED = '#stream-aborted',
+}
+
+function createWritableStreamFromMessageChannel(
+  channel: MessageChannel,
+): WritableStream {
+  return new WritableStream({
+    write(chunk) {
+      channel.port1.postMessage(chunk);
+    },
+    close() {
+      channel.port1.postMessage(DOWNLOAD_EVENTS.STREAM_CLOSED);
+    },
+    abort() {
+      channel.port1.postMessage(DOWNLOAD_EVENTS.STREAM_ABORTED);
+      closeMessagePort(channel.port1);
+      closeMessagePort(channel.port2);
+    },
+  });
+}
+
+function closeMessagePort(port: MessagePort): void {
+  port.onmessage = null;
+  port.close();
+}
+
+interface LegendApplicationDownloadRequest {
+  tag: string;
+  filename: string;
+  url: string;
+}
+
+interface LegendApplicationTagResponse {
+  tag: string;
+  downloadUrl: string;
+}
+
+async function getServiceWorker(): Promise<ServiceWorker | undefined> {
+  if (!('serviceWorker' in navigator)) {
+    return Promise.reject(
+      new Error(
+        'Service worker is not available. Service Worker requires HTTPS protocol',
+      ),
+    );
+  }
+  return navigator.serviceWorker
+    .getRegistration()
+    .then((workerRegistration) => {
+      if (workerRegistration === undefined) {
+        return undefined;
+      }
+      const pending =
+        workerRegistration.installing ?? workerRegistration.waiting;
+      return (
+        workerRegistration.active ??
+        new Promise((resolve) => {
+          // if not activated, add listener to waiting or installing registration
+          const listener = (): void => {
+            if (pending?.state === 'activated') {
+              pending.removeEventListener('statechange', listener);
+              resolve(workerRegistration.active ?? undefined);
+            }
+          };
+          pending?.addEventListener('statechange', listener);
+        })
+      );
+    });
+}
+
+function createDownloadRequest(
+  filename: string,
+): LegendApplicationDownloadRequest {
+  const PREFIX = 6;
+  const prefix = String(Math.random()).slice(-PREFIX);
+  const url = new URL(`${prefix}/${filename}`, window.location.href).toString();
+  return { tag: DOWNLOAD_EVENTS.TAG_REQUEST, filename, url };
+}
+
+function handleServiceWorkerDownloadResponse(
+  event: MessageEvent<LegendApplicationTagResponse | undefined>,
+): void {
+  const data = event.data;
+  if (data?.tag === DOWNLOAD_EVENTS.TAG_RESPONSE && data.downloadUrl.length) {
+    openInIframe(data.downloadUrl);
+  }
+}
+
+function openInIframe(src: string): HTMLIFrameElement {
+  const iframe = document.createElement('iframe');
+  iframe.hidden = true;
+  iframe.src = src;
+  document.body.appendChild(iframe);
+  return iframe;
+}
+
+export async function downloadStream(
+  responseBody: ReadableStream,
+  filename: string,
+): Promise<void> {
+  // creates communication channel with service worker with response handler
+  const channel = new MessageChannel();
+  channel.port1.onmessage = handleServiceWorkerDownloadResponse;
+
+  // grabs service worker and handles it download along with response channel port
+  const serviceWorker = await getServiceWorker();
+  if (!serviceWorker) {
+    return;
+  }
+  const downloadRequest = createDownloadRequest(filename);
+  serviceWorker.postMessage(downloadRequest, [channel.port2]);
+
+  // creates new data stream over communication channel and pipes given stream in it
+  responseBody
+    .pipeTo(createWritableStreamFromMessageChannel(channel))
+    .then(() => {
+      // TODO: trace success
+    })
+    .catch(() => {
+      // TODO: fail
+    });
+}
+
+export function registerDownloadHelperServiceWorker(): void {
+  if ('serviceWorker' in navigator) {
+    navigator.serviceWorker
+      .register(new URL('./DownloadHelper.service-worker.js', import.meta.url))
+      .then((reg) => {
+        // TODO: add trace
+        // console.debug('register service worker success', reg);
+      })
+      .catch((error) => {
+        // TODO: add trace
+        // console.debug('register service worker error', error);
+      });
+  }
+}

package/tsconfig.json

@@ -39,6 +39,9 @@
     "./src/code-editor/__test-utils__/MockedMonacoEditor.ts",
     "./src/code-editor/themes/MonacoEditorThemeUtils.ts",
     "./src/data-grid/index.ts",
+    "./src/download-helper/DownloadHelper.service-worker.ts",
+    "./src/download-helper/index.ts",
+    "./src/download-helper/__test-utils__/MockedDownloadHelper.ts",
     "./src/graph-editor/index.ts",
     "./src/application/ActivityBar.tsx",
     "./src/application/DocumentationLink.tsx",