npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@wix/agent-platform-bm-sdk

v1.18.0

Published

`agent-platform-bm-sdk` is a library designed to facilitate interaction with a platform's agent within a Domain Assistant Tool. It provides a way to report events and errors to the platform, and to invoke side effects.

Downloads

366

Readme

Introduction

agent-platform-bm-sdk is a library designed to facilitate interaction with a platform's agent within a Domain Assistant Tool. It provides a way to report events and errors to the platform, and to invoke side effects.

Prerequisites

Add to your Assistant App, the GENIE.PUBLISH_ASSISTANT_SIDE_EFFECT permission

Usage in Domain Assistant Tool

In the tools execute function use this:

execute: async (params, ctx) => {
 const APP_SECRET = ctx.getConfig('app-secret')!
 ctx.apiGatewayClient.signWith('<PASTE_APP_DEF_ID>', APP_SECRET)

 const signedAspects = await ctx.apiGatewayClient.addServiceIdentitySafe(ctx.aspects)

 const data = {
   url: 'http://www.wix.com'
 }

 await ctx.invokeSideEffect(
   'your-event-name', //Like 'navigate-to' - must match this regex `^[A-Za-z0-9_-]+$`
   data,
   signedAspects
 )

Usage in BM Client

Add this code to your BM app when you want to receive event on the client (like navigate)

import { useAssistantEffect } from '@wix/agent-platform-bm-sdk';

// ...

useAssistantEffect<{url: string}>(
  ({url}) => {
    console.log({url});
    window.open(url);
  },
  'your-app-def-id',
  'your-event-name', //like 'navigate-to'
);

Example Code

Domain Assistant Code (emit)

https://github.com/wix-private/assistant-domains/blob/0db203f34094fb862eed27f65b4e243da6971a93/packages/time-assistant/src/tools/getCurrentTime.ts#L22

Client Code (listen)

https://github.com/wix-private/genie/blob/2027541202f6330157ddb682c8037f7c50138985/packages/business-assistant-bm-app/src/pages/index.tsx#L28

Testing in AI Assistant Playground

  1. In Advanced Assistant Configuration (initial screen) register a side effect listener.
  2. In chat trigger side effect from the tool or widget.
  3. Expect browser alert with emitted side effect data.