Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@plexus-interop/common-api-impl

Package Overview
Dependencies
Maintainers
2
Versions
64
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@plexus-interop/common-api-impl

Common API implementation

  • 0.19.1
  • latest
  • npm
  • Socket score

Version published
Maintainers
2
Created
Source

Implementation for Common API Draft Proposal

Partial implementation for Common Interop API.

Metadata Setup

Plexus Interop based on Metadata, so each application interracting via Common API should still be defined in metatada.

  • All Methods/Streams/Messages must be defined as regular Plexus Messages and Services
  • Method/Stream names, used from client code, should refer to aliases of provided actions. E.g. method, used like below:
peer.invoke('close-market-order', { orderId });

should be defined in metadata by action provider as following:

application ProviderApplication {
    provides OrderService { 
        CloseMarketOrder [(provided_method_alias) = "close-market-order" ]; 
    }
}
  • All apps should be also marked with aliases in metadata to be discovered by Common API, e.g.: application connecting to Plexus using
const peer = await window.platform.connect('web-trader-client');

should be mapped via custom option like this:

application WebTraderClient {
    option (app_alias) = "web-trader-client";
}

Implemented features

API is implemented partially, all other methods raise Method not implemented error. Available features can be checked via feature flags API. Here is the list of supported functionality:

  • InvokeMethod

  • SubscribeStream

  • RegisterMethodOnConnect

  • RegisterStreamOnConnect

  • DiscoverMethods

  • DiscoverStreams

FAQs

Package last updated on 15 Nov 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc