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

package/src/models.ts

@@ -2,44 +2,39 @@
  * Types of parameters supported by Opal tools
  */
 export enum ParameterType {
-  String = 'string',
-  Integer = 'integer',
-  Number = 'number',
-  Boolean = 'boolean',
-  List = 'array',
-  Dictionary = 'object'
+  Boolean = "boolean",
+  Dictionary = "object",
+  Integer = "integer",
+  List = "array",
+  Number = "number",
+  String = "string",
 }
 
 /**
- * Parameter definition for an Opal tool
+ * Authentication data for an Opal tool
  */
-export 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(
-    public name: string,
-    public type: ParameterType,
-    public description: string,
-    public required: boolean
-  ) {}
+export type AuthData = {
+  credentials: Credentials;
+  provider: string;
+};
 
-  /**
-   * Convert to JSON for the discovery endpoint
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      type: this.type,
-      description: this.description,
-      required: this.required
-    };
-  }
-}
+/**
+ * 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,7 +49,7 @@ export class AuthRequirement {
   constructor(
     public provider: string,
     public scopeBundle: string,
-    public required: boolean = true
+    public required: boolean = true,
   ) {}
 
   /**
@@ -63,8 +58,8 @@ export class AuthRequirement {
   toJSON() {
     return {
       provider: this.provider,
+      required: this.required,
       scope_bundle: this.scopeBundle,
-      required: this.required
     };
   }
 }
@@ -76,7 +71,7 @@ export class Function {
   /**
    * HTTP method for the endpoint (default: POST)
    */
-  public httpMethod: string = 'POST';
+  public httpMethod: string = "POST";
 
   /**
    * Create a new function definition
@@ -85,29 +80,38 @@ export 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(
     public name: string,
     public description: string,
     public parameters: Parameter[],
     public endpoint: string,
-    public authRequirements?: AuthRequirement[]
+    public authRequirements?: AuthRequirement[],
+    public uiResource?: string,
   ) {}
 
   /**
    * Convert to JSON for the discovery endpoint
    */
   toJSON() {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const result: any = {
-      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;
@@ -115,51 +119,23 @@ export class Function {
 }
 
 /**
- * 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
- */
-export type Environment = {
-  execution_mode: "headless" | "interactive";
-}
-
-/**
- * Island field definition for interactive UI components
+ * Island action definition for interactive UI components
  */
-export class IslandField {
+export 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(
     public name: string,
     public label: string,
-    public type: "string" | "boolean" | "json",
-    public value: string = "",
-    public hidden: boolean = false,
-    public options: string[] = []
+    public type: string,
+    public endpoint: string,
+    public operation: string = "create",
   ) {}
 
   /**
@@ -167,34 +143,35 @@ export class IslandField {
    */
   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,
     };
   }
 }
 
 /**
- * Island action definition for interactive UI components
+ * Island field definition for interactive UI components
  */
-export class IslandAction {
+export 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(
     public name: string,
     public label: string,
-    public type: string,
-    public endpoint: string,
-    public operation: string = "create"
+    public type: "boolean" | "json" | "string",
+    public value: string = "",
+    public hidden: boolean = false,
+    public options: string[] = [],
   ) {}
 
   /**
@@ -202,11 +179,12 @@ export class IslandAction {
    */
   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,
     };
   }
 }
@@ -215,8 +193,8 @@ export class IslandAction {
  * Island configuration for interactive UI components
  */
 export class IslandConfig {
-  static Field = IslandField;
   static Action = IslandAction;
+  static Field = IslandField;
 
   /**
    * Create a new island configuration
@@ -229,7 +207,7 @@ export class IslandConfig {
     public fields: IslandField[],
     public actions: IslandAction[],
     public type?: string,
-    public icon?: string
+    public icon?: string,
   ) {}
 
   /**
@@ -237,8 +215,8 @@ export 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()),
     };
   }
 }
@@ -269,7 +247,7 @@ export class IslandResponseConfig {
 export class IslandResponse {
   static ResponseConfig = IslandResponseConfig;
 
-  public type: "island" = "island";
+  public type = "island" as const;
 
   /**
    * Create a new island response
@@ -278,7 +256,7 @@ export class IslandResponse {
    */
   constructor(
     public config: IslandResponseConfig,
-    public message?: string
+    public message?: string,
   ) {}
 
   /**
@@ -300,3 +278,55 @@ export class IslandResponse {
     };
   }
 }
+
+/**
+ * Parameter definition for an Opal tool
+ */
+export 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(
+    public name: string,
+    public type: ParameterType,
+    public description: string,
+    public required: boolean,
+  ) {}
+
+  /**
+   * Convert to JSON for the discovery endpoint
+   */
+  toJSON() {
+    return {
+      description: this.description,
+      name: this.name,
+      required: this.required,
+      type: this.type,
+    };
+  }
+}
+
+/**
+ * Resource definition for MCP resources
+ */
+export 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(
+    public uri: string,
+    public name: string,
+    public description?: string,
+    public mimeType?: string,
+    public title?: string,
+  ) {}
+}