Triggerkit

A Trigger.dev extension that enables seamless integration between SvelteKit and Trigger.dev by allowing you to use your SvelteKit functions directly in your Trigger.dev projects.

Features

• 🔄 Use SvelteKit functions directly in Trigger.dev jobs
• 📦 Automatic function discovery and export
• 🔍 TypeScript support with type preservation
• 🌐 Works with Trigger.dev V3
• 🎯 Configurable directory scanning

Installation

npm add -D triggerkit

Quick Start

1. Configure Trigger.dev to use the plugin:

import { sveltekit } from '@sveltejs/kit/vite';
import { triggerkit } from 'triggerkit';

export default defineConfig({
  project: "your-project-id",
  runtime: "node",
  build: {
    extensions: [
      triggerkit({
        includeDirs: ['src/lib/server']
      })
    ]
  }
});

2. Write your server functions in SvelteKit:

// src/lib/server/email.ts
import { EMAIL_API_KEY } from '$env/static/private';

/**
 * Sends a welcome email to a new user
 */
export async function sendWelcomeEmail(userId: string) {
  // Your email sending logic using EMAIL_API_KEY
  return { success: true, userId };
}

3. Use them in your Trigger.dev project:

import { sendWelcomeEmail } from "virtual:triggerkit";
import { task } from "@trigger.dev/sdk/v3";

export const welcomeEmailTask = task({
  id: "welcome-email",
  run: async (payload: { userId: string }) => {
    const result = await sendWelcomeEmail(payload.userId);
    return result;
  },
});

Configuration

interface PluginOptions {
  /**
   * Directories to scan for exportable functions.
   * @default ['src/lib', 'src/lib/server']
   */
  includeDirs?: string[];

  /**
   * File patterns to scan. Use forward slashes even on Windows.
   * @default ['**/*.ts', '**/*.js', '**/+server.ts']
   */
  filePatterns?: string[];

  /**
   * Patterns to exclude from scanning. Use forward slashes even on Windows.
   * @default ['**/node_modules/**', '**/*.test.ts', '**/*.spec.ts']
   */
  exclude?: string[];
}

Key Behaviors

• Automatically discovers and exports functions from specified directories
• Resolves module imports with automatic file extension handling
• Supports TypeScript and JavaScript files
• Preserves function types and metadata
• Handles SvelteKit environment variable imports

Accessing Functions

You can access all discovered functions through the functions object:

import { functions } from 'virtual:triggerkit';
// Call a discovered function
await functions.sendWelcomeEmail(userId);

Environment Variables

The plugin automatically handles environment variables imported from $env/static/private or $env/static/public, making them available in your Trigger.dev tasks through process.env.

Contributing

Contributions are welcome! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.