@aglyn/besigner 1.0.0-beta.220 → 1.0.0-beta.222

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aglyn/besigner",
-  "version": "1.0.0-beta.220",
+  "version": "1.0.0-beta.222",
   "license": "Apache-2.0",
   "homepage": "https://aglyn.com",
   "repository": {
@@ -25,11 +25,11 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@aglyn/aglyn": "1.0.0-beta.220",
-    "@aglyn/shared-data-types": "1.0.0-beta.220",
-    "@aglyn/shared-util-logger": "1.0.0-beta.220",
-    "@aglyn/shared-util-tools": "1.0.0-beta.220",
-    "@aglyn/shared-util-vendor": "1.0.0-beta.220",
+    "@aglyn/aglyn": "1.0.0-beta.222",
+    "@aglyn/shared-data-types": "1.0.0-beta.222",
+    "@aglyn/shared-util-logger": "1.0.0-beta.222",
+    "@aglyn/shared-util-tools": "1.0.0-beta.222",
+    "@aglyn/shared-util-vendor": "1.0.0-beta.222",
     "@swc/helpers": "0.5.23",
     "lodash-es": "^4.18.1",
     "mobx": "^7.0.5",

package/src/lib/definitions/besigner-interface.types.d.ts

@@ -62,6 +62,13 @@ export type BesignerContext = {
         mutedClasses?: string[];
         /** What kind of host view the canvas is editing (screen or shared layout). */
         viewType?: HostViewType;
+        /**
+         * What the open document is called in copy — 'page', 'component',
+         * 'email', 'template', or a plugin document's own noun. The view type
+         * cannot say this: a page component edits in the SCREEN view. Unset when
+         * no editor has published one, which canvas copy reads as 'page'.
+         */
+        documentNoun?: string;
         /**
          * WYSIWYG bindings (AGL-97): when not false, the canvas resolves
          * variable/function binding tokens live; toggle off for raw tokens.

package/src/lib/definitions/besigner-interface.types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../../libs/besigner/core/src/lib/definitions/besigner-interface.types.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2022 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { HostViewType } from '@aglyn/aglyn'\nimport type { IBesignerAppController } from './besigner-app.types'\nimport type { HostThemeScheme } from '@aglyn/shared-data-types'\n// eslint-disable-next-line @nx/enforce-module-boundaries\nimport type { LogLevelString } from '@aglyn/shared-util-logger'\nimport type { BehaviorSubject } from 'rxjs'\nimport type {\n  BesignerDeviceFlag,\n  BesignerStateFlag,\n  BesignerPanelTabFlag,\n  BesignerPanelViewFlag,\n  InteractionModeFlag,\n} from '../constants/besigner'\nimport type {\n  BesignerSetFlagPayload,\n  BesignerSetFlagsPayload,\n  BesignerSetPanelPayload,\n  BesignerSetPanelsPayload,\n} from './emitter.types'\n\nexport type BesignerContext = {\n  flags: {\n    debug: boolean\n    logLevel: LogLevelString\n    interactMode: InteractionModeFlag\n    activeView?: BesignerPanelViewFlag\n    devicePreview?: BesignerDeviceFlag\n    /** Color scheme the canvas previews the host theme in; console UI is unaffected. */\n    canvasScheme?: HostThemeScheme\n    /**\n     * Interaction state held ON for the element being styled (AGL-2486).\n     * Canvas only, never persisted — see {@link BesignerStateFlag}.\n     */\n    heldState?: BesignerStateFlag\n    /** The node the held state applies to; every other leaf renders at rest. */\n    heldStateNodeId?: string\n    /**\n     * Nodes the canvas shows even though they carry the hidden class\n     * (AGL-592) — a mega-menu panel or a drawer opened up for designing.\n     * Canvas only, never persisted and never written back to the document:\n     * showing a panel to work on it is a different act from publishing the\n     * site with it open.\n     */\n    revealedNodeIds?: string[]\n    /**\n     * Style declarations the canvas is rendering without, so a layout can be\n     * compared against itself with one property switched off (AGL-2486).\n     * Encoded `nodeId|state|breakpoint|property` — see `muted-styles`. Canvas\n     * only: the declaration stays in the document exactly where it was\n     * written, and only the canvas's copy of the sx drops it.\n     */\n    mutedStyles?: string[]\n    /**\n     * Classes the canvas is rendering without, encoded `nodeId|className`\n     * (AGL-2486). Canvas only, like the style mutes: the element's class list\n     * in the document is untouched, so what the Classes chips show is what\n     * ships.\n     */\n    mutedClasses?: string[]\n    /** What kind of host view the canvas is editing (screen or shared layout). */\n    viewType?: HostViewType\n    /**\n     * WYSIWYG bindings (AGL-97): when not false, the canvas resolves\n     * variable/function binding tokens live; toggle off for raw tokens.\n     */\n    resolveBindings?: boolean\n  }\n  panels: {\n    panelLeft?: BesignerPanelItem\n    panelRight?: BesignerPanelItem\n    panelBottom?: BesignerPanelItem\n  }\n}\nexport type BesignerFlagsState = BesignerContext['flags']\nexport type BesignerFlagKey = keyof BesignerFlagsState\nexport type BesignerFlagValue<K extends BesignerFlagKey = BesignerFlagKey> =\n  BesignerFlagsState[K]\nexport type BesignerPanelsState = BesignerContext['panels']\nexport type BesignerPanelKey = keyof BesignerPanelsState\nexport type BesignerPanelValue<K extends BesignerPanelKey = BesignerPanelKey> =\n  BesignerPanelsState[K]\nexport type BesignerPanelItem = {\n  id?: BesignerPanelViewFlag\n  size?: number | string\n  toggled?: boolean\n  tab?: BesignerPanelTabFlag\n}\n\nexport interface BesignerInterfaceControllerOptions {\n  logLevel?: LogLevelString\n  defaults?: Partial<BesignerContext>\n}\n\nexport interface IBesignerInterfaceController {\n  readonly __store__: {\n    [K in keyof BesignerContext]: BehaviorSubject<BesignerContext[K]>\n  }\n  readonly flags: this['__store__']['flags']\n  readonly panels: this['__store__']['panels']\n\n  setFlag(payload: BesignerSetFlagPayload): this\n  setFlags(payload: BesignerSetFlagsPayload): this\n  setPanel(payload: BesignerSetPanelPayload): this\n  setPanels(payload: BesignerSetPanelsPayload): this\n}\n\nexport interface BesignerInterfaceControllerT {\n  new (\n    app: IBesignerAppController,\n    options: BesignerInterfaceControllerOptions,\n  ): IBesignerInterfaceController\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GA4GD,WAKC"}
+{"version":3,"sources":["../../../../../../../libs/besigner/core/src/lib/definitions/besigner-interface.types.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2022 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { HostViewType } from '@aglyn/aglyn'\nimport type { IBesignerAppController } from './besigner-app.types'\nimport type { HostThemeScheme } from '@aglyn/shared-data-types'\n// eslint-disable-next-line @nx/enforce-module-boundaries\nimport type { LogLevelString } from '@aglyn/shared-util-logger'\nimport type { BehaviorSubject } from 'rxjs'\nimport type {\n  BesignerDeviceFlag,\n  BesignerStateFlag,\n  BesignerPanelTabFlag,\n  BesignerPanelViewFlag,\n  InteractionModeFlag,\n} from '../constants/besigner'\nimport type {\n  BesignerSetFlagPayload,\n  BesignerSetFlagsPayload,\n  BesignerSetPanelPayload,\n  BesignerSetPanelsPayload,\n} from './emitter.types'\n\nexport type BesignerContext = {\n  flags: {\n    debug: boolean\n    logLevel: LogLevelString\n    interactMode: InteractionModeFlag\n    activeView?: BesignerPanelViewFlag\n    devicePreview?: BesignerDeviceFlag\n    /** Color scheme the canvas previews the host theme in; console UI is unaffected. */\n    canvasScheme?: HostThemeScheme\n    /**\n     * Interaction state held ON for the element being styled (AGL-2486).\n     * Canvas only, never persisted — see {@link BesignerStateFlag}.\n     */\n    heldState?: BesignerStateFlag\n    /** The node the held state applies to; every other leaf renders at rest. */\n    heldStateNodeId?: string\n    /**\n     * Nodes the canvas shows even though they carry the hidden class\n     * (AGL-592) — a mega-menu panel or a drawer opened up for designing.\n     * Canvas only, never persisted and never written back to the document:\n     * showing a panel to work on it is a different act from publishing the\n     * site with it open.\n     */\n    revealedNodeIds?: string[]\n    /**\n     * Style declarations the canvas is rendering without, so a layout can be\n     * compared against itself with one property switched off (AGL-2486).\n     * Encoded `nodeId|state|breakpoint|property` — see `muted-styles`. Canvas\n     * only: the declaration stays in the document exactly where it was\n     * written, and only the canvas's copy of the sx drops it.\n     */\n    mutedStyles?: string[]\n    /**\n     * Classes the canvas is rendering without, encoded `nodeId|className`\n     * (AGL-2486). Canvas only, like the style mutes: the element's class list\n     * in the document is untouched, so what the Classes chips show is what\n     * ships.\n     */\n    mutedClasses?: string[]\n    /** What kind of host view the canvas is editing (screen or shared layout). */\n    viewType?: HostViewType\n    /**\n     * What the open document is called in copy — 'page', 'component',\n     * 'email', 'template', or a plugin document's own noun. The view type\n     * cannot say this: a page component edits in the SCREEN view. Unset when\n     * no editor has published one, which canvas copy reads as 'page'.\n     */\n    documentNoun?: string\n    /**\n     * WYSIWYG bindings (AGL-97): when not false, the canvas resolves\n     * variable/function binding tokens live; toggle off for raw tokens.\n     */\n    resolveBindings?: boolean\n  }\n  panels: {\n    panelLeft?: BesignerPanelItem\n    panelRight?: BesignerPanelItem\n    panelBottom?: BesignerPanelItem\n  }\n}\nexport type BesignerFlagsState = BesignerContext['flags']\nexport type BesignerFlagKey = keyof BesignerFlagsState\nexport type BesignerFlagValue<K extends BesignerFlagKey = BesignerFlagKey> =\n  BesignerFlagsState[K]\nexport type BesignerPanelsState = BesignerContext['panels']\nexport type BesignerPanelKey = keyof BesignerPanelsState\nexport type BesignerPanelValue<K extends BesignerPanelKey = BesignerPanelKey> =\n  BesignerPanelsState[K]\nexport type BesignerPanelItem = {\n  id?: BesignerPanelViewFlag\n  size?: number | string\n  toggled?: boolean\n  tab?: BesignerPanelTabFlag\n}\n\nexport interface BesignerInterfaceControllerOptions {\n  logLevel?: LogLevelString\n  defaults?: Partial<BesignerContext>\n}\n\nexport interface IBesignerInterfaceController {\n  readonly __store__: {\n    [K in keyof BesignerContext]: BehaviorSubject<BesignerContext[K]>\n  }\n  readonly flags: this['__store__']['flags']\n  readonly panels: this['__store__']['panels']\n\n  setFlag(payload: BesignerSetFlagPayload): this\n  setFlags(payload: BesignerSetFlagsPayload): this\n  setPanel(payload: BesignerSetPanelPayload): this\n  setPanels(payload: BesignerSetPanelsPayload): this\n}\n\nexport interface BesignerInterfaceControllerT {\n  new (\n    app: IBesignerAppController,\n    options: BesignerInterfaceControllerOptions,\n  ): IBesignerInterfaceController\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAmHD,WAKC"}