@threadlabs/looma 0.28.22 → 0.29.1

package/vue/editor/LoomaEditor.d.ts

@@ -2,11 +2,13 @@ import "../../components/ui-editor-surface/ui-editor-surface.css";
 import "./looma-editor.css";
 import { type AnyExtension, type Editor, type JSONContent } from "@tiptap/core";
 import { type PropType, type VNode } from "vue";
-import { type LoomaSlashCommand, type LoomaMentionItem, type LoomaMentionProvider, type LoomaCodeLanguages } from "@threadlabs/looma/editor";
-import { type LoomaImageActivationDetail, type LoomaImageAttributeResolver, type LoomaImageSourceResolver, type LoomaImageRenditionErrorDetail } from "../../editor/image-delivery.js";
-import { type LoomaImageUploader } from "../../editor/image-uploads.js";
-import { type LoomaLinkResolve, type LoomaLinkSearch } from "../../editor/link-editing.js";
-export type { LoomaImageUploader, LoomaImageUploadResult } from "../../editor/image-uploads.js";
+import { type LoomaSlashCommand, type LoomaMentionItem, type LoomaCodeLanguages } from "@threadlabs/looma/editor";
+import { type LoomaImageActivationDetail, type LoomaImageAttributeResolver, type LoomaImageDescriptor, type LoomaImageSourceResolver, type LoomaImageRenditionErrorDetail } from "../../editor/image-delivery.js";
+import { type LoomaImageUploadDetail } from "../../editor/image-uploads.js";
+import { type LoomaResponder } from "../../editor/requests.js";
+import { type LoomaLinkTarget } from "../../editor/link-editing.js";
+export type { LoomaImageUploadDetail } from "../../editor/image-uploads.js";
+export type { LoomaRequestInit, LoomaResponder } from "../../editor/requests.js";
 /**
  * Chooses whether formatting controls follow a selection, occupy persistent
  * editor chrome, or open from an app-owned button (`popover`, with a text-only
@@ -42,13 +44,63 @@ export interface LoomaEditorSelectionActionDetail {
     before: string;
     after: string;
 }
+export type { LoomaLinkTarget } from "../../editor/link-editing.js";
+/** The `slash-commands` request's detail: this editor's default commands. */
+export interface LoomaSlashCommandsDetail {
+    defaults: LoomaSlashCommand[];
+}
+/** The `link-search` request's detail: what the author typed in the link field. */
+export interface LoomaLinkSearchDetail {
+    query: string;
+}
+/** The `link-resolve` request's detail: a saved link's `href`. */
+export interface LoomaLinkResolveDetail {
+    href: string;
+}
+/** The `mention-query` request's detail: what the author typed after `@`, and how many results show. */
+export interface LoomaMentionQueryDetail {
+    query: string;
+    limit: number;
+}
+/**
+ * Answers `extensions` with Tiptap extensions added after Looma's.
+ * @lifecycle The editor asks when it mounts and again when a responder first appears, then rebuilds
+ * with the answer and keeps its document.
+ */
+export type LoomaEditorExtensions = LoomaResponder<null, AnyExtension[]>;
+/**
+ * Answers `slash-commands` with the commands the slash menu offers: the defaults, changed or
+ * extended. `null` keeps the defaults; an empty array offers none.
+ * @ownership The host owns its command objects and mutations; Looma asks again with fresh defaults
+ * when the prop changes or image uploads become available.
+ */
+export type LoomaEditorSlashCommands = LoomaResponder<LoomaSlashCommandsDetail, LoomaSlashCommand[]>;
+/**
+ * Answers `link-search` with host records for a link, without teaching the editor how they are stored.
+ * @ownership The host checks access and returns durable, openable `href` values.
+ * @failure A rejection leaves the document untouched and shows a retryable search error.
+ */
+export type LoomaLinkSearch = LoomaResponder<LoomaLinkSearchDetail, LoomaLinkTarget[]>;
+/**
+ * Answers `link-resolve` with a saved link's current record, so a renamed record shows its new label.
+ * @ownership The host resolves identity and access; Looma keeps the saved href as is.
+ * @failure A rejection or `null` leaves the original href visible and editable.
+ */
+export type LoomaLinkResolve = LoomaResponder<LoomaLinkResolveDetail, LoomaLinkTarget>;
+/**
+ * Answers `mention-query` with people to suggest after `@`; `null` falls back to `mentionItems`.
+ * @ownership The host owns directory access; Looma filters the answer and clamps it to `limit`.
+ * @failure A rejection shows an empty menu.
+ */
+export type LoomaMentionQuery = LoomaResponder<LoomaMentionQueryDetail, LoomaMentionItem[]>;
 /**
- * Replace the slash inventory, or return retained defaults plus host commands.
- * @ownership The host owns its command objects and mutations; Looma supplies
- * fresh defaults and invokes this factory when the inventory prop changes.
+ * Answers `image-upload` with the image to insert for a pasted, dropped, or chosen file, or `null`
+ * to insert nothing. `progress(loaded, total)` drives the editor's progress status, and `signal`
+ * aborts when the author cancels.
+ * @ownership The application owns the upload and the returned `src`; Looma owns inserting it.
+ * @failure A rejection leaves the document unchanged and emits `uploadError`.
  */
-export type LoomaEditorSlashCommands = LoomaSlashCommand[] | ((defaults: LoomaSlashCommand[]) => LoomaSlashCommand[]);
-export type { LoomaLinkResolve, LoomaLinkSearch, LoomaLinkTarget } from "../../editor/link-editing.js";
+export type LoomaImageUploader = LoomaResponder<LoomaImageUploadDetail, LoomaImageDescriptor>;
 /**
  * Turnkey Vue editor that composes Looma's framework-neutral Tiptap extensions
  * with declarative menus, image delivery, and table interaction chrome.
@@ -95,13 +147,14 @@ export declare const LoomaEditor: import("vue").DefineComponent<import("vue").Ex
         type: StringConstructor;
         default: string;
     };
+    /** Answers `extensions`: the application's Tiptap extensions, added after Looma's. */
     extensions: {
-        type: PropType<AnyExtension[]>;
-        default: () => never[];
+        type: PropType<LoomaEditorExtensions | undefined>;
+        default: undefined;
     };
-    /** One inventory for the existing slash extension; an empty array intentionally supplies no commands. */
+    /** Answers `slash-commands`: the slash menu's commands, given the defaults. */
     slashCommands: {
-        type: PropType<LoomaEditorSlashCommands>;
+        type: PropType<LoomaEditorSlashCommands | undefined>;
         default: undefined;
     };
     /** Override the lazy built-in catalog with application-owned code grammars. An empty object disables highlighting. */
@@ -113,8 +166,9 @@ export declare const LoomaEditor: import("vue").DefineComponent<import("vue").Ex
         type: PropType<LoomaMentionItem[]>;
         default: () => never[];
     };
-    mentionProvider: {
-        type: PropType<LoomaMentionProvider | undefined>;
+    /** Answers `mention-query`: people to suggest for what the author typed after `@`. */
+    mentionQuery: {
+        type: PropType<LoomaMentionQuery | undefined>;
         default: undefined;
     };
     mentionLimit: {
@@ -126,7 +180,7 @@ export declare const LoomaEditor: import("vue").DefineComponent<import("vue").Ex
         type: StringConstructor;
         default: string;
     };
-    /** Host-owned search and identity lookup for links to application records. */
+    /** Answers `link-search` and `link-resolve`: host search and identity lookup for links to application records. */
     linkSearch: {
         type: PropType<LoomaLinkSearch | undefined>;
         default: undefined;
@@ -139,7 +193,8 @@ export declare const LoomaEditor: import("vue").DefineComponent<import("vue").Ex
         type: StringConstructor;
         default: string;
     };
-    uploadImage: {
+    /** Answers `image-upload`: uploads a pasted, dropped, or chosen image and returns the image to insert. */
+    imageUpload: {
         type: PropType<LoomaImageUploader | undefined>;
         default: undefined;
     };
@@ -237,13 +292,14 @@ export declare const LoomaEditor: import("vue").DefineComponent<import("vue").Ex
         type: StringConstructor;
         default: string;
     };
+    /** Answers `extensions`: the application's Tiptap extensions, added after Looma's. */
     extensions: {
-        type: PropType<AnyExtension[]>;
-        default: () => never[];
+        type: PropType<LoomaEditorExtensions | undefined>;
+        default: undefined;
     };
-    /** One inventory for the existing slash extension; an empty array intentionally supplies no commands. */
+    /** Answers `slash-commands`: the slash menu's commands, given the defaults. */
     slashCommands: {
-        type: PropType<LoomaEditorSlashCommands>;
+        type: PropType<LoomaEditorSlashCommands | undefined>;
         default: undefined;
     };
     /** Override the lazy built-in catalog with application-owned code grammars. An empty object disables highlighting. */
@@ -255,8 +311,9 @@ export declare const LoomaEditor: import("vue").DefineComponent<import("vue").Ex
         type: PropType<LoomaMentionItem[]>;
         default: () => never[];
     };
-    mentionProvider: {
-        type: PropType<LoomaMentionProvider | undefined>;
+    /** Answers `mention-query`: people to suggest for what the author typed after `@`. */
+    mentionQuery: {
+        type: PropType<LoomaMentionQuery | undefined>;
         default: undefined;
     };
     mentionLimit: {
@@ -268,7 +325,7 @@ export declare const LoomaEditor: import("vue").DefineComponent<import("vue").Ex
         type: StringConstructor;
         default: string;
     };
-    /** Host-owned search and identity lookup for links to application records. */
+    /** Answers `link-search` and `link-resolve`: host search and identity lookup for links to application records. */
     linkSearch: {
         type: PropType<LoomaLinkSearch | undefined>;
         default: undefined;
@@ -281,7 +338,8 @@ export declare const LoomaEditor: import("vue").DefineComponent<import("vue").Ex
         type: StringConstructor;
         default: string;
     };
-    uploadImage: {
+    /** Answers `image-upload`: uploads a pasted, dropped, or chosen image and returns the image to insert. */
+    imageUpload: {
         type: PropType<LoomaImageUploader | undefined>;
         default: undefined;
     };
@@ -344,7 +402,7 @@ export declare const LoomaEditor: import("vue").DefineComponent<import("vue").Ex
     onImageActivate?: ((_detail: LoomaImageActivationDetail) => any) | undefined;
     onImageRenditionError?: ((_detail: LoomaImageRenditionErrorDetail) => any) | undefined;
 }>, {
-    extensions: AnyExtension[];
+    extensions: LoomaEditorExtensions | undefined;
     editable: boolean;
     label: string;
     placeholder: string;
@@ -352,15 +410,15 @@ export declare const LoomaEditor: import("vue").DefineComponent<import("vue").Ex
     disableHighlight: boolean;
     codeLanguages: Readonly<Record<string, import("highlight.js").LanguageFn>> | null;
     modelValue: JSONContent;
+    slashCommands: LoomaEditorSlashCommands | undefined;
+    mentionQuery: LoomaMentionQuery | undefined;
+    linkSearch: LoomaLinkSearch | undefined;
+    linkResolve: LoomaLinkResolve | undefined;
+    imageUpload: LoomaImageUploader | undefined;
     contentDensity: "compact" | "comfortable";
-    slashCommands: LoomaEditorSlashCommands;
     mentionItems: LoomaMentionItem[];
-    mentionProvider: LoomaMentionProvider | undefined;
     mentionLimit: number;
-    linkSearch: LoomaLinkSearch | undefined;
-    linkResolve: LoomaLinkResolve | undefined;
     linkTargetLabel: string;
-    uploadImage: LoomaImageUploader | undefined;
     resolveImageAttributes: LoomaImageAttributeResolver | undefined;
     resolveImageSource: LoomaImageSourceResolver | undefined;
     toolbarMode: LoomaEditorToolbarMode;

package/vue/editor/index.d.ts

@@ -1,4 +1,4 @@
 export * from "@threadlabs/looma/editor";
 export * from "./primitives.js";
-export { LoomaEditor, type LoomaEditorToolbarMode, type LoomaEditorSelectionAction, type LoomaEditorSelectionActionDetail, type LoomaEditorRangeAction, type LoomaEditorRangeActionDetail, type LoomaEditorSlashCommands, type LoomaLinkTarget, type LoomaLinkSearch, type LoomaLinkResolve, type LoomaImageUploader, type LoomaImageUploadResult, } from "./LoomaEditor.js";
+export { LoomaEditor, type LoomaEditorToolbarMode, type LoomaEditorSelectionAction, type LoomaEditorSelectionActionDetail, type LoomaEditorRangeAction, type LoomaEditorRangeActionDetail, type LoomaEditorExtensions, type LoomaEditorSlashCommands, type LoomaSlashCommandsDetail, type LoomaLinkTarget, type LoomaLinkSearch, type LoomaLinkSearchDetail, type LoomaLinkResolve, type LoomaLinkResolveDetail, type LoomaMentionQuery, type LoomaMentionQueryDetail, type LoomaImageUploader, type LoomaImageUploadDetail, type LoomaRequestInit, type LoomaResponder, } from "./LoomaEditor.js";
 export type { LoomaImageActivationDetail, LoomaImageActivationTrigger, LoomaImageAttributeResolver, LoomaImageSourceResolver, LoomaImageDescriptor, LoomaImageRenditionErrorDetail, LoomaImageRenditionAttributes, } from "../../editor/image-delivery.js";