@metapages/metapage 1.8.25 → 1.8.27

package/src/metapage/Metaframe.ts

@@ -1,7 +1,4 @@
-import {
-  EventEmitter,
-  ListenerFn,
-} from 'eventemitter3';
+import { EventEmitter, ListenerFn } from "eventemitter3";
 
 import {
   getHashParamFromWindow,
@@ -16,35 +13,28 @@ import {
   setHashParamValueFloatInWindow,
   setHashParamValueIntInWindow,
   setHashParamValueJsonInWindow,
-} from '@metapages/hash-query';
+} from "@metapages/hash-query";
 
-import { VERSION_METAFRAME } from './Constants';
-import {
-  MetaframeId,
-  MetaframePipeId,
-  MetapageId,
-} from './core';
-import {
-  deserializeInputs,
-  serializeInputs,
-} from './data';
-import { MetapageEventUrlHashUpdate } from './events';
+import { VERSION_METAFRAME } from "./Constants";
+import { Disposer, MetaframeId, MetaframePipeId, MetapageId } from "./core";
+import { deserializeInputs, serializeInputs } from "./data";
+import { MetapageEventUrlHashUpdate } from "./events";
 import {
   JsonRpcMethodsFromChild,
   JsonRpcMethodsFromParent,
   MinimumClientMessage,
   SetupIframeServerResponseData,
-} from './jsonrpc';
+} from "./jsonrpc";
 import {
   isDebugFromUrlsParams,
   log as MetapageToolsLog,
   merge,
   pageLoaded,
   stringToRgb,
-} from './MetapageTools';
-import { isIframe } from './Shared';
-import { MetaframeInputMap } from './v0_4';
-import { VersionsMetapage } from './versions';
+} from "./MetapageTools";
+import { isIframe } from "./Shared";
+import { MetaframeInputMap } from "./v0_4";
+import { VersionsMetapage } from "./versions";
 
 // TODO combine/unify MetaframeEvents and MetaframeLoadingState
 export enum MetaframeLoadingState {
@@ -120,17 +110,17 @@ export class Metaframe extends EventEmitter<
     this.setInput = this.setInput.bind(this);
     this.setInputs = this.setInputs.bind(this);
     this.setInternalInputsAndNotify =
-    this.setInternalInputsAndNotify.bind(this);
+      this.setInternalInputsAndNotify.bind(this);
     this.setOutput = this.setOutput.bind(this);
     this.setOutputs = this.setOutputs.bind(this);
     this.warn = this.warn.bind(this);
     this._resolveSetupIframeServerResponse =
-    this._resolveSetupIframeServerResponse.bind(this);
+      this._resolveSetupIframeServerResponse.bind(this);
     this.addListenerReturnDisposer = this.addListenerReturnDisposer.bind(this);
     this.connected = this.connected.bind(this);
     this.isConnected = this.isConnected.bind(this);
     this.disableNotifyOnHashUrlChange =
-    this.disableNotifyOnHashUrlChange.bind(this);
+      this.disableNotifyOnHashUrlChange.bind(this);
     this._onHashUrlChange = this._onHashUrlChange.bind(this);
 
     this.setParameter = this.setParameter.bind(this);
@@ -147,7 +137,6 @@ export class Metaframe extends EventEmitter<
     this.getParameterInt = this.getParameterInt.bind(this);
     this.deleteParameter = this.deleteParameter.bind(this);
 
-
     if (!this._isIframe) {
       //Don't add any of the machinery, it only works if we're iframes.
       //This will never return
@@ -180,7 +169,6 @@ export class Metaframe extends EventEmitter<
     }
 
     (async () => {
-
       if (!this._parentId) {
         this._parentVersion = params.version;
         this.color = stringToRgb(this.id);
@@ -188,13 +176,14 @@ export class Metaframe extends EventEmitter<
         this.log(
           `metapage[${this._parentId}](v${
             this._parentVersion ? this._parentVersion : "unknown"
-          }) registered`
+          }) registered`,
         );
 
-
         if (params.state && params.state.inputs) {
           if (this.isInputOutputBlobSerialization) {
-            this._inputPipeValues = await deserializeInputs(params.state.inputs);
+            this._inputPipeValues = await deserializeInputs(
+              params.state.inputs,
+            );
           } else {
             this._inputPipeValues = params.state.inputs;
           }
@@ -226,8 +215,8 @@ export class Metaframe extends EventEmitter<
               this.emit(
                 MetaframeEvents.Input,
                 pipeId,
-                this._inputPipeValues[pipeId]
-              )
+                this._inputPipeValues[pipeId],
+              ),
             );
           }
         }
@@ -243,11 +232,13 @@ export class Metaframe extends EventEmitter<
         this.emit(MetaframeEvents.Connected);
 
         // Send the initial outputs to the parent, we have been accumulating them
-        this.sendRpc(JsonRpcMethodsFromChild.OutputsUpdate, this._outputPipeValues);
-
+        this.sendRpc(
+          JsonRpcMethodsFromChild.OutputsUpdate,
+          this._outputPipeValues,
+        );
       } else {
         this.log(
-          "Got JsonRpcMethods.SetupIframeServerResponse but already resolved"
+          "Got JsonRpcMethods.SetupIframeServerResponse but already resolved",
         );
       }
     })();
@@ -263,21 +254,21 @@ export class Metaframe extends EventEmitter<
         resolve();
         return;
       }
-      let disposer: () => void;
+      let disposer: Disposer;
       disposer = this.addListenerReturnDisposer(
         MetaframeEvents.Connected,
         () => {
           resolve();
           disposer();
-        }
+        },
       );
     });
   }
 
   addListenerReturnDisposer(
     event: MetaframeEvents | JsonRpcMethodsFromChild,
-    listener: ListenerFn<any[]>
-  ): () => void {
+    listener: ListenerFn<any[]>,
+  ): Disposer {
     super.addListener(event, listener);
     const disposer = () => {
       super.removeListener(event, listener);
@@ -331,7 +322,7 @@ export class Metaframe extends EventEmitter<
 
   public addListener(
     event: MetaframeEvents | JsonRpcMethodsFromChild,
-    listener: ListenerFn<any[]>
+    listener: ListenerFn<any[]>,
   ) {
     super.addListener(event, listener);
 
@@ -348,21 +339,21 @@ export class Metaframe extends EventEmitter<
     return this;
   }
 
-  public onInput(pipeId: MetaframePipeId, listener: any): () => void {
+  public onInput(pipeId: MetaframePipeId, listener: any): Disposer {
     return this.addListenerReturnDisposer(
       MetaframeEvents.Input,
       (pipe: MetaframePipeId, value: any) => {
         if (pipeId === pipe) {
           listener(value);
         }
-      }
+      },
     );
   }
 
-  public onInputs(listener: (m: MetaframeInputMap) => void): () => void {
+  public onInputs(listener: (m: MetaframeInputMap) => void): Disposer {
     const disposer = this.addListenerReturnDisposer(
       MetaframeEvents.Inputs,
-      listener
+      listener,
     );
     return disposer;
   }
@@ -408,16 +399,19 @@ export class Metaframe extends EventEmitter<
     Object.keys(inputs).forEach((pipeId) => {
       try {
         // if we don't actually need this event, we should remove it
-        this.emit(MetaframeEvents.Input, pipeId, inputs[pipeId])
-      } catch(err) {
-        console.error(`Error emitting input ${pipeId}: ${err}`)
-        this.emit(MetaframeEvents.Error, `Error emitting input ${pipeId}: ${err}`);
+        this.emit(MetaframeEvents.Input, pipeId, inputs[pipeId]);
+      } catch (err) {
+        console.error(`Error emitting input ${pipeId}: ${err}`);
+        this.emit(
+          MetaframeEvents.Error,
+          `Error emitting input ${pipeId}: ${err}`,
+        );
       }
     });
     try {
       this.emit(MetaframeEvents.Inputs, inputs);
-    } catch(err) {
-      console.error(`Error emitting inputs: ${err}`)
+    } catch (err) {
+      console.error(`Error emitting inputs: ${err}`);
       this.emit(MetaframeEvents.Error, `Error emitting inputs: ${err}`);
     }
   }
@@ -475,8 +469,6 @@ export class Metaframe extends EventEmitter<
   //   window.removeEventListener("hashchange", this._onHashUrlChange);
   // }
 
-
-
   /** Tell the parent metapage our hash params changed */
   _onHashUrlChange(_: any): void {
     const payload: MetapageEventUrlHashUpdate = {
@@ -501,7 +493,7 @@ export class Metaframe extends EventEmitter<
       }
     } else {
       this.log(
-        "Cannot send JSON-RPC window message: there is no window.parent which means we are not an iframe"
+        "Cannot send JSON-RPC window message: there is no window.parent which means we are not an iframe",
       );
     }
   }
@@ -519,7 +511,7 @@ export class Metaframe extends EventEmitter<
           )
         ) {
           this.log(
-            `window.message: received message (method=${method}) but jsonrpc.parentId=${jsonrpc.parentId} _parentId=${this._parentId} jsonrpc.iframeId=${jsonrpc.iframeId} id=${this.id}`
+            `window.message: received message (method=${method}) but jsonrpc.parentId=${jsonrpc.parentId} _parentId=${this._parentId} jsonrpc.iframeId=${jsonrpc.iframeId} id=${this.id}`,
           );
           return;
         }
@@ -541,8 +533,8 @@ export class Metaframe extends EventEmitter<
             if (this.debug)
               this.log(
                 `window.message: unknown JSON-RPC method: ${JSON.stringify(
-                  jsonrpc
-                )}`
+                  jsonrpc,
+                )}`,
               );
             break;
         }
@@ -558,7 +550,7 @@ export class Metaframe extends EventEmitter<
     setHashParamInWindow(key, value);
   }
 
-  getParameter(key: string) :string | undefined {
+  getParameter(key: string): string | undefined {
     return getHashParamFromWindow(key);
   }
 
@@ -566,7 +558,7 @@ export class Metaframe extends EventEmitter<
     setHashParamValueBooleanInWindow(key, value);
   }
 
-  getParameterBoolean(key: string) :boolean | undefined {
+  getParameterBoolean(key: string): boolean | undefined {
     return getHashParamValueBooleanFromWindow(key);
   }
 
@@ -574,7 +566,7 @@ export class Metaframe extends EventEmitter<
     setHashParamValueJsonInWindow(key, value);
   }
 
-  getParameterJson<T>(key: string) :T|undefined {
+  getParameterJson<T>(key: string): T | undefined {
     return getHashParamValueJsonFromWindow<T>(key);
   }
 
@@ -582,7 +574,7 @@ export class Metaframe extends EventEmitter<
     setHashParamValueBase64EncodedInWindow(key, value);
   }
 
-  getParameterBase64(key: string) :string | undefined {
+  getParameterBase64(key: string): string | undefined {
     return getHashParamValueBase64DecodedFromWindow(key);
   }
 
@@ -590,7 +582,7 @@ export class Metaframe extends EventEmitter<
     setHashParamValueFloatInWindow(key, value);
   }
 
-  getParameterFloat(key: string) :number | undefined {
+  getParameterFloat(key: string): number | undefined {
     return getHashParamValueFloatFromWindow(key);
   }
 
@@ -598,11 +590,11 @@ export class Metaframe extends EventEmitter<
     setHashParamValueIntInWindow(key, value);
   }
 
-  getParameterInt(key: string) :number | undefined {
+  getParameterInt(key: string): number | undefined {
     return getHashParamValueIntFromWindow(key);
   }
 
   deleteParameter(key: string) {
     setHashParamInWindow(key, undefined);
   }
-}
+}

package/src/metapage/Metapage.ts

@@ -7,7 +7,7 @@ import {
   convertMetapageDefinitionToCurrentVersion,
   getMatchingMetapageVersion,
 } from "./conversions-metapage";
-import { MetaframeId, MetaframePipeId, MetapageId } from "./core";
+import { Disposer, MetaframeId, MetaframePipeId, MetapageId } from "./core";
 import { deserializeInputs, serializeInputs } from "./data";
 import {
   MetapageEventDefinition,
@@ -54,11 +54,11 @@ const emptyState: MetapageState = create<MetapageState>(
       outputs: {},
     },
   },
-  (draft) => draft
+  (draft) => draft,
 );
 
 export const getLibraryVersionMatching = (
-  version: string
+  version: string,
 ): VersionsMetapage => {
   return getMatchingMetapageVersion(version);
 };
@@ -157,7 +157,7 @@ export class Metapage extends MetapageShared {
   // for caching input lookups
   _cachedInputLookupMap: CachedInputLookupMap = create<CachedInputLookupMap>(
     {},
-    (draft) => draft
+    (draft) => draft,
   );
   _inputMap: {
     [key: string]: PipeInput[];
@@ -260,8 +260,8 @@ export class Metapage extends MetapageShared {
 
   addListenerReturnDisposer(
     event: MetapageEvents,
-    listener: ListenerFn<any[]>
-  ): () => void {
+    listener: ListenerFn<any[]>,
+  ): Disposer {
     super.addListener(event, listener);
     const disposer = () => {
       super.removeListener(event, listener);
@@ -269,15 +269,15 @@ export class Metapage extends MetapageShared {
     return disposer;
   }
 
-  onInputs(cb: (inputs: MetapageInstanceInputs) => () => void) {
+  onInputs(cb: (inputs: MetapageInstanceInputs) => void): Disposer {
     return this.addListenerReturnDisposer(MetapageEvents.Inputs, cb);
   }
 
-  onOutputs(cb: (outputs: MetapageInstanceInputs) => void) {
+  onOutputs(cb: (outputs: MetapageInstanceInputs) => void): Disposer {
     return this.addListenerReturnDisposer(MetapageEvents.Outputs, cb);
   }
 
-  onState(cb: (state: MetapageState) => void) {
+  onState(cb: (state: MetapageState) => void): Disposer {
     return this.addListenerReturnDisposer(MetapageEvents.State, cb);
   }
 
@@ -301,10 +301,10 @@ export class Metapage extends MetapageShared {
     this._state = create<MetapageState>(newState, (draft) => draft);
     this.getMetaframeIds().forEach((metaframeId) => {
       this.getMetaframe(metaframeId)?.setInputs(
-        this._state.metaframes.inputs[metaframeId]
+        this._state.metaframes.inputs[metaframeId],
       );
       this.getMetaframe(metaframeId)?.setOutputs(
-        this._state.metaframes.outputs[metaframeId]
+        this._state.metaframes.outputs[metaframeId],
       );
     });
 
@@ -326,7 +326,7 @@ export class Metapage extends MetapageShared {
 
   public async setDefinition(
     def: any,
-    state?: MetapageState
+    state?: MetapageState,
   ): Promise<Metapage> {
     // Some validation
     if (!def.version) {
@@ -351,7 +351,7 @@ export class Metapage extends MetapageShared {
 
         if (!metaframeDefinition.url) {
           this.emitErrorMessage(
-            `Metaframe "${metaframeId}" missing field: url`
+            `Metaframe "${metaframeId}" missing field: url`,
           );
           throw `Metaframe "${metaframeId}" missing field: url`;
         }
@@ -485,7 +485,7 @@ export class Metapage extends MetapageShared {
   // to add/remove
   removeAll(): void {
     Object.keys(this._metaframes).forEach((id) =>
-      this._metaframes[id].dispose()
+      this._metaframes[id].dispose(),
     );
     this._metaframes = create({}, (draft) => draft);
     this._state = emptyState;
@@ -518,7 +518,7 @@ export class Metapage extends MetapageShared {
   // do not expose, change definition instead
   addMetaframe(
     metaframeId: MetaframeId,
-    definition: MetaframeInstance
+    definition: MetaframeInstance,
   ): MetapageIFrameRpcClient {
     if (!metaframeId) {
       throw "addMetaframe missing metaframeId";
@@ -535,7 +535,7 @@ export class Metapage extends MetapageShared {
 
     if (!definition.url) {
       this.emitErrorMessage(
-        `Metaframe definition missing url id=${metaframeId}`
+        `Metaframe definition missing url id=${metaframeId}`,
       );
       throw `Metaframe definition missing url id=${metaframeId}`;
     }
@@ -546,13 +546,13 @@ export class Metapage extends MetapageShared {
       metaframeId,
       this._id,
       this._consoleBackgroundColor,
-      this.debug
+      this.debug,
     ).setMetapage(this);
     this._metaframes = create<MetaframeClients>(
       this._metaframes,
       (draft: MetaframeClients) => {
         draft[metaframeId] = iframeClient;
-      }
+      },
     );
 
     iframeClient.addListener(MetapageEvents.Error, (err) => {
@@ -581,7 +581,7 @@ export class Metapage extends MetapageShared {
     window.removeEventListener("message", this.onMessage);
     if (this._metaframes) {
       Object.keys(this._metaframes).forEach((metaframeId) =>
-        this._metaframes[metaframeId].dispose()
+        this._metaframes[metaframeId].dispose(),
       );
     }
 
@@ -618,7 +618,7 @@ export class Metapage extends MetapageShared {
   getInputsFromOutput(
     source: MetaframeId,
     // the pipe id is simply the name of the output file/object/thing
-    outputPipeId: MetaframePipeId
+    outputPipeId: MetaframePipeId,
   ): MetaframeInputTargetsFromOutput[] {
     // Do all the cache checking
     if (!this._cachedInputLookupMap[source]) {
@@ -626,7 +626,7 @@ export class Metapage extends MetapageShared {
         this._cachedInputLookupMap,
         (draft: CachedInputLookupMap) => {
           draft[source] = create({}, (__) => __);
-        }
+        },
       );
     }
 
@@ -668,7 +668,7 @@ export class Metapage extends MetapageShared {
               }
             });
           });
-        }
+        },
       );
     }
 
@@ -718,7 +718,7 @@ export class Metapage extends MetapageShared {
   public setInput(
     iframeId: MetaframeId | MetapageInstanceInputs,
     inputPipeId?: MetaframePipeId | MetaframeInputMap,
-    value?: PipeUpdateBlob
+    value?: PipeUpdateBlob,
   ) {
     if (typeof iframeId === "object") {
       this.setInputStateOnlyMetapageInstanceInputs(iframeId);
@@ -731,7 +731,7 @@ export class Metapage extends MetapageShared {
     this.setMetaframeClientInputAndSentClientEvent(
       iframeId,
       inputPipeId,
-      value
+      value,
     );
     // finally send the main events
     if (
@@ -748,7 +748,7 @@ export class Metapage extends MetapageShared {
   setMetaframeClientInputAndSentClientEvent(
     iframeId: MetaframeId | MetapageInstanceInputs,
     inputPipeId?: MetaframePipeId | MetaframeInputMap,
-    value?: PipeUpdateBlob
+    value?: PipeUpdateBlob,
   ) {
     if (typeof iframeId === "object") {
       if (inputPipeId || value) {
@@ -788,13 +788,13 @@ export class Metapage extends MetapageShared {
   public setInputs(
     iframeId: MetaframeId | MetapageInstanceInputs,
     inputPipeId?: MetaframePipeId | MetaframeInputMap,
-    value?: PipeUpdateBlob
+    value?: PipeUpdateBlob,
   ) {
     this.setInput(iframeId, inputPipeId, value);
   }
 
   setOutputStateOnlyMetapageInstanceInputs(
-    metapageInputs: MetapageInstanceInputs
+    metapageInputs: MetapageInstanceInputs,
   ) {
     this._setStateOnlyMetaframes(false, metapageInputs);
   }
@@ -802,25 +802,25 @@ export class Metapage extends MetapageShared {
   setOutputStateOnlyMetaframeInputValue(
     metaframeId: MetaframeId,
     inputPipeId: MetaframePipeId,
-    value?: PipeUpdateBlob
+    value?: PipeUpdateBlob,
   ) {
     this._setStateOnlyMetaframeInputValue(
       false,
       metaframeId,
       inputPipeId,
-      value
+      value,
     );
   }
 
   setOutputStateOnlyMetaframeInputMap(
     metaframeId: MetaframeId,
-    metaframeValuesNew: MetaframeInputMap
+    metaframeValuesNew: MetaframeInputMap,
   ) {
     this._setStateOnlyMetaframeInputMap(false, metaframeId, metaframeValuesNew);
   }
 
   setInputStateOnlyMetapageInstanceInputs(
-    metapageInputs: MetapageInstanceInputs
+    metapageInputs: MetapageInstanceInputs,
   ) {
     this._setStateOnlyMetaframes(true, metapageInputs);
   }
@@ -828,19 +828,19 @@ export class Metapage extends MetapageShared {
   setInputStateOnlyMetaframeInputValue(
     metaframeId: MetaframeId,
     inputPipeId: MetaframePipeId,
-    value?: PipeUpdateBlob
+    value?: PipeUpdateBlob,
   ) {
     this._setStateOnlyMetaframeInputValue(
       true,
       metaframeId,
       inputPipeId,
-      value
+      value,
     );
   }
 
   setInputStateOnlyMetaframeInputMap(
     metaframeId: MetaframeId,
-    metaframeValuesNew: MetaframeInputMap
+    metaframeValuesNew: MetaframeInputMap,
   ) {
     this._setStateOnlyMetaframeInputMap(true, metaframeId, metaframeValuesNew);
   }
@@ -849,7 +849,7 @@ export class Metapage extends MetapageShared {
     isInputs: boolean,
     metaframeId: MetaframeId,
     metaframePipeId: MetaframePipeId,
-    value?: PipeUpdateBlob
+    value?: PipeUpdateBlob,
   ): void {
     this._state = create(this._state, (draft: MetapageState) => {
       const isMetaframe = this._metaframes.hasOwnProperty(metaframeId);
@@ -893,7 +893,7 @@ export class Metapage extends MetapageShared {
   _setStateOnlyMetaframeInputMap(
     isInputs: boolean,
     metaframeId: MetaframeId,
-    metaframeValuesNew: MetaframeInputMap
+    metaframeValuesNew: MetaframeInputMap,
   ): void {
     if (!metaframeValuesNew || Object.keys(metaframeValuesNew).length === 0) {
       return;
@@ -929,7 +929,7 @@ export class Metapage extends MetapageShared {
 
   _setStateOnlyMetaframes(
     isInputs: boolean,
-    inputsMetaframesNew: MetapageInstanceInputs
+    inputsMetaframesNew: MetapageInstanceInputs,
   ): void {
     if (!inputsMetaframesNew || Object.keys(inputsMetaframesNew).length === 0) {
       return;
@@ -1045,7 +1045,7 @@ export class Metapage extends MetapageShared {
 
     if (this.debug) {
       this.log(
-        `processing ${JSON.stringify(jsonrpc, null, "  ").substring(0, 500)}`
+        `processing ${JSON.stringify(jsonrpc, null, "  ").substring(0, 500)}`,
       );
     }
 
@@ -1107,7 +1107,7 @@ export class Metapage extends MetapageShared {
             this.setInputStateOnlyMetapageInstanceInputs(collectedOutputs);
             Object.keys(collectedOutputs).forEach((metaframeId) => {
               this._metaframes[metaframeId].setInputs(
-                collectedOutputs[metaframeId]
+                collectedOutputs[metaframeId],
                 // then actually set the inputs once collected
               );
             });
@@ -1157,7 +1157,7 @@ export class Metapage extends MetapageShared {
           }
         } else {
           console.error(
-            `InputsUpdate failed no metaframe id: "${metaframeId}"`
+            `InputsUpdate failed no metaframe id: "${metaframeId}"`,
           );
           this.error(`InputsUpdate failed no metaframe id: "${metaframeId}"`);
         }
@@ -1187,7 +1187,7 @@ export class Metapage extends MetapageShared {
             (draft) => {
               draft.metaframes[hashParamsUpdatePayload.metaframe].url =
                 url.href;
-            }
+            },
           );
 
           this._emitDefinitionEvent();