app_bridge 3.0.0 → 4.0.0

data/ext/app_bridge/wit/v4/world.wit

@@ -0,0 +1,328 @@
+package standout:app@4.0.0;
+
+interface types {
+  // The trigger-store is a string that is used to store data between trigger
+  // invocations. It is unique per trigger instance and is persisted between
+  // invocations.
+  //
+  // You can store any string here. We suggest that you use a serialized
+  // JSON object or similar since that will give you some flexibility if you
+  // need to add more data to the store.
+  type trigger-store = string;
+
+  record connection {
+    id: string,
+    name: string,
+    // The connection data is a JSON object serialized into a string. The JSON root
+    // will always be an object.
+    serialized-data: string,
+  }
+
+  record trigger-context {
+    // Trigger ID is a unique identifier for the trigger that is requested to be
+    // invoked.
+    trigger-id: string,
+
+    // The connection that the trigger is invoked for.
+    // Connection is required for all trigger operations.
+    connection: connection,
+
+    // The store will contain the data that was stored in the trigger store the
+    // last time the trigger was invoked.
+    store: trigger-store,
+
+    // The input data for the trigger, serialized as a JSON object string.
+    // This contains the input data from the trigger configuration form.
+    serialized-input: string,
+  }
+
+  record action-context {
+    // Action ID is a unique identifier for the action that is requested to be
+    // invoked.
+    action-id: string,
+
+    // The connection that the action is invoked for.
+    // Connection is required for all action operations.
+    connection: connection,
+
+    // The input data for the action, serialized as a JSON object string.
+    // This contains the data passed from the previous step in the workflow.
+    serialized-input: string,
+  }
+
+  record trigger-response {
+    // The trigger events, each event will be used to spawn a new workflow
+    // execution in Standouts integration plattform.
+    events: list<trigger-event>,
+
+    // The updated store will be stored and used the next time the trigger is
+    // invoked.
+    store: trigger-store,
+  }
+
+  record action-response {
+    // The output data from the action, serialized as a JSON object string.
+    // This contains the data that will be passed to the next step in the workflow.
+    // The data must be a valid JSON object (not an array or primitive).
+    serialized-output: string
+  }
+
+  record trigger-event {
+    // The ID of the trigger event
+    //
+    // If the connection used for the given instance of the trigger is the same,
+    // as seen before. Then the event will be ignored.
+    //
+    // A scheduler could therefore use an timestamp as the ID, to ensure that
+    // the event is only triggered once per given time.
+    //
+    // A trigger that acts on created orders in a e-commerce system could use
+    // the order ID as the ID, to ensure that the event is only triggered once
+    // per order.
+    //
+    // A trigger that acts on updated orders in a e-commerce system could use
+    // the order ID in combination with an updated at timestamp as the ID, to
+    // ensure that the event is only triggered once per order update.
+    id: string,
+
+    // Serialized data must be a JSON object serialized into a string
+    // Note that it is important that the root is a object, not an array,
+    // or another primitive type.
+    serialized-data: string,
+  }
+
+  /// A structured error that can be returned by for example a call to a trigger or action.
+  /// Contains a machine-readable code and a human-readable message.
+  record app-error {
+    /// The error code identifying the type of failure.
+    code: error-code,
+
+    /// A human-readable message describing the error in more detail.
+    message: string,
+  }
+
+  /// An enumeration of error codes that can be returned by a trigger implementation.
+  /// These codes help the platform and plugin developers distinguish between different types of failures.
+  variant error-code {
+    /// Authentication failed. Typically due to an invalid or expired API key or token.
+    unauthenticated,
+
+    /// Authorization failed. The connection is valid but does not have the necessary permissions.
+    forbidden,
+
+    /// The trigger is misconfigured. For example, a required setting is missing or invalid.
+    misconfigured,
+
+    /// The target system does not support a required feature or endpoint.
+    unsupported,
+
+    /// The target system is rate-limiting requests. Try again later.
+    rate-limit,
+
+    /// The request timed out. The target system did not respond in time.
+    timeout,
+
+    /// The target system is currently unavailable or unreachable.
+    unavailable,
+
+    /// An unexpected internal error occurred in the plugin.
+    internal-error,
+
+    /// The response from the external system could not be parsed or was in an invalid format.
+    malformed-response,
+
+    /// A catch-all for all other types of errors. Should include a descriptive message.
+    other,
+
+    /// Complete the current workflow execution.
+    complete-workflow,
+
+    /// Complete the parent step execution.
+    complete-parent,
+  }
+}
+
+
+interface triggers {
+  use types.{trigger-context, trigger-event, trigger-response, app-error};
+
+  trigger-ids: func() -> result<list<string>, app-error>;
+
+  // Get the input schema for a specific trigger
+  // Returns a JSON Schema Draft 2020-12 schema as a string
+  // The schema may vary based on the connection in the context
+  // The trigger-id is extracted from the context
+  input-schema: func(context: trigger-context) -> result<string, app-error>;
+
+  // Get the output schema for a specific trigger
+  // Returns a JSON Schema Draft 2020-12 schema as a string
+  // The schema may vary based on the connection in the context
+  // The trigger-id is extracted from the context
+  output-schema: func(context: trigger-context) -> result<string, app-error>;
+
+  // Fetch events
+  //
+  // There are some limitations to the function:
+  // - It must a `trigger-response` within 30 seconds
+  // - It must return less than or equal to 100 `trigger-response.events`
+  // - It must not return more than 64 kB of data in the `trigger-response.store`
+  //
+  // If you need to fetch more events, you can return up to 100 events and then
+  // store the data needed for you to remember where you left off in the store.
+  // The next time the trigger is invoked, you can use the store to continue
+  // where you left off.
+  //
+  // If you do not pass the limitations the return value will be ignored. We
+  // will not handle any events and we persist the store that was returned in
+  // the response.
+  //
+  // That also means that you should implement your fetch event function in a
+  // way that it can be called multiple times using the same context and return
+  // the same events. That will ensure that the user that is building an
+  // integration with your trigger will not miss any events if your system is
+  // down for a short period of time.
+  fetch-events: func(context: trigger-context) -> result<trigger-response, app-error>;
+}
+
+interface actions {
+  use types.{action-context, action-response, app-error};
+
+  action-ids: func() -> result<list<string>, app-error>;
+
+  // Get the input schema for a specific action
+  // Returns a JSON Schema Draft 2020-12 schema as a string
+  // The schema may vary based on the connection in the context
+  // The action-id is extracted from the context
+  input-schema: func(context: action-context) -> result<string, app-error>;
+
+  // Get the output schema for a specific action
+  // Returns a JSON Schema Draft 2020-12 schema as a string
+  // The schema may vary based on the connection in the context
+  // The action-id is extracted from the context
+  output-schema: func(context: action-context) -> result<string, app-error>;
+
+  // Execute an action
+  //
+  // There are some limitations to the function:
+  // - It must return an `action-response` within 30 seconds
+  // - The serialized-output must be a valid JSON object serialized as a string
+  //
+  // Actions can perform various operations such as:
+  // - Making HTTP requests to external APIs
+  // - Processing and transforming data
+  // - Storing data for future use
+  // - Triggering other systems or workflows
+  //
+  // The action receives input data from the previous step and can return
+  // serialized output data to be passed to the next step in the workflow.
+  execute: func(context: action-context) -> result<action-response, app-error>;
+}
+
+interface environment {
+  // Get all environment variables
+  env-vars: func() -> list<tuple<string, string>>;
+  // Get a specific environment variable by name
+  env-var: func(name: string) -> option<string>;
+}
+
+interface http {
+  record response {
+    status: u16,
+    headers: headers,
+    body: string,
+  }
+
+  record request {
+    method: method,
+    url: string,
+    headers: headers,
+    body: string,
+  }
+
+  variant request-error {
+    other(string)
+  }
+
+  type headers = list<tuple<string, string>>;
+
+  resource request-builder {
+    constructor();
+
+    method: func(method: method) -> request-builder;
+    url: func(url: string) -> request-builder;
+
+    // Add a header to the request
+    header: func(key: string, value: string) -> request-builder;
+    headers: func(headers: list<tuple<string, string>>) -> request-builder;
+
+    // Add a body to the request
+    body: func(body: string) -> request-builder;
+
+    object: func() -> request;
+
+    // Send the request
+    send: func() -> result<response, request-error>;
+  }
+
+  variant method {
+    get,
+    post,
+    put,
+    delete,
+    patch,
+    options,
+    head,
+  }
+}
+
+interface file {
+  // HTTP headers for file requests (same as http interface)
+  type headers = list<tuple<string, string>>;
+
+  // Normalized file data
+  record file-data {
+    // Base64-encoded file content
+    base64: string,
+    // MIME type (e.g., "application/pdf")
+    content-type: string,
+    // Filename
+    filename: string,
+  }
+
+  variant file-error {
+    // Failed to fetch file from URL
+    fetch-failed(string),
+    // Invalid input format (not a valid URL, data URI, or base64)
+    invalid-input(string),
+    // Request timed out
+    timeout(string),
+    // Any other error
+    other(string),
+  }
+
+  // Normalize any file source to FileData
+  //
+  // The source is automatically detected:
+  // - URL: "https://example.com/file.pdf" - fetched with optional headers
+  // - Data URI: "data:application/pdf;base64,JVBERi0..." - parsed and extracted
+  // - Base64: Any other string is treated as raw base64 - decoded to detect type
+  //
+  // Parameters:
+  // - source: URL, data URI, or base64-encoded content
+  // - headers: Optional HTTP headers for URL requests (e.g., Authorization)
+  // - filename: Optional filename override (auto-detected if not provided)
+  //
+  // Returns file-data which will be processed by the platform:
+  // 1. Fields with format: "file-output" in the output schema are identified
+  // 2. File data is uploaded using the configured file_uploader
+  // 3. The file-data is replaced with the blob ID in the response
+  normalize: func(source: string, headers: option<headers>, filename: option<string>) -> result<file-data, file-error>;
+}
+
+world bridge {
+  import http;
+  import environment;
+  import file;
+  export triggers;
+  export actions;
+}

data/lib/app_bridge/app.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "json"
 require "timeout"
 
 module AppBridge
@@ -25,9 +26,13 @@ module AppBridge
     def execute_action(context)
       response = request_action_with_timeout(context)
 
-      validate_action_response_size!(response.serialized_output)
+      # Process files: find file-output fields in schema and replace with blob IDs
+      processed_output = process_files(response.serialized_output, context)
 
-      response
+      validate_action_response_size!(processed_output)
+
+      # Return new response with processed output
+      response.with_output(processed_output)
     end
 
     def timeout_seconds
@@ -65,5 +70,19 @@ module AppBridge
         _rust_fetch_events(context)
       end
     end
+
+    # Process files in the response based on output schema
+    def process_files(serialized_output, context)
+      data = JSON.parse(serialized_output)
+      schema = parse_output_schema(context)
+      JSON.generate(FileProcessor.call(data, schema))
+    rescue JSON::ParserError
+      # Schema parsing failed, return original output
+      serialized_output
+    end
+
+    def parse_output_schema(context)
+      JSON.parse(action_output_schema(context))
+    end
   end
 end

data/lib/app_bridge/file_processor.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require "json"
+
+module AppBridge
+  # Processes file data from WASM component responses.
+  #
+  # Uses the output schema to find fields with format: "file-output" and
+  # replaces the file data (base64, content_type, filename) with blob IDs
+  # via the configured file_uploader.
+  #
+  # The WASM component should use file.read to normalize any input format
+  # (URL, data URI, raw base64) into a consistent hash structure before output.
+  class FileProcessor
+    FILE_OUTPUT_FORMAT = "file-output"
+
+    # Process file data in a response hash.
+    #
+    # @param data [Hash] The response data from a WASM component
+    # @param schema [Hash] The JSON schema for the response data
+    # @return [Hash] The processed data with file IDs instead of file data
+    def self.call(data, schema)
+      new(data, schema).call
+    end
+
+    # @param data [Hash] The response data from a WASM component
+    # @param schema [Hash] The JSON schema for the response data
+    def initialize(data, schema)
+      @data = deep_dup(data)
+      @schema = schema
+    end
+
+    # Processes the data, uploading files and replacing file data with IDs.
+    #
+    # @return [Hash] The processed data with file IDs
+    def call
+      process_node(@data, @schema)
+      @data
+    end
+
+    private
+
+    def process_node(data_node, schema_node)
+      return unless data_node.is_a?(Hash) && schema_node.is_a?(Hash)
+
+      properties = schema_node["properties"]
+      return unless properties.is_a?(Hash)
+
+      properties.each do |key, sub_schema|
+        process_property(data_node, key, sub_schema)
+      end
+    end
+
+    def process_property(data_node, key, sub_schema)
+      data_value, actual_key = find_data_value(data_node, key)
+      return if data_value.nil?
+
+      if sub_schema["format"] == FILE_OUTPUT_FORMAT
+        process_file_field(data_node, actual_key, data_value)
+      elsif array_schema?(sub_schema)
+        process_array_field(data_value, sub_schema)
+      elsif data_value.is_a?(Hash)
+        process_node(data_value, sub_schema)
+      end
+    end
+
+    def find_data_value(data_node, key)
+      str_key = key.to_s
+      return [nil, nil] unless data_node.key?(str_key)
+
+      [data_node[str_key], str_key]
+    end
+
+    def process_file_field(data_node, actual_key, data_value)
+      return unless file_data?(data_value)
+
+      blob_id = upload_file(data_value)
+      data_node[actual_key] = blob_id
+    end
+
+    def array_schema?(sub_schema)
+      sub_schema["type"] == "array" && sub_schema["items"].is_a?(Hash)
+    end
+
+    def process_array_field(data_value, sub_schema)
+      return unless data_value.is_a?(Array)
+
+      items_schema = sub_schema["items"]
+      data_value.each_with_index do |item, index|
+        if items_schema["format"] == FILE_OUTPUT_FORMAT && file_data?(item)
+          data_value[index] = upload_file(item)
+        else
+          process_node(item, items_schema)
+        end
+      end
+    end
+
+    def file_data?(value)
+      return false unless value.is_a?(Hash)
+
+      present?(value["base64"]) && present?(value["filename"])
+    end
+
+    def upload_file(file_data)
+      result = AppBridge.file_uploader.call(file_data)
+      # If uploader returns nil (no uploader configured), leave data unchanged
+      result.nil? ? file_data : result
+    rescue StandardError => e
+      raise AppBridge::InternalError, "Failed to upload '#{file_data["filename"]}': #{e.message}"
+    end
+
+    def present?(value)
+      !value.nil? && !value.to_s.strip.empty?
+    end
+
+    # Deep duplicates the object and normalizes all hash keys to strings
+    def deep_dup(obj)
+      case obj
+      when Hash then obj.transform_keys(&:to_s).transform_values { |v| deep_dup(v) }
+      when Array then obj.map { |v| deep_dup(v) }
+      else safe_dup(obj)
+      end
+    end
+
+    def safe_dup(obj)
+      obj.dup
+    rescue TypeError
+      obj
+    end
+  end
+end

data/lib/app_bridge/version.rb

@@ -4,5 +4,5 @@
 # ext/app_bridge/Cargo.toml file to keep them in sync.
 
 module AppBridge
-  VERSION = "3.0.0"
+  VERSION = "4.0.0"
 end

data/lib/app_bridge.rb

@@ -2,13 +2,39 @@
 
 require_relative "app_bridge/version"
 require_relative "app_bridge/app"
+require_relative "app_bridge/file_processor"
 
+# Communication layer for Standout integration apps using WebAssembly components.
 module AppBridge
   class Error < StandardError; end
   class TimeoutError < Error; end
   class TooManyEventsError < Error; end
   class StoreTooLargeError < Error; end
   class ActionResponseTooLargeError < Error; end
+  class FileUploadError < Error; end
+  class InternalError < Error; end
+
+  class << self
+    # Configurable file uploader callback.
+    # The platform should set this to handle file uploads and return an ID.
+    #
+    # @example Configure with ActiveStorage
+    #   AppBridge.file_uploader = ->(file_data) {
+    #     content = Base64.decode64(file_data['base64'])
+    #     blob = ActiveStorage::Blob.create_and_upload!(
+    #       io: StringIO.new(content),
+    #       filename: file_data['filename'],
+    #       content_type: file_data['content_type'] || 'application/octet-stream'
+    #     )
+    #     blob.signed_id  # Returns just the ID
+    #   }
+    attr_accessor :file_uploader
+  end
+
+  # Default no-op uploader (returns nil - no file storage configured)
+  # rubocop:disable Style/NilLambda
+  self.file_uploader = ->(_file_data) { nil }
+  # rubocop:enable Style/NilLambda
 
   # Represents a trigger event that is recieved from the app.
   class TriggerEvent

data/tasks/fixtures.rake

@@ -2,7 +2,7 @@
 
 require "English"
 
-namespace :fixtures do # rubocop:disable Metrics/BlockLength
+namespace :fixtures do
   namespace :apps do
     desc "Clean up build artifacts"
     task :clean do
@@ -37,8 +37,22 @@ namespace :fixtures do # rubocop:disable Metrics/BlockLength
       Process.wait(pid)
       raise "Failed to build artifacts" unless $CHILD_STATUS.success?
     end
+
+    desc "Compile the v3 fixture app (for backward compatibility testing)"
+    task :compile_rust_v3 do
+      pwd = "spec/fixtures/components/rust_app_v3"
+      next unless File.exist?(pwd)
+
+      compile_pid = Process.spawn("cargo clean && cargo build --release --target wasm32-wasip2",
+                                  chdir: pwd)
+      Process.wait(compile_pid)
+      raise "Failed to build v3 artifacts" unless $CHILD_STATUS.success?
+
+      move_pid = Process.spawn("mv #{pwd}/target/wasm32-wasip2/release/rust_app_v3.wasm #{pwd}/../rust_app_v3.wasm")
+      Process.wait(move_pid)
+    end
   end
 end
 
 desc "Build all fixtures"
-task fixtures: %i[fixtures:apps:clean fixtures:apps:compile_rust fixtures:apps:compile_js]
+task fixtures: %i[fixtures:apps:clean fixtures:apps:compile_rust fixtures:apps:compile_js fixtures:apps:compile_rust_v3]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: app_bridge
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Alexander Ross
 bindir: exe
 cert_chain: []
-date: 2025-10-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -47,8 +47,10 @@ files:
 - ext/app_bridge/src/app_state.rs
 - ext/app_bridge/src/component.rs
 - ext/app_bridge/src/error_mapping.rs
+- ext/app_bridge/src/file_ops.rs
 - ext/app_bridge/src/lib.rs
 - ext/app_bridge/src/request_builder.rs
+- ext/app_bridge/src/types.rs
 - ext/app_bridge/src/wrappers/action_context.rs
 - ext/app_bridge/src/wrappers/action_response.rs
 - ext/app_bridge/src/wrappers/app.rs
@@ -57,9 +59,11 @@ files:
 - ext/app_bridge/src/wrappers/trigger_context.rs
 - ext/app_bridge/src/wrappers/trigger_event.rs
 - ext/app_bridge/src/wrappers/trigger_response.rs
-- ext/app_bridge/wit/world.wit
+- ext/app_bridge/wit/v3/world.wit
+- ext/app_bridge/wit/v4/world.wit
 - lib/app_bridge.rb
 - lib/app_bridge/app.rb
+- lib/app_bridge/file_processor.rb
 - lib/app_bridge/version.rb
 - sig/app_bridge.rbs
 - tasks/fixtures.rake
@@ -87,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.3.11
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Communication layer for Standout integration apps
 test_files: []