feat(templates/dotype-wizard): add cdc field in create wizard (#330)

* feat(templates/dotype-wizard): add cdc field in create wizard

* refactor(templates/dotype-wizards): better function name

* test(templates/dotype-wizards): add tests for CDC field handling

Author: JakobVogelsang

__snapshots__/DOType wizards.md

@@ -693,6 +693,13 @@
       pattern="([ -~]|[…]|[ -퟿]|[-�]|[𐀀\-􏿿])*"
     >
     </wizard-textfield>
+    <wizard-textfield
+      helper="[scl.cdc]"
+      label="cdc"
+      pattern="(SPS)|(DPS)|(INS)|(ENS)|(ACT)|(ACD)|(SEC)|(BCR)|(HST)|(VSS)|(MV)|(CMV)|(SAV)|(WYE)|(DEL)|(SEQ)|(HMV)|(HWYE)|(HDEL)|(SPC)|(DPC)|(INC)|(ENC)|(BSC)|(ISC)|(APC)|(BAC)|(SPG)|(ING)|(ENG)|(ORG)|(TSG)|(CUG)|(VSG)|(ASG)|(CURVE)|(CSG)|(DPL)|(LPL)|(CSD)|(CST)|(BTS)|(UTS)|(LTS)|(GTS)|(MTS)|(NTS)|(STS)|(CTS)|(OTS)|(VSD)"
+      required=""
+    >
+    </wizard-textfield>
   </div>
   <mwc-button
     dialogaction="close"
@@ -1025,7 +1032,7 @@
       dialoginitialfocus=""
       helper="[scl.name]"
       label="name"
-      pattern="[a-z][0-9,A-Z,a-z]*"
+      pattern="[a-z][0-9A-Za-z]*"
       required=""
     >
       >
@@ -1217,7 +1224,7 @@
       dialoginitialfocus=""
       helper="[scl.name]"
       label="name"
-      pattern="[a-z][0-9,A-Z,a-z]*"
+      pattern="[a-z][0-9A-Za-z]*"
       required=""
     >
       >

src/editors/templates/dotype-wizards.ts

@@ -12,7 +12,6 @@ import {
   isPublic,
   newActionEvent,
   newWizardEvent,
-  patterns,
   SCLTag,
   selector,
   Wizard,
@@ -34,6 +33,7 @@ import { SingleSelectedEvent } from '@material/mwc-list/mwc-list-foundation';
 import { ListItem } from '@material/mwc-list/mwc-list-item';
 import { List } from '@material/mwc-list';
 import { createDaWizard, editDAWizard } from '../../wizards/da.js';
+import { patterns } from '../../wizards/foundation/limits.js';
 
 function updateSDoAction(element: Element): WizardActor {
   return (inputs: WizardInput[]): EditorAction[] => {
@@ -144,7 +144,7 @@ function sDOWizard(options: WizardOptions): Wizard | undefined {
           .maybeValue=${name}
           helper="${translate('scl.name')}"
           required
-          pattern="${patterns.alphanumericFirstLowerCase}"
+          pattern="${patterns.tRestrName1stL}"
           dialogInitialFocus
         >
           ></wizard-textfield
@@ -191,6 +191,8 @@ function addPredefinedDOType(
     if (existId) return [];
 
     const desc = getValue(inputs.find(i => i.label === 'desc')!);
+    const cdc = getValue(inputs.find(i => i.label === 'cdc')!)!;
+
     const values = <Select>inputs.find(i => i.label === 'values');
     const selectedElement = values.selected
       ? templates.querySelector(`DOType[id="${values.selected.value}"]`)
@@ -200,6 +202,7 @@ function addPredefinedDOType(
       : parent.ownerDocument.createElement('DOType');
 
     element.setAttribute('id', id);
+    element.setAttribute('cdc', cdc);
     if (desc) element.setAttribute('desc', desc);
 
     const actions: Create[] = [];
@@ -221,6 +224,22 @@ function addPredefinedDOType(
   };
 }
 
+function onSelectTemplateDOType(e: Event, templates: Document): void {
+  const cdcUI = <Select>(
+    (<Select>e.target).parentElement!.querySelector(
+      'wizard-textfield[label="cdc"]'
+    )!
+  );
+
+  const doTypeId = (<Select>e.target).value;
+  const cdc =
+    templates.querySelector(`DOType[id="${doTypeId}"]`)?.getAttribute('cdc') ??
+    null;
+
+  if (cdc) cdcUI.value = cdc;
+  cdcUI.disabled = true;
+}
+
 export function createDOTypeWizard(
   parent: Element,
   templates: Document
@@ -240,6 +259,7 @@ export function createDOTypeWizard(
           icon="playlist_add_check"
           label="values"
           helper="${translate('dotype.wizard.enums')}"
+          @selected=${(e: Event) => onSelectTemplateDOType(e, templates)}
         >
           ${Array.from(templates.querySelectorAll('DOType')).map(
             datype =>
@@ -273,6 +293,12 @@ export function createDOTypeWizard(
           nullable
           pattern="${patterns.normalizedString}"
         ></wizard-textfield>`,
+        html`<wizard-textfield
+          label="cdc"
+          helper="${translate('scl.cdc')}"
+          required
+          pattern="${patterns.cdc}"
+        ></wizard-textfield>`,
       ],
     },
   ];

src/wizards/foundation/limits.ts

@@ -23,9 +23,14 @@ export const patterns = {
   alphanumericFirstUpperCase: '[A-Z][0-9,A-Z,a-z]*',
   asciName: '[A-Za-z][0-9,A-Z,a-z_]*',
   lnClass: '[A-Z]{4,4}',
-  restrName1stU: '[a-z][0-9A-Za-z]*',
+  tRestrName1stL: '[a-z][0-9A-Za-z]*',
   abstractDataAttributeName:
     '((T)|(Test)|(Check)|(SIUnit)|(Open)|(SBO)|(SBOw)|(Cancel)|[a-z][0-9A-Za-z]*)',
+  cdc:
+    '(SPS)|(DPS)|(INS)|(ENS)|(ACT)|(ACD)|(SEC)|(BCR)|(HST)|(VSS)|(MV)|(CMV)|(SAV)|' +
+    '(WYE)|(DEL)|(SEQ)|(HMV)|(HWYE)|(HDEL)|(SPC)|(DPC)|(INC)|(ENC)|(BSC)|(ISC)|(APC)|(BAC)|' +
+    '(SPG)|(ING)|(ENG)|(ORG)|(TSG)|(CUG)|(VSG)|(ASG)|(CURVE)|(CSG)|(DPL)|(LPL)|(CSD)|(CST)|' +
+    '(BTS)|(UTS)|(LTS)|(GTS)|(MTS)|(NTS)|(STS)|(CTS)|(OTS)|(VSD)',
 };
 
 export const maxLength = {

test/integration/editors/templates/dotype-wizarding.test.ts

@@ -38,6 +38,7 @@ describe('DOType wizards', () => {
   describe('defines a createDOTypeWizard', () => {
     let selector: Select;
     let idField: WizardTextField;
+    let cdcField: WizardTextField;
     let primayAction: HTMLElement;
     beforeEach(async () => {
       const button = <HTMLElement>(
@@ -54,6 +55,9 @@ describe('DOType wizards', () => {
       idField = <WizardTextField>(
         parent.wizardUI.dialog?.querySelector('wizard-textfield[label="id"]')
       );
+      cdcField = <WizardTextField>(
+        parent.wizardUI.dialog?.querySelector('wizard-textfield[label="cdc"]')
+      );
       primayAction = <HTMLElement>(
         parent.wizardUI.dialog?.querySelector(
           'mwc-button[slot="primaryAction"]'
@@ -67,13 +71,31 @@ describe('DOType wizards', () => {
     it('allows to add empty DOTypes to the project', async () => {
       expect(doc.querySelector('DOType[id="myGeneralDOType"]')).to.not.exist;
       idField.maybeValue = 'myGeneralDOType';
+      cdcField.maybeValue = 'SPS';
       await parent.requestUpdate();
       primayAction.click();
       await parent.updateComplete;
       expect(doc.querySelector('DOType[id="myGeneralDOType"]')).to.exist;
     });
+    it('allows to define CDC only for empty DOType creation', async () => {
+      await cdcField.updateComplete;
+      expect(cdcField.disabled).to.not.be.true;
+      selector.value = 'OpenSCD_ENS_Health';
+      await cdcField.requestUpdate();
+      expect(cdcField.disabled).to.be.true;
+    });
+    it('requires CDC definition for empty DOTypes', async () => {
+      expect(doc.querySelector('DOType[id="myGeneralDOType"]')).to.not.exist;
+      idField.maybeValue = 'myGeneralDOType';
+      cdcField.maybeValue = null;
+      await parent.requestUpdate();
+      primayAction.click();
+      await parent.updateComplete;
+      expect(doc.querySelector('DOType[id="myGeneralDOType"]')).to.not.exist;
+    });
     it('respects the sequence defined in the standard', async () => {
       idField.maybeValue = 'myGeneralDOType';
+      cdcField.maybeValue = 'SPS';
       await parent.requestUpdate();
       primayAction.click();
       await parent.updateComplete;