sitecore-ai-sdk-tools 0.0.1-alpha.1

package/dist/index.d.ts

@@ -0,0 +1,749 @@
+import * as ai from 'ai';
+import { tool } from 'ai';
+import { experimental_XMC } from '@sitecore-marketplace-sdk/xmc';
+import { ClientSDK } from '@sitecore-marketplace-sdk/client';
+import { z } from 'zod';
+
+declare const assetToolsConfig: {
+    get_asset_information: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            assetId: z.ZodString;
+        }, z.core.$strip>;
+    };
+    search_assets: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            query: z.ZodString;
+            language: z.ZodString;
+            type: z.ZodString;
+        }, z.core.$strip>;
+    };
+    update_asset: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            assetId: z.ZodString;
+            fields: z.ZodObject<{}, z.core.$strip>;
+            language: z.ZodString;
+            name: z.ZodString;
+            altText: z.ZodString;
+        }, z.core.$strip>;
+    };
+    upload_asset: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            fileUrl: z.ZodString;
+            name: z.ZodString;
+            itemPath: z.ZodString;
+            language: z.ZodString;
+            extension: z.ZodString;
+            siteName: z.ZodString;
+        }, z.core.$strip>;
+    };
+};
+declare const environmentToolsConfig: {
+    list_languages: {
+        description: string;
+        inputSchema: z.ZodObject<{}, z.core.$strip>;
+    };
+};
+declare const personalizationToolsConfig: {
+    create_personalization_version: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            pageId: z.ZodString;
+            name: z.ZodString;
+            variant_name: z.ZodString;
+            audience_name: z.ZodString;
+            condition_template_id: z.ZodString;
+            condition_params: z.ZodObject<{}, z.core.$strip>;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_personalization_versions_by_page: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            pageId: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_condition_templates: {
+        description: string;
+        inputSchema: z.ZodObject<{}, z.core.$strip>;
+    };
+    get_condition_template_by_id: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            templateId: z.ZodString;
+        }, z.core.$strip>;
+    };
+};
+declare const jobToolsConfig: {
+    revert_job: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            jobId: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_job: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            jobId: z.ZodString;
+        }, z.core.$strip>;
+    };
+    list_operations: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            jobId: z.ZodString;
+        }, z.core.$strip>;
+    };
+};
+declare const pagesToolsConfig: {
+    get_page: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            pageId: z.ZodString;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+    create_page: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            templateId: z.ZodString;
+            name: z.ZodString;
+            parentId: z.ZodString;
+            language: z.ZodString;
+            fields: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
+        }, z.core.$strip>;
+    };
+    get_page_template_by_id: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            templateId: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_allowed_components_by_placeholder: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            pageId: z.ZodString;
+            placeholderName: z.ZodString;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_components_on_page: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            pageId: z.ZodString;
+            language: z.ZodString;
+            version: z.ZodNumber;
+        }, z.core.$strip>;
+    };
+    add_component_on_page: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            pageId: z.ZodString;
+            componentId: z.ZodString;
+            placeholderPath: z.ZodString;
+            componentItemName: z.ZodString;
+            language: z.ZodString;
+            fields: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
+        }, z.core.$strip>;
+    };
+    set_component_datasource: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            pageId: z.ZodString;
+            componentId: z.ZodString;
+            datasourceId: z.ZodString;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+    add_language_to_page: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            pageId: z.ZodString;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+    search_site: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            search_query: z.ZodString;
+            site_name: z.ZodString;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_page_path_by_live_url: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            live_url: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_page_screenshot: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            pageId: z.ZodString;
+            version: z.ZodNumber;
+            language: z.ZodString;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>;
+    };
+    get_page_html: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            pageId: z.ZodString;
+            language: z.ZodString;
+            version: z.ZodNumber;
+        }, z.core.$strip>;
+    };
+    get_page_preview_url: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            pageId: z.ZodString;
+            language: z.ZodString;
+            version: z.ZodNumber;
+        }, z.core.$strip>;
+    };
+};
+declare const sitesToolsConfig: {
+    get_sites_list: {
+        description: string;
+        inputSchema: z.ZodObject<{}, z.core.$strip>;
+    };
+    get_site_details: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            siteId: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_all_pages_by_site: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            siteName: z.ZodString;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_site_id_from_item: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            itemId: z.ZodString;
+        }, z.core.$strip>;
+    };
+};
+declare const contentToolsConfig: {
+    create_content_item: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            templateId: z.ZodString;
+            name: z.ZodString;
+            parentId: z.ZodString;
+            language: z.ZodString;
+            fields: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        }, z.core.$strip>;
+    };
+    delete_content: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            itemId: z.ZodString;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_content_item_by_id: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            itemId: z.ZodString;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+    update_content: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            itemId: z.ZodString;
+            fields: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+            language: z.ZodString;
+            createNewVersion: z.ZodBoolean;
+            siteName: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_content_item_by_path: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            item_path: z.ZodString;
+            failOnNotFound: z.ZodBoolean;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+    list_available_insert_options: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            itemId: z.ZodString;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+};
+declare const componentsToolsConfig: {
+    create_component_datasource: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            componentId: z.ZodString;
+            siteName: z.ZodString;
+            dataFields: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+            children: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
+            language: z.ZodString;
+        }, z.core.$strip>;
+    };
+    search_component_datasources: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            componentId: z.ZodString;
+            term: z.ZodString;
+        }, z.core.$strip>;
+    };
+    list_components: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            site_name: z.ZodString;
+        }, z.core.$strip>;
+    };
+    get_component: {
+        description: string;
+        inputSchema: z.ZodObject<{
+            componentId: z.ZodString;
+        }, z.core.$strip>;
+    };
+};
+
+type NeedsApproval = Parameters<typeof tool>[0]['needsApproval'];
+type DefaultToolOptions = {
+    needsApproval?: NeedsApproval;
+};
+type SitecoreToolName = keyof typeof assetToolsConfig | keyof typeof pagesToolsConfig | keyof typeof personalizationToolsConfig | keyof typeof sitesToolsConfig | keyof typeof environmentToolsConfig | keyof typeof jobToolsConfig | keyof typeof componentsToolsConfig | keyof typeof contentToolsConfig;
+type ClientSideContext = {
+    client: ClientSDK;
+    sitecoreContextId: string;
+};
+type ClientSideTool = {
+    toolName: string;
+    input: unknown;
+};
+
+declare function executeSitecoreTool(context: ClientSideContext, tool: ClientSideTool): Promise<{
+    success: boolean;
+    error: string;
+    result?: undefined;
+} | {
+    success: boolean;
+    result: unknown;
+    error?: undefined;
+}>;
+
+type ToolConfig<TInput, TOutput> = {
+    description: string;
+    inputSchema: z.ZodType<TInput>;
+    execute: (opts: ClientSideContext, input: TInput) => Promise<TOutput>;
+};
+type PageBuilderToolOptions = DefaultToolOptions;
+declare const pageBuilderTools: (options: PageBuilderToolOptions) => {
+    get_current_page_context: ai.Tool<Record<string, never>, never>;
+    reload_current_page: ai.Tool<Record<string, never>, never>;
+    navigate_to_another_page: ai.Tool<{
+        itemId: string;
+    }, never>;
+};
+type PageBuilderToolName = keyof ReturnType<typeof pageBuilderTools>;
+declare function executePageBuilderTool(context: ClientSideContext, tool: ClientSideTool): Promise<{
+    success: boolean;
+    error: string;
+    result?: undefined;
+} | {
+    success: boolean;
+    result: unknown;
+    error?: undefined;
+}>;
+
+type CreateSitecoreToolsOptions = ({
+    execution: 'client';
+} | {
+    execution: 'server';
+    client: experimental_XMC;
+    sitecoreContextId: string;
+}) & {
+    needsApproval?: NeedsApproval;
+};
+declare function createSitecoreTools(options: CreateSitecoreToolsOptions): {
+    revert_job: ai.Tool<{
+        jobId: string;
+    }, never>;
+    get_job: ai.Tool<{
+        jobId: string;
+    }, never>;
+    list_operations: ai.Tool<{
+        jobId: string;
+    }, never>;
+    get_sites_list: ai.Tool<Record<string, never>, never>;
+    get_site_details: ai.Tool<{
+        siteId: string;
+    }, never>;
+    get_all_pages_by_site: ai.Tool<{
+        siteName: string;
+        language: string;
+    }, never>;
+    get_site_id_from_item: ai.Tool<{
+        itemId: string;
+    }, never>;
+    create_personalization_version: ai.Tool<{
+        pageId: string;
+        name: string;
+        variant_name: string;
+        audience_name: string;
+        condition_template_id: string;
+        condition_params: Record<string, never>;
+        language: string;
+    }, never>;
+    get_personalization_versions_by_page: ai.Tool<{
+        pageId: string;
+    }, never>;
+    get_condition_templates: ai.Tool<Record<string, never>, never>;
+    get_condition_template_by_id: ai.Tool<{
+        templateId: string;
+    }, never>;
+    get_page: ai.Tool<{
+        pageId: string;
+        language: string;
+    }, never>;
+    create_page: ai.Tool<{
+        templateId: string;
+        name: string;
+        parentId: string;
+        language: string;
+        fields: Record<string, string | number>[];
+    }, never>;
+    get_page_template_by_id: ai.Tool<{
+        templateId: string;
+    }, never>;
+    get_allowed_components_by_placeholder: ai.Tool<{
+        pageId: string;
+        placeholderName: string;
+        language: string;
+    }, never>;
+    get_components_on_page: ai.Tool<{
+        pageId: string;
+        language: string;
+        version: number;
+    }, never>;
+    add_component_on_page: ai.Tool<{
+        pageId: string;
+        componentId: string;
+        placeholderPath: string;
+        componentItemName: string;
+        language: string;
+        fields: Record<string, string | number>;
+    }, never>;
+    set_component_datasource: ai.Tool<{
+        pageId: string;
+        componentId: string;
+        datasourceId: string;
+        language: string;
+    }, never>;
+    add_language_to_page: ai.Tool<{
+        pageId: string;
+        language: string;
+    }, never>;
+    search_site: ai.Tool<{
+        search_query: string;
+        site_name: string;
+        language: string;
+    }, never>;
+    get_page_path_by_live_url: ai.Tool<{
+        live_url: string;
+    }, never>;
+    get_page_screenshot: ai.Tool<{
+        pageId: string;
+        version: number;
+        language: string;
+        width: number;
+        height: number;
+    }, never>;
+    get_page_html: ai.Tool<{
+        pageId: string;
+        language: string;
+        version: number;
+    }, never>;
+    get_page_preview_url: ai.Tool<{
+        pageId: string;
+        language: string;
+        version: number;
+    }, never>;
+    list_languages: ai.Tool<Record<string, never>, never>;
+    create_content_item: ai.Tool<{
+        templateId: string;
+        name: string;
+        parentId: string;
+        language: string;
+        fields: Record<string, string | number>;
+    }, never>;
+    delete_content: ai.Tool<{
+        itemId: string;
+        language: string;
+    }, never>;
+    get_content_item_by_id: ai.Tool<{
+        itemId: string;
+        language: string;
+    }, never>;
+    update_content: ai.Tool<{
+        itemId: string;
+        fields: Record<string, string | number>;
+        language: string;
+        createNewVersion: boolean;
+        siteName: string;
+    }, never>;
+    get_content_item_by_path: ai.Tool<{
+        item_path: string;
+        failOnNotFound: boolean;
+        language: string;
+    }, never>;
+    list_available_insert_options: ai.Tool<{
+        itemId: string;
+        language: string;
+    }, never>;
+    create_component_datasource: ai.Tool<{
+        componentId: string;
+        siteName: string;
+        dataFields: Record<string, string | number>;
+        children: Record<string, string | number>[];
+        language: string;
+    }, never>;
+    search_component_datasources: ai.Tool<{
+        componentId: string;
+        term: string;
+    }, never>;
+    list_components: ai.Tool<{
+        site_name: string;
+    }, never>;
+    get_component: ai.Tool<{
+        componentId: string;
+    }, never>;
+    get_asset_information: ai.Tool<{
+        assetId: string;
+    }, never>;
+    search_assets: ai.Tool<{
+        query: string;
+        language: string;
+        type: string;
+    }, never>;
+    update_asset: ai.Tool<{
+        assetId: string;
+        fields: Record<string, never>;
+        language: string;
+        name: string;
+        altText: string;
+    }, never>;
+    upload_asset: ai.Tool<{
+        fileUrl: string;
+        name: string;
+        itemPath: string;
+        language: string;
+        extension: string;
+        siteName: string;
+    }, never>;
+} | {
+    revert_job: ai.Tool<{
+        jobId: string;
+    }, unknown>;
+    get_job: ai.Tool<{
+        jobId: string;
+    }, unknown>;
+    list_operations: ai.Tool<{
+        jobId: string;
+    }, unknown>;
+    get_sites_list: ai.Tool<Record<string, never>, unknown>;
+    get_site_details: ai.Tool<{
+        siteId: string;
+    }, unknown>;
+    get_all_pages_by_site: ai.Tool<{
+        siteName: string;
+        language: string;
+    }, unknown>;
+    get_site_id_from_item: ai.Tool<{
+        itemId: string;
+    }, unknown>;
+    create_personalization_version: ai.Tool<{
+        pageId: string;
+        name: string;
+        variant_name: string;
+        audience_name: string;
+        condition_template_id: string;
+        condition_params: Record<string, never>;
+        language: string;
+    }, {
+        jobId: string;
+    }>;
+    get_personalization_versions_by_page: ai.Tool<{
+        pageId: string;
+    }, unknown>;
+    get_condition_templates: ai.Tool<Record<string, never>, unknown>;
+    get_condition_template_by_id: ai.Tool<{
+        templateId: string;
+    }, unknown>;
+    get_page: ai.Tool<{
+        pageId: string;
+        language: string;
+    }, unknown>;
+    create_page: ai.Tool<{
+        templateId: string;
+        name: string;
+        parentId: string;
+        language: string;
+        fields: Record<string, string | number>[];
+    }, {
+        jobId: string;
+    }>;
+    get_page_template_by_id: ai.Tool<{
+        templateId: string;
+    }, unknown>;
+    get_allowed_components_by_placeholder: ai.Tool<{
+        pageId: string;
+        placeholderName: string;
+        language: string;
+    }, unknown>;
+    get_components_on_page: ai.Tool<{
+        pageId: string;
+        language: string;
+        version: number;
+    }, unknown>;
+    add_component_on_page: ai.Tool<{
+        pageId: string;
+        componentId: string;
+        placeholderPath: string;
+        componentItemName: string;
+        language: string;
+        fields: Record<string, string | number>;
+    }, {
+        jobId: string;
+    }>;
+    set_component_datasource: ai.Tool<{
+        pageId: string;
+        componentId: string;
+        datasourceId: string;
+        language: string;
+    }, {
+        jobId: string;
+    }>;
+    add_language_to_page: ai.Tool<{
+        pageId: string;
+        language: string;
+    }, {
+        jobId: string;
+    }>;
+    search_site: ai.Tool<{
+        search_query: string;
+        site_name: string;
+        language: string;
+    }, unknown>;
+    get_page_path_by_live_url: ai.Tool<{
+        live_url: string;
+    }, unknown>;
+    get_page_screenshot: ai.Tool<{
+        pageId: string;
+        version: number;
+        language: string;
+        width: number;
+        height: number;
+    }, unknown>;
+    get_page_html: ai.Tool<{
+        pageId: string;
+        language: string;
+        version: number;
+    }, unknown>;
+    get_page_preview_url: ai.Tool<{
+        pageId: string;
+        language: string;
+        version: number;
+    }, unknown>;
+    list_languages: ai.Tool<Record<string, never>, unknown>;
+    create_content_item: ai.Tool<{
+        templateId: string;
+        name: string;
+        parentId: string;
+        language: string;
+        fields: Record<string, string | number>;
+    }, {
+        jobId: string;
+    }>;
+    delete_content: ai.Tool<{
+        itemId: string;
+        language: string;
+    }, {
+        jobId: string;
+    }>;
+    get_content_item_by_id: ai.Tool<{
+        itemId: string;
+        language: string;
+    }, unknown>;
+    update_content: ai.Tool<{
+        itemId: string;
+        fields: Record<string, string | number>;
+        language: string;
+        createNewVersion: boolean;
+        siteName: string;
+    }, {
+        jobId: string;
+    }>;
+    get_content_item_by_path: ai.Tool<{
+        item_path: string;
+        failOnNotFound: boolean;
+        language: string;
+    }, unknown>;
+    list_available_insert_options: ai.Tool<{
+        itemId: string;
+        language: string;
+    }, unknown>;
+    create_component_datasource: ai.Tool<{
+        componentId: string;
+        siteName: string;
+        dataFields: Record<string, string | number>;
+        children: Record<string, string | number>[];
+        language: string;
+    }, {
+        jobId: string;
+    }>;
+    search_component_datasources: ai.Tool<{
+        componentId: string;
+        term: string;
+    }, unknown>;
+    list_components: ai.Tool<{
+        site_name: string;
+    }, unknown>;
+    get_component: ai.Tool<{
+        componentId: string;
+    }, unknown>;
+    get_asset_information: ai.Tool<{
+        assetId: string;
+    }, unknown>;
+    search_assets: ai.Tool<{
+        query: string;
+        language: string;
+        type: string;
+    }, unknown>;
+    update_asset: ai.Tool<{
+        assetId: string;
+        fields: Record<string, never>;
+        language: string;
+        name: string;
+        altText: string;
+    }, {
+        jobId: string;
+    }>;
+    upload_asset: ai.Tool<{
+        fileUrl: string;
+        name: string;
+        itemPath: string;
+        language: string;
+        extension: string;
+        siteName: string;
+    }, {
+        jobId: string;
+    }>;
+};
+
+export { type ClientSideContext, type ClientSideTool, type CreateSitecoreToolsOptions, type DefaultToolOptions, type NeedsApproval, type PageBuilderToolName, type PageBuilderToolOptions, type SitecoreToolName, type ToolConfig, createSitecoreTools, executePageBuilderTool, executeSitecoreTool, pageBuilderTools };