@xmesh/system-design 0.0.3 → 0.0.5

package/dist/react/XmArtifact.d.ts

@@ -0,0 +1,113 @@
+import React from "react";
+import { XmArtifact as XmArtifactElement } from "../lit/components/artifact/index.js";
+
+/**
+ * A generic type for strongly typing custom events with their targets
+ * @template T - The type of the event target (extends EventTarget)
+ * @template D - The type of the detail payload for the custom event
+ */
+type TypedEvent<T extends EventTarget, E = Event> = E & {
+  target: T;
+};
+/** `XmArtifact` component event */
+export type XmArtifactElementEvent<E = Event> = TypedEvent<
+  XmArtifactElement,
+  E
+>;
+
+export type { XmArtifactElement };
+
+export interface XmArtifactProps extends Pick<
+  React.AllHTMLAttributes<HTMLElement>,
+  | "children"
+  | "dir"
+  | "hidden"
+  | "id"
+  | "lang"
+  | "slot"
+  | "style"
+  | "title"
+  | "translate"
+  | "onClick"
+  | "onFocus"
+  | "onBlur"
+> {
+  /** undefined */
+  showRefresh?: boolean;
+
+  /** undefined */
+  showClose?: boolean;
+
+  /** undefined */
+  title?: XmArtifactElement["title"];
+
+  /** undefined */
+  subCsv?: XmArtifactElement["subCsv"];
+
+  /** undefined */
+  view?: XmArtifactElement["view"];
+
+  /** A space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method `Document.getElementsByClassName()`. */
+  className?: string;
+
+  /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */
+  exportparts?: string;
+
+  /** Used for labels to link them with their inputs (using input id). */
+  htmlFor?: string;
+
+  /** Used to help React identify which items have changed, are added, or are removed within a list. */
+  key?: number | string;
+
+  /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
+  part?: string;
+
+  /** A mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. */
+  ref?: React.Ref<XmArtifactElement>;
+
+  /** Allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the `Tab` key, hence the name) and determine their relative ordering for sequential focus navigation. */
+  tabIndex?: number;
+
+  /** Fired when the element requests to close. */
+  onClose?: (event: XmArtifactElementEvent) => void;
+
+  /** Fired when a refresh is requested. */
+  onRefresh?: (event: XmArtifactElementEvent) => void;
+
+  /** Fired when the active view changes. */
+  onViewChange?: (event: XmArtifactElementEvent) => void;
+}
+
+/**
+ *
+ *
+ * ## Attributes & Properties
+ *
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ *
+ * - `title`: undefined
+ * - `sub-csv`/`subCsv`: undefined
+ * - `view`: undefined
+ * - `show-refresh`/`showRefresh`: undefined
+ * - `show-close`/`showClose`: undefined
+ * - `sub`: undefined (property only)
+ *
+ * ## Events
+ *
+ * Events that will be emitted by the component.
+ *
+ * - `close`: Fired when the element requests to close.
+ * - `refresh`: Fired when a refresh is requested.
+ * - `view-change`: Fired when the active view changes.
+ *
+ * ## Methods
+ *
+ * Methods that can be called to access component functionality.
+ *
+ * - `setBodies(preview: ChildNode[], code: ChildNode[]) => void`: Imperatively set the preview/code body nodes from a host. Replaces any
+ * authored or previously-set bodies. Used by <xm-chat-shell> to hand the
+ * panel its slot content; the chat shell can't author them as direct
+ * children of the lit-rendered <xm-artifact> tag without the snapshot
+ * timing race that this method sidesteps.
+ */
+export const XmArtifact: React.ForwardRefExoticComponent<XmArtifactProps>;

package/dist/react/XmArtifact.js

@@ -0,0 +1,45 @@
+import React, { forwardRef, useRef } from "react";
+import "../lit/components/artifact/index.js";
+import { useEventListener, createForwardedRefHandler } from "./react-utils.js";
+
+export const XmArtifact = forwardRef((props, forwardedRef) => {
+  const ref = useRef(null);
+  const {
+    showRefresh,
+    showClose,
+    title,
+    subCsv,
+    view,
+    className,
+    exportparts,
+    htmlFor,
+    part,
+    tabIndex,
+    ...restProps
+  } = props;
+
+  /** Event listeners - run once */
+  useEventListener(ref, "close", props.onClose);
+  useEventListener(ref, "refresh", props.onRefresh);
+  useEventListener(ref, "view-change", props.onViewChange);
+
+  return React.createElement(
+    "xm-artifact",
+    {
+      ref: createForwardedRefHandler(ref, forwardedRef),
+      ...restProps,
+      title: title,
+      "sub-csv": subCsv ?? props["sub-csv"],
+      view: view,
+      class: className,
+      exportparts: exportparts,
+      for: htmlFor ?? props["for"],
+      part: part,
+      tabindex: tabIndex ?? props["tabindex"],
+      "show-refresh": showRefresh ? true : undefined,
+      "show-close": showClose ? true : undefined,
+      style: { ...props.style },
+    },
+    props.children,
+  );
+});

package/dist/react/XmArtifactChip.d.ts

@@ -0,0 +1,56 @@
+import React from "react";
+import { XmArtifactChip as XmArtifactChipElement } from "../lit/components/bubble/index.js";
+
+export type { XmArtifactChipElement };
+
+export interface XmArtifactChipProps extends Pick<
+  React.AllHTMLAttributes<HTMLElement>,
+  | "children"
+  | "dir"
+  | "hidden"
+  | "id"
+  | "lang"
+  | "slot"
+  | "style"
+  | "title"
+  | "translate"
+  | "onClick"
+  | "onFocus"
+  | "onBlur"
+> {
+  /** undefined */
+  download?: boolean;
+
+  /** A space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method `Document.getElementsByClassName()`. */
+  className?: string;
+
+  /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */
+  exportparts?: string;
+
+  /** Used for labels to link them with their inputs (using input id). */
+  htmlFor?: string;
+
+  /** Used to help React identify which items have changed, are added, or are removed within a list. */
+  key?: number | string;
+
+  /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
+  part?: string;
+
+  /** A mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. */
+  ref?: React.Ref<XmArtifactChipElement>;
+
+  /** Allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the `Tab` key, hence the name) and determine their relative ordering for sequential focus navigation. */
+  tabIndex?: number;
+}
+
+/**
+ *
+ *
+ * ## Attributes & Properties
+ *
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ *
+ * - `download`: undefined
+ * - `artifact`: undefined (property only)
+ */
+export const XmArtifactChip: React.ForwardRefExoticComponent<XmArtifactChipProps>;

package/dist/react/XmArtifactChip.js

@@ -0,0 +1,32 @@
+import React, { forwardRef, useRef } from "react";
+import "../lit/components/bubble/index.js";
+import { createForwardedRefHandler } from "./react-utils.js";
+
+export const XmArtifactChip = forwardRef((props, forwardedRef) => {
+  const ref = useRef(null);
+  const {
+    download,
+    className,
+    exportparts,
+    htmlFor,
+    part,
+    tabIndex,
+    ...restProps
+  } = props;
+
+  return React.createElement(
+    "xm-artifact-chip",
+    {
+      ref: createForwardedRefHandler(ref, forwardedRef),
+      ...restProps,
+      class: className,
+      exportparts: exportparts,
+      for: htmlFor ?? props["for"],
+      part: part,
+      tabindex: tabIndex ?? props["tabindex"],
+      download: download ? true : undefined,
+      style: { ...props.style },
+    },
+    props.children,
+  );
+});

package/dist/react/XmAutocomplete.d.ts

@@ -0,0 +1,153 @@
+import React from "react";
+import {
+  XmAutocomplete as XmAutocompleteElement,
+  CustomEvent,
+} from "../lit/components/autocomplete/index.js";
+
+/**
+ * A generic type for strongly typing custom events with their targets
+ * @template T - The type of the event target (extends EventTarget)
+ * @template D - The type of the detail payload for the custom event
+ */
+type TypedEvent<T extends EventTarget, E = Event> = E & {
+  target: T;
+};
+/** `XmAutocomplete` component event */
+export type XmAutocompleteElementEvent<E = Event> = TypedEvent<
+  XmAutocompleteElement,
+  E
+>;
+
+export type { XmAutocompleteElement, CustomEvent };
+
+export interface XmAutocompleteProps extends Pick<
+  React.AllHTMLAttributes<HTMLElement>,
+  | "children"
+  | "dir"
+  | "hidden"
+  | "id"
+  | "lang"
+  | "slot"
+  | "style"
+  | "title"
+  | "translate"
+  | "onClick"
+  | "onFocus"
+  | "onBlur"
+> {
+  /** undefined */
+  required?: boolean;
+
+  /** undefined */
+  disabled?: boolean;
+
+  /** undefined */
+  readOnly?: boolean;
+
+  /** undefined */
+  loading?: boolean;
+
+  /** INITIAL checked for toggle subclasses; mapped from attribute `checked`. */
+  initialChecked?: boolean;
+
+  /** Native placeholder shown when the query is empty. */
+  placeholder?: XmAutocompleteElement["placeholder"];
+
+  /** undefined */
+  label?: XmAutocompleteElement["label"];
+
+  /** undefined */
+  helper?: XmAutocompleteElement["helper"];
+
+  /** Severity copy. Non-empty ⇒ the field is in error (icon + copy, never color). */
+  error?: XmAutocompleteElement["error"];
+
+  /** undefined */
+  size?: XmAutocompleteElement["size"];
+
+  /** Form-control name — mirrors native <input name>. */
+  name?: XmAutocompleteElement["name"];
+
+  /** INITIAL value (uncontrolled-first, AD-6): the `value` attribute seeds the
+live state once, then never overrides user input. Mapped from attribute
+`value` so authors write `<xm-text-field value="…">`. */
+  initialValue?: XmAutocompleteElement["initialValue"];
+
+  /** A space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method `Document.getElementsByClassName()`. */
+  className?: string;
+
+  /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */
+  exportparts?: string;
+
+  /** Used for labels to link them with their inputs (using input id). */
+  htmlFor?: string;
+
+  /** Used to help React identify which items have changed, are added, or are removed within a list. */
+  key?: number | string;
+
+  /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
+  part?: string;
+
+  /** A mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. */
+  ref?: React.Ref<XmAutocompleteElement>;
+
+  /** Allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the `Tab` key, hence the name) and determine their relative ordering for sequential focus navigation. */
+  tabIndex?: number;
+
+  /** Shared option model — `{ label, value, disabled? }` (AD-8a). */
+  options?: XmAutocompleteElement["options"];
+
+  /** Typed primitive read for consumers; the inherited string `value` stays in
+sync for xm-form / ElementInternals. */
+  selectedValue?: XmAutocompleteElement["selectedValue"];
+
+  /** Fired on commit with the new value in `detail`. */
+  onChange?: (event: XmAutocompleteElementEvent) => void;
+
+  /** Fired on each edit with the current value in `detail`. */
+  onInput?: (event: XmAutocompleteElementEvent) => void;
+}
+
+/**
+ *
+ *
+ * ## Attributes & Properties
+ *
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ *
+ * - `placeholder`: Native placeholder shown when the query is empty.
+ * - `label`: undefined
+ * - `helper`: undefined
+ * - `error`: Severity copy. Non-empty ⇒ the field is in error (icon + copy, never color).
+ * - `size`: undefined
+ * - `required`: undefined
+ * - `disabled`: undefined
+ * - `readonly`/`readOnly`: undefined
+ * - `loading`: undefined
+ * - `name`: Form-control name — mirrors native <input name>.
+ * - `value`/`initialValue`: INITIAL value (uncontrolled-first, AD-6): the `value` attribute seeds the
+ * live state once, then never overrides user input. Mapped from attribute
+ * `value` so authors write `<xm-text-field value="…">`.
+ * - `checked`/`initialChecked`: INITIAL checked for toggle subclasses; mapped from attribute `checked`.
+ * - `options`: Shared option model — `{ label, value, disabled? }` (AD-8a). (property only)
+ * - `selectedValue`: Typed primitive read for consumers; the inherited string `value` stays in
+ * sync for xm-form / ElementInternals. (property only) (readonly)
+ * - `readonly`: undefined (property only)
+ * - `value`: Programmatic reset support — setting `value` after first paint updates live state. (property only)
+ * - `checked`: Public read contract for toggle subclasses (AD-6a). (property only)
+ *
+ * ## Events
+ *
+ * Events that will be emitted by the component.
+ *
+ * - `change`: Fired on commit with the new value in `detail`.
+ * - `input`: Fired on each edit with the current value in `detail`.
+ *
+ * ## Methods
+ *
+ * Methods that can be called to access component functionality.
+ *
+ * - `setFormDisabled(disabled: boolean) => void`: Down-propagation hook: xm-form (Story 2.10) sets this; it OR's with the
+ * field's own disabled and can never re-enable a self-disabled field.
+ */
+export const XmAutocomplete: React.ForwardRefExoticComponent<XmAutocompleteProps>;

package/dist/react/XmAutocomplete.js

@@ -0,0 +1,68 @@
+import React, { forwardRef, useRef } from "react";
+import "../lit/components/autocomplete/index.js";
+import {
+  useEventListener,
+  useProperties,
+  createForwardedRefHandler,
+} from "./react-utils.js";
+
+export const XmAutocomplete = forwardRef((props, forwardedRef) => {
+  const ref = useRef(null);
+  const {
+    required,
+    disabled,
+    readOnly,
+    loading,
+    initialChecked,
+    placeholder,
+    label,
+    helper,
+    error,
+    size,
+    name,
+    initialValue,
+    className,
+    exportparts,
+    htmlFor,
+    part,
+    tabIndex,
+    options,
+    selectedValue,
+    ...restProps
+  } = props;
+
+  /** Event listeners - run once */
+  useEventListener(ref, "change", props.onChange);
+  useEventListener(ref, "input", props.onInput);
+
+  /** Properties - run whenever a property has changed */
+  useProperties(ref, "options", options);
+  useProperties(ref, "selectedValue", selectedValue);
+
+  return React.createElement(
+    "xm-autocomplete",
+    {
+      ref: createForwardedRefHandler(ref, forwardedRef),
+      ...restProps,
+      placeholder: placeholder,
+      label: label,
+      helper: helper,
+      error: error,
+      size: size,
+      name: name,
+      value: initialValue ?? props["value"],
+      class: className,
+      exportparts: exportparts,
+      for: htmlFor ?? props["for"],
+      part: part,
+      tabindex: tabIndex ?? props["tabindex"],
+      required: required ? true : undefined,
+      disabled: disabled ? true : undefined,
+      readonly: readOnly ? true : undefined,
+      loading: loading ? true : undefined,
+      checked: initialChecked ? true : undefined,
+      style: { ...props.style },
+    },
+    props.children,
+  );
+});

package/dist/react/XmAvatar.d.ts

@@ -0,0 +1,71 @@
+import React from "react";
+import { XmAvatar as XmAvatarElement } from "../lit/components/avatar/index.js";
+
+export type { XmAvatarElement };
+
+export interface XmAvatarProps extends Pick<
+  React.AllHTMLAttributes<HTMLElement>,
+  | "children"
+  | "dir"
+  | "hidden"
+  | "id"
+  | "lang"
+  | "slot"
+  | "style"
+  | "title"
+  | "translate"
+  | "onClick"
+  | "onFocus"
+  | "onBlur"
+> {
+  /** undefined */
+  title?: XmAvatarElement["title"];
+
+  /** undefined */
+  name?: XmAvatarElement["name"];
+
+  /** undefined */
+  initials?: XmAvatarElement["initials"];
+
+  /** undefined */
+  src?: XmAvatarElement["src"];
+
+  /** undefined */
+  size?: XmAvatarElement["size"];
+
+  /** A space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method `Document.getElementsByClassName()`. */
+  className?: string;
+
+  /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */
+  exportparts?: string;
+
+  /** Used for labels to link them with their inputs (using input id). */
+  htmlFor?: string;
+
+  /** Used to help React identify which items have changed, are added, or are removed within a list. */
+  key?: number | string;
+
+  /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
+  part?: string;
+
+  /** A mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. */
+  ref?: React.Ref<XmAvatarElement>;
+
+  /** Allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the `Tab` key, hence the name) and determine their relative ordering for sequential focus navigation. */
+  tabIndex?: number;
+}
+
+/**
+ *
+ *
+ * ## Attributes & Properties
+ *
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ *
+ * - `title`: undefined
+ * - `name`: undefined
+ * - `initials`: undefined
+ * - `src`: undefined
+ * - `size`: undefined
+ */
+export const XmAvatar: React.ForwardRefExoticComponent<XmAvatarProps>;

package/dist/react/XmAvatar.js

@@ -0,0 +1,40 @@
+import React, { forwardRef, useRef } from "react";
+import "../lit/components/avatar/index.js";
+import { createForwardedRefHandler } from "./react-utils.js";
+
+export const XmAvatar = forwardRef((props, forwardedRef) => {
+  const ref = useRef(null);
+  const {
+    title,
+    name,
+    initials,
+    src,
+    size,
+    className,
+    exportparts,
+    htmlFor,
+    part,
+    tabIndex,
+    ...restProps
+  } = props;
+
+  return React.createElement(
+    "xm-avatar",
+    {
+      ref: createForwardedRefHandler(ref, forwardedRef),
+      ...restProps,
+      title: title,
+      name: name,
+      initials: initials,
+      src: src,
+      size: size,
+      class: className,
+      exportparts: exportparts,
+      for: htmlFor ?? props["for"],
+      part: part,
+      tabindex: tabIndex ?? props["tabindex"],
+      style: { ...props.style },
+    },
+    props.children,
+  );
+});

package/dist/react/XmAvatarGroup.d.ts

@@ -0,0 +1,59 @@
+import React from "react";
+import { XmAvatarGroup as XmAvatarGroupElement } from "../lit/components/avatar-group/index.js";
+
+export type { XmAvatarGroupElement };
+
+export interface XmAvatarGroupProps extends Pick<
+  React.AllHTMLAttributes<HTMLElement>,
+  | "children"
+  | "dir"
+  | "hidden"
+  | "id"
+  | "lang"
+  | "slot"
+  | "style"
+  | "title"
+  | "translate"
+  | "onClick"
+  | "onFocus"
+  | "onBlur"
+> {
+  /** undefined */
+  max?: XmAvatarGroupElement["max"];
+
+  /** undefined */
+  size?: XmAvatarGroupElement["size"];
+
+  /** A space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method `Document.getElementsByClassName()`. */
+  className?: string;
+
+  /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */
+  exportparts?: string;
+
+  /** Used for labels to link them with their inputs (using input id). */
+  htmlFor?: string;
+
+  /** Used to help React identify which items have changed, are added, or are removed within a list. */
+  key?: number | string;
+
+  /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
+  part?: string;
+
+  /** A mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. */
+  ref?: React.Ref<XmAvatarGroupElement>;
+
+  /** Allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the `Tab` key, hence the name) and determine their relative ordering for sequential focus navigation. */
+  tabIndex?: number;
+}
+
+/**
+ *
+ *
+ * ## Attributes & Properties
+ *
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ *
+ * - `max`: undefined
+ * - `size`: undefined
+ */
+export const XmAvatarGroup: React.ForwardRefExoticComponent<XmAvatarGroupProps>;

package/dist/react/XmAvatarGroup.js

@@ -0,0 +1,34 @@
+import React, { forwardRef, useRef } from "react";
+import "../lit/components/avatar-group/index.js";
+import { createForwardedRefHandler } from "./react-utils.js";
+
+export const XmAvatarGroup = forwardRef((props, forwardedRef) => {
+  const ref = useRef(null);
+  const {
+    max,
+    size,
+    className,
+    exportparts,
+    htmlFor,
+    part,
+    tabIndex,
+    ...restProps
+  } = props;
+
+  return React.createElement(
+    "xm-avatar-group",
+    {
+      ref: createForwardedRefHandler(ref, forwardedRef),
+      ...restProps,
+      max: max,
+      size: size,
+      class: className,
+      exportparts: exportparts,
+      for: htmlFor ?? props["for"],
+      part: part,
+      tabindex: tabIndex ?? props["tabindex"],
+      style: { ...props.style },
+    },
+    props.children,
+  );
+});