@optimizely-opal/opal-tools-sdk 0.1.3-dev → 0.1.6-dev

package/dist/block.js

@@ -0,0 +1,104 @@
+"use strict";
+/**
+ * Generated by json-schema-to-typescript
+ * DO NOT MODIFY - This file is auto-generated from block-document-spec.json
+ * Run 'npm run generate:block' to regenerate
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Block = void 0;
+exports.isBlockResponse = isBlockResponse;
+/**
+ * Builder namespace for Adaptive Block Document components.
+ *
+ * Usage:
+ *   Block.Document({ children: [...] })
+ *   Block.Heading({ children: "Title", level: "2" })
+ *   Block.Input({ name: "field_name", placeholder: "Enter..." })
+ */
+exports.Block = {
+    Action: (props) => ({
+        $type: "Block.Action",
+        ...props,
+    }),
+    Alert: (props) => ({
+        $type: "Block.Alert",
+        ...props,
+    }),
+    Badge: (props) => ({
+        $type: "Block.Badge",
+        ...props,
+    }),
+    Box: (props) => ({
+        $type: "Block.Box",
+        ...props,
+    }),
+    CancelAction: (props) => ({ $type: "Block.CancelAction", ...props }),
+    Checkbox: (props) => ({
+        $type: "Block.Checkbox",
+        ...props,
+    }),
+    Code: (props) => ({
+        $type: "Block.Code",
+        ...props,
+    }),
+    Document: (props) => ({
+        $type: "Block.Document",
+        ...props,
+    }),
+    Field: (props) => ({
+        $type: "Block.Field",
+        ...props,
+    }),
+    Group: (props) => ({
+        $type: "Block.Group",
+        ...props,
+    }),
+    Heading: (props) => ({
+        $type: "Block.Heading",
+        ...props,
+    }),
+    Input: (props) => ({
+        $type: "Block.Input",
+        ...props,
+    }),
+    Link: (props) => ({
+        $type: "Block.Link",
+        ...props,
+    }),
+    Range: (props) => ({
+        $type: "Block.Range",
+        ...props,
+    }),
+    Select: (props) => ({
+        $type: "Block.Select",
+        ...props,
+    }),
+    Separator: (props) => ({
+        $type: "Block.Separator",
+        ...props,
+    }),
+    Switch: (props) => ({
+        $type: "Block.Switch",
+        ...props,
+    }),
+    Text: (props) => ({
+        $type: "Block.Text",
+        ...props,
+    }),
+    Textarea: (props) => ({
+        $type: "Block.Textarea",
+        ...props,
+    }),
+};
+/**
+ * Type guard to check if a value is a BlockResponse.
+ */
+function isBlockResponse(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        ("content" in value ||
+            "data" in value ||
+            "artifact" in value ||
+            "rollback" in value ||
+            "error" in value));
+}

package/dist/decorators.d.ts

@@ -1,20 +1,20 @@
-import 'reflect-metadata';
-import { ParameterType } from './models';
+import "reflect-metadata";
+import { ParameterType } from "./models";
 interface ParameterDefinition {
-    name: string;
-    type: ParameterType;
     description: string;
+    name: string;
     required: boolean;
+    type: ParameterType;
 }
 interface ToolOptions {
-    name: string;
-    description: string;
-    parameters?: ParameterDefinition[];
     authRequirements?: {
         provider: string;
-        scopeBundle: string;
         required?: boolean;
+        scopeBundle: string;
     };
+    description: string;
+    name: string;
+    parameters?: ParameterDefinition[];
 }
 /**
  * Decorator to register a function as an Opal tool

package/dist/decorators.js

@@ -1,50 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tool = tool;
+/* eslint-disable @typescript-eslint/no-explicit-any */
 require("reflect-metadata");
 const models_1 = require("./models");
 const registry_1 = require("./registry");
-/**
- * Map a TypeScript type to a ParameterType
- * @param type TypeScript type
- */
-function mapTypeToParameterType(type) {
-    if (type === String || type.name === 'String') {
-        return models_1.ParameterType.String;
-    }
-    else if (type === Number || type.name === 'Number') {
-        return models_1.ParameterType.Number;
-    }
-    else if (type === Boolean || type.name === 'Boolean') {
-        return models_1.ParameterType.Boolean;
-    }
-    else if (type === Array || type.name === 'Array') {
-        return models_1.ParameterType.List;
-    }
-    else if (type === Object || type.name === 'Object') {
-        return models_1.ParameterType.Dictionary;
-    }
-    // Default to string
-    return models_1.ParameterType.String;
-}
-/**
- * Extract parameters from a TypeScript interface
- * @param paramType Parameter type object
- */
-function extractParameters(paramType) {
-    const parameters = [];
-    // This is very basic and doesn't handle complex types
-    // For production use, this would need to be more sophisticated
-    for (const key in paramType) {
-        if (paramType.hasOwnProperty(key)) {
-            const type = typeof paramType[key] === 'undefined' ? String : paramType[key].constructor;
-            const required = true; // In a real implementation, we'd detect optional parameters
-            parameters.push(new models_1.Parameter(key, mapTypeToParameterType(type), '', // Description - in a real impl we'd use TypeDoc or similar
-            required));
-        }
-    }
-    return parameters;
-}
 /**
  * Decorator to register a function as an Opal tool
  * @param options Tool options including:
@@ -66,7 +26,7 @@ function tool(options) {
         const isMethod = propertyKey && descriptor;
         const handler = isMethod ? descriptor.value : target;
         // Generate endpoint from name - ensure hyphens instead of underscores
-        const endpoint = `/tools/${options.name.replace(/_/g, '-')}`;
+        const endpoint = `/tools/${options.name.replace(/_/g, "-")}`;
         // Convert parameter definitions to Parameter objects
         const parameters = [];
         if (options.parameters && options.parameters.length > 0) {
@@ -79,7 +39,7 @@ function tool(options) {
         let authRequirements;
         if (options.authRequirements) {
             authRequirements = [
-                new models_1.AuthRequirement(options.authRequirements.provider, options.authRequirements.scopeBundle, options.authRequirements.required ?? true)
+                new models_1.AuthRequirement(options.authRequirements.provider, options.authRequirements.scopeBundle, options.authRequirements.required ?? true),
             ];
         }
         // Register the tool with all services

package/dist/index.d.ts

@@ -1,5 +1,9 @@
-import 'reflect-metadata';
-export { ToolsService } from './service';
-export { tool } from './decorators';
-export { requiresAuth } from './auth';
-export * from './models';
+import "reflect-metadata";
+export { requiresAuth } from "./auth";
+export { Block, isBlockResponse } from "./block";
+export type * from "./block";
+export { tool } from "./decorators";
+export * from "./models";
+export { registerTool } from "./registerTool";
+export type { RequestHandlerExtra } from "./registerTool";
+export { ToolsService } from "./service";

package/dist/index.js

@@ -14,12 +14,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.requiresAuth = exports.tool = exports.ToolsService = void 0;
+exports.ToolsService = exports.registerTool = exports.tool = exports.isBlockResponse = exports.Block = exports.requiresAuth = void 0;
 require("reflect-metadata");
-var service_1 = require("./service");
-Object.defineProperty(exports, "ToolsService", { enumerable: true, get: function () { return service_1.ToolsService; } });
-var decorators_1 = require("./decorators");
-Object.defineProperty(exports, "tool", { enumerable: true, get: function () { return decorators_1.tool; } });
 var auth_1 = require("./auth");
 Object.defineProperty(exports, "requiresAuth", { enumerable: true, get: function () { return auth_1.requiresAuth; } });
+var block_1 = require("./block");
+Object.defineProperty(exports, "Block", { enumerable: true, get: function () { return block_1.Block; } });
+Object.defineProperty(exports, "isBlockResponse", { enumerable: true, get: function () { return block_1.isBlockResponse; } });
+var decorators_1 = require("./decorators");
+Object.defineProperty(exports, "tool", { enumerable: true, get: function () { return decorators_1.tool; } });
 __exportStar(require("./models"), exports);
+var registerTool_1 = require("./registerTool");
+Object.defineProperty(exports, "registerTool", { enumerable: true, get: function () { return registerTool_1.registerTool; } });
+var service_1 = require("./service");
+Object.defineProperty(exports, "ToolsService", { enumerable: true, get: function () { return service_1.ToolsService; } });

package/dist/models.d.ts

@@ -2,39 +2,36 @@
  * Types of parameters supported by Opal tools
  */
 export declare enum ParameterType {
-    String = "string",
-    Integer = "integer",
-    Number = "number",
     Boolean = "boolean",
+    Dictionary = "object",
+    Integer = "integer",
     List = "array",
-    Dictionary = "object"
+    Number = "number",
+    String = "string"
 }
 /**
- * Parameter definition for an Opal tool
+ * Authentication data for an Opal tool
  */
-export declare class Parameter {
-    name: string;
-    type: ParameterType;
-    description: string;
-    required: boolean;
-    /**
-     * Create a new parameter definition
-     * @param name Parameter name
-     * @param type Parameter type
-     * @param description Parameter description
-     * @param required Whether the parameter is required
-     */
-    constructor(name: string, type: ParameterType, description: string, required: boolean);
-    /**
-     * Convert to JSON for the discovery endpoint
-     */
-    toJSON(): {
-        name: string;
-        type: ParameterType;
-        description: string;
-        required: boolean;
-    };
-}
+export type AuthData = {
+    credentials: Credentials;
+    provider: string;
+};
+/**
+ * Authentication credentials structure
+ */
+export type Credentials = {
+    access_token: string;
+    customer_id: string;
+    instance_id: string;
+    org_sso_id?: string;
+    product_sku: string;
+};
+/**
+ * Execution environment for an Opal tool
+ */
+export type Environment = {
+    execution_mode: "headless" | "interactive";
+};
 /**
  * Authentication requirements for an Opal tool
  */
@@ -54,8 +51,8 @@ export declare class AuthRequirement {
      */
     toJSON(): {
         provider: string;
-        scope_bundle: string;
         required: boolean;
+        scope_bundle: string;
     };
 }
 /**
@@ -86,35 +83,41 @@ export declare class Function {
     toJSON(): any;
 }
 /**
- * Authentication credentials structure
- */
-export type Credentials = {
-    access_token: string;
-    org_sso_id?: string;
-    customer_id: string;
-    instance_id: string;
-    product_sku: string;
-};
-/**
- * Authentication data for an Opal tool
- */
-export type AuthData = {
-    provider: string;
-    credentials: Credentials;
-};
-/**
- * Execution environment for an Opal tool
+ * Island action definition for interactive UI components
  */
-export type Environment = {
-    execution_mode: "headless" | "interactive";
-};
+export declare class IslandAction {
+    name: string;
+    label: string;
+    type: string;
+    endpoint: string;
+    operation: string;
+    /**
+     * Create a new island action
+     * @param name Programmatic action identifier
+     * @param label Human-readable button label
+     * @param type UI element type
+     * @param endpoint API endpoint to call
+     * @param operation Operation type
+     */
+    constructor(name: string, label: string, type: string, endpoint: string, operation?: string);
+    /**
+     * Convert to JSON for the discovery endpoint
+     */
+    toJSON(): {
+        endpoint: string;
+        label: string;
+        name: string;
+        operation: string;
+        type: string;
+    };
+}
 /**
  * Island field definition for interactive UI components
  */
 export declare class IslandField {
     name: string;
     label: string;
-    type: "string" | "boolean" | "json";
+    type: "boolean" | "json" | "string";
     value: string;
     hidden: boolean;
     options: string[];
@@ -127,46 +130,17 @@ export declare class IslandField {
      * @param hidden Whether to hide from user
      * @param options Available options for selection
      */
-    constructor(name: string, label: string, type: "string" | "boolean" | "json", value?: string, hidden?: boolean, options?: string[]);
+    constructor(name: string, label: string, type: "boolean" | "json" | "string", value?: string, hidden?: boolean, options?: string[]);
     /**
      * Convert to JSON for the discovery endpoint
      */
     toJSON(): {
-        name: string;
+        hidden: boolean;
         label: string;
+        name: string;
+        options: string[];
         type: "string" | "boolean" | "json";
         value: string;
-        hidden: boolean;
-        options: string[];
-    };
-}
-/**
- * Island action definition for interactive UI components
- */
-export declare class IslandAction {
-    name: string;
-    label: string;
-    type: string;
-    endpoint: string;
-    operation: string;
-    /**
-     * Create a new island action
-     * @param name Programmatic action identifier
-     * @param label Human-readable button label
-     * @param type UI element type
-     * @param endpoint API endpoint to call
-     * @param operation Operation type
-     */
-    constructor(name: string, label: string, type: string, endpoint: string, operation?: string);
-    /**
-     * Convert to JSON for the discovery endpoint
-     */
-    toJSON(): {
-        name: string;
-        label: string;
-        type: string;
-        endpoint: string;
-        operation: string;
     };
 }
 /**
@@ -175,32 +149,36 @@ export declare class IslandAction {
 export declare class IslandConfig {
     fields: IslandField[];
     actions: IslandAction[];
-    static Field: typeof IslandField;
+    type?: string | undefined;
+    icon?: string | undefined;
     static Action: typeof IslandAction;
+    static Field: typeof IslandField;
     /**
      * Create a new island configuration
      * @param fields List of island fields
      * @param actions List of island actions
+     * @param type Optional island type
+     * @param icon Optional island icon
      */
-    constructor(fields: IslandField[], actions: IslandAction[]);
+    constructor(fields: IslandField[], actions: IslandAction[], type?: string | undefined, icon?: string | undefined);
     /**
      * Convert to JSON for the discovery endpoint
      */
     toJSON(): {
-        fields: {
+        actions: {
+            endpoint: string;
+            label: string;
             name: string;
+            operation: string;
+            type: string;
+        }[];
+        fields: {
+            hidden: boolean;
             label: string;
+            name: string;
+            options: string[];
             type: "string" | "boolean" | "json";
             value: string;
-            hidden: boolean;
-            options: string[];
-        }[];
-        actions: {
-            name: string;
-            label: string;
-            type: string;
-            endpoint: string;
-            operation: string;
         }[];
     };
 }
@@ -219,20 +197,20 @@ export declare class IslandResponseConfig {
      */
     toJSON(): {
         islands: {
-            fields: {
+            actions: {
+                endpoint: string;
+                label: string;
                 name: string;
+                operation: string;
+                type: string;
+            }[];
+            fields: {
+                hidden: boolean;
                 label: string;
+                name: string;
+                options: string[];
                 type: "string" | "boolean" | "json";
                 value: string;
-                hidden: boolean;
-                options: string[];
-            }[];
-            actions: {
-                name: string;
-                label: string;
-                type: string;
-                endpoint: string;
-                operation: string;
             }[];
         }[];
     };
@@ -242,41 +220,70 @@ export declare class IslandResponseConfig {
  */
 export declare class IslandResponse {
     config: IslandResponseConfig;
+    message?: string | undefined;
     static ResponseConfig: typeof IslandResponseConfig;
     type: "island";
     /**
      * Create a new island response
      * @param config Response configuration
+     * @param message Optional message for the island response
      */
-    constructor(config: IslandResponseConfig);
+    constructor(config: IslandResponseConfig, message?: string | undefined);
     /**
      * Create an island response with a list of islands
      * @param islands List of island configurations
+     * @param message Optional message for the island response
      * @returns New IslandResponse instance
      */
-    static create(islands: IslandConfig[]): IslandResponse;
+    static create(islands: IslandConfig[], message?: string): IslandResponse;
     /**
      * Convert to JSON for the discovery endpoint
      */
     toJSON(): {
         config: {
             islands: {
-                fields: {
+                actions: {
+                    endpoint: string;
+                    label: string;
                     name: string;
+                    operation: string;
+                    type: string;
+                }[];
+                fields: {
+                    hidden: boolean;
                     label: string;
+                    name: string;
+                    options: string[];
                     type: "string" | "boolean" | "json";
                     value: string;
-                    hidden: boolean;
-                    options: string[];
-                }[];
-                actions: {
-                    name: string;
-                    label: string;
-                    type: string;
-                    endpoint: string;
-                    operation: string;
                 }[];
             }[];
         };
     };
 }
+/**
+ * Parameter definition for an Opal tool
+ */
+export declare class Parameter {
+    name: string;
+    type: ParameterType;
+    description: string;
+    required: boolean;
+    /**
+     * Create a new parameter definition
+     * @param name Parameter name
+     * @param type Parameter type
+     * @param description Parameter description
+     * @param required Whether the parameter is required
+     */
+    constructor(name: string, type: ParameterType, description: string, required: boolean);
+    /**
+     * Convert to JSON for the discovery endpoint
+     */
+    toJSON(): {
+        description: string;
+        name: string;
+        required: boolean;
+        type: ParameterType;
+    };
+}