Regex template function

This commit is contained in:
Gregory Schier
2025-07-23 13:33:58 -07:00
parent f1acb3c925
commit 1b90842d30
3 changed files with 253 additions and 17 deletions

View File

@@ -1,32 +1,74 @@
import type { TemplateFunctionArg } from '@yaakapp-internal/plugins';
import type { CallTemplateFunctionArgs, Context, PluginDefinition } from '@yaakapp/api';
const inputArg: TemplateFunctionArg = {
type: 'text',
name: 'input',
label: 'Input Text',
multiLine: true,
};
const regexArg: TemplateFunctionArg = {
type: 'text',
name: 'regex',
label: 'Regular Expression',
placeholder: '\\w+',
defaultValue: '.*',
description:
'A JavaScript regular expression. Use a capture group to reference parts of the match in the replacement.',
};
export const plugin: PluginDefinition = {
templateFunctions: [
{
name: 'regex.match',
description: 'Extract',
args: [
{
type: 'text',
name: 'regex',
label: 'Regular Expression',
placeholder: '^\\w+=(?<value>\\w*)$',
defaultValue: '^(.*)$',
description:
'A JavaScript regular expression, evaluated using the Node.js RegExp engine. Capture groups or named groups can be used to extract values.',
},
{ type: 'text', name: 'input', label: 'Input Text', multiLine: true },
],
description: 'Extract text using a regular expression',
args: [inputArg, regexArg],
async onRender(_ctx: Context, args: CallTemplateFunctionArgs): Promise<string | null> {
if (!args.values.regex || !args.values.input) return '';
const input = String(args.values.input ?? '');
const regex = new RegExp(String(args.values.regex ?? ''));
const input = String(args.values.input);
const regex = new RegExp(String(args.values.regex));
const match = input.match(regex);
return match?.groups
? (Object.values(match.groups)[0] ?? '')
: (match?.[1] ?? match?.[0] ?? '');
},
},
{
name: 'regex.replace',
description: 'Replace text using a regular expression',
args: [
inputArg,
regexArg,
{
type: 'text',
name: 'replacement',
label: 'Replacement Text',
placeholder: 'hello $1',
description:
'The replacement text. Use $1, $2, ... to reference capture groups or $& to reference the entire match.',
},
{
type: 'text',
name: 'flags',
label: 'Flags',
placeholder: 'g',
defaultValue: 'g',
optional: true,
description:
'Regular expression flags (g for global, i for case-insensitive, m for multiline, etc.)',
},
],
async onRender(_ctx: Context, args: CallTemplateFunctionArgs): Promise<string | null> {
const input = String(args.values.input ?? '');
const replacement = String(args.values.replacement ?? '');
const flags = String(args.values.flags || '');
const regex = String(args.values.regex);
if (!regex) return '';
return input.replace(new RegExp(String(args.values.regex), flags), replacement);
},
},
],
};

View File

@@ -0,0 +1,194 @@
import { describe, expect, it } from 'vitest';
import type { Context } from '@yaakapp/api';
import { plugin } from '../src';
describe('regex.match', () => {
const matchFunction = plugin.templateFunctions!.find(f => f.name === 'regex.match');
it('should exist', () => {
expect(matchFunction).toBeDefined();
});
it('should extract first capture group', async () => {
const result = await matchFunction!.onRender({} as Context, {
values: {
regex: 'Hello (\\w+)',
input: 'Hello World',
},
purpose: 'send',
});
expect(result).toBe('World');
});
it('should extract named capture group', async () => {
const result = await matchFunction!.onRender({} as Context, {
values: {
regex: 'Hello (?<name>\\w+)',
input: 'Hello World',
},
purpose: 'send',
});
expect(result).toBe('World');
});
it('should return full match when no capture groups', async () => {
const result = await matchFunction!.onRender({} as Context, {
values: {
regex: 'Hello \\w+',
input: 'Hello World'
},
purpose: 'send',
});
expect(result).toBe('Hello World');
});
it('should return empty string when no match', async () => {
const result = await matchFunction!.onRender({} as Context, {
values: {
regex: 'Goodbye',
input: 'Hello World'
},
purpose: 'send',
});
expect(result).toBe('');
});
it('should return empty string when regex is empty', async () => {
const result = await matchFunction!.onRender({} as Context, {
values: {
regex: '',
input: 'Hello World'
},
purpose: 'send',
});
expect(result).toBe('');
});
it('should return empty string when input is empty', async () => {
const result = await matchFunction!.onRender({} as Context, {
values: {
regex: 'Hello',
input: ''
},
purpose: 'send',
});
expect(result).toBe('');
});
});
describe('regex.replace', () => {
const replaceFunction = plugin.templateFunctions!.find(f => f.name === 'regex.replace');
it('should exist', () => {
expect(replaceFunction).toBeDefined();
});
it('should replace one occurrence by default', async () => {
const result = await replaceFunction!.onRender({} as Context, {
values: {
regex: 'o',
input: 'Hello World',
replacement: 'a'
},
purpose: 'send',
});
expect(result).toBe('Hella World');
});
it('should replace with capture groups', async () => {
const result = await replaceFunction!.onRender({} as Context, {
values: {
regex: '(\\w+) (\\w+)',
input: 'Hello World',
replacement: '$2 $1'
},
purpose: 'send',
});
expect(result).toBe('World Hello');
});
it('should replace with full match reference', async () => {
const result = await replaceFunction!.onRender({} as Context, {
values: {
regex: 'World',
input: 'Hello World',
replacement: '[$&]'
},
purpose: 'send',
});
expect(result).toBe('Hello [World]');
});
it('should respect flags parameter', async () => {
const result = await replaceFunction!.onRender({} as Context, {
values: {
regex: 'hello',
input: 'Hello World',
replacement: 'Hi',
flags: 'i'
},
purpose: 'send',
});
expect(result).toBe('Hi World');
});
it('should handle empty replacement', async () => {
const result = await replaceFunction!.onRender({} as Context, {
values: {
regex: 'World',
input: 'Hello World',
replacement: ''
},
purpose: 'send',
});
expect(result).toBe('Hello ');
});
it('should return original input when no match', async () => {
const result = await replaceFunction!.onRender({} as Context, {
values: {
regex: 'Goodbye',
input: 'Hello World',
replacement: 'Hi'
},
purpose: 'send',
});
expect(result).toBe('Hello World');
});
it('should return empty string when regex is empty', async () => {
const result = await replaceFunction!.onRender({} as Context, {
values: {
regex: '',
input: 'Hello World',
replacement: 'Hi'
},
purpose: 'send',
});
expect(result).toBe('');
});
it('should return empty string when input is empty', async () => {
const result = await replaceFunction!.onRender({} as Context, {
values: {
regex: 'Hello',
input: '',
replacement: 'Hi'
},
purpose: 'send',
});
expect(result).toBe('');
});
it('should throw on invalid regex', async () => {
const fn = replaceFunction!.onRender({} as Context, {
values: {
regex: '[',
input: 'Hello World',
replacement: 'Hi'
},
purpose: 'send',
});
await expect(fn).rejects.toThrow('Invalid regular expression: /[/: Unterminated character class');
});
});

View File

@@ -33,7 +33,7 @@ export function resolvedModelName(r: AnyModel | null): string {
}
// Strip unnecessary protocol
const withoutProto = withoutVariables.replace(/^https?:\/\//, '');
const withoutProto = withoutVariables.replace(/^(http|https|ws|wss):\/\//, '');
return withoutProto;
}