Create New Extension

title: My First Extension                          # Human readable title, ideally under 20 characters
version: 0.0.1                                     # Semver compatible version string
description: A small omnitool extension doing stuff
author: omni@example.com                           # Author name or email
origin: https://github.com/user/repository.git     # url to the extensions git repository. This is not required for local extensions not published
client:
  addToWorkbench: false                            # if set to true, the extension will be added to the client's extension menu
dependencies:                                      # Optional field allowing auto installation of yarn packages required by an extensions in the same format as package.json. This is experimental and will likely change
  package: package@stable
packages:

known_extensions:
  - title: 3D Texture Playground                                #Human readable title
    id: omni-extension-texture-playground                       #Extension id
    url: https://raw.githubusercontent.com/user/repository/branchname/extension.yaml #discovery url for the raw extension.yaml file describing the extensions
    ...

function createScript()
{
  return {
    description: "Create a flipbook from the current chat",
    title: "Create Flipboard",
    exec(args){

      let images = [];
        // Find every image in chat
        window.client.chat.state.messages.forEach((msg) => {
          if (msg.attachments && msg.images && msg.images.length > 0) {
            images= images.concat(msg.images.map((img) => {
              return img.url
            }))
          }
        })
        window.client.workbench.showExtension("omni-extension-flipbook", {images: images});
        // One could also open the extension in a separate window:
        // window.open(`./extensions/omni-extension-flipbook/?images=${encodeURIComponent(JSON.stringify(images))}`, '_blank', 'popup=1,toolbar=0,location=0,menubar=0');
        window.client.sendSystemMessage(`Flipbook created, please check the extensions tab`, "text/markdown",
        {
          commands:
          [
            {
              title: 'Show Flipbook',
              id: 'toggleExtensions',
              args: []
            }
          ]
        });
        return true;
    }
  }
}

      const args = new URLSearchParams(location.search)
      const params = JSON.parse(args.get('q'))

      if (params.images) {
        images.value = params.images
      }

const blocks = []

const extensionHooks = {}

const blockFactory = (FactoryFn) =>
{
  blocks.map((c) => FactoryFn(c.schema, c.functions))
}
export default {hooks: extensionHooks, createComponents: blockFactory}

// ServerExtensionManager.ts
enum PERMITTED_EXTENSIONS_EVENTS
{
  'pre_request_execute'   = 'pre_request_execute',      // runs each time a block is preparing to execute it's underlying API call allowing manipulation of the outgoing call. Arg
  'post_request_execute'  = 'post_request_execute',     // runs each time a block has executed it's underlying API call, allowing manipulation of the result
  'component:x-input'     = 'component:x-input',        // runs each time a chat input block processes it's payload. Args:  (ctx, payload). Allows modification of payload
  'jobs.job_started'      = 'job_started',              // runs each time a workflow / job has started executing
  'jobs.job_finished'     = 'job_finished',             // runs each time a workflow / job has stopped executing
  'jobs.pre_workflow_start' = 'job_pre_start'           // runs each time a workflow is prepping execution, allowing it to be cancelled. Args: (workflow, workflow_context, ctx, actions). Set actions.cancel to true to abort execution, set actions.cancelReason to a string to return a specific cancellation reason to the user.
  'registry.package_installed': 'package_installed' //{ omniPackage:string, installationId, orgId, customBaseUrl, duration: (end - start).toFixed() })
}

const extensionHooks = {

  // An basic interceptor that replaces any chat input containing something like an email addresses with a simple replacement
  // This runs on any chat input
  'component:x-input': function(ctx, payload)
  {
    if (payload.text != null && typeof(payload.text) === 'string')
    {
      payload.text = payload.text.replace(\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}\b, "example@example.com")
    }
  },


  // Prevent any workflow from starting if the text input has the word clown
  // This runs every time a workflow starts
  'job_pre_start': function(ctx, workflow, workflow_context, actions)
  {
    console.log('job_pre_start pii scrubber', workflow_context.args)

    if (workflow_context.args ?? workflow_context.args.text?.includes("clown"))
    {
      actions.cancel = true
      actions.cancelReason = "N0 clowns allowed"
    }
  }
}

const MyCustomBlock =
 {
    schema:                                                   // <-- OpenAPI 3 Schema
    {
      // Namespace is automatically set to the extension id
      "tags": ['default'],
      "componentKey": "my-first-block",                       // <-- unique id within the namespace
      //"apiKey": "my-first-block",                           // <-- optional, set to the 'parent' API if this is a normal rest component (not supported yet)
      "operation": {
        // operationId is automatically set to componentKey
        "schema": {
          "title": "My First Block",                          // <-- componentn title
          "type": "object",
          required:[],
          "properties": {
            "text": {
              "title": "Some Text Input",
              "type": "string",                                // <-- openAPI type
              "x-type": "text",                                // <-- custom omnitool socket type if wanted
              "default": "my default value",
              "description": `My block description`
            }
          },
        },
        "responseTypes": {
          "200": {
            "schema": {
              "required": [
                "text"
              ],
              "type": "string",
              "properties": {
                "text": {
                  "title": "My Output Text",
                  "type": "string",
                },
              },
            },
            "contentType": "application/json"
          },
        },
        "method": "X-CUSTOM"                          // <-- This is important
      },
      patch:                                          // <-- optional omnitool patch block
      {
        "title": "My Custom Component",              /// <-- component
        "category": "Test",
        "summary": "Replaces Cars with Horses",
        "meta":
        {
          "source":
          {
            "summary": "Replaces cars with horses",
            links:
            {
              // list of string: string fields that are rendered as urls.
              "research papaer": "https://arxiv.org..."
            }
          }
        },
        inputs: {...},
        controls: {...}
        outputs: {...}
      }
    },
    functions: {
      _exec: async (payload, ctx) =>                           // <--  The _exec function is invoked when the component is run
      {
        if (payload.text)
        {
          payload.text = payload.text.replace("car", "horse" )
        }
        return payload                                       // <-- Do not forget to return the altered payload
      }
    }
  }

let blocks = [MyCustomBlock]

export default (FactoryFn: any) =>
{
  return components.map((c) => FactoryFn(c.schema, c.functions))
}