mahoraga-sources

Pluggable source adapters for analytics platforms, used by Mahoraga.

Install

npm install mahoraga-sources

Usage

import { AmplitudeAdapter, PipelineRunner } from 'mahoraga-sources';
import { createDatabase, EventStore, CheckpointStore } from 'mahoraga-core';

const dbManager = createDatabase('.mahoraga/mahoraga.db');
const runner = new PipelineRunner(
  new EventStore(dbManager.db),
  new CheckpointStore(dbManager.db),
);

const adapter = new AmplitudeAdapter();
const result = await runner.run(
  adapter,
  {
    apiKey: process.env.MAHORAGA_AMPLITUDE_API_KEY!,
    secretKey: process.env.MAHORAGA_AMPLITUDE_SECRET_KEY!,
  },
  { start: Date.now() - 86400000, end: Date.now() },
);

console.log(result);
// { status: 'ok', eventCount: 1234 }

Supported Sources

| Source | Status | Adapter | |--------|--------|---------| | Amplitude | Available | AmplitudeAdapter | | PostHog | Available | PostHogAdapter | | Sentry | Planned | — |

Writing a Custom Adapter

Implement the SourceAdapter interface:

import type { SourceAdapter, AdapterConfig, PullBatch } from 'mahoraga-sources';
import type { TimeRange, Cursor } from 'mahoraga-core';

export class MyAdapter implements SourceAdapter {
  name = 'my-source';

  async *pull(config: AdapterConfig, timeRange: TimeRange, _cursor?: Cursor): AsyncIterable<PullBatch> {
    // Yield batches of normalized events
    yield { events: [...], cursor: { value: 'next-page-token', updatedAt: Date.now() } };
  }
}

License

MIT