@optimizely-opal/opal-tools-sdk 0.1.5-dev → 0.1.8-dev

package/dist/models.js

@@ -1,48 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IslandResponse = exports.IslandResponseConfig = exports.IslandConfig = exports.IslandAction = exports.IslandField = exports.Function = exports.AuthRequirement = exports.Parameter = exports.ParameterType = void 0;
+exports.Resource = exports.Parameter = exports.IslandResponse = exports.IslandResponseConfig = exports.IslandConfig = exports.IslandField = exports.IslandAction = exports.Function = exports.AuthRequirement = exports.ParameterType = void 0;
 /**
  * Types of parameters supported by Opal tools
  */
 var ParameterType;
 (function (ParameterType) {
-    ParameterType["String"] = "string";
-    ParameterType["Integer"] = "integer";
-    ParameterType["Number"] = "number";
     ParameterType["Boolean"] = "boolean";
-    ParameterType["List"] = "array";
     ParameterType["Dictionary"] = "object";
+    ParameterType["Integer"] = "integer";
+    ParameterType["List"] = "array";
+    ParameterType["Number"] = "number";
+    ParameterType["String"] = "string";
 })(ParameterType || (exports.ParameterType = ParameterType = {}));
-/**
- * Parameter definition for an Opal tool
- */
-class Parameter {
-    /**
-     * 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, type, description, required) {
-        this.name = name;
-        this.type = type;
-        this.description = description;
-        this.required = required;
-    }
-    /**
-     * Convert to JSON for the discovery endpoint
-     */
-    toJSON() {
-        return {
-            name: this.name,
-            type: this.type,
-            description: this.description,
-            required: this.required
-        };
-    }
-}
-exports.Parameter = Parameter;
 /**
  * Authentication requirements for an Opal tool
  */
@@ -64,8 +34,8 @@ class AuthRequirement {
     toJSON() {
         return {
             provider: this.provider,
+            required: this.required,
             scope_bundle: this.scopeBundle,
-            required: this.required
         };
     }
 }
@@ -81,105 +51,111 @@ class Function {
      * @param parameters Function parameters
      * @param endpoint API endpoint
      * @param authRequirements Authentication requirements (optional)
+     * @param uiResource URI of associated UI resource for dynamic rendering (optional)
      */
-    constructor(name, description, parameters, endpoint, authRequirements) {
+    constructor(name, description, parameters, endpoint, authRequirements, uiResource) {
         this.name = name;
         this.description = description;
         this.parameters = parameters;
         this.endpoint = endpoint;
         this.authRequirements = authRequirements;
+        this.uiResource = uiResource;
         /**
          * HTTP method for the endpoint (default: POST)
          */
-        this.httpMethod = 'POST';
+        this.httpMethod = "POST";
     }
     /**
      * Convert to JSON for the discovery endpoint
      */
     toJSON() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const result = {
-            name: this.name,
             description: this.description,
-            parameters: this.parameters.map(p => p.toJSON()),
             endpoint: this.endpoint,
-            http_method: this.httpMethod
+            http_method: this.httpMethod,
+            name: this.name,
+            parameters: this.parameters.map((p) => p.toJSON()),
         };
         if (this.authRequirements && this.authRequirements.length > 0) {
-            result.auth_requirements = this.authRequirements.map(auth => auth.toJSON());
+            result.auth_requirements = this.authRequirements.map((auth) => auth.toJSON());
+        }
+        if (this.uiResource !== undefined) {
+            result.ui_resource = this.uiResource;
         }
         return result;
     }
 }
 exports.Function = Function;
 /**
- * Island field definition for interactive UI components
+ * Island action definition for interactive UI components
  */
-class IslandField {
+class IslandAction {
     /**
-     * Create a new island field
-     * @param name Programmatic field identifier
-     * @param label Human-readable label
-     * @param type Field type
-     * @param value Current field value
-     * @param hidden Whether to hide from user
-     * @param options Available options for selection
+     * 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, label, type, value = "", hidden = false, options = []) {
+    constructor(name, label, type, endpoint, operation = "create") {
         this.name = name;
         this.label = label;
         this.type = type;
-        this.value = value;
-        this.hidden = hidden;
-        this.options = options;
+        this.endpoint = endpoint;
+        this.operation = operation;
     }
     /**
      * Convert to JSON for the discovery endpoint
      */
     toJSON() {
         return {
-            name: this.name,
+            endpoint: this.endpoint,
             label: this.label,
+            name: this.name,
+            operation: this.operation,
             type: this.type,
-            value: this.value,
-            hidden: this.hidden,
-            options: this.options,
         };
     }
 }
-exports.IslandField = IslandField;
+exports.IslandAction = IslandAction;
 /**
- * Island action definition for interactive UI components
+ * Island field definition for interactive UI components
  */
-class IslandAction {
+class IslandField {
     /**
-     * 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
+     * Create a new island field
+     * @param name Programmatic field identifier
+     * @param label Human-readable label
+     * @param type Field type
+     * @param value Current field value
+     * @param hidden Whether to hide from user
+     * @param options Available options for selection
      */
-    constructor(name, label, type, endpoint, operation = "create") {
+    constructor(name, label, type, value = "", hidden = false, options = []) {
         this.name = name;
         this.label = label;
         this.type = type;
-        this.endpoint = endpoint;
-        this.operation = operation;
+        this.value = value;
+        this.hidden = hidden;
+        this.options = options;
     }
     /**
      * Convert to JSON for the discovery endpoint
      */
     toJSON() {
         return {
-            name: this.name,
+            hidden: this.hidden,
             label: this.label,
+            name: this.name,
+            options: this.options,
             type: this.type,
-            endpoint: this.endpoint,
-            operation: this.operation,
+            value: this.value,
         };
     }
 }
-exports.IslandAction = IslandAction;
+exports.IslandField = IslandField;
 /**
  * Island configuration for interactive UI components
  */
@@ -202,14 +178,14 @@ class IslandConfig {
      */
     toJSON() {
         return {
-            fields: this.fields.map((field) => field.toJSON()),
             actions: this.actions.map((action) => action.toJSON()),
+            fields: this.fields.map((field) => field.toJSON()),
         };
     }
 }
 exports.IslandConfig = IslandConfig;
-IslandConfig.Field = IslandField;
 IslandConfig.Action = IslandAction;
+IslandConfig.Field = IslandField;
 /**
  * Island response configuration
  */
@@ -265,3 +241,54 @@ class IslandResponse {
 }
 exports.IslandResponse = IslandResponse;
 IslandResponse.ResponseConfig = IslandResponseConfig;
+/**
+ * Parameter definition for an Opal tool
+ */
+class Parameter {
+    /**
+     * 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, type, description, required) {
+        this.name = name;
+        this.type = type;
+        this.description = description;
+        this.required = required;
+    }
+    /**
+     * Convert to JSON for the discovery endpoint
+     */
+    toJSON() {
+        return {
+            description: this.description,
+            name: this.name,
+            required: this.required,
+            type: this.type,
+        };
+    }
+}
+exports.Parameter = Parameter;
+/**
+ * Resource definition for MCP resources
+ */
+class Resource {
+    /**
+     * Create a new resource definition
+     * @param uri The unique URI for this resource (e.g., "ui://my-app/create-form")
+     * @param name Name of the resource
+     * @param description Description of the resource (optional)
+     * @param mimeType MIME type of the resource content (optional)
+     * @param title Human-readable title for the resource (optional)
+     */
+    constructor(uri, name, description, mimeType, title) {
+        this.uri = uri;
+        this.name = name;
+        this.description = description;
+        this.mimeType = mimeType;
+        this.title = title;
+    }
+}
+exports.Resource = Resource;