@apibara/indexer 2.0.0-beta.0 → 2.0.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apibara/indexer",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.3",
   "type": "module",
   "source": "./src/index.ts",
   "main": "./dist/index.mjs",
@@ -23,6 +23,12 @@
       "require": "./dist/sinks/csv.cjs",
       "default": "./dist/sinks/csv.mjs"
     },
+    "./sinks/drizzle": {
+      "types": "./dist/sinks/drizzle/index.d.ts",
+      "import": "./dist/sinks/drizzle/index.mjs",
+      "require": "./dist/sinks/drizzle/index.cjs",
+      "default": "./dist/sinks/drizzle/index.mjs"
+    },
     "./testing": {
       "types": "./dist/testing/index.d.ts",
       "import": "./dist/testing/index.mjs",
@@ -30,43 +36,48 @@
       "default": "./dist/testing/index.mjs"
     }
   },
-  "publishConfig": {
-    "files": [
-      "dist",
-      "src",
-      "README.md"
-    ]
+  "publishConfig": {},
+  "scripts": {
+    "build": "unbuild",
+    "lint": "biome check .",
+    "typecheck": "tsc --noEmit",
+    "lint:fix": "pnpm lint --write",
+    "test": "vitest",
+    "test:ci": "vitest run",
+    "format": "biome format . --write"
   },
   "devDependencies": {
     "@types/better-sqlite3": "^7.6.11",
     "@types/node": "^20.14.0",
+    "@types/pg": "^8.11.10",
     "better-sqlite3": "^11.1.2",
     "csv-stringify": "^6.5.0",
+    "drizzle-orm": "^0.33.0",
+    "pg": "^8.12.0",
+    "postgres-range": "^1.1.4",
     "unbuild": "^2.0.0",
     "vitest": "^1.6.0"
   },
   "dependencies": {
+    "@apibara/protocol": "2.0.0-beta.3",
     "@opentelemetry/api": "^1.9.0",
     "consola": "^3.2.3",
     "hookable": "^5.5.3",
     "klona": "^2.0.6",
     "nice-grpc": "^2.1.8",
-    "unctx": "^2.3.1",
-    "@apibara/protocol": "2.0.0-beta.1"
+    "unctx": "^2.3.1"
   },
   "peerDependencies": {
     "better-sqlite3": "^11.1.2",
     "csv-stringify": "^6.5.0",
+    "drizzle-orm": "^0.33.0",
+    "postgres-range": "^1.1.4",
     "vitest": "^1.6.0"
   },
-  "scripts": {
-    "build": "unbuild",
-    "lint": "biome check .",
-    "typecheck": "tsc --noEmit",
-    "lint:fix": "pnpm lint --write",
-    "test": "vitest",
-    "test:ci": "vitest run",
-    "format": "biome format . --write"
-  },
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
   "types": "./dist/index.d.ts"
-}
+}

package/src/context.ts

@@ -1,14 +1,19 @@
 import { AsyncLocalStorage } from "node:async_hooks";
 import { getContext } from "unctx";
+import type { Sink } from "./sink";
 
 // biome-ignore lint/suspicious/noExplicitAny: context type
-export interface IndexerContext extends Record<string, any> {}
+export interface IndexerContext<TTxnParams = any> extends Record<string, any> {
+  sink?: Sink<TTxnParams>;
+  sinkTransaction?: TTxnParams;
+}
 
 export const indexerAsyncContext = getContext<IndexerContext>("indexer", {
   asyncContext: true,
   AsyncLocalStorage,
 });
 
-export function useIndexerContext() {
-  return indexerAsyncContext.use();
+// biome-ignore lint/suspicious/noExplicitAny: <explanation>
+export function useIndexerContext<TTxnParams = any>() {
+  return indexerAsyncContext.use() as IndexerContext<TTxnParams>;
 }

package/src/hooks/index.ts

@@ -1 +1,2 @@
 export * from "./useKVStore";
+export * from "./useSink";

package/src/hooks/useSink.ts

@@ -0,0 +1,13 @@
+import type { IndexerContext } from "../context";
+
+export function useSink<TTxnParams>({
+  context,
+}: {
+  context: IndexerContext<TTxnParams>;
+}) {
+  if (!context.sinkTransaction) {
+    throw new Error("Transaction context doesn't exist!");
+  }
+
+  return context.sinkTransaction;
+}

package/src/index.ts

@@ -4,3 +4,4 @@ export { useIndexerContext } from "./context";
 
 export * from "./plugins";
 export * from "./vcr";
+export * from "./hooks";

package/src/indexer.test.ts

@@ -4,12 +4,12 @@ import {
   type MockFilter,
 } from "@apibara/protocol/testing";
 import Database from "better-sqlite3";
-import { klona } from "klona/full";
 import { describe, expect, it } from "vitest";
+import { useSink } from "./hooks";
 import { run } from "./indexer";
 import { SqlitePersistence, sqlitePersistence } from "./plugins/persistence";
 import { generateMockMessages, vcr } from "./testing";
-import { type MockRet, getMockIndexer } from "./testing/indexer";
+import { getMockIndexer } from "./testing/indexer";
 
 describe("Run Test", () => {
   it("should stream messages", async () => {
@@ -18,7 +18,18 @@ describe("Run Test", () => {
     });
 
     const sink = vcr();
-    await run(client, getMockIndexer(), sink);
+
+    const indexer = getMockIndexer({
+      sink,
+      override: {
+        transform: async ({ context, endCursor, block: { data } }) => {
+          const { writer } = useSink({ context });
+          writer.insert([{ data }]);
+        },
+      },
+    });
+
+    await run(client, indexer);
 
     expect(sink.result).toMatchInlineSnapshot(`
       [
@@ -246,28 +257,37 @@ describe("Run Test", () => {
 
     const db = Database(":memory:");
 
-    const persistence = sqlitePersistence<MockFilter, MockBlock, MockRet>({
-      database: db,
-    });
+    const sink = vcr();
 
     // create mock indexer with persistence plugin
-    const indexer = klona(getMockIndexer([persistence]));
-    indexer.options.startingCursor = { orderKey: 100n };
-    indexer.options.factory = async (block) => {
-      if (block.data === "B") {
-        return { filter: { filter: "B" } };
-      }
-
-      if (block.data === "C") {
-        return { filter: { filter: "C" } };
-      }
-
-      return {};
-    };
-
-    const sink = vcr();
+    const indexer = getMockIndexer({
+      plugins: [
+        sqlitePersistence({
+          database: db,
+        }),
+      ],
+      sink,
+      override: {
+        startingCursor: { orderKey: 100n },
+        factory: async ({ block }) => {
+          if (block.data === "B") {
+            return { filter: { filter: "B" } };
+          }
+
+          if (block.data === "C") {
+            return { filter: { filter: "C" } };
+          }
+
+          return {};
+        },
+        transform: async ({ context, endCursor, block: { data } }) => {
+          const { writer } = useSink({ context });
+          writer.insert([{ data }]);
+        },
+      },
+    });
 
-    await run(client, indexer, sink);
+    await run(client, indexer);
 
     const store = new SqlitePersistence<MockFilter>(db);
 
@@ -423,28 +443,37 @@ describe("Run Test", () => {
 
     const db = Database(":memory:");
 
-    const persistence = sqlitePersistence<MockFilter, MockBlock, MockRet>({
-      database: db,
-    });
+    const sink = vcr();
 
     // create mock indexer with persistence plugin
-    const indexer = klona(getMockIndexer([persistence]));
-    indexer.options.startingCursor = { orderKey: 100n };
-    indexer.options.factory = async (block) => {
-      if (block.data === "B") {
-        return { filter: { filter: "B" } };
-      }
-
-      if (block.data === "C") {
-        return { filter: { filter: "C" } };
-      }
-
-      return {};
-    };
-
-    const sink = vcr();
+    const indexer = getMockIndexer({
+      plugins: [
+        sqlitePersistence({
+          database: db,
+        }),
+      ],
+      sink,
+      override: {
+        startingCursor: { orderKey: 100n },
+        factory: async ({ block }) => {
+          if (block.data === "B") {
+            return { filter: { filter: "B" } };
+          }
+
+          if (block.data === "C") {
+            return { filter: { filter: "C" } };
+          }
+
+          return {};
+        },
+        transform: async ({ context, endCursor, block: { data } }) => {
+          const { writer } = useSink({ context });
+          writer.insert([{ data }]);
+        },
+      },
+    });
 
-    await expect(() => run(client, indexer, sink)).rejects.toThrowError(
+    await expect(() => run(client, indexer)).rejects.toThrowError(
       "this error should occurr!",
     );