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

package/README.md

@@ -215,7 +215,9 @@ async function getWeather(parameters: WeatherParameters) {
         '/tools/get_weather',
         'update'
       )
-    ]
+    ],
+    'button',  // Optional island type
+    'plus'     // Optional island icon
   );
   
   return IslandResponse.create([island]);
@@ -245,6 +247,8 @@ Actions represent buttons or operations:
 Contains the complete island configuration:
 - `fields`: Array of IslandConfig.Field objects
 - `actions`: Array of IslandConfig.Action objects
+- `type`: Optional island type for custom rendering (optional)
+- `icon`: Optional icon identifier for the island (optional)
 
 #### IslandResponse
 The response wrapper for islands:

package/dist/models.d.ts

@@ -175,14 +175,18 @@ export declare class IslandAction {
 export declare class IslandConfig {
     fields: IslandField[];
     actions: IslandAction[];
+    type?: string | undefined;
+    icon?: string | undefined;
     static Field: typeof IslandField;
     static Action: typeof IslandAction;
     /**
      * 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
      */
@@ -242,19 +246,22 @@ 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
      */

package/dist/models.js

@@ -188,10 +188,14 @@ class IslandConfig {
      * 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, actions) {
+    constructor(fields, actions, type, icon) {
         this.fields = fields;
         this.actions = actions;
+        this.type = type;
+        this.icon = icon;
     }
     /**
      * Convert to JSON for the discovery endpoint
@@ -234,18 +238,21 @@ class IslandResponse {
     /**
      * Create a new island response
      * @param config Response configuration
+     * @param message Optional message for the island response
      */
-    constructor(config) {
+    constructor(config, message) {
         this.config = config;
+        this.message = message;
         this.type = "island";
     }
     /**
      * 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) {
-        return new IslandResponse(new IslandResponseConfig(islands));
+    static create(islands, message) {
+        return new IslandResponse(new IslandResponseConfig(islands), message);
     }
     /**
      * Convert to JSON for the discovery endpoint

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optimizely-opal/opal-tools-sdk",
-  "version": "0.1.3-dev",
+  "version": "0.1.5-dev",
   "description": "SDK for creating Opal-compatible tools services",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,19 +19,18 @@
   "author": "Optimizely",
   "license": "MIT",
   "dependencies": {
-    "express": "^4.18.2",
-    "axios": "^1.6.0",
     "reflect-metadata": "^0.1.13"
   },
   "devDependencies": {
-    "@types/express": "^4.17.17",
     "@types/jest": "^29.5.3",
-    "@types/node": "^20.4.5",
     "jest": "^29.6.2",
-    "ts-jest": "^29.1.1",
-    "typescript": "^5.1.6"
+    "ts-jest": "^29.1.1"
   },
   "peerDependencies": {
+    "typescript": "^5.1.6",
+    "@types/node": "^20.4.5",
+    "@types/express": "^4.17.17",
+    "axios": "^1.6.0",
     "express": "^4.18.2"
   },
   "repository": {

package/src/models.ts

@@ -222,10 +222,14 @@ export class IslandConfig {
    * 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(
     public fields: IslandField[],
-    public actions: IslandAction[]
+    public actions: IslandAction[],
+    public type?: string,
+    public icon?: string
   ) {}
 
   /**
@@ -270,16 +274,21 @@ export class IslandResponse {
   /**
    * Create a new island response
    * @param config Response configuration
+   * @param message Optional message for the island response
    */
-  constructor(public config: IslandResponseConfig) {}
+  constructor(
+    public config: IslandResponseConfig,
+    public message?: string
+  ) {}
 
   /**
    * 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 {
-    return new IslandResponse(new IslandResponseConfig(islands));
+  static create(islands: IslandConfig[], message?: string): IslandResponse {
+    return new IslandResponse(new IslandResponseConfig(islands), message);
   }
 
   /**