app_bridge 1.0.0-x86_64-darwin → 2.1.0-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65ea1d5385128308bac7eab284a4f9d3389e2a51f4e575b550d8107a053dff08
-  data.tar.gz: ba3af926e040bee469c771ac3e8ad0b6160fa7f4736c021b5b4590e32ee47ac5
+  metadata.gz: 532c2aa5286173c345b2d3e09802f58268a02dda0bb1a2922ae4906107a5b9e2
+  data.tar.gz: ba6e0025d397e6fac6f2feb4e4953a3de6446747d0bfb9c3d2f56604b347a833
 SHA512:
-  metadata.gz: 0d87dd1f0b10cf1fcf43672a4838a26fcf98b0c043ce4dcb530246dd40f227b8fd351ba832b74d03b4d719064dbb992c566ffb3a98d78d28d77f3bbadd179961
-  data.tar.gz: 8efd8b6b06e68d5130a8052e267ada3212ca53b1d672c39483975414e19e412fb83b464b17ee9e53a3a3d2b9174d77cd1bbc123dba89f0187ef4e271b52090e5
+  metadata.gz: 33e5273b58ba665b0d578cc114bd10342e52d856e0d0c582ddc49249ad9a5767cc5267e023422628c9bbca6302f8a8e8cee4184b747b8f032e8ea6bc95d3e410
+  data.tar.gz: a85d038d6f286a1fd5b7cad816b6e02773ee78b4fb135be0c88a5f26828b2e5b8708853ef4affdc0784c9fbf85725be9e8c4170ab998bd25178dcc28ea79bef4

data/.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# http://editorconfig.org/
+
+root = true
+
+[*]
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2
+curly_bracket_next_line = false
+indent_brace_style = K&R
+
+[*.md]
+trim_trailing_whitespace = false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.2

data/Rakefile

@@ -3,8 +3,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
-
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
@@ -22,4 +20,9 @@ end
 # Load all project specific rake tasks
 Dir.glob(File.expand_path("tasks/**/*.rake", __dir__)).each { |file| load file }
 
-task default: %i[fixtures compile spec rubocop]
+# Set test mode environment variable for specs
+RSpec::Core::RakeTask.new(:spec) do |_t|
+  ENV["APP_BRIDGE_TEST_MODE"] = "1"
+end
+
+task default: %i[fixtures compile rust:test spec rubocop]

data/ext/app_bridge/wit/world.wit

@@ -1,4 +1,4 @@
-package standout:app@0.3.0;
+package standout:app@2.1.0;
 
 interface types {
   // The trigger-store is a string that is used to store data between trigger
@@ -10,10 +10,10 @@ interface types {
   // need to add more data to the store.
   type trigger-store = string;
 
-  record account {
+  record connection {
     id: string,
     name: string,
-    // The account data is a JSON object serialized into a string. The JSON root
+    // The connection data is a JSON object serialized into a string. The JSON root
     // will always be an object.
     serialized-data: string,
   }
@@ -23,12 +23,31 @@ interface types {
     // invoked.
     trigger-id: string,
 
-    // The account that the trigger is invoked for.
-    account: account,
+    // 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 {
@@ -41,10 +60,17 @@ interface types {
     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 account used for the given instance of the trigger is the same,
+    // 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
@@ -59,24 +85,74 @@ interface types {
     // ensure that the event is only triggered once per order update.
     id: string,
 
-    // The timestamp of the event.
-    // Must be a unix timestamp in milliseconds since epoch (UTC).
-    // In JavaScript `Date.now()` can be used to get the current timestamp in
-    // milliseconds.
-    timestamp: u64,
-
     // 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,
+  }
 }
 
 
 interface triggers {
-  use types.{trigger-context, trigger-event, trigger-response};
+  use types.{trigger-context, trigger-event, trigger-response, app-error};
+
+  trigger-ids: func() -> result<list<string>, app-error>;
 
-  get-triggers: func() -> list<string>;
+  // 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
   //
@@ -99,7 +175,48 @@ interface triggers {
   // 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) -> trigger-response;
+  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 {
@@ -154,5 +271,7 @@ interface http {
 
 world bridge {
   import http;
+  import environment;
   export triggers;
+  export actions;
 }

data/lib/app_bridge/app.rb

@@ -3,8 +3,16 @@
 require "timeout"
 
 module AppBridge
-  # An app that can be used to fetch events.
+  # An app that can be used to fetch events and execute actions.
   class App
+    def initialize(component_path, environment_variables: {})
+      @component_path = component_path
+      @environment_variables = environment_variables
+      _rust_initialize(component_path, environment_variables)
+    rescue StandardError
+      raise InternalError, "Incompatible WASM file version"
+    end
+
     def fetch_events(context)
       response = request_events_with_timeout(context)
 
@@ -14,7 +22,15 @@ module AppBridge
       response
     end
 
-    def polling_timeout
+    def execute_action(context)
+      response = request_action_with_timeout(context)
+
+      validate_action_response_size!(response.serialized_output)
+
+      response
+    end
+
+    def timeout_seconds
       30 # seconds
     end
 
@@ -32,8 +48,20 @@ module AppBridge
       raise StoreTooLargeError, "Store size exceeds 64 kB limit"
     end
 
+    def validate_action_response_size!(serialized_output)
+      return if serialized_output.size <= 64 * 1024
+
+      raise ActionResponseTooLargeError, "Action response size exceeds 64 kB limit"
+    end
+
+    def request_action_with_timeout(context)
+      Timeout.timeout(timeout_seconds, TimeoutError, "Action exceeded #{timeout_seconds} seconds") do
+        _rust_execute_action(context)
+      end
+    end
+
     def request_events_with_timeout(context)
-      Timeout.timeout(polling_timeout, TimeoutError, "Polling exceeded #{polling_timeout} seconds") do
+      Timeout.timeout(timeout_seconds, TimeoutError, "Polling exceeded #{timeout_seconds} seconds") do
         _rust_fetch_events(context)
       end
     end

data/lib/app_bridge/version.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# When updating the version, please also update the version in the
+# ext/app_bridge/Cargo.toml file to keep them in sync.
+
 module AppBridge
-  VERSION = "1.0.0"
+  VERSION = "2.1.0"
 end

data/lib/app_bridge.rb

@@ -3,17 +3,12 @@
 require_relative "app_bridge/version"
 require_relative "app_bridge/app"
 
-begin
-  require "app_bridge/#{RUBY_VERSION.split(".").first(2).join(".")}/app_bridge"
-rescue LoadError
-  require "app_bridge/app_bridge"
-end
-
 module AppBridge
   class Error < StandardError; end
   class TimeoutError < Error; end
   class TooManyEventsError < Error; end
   class StoreTooLargeError < Error; end
+  class ActionResponseTooLargeError < Error; end
 
   # Represents a trigger event that is recieved from the app.
   class TriggerEvent
@@ -23,3 +18,6 @@ module AppBridge
     end
   end
 end
+
+# Load the extension after the module is defined
+require_relative "app_bridge/app_bridge"

data/sig/app_bridge.rbs

@@ -7,11 +7,15 @@ module AppBridge
 
     def triggers: () -> Array[String]
 
+    def actions: () -> Array[String]
+
     def fetch_events: (TriggerContext) -> TriggerResponse
+
+    def execute_action: (ActionContext) -> ActionResponse
   end
 
-  class Account
-    def self.new: (String, String, String) -> Account
+  class Connection
+    def self.new: (String, String, String) -> Connection
 
     def id: () -> String
 
@@ -39,12 +43,30 @@ module AppBridge
   end
 
   class TriggerContext
-    def self.new: (String, Account, String) -> TriggerContext
+    def self.new: (String, Connection, String, String) -> TriggerContext
 
     def trigger_id: () -> String
 
-    def account: () -> Account
+    def connection: () -> Connection
 
     def store: () -> String
+
+    def serialized_input: () -> String
+  end
+
+  class ActionContext
+    def self.new: (String, Connection, String) -> ActionContext
+
+    def action_id: () -> String
+
+    def connection: () -> Connection
+
+    def serialized_input: () -> String
+  end
+
+  class ActionResponse
+    def self.new: (String) -> ActionResponse
+
+    def serialized_output: () -> String
   end
 end

data/tasks/fixtures.rake

@@ -2,36 +2,43 @@
 
 require "English"
 
-namespace :fixtures do
+namespace :fixtures do # rubocop:disable Metrics/BlockLength
   namespace :apps do
     desc "Clean up build artifacts"
     task :clean do
-      # In context of the path spec/fixtures/components/example.
+      # In context of the path spec/fixtures/components/rust_app.
       # Execute cargo clean.
       #
-      pwd = "spec/fixtures/components/example"
+      pwd = "spec/fixtures/components/rust_app"
       pid = Process.spawn("cargo clean", chdir: pwd)
       Process.wait(pid)
       raise "Failed to clean build artifacts" unless $CHILD_STATUS.success?
 
       # Remove the built wasm artifact.
-      pid = Process.spawn("rm example.wasm", chdir: "spec/fixtures/components")
+      pid = Process.spawn("rm rust_app.wasm", chdir: "spec/fixtures/components")
       Process.wait(pid)
     end
 
     desc "Compile the fixture apps"
-    task :compile do
-      pwd = "spec/fixtures/components/example"
+    task :compile_rust do
+      pwd = "spec/fixtures/components/rust_app"
       compile_pid = Process.spawn("cargo clean && cargo build --release --target wasm32-wasip2",
                                   chdir: pwd)
       Process.wait(compile_pid)
       raise "Failed to build artifacts" unless $CHILD_STATUS.success?
 
-      move_pid = Process.spawn("mv #{pwd}/target/wasm32-wasip2/release/example.wasm #{pwd}/../example.wasm")
+      move_pid = Process.spawn("mv #{pwd}/target/wasm32-wasip2/release/rust_app.wasm #{pwd}/../rust_app.wasm")
       Process.wait(move_pid)
     end
+
+    task :compile_js do
+      pwd = "spec/fixtures/components/js_app"
+      pid = Process.spawn("npm run build", chdir: pwd)
+      Process.wait(pid)
+      raise "Failed to build artifacts" unless $CHILD_STATUS.success?
+    end
   end
 end
 
 desc "Build all fixtures"
-task fixtures: %i[fixtures:apps:clean fixtures:apps:compile]
+task fixtures: %i[fixtures:apps:clean fixtures:apps:compile_rust fixtures:apps:compile_js]

data/tasks/rust_test.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Rake task to run Rust tests
+namespace :rust do
+  desc "Run Rust tests"
+  task :test do
+    puts "Running Rust tests..."
+    system("cargo test")
+    puts "Rust tests completed."
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_bridge
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: x86_64-darwin
 authors:
 - Alexander Ross
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-04-03 00:00:00.000000000 Z
+date: 2025-10-02 00:00:00.000000000 Z
 dependencies: []
 description: The app_bridge gem is designed to enable seamless interaction with WebAssembly
   components that adhere to the WIT specification `standout:app`. It is developed
@@ -19,8 +19,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - README.md
 - Rakefile
@@ -32,6 +34,7 @@ files:
 - lib/app_bridge/version.rb
 - sig/app_bridge.rbs
 - tasks/fixtures.rake
+- tasks/rust_test.rake
 homepage: https://github.com/standout/app_bridge
 licenses: []
 metadata: