This repository was archived by the owner on Nov 27, 2025. It is now read-only.
Integrate Wizarding API V3 from OpenEnergyTools to OpenSCD #1630
+238
−44
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,127 @@ | ||
| import { | ||
| customElement, | ||
| html, | ||
| LitElement, | ||
| property, | ||
| query, | ||
| state, | ||
| TemplateResult, | ||
| } from 'lit-element'; | ||
| import { WizardEvent, WizardFactory } from '../foundation.js'; | ||
| import '../wizard-dialog.js'; | ||
| import { WizardDialog } from '../wizard-dialog.js'; | ||
| import { CreateWizardRequest, EditWizardRequest } from '../scl-wizarding.js'; | ||
|
|
||
| function adaptV3Wizard(v3Def: unknown): WizardFactory | null { | ||
| const v3 = v3Def as { | ||
| steps: Array<{ | ||
| title: string; | ||
| render: () => TemplateResult; | ||
| }>; | ||
| }; | ||
| if (!v3?.steps?.length) return null; | ||
|
|
||
| return () => | ||
| v3.steps.map(step => ({ | ||
| title: step.title, | ||
| content: [step.render()], | ||
| actions: [ | ||
| { | ||
| label: 'Close', | ||
| icon: 'close', | ||
| action: () => [], | ||
| }, | ||
| ], | ||
| })); | ||
| } | ||
|
|
||
| /** `LitElement` mixin that adds a `workflow` property which [[`Wizard`]]s are | ||
| * queued onto on incoming [[`WizardEvent`]]s, first come first displayed. */ | ||
| @customElement('oscd-wizards') | ||
| export class OscdWizards extends LitElement { | ||
| @property({ type: Object }) | ||
| host!: HTMLElement; | ||
|
|
||
| /** FIFO queue of WizardFactories to display */ | ||
| @state() | ||
| workflow: WizardFactory[] = []; | ||
|
|
||
| @query('wizard-dialog') | ||
| wizardUI!: WizardDialog; | ||
|
|
||
| private onWizard(event: WizardEvent) { | ||
| const { wizard, subwizard, v3Wizard } = event.detail; | ||
| if (v3Wizard) { | ||
| const adapted = adaptV3Wizard(v3Wizard); | ||
| if (adapted === null) { | ||
| this.workflow.shift(); | ||
| } else if (subwizard) { | ||
| this.workflow.unshift(adapted); | ||
| } else { | ||
| this.workflow.push(adapted); | ||
| } | ||
| } else if (wizard === null) { | ||
| this.workflow.shift(); | ||
| } else if (wizard) { | ||
| if (subwizard) { | ||
| this.workflow.unshift(wizard); | ||
| } else { | ||
| this.workflow.push(wizard); | ||
| } | ||
| } | ||
|
|
||
| this.updateWizards(); | ||
| } | ||
|
|
||
| private onWizardRequest( | ||
| e: CustomEvent<EditWizardRequest | CreateWizardRequest> | ||
| ) { | ||
| const detail = e.detail as (EditWizardRequest | CreateWizardRequest) & { | ||
| wizard?: WizardFactory; | ||
| }; | ||
| if ('wizard' in detail && detail.wizard) { | ||
| const wf = detail.wizard as WizardFactory; | ||
| detail.subWizard ? this.workflow.unshift(wf) : this.workflow.push(wf); | ||
| } else { | ||
| console.log('[oscd-wizards] No wizard provided, skipping...'); | ||
| } | ||
|
|
||
| this.updateWizards(); | ||
| } | ||
|
|
||
| private onCloseWizard() { | ||
| this.workflow.shift(); | ||
| this.updateWizards(); | ||
| } | ||
|
|
||
| private updateWizards() { | ||
| this.requestUpdate('workflow'); | ||
| this.updateComplete | ||
| .then(() => this.wizardUI.updateComplete) | ||
| .then(() => this.wizardUI.dialog?.updateComplete) | ||
| .then(() => this.wizardUI.dialog?.focus()); | ||
|
Comment on lines
+99
to
+102
Member
There was a problem hiding this comment. again, thank you for the clean up :) |
||
| } | ||
|
|
||
| connectedCallback() { | ||
| super.connectedCallback(); | ||
|
|
||
| this.host.addEventListener('wizard', this.onWizard.bind(this)); | ||
| this.host.addEventListener('oscd-edit-wizard-request', (e: Event) => | ||
| this.onWizardRequest(e as CustomEvent<EditWizardRequest>) | ||
| ); | ||
| this.host.addEventListener('oscd-create-wizard-request', (e: Event) => | ||
| this.onWizardRequest(e as CustomEvent<CreateWizardRequest>) | ||
| ); | ||
| this.host.addEventListener('oscd-close-wizard', () => this.onCloseWizard()); | ||
| this.host.addEventListener('editor-action', () => | ||
| this.wizardUI.requestUpdate() | ||
| ); | ||
| } | ||
|
|
||
| render(): TemplateResult { | ||
| return html` | ||
| <slot></slot> | ||
| <wizard-dialog .wizard=${this.workflow[0]?.() ?? []}></wizard-dialog> | ||
| `; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| interface WizardRequestBase { | ||
| subWizard?: boolean; | ||
| } | ||
| export interface EditWizardRequest extends WizardRequestBase { | ||
| element: Element; | ||
| } | ||
| export interface CreateWizardRequest extends WizardRequestBase { | ||
| parent: Element; | ||
| tagName: string; | ||
| } | ||
|
|
||
| type CreateWizardEvent = CustomEvent<CreateWizardRequest>; | ||
| type EditWizardEvent = CustomEvent<EditWizardRequest>; | ||
|
|
||
| export function newCreateWizardEvent( | ||
| parent: Element, | ||
| tagName: string, | ||
| subWizard?: boolean, | ||
| eventInitDict?: CustomEventInit<Partial<CreateWizardRequest>> | ||
| ): CreateWizardEvent { | ||
| return new CustomEvent<CreateWizardRequest>('oscd-create-wizard-request', { | ||
| bubbles: true, | ||
| composed: true, | ||
| ...eventInitDict, | ||
| detail: { | ||
| parent, | ||
| tagName, | ||
| subWizard, | ||
| ...eventInitDict?.detail, | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| export function newEditWizardEvent( | ||
| element: Element, | ||
| subWizard?: boolean, | ||
| eventInitDict?: CustomEventInit<Partial<EditWizardRequest>> | ||
| ): EditWizardEvent { | ||
| return new CustomEvent<EditWizardRequest>('oscd-edit-wizard-request', { | ||
| bubbles: true, | ||
| composed: true, | ||
| ...eventInitDict, | ||
| detail: { element, subWizard, ...eventInitDict?.detail }, | ||
| }); | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the small cleanups too :)