@fusion.dev/helix-sandbox 0.0.0-dev

package/types/vue.d.ts

@@ -0,0 +1,134 @@
+import type {
+  HelixSandboxEditor,
+  HelixBeforeEditEvent,
+  HelixCaretEvent,
+  HelixEditEvent,
+} from "@fusion.dev/helix-sandbox";
+import type { HTMLAttributes, PublicProps, EmitFn, EmitsToProps } from "vue";
+
+/** This file was autogenerated by @wc-toolkit/vuejs-types */
+/**
+ * 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;
+};
+
+export type EventMap = {
+  [event: string]: Event;
+};
+
+// Vue's template type-checking reads props from $props and events from $emit.
+// See: https://vuejs.org/guide/extras/web-components.html#non-vue-web-components-and-typescript
+export type VueEmitsOptions<T extends EventMap> = {
+  [K in keyof T]: (event: T[K]) => void;
+};
+
+export type VueEmit<T extends EventMap> = EmitFn<VueEmitsOptions<T>>;
+
+// Helps Volar autocomplete "@event" by providing "onXxx" props.
+export type VueOnProps<T extends EventMap> = EmitsToProps<VueEmitsOptions<T>>;
+
+export type DefineCustomElement<
+  ElementType extends HTMLElement,
+  Props = {},
+  Events extends EventMap = {},
+> = new () => ElementType & {
+  /** @deprecated Do not use the $props property on a Custom Element ref; this is for template prop types only. */
+  $props: HTMLAttributes & Props & PublicProps & VueOnProps<Events>;
+
+  /** @deprecated Do not use the $emit property on a Custom Element ref; this is for template event types only. */
+  $emit: VueEmit<Events>;
+};
+
+/** `HelixSandboxEditor` component event */
+export type HelixSandboxEditorElementEvent<E = Event> = TypedEvent<
+  HelixSandboxEditor,
+  E
+>;
+/** `helix-before-edit` event type */
+export type HelixSandboxEditorHelixBeforeEditElementEvent =
+  HelixSandboxEditorElementEvent<HelixBeforeEditEvent>;
+/** `helix-caret` event type */
+export type HelixSandboxEditorHelixCaretElementEvent =
+  HelixSandboxEditorElementEvent<HelixCaretEvent>;
+/** `helix-edit` event type */
+export type HelixSandboxEditorHelixEditElementEvent =
+  HelixSandboxEditorElementEvent<HelixEditEvent>;
+
+export type HelixSandboxEditorVueProps = {
+  /** Accessible name for the editable region. */
+  "field-label"?: (HelixSandboxEditor["fieldLabel"]) | undefined;
+  /** Accessible name for the editable region. */
+  fieldLabel?: (HelixSandboxEditor["fieldLabel"]) | undefined;
+  /** The language of the source, which decides how it is highlighted. A name
+the editor does not read draws the source plain. */
+  language?: (HelixSandboxEditor["language"]) | undefined;
+  /** Which source this pane holds, echoed in every change. */
+  name?: (HelixSandboxEditor["name"]) | undefined;
+  /** Whether the text can be changed.
+
+`EditorState.readOnly` rather than removing the editor's focus or its
+keymap: a reader still needs to select the text, scroll it, and put a
+cursor in it to read a long line. What it stops is the typing. */
+  readonly?: (HelixSandboxEditor["readOnly"]) | undefined;
+  /** Whether the text can be changed.
+
+`EditorState.readOnly` rather than removing the editor's focus or its
+keymap: a reader still needs to select the text, scroll it, and put a
+cursor in it to read a long line. What it stops is the typing. */
+  readOnly?: (HelixSandboxEditor["readOnly"]) | undefined;
+  /** The source being edited. */
+  value?: (HelixSandboxEditor["value"]) | undefined;
+};
+
+export type HelixSandboxEditorVueEvents = {
+  /** Fired before the source is edited. Cancelable: refusing it takes the decision and nothing moves. */
+  "helix-before-edit": HelixSandboxEditorHelixBeforeEditElementEvent;
+  /** Fired when the cursor moves, with its line and column. */
+  "helix-caret": HelixSandboxEditorHelixCaretElementEvent;
+  /** Fired after the source was edited, with the new source. */
+  "helix-edit": HelixSandboxEditorHelixEditElementEvent;
+};
+
+export type CustomCssProperties = {};
+
+// Vue SFC template type-checking (GlobalComponents) for non-Vue custom elements.
+// Note: Some tooling expects this augmentation under "@vue/runtime-core", while
+// other docs/examples use "vue". We emit both for compatibility.
+export interface WcToolkitVueGlobalComponents {
+  /** CodeMirror, not a '<textarea>'. A textarea cannot highlight what it holds, number its lines, or say where the cursor is, and a status bar reading line and column has to ask something.  **On its own path.** This is '@fusion.dev/helix-sandbox/editor', and the package's root exports its class as a type only, because CodeMirror is most of what the package weighs over the wire. A sandbox with no editable pane pays for none, and neither does a site that registers its elements once.  'language' names the grammar by the name a file or a sandbox pane carries: 'css', 'html', 'js', 'jsx', 'mjs', 'sh', 'ts' or 'tsx'. A name the editor does not read draws the source plain, and the console says so once.  Each edit a reader makes is 'helix-before-edit' first, which you can cancel to refuse the edit, and 'helix-edit' once the source holds it, as 'helix-sandbox-source' sends them. A 'value' set from outside is the source the editor is given, and sends neither. **The editor is ':state(modified)' while its source differs from the source it was given**, the first 'value' or the last one set from outside, and 'reset()' puts that source back as an edit.  The view is built once and reconfigured, not rebuilt. Replacing it on every change would throw away the undo history, the scroll position, and the selection, which is most of what an editor is. */
+  "helix-sandbox-editor": DefineCustomElement<
+    HelixSandboxEditor,
+    HelixSandboxEditorVueProps,
+    HelixSandboxEditorVueEvents
+  >;
+}
+
+declare module "@vue/runtime-core" {
+  interface GlobalComponents extends WcToolkitVueGlobalComponents {}
+}
+
+declare module "@vue/runtime-dom" {
+  interface GlobalComponents extends WcToolkitVueGlobalComponents {}
+
+  // Needed for named slots on native elements when using Web Components.
+  // Vue templates otherwise reject: <span slot="icon" />
+  interface HTMLAttributes {
+    slot?: (string) | undefined;
+  }
+}
+
+declare module "vue" {
+  interface GlobalComponents extends WcToolkitVueGlobalComponents {}
+
+  // Some package managers (notably pnpm) may not make "@vue/runtime-dom" directly
+  // resolvable from the consuming project, so we also augment via "vue".
+  interface HTMLAttributes {
+    slot?: (string) | undefined;
+  }
+
+  interface CSSProperties extends CustomCssProperties {}
+}

package/types/words.d.ts

@@ -0,0 +1,22 @@
+// Generated by `helix-words-types` from this package manifest. Do not edit.
+//
+// `registerWords`, and the words each family lets you register with it, keyed
+// by the family tag. Import it from here, which types your calls:
+// `import { registerWords } from '@fusion.dev/helix-sandbox/words'`. With it imported
+// from elsewhere, `import type {} from '@fusion.dev/helix-sandbox/words'` types them.
+import type { Message, MessageTable } from '@fusion.dev/helix-core'
+
+export * from '@fusion.dev/helix-core/words'
+
+declare module '@fusion.dev/helix-core' {
+  interface HelixWords {
+    'helix-sandbox-editor': {
+      /**
+       * Accessible name for the editable region.
+       *
+       * English: `Example source`
+       */
+      fieldLabel: Message
+    }
+  }
+}