Helper Functions & Utilities

1
import {
2
  createSimpleContext,
3
  createSimpleApiTool,
4
  createExpressionTool,
5
  setAllowedEnvPrefixes,
6
  getAllowedEnvPrefixes,
7
  safeAssign,
8
  filterSensitiveHeaders,
9
  redactUrl,
10
  inferSchema,
11
  registerBuiltinSkills,
12
} from '@signalwire/sdk';

1
createSimpleContext(name?: string): Context

1
import { createSimpleContext } from '@signalwire/sdk';
2
3
const ctx = createSimpleContext();
4
ctx.addStep('greet', { task: 'Say hello to the caller.' });
5
ctx.addStep('help', { task: 'Ask how you can help today.' });

1
createSimpleApiTool(opts: {
2
  name: string;
3
  url: string;
4
  responseTemplate: string;
5
  parameters?: Record<string, {
6
    type?: string;
7
    description?: string;
8
    required?: boolean;
9
  }>;
10
  method?: string;
11
  headers?: Record<string, string>;
12
  body?: Record<string, unknown>;
13
  errorKeys?: string[];
14
}): DataMap

1
import { AgentBase, createSimpleApiTool } from '@signalwire/sdk';
2
3
const weatherTool = createSimpleApiTool({
4
  name: 'get_weather',
5
  url: 'https://api.weather.com/v1/current?key=API_KEY&q=${args.location}',
6
  responseTemplate:
7
    'Weather in ${args.location}: ${response.current.condition.text}, ${response.current.temp_f}F',
8
  parameters: {
9
    location: {
10
      type: 'string',
11
      description: 'City name',
12
      required: true,
13
    },
14
  },
15
});
16
17
const agent = new AgentBase({ name: 'weather-agent' });
18
weatherTool.registerWithAgent(agent);

1
createExpressionTool(opts: {
2
  name: string;
3
  patterns: Record<string, [string, FunctionResult]>;
4
  parameters?: Record<string, {
5
    type?: string;
6
    description?: string;
7
    required?: boolean;
8
  }>;
9
}): DataMap

1
import { AgentBase, FunctionResult, createExpressionTool } from '@signalwire/sdk';
2
3
const routingTool = createExpressionTool({
4
  name: 'route_command',
5
  patterns: {
6
    '${args.command}': [
7
      'play.*',
8
      new FunctionResult('Starting playback.'),
9
    ],
10
  },
11
  parameters: {
12
    command: { type: 'string', description: 'The command to route', required: true },
13
    filename: { type: 'string', description: 'File to play' },
14
  },
15
});
16
17
const agent = new AgentBase({ name: 'router' });
18
routingTool.registerWithAgent(agent);

1
setAllowedEnvPrefixes(prefixes: string[]): void

1
import { setAllowedEnvPrefixes } from '@signalwire/sdk';
2
3
// Allow custom prefixes in addition to defaults
4
setAllowedEnvPrefixes(['SIGNALWIRE_', 'SWML_', 'SW_', 'MY_APP_']);

1
getAllowedEnvPrefixes(): string[]

1
import { getAllowedEnvPrefixes } from '@signalwire/sdk';
2
3
const prefixes = getAllowedEnvPrefixes();
4
console.log(prefixes);
5
// ['SIGNALWIRE_', 'SWML_', 'SW_']

1
import { safeAssign } from '@signalwire/sdk';
2
3
const target = { a: 1 };
4
safeAssign(target, { b: 2, __proto__: 'blocked' });
5
console.log(target); // { a: 1, b: 2 }

1
import { filterSensitiveHeaders } from '@signalwire/sdk';
2
3
const raw = { 'content-type': 'application/json', authorization: 'Bearer secret' };
4
const safe = filterSensitiveHeaders(raw);
5
console.log(safe); // { 'content-type': 'application/json' }

1
import { redactUrl } from '@signalwire/sdk';
2
3
console.log(redactUrl('https://admin:secret@example.com/api'));
4
// "https://admin:****@example.com/api"

1
import { MAX_SKILL_INPUT_LENGTH } from '@signalwire/sdk';
2
3
console.log(MAX_SKILL_INPUT_LENGTH); // 1000

1
import { inferSchema } from '@signalwire/sdk';
2
3
const schema = inferSchema((city: string, units = 'metric') => {});
4
console.log(schema?.parameters);
5
// { city: { type: 'string' }, units: { type: 'string' } }
6
console.log(schema?.required); // ['city']

1
import { registerBuiltinSkills, SkillRegistry } from '@signalwire/sdk';
2
3
registerBuiltinSkills();
4
const registry = SkillRegistry.getInstance();
5
console.log(registry.listRegistered()); // ['datetime', 'math', 'joke', ...]