@surph_ai/cli 0.0.20 → 0.0.22

package/package.json

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

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

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

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

@@ -111,7 +111,7 @@ type ToolArgs = {
   location: string
 };
 
-const handler: ToolHandler<ToolArgs> = async ({ args, user, context = null, board = null }: Record<string, any>) => {
+const handler: ToolHandler<ToolArgs> = async ({ args, user, contexts = null, board = null }: Record<string, any>) => {
   try {
     const { location } = args;
     if (!location) {

package/scaffold/tool/tools/index.ts

@@ -1,15 +1,12 @@
 import type { ToolHandler, ToolContext, User } from '@surph_ai/sdk';
 import { surph, SurphContext, SurphBoard } from '@surph_ai/sdk';
 
-type ToolArgs = {
-  // your custom tool args goes here
-};
+// your custom tool args goes here
+type ToolArgs = {};
 
-const handler: ToolHandler<ToolArgs> = async ({ args, user, context = null, board = null }: Record<string, any>) => {
+// your custom tool code goes here.
+const handler: ToolHandler<ToolArgs> = async ({ args, user, contexts = 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
@@ -17,11 +14,17 @@ const handler: ToolHandler<ToolArgs> = async ({ args, user, context = null, boar
     //
     // 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
+    // use it. To do so, run: "npx @surph_ai/cli manifest".
+
+    // example payload:
+    // return {
+    //   items: data,
+    //   format_instructions: 'For each item, extract a formatted event listing with date, time, location,
+    //   title, and description. If the item is a happening with a time and place, mark it as an event;
+    //   otherwise still include it but mark isEvent=false. Pull fields from title/content/tags/source when
+    //   present; use "" if unknown.'
+    // }; 
 
-    // this is your tool final payload:
     return {}
   } catch (error: any) {
     throw error

package/toolserver/middleware/board.js

@@ -1,5 +1,6 @@
 const { SURPH_S3_URL } = require('../../utils/constants.js')
 const boardConfiguration = require('../../utils/boardConfiguration.js')
+const BOARD_CACHE = {}
 
 module.exports = async (req, res, next) => {
   const headers = req.headers;
@@ -19,7 +20,6 @@ module.exports = async (req, res, next) => {
   //   surphBoard = process.env.SURPH_BOARD;
   // }
 
-  // console.log('SURPH_BOARD_ENV: ', surphBoard);
   if (!surphBoard) {
     return next();
   }
@@ -28,8 +28,15 @@ module.exports = async (req, res, next) => {
     return next();
   }
 
+  if (BOARD_CACHE[surphBoard]) {
+    req.surph_board = { ...BOARD_CACHE[surphBoard] }
+    return next();
+  }
+
+  console.log('SURPH_BOARD_ENV: ', surphBoard);
+
   // const surph_board = await boardConfiguration(surphBoard);
-  const { board, contexts, tides, tools } = await boardConfiguration(surphBoard);
+  const { board = {}, contexts, tides, tools } = await boardConfiguration(surphBoard);
 
   const tideTools = []
   tides.forEach(t => {
@@ -61,6 +68,8 @@ module.exports = async (req, res, next) => {
     relativePath: `${SURPH_S3_URL}/boards/${surphBoard}/`
   };
 
+  BOARD_CACHE[surphBoard] = { ...req.surph_board }
+
   // console.log('\n\nSURPH_BOARD: ', JSON.stringify(req.surph_board));
   next();
 }

package/toolserver/routes/index.js

@@ -63,7 +63,7 @@ router.get('/', async (req, res, next) => {
       contexts = []
     }
 
-    const user = userConfig ? userConfig.user : { permissions: [] }
+    const user = userConfig ? userConfig.user : { permissions: [] } // TODO: address this client side
     const creator = userConfig ? { _id: user._id, username: user.username, avatar: user.avatar } : {}
     const localTools = toolSlugs.map(slug => {
       const tool = manifest[slug]

package/toolserver/routes/tool.js

@@ -17,11 +17,12 @@ const loadTool = () => import(toolsPath).then((mod) => mod.default)
 const router = Router()
 
 const handler = async (event, tool) => {
-  const { args, context, user, board } = event
+  // "context" will eventually be deprecated, "contexts" is primary now.
+  const { args, context, contexts, user, board } = event
   let payload = null
   let errorMsg = null
   try {
-    payload = await tool({ args, context, user, board })
+    payload = await tool({ args, context, contexts, user, board })
   } catch (error) {
     errorMsg = error instanceof Error ? error.message : String(error)
   } finally {
@@ -94,13 +95,11 @@ router.get('/test', async (req, res, next) => {
 
 router.post('/custom', async (req, res, next) => {
   try {
-    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.`)
-    // }
-
+    // "context" will eventually be deprecated, "contexts" is primary now.
+    const { name, args, tool, user = null, context = null, contexts = null, board = null } = req.body;
     const toolRunner = await loadTool()
-    const response = await handler({ args, context, user, board }, toolRunner)
+
+    const response = await handler({ args, context, contexts, user, board }, toolRunner)
     if (response.error) {
       throw new Error(response.error);
     }

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

@@ -1,45 +0,0 @@
-import type { ToolHandler } from '@surph_ai/sdk';
-import { surph } from '@surph_ai/sdk';
-
-// your custom tool args goes here
-type ToolArgs = {
-  preferences: string[]
-};
-
-const handler: ToolHandler<ToolArgs> = async ({ args, user, context = null, board = null }: Record<string, any>) => {
-  try {
-    if (!args) {
-      throw new Error('Args required.')
-    }
-
-    if (!context) {
-      throw new Error('Context required.')
-    }
-
-    const { preferences } = args; // string[]
-    const searchQuery = preferences.join(', ')
-
-    const searchResults = await surph.search(searchQuery, context)
-
-    const promptResponse = await surph.prompt({
-      instructions: `searchResults is a JSON array data feed of events and announcements. Your job is to sort each item into one of three categories: offering free food, free event, or free giveaway (such as raffles, prizes, etc.).`,
-      prompt: `Given this list of items, separate them into free food, free event, or free giveaway:\n\n${JSON.stringify(searchResults)}`,
-      output: {
-        name: 'deal_search_results',
-        description: 'The deal search results',
-        fields: [
-          { name: 'food', type: 'array', description: 'a list of events and announcements with free food.' },
-          { name: 'event',  type: 'array', description: 'a list of events that are free to attend.' },
-          { name: 'items', type: 'array', description: 'a list of events and announcements with free items.' }
-        ]
-      }
-    })
-
-    return promptResponse
-  } catch (error) {
-    throw error
-  }
-};
-
-export default handler;
-

package/scaffold/tool/examples/dealfinder/manifest.json

@@ -1,21 +0,0 @@
-{
-  "deal-finder-q9je7jou": {
-    "name": "deal-finder",
-    "slug": "deal-finder-q9je7jou",
-    "type": "custom",
-    "description": "Search the user's active Surph context for local deals, discounts, promotions, specials, sales, and related opportunities across food, drinks, restaurants, shops, events, entertainment, and other businesses or venues covered by the context. Use whenever the user asks to find, compare, filter, or recommend current or upcoming local deals—including requests for happy hours, meal specials, event discounts, retail sales, coupons, or promotions. Prefer this instead of webSearch when the requested local businesses, venues, events, or listings are represented in the active Surph context.",
-    "parameters": {
-      "type": "object",
-      "properties": {
-        "preferences": {
-          "type": "array",
-          "description": "Optional free-form preferences, categories, constraints, or deal criteria to prioritize, such as food, drinks, events, retail sales, happy hour, nearby neighborhoods, budget, dates, or specific businesses.",
-          "items": {
-            "type": "string"
-          }
-        }
-      },
-      "required": []
-    }
-  }
-}