@surph_ai/cli 0.0.16 → 0.0.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@surph_ai/cli",
-  "version": "0.0.16",
+  "version": "0.0.19",
   "description": "",
   "main": "index.js",
   "types": "./types.d.ts",

package/scaffold/index.js

@@ -44,7 +44,7 @@ const nextSteps = function(name){
 }
 
 
-module.exports = (name, type = 'app') => {
+module.exports = async (name, type = 'app') => {
   /*
   https://stackoverflow.com/questions/8683895/how-do-i-determine-the-current-operating-system-with-node-js
   Returns the operating system platform. Possible values are 'darwin', 'freebsd', 'linux',
@@ -142,6 +142,9 @@ module.exports = (name, type = 'app') => {
 
     utils.write('tsconfig.json', JSON.stringify(tsConfig, null, 2) + '\n')
 
+    const cheatsheetResp = await fetch('https://surph.s3.us-east-1.amazonaws.com/tools/cli/CHEATSHEET.md')
+    utils.write('CHEATSHEET.md', await cheatsheetResp.text())
+
     console.log('\n- - - - - Next Steps - - - - - ')
     console.log('1. $ cd ' + name)
     console.log('2. $ npm install or $ yarn install')

package/scaffold/tool/examples/dealfinder/index.ts

@@ -6,7 +6,7 @@ type ToolArgs = {
   preferences: string[]
 };
 
-const handler: ToolHandler<ToolArgs> = async ({ args, user, context }: Record<string, any>) => {
+const handler: ToolHandler<ToolArgs> = async ({ args, user, context = null, board = null }: Record<string, any>) => {
   try {
     if (!args) {
       throw new Error('Args required.')

package/scaffold/tool/examples/population/index.ts

@@ -11,7 +11,7 @@ type ToolArgs = {
   city: string
 };
 
-const handler: ToolHandler<ToolArgs> = async ({ args, user, context }: Record<string, any>) => {
+const handler: ToolHandler<ToolArgs> = async ({ args, user, context = null, board = null }: Record<string, any>) => {
   try {
     // your custom tool code goes here
     const { city } = args

package/scaffold/tool/examples/weather/index.ts

@@ -1,3 +1,5 @@
+// This example shows how to connect a custom tool to an API and make API calls.
+
 import type { ToolHandler } from '@surph_ai/sdk';
 
 // Define interfaces for API responses
@@ -109,7 +111,7 @@ type ToolArgs = {
   location: string
 };
 
-const handler: ToolHandler<ToolArgs> = async ({ args, user, context }: Record<string, any>) => {
+const handler: ToolHandler<ToolArgs> = async ({ args, user, context = null, board = null }: Record<string, any>) => {
   try {
     const { location } = args;
     if (!location) {

package/scaffold/tool/package.json

@@ -8,8 +8,6 @@
     "test": "",
     "build": "rimraf dist && tsc",
     "watch": "tsc -w",
-    "login": "surph login",
-    "manifest": "surph manifest",
     "publish": "npm run build && surph publish",
     "deploy": "npm run build && surph deploy"
   },

package/scaffold/tool/tools/index.ts

@@ -1,13 +1,37 @@
 import type { ToolHandler, ToolContext, User } from '@surph_ai/sdk';
-import { surph } from '@surph_ai/sdk';
+import { surph, SurphContext, SurphBoard } from '@surph_ai/sdk';
 
 type ToolArgs = {
   // your custom tool args goes here
 };
 
-const handler: ToolHandler<ToolArgs> = async ({ args, user, context }: Record<string, any>) => {
-  // your custom tool code goes here
+const handler: ToolHandler<ToolArgs> = async ({ args, user, context = null, board = null }: Record<string, any>) => {
+  try {
+
+    // your custom tool code goes here.
+    //
+    // pro tip: tell your coding agent to use "CHEATSHEET.md"
+    // as a guide for working with this sdk. for example, tell
+    // your coding agent "use CHEATSHEET.md to set up a fetch
+    // request for most recent context items."
+    //
+    // IMPORTANT: before testing your custom tool, remember to
+    // populate the "manifest.json" file so surph knows when to
+    // use it. To do so, run:
+    //
+    // npx @surph_ai/cli manifest
+
+    // this is your tool final payload:
+    return {}
+  } catch (error: any) {
+    throw error
+  }
 };
 
 export default handler;
 
+// some fake api services to get you started:
+// https://www.mydummyapi.com/
+// https://dummyjson.com/
+// https://jsonplaceholder.typicode.com/
+//

package/toolserver/app.js

@@ -1,7 +1,7 @@
 const express = require('express')
 const path = require('path')
 const vinely = require('@vinely-ai/sdk')
-const { config, configureApp } = require('./middleware/index.js')
+const { config, configureApp, board } = require('./middleware/index.js')
 
 const app = express()
 
@@ -11,6 +11,7 @@ configureApp(app, {
 })
 
 app.use(config)
+app.use(board)
 
 const rpc = require('./routes/rpc')
 const api = require('./routes/api')

package/toolserver/middleware/board.js

@@ -0,0 +1,66 @@
+const { SURPH_S3_URL } = require('../../utils/constants.js')
+const boardConfiguration = require('../../utils/boardConfiguration.js')
+
+module.exports = async (req, res, next) => {
+  const headers = req.headers;
+  const host = headers.host; // "beltwaybits.surph.ai"
+  // console.log('SURPH HOST = = = = = ' + host)
+
+  if (host === 'surph.ai' || host === 'www.surph.ai') {
+    return next();
+  }
+
+  let surphBoard = process.env.SURPH_BOARD;
+
+  // if (host.includes('surph.ai')) {
+  //   const parts = host.split('.');
+  //   surphBoard = parts[0];
+  // } else {
+  //   surphBoard = process.env.SURPH_BOARD;
+  // }
+
+  // console.log('SURPH_BOARD_ENV: ', surphBoard);
+  if (!surphBoard) {
+    return next();
+  }
+
+  if (req.surph_board) {
+    return next();
+  }
+
+  // const surph_board = await boardConfiguration(surphBoard);
+  const { board, contexts, tides, tools } = await boardConfiguration(surphBoard);
+
+  const tideTools = []
+  tides.forEach(t => {
+    t.tools.forEach(toolSlug => {
+      if (tideTools.indexOf(toolSlug) === -1)
+        tideTools.push(toolSlug)
+    })
+  })
+
+  // console.log('TIDE TOLS: ' + JSON.stringify(tideTools))
+
+  const _tools = []
+  tools.forEach(t => {
+    if (tideTools.indexOf(t.slug) === -1) {
+      _tools.push({ ...t })
+    } else {
+      _tools.push({ ...t, origin: 'tide' })
+    }
+  })
+
+
+  req.surph_board = {
+    // ...surph_board,
+    ...board,
+    contexts,
+    tides,
+    // tools,
+    tools: _tools,
+    relativePath: `${SURPH_S3_URL}/boards/${surphBoard}/`
+  };
+
+  // console.log('\n\nSURPH_BOARD: ', JSON.stringify(req.surph_board));
+  next();
+}

package/toolserver/middleware/index.js

@@ -1,7 +1,9 @@
 const config = require('./config.js')
 const configureApp = require('./configureApp.js')
+const board = require('./board.js')
 
 module.exports = {
   config,
   configureApp,
+  board,
 }

package/toolserver/routes/index.js

@@ -3,6 +3,7 @@ const os = require('os')
 const path = require('path')
 const fs = require('fs')
 const userConfiguration = require('../../utils/userConfiguration')
+const boardConfiguration = require('../../utils/boardConfiguration')
 const manifest = require('../../../../../manifest.json')
 
 const SURPH_S3_URL = 'https://surph.s3.us-east-1.amazonaws.com'
@@ -34,13 +35,32 @@ router.get('/', async (req, res, next) => {
     // production shape the web app consumes — useSettings.js reads
     // `preloaded.user` and downstream code branches on `_id`.
     const session = readSurphSession()
-    const { user, contexts, tides, tools } = session?.userId? await userConfiguration({ id: session.userId }) : null
-    const creator = {
-      _id: user._id,
-      username: user.username,
-      avatar: user.avatar
+    // const { user, contexts, tides, tools } = session?.userId? await userConfiguration({ id: session.userId }) : null
+    const userConfig = session?.userId? await userConfiguration({ id: session.userId }) : null
+
+    let title = 'Surph AI'
+    let ctx = null
+    let board = null
+    let tools = null
+    let tides = null
+    let contexts = null
+
+    if (req.surph_board) {
+      ctx = req.surph_board.contexts[0] // change this to "defaultContext"
+      board = req.surph_board
+      title = req.surph_board.name
+
+      tools = req.surph_board.tools
+      tides = req.surph_board.tides
+      contexts = req.surph_board.contexts
+    } else {
+      tools = userConfig.tools
+      tides = userConfig.tides
+      contexts = userConfig.contexts
     }
 
+    const user = userConfig.user
+    const creator = { _id: user._id, username: user.username, avatar: user.avatar }
     const localTools = toolSlugs.map(slug => {
       const tool = manifest[slug]
       let isTideTool = false
@@ -59,6 +79,9 @@ router.get('/', async (req, res, next) => {
     const context = {
       env: 'sandbox',
       mode: 'desktop',
+      title,
+      board,
+      context: ctx,
       user,
       config: { ...req.config, entry: 'web' },
       contexts,

package/toolserver/routes/tool.js

@@ -17,11 +17,11 @@ const loadTool = () => import(toolsPath).then((mod) => mod.default)
 const router = Router()
 
 const handler = async (event, tool) => {
-  const { args, context, user } = event
+  const { args, context, user, board } = event
   let payload = null
   let errorMsg = null
   try {
-    payload = await tool({ args, context, user })
+    payload = await tool({ args, context, user, board })
   } catch (error) {
     errorMsg = error instanceof Error ? error.message : String(error)
   } finally {
@@ -94,13 +94,13 @@ router.get('/test', async (req, res, next) => {
 
 router.post('/custom', async (req, res, next) => {
   try {
-    const { name, args, tool, user = null, context = null } = req.body;
+    const { name, args, tool, user = null, context = null, board = null } = req.body;
     // if (process.env.SURPH_TOOL !== tool.slug) {
     //   throw new Error(`Invalid tool ${tool.slug}. Check .env file.`)
     // }
 
     const toolRunner = await loadTool()
-    const response = await handler({ args, context, user }, toolRunner)
+    const response = await handler({ args, context, user, board }, toolRunner)
     if (response.error) {
       throw new Error(response.error);
     }

package/utils/boardConfiguration.js

@@ -0,0 +1,45 @@
+const { REST_API_URL } = require('./constants.js')
+
+
+const BOARD_CACHE = {};
+// testing for https://beltwaybits.surph.ai/:
+// const testBoard = 'beltwaybits'
+// const resp = await fetch(`${REST_API_URL}/rest/context?boards.slug=${testBoard}`)
+// const { payload } = await resp.json();
+// ctx = Array.isArray(payload) ? payload[0] || null : payload;
+// board = ctx.boards.find((b: any) => b.slug === testBoard)
+// board.relativePath = `${SURPH_S3_URL}/boards/${testBoard}/`
+// title = board.name
+const boardConfiguration = async (boardSlug) => {
+    try {
+        if (!boardSlug)
+            return null;
+        if (BOARD_CACHE[boardSlug]) {
+            if (BOARD_CACHE[boardSlug] === 'pending') {
+                // console.log('PENDING')
+                return null;
+            }
+            return BOARD_CACHE[boardSlug];
+        }
+        BOARD_CACHE[boardSlug] = 'pending';
+        const response = await fetch(`${REST_API_URL}/queries/board_configuration`, {
+            method: 'POST',
+            body: JSON.stringify({ board: boardSlug }),
+            headers: {
+                'Accept': 'application/json',
+                'Content-type': 'application/json',
+                'x-surph-client': 'surph-webapp',
+            }
+        });
+        const { payload } = await response.json();
+        BOARD_CACHE[boardSlug] = payload;
+        // console.log('PAYLOAD: ' + JSON.stringify(payload));
+        const { board, contexts, tides, tools } = payload;
+        return { board, contexts, tides, tools };
+    }
+    catch (error) {
+        console.error('Error fetching board: ', error.message);
+        throw error;
+    }
+};
+module.exports = boardConfiguration;

package/utils/constants.js

@@ -0,0 +1,9 @@
+const SURPH_S3_URL = 'https://surph.s3.us-east-1.amazonaws.com'
+const REST_API_URL = 'https://surph-mongo-http-19075ff8d93f.herokuapp.com';
+const S3_BUCKET = 'https://surph.s3.us-east-1.amazonaws.com';
+
+module.exports = {
+  SURPH_S3_URL,
+  REST_API_URL,
+  S3_BUCKET
+}