Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .claude/skills/frigg/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ class QuoApi extends ApiKeyRequester {
### Project Setup

```bash
npx create-frigg-app my-integration
frigg init my-integration
cd my-integration
npm install
```
Expand Down Expand Up @@ -1004,7 +1004,7 @@ Response (200): {
**Trigger Database Migration**

```bash
POST /db-migrate
POST /admin/db-migrate
x-frigg-admin-api-key: ${ADMIN_API_KEY}
Content-Type: application/json

Expand All @@ -1018,15 +1018,15 @@ Response (202): {
"success": true,
"processId": "mig-1642512000-abc123",
"state": "INITIALIZING",
"statusUrl": "/db-migrate/mig-1642512000-abc123",
"statusUrl": "/admin/db-migrate/mig-1642512000-abc123",
"message": "Migration job queued successfully"
}
```

**Check Migration Status**

```bash
GET /db-migrate/status?stage=production
GET /admin/db-migrate/status?stage=production
x-frigg-admin-api-key: ${ADMIN_API_KEY}

Response (200): {
Expand All @@ -1042,14 +1042,14 @@ Response (200): {
"pendingMigrations": 3,
"dbType": "postgresql",
"stage": "production",
"recommendation": "Run POST /db-migrate to apply pending migrations"
"recommendation": "Run POST /admin/db-migrate to apply pending migrations"
}
```

**Get Migration Details**

```bash
GET /db-migrate/${MIGRATION_ID}?stage=production
GET /admin/db-migrate/${MIGRATION_ID}?stage=production
x-frigg-admin-api-key: ${ADMIN_API_KEY}

Response (200): {
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ on:
- gitbook-updates
paths-ignore:
- docs/**
permissions:
contents: write
id-token: write

jobs:
release:
runs-on: ubuntu-latest
Expand All @@ -30,6 +34,7 @@ jobs:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
run: |
npm install -g npm@latest
npm ci
cd packages/ui
npm run build
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,4 @@ claude-flow.log
/packages/devtools/management-ui/dist
/packages/devtools/management-ui/.claude-flow
/.claude-flow
analysis-reports/
37 changes: 34 additions & 3 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This file provides guidance to Claude Code when working with the Frigg Framework

### Core Philosophy

Build enterprise-grade integrations as simply as `create-frigg-app`. Framework handles the infrastructure, developers focus on integration logic.
Build enterprise-grade integrations as simply as `frigg init`. Framework handles the infrastructure, developers focus on integration logic.

### Monorepo Structure

Expand Down Expand Up @@ -49,7 +49,7 @@ frigg/

```bash
# Create new Frigg app
npx create-frigg-app my-integration
frigg init my-integration

# Install API modules
frigg install hubspot
Expand Down Expand Up @@ -171,6 +171,37 @@ class MyIntegration extends IntegrationBase {
}
```

### Integration Patterns (Sync, Queues, Webhooks)

For complex integrations requiring sync orchestration, queue management, and webhook handling, see the **[Integration Patterns Guide](/docs/guides/INTEGRATION-PATTERNS.md)**.

Key patterns covered:

- **Process Model**: Track long-running operations with state management (`INITIALIZING` → `PROCESSING` → `COMPLETED`)
- **friggCommands**: Standardized interface for persisting integration config (`createFriggCommands()`)
- **QueueManager**: AWS SQS wrapper for async job processing with rate limiting and fan-out
- **Integration Events**: Define `USER_ACTION`, `CRON`, `QUEUE`, and `WEBHOOK` event handlers
- **SyncOrchestrator**: Coordinate sync operations across entity types

Quick example:

```javascript
const { createFriggCommands } = require('@friggframework/core');

class MyIntegration extends IntegrationBase {
constructor(params) {
super(params);
this.commands = createFriggCommands({ integrationClass: MyIntegration });

this.events = {
INITIAL_SYNC: { type: 'USER_ACTION', handler: this.startSync.bind(this) },
ONGOING_SYNC: { type: 'CRON', handler: this.deltaSync.bind(this) },
PROCESS_BATCH: { handler: this.processBatch.bind(this) }
};
}
}
```

### Encryption & Security

- **Field-Level Encryption**: Transparent database-agnostic encryption via Prisma Client Extensions
Expand Down Expand Up @@ -870,7 +901,7 @@ When working on the Frigg Framework, always prioritize finding the **best soluti

### Integration Development

1. Start with `create-frigg-app` for consistent structure
1. Start with `frigg init` for consistent structure
2. Use existing API modules when possible
3. Follow the IntegrationBase method contracts
4. Implement proper error handling and logging
Expand Down
Loading
Loading