@things-factory/figure-library 10.1.247 → 10.1.250

package/dist-client/figure-library-changed.d.ts

@@ -0,0 +1,8 @@
+export declare const FIGURE_LIBRARY_CHANGED = "figure-library-changed";
+/** Said after the server accepted a change to the domain's type map. */
+export declare function announceLibraryChanged(target?: EventTarget): void;
+/**
+ * Runs `read` on every change. Changes that arrive while a read is under way fold into one more read after it, so
+ * the last read always sees the last change and two reads never race to register the tray.
+ */
+export declare function keepCurrentWithLibrary(read: () => Promise<void>, target?: EventTarget): () => void;

package/dist-client/figure-library-changed.js

@@ -0,0 +1,33 @@
+/*
+ * The library's type map changed: a package was imported, a figure was archived or brought back, or another release
+ * was chosen to draw with (ADR-0114). The modeller tray was read once at boot, so a figure imported later stayed out of
+ * it until the page reloaded. Whatever changes the type map says so here, and the tray reads it again.
+ */
+export const FIGURE_LIBRARY_CHANGED = 'figure-library-changed';
+/** Said after the server accepted a change to the domain's type map. */
+export function announceLibraryChanged(target = window) {
+    target.dispatchEvent(new Event(FIGURE_LIBRARY_CHANGED));
+}
+/**
+ * Runs `read` on every change. Changes that arrive while a read is under way fold into one more read after it, so
+ * the last read always sees the last change and two reads never race to register the tray.
+ */
+export function keepCurrentWithLibrary(read, target = window) {
+    let running;
+    let again = false;
+    const run = async () => {
+        if (running) {
+            again = true;
+            return;
+        }
+        do {
+            again = false;
+            running = read().catch(() => { });
+            await running;
+        } while (again);
+        running = undefined;
+    };
+    target.addEventListener(FIGURE_LIBRARY_CHANGED, run);
+    return () => target.removeEventListener(FIGURE_LIBRARY_CHANGED, run);
+}
+//# sourceMappingURL=figure-library-changed.js.map

package/dist-client/figure-library-changed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"figure-library-changed.js","sourceRoot":"","sources":["../client/figure-library-changed.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,CAAC,MAAM,sBAAsB,GAAG,wBAAwB,CAAA;AAE9D,wEAAwE;AACxE,MAAM,UAAU,sBAAsB,CAAC,SAAsB,MAAM;IACjE,MAAM,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAA;AACzD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAyB,EAAE,SAAsB,MAAM;IAC5F,IAAI,OAAkC,CAAA;IACtC,IAAI,KAAK,GAAG,KAAK,CAAA;IACjB,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;QACrB,IAAI,OAAO,EAAE,CAAC;YACZ,KAAK,GAAG,IAAI,CAAA;YACZ,OAAM;QACR,CAAC;QACD,GAAG,CAAC;YACF,KAAK,GAAG,KAAK,CAAA;YACb,OAAO,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;YAChC,MAAM,OAAO,CAAA;QACf,CAAC,QAAQ,KAAK,EAAC;QACf,OAAO,GAAG,SAAS,CAAA;IACrB,CAAC,CAAA;IACD,MAAM,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAA;IACpD,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAA;AACtE,CAAC","sourcesContent":["/*\n * The library's type map changed: a package was imported, a figure was archived or brought back, or another release\n * was chosen to draw with (ADR-0114). The modeller tray was read once at boot, so a figure imported later stayed out of\n * it until the page reloaded. Whatever changes the type map says so here, and the tray reads it again.\n */\n\nexport const FIGURE_LIBRARY_CHANGED = 'figure-library-changed'\n\n/** Said after the server accepted a change to the domain's type map. */\nexport function announceLibraryChanged(target: EventTarget = window): void {\n  target.dispatchEvent(new Event(FIGURE_LIBRARY_CHANGED))\n}\n\n/**\n * Runs `read` on every change. Changes that arrive while a read is under way fold into one more read after it, so\n * the last read always sees the last change and two reads never race to register the tray.\n */\nexport function keepCurrentWithLibrary(read: () => Promise<void>, target: EventTarget = window): () => void {\n  let running: Promise<void> | undefined\n  let again = false\n  const run = async () => {\n    if (running) {\n      again = true\n      return\n    }\n    do {\n      again = false\n      running = read().catch(() => {})\n      await running\n    } while (again)\n    running = undefined\n  }\n  target.addEventListener(FIGURE_LIBRARY_CHANGED, run)\n  return () => target.removeEventListener(FIGURE_LIBRARY_CHANGED, run)\n}\n"]}

package/dist-client/figure-palette.d.ts

@@ -1,7 +1,9 @@
 import { type FigurePaletteGroup } from './figure-palette-group.js';
 export * from './figure-palette-group.js';
 /**
- * Asks the type map, registers the figures that can be placed, and gives the tray its "Figure" group. A server with no
- * figure library, or a user with no right to read it, gets no group and no error: the tray simply has none.
+ * Asks the type map, registers the figures that can be placed, and gives the tray its "Figure" group -- now, and again
+ * whenever the library changes (an import, an archive, another release chosen), so a figure imported while the app is
+ * open is in the tray without a reload. A server with no figure library, or a user with no right to read it, gets no
+ * group and no error: the tray simply has none.
  */
 export declare function registerFigurePalette(registerGroup: (group: FigurePaletteGroup) => void): Promise<void>;

package/dist-client/figure-palette.js

@@ -9,6 +9,7 @@ import { client } from '@operato/graphql';
 import { i18next } from '@operato/i18n';
 import { getPathInfo } from '@operato/utils';
 import { figurePaletteGroupOf, placeableFigureTypes } from './figure-palette-group.js';
+import { keepCurrentWithLibrary } from './figure-library-changed.js';
 export * from './figure-palette-group.js';
 const TYPE_MAP = gql `
   query {
@@ -27,24 +28,31 @@ const TYPE_MAP = gql `
   }
 `;
 /**
- * Asks the type map, registers the figures that can be placed, and gives the tray its "Figure" group. A server with no
- * figure library, or a user with no right to read it, gets no group and no error: the tray simply has none.
+ * Asks the type map, registers the figures that can be placed, and gives the tray its "Figure" group -- now, and again
+ * whenever the library changes (an import, an archive, another release chosen), so a figure imported while the app is
+ * open is in the tray without a reload. A server with no figure library, or a user with no right to read it, gets no
+ * group and no error: the tray simply has none.
  */
 export async function registerFigurePalette(registerGroup) {
-    try {
-        const lines = (await client.query({ query: TYPE_MAP, fetchPolicy: 'network-only' })).data?.figureTypeMap ?? [];
-        /*
-          A figure placed from the tray must already be registered: the scene resolves types only when a board opens, and
-          a type nobody registered is placed as the stand-in that cannot move. The figure provider registers them now.
-        */
-        const placeable = placeableFigureTypes(lines);
-        if (placeable.length)
-            await resolveUnknownTypes({ components: placeable.map(type => ({ type })) });
-        const { contextPath } = getPathInfo(location.pathname);
-        registerGroup(figurePaletteGroupOf(lines, { contextPath, t: (key, options) => i18next.t(key, options) }));
-    }
-    catch {
-        /* No figure library on this server or no right to read it: the tray has no Figure group. */
-    }
+    const read = async () => {
+        try {
+            const lines = (await client.query({ query: TYPE_MAP, fetchPolicy: 'network-only' })).data?.figureTypeMap ?? [];
+            /*
+              A figure placed from the tray must already be registered: the scene resolves types only when a board opens, and
+              a type nobody registered is placed as the stand-in that cannot move. The figure provider registers them now.
+            */
+            const placeable = placeableFigureTypes(lines);
+            if (placeable.length)
+                await resolveUnknownTypes({ components: placeable.map(type => ({ type })) });
+            const { contextPath } = getPathInfo(location.pathname);
+            /* The modeller replaces a group registered under the same name, so a second read updates the tray in place. */
+            registerGroup(figurePaletteGroupOf(lines, { contextPath, t: (key, options) => i18next.t(key, options) }));
+        }
+        catch {
+            /* No figure library on this server or no right to read it: the tray has no Figure group. */
+        }
+    };
+    await read();
+    keepCurrentWithLibrary(read);
 }
 //# sourceMappingURL=figure-palette.js.map

package/dist-client/figure-palette.js.map

@@ -1 +1 @@
-{"version":3,"file":"figure-palette.js","sourceRoot":"","sources":["../client/figure-palette.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,GAAG,MAAM,aAAa,CAAA;AAE7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAE5C,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAmD,MAAM,2BAA2B,CAAA;AAEvI,cAAc,2BAA2B,CAAA;AAEzC,MAAM,QAAQ,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;CAenB,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,aAAkD;IAC5F,IAAI,CAAC;QACH,MAAM,KAAK,GAAwB,CAAC,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,aAAa,IAAI,EAAE,CAAA;QACnI;;;UAGE;QACF,MAAM,SAAS,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAA;QAC7C,IAAI,SAAS,CAAC,MAAM;YAAE,MAAM,mBAAmB,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;QAElG,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QACtD,aAAa,CAAC,oBAAoB,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAA;IAC3G,CAAC;IAAC,MAAM,CAAC;QACP,4FAA4F;IAC9F,CAAC;AACH,CAAC","sourcesContent":["/*\n * The figures this board server imported (ADR-0114), in a board modeller's tray. Every app whose boards place library\n * figures calls this once from its bootstrap and hands it its modeller's `registerGroup` -- the tray belongs to the\n * modeller the app uses, and an app may carry its own (fmsim).\n */\nimport gql from 'graphql-tag'\n\nimport { resolveUnknownTypes } from '@hatiolab/things-scene'\nimport { client } from '@operato/graphql'\nimport { i18next } from '@operato/i18n'\nimport { getPathInfo } from '@operato/utils'\n\nimport { figurePaletteGroupOf, placeableFigureTypes, type FigurePaletteGroup, type FigureTypeMapLine } from './figure-palette-group.js'\n\nexport * from './figure-palette-group.js'\n\nconst TYPE_MAP = gql`\n  query {\n    figureTypeMap {\n      name\n      release {\n        ref\n        name\n        formatSupported\n        item\n        holder\n        assetFormat\n        dependencies\n      }\n    }\n  }\n`\n\n/**\n * Asks the type map, registers the figures that can be placed, and gives the tray its \"Figure\" group. A server with no\n * figure library, or a user with no right to read it, gets no group and no error: the tray simply has none.\n */\nexport async function registerFigurePalette(registerGroup: (group: FigurePaletteGroup) => void): Promise<void> {\n  try {\n    const lines: FigureTypeMapLine[] = (await client.query({ query: TYPE_MAP, fetchPolicy: 'network-only' })).data?.figureTypeMap ?? []\n    /*\n      A figure placed from the tray must already be registered: the scene resolves types only when a board opens, and\n      a type nobody registered is placed as the stand-in that cannot move. The figure provider registers them now.\n    */\n    const placeable = placeableFigureTypes(lines)\n    if (placeable.length) await resolveUnknownTypes({ components: placeable.map(type => ({ type })) })\n\n    const { contextPath } = getPathInfo(location.pathname)\n    registerGroup(figurePaletteGroupOf(lines, { contextPath, t: (key, options) => i18next.t(key, options) }))\n  } catch {\n    /* No figure library on this server or no right to read it: the tray has no Figure group. */\n  }\n}\n"]}
+{"version":3,"file":"figure-palette.js","sourceRoot":"","sources":["../client/figure-palette.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,GAAG,MAAM,aAAa,CAAA;AAE7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAE5C,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAmD,MAAM,2BAA2B,CAAA;AACvI,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AAEpE,cAAc,2BAA2B,CAAA;AAEzC,MAAM,QAAQ,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;CAenB,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,aAAkD;IAC5F,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;QACtB,IAAI,CAAC;YACH,MAAM,KAAK,GAAwB,CAAC,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,aAAa,IAAI,EAAE,CAAA;YACnI;;;cAGE;YACF,MAAM,SAAS,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAA;YAC7C,IAAI,SAAS,CAAC,MAAM;gBAAE,MAAM,mBAAmB,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;YAElG,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;YACtD,+GAA+G;YAC/G,aAAa,CAAC,oBAAoB,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAA;QAC3G,CAAC;QAAC,MAAM,CAAC;YACP,4FAA4F;QAC9F,CAAC;IACH,CAAC,CAAA;IACD,MAAM,IAAI,EAAE,CAAA;IACZ,sBAAsB,CAAC,IAAI,CAAC,CAAA;AAC9B,CAAC","sourcesContent":["/*\n * The figures this board server imported (ADR-0114), in a board modeller's tray. Every app whose boards place library\n * figures calls this once from its bootstrap and hands it its modeller's `registerGroup` -- the tray belongs to the\n * modeller the app uses, and an app may carry its own (fmsim).\n */\nimport gql from 'graphql-tag'\n\nimport { resolveUnknownTypes } from '@hatiolab/things-scene'\nimport { client } from '@operato/graphql'\nimport { i18next } from '@operato/i18n'\nimport { getPathInfo } from '@operato/utils'\n\nimport { figurePaletteGroupOf, placeableFigureTypes, type FigurePaletteGroup, type FigureTypeMapLine } from './figure-palette-group.js'\nimport { keepCurrentWithLibrary } from './figure-library-changed.js'\n\nexport * from './figure-palette-group.js'\n\nconst TYPE_MAP = gql`\n  query {\n    figureTypeMap {\n      name\n      release {\n        ref\n        name\n        formatSupported\n        item\n        holder\n        assetFormat\n        dependencies\n      }\n    }\n  }\n`\n\n/**\n * Asks the type map, registers the figures that can be placed, and gives the tray its \"Figure\" group -- now, and again\n * whenever the library changes (an import, an archive, another release chosen), so a figure imported while the app is\n * open is in the tray without a reload. A server with no figure library, or a user with no right to read it, gets no\n * group and no error: the tray simply has none.\n */\nexport async function registerFigurePalette(registerGroup: (group: FigurePaletteGroup) => void): Promise<void> {\n  const read = async () => {\n    try {\n      const lines: FigureTypeMapLine[] = (await client.query({ query: TYPE_MAP, fetchPolicy: 'network-only' })).data?.figureTypeMap ?? []\n      /*\n        A figure placed from the tray must already be registered: the scene resolves types only when a board opens, and\n        a type nobody registered is placed as the stand-in that cannot move. The figure provider registers them now.\n      */\n      const placeable = placeableFigureTypes(lines)\n      if (placeable.length) await resolveUnknownTypes({ components: placeable.map(type => ({ type })) })\n\n      const { contextPath } = getPathInfo(location.pathname)\n      /* The modeller replaces a group registered under the same name, so a second read updates the tray in place. */\n      registerGroup(figurePaletteGroupOf(lines, { contextPath, t: (key, options) => i18next.t(key, options) }))\n    } catch {\n      /* No figure library on this server or no right to read it: the tray has no Figure group. */\n    }\n  }\n  await read()\n  keepCurrentWithLibrary(read)\n}\n"]}