@kopexa/extension-controlref 1.0.0 → 2.0.0

package/dist/index.mjs

@@ -1,44 +1,81 @@
 "use client";
 import {
-  DEFAULT_CONTROL_GQL_API
-} from "./chunk-SNRVOTF5.mjs";
+  ControlBlock
+} from "./chunk-RTBFRPB3.mjs";
+import "./chunk-FTEE5U3H.mjs";
+import "./chunk-XHD2KFKQ.mjs";
+import "./chunk-ZUR6XKMG.mjs";
 import {
-  ControlRef
-} from "./chunk-H2ECPGOG.mjs";
-import "./chunk-KLX7Q3HL.mjs";
-import "./chunk-NAJ6IC4Y.mjs";
+  ControlImplementation
+} from "./chunk-ZRKYAFRY.mjs";
+import "./chunk-IMHLTRZJ.mjs";
 import {
   Control
-} from "./chunk-LKRTUIEV.mjs";
-import "./chunk-VP5POY44.mjs";
-import "./chunk-QI3ZPZTR.mjs";
-import "./chunk-AZ5M5MVC.mjs";
-import "./chunk-EDD7DYLE.mjs";
-import "./chunk-AC4KL3WX.mjs";
-import "./chunk-DTFR234X.mjs";
-import "./chunk-WIR5FCIC.mjs";
-import "./chunk-GC5EBQ7G.mjs";
+} from "./chunk-X46EFFCE.mjs";
+import "./chunk-TEDXYIGO.mjs";
+import "./chunk-LMKP3DDN.mjs";
+import "./chunk-JM66CQVD.mjs";
+import "./chunk-WIS7ZNTO.mjs";
+import "./chunk-GYDJVHHG.mjs";
+import "./chunk-A7FWOQDN.mjs";
+import "./chunk-4C72VBLP.mjs";
+import "./chunk-AQTNFDGA.mjs";
+import "./chunk-D53W4HWR.mjs";
 
 // src/index.ts
-import { Extension } from "@tiptap/core";
+import {
+  callOrReturn,
+  Extension,
+  getExtensionField
+} from "@tiptap/core";
 var ControlKit = Extension.create({
   name: "controlKit",
   addOptions() {
     return {
       control: {},
-      url: DEFAULT_CONTROL_GQL_API
+      controlBlock: {},
+      controlImplementation: {}
     };
   },
   addExtensions() {
     const extensions = [];
     if (this.options.control !== false) {
-      extensions.push(Control.configure(this.options.control));
+      extensions.push(
+        Control.configure({
+          ...this.options.control,
+          resolver: this.options.resolver
+        })
+      );
+    }
+    if (this.options.controlBlock !== false) {
+      extensions.push(
+        ControlBlock.configure({
+          ...this.options.controlBlock,
+          resolver: this.options.resolver
+        })
+      );
+    }
+    if (this.options.controlImplementation !== false) {
+      extensions.push(
+        ControlImplementation.configure(this.options.controlImplementation)
+      );
     }
-    extensions.push(ControlRef);
     return extensions;
+  },
+  extendNodeSchema(extension) {
+    const context = {
+      name: extension.name,
+      options: extension.options,
+      storage: extension.storage
+    };
+    return {
+      controlRole: callOrReturn(
+        getExtensionField(extension, "controlRole", context)
+      )
+    };
   }
 });
 export {
-  ControlKit,
-  ControlRef
+  ControlBlock,
+  ControlKit
 };

package/dist/messages/index.d.mts

@@ -44,6 +44,11 @@ declare const messages: {
         defaultMessage: string;
         description: string;
     };
+    variant_hint: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
     variant_chip: {
         id: string;
         defaultMessage: string;
@@ -99,6 +104,136 @@ declare const messages: {
         defaultMessage: string;
         description: string;
     };
+    unmapped_control: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    control_with_title: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    search_hint: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    no_results: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    results_count: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    updated_at: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    selected: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    no_control_selected: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    clear: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    unmap: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    live_preview: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    display_options: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    show_status_indicator: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    searching: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    map_control_aria: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    outdated_badge: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    missing_badge: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    error_loading: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    error_timeout: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    missing_callout: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    outdated_callout: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    search_placeholder: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    control_implementations: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    header_status: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    header_status_aria: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    header_status_avv_tip: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
 };
 
 export { messages };

package/dist/messages/index.d.ts

@@ -44,6 +44,11 @@ declare const messages: {
         defaultMessage: string;
         description: string;
     };
+    variant_hint: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
     variant_chip: {
         id: string;
         defaultMessage: string;
@@ -99,6 +104,136 @@ declare const messages: {
         defaultMessage: string;
         description: string;
     };
+    unmapped_control: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    control_with_title: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    search_hint: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    no_results: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    results_count: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    updated_at: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    selected: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    no_control_selected: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    clear: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    unmap: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    live_preview: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    display_options: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    show_status_indicator: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    searching: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    map_control_aria: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    outdated_badge: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    missing_badge: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    error_loading: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    error_timeout: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    missing_callout: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    outdated_callout: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    search_placeholder: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    control_implementations: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    header_status: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    header_status_aria: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    header_status_avv_tip: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
 };
 
 export { messages };

package/dist/messages/index.js

@@ -63,14 +63,19 @@ var messages = (0, import_react_intl.defineMessages)({
   },
   search_controls: {
     id: "editor.controlref.search_controls",
-    defaultMessage: "Search controls...",
+    defaultMessage: "Search controls\u2026",
     description: "Placeholder for search controls input"
   },
   variant: {
     id: "editor.controlref.variant",
-    defaultMessage: "Variant",
+    defaultMessage: "Variante",
     description: "Label for variant section"
   },
+  variant_hint: {
+    id: "editor.controlref.variant_hint",
+    defaultMessage: "Choose a visual emphasis for this section.",
+    description: "Hint for variant section"
+  },
   variant_chip: {
     id: "editor.controlref.variant_chip",
     defaultMessage: "Chip",
@@ -125,6 +130,136 @@ var messages = (0, import_react_intl.defineMessages)({
     id: "editor.controlref.save_settings",
     defaultMessage: "Save Settings",
     description: "Label for save settings button"
+  },
+  unmapped_control: {
+    id: "editor.controlref.unmapped_control",
+    defaultMessage: "Unmapped Control",
+    description: "Fallback label when no control is selected"
+  },
+  control_with_title: {
+    id: "editor.controlref.control_with_title",
+    defaultMessage: "Control: {title}",
+    description: "Dialog title with selected control"
+  },
+  search_hint: {
+    id: "editor.controlref.search_hint",
+    defaultMessage: "Start typing to search by ID, title or status.",
+    description: "Empty search hint"
+  },
+  no_results: {
+    id: "editor.controlref.no_results",
+    defaultMessage: "No controls found for \u201C{query}\u201D. You can keep this chip unmapped.",
+    description: "Shown when no controls match search query"
+  },
+  results_count: {
+    id: "editor.controlref.results_count",
+    defaultMessage: "{count, plural, one {# result} other {# results}}",
+    description: "Number of search results"
+  },
+  updated_at: {
+    id: "editor.controlref.updated_at",
+    defaultMessage: "Updated {date}",
+    description: "Updated date label"
+  },
+  selected: {
+    id: "editor.controlref.selected",
+    defaultMessage: "Selected",
+    description: "Label for selected item area"
+  },
+  no_control_selected: {
+    id: "editor.controlref.no_control_selected",
+    defaultMessage: "No control selected",
+    description: "Empty state in selected area"
+  },
+  clear: {
+    id: "editor.controlref.clear",
+    defaultMessage: "Clear",
+    description: "Clear selection button"
+  },
+  unmap: {
+    id: "editor.controlref.unmap",
+    defaultMessage: "Unmap",
+    description: "Unmap selection button"
+  },
+  live_preview: {
+    id: "editor.controlref.live_preview",
+    defaultMessage: "Live preview",
+    description: "Live preview section title"
+  },
+  display_options: {
+    id: "editor.controlref.display_options",
+    defaultMessage: "Display options",
+    description: "Display options section title"
+  },
+  show_status_indicator: {
+    id: "editor.controlref.show_status_indicator",
+    defaultMessage: "Show status indicator",
+    description: "Toggle for showing indicator"
+  },
+  searching: {
+    id: "editor.controlref.searching",
+    defaultMessage: "Searching\u2026",
+    description: "Loading indicator text"
+  },
+  map_control_aria: {
+    id: "editor.controlref.map_control_aria",
+    defaultMessage: "Map control",
+    description: "ARIA label for mapping control"
+  },
+  outdated_badge: {
+    id: "editor.controlref.outdated_badge",
+    defaultMessage: "A newer revision exists",
+    description: "Badge for outdated controls"
+  },
+  missing_badge: {
+    id: "editor.controlref.missing_badge",
+    defaultMessage: "Control no longer exists",
+    description: "Badge for missing controls"
+  },
+  error_loading: {
+    id: "editor.controlref.error_loading",
+    defaultMessage: "Failed to load controls",
+    description: "Error message when failing to load controls"
+  },
+  error_timeout: {
+    id: "editor.controlref.error_timeout",
+    defaultMessage: "The request timed out. Please try again.",
+    description: "Error message when the request times out"
+  },
+  missing_callout: {
+    id: "editor.controlref.missing_callout",
+    defaultMessage: "The currently mapped control could not be found. It may have been deleted or you may not have access to it anymore. Please select a different control.",
+    description: "Callout message when the selected control is missing"
+  },
+  outdated_callout: {
+    id: "editor.controlref.outdated_callout",
+    defaultMessage: "A newer revision of the currently mapped control exists. Consider updating to the latest version by re-selecting it below.",
+    description: "Callout message when the selected control is outdated"
+  },
+  search_placeholder: {
+    id: "editor.controlref.search_placeholder",
+    defaultMessage: "e.g. CTRL-001, Asset Inventory\u2026",
+    description: "Placeholder for search controls input"
+  },
+  control_implementations: {
+    id: "editor.controlref.control_implementations",
+    defaultMessage: "Implementations",
+    description: "Label for control implementations section"
+  },
+  header_status: {
+    id: "editor.controlblock.header_status",
+    defaultMessage: "Show status in header",
+    description: "Label for show status in header toggle"
+  },
+  header_status_aria: {
+    id: "editor.controlblock.header_status_aria",
+    defaultMessage: "Toggle status chip in card header",
+    description: "ARIA label for show status in header toggle"
+  },
+  header_status_avv_tip: {
+    id: "editor.controlblock.header_status_avv_tip",
+    defaultMessage: "If this document is intended for use or export as a data processing agreement (AVV), disable this option unless you explicitly want to publish the current control status.",
+    description: "Tooltip for show status in header toggle when used in AVV documents"
   }
 });
 // Annotate the CommonJS export names for ESM import in node:

package/dist/messages/index.mjs

@@ -1,8 +1,7 @@
 "use client";
 import {
   messages
-} from "../chunk-WIR5FCIC.mjs";
-import "../chunk-GC5EBQ7G.mjs";
+} from "../chunk-D53W4HWR.mjs";
 export {
   messages
 };

package/dist/role.d.mts

@@ -0,0 +1,17 @@
+import { ParentConfig } from '@tiptap/core';
+
+declare module "@tiptap/core" {
+    interface NodeConfig<Options, Storage> {
+        /**
+         * A string or function to determine the role of the control field.
+         * @default 'control'
+         * @example () => 'control'
+         */
+        controlRole?: string | ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<NodeConfig<Options>>["controlRole"];
+        }) => string);
+    }
+}

package/dist/role.d.ts

@@ -0,0 +1,17 @@
+import { ParentConfig } from '@tiptap/core';
+
+declare module "@tiptap/core" {
+    interface NodeConfig<Options, Storage> {
+        /**
+         * A string or function to determine the role of the control field.
+         * @default 'control'
+         * @example () => 'control'
+         */
+        controlRole?: string | ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<NodeConfig<Options>>["controlRole"];
+        }) => string);
+    }
+}

package/dist/role.js

@@ -0,0 +1,5 @@
+"use client";
+"use strict";
+
+// src/role.ts
+var import_core = require("@tiptap/core");

package/dist/role.mjs

@@ -0,0 +1,2 @@
+"use client";
+import "./chunk-WIS7ZNTO.mjs";

package/dist/types.d.mts

@@ -1,5 +1,27 @@
 import { CardVariantProps } from '@kopexa/theme';
 
+type FallbackOptions = Record<string, unknown>;
+type ControlNodeAttrs<T = FallbackOptions> = {
+    id: string | null;
+    title: string | null;
+    updatedAt: string | null;
+    status: string | null;
+    options: T | null;
+};
+type ControlBlockVariant = "default" | "muted" | "accent";
+type ControlViewOptions = {
+    showStatus?: boolean | null;
+    variant?: ControlBlockVariant;
+};
+type ControlResolver = {
+    /**
+     * A method to retrieve a list of controls, potentially filtered by a search term.
+     * @param searchTerm - Optional term to filter controls.
+     * @returns A promise that resolves to an array of control objects.
+     */
+    getControls: (searchTerm?: string) => Promise<Array<ControlSummary>>;
+    getControl: (id: string) => Promise<ControlSummary | null>;
+};
 type ControlSummary = {
     id: string | null;
     title: string | null;
@@ -14,24 +36,9 @@ type ControlImplementationRef = {
     updatedAt?: string | null;
     status?: string | null;
 };
-type Variant = "chip" | "card";
 type CardBorder = CardVariantProps["border"];
 type CardShadow = CardVariantProps["shadow"];
 type CardRadius = CardVariantProps["radius"];
 type CardSpacing = CardVariantProps["spacing"];
-type ControlRefOptions = {
-    variant: Variant;
-    inlineShowStatus: boolean;
-    cardShowDescription: boolean;
-    cardShowImplementations: boolean;
-    cardBorder: CardBorder;
-    cardShadow: CardShadow;
-    cardRadius: CardRadius;
-    cardSpacing: CardSpacing;
-};
-type Getters = {
-    search: (q: string) => Promise<ControlSummary[]>;
-    getById: (id: string) => Promise<ControlSummary | null>;
-};
 
-export type { CardBorder, CardRadius, CardShadow, CardSpacing, ControlImplementationRef, ControlRefOptions, ControlSummary, Getters, Variant };
+export type { CardBorder, CardRadius, CardShadow, CardSpacing, ControlBlockVariant, ControlImplementationRef, ControlNodeAttrs, ControlResolver, ControlSummary, ControlViewOptions };