@oicl/openbridge-webcomponents-full-bundle 2.0.0-next.158 → 2.0.0-next.159

package/script/eslint-property-docs-rule.test.ts

@@ -72,12 +72,66 @@ describe('property-docs-in-class-jsdoc — reports', () => {
         {
           code: cls(
             ' * Thing.\n * @stable',
-            '  /**\n   * The value.\n   * @deprecated use other\n   */\n  @property({type: Number}) value = 0;'
+            '  /**\n   * The value.\n   * @see other\n   */\n  @property({type: Number}) value = 0;'
           ),
-          errors: [{messageId: 'manual'}],
+          errors: [
+            {
+              messageId: 'manual',
+              data: {name: 'value', reason: 'contains @see'},
+            },
+          ],
           output: null,
         },
+        {
+          // cem reads the default from a literal initializer, so a tag that
+          // disagrees with it is a contradiction to report, not data to keep.
+          code: cls(
+            ' * Thing.\n * @stable',
+            '  /**\n   * Size.\n   * @default 385\n   */\n  @property({type: Number}) size = 384;'
+          ),
+          errors: [
+            {
+              messageId: 'manual',
+              data: {
+                name: 'size',
+                reason: '@default differs from the initializer',
+              },
+            },
+          ],
+          output: null,
+        },
+      ],
+    });
+  });
+
+  it('does not report an inline doc the manifest can only read inline', () => {
+    tester.run('property-docs', propertyDocsRule, {
+      valid: [
+        // cem lifts a member @deprecated into the manifest; the class JSDoc
+        // has no tag for it, so the doc stays where it is.
+        cls(
+          ' * Thing.\n * @stable',
+          '  /**\n   * The value.\n   * @deprecated use other\n   */\n  @property({type: Number}) value = 0;'
+        ),
+        // Wherever @deprecated sits among the tags.
+        cls(
+          ' * Thing.\n * @stable',
+          '  /**\n   * The value.\n   * @see other\n   * @deprecated use other\n   */\n  @property({type: Number}) value = 0;'
+        ),
+        // A class without a JSDoc does not turn it back into a report.
+        "import {LitElement} from 'lit';\n@customElement('obc-x')\nexport class ObcX extends LitElement {\n  /** @deprecated use other */\n  @property({type: Number}) value = 0;\n}\n",
+        // cem reads `default` only from a literal initializer, so the tag is
+        // the manifest's only source here.
+        cls(
+          ' * Thing.\n * @stable',
+          '  /**\n   * Size.\n   * @default Size.normal\n   */\n  @property({type: String}) size = Size.normal;'
+        ),
+        cls(
+          ' * Thing.\n * @stable',
+          "  /**\n   * Size.\n   * @default 'normal'\n   */\n  @property({type: String}) size = Size.normal;"
+        ),
       ],
+      invalid: [],
     });
   });
 
@@ -152,33 +206,6 @@ describe('property-docs-in-class-jsdoc — reports', () => {
     });
   });
 
-  it('treats a mismatched @default as manual, not hoistable', () => {
-    tester.run('property-docs', propertyDocsRule, {
-      valid: [],
-      invalid: [
-        {
-          // The doc's @default text ('normal') doesn't match the field's
-          // actual initializer (Size.normal) — don't trust the doc's word
-          // for what the manifest should show; leave it for a human.
-          code: cls(
-            ' * Thing.\n * @stable',
-            "  /**\n   * Size.\n   * @default 'normal'\n   */\n  @property({type: String}) size = Size.normal;"
-          ),
-          errors: [
-            {
-              messageId: 'manual',
-              data: {
-                name: 'size',
-                reason: '@default differs from the initializer',
-              },
-            },
-          ],
-          output: null,
-        },
-      ],
-    });
-  });
-
   it('treats a class JSDoc containing @typedef as unusable for hoisting', () => {
     tester.run('property-docs', propertyDocsRule, {
       valid: [],
@@ -202,35 +229,6 @@ describe('property-docs-in-class-jsdoc — reports', () => {
     });
   });
 
-  it('treats a matching @default on a non-literal initializer as manual', () => {
-    tester.run('property-docs', propertyDocsRule, {
-      valid: [],
-      invalid: [
-        {
-          // The tag text matches the initializer verbatim, so it's not a
-          // *wrong* @default — but cem only reads `default` from a literal
-          // declaration, so dropping this tag would lose it from the
-          // manifest entirely (unlike `@default 384` over `= 384`, where
-          // cem reads the literal `384` itself once the tag is gone).
-          code: cls(
-            ' * Thing.\n * @stable',
-            '  /**\n   * Size.\n   * @default Size.normal\n   */\n  @property({type: String}) size = Size.normal;'
-          ),
-          errors: [
-            {
-              messageId: 'manual',
-              data: {
-                name: 'size',
-                reason: '@default on a non-literal initializer',
-              },
-            },
-          ],
-          output: null,
-        },
-      ],
-    });
-  });
-
   it('treats a description containing {@link} as manual, not hoistable', () => {
     tester.run('property-docs', propertyDocsRule, {
       valid: [],
@@ -326,9 +324,25 @@ describe('classifyFieldDoc', () => {
     expect(classifyFieldDoc(['Modes:', '- `a`: one', '- `b`: two']).ok).toBe(
       false
     );
-    expect(classifyFieldDoc(['Old.', '@deprecated use x']).ok).toBe(false);
+    expect(classifyFieldDoc(['Old.', '@see x'])).toEqual({
+      ok: false,
+      reason: 'contains @see',
+    });
     expect(classifyFieldDoc(['Para one.', '', 'Para two.']).ok).toBe(false);
   });
+  it('marks a doc the manifest can only read inline as one to keep', () => {
+    expect(classifyFieldDoc(['Old.', '@deprecated use x'])).toEqual({
+      ok: false,
+      reason: 'contains @deprecated',
+      keep: true,
+    });
+    // @deprecated wins over an earlier foreign tag.
+    expect(classifyFieldDoc(['Old.', '@see x', '@deprecated use x'])).toEqual({
+      ok: false,
+      reason: 'contains @deprecated',
+      keep: true,
+    });
+  });
   it('splits a same-line @availableWhen or @default off the description', () => {
     expect(classifyFieldDoc(['Desc. @availableWhen off==true'])).toEqual({
       ok: true,
@@ -347,6 +361,12 @@ describe('classifyFieldDoc', () => {
     ).toEqual({
       ok: false,
       reason: '@default differs from the initializer',
+      keep: true,
+    });
+    // A literal initializer is what cem reads, so the mismatch is reported.
+    expect(classifyFieldDoc(['Desc.', '@default 385'], '384', true)).toEqual({
+      ok: false,
+      reason: '@default differs from the initializer',
     });
     expect(classifyFieldDoc(['Desc.', '@default 384'], '384', true)).toEqual({
       ok: true,
@@ -363,6 +383,7 @@ describe('classifyFieldDoc', () => {
     ).toEqual({
       ok: false,
       reason: '@default on a non-literal initializer',
+      keep: true,
     });
     expect(classifyFieldDoc(['Desc.', '@default 384'], '384', true)).toEqual({
       ok: true,

package/src/automation/corner-line/corner-line.ts

@@ -11,7 +11,8 @@ export enum CornerLineDirection {
 }
 
 /**
- * @deprecated
+ * @deprecated The line components are deprecated and will be removed in future releases.
+ * Please use the `@oicl/connector-diagram` package instead.
  */
 @customElement('obc-corner-line')
 export class ObcCornerLine extends LitElement {

package/src/automation/direction-line/direction-line.ts

@@ -4,7 +4,8 @@ import {LineMedium, LineType, lineColor, lineWidth} from '../index.js';
 import {customElement} from '../../decorator.js';
 
 /**
- * @deprecated
+ * @deprecated The line components are deprecated and will be removed in future releases.
+ * Please use the `@oicl/connector-diagram` package instead.
  */
 @customElement('obc-direction-line')
 export class ObcDirectionLine extends LitElement {

package/src/automation/end-point-line/end-point-line.ts

@@ -10,7 +10,8 @@ export enum EndPointDirection {
 }
 
 /**
- * @deprecated
+ * @deprecated The line components are deprecated and will be removed in future releases.
+ * Please use the `@oicl/connector-diagram` package instead.
  */
 @customElement('obc-end-point-line')
 export class ObcEndPointLine extends LitElement {

package/src/automation/horizontal-line/horizontal-line.ts

@@ -4,7 +4,8 @@ import {LineMedium, lineColor, LineType, lineWidth} from '../index.js';
 import {customElement} from '../../decorator.js';
 
 /**
- * @deprecated
+ * @deprecated The line components are deprecated and will be removed in future releases.
+ * Please use the `@oicl/connector-diagram` package instead.
  */
 @customElement('obc-horizontal-line')
 export class ObcHorizontalLine extends LitElement {

package/src/automation/line-cross/line-cross.ts

@@ -4,7 +4,8 @@ import {LineMedium, LineType, lineColor, lineWidth} from '../index.js';
 import {customElement} from '../../decorator.js';
 
 /**
- * @deprecated
+ * @deprecated The line components are deprecated and will be removed in future releases.
+ * Please use the `@oicl/connector-diagram` package instead.
  */
 @customElement('obc-line-cross')
 export class ObcLineCross extends LitElement {

package/src/automation/line-overlap/line-overlap.ts

@@ -4,7 +4,8 @@ import {LineMedium, LineType, lineColor, lineWidth} from '../index.js';
 import {customElement} from '../../decorator.js';
 
 /**
- * @deprecated
+ * @deprecated The line components are deprecated and will be removed in future releases.
+ * Please use the `@oicl/connector-diagram` package instead.
  */
 @customElement('obc-line-overlap')
 export class ObcLineOverlap extends LitElement {

package/src/automation/three-way-line/three-way-line.ts

@@ -11,7 +11,8 @@ export enum ThreeWayLineDirection {
 }
 
 /**
- * @deprecated
+ * @deprecated The line components are deprecated and will be removed in future releases.
+ * Please use the `@oicl/connector-diagram` package instead.
  */
 @customElement('obc-three-way-line')
 export class ObcThreeWayLine extends LitElement {

package/src/automation/vertical-line/vertical-line.ts

@@ -7,7 +7,8 @@ import {customElement} from '../../decorator.js';
  * Vertical line component
  *
  * The vertical line is 24px * length + 1px. +1 px to make sure that connecting lines are overlapping, to hide the gap between them.
- * @deprecated
+ * @deprecated The line components are deprecated and will be removed in future releases.
+ * Please use the `@oicl/connector-diagram` package instead.
  */
 @customElement('obc-vertical-line')
 export class ObcVerticalLine extends LitElement {

package/src/components/command-menu/command-menu.ts

@@ -141,7 +141,6 @@ export class ObcCommandMenu extends LitElement {
             <obc-start-stop-switch
               @change=${this.onChange}
               .checked=${this.inCommand}
-              showCheckedStateIcon
               .size=${'large'}
             >
               <div slot="to-checked-action-label">

package/src/components/notification-badge-button/notification-badge-button.ts

@@ -64,7 +64,10 @@ import {customElement} from '../../decorator.js';
  *   Useful for visually separating the button from others or indicating a secondary action.
  * @slot - Main content slot for icon or text label.
  * @fires click - Fired when the button is clicked (if not disabled).
- * @deprecated
+ * @deprecated The notification-badge-button component is deprecated and will be removed in future releases.
+ * Use `obc-icon-button` instead; `openLeft`, `openRight` and `indent` have no
+ * equivalent, and its default slot takes the icon while text goes in the `label`
+ * slot behind `hasLabel`.
  */
 @customElement('obc-notification-badge-button')
 export class ObcNotificationBadgeButton extends LitElement {

package/src/components/start-stop-switch/start-stop-switch.stories.ts

@@ -16,8 +16,6 @@ const meta: Meta<ObcStartStopSwitch> = {
   tags: ['6.0'],
   component: 'obc-start-stop-switch',
   args: {
-    showUncheckedStateIcon: false,
-    showCheckedStateIcon: false,
     checked: false,
     variant: 'normal',
     size: 'regular',
@@ -61,8 +59,6 @@ const meta: Meta<ObcStartStopSwitch> = {
   render: (args) => {
     return html`<obc-start-stop-switch
       .checked=${args.checked}
-      .showUncheckedStateIcon=${args.showUncheckedStateIcon}
-      .showCheckedStateIcon=${args.showCheckedStateIcon}
       .variant=${args.variant}
       .size=${args.size}
       .disabled=${args.disabled}
@@ -321,10 +317,7 @@ export const CmdExample: Story = {
     checked: true,
   },
   render: (args) => {
-    return html`<obc-start-stop-switch
-      .checked=${args.checked}
-      showCheckedStateIcon
-    >
+    return html`<obc-start-stop-switch .checked=${args.checked}>
       <div slot="checked-state-icon">
         <obi-command-in></obi-command-in>
       </div>

package/src/components/start-stop-switch/start-stop-switch.ts

@@ -124,10 +124,6 @@ export class ObcStartStopSwitch extends LitElement {
    * - `running`: Green appearance indicating motor/process is running
    * - `loading`: Light blue appearance indicating a pending/loading state
    *
-   * If `true`, the content of the `checked-state-icon` slot will be displayed when checked.
-   */
-  @property({type: Boolean}) showUncheckedStateIcon = false;
-  /**
    * This only affects the visual style, not the switch position.
    *
    * Defaults to `'normal'`.
@@ -137,11 +133,6 @@ export class ObcStartStopSwitch extends LitElement {
 
   /**
    * The size of the switch.
-   *
-   * If `true`, the content of the `unchecked-state-icon` slot will be displayed when unchecked.
-   */
-  @property({type: Boolean}) showCheckedStateIcon = false;
-  /**
    * - `regular`: Standard size with 32px track height
    * - `large`: Larger size with 48px track height
    *

package/src/navigation-instruments/azimuth-thruster-labeled/azimuth-thruster-labeled.ts

@@ -33,7 +33,8 @@ export enum AzimuthThrusterLabeledSize {
  * @availableWhen autoAtThrustSetpointDeadband thrustSetpoint!=undefined && autoAtThrustSetpoint==true
  * @availableWhen thrustSetpointAtZeroDeadband thrustSetpoint!=undefined
  * @availableWhen thrustSetpointOverride thrustSetpoint!=undefined
- * @deprecated
+ * @deprecated The azimuth-thruster-labeled component is deprecated and will be removed in future releases.
+ * Please make a combined component by using <obc-azimuth-thruster> in combination with <obc-readout> instead.
  */
 @customElement('obc-azimuth-thruster-labeled')
 export class ObcAzimuthThrusterLabeled extends LitElement {

package/src/navigation-instruments/instrument-field/instrument-field.ts

@@ -59,7 +59,9 @@ export enum InstrumentFieldSize {
  *
  * @csspart label - The container for the tag and unit.
  * @csspart tag - The tag text element.
- * @deprecated
+ * @deprecated The instrument-field component is deprecated and will be removed in future releases.
+ * Please use the <obc-readout> component instead. See storybook for migration details.
+ * https://openbridge-next-storybook.web.app/?path=/docs/instruments-instrument-field-deprecated--docs
  */
 @customElement('obc-instrument-field')
 export class ObcInstrumentField extends LitElement {