@umbraco-ai/core 1.0.0 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umbraco-ai/core",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "type": "module",
   "types": "./types/umbraco-ai-public-types.d.ts",
   "files": [

package/types/umbraco-ai-public-types.d.ts

@@ -4,7 +4,8 @@ import type { ManifestBase } from '@umbraco-cms/backoffice/extension-api';
 import { Observable } from '@umbraco-cms/backoffice/external/rxjs';
 import { Observable as Observable_2 } from 'rxjs';
 import { TemplateResult } from 'lit-html';
-import type { TemplateResult as TemplateResult_2 } from '@umbraco-cms/backoffice/external/lit';
+import { TemplateResult as TemplateResult_2 } from '@umbraco-cms/backoffice/external/lit';
+import type { UmbApi } from '@umbraco-cms/backoffice/extension-api';
 import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
 import { UmbControllerBase } from '@umbraco-cms/backoffice/class-api';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
@@ -109,6 +110,33 @@ declare type PropertyChangeModel = {
  */
 export declare function resolveEntityAdapterByType(entityType: string): Promise<UaiEntityAdapterApi | undefined>;
 
+/**
+ * Converts a string to camelCase by splitting on separators (-, _, ., spaces).
+ * Used for converting tool/scope IDs to localization key format.
+ *
+ * @example
+ * toCamelCase("content-read") // "contentRead"
+ * toCamelCase("media_write") // "mediaWrite"
+ * toCamelCase("some.scope") // "someScope"
+ */
+export declare function toCamelCase(str: string): string;
+
+export declare type ToolItemResponseModel = {
+    id: string;
+    name: string;
+    description: string;
+    scopeId: string;
+    isDestructive: boolean;
+    tags: Array<string>;
+};
+
+export declare type ToolScopeItemResponseModel = {
+    id: string;
+    icon: string;
+    isDestructive: boolean;
+    domain: string;
+};
+
 /**
  * A constant representing an empty GUID.
  * @public
@@ -225,7 +253,7 @@ export declare interface UaiChatResult {
  * Chat message role.
  * @public
  */
-export declare type UaiChatRole = 'user' | 'assistant' | 'system';
+export declare type UaiChatRole = "user" | "assistant" | "system";
 
 /**
  * Streaming chunk from chat completion.
@@ -641,10 +669,37 @@ export declare class UaiEntityDeletedRedirectController extends UmbControllerBas
     constructor(host: UmbControllerHost, args: UaiEntityDeletedRedirectArgs);
 }
 
+/**
+ * Frontend tool metadata for display in tool pickers.
+ * This is the minimal data needed by consumers to list available frontend tools.
+ */
+export declare interface UaiFrontendToolData {
+    /** Unique tool identifier (matches AG-UI tool call name) */
+    id: string;
+    /** Display name for the tool */
+    name: string;
+    /** Description of what the tool does */
+    description: string;
+    /** Scope identifier for permission grouping */
+    scopeId: string;
+}
+
+/**
+ * Repository API for accessing frontend tool metadata.
+ * Implemented by packages that provide frontend tools (e.g., Copilot).
+ */
+export declare interface UaiFrontendToolRepositoryApi extends UmbApi {
+    /**
+     * Get all available frontend tools.
+     * @returns Array of frontend tool metadata
+     */
+    getTools(): Promise<UaiFrontendToolData[]>;
+}
+
 export declare interface UaiItemPickerModalData {
     items?: UaiPickableItemModel[];
     fetchItems?: () => Promise<UaiPickableItemModel[]>;
-    selectionMode?: 'single' | 'multiple';
+    selectionMode?: "single" | "multiple";
     tagTemplate?: (item: UaiPickableItemModel) => TemplateResult_2;
     title?: string;
     buttonLabel?: string;
@@ -988,6 +1043,295 @@ export declare class UaiTagsInputElement extends UaiTagsInputElement_base {
 
 declare const UaiTagsInputElement_base: (new (...args: any[]) => UUIFormControlMixinElement<FormData | FormDataEntryValue>) & typeof UmbLitElement;
 
+/**
+ * Tool with permission state.
+ */
+export declare interface UaiToolPermission {
+    toolId: string;
+    state: UaiToolPermissionState;
+}
+
+/**
+ * Component for managing individual tool permission overrides.
+ * Displays inherited tools with "Deny" buttons and allows adding new tools with "Allow" permission.
+ *
+ * @fires change - Fires when permissions change
+ *
+ * @public
+ */
+export declare class UaiToolPermissionsOverrideElement extends UmbLitElement {
+    #private;
+    /**
+     * Map of tool ID to full tool data.
+     */
+    private _toolDataMap;
+    /**
+     * Inherited tool IDs from agent defaults.
+     */
+    inheritedToolIds: string[];
+    /**
+     * Tool IDs that are explicitly allowed (additive).
+     */
+    allowedToolIds: string[];
+    /**
+     * Tool IDs that are explicitly denied (subtractive).
+     */
+    deniedToolIds: string[];
+    /**
+     * Whether the component is in readonly mode.
+     */
+    readonly: boolean;
+    connectedCallback(): void;
+    updated(changedProperties: Map<string, unknown>): void;
+    /**
+     * Load full tool data for all tools.
+     */
+    private _loadToolData;
+    /**
+     * Computed list of all tools with their permission states.
+     */
+    private get _allTools();
+    /**
+     * Add a new allowed tool.
+     */
+    private _addAllowedTool;
+    /**
+     * Fetch available tools for the picker modal.
+     */
+    private _fetchAvailableTools;
+    /**
+     * Deny a tool (move to denied list).
+     */
+    private _denyTool;
+    /**
+     * Remove a tool from denied list (allow it again).
+     */
+    private _allowTool;
+    /**
+     * Remove an explicitly allowed tool.
+     */
+    private _removeAllowedTool;
+    /**
+     * Dispatch change event.
+     */
+    private _dispatchChangeEvent;
+    /**
+     * Render a tool permission item.
+     */
+    private _renderToolItem;
+    render(): TemplateResult<1>;
+    static styles: CSSResult[];
+}
+
+/**
+ * Permission state for a tool override.
+ */
+export declare type UaiToolPermissionState = "inherited" | "allowed" | "denied";
+
+/**
+ * Tool picker component that allows selecting one or more AI tools.
+ *
+ * @fires change - Fires when the selection changes (UmbChangeEvent).
+ *
+ * @example
+ * Multiple selection (default):
+ * ```html
+ * <uai-tool-picker
+ *   .value=${["tool-id-1", "tool-id-2"]}
+ *   @change=${(e) => console.log(e.target.value)}
+ * ></uai-tool-picker>
+ * ```
+ * @public
+ */
+export declare class UaiToolPickerElement extends UaiToolPickerElement_base {
+    #private;
+    /**
+     * Readonly mode - cannot add or remove.
+     */
+    readonly: boolean;
+    /**
+     * Optional frontend tools to include alongside server-fetched tools.
+     * These tools will be combined with the backend tools when displaying the picker.
+     */
+    frontendTools?: UaiFrontendToolData[];
+    /**
+     * The selected tool ID(s).
+     */
+    set value(val: string[] | undefined);
+    get value(): string[] | undefined;
+    private _selection;
+    private _items;
+    private _loading;
+    updated(changedProperties: Map<PropertyKey, unknown>): void;
+    render(): TemplateResult<1>;
+    static styles: CSSResult[];
+}
+
+declare const UaiToolPickerElement_base: HTMLElementConstructor<UmbFormControlMixinElement<string[] | undefined>> & typeof UmbLitElement;
+
+/**
+ * Repository for tool operations.
+ */
+export declare class UaiToolRepository extends UmbControllerBase {
+    #private;
+    constructor(host: UmbControllerHost);
+    /**
+     * Gets all registered tool scopes.
+     */
+    getToolScopes(): Promise<{
+        data?: Array<ToolScopeItemResponseModel>;
+        error?: unknown;
+    }>;
+    /**
+     * Gets all registered tools.
+     */
+    getTools(): Promise<{
+        data?: Array<ToolItemResponseModel>;
+        error?: unknown;
+    }>;
+}
+
+/**
+ * Tool scope with permission state.
+ */
+export declare interface UaiToolScopePermission {
+    scopeId: string;
+    state: UaiToolScopePermissionState;
+}
+
+export declare class UaiToolScopePermissionsElement extends UaiToolScopePermissionsElement_base {
+    #private;
+    /**
+     * Readonly mode - cannot toggle permissions.
+     */
+    readonly: boolean;
+    /**
+     * The selected tool scope IDs.
+     */
+    set value(val: string[] | undefined);
+    get value(): string[] | undefined;
+    private _selection;
+    private _groups;
+    private _loading;
+    connectedCallback(): void;
+    render(): TemplateResult<1>;
+    static styles: CSSResult[];
+}
+
+declare const UaiToolScopePermissionsElement_base: HTMLElementConstructor<UmbFormControlMixinElement<string[] | undefined>> & typeof UmbLitElement;
+
+/**
+ * Component for managing tool scope permission overrides.
+ * Displays inherited scopes with "Deny" buttons and allows adding new scopes with "Allow" permission.
+ *
+ * @fires change - Fires when permissions change
+ *
+ * @public
+ */
+export declare class UaiToolScopePermissionsOverrideElement extends UmbLitElement {
+    #private;
+    /**
+     * Map of scope ID to full scope data.
+     */
+    private _scopeDataMap;
+    /**
+     * Inherited scope IDs from agent defaults.
+     */
+    inheritedScopeIds: string[];
+    /**
+     * Scope IDs that are explicitly allowed (additive).
+     */
+    allowedScopeIds: string[];
+    /**
+     * Scope IDs that are explicitly denied (subtractive).
+     */
+    deniedScopeIds: string[];
+    /**
+     * Whether the component is in readonly mode.
+     */
+    readonly: boolean;
+    connectedCallback(): void;
+    updated(changedProperties: Map<string, unknown>): void;
+    /**
+     * Load full scope data for all scopes.
+     */
+    private _loadScopeData;
+    /**
+     * Computed list of all scopes with their permission states.
+     */
+    private get _allScopes();
+    /**
+     * Add a new allowed scope.
+     */
+    private _addAllowedScope;
+    /**
+     * Fetch available tool scopes for the picker modal.
+     */
+    private _fetchAvailableScopes;
+    /**
+     * Deny a scope (move to denied list).
+     */
+    private _denyScope;
+    /**
+     * Remove a scope from denied list (allow it again).
+     */
+    private _allowScope;
+    /**
+     * Remove an explicitly allowed scope.
+     */
+    private _removeAllowedScope;
+    /**
+     * Dispatch change event.
+     */
+    private _dispatchChangeEvent;
+    /**
+     * Render a scope permission item.
+     */
+    private _renderScopeItem;
+    render(): TemplateResult<1>;
+    static styles: CSSResult[];
+}
+
+/**
+ * Permission state for a tool scope override.
+ */
+export declare type UaiToolScopePermissionState = "inherited" | "allowed" | "denied";
+
+/**
+ * Tool scope picker component that allows selecting one or more tool scopes.
+ *
+ * @fires change - Fires when the selection changes (UmbChangeEvent).
+ *
+ * @example
+ * Multiple selection:
+ * ```html
+ * <uai-tool-scope-picker
+ *   .value=${["content-read", "media-write"]}
+ *   @change=${(e) => console.log(e.target.value)}
+ * ></uai-tool-scope-picker>
+ * ```
+ * @public
+ */
+export declare class UaiToolScopePickerElement extends UaiToolScopePickerElement_base {
+    #private;
+    /**
+     * Readonly mode - cannot add or remove.
+     */
+    readonly: boolean;
+    /**
+     * The selected tool scope ID(s).
+     */
+    set value(val: string[] | undefined);
+    get value(): string[] | undefined;
+    private _selection;
+    private _items;
+    private _loading;
+    render(): TemplateResult<1>;
+    static styles: CSSResult[];
+}
+
+declare const UaiToolScopePickerElement_base: HTMLElementConstructor<UmbFormControlMixinElement<string[] | undefined>> & typeof UmbLitElement;
+
 /**
  * Unified repository for version history operations across all entity types.
  * Uses the unified versioning API endpoint instead of entity-specific endpoints.
@@ -1023,6 +1367,124 @@ export declare class UaiUnifiedVersionHistoryRepository {
     rollback(entityType: string, entityId: string, version: number): Promise<boolean>;
 }
 
+/**
+ * Configuration for the user group settings list component.
+ * @template TSettings - The type of settings managed for each user group
+ * @public
+ */
+export declare interface UaiUserGroupSettingsConfig<TSettings> {
+    /** Modal configuration for editing settings */
+    editorModal: {
+        /** Modal token to open for editing */
+        token: UmbModalToken<any, any>;
+        /** Factory to create modal data */
+        createData: (userGroupId: string, userGroupName: string, existingSettings?: TSettings) => any;
+        /** Extract settings from modal result */
+        extractValue: (modalResult: any) => TSettings;
+    };
+    /** Display configuration */
+    display: {
+        /** Render summary text/content for list item detail */
+        renderSummary: (settings: TSettings) => TemplateResult_2 | string;
+        /** Optional: Render tags/badges in list item */
+        renderTags?: (settings: TSettings) => TemplateResult_2;
+    };
+    /** Localization (all optional with sensible defaults) */
+    labels?: {
+        /** Box headline (default: "User Group Overrides") */
+        headline?: string;
+        /** Add button label (default: "Add User Group Override") */
+        addButton?: string;
+    };
+}
+
+/**
+ * Generic reusable component for managing user-group-specific settings for any feature.
+ * Handles list display, add/edit/remove workflows, and user group picker integration.
+ *
+ * @fires change - Fires when the value changes
+ *
+ * @example
+ * ```typescript
+ * const config: UaiUserGroupSettingsConfig<MySettings> = {
+ *   editorModal: {
+ *     token: MY_EDITOR_MODAL_TOKEN,
+ *     createData: (id, name, existing) => ({ userGroupId: id, userGroupName: name, settings: existing }),
+ *     extractValue: (result) => result.settings,
+ *   },
+ *   display: {
+ *     renderSummary: (settings) => `${settings.count} items configured`,
+ *     renderTags: (settings) => html`<uui-tag>Active</uui-tag>`,
+ *   },
+ *   labels: {
+ *     headline: 'Custom Settings',
+ *     addButton: 'Add Custom Setting',
+ *   },
+ * };
+ * ```
+ *
+ * @public
+ */
+export declare class UaiUserGroupSettingsListElement<TSettings> extends UmbLitElement {
+    #private;
+    /**
+     * Map of user group IDs to their settings.
+     * Dictionary key is the user group ID (GUID as string).
+     */
+    value: Record<string, TSettings>;
+    /**
+     * Configuration for the component (modal, display, labels).
+     */
+    config: UaiUserGroupSettingsConfig<TSettings>;
+    /**
+     * Whether the component is in readonly mode.
+     */
+    readonly: boolean;
+    /**
+     * Internal state for resolved user group names.
+     */
+    private _userGroupNames;
+    /**
+     * Computed labels with defaults.
+     */
+    private get _labels();
+    /**
+     * Check if there are any user groups configured.
+     */
+    private get _hasUserGroups();
+    /**
+     * Get user group entries as array for rendering.
+     */
+    private get _userGroupEntries();
+    connectedCallback(): void;
+    /**
+     * Load user group names for all configured user groups.
+     */
+    private _loadUserGroupNames;
+    /**
+     * Get user group name by ID.
+     */
+    private _getUserGroupName;
+    /**
+     * Add a new user group override.
+     */
+    private _addUserGroup;
+    /**
+     * Edit an existing user group override.
+     */
+    private _editUserGroup;
+    /**
+     * Remove a user group override.
+     */
+    private _removeUserGroup;
+    /**
+     * Dispatch change event.
+     */
+    private _dispatchChangeEvent;
+    render(): TemplateResult_2<1>;
+    static styles: CSSResult[];
+}
+
 /**
  * Response model for version comparison.
  */