@apibara/indexer 2.0.0-beta.5 → 2.0.0-beta.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/dist/index.cjs +50 -0
  2. package/dist/index.d.cts +18 -0
  3. package/dist/index.d.mts +18 -0
  4. package/dist/index.d.ts +18 -0
  5. package/dist/index.mjs +34 -0
  6. package/dist/plugins/index.cjs +7 -0
  7. package/dist/plugins/index.d.cts +4 -0
  8. package/dist/plugins/index.d.mts +4 -0
  9. package/dist/plugins/index.d.ts +4 -0
  10. package/dist/plugins/index.mjs +5 -0
  11. package/dist/plugins/kv.cjs +131 -0
  12. package/dist/plugins/kv.d.cts +32 -0
  13. package/dist/plugins/kv.d.mts +32 -0
  14. package/dist/plugins/kv.d.ts +32 -0
  15. package/dist/plugins/kv.mjs +124 -0
  16. package/dist/plugins/persistence.cjs +182 -0
  17. package/dist/plugins/persistence.d.cts +50 -0
  18. package/dist/plugins/persistence.d.mts +50 -0
  19. package/dist/plugins/persistence.d.ts +50 -0
  20. package/dist/plugins/persistence.mjs +179 -0
  21. package/dist/shared/indexer.2c23c9cd.mjs +35 -0
  22. package/dist/shared/indexer.318d3617.cjs +47 -0
  23. package/dist/shared/indexer.36530330.mjs +249 -0
  24. package/dist/shared/indexer.500fd281.d.cts +23 -0
  25. package/dist/shared/indexer.541d43eb.cjs +266 -0
  26. package/dist/shared/indexer.93d6b2eb.mjs +17 -0
  27. package/dist/shared/indexer.a8b7ab1f.cjs +25 -0
  28. package/dist/shared/indexer.b9c8f0d8.d.cts +19 -0
  29. package/dist/shared/indexer.b9c8f0d8.d.mts +19 -0
  30. package/dist/shared/indexer.b9c8f0d8.d.ts +19 -0
  31. package/dist/shared/indexer.c7ed6b83.d.cts +82 -0
  32. package/dist/shared/indexer.e1856641.d.mts +23 -0
  33. package/dist/shared/indexer.e4f2430f.d.ts +23 -0
  34. package/dist/shared/indexer.e8bd138d.d.mts +82 -0
  35. package/dist/shared/indexer.f761abcd.d.ts +82 -0
  36. package/dist/sinks/csv.cjs +85 -0
  37. package/dist/sinks/csv.d.cts +66 -0
  38. package/dist/sinks/csv.d.mts +66 -0
  39. package/dist/sinks/csv.d.ts +66 -0
  40. package/dist/sinks/csv.mjs +78 -0
  41. package/dist/sinks/drizzle/index.cjs +210 -0
  42. package/dist/sinks/drizzle/index.d.cts +111 -0
  43. package/dist/sinks/drizzle/index.d.mts +111 -0
  44. package/dist/sinks/drizzle/index.d.ts +111 -0
  45. package/dist/sinks/drizzle/index.mjs +196 -0
  46. package/dist/sinks/sqlite.cjs +90 -0
  47. package/dist/sinks/sqlite.d.cts +71 -0
  48. package/dist/sinks/sqlite.d.mts +71 -0
  49. package/dist/sinks/sqlite.d.ts +71 -0
  50. package/dist/sinks/sqlite.mjs +87 -0
  51. package/dist/testing/index.cjs +64 -0
  52. package/dist/testing/index.d.cts +40 -0
  53. package/dist/testing/index.d.mts +40 -0
  54. package/dist/testing/index.d.ts +40 -0
  55. package/dist/testing/index.mjs +60 -0
  56. package/dist/vcr/index.cjs +25 -0
  57. package/dist/vcr/index.d.cts +18 -0
  58. package/dist/vcr/index.d.mts +18 -0
  59. package/dist/vcr/index.d.ts +18 -0
  60. package/dist/vcr/index.mjs +14 -0
  61. package/package.json +33 -11
  62. package/src/vcr/record.ts +1 -1
@@ -0,0 +1,82 @@
1
+ import { StreamDataRequest, StreamDataOptions, Cursor, DataFinality, StreamDataResponse, StreamConfig, Client } from '@apibara/protocol';
2
+ import { NestedHooks, Hookable } from 'hookable';
3
+ import { S as Sink } from './indexer.b9c8f0d8.cjs';
4
+
5
+ interface IndexerContext<TTxnParams = any> extends Record<string, any> {
6
+ sink?: Sink<TTxnParams>;
7
+ sinkTransaction?: TTxnParams;
8
+ }
9
+ declare function useIndexerContext<TTxnParams = any>(): IndexerContext<TTxnParams>;
10
+
11
+ type IndexerPlugin<TFilter, TBlock, TTxnParams> = (indexer: Indexer<TFilter, TBlock, TTxnParams>) => void;
12
+ declare function defineIndexerPlugin<TFilter, TBlock, TTxnParams>(def: IndexerPlugin<TFilter, TBlock, TTxnParams>): IndexerPlugin<TFilter, TBlock, TTxnParams>;
13
+
14
+ interface IndexerHooks<TFilter, TBlock> {
15
+ "run:before": () => void;
16
+ "run:after": () => void;
17
+ "connect:before": ({ request, options, }: {
18
+ request: StreamDataRequest<TFilter>;
19
+ options: StreamDataOptions;
20
+ }) => void;
21
+ "connect:after": () => void;
22
+ "connect:factory": ({ request, endCursor, }: {
23
+ request: StreamDataRequest<TFilter>;
24
+ endCursor?: Cursor;
25
+ }) => void;
26
+ "handler:before": ({ block, finality, endCursor, }: {
27
+ block: TBlock;
28
+ finality: DataFinality;
29
+ endCursor?: Cursor;
30
+ }) => void;
31
+ "handler:after": ({ block, finality, endCursor, }: {
32
+ block: TBlock;
33
+ finality: DataFinality;
34
+ endCursor?: Cursor;
35
+ }) => void;
36
+ "transaction:commit": ({ finality, endCursor, }: {
37
+ finality: DataFinality;
38
+ endCursor?: Cursor;
39
+ }) => void;
40
+ "handler:exception": ({ error }: {
41
+ error: Error;
42
+ }) => void;
43
+ message: ({ message }: {
44
+ message: StreamDataResponse<TBlock>;
45
+ }) => void;
46
+ }
47
+ interface IndexerConfig<TFilter, TBlock, TTxnParams> {
48
+ streamUrl: string;
49
+ filter: TFilter;
50
+ finality?: DataFinality;
51
+ startingCursor?: Cursor;
52
+ sink?: Sink<TTxnParams>;
53
+ factory?: ({ block, context, }: {
54
+ block: TBlock;
55
+ context: IndexerContext<TTxnParams>;
56
+ }) => Promise<{
57
+ filter?: TFilter;
58
+ }>;
59
+ transform: (args: {
60
+ block: TBlock;
61
+ cursor?: Cursor | undefined;
62
+ endCursor?: Cursor | undefined;
63
+ finality: DataFinality;
64
+ context: IndexerContext<TTxnParams>;
65
+ }) => Promise<void>;
66
+ hooks?: NestedHooks<IndexerHooks<TFilter, TBlock>>;
67
+ plugins?: ReadonlyArray<IndexerPlugin<TFilter, TBlock, TTxnParams>>;
68
+ debug?: boolean;
69
+ }
70
+ interface IndexerWithStreamConfig<TFilter, TBlock, TTxnParams> extends IndexerConfig<TFilter, TBlock, TTxnParams> {
71
+ streamConfig: StreamConfig<TFilter, TBlock>;
72
+ }
73
+ declare function defineIndexer<TFilter, TBlock>(streamConfig: StreamConfig<TFilter, TBlock>): <TTxnParams>(config: IndexerConfig<TFilter, TBlock, TTxnParams>) => IndexerWithStreamConfig<TFilter, TBlock, TTxnParams>;
74
+ interface Indexer<TFilter, TBlock, TTxnParams> {
75
+ streamConfig: StreamConfig<TFilter, TBlock>;
76
+ options: IndexerConfig<TFilter, TBlock, TTxnParams>;
77
+ hooks: Hookable<IndexerHooks<TFilter, TBlock>>;
78
+ }
79
+ declare function createIndexer<TFilter, TBlock, TTxnParams>({ streamConfig, ...options }: IndexerWithStreamConfig<TFilter, TBlock, TTxnParams>): Indexer<TFilter, TBlock, TTxnParams>;
80
+ declare function run<TFilter, TBlock, TTxnParams>(client: Client<TFilter, TBlock>, indexer: Indexer<TFilter, TBlock, TTxnParams>): Promise<void>;
81
+
82
+ export { type IndexerPlugin as I, type IndexerContext as a, type IndexerHooks as b, type IndexerConfig as c, type IndexerWithStreamConfig as d, defineIndexer as e, type Indexer as f, createIndexer as g, defineIndexerPlugin as h, run as r, useIndexerContext as u };
@@ -0,0 +1,23 @@
1
+ import { Cursor, Client } from '@apibara/protocol';
2
+ import { f as Indexer } from './indexer.e8bd138d.mjs';
3
+ import { b as SinkData } from './indexer.b9c8f0d8.mjs';
4
+
5
+ type VcrConfig = {
6
+ cassetteDir: string;
7
+ };
8
+ type CassetteOptions = {
9
+ name: string;
10
+ startingCursor: Cursor;
11
+ endingCursor: Cursor;
12
+ };
13
+
14
+ declare function replay<TFilter, TBlock, TTxnParams>(vcrConfig: VcrConfig, indexer: Indexer<TFilter, TBlock, TTxnParams>, cassetteName: string): Promise<VcrReplayResult>;
15
+ type VcrReplayResult = {
16
+ outputs: Array<{
17
+ endCursor?: Cursor;
18
+ data: SinkData[];
19
+ }>;
20
+ };
21
+ declare function loadCassette<TFilter, TBlock>(vcrConfig: VcrConfig, cassetteName: string): Client<TFilter, TBlock>;
22
+
23
+ export { type CassetteOptions as C, type VcrConfig as V, type VcrReplayResult as a, loadCassette as l, replay as r };
@@ -0,0 +1,23 @@
1
+ import { Cursor, Client } from '@apibara/protocol';
2
+ import { f as Indexer } from './indexer.f761abcd.js';
3
+ import { b as SinkData } from './indexer.b9c8f0d8.js';
4
+
5
+ type VcrConfig = {
6
+ cassetteDir: string;
7
+ };
8
+ type CassetteOptions = {
9
+ name: string;
10
+ startingCursor: Cursor;
11
+ endingCursor: Cursor;
12
+ };
13
+
14
+ declare function replay<TFilter, TBlock, TTxnParams>(vcrConfig: VcrConfig, indexer: Indexer<TFilter, TBlock, TTxnParams>, cassetteName: string): Promise<VcrReplayResult>;
15
+ type VcrReplayResult = {
16
+ outputs: Array<{
17
+ endCursor?: Cursor;
18
+ data: SinkData[];
19
+ }>;
20
+ };
21
+ declare function loadCassette<TFilter, TBlock>(vcrConfig: VcrConfig, cassetteName: string): Client<TFilter, TBlock>;
22
+
23
+ export { type CassetteOptions as C, type VcrConfig as V, type VcrReplayResult as a, loadCassette as l, replay as r };
@@ -0,0 +1,82 @@
1
+ import { StreamDataRequest, StreamDataOptions, Cursor, DataFinality, StreamDataResponse, StreamConfig, Client } from '@apibara/protocol';
2
+ import { NestedHooks, Hookable } from 'hookable';
3
+ import { S as Sink } from './indexer.b9c8f0d8.mjs';
4
+
5
+ interface IndexerContext<TTxnParams = any> extends Record<string, any> {
6
+ sink?: Sink<TTxnParams>;
7
+ sinkTransaction?: TTxnParams;
8
+ }
9
+ declare function useIndexerContext<TTxnParams = any>(): IndexerContext<TTxnParams>;
10
+
11
+ type IndexerPlugin<TFilter, TBlock, TTxnParams> = (indexer: Indexer<TFilter, TBlock, TTxnParams>) => void;
12
+ declare function defineIndexerPlugin<TFilter, TBlock, TTxnParams>(def: IndexerPlugin<TFilter, TBlock, TTxnParams>): IndexerPlugin<TFilter, TBlock, TTxnParams>;
13
+
14
+ interface IndexerHooks<TFilter, TBlock> {
15
+ "run:before": () => void;
16
+ "run:after": () => void;
17
+ "connect:before": ({ request, options, }: {
18
+ request: StreamDataRequest<TFilter>;
19
+ options: StreamDataOptions;
20
+ }) => void;
21
+ "connect:after": () => void;
22
+ "connect:factory": ({ request, endCursor, }: {
23
+ request: StreamDataRequest<TFilter>;
24
+ endCursor?: Cursor;
25
+ }) => void;
26
+ "handler:before": ({ block, finality, endCursor, }: {
27
+ block: TBlock;
28
+ finality: DataFinality;
29
+ endCursor?: Cursor;
30
+ }) => void;
31
+ "handler:after": ({ block, finality, endCursor, }: {
32
+ block: TBlock;
33
+ finality: DataFinality;
34
+ endCursor?: Cursor;
35
+ }) => void;
36
+ "transaction:commit": ({ finality, endCursor, }: {
37
+ finality: DataFinality;
38
+ endCursor?: Cursor;
39
+ }) => void;
40
+ "handler:exception": ({ error }: {
41
+ error: Error;
42
+ }) => void;
43
+ message: ({ message }: {
44
+ message: StreamDataResponse<TBlock>;
45
+ }) => void;
46
+ }
47
+ interface IndexerConfig<TFilter, TBlock, TTxnParams> {
48
+ streamUrl: string;
49
+ filter: TFilter;
50
+ finality?: DataFinality;
51
+ startingCursor?: Cursor;
52
+ sink?: Sink<TTxnParams>;
53
+ factory?: ({ block, context, }: {
54
+ block: TBlock;
55
+ context: IndexerContext<TTxnParams>;
56
+ }) => Promise<{
57
+ filter?: TFilter;
58
+ }>;
59
+ transform: (args: {
60
+ block: TBlock;
61
+ cursor?: Cursor | undefined;
62
+ endCursor?: Cursor | undefined;
63
+ finality: DataFinality;
64
+ context: IndexerContext<TTxnParams>;
65
+ }) => Promise<void>;
66
+ hooks?: NestedHooks<IndexerHooks<TFilter, TBlock>>;
67
+ plugins?: ReadonlyArray<IndexerPlugin<TFilter, TBlock, TTxnParams>>;
68
+ debug?: boolean;
69
+ }
70
+ interface IndexerWithStreamConfig<TFilter, TBlock, TTxnParams> extends IndexerConfig<TFilter, TBlock, TTxnParams> {
71
+ streamConfig: StreamConfig<TFilter, TBlock>;
72
+ }
73
+ declare function defineIndexer<TFilter, TBlock>(streamConfig: StreamConfig<TFilter, TBlock>): <TTxnParams>(config: IndexerConfig<TFilter, TBlock, TTxnParams>) => IndexerWithStreamConfig<TFilter, TBlock, TTxnParams>;
74
+ interface Indexer<TFilter, TBlock, TTxnParams> {
75
+ streamConfig: StreamConfig<TFilter, TBlock>;
76
+ options: IndexerConfig<TFilter, TBlock, TTxnParams>;
77
+ hooks: Hookable<IndexerHooks<TFilter, TBlock>>;
78
+ }
79
+ declare function createIndexer<TFilter, TBlock, TTxnParams>({ streamConfig, ...options }: IndexerWithStreamConfig<TFilter, TBlock, TTxnParams>): Indexer<TFilter, TBlock, TTxnParams>;
80
+ declare function run<TFilter, TBlock, TTxnParams>(client: Client<TFilter, TBlock>, indexer: Indexer<TFilter, TBlock, TTxnParams>): Promise<void>;
81
+
82
+ export { type IndexerPlugin as I, type IndexerContext as a, type IndexerHooks as b, type IndexerConfig as c, type IndexerWithStreamConfig as d, defineIndexer as e, type Indexer as f, createIndexer as g, defineIndexerPlugin as h, run as r, useIndexerContext as u };
@@ -0,0 +1,82 @@
1
+ import { StreamDataRequest, StreamDataOptions, Cursor, DataFinality, StreamDataResponse, StreamConfig, Client } from '@apibara/protocol';
2
+ import { NestedHooks, Hookable } from 'hookable';
3
+ import { S as Sink } from './indexer.b9c8f0d8.js';
4
+
5
+ interface IndexerContext<TTxnParams = any> extends Record<string, any> {
6
+ sink?: Sink<TTxnParams>;
7
+ sinkTransaction?: TTxnParams;
8
+ }
9
+ declare function useIndexerContext<TTxnParams = any>(): IndexerContext<TTxnParams>;
10
+
11
+ type IndexerPlugin<TFilter, TBlock, TTxnParams> = (indexer: Indexer<TFilter, TBlock, TTxnParams>) => void;
12
+ declare function defineIndexerPlugin<TFilter, TBlock, TTxnParams>(def: IndexerPlugin<TFilter, TBlock, TTxnParams>): IndexerPlugin<TFilter, TBlock, TTxnParams>;
13
+
14
+ interface IndexerHooks<TFilter, TBlock> {
15
+ "run:before": () => void;
16
+ "run:after": () => void;
17
+ "connect:before": ({ request, options, }: {
18
+ request: StreamDataRequest<TFilter>;
19
+ options: StreamDataOptions;
20
+ }) => void;
21
+ "connect:after": () => void;
22
+ "connect:factory": ({ request, endCursor, }: {
23
+ request: StreamDataRequest<TFilter>;
24
+ endCursor?: Cursor;
25
+ }) => void;
26
+ "handler:before": ({ block, finality, endCursor, }: {
27
+ block: TBlock;
28
+ finality: DataFinality;
29
+ endCursor?: Cursor;
30
+ }) => void;
31
+ "handler:after": ({ block, finality, endCursor, }: {
32
+ block: TBlock;
33
+ finality: DataFinality;
34
+ endCursor?: Cursor;
35
+ }) => void;
36
+ "transaction:commit": ({ finality, endCursor, }: {
37
+ finality: DataFinality;
38
+ endCursor?: Cursor;
39
+ }) => void;
40
+ "handler:exception": ({ error }: {
41
+ error: Error;
42
+ }) => void;
43
+ message: ({ message }: {
44
+ message: StreamDataResponse<TBlock>;
45
+ }) => void;
46
+ }
47
+ interface IndexerConfig<TFilter, TBlock, TTxnParams> {
48
+ streamUrl: string;
49
+ filter: TFilter;
50
+ finality?: DataFinality;
51
+ startingCursor?: Cursor;
52
+ sink?: Sink<TTxnParams>;
53
+ factory?: ({ block, context, }: {
54
+ block: TBlock;
55
+ context: IndexerContext<TTxnParams>;
56
+ }) => Promise<{
57
+ filter?: TFilter;
58
+ }>;
59
+ transform: (args: {
60
+ block: TBlock;
61
+ cursor?: Cursor | undefined;
62
+ endCursor?: Cursor | undefined;
63
+ finality: DataFinality;
64
+ context: IndexerContext<TTxnParams>;
65
+ }) => Promise<void>;
66
+ hooks?: NestedHooks<IndexerHooks<TFilter, TBlock>>;
67
+ plugins?: ReadonlyArray<IndexerPlugin<TFilter, TBlock, TTxnParams>>;
68
+ debug?: boolean;
69
+ }
70
+ interface IndexerWithStreamConfig<TFilter, TBlock, TTxnParams> extends IndexerConfig<TFilter, TBlock, TTxnParams> {
71
+ streamConfig: StreamConfig<TFilter, TBlock>;
72
+ }
73
+ declare function defineIndexer<TFilter, TBlock>(streamConfig: StreamConfig<TFilter, TBlock>): <TTxnParams>(config: IndexerConfig<TFilter, TBlock, TTxnParams>) => IndexerWithStreamConfig<TFilter, TBlock, TTxnParams>;
74
+ interface Indexer<TFilter, TBlock, TTxnParams> {
75
+ streamConfig: StreamConfig<TFilter, TBlock>;
76
+ options: IndexerConfig<TFilter, TBlock, TTxnParams>;
77
+ hooks: Hookable<IndexerHooks<TFilter, TBlock>>;
78
+ }
79
+ declare function createIndexer<TFilter, TBlock, TTxnParams>({ streamConfig, ...options }: IndexerWithStreamConfig<TFilter, TBlock, TTxnParams>): Indexer<TFilter, TBlock, TTxnParams>;
80
+ declare function run<TFilter, TBlock, TTxnParams>(client: Client<TFilter, TBlock>, indexer: Indexer<TFilter, TBlock, TTxnParams>): Promise<void>;
81
+
82
+ export { type IndexerPlugin as I, type IndexerContext as a, type IndexerHooks as b, type IndexerConfig as c, type IndexerWithStreamConfig as d, defineIndexer as e, type Indexer as f, createIndexer as g, defineIndexerPlugin as h, run as r, useIndexerContext as u };
@@ -0,0 +1,85 @@
1
+ 'use strict';
2
+
3
+ const fs = require('node:fs');
4
+ const csvStringify = require('csv-stringify');
5
+ const sink = require('../shared/indexer.a8b7ab1f.cjs');
6
+ require('consola');
7
+
8
+ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
9
+
10
+ const fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
11
+
12
+ const transactionHelper = (context) => {
13
+ return {
14
+ insert: (data) => {
15
+ context.buffer.push(...data);
16
+ }
17
+ };
18
+ };
19
+ class CsvSink extends sink.Sink {
20
+ constructor(_stringifier, _config) {
21
+ super();
22
+ this._stringifier = _stringifier;
23
+ this._config = _config;
24
+ }
25
+ async write({
26
+ data,
27
+ endCursor
28
+ }) {
29
+ data = this.processCursorColumn(data, endCursor);
30
+ await this.insertToCSV(data);
31
+ }
32
+ async transaction({ cursor, endCursor, finality }, cb) {
33
+ const context = {
34
+ buffer: []
35
+ };
36
+ const writer = transactionHelper(context);
37
+ await cb({ writer });
38
+ await this.write({ data: context.buffer, endCursor });
39
+ }
40
+ async invalidate(cursor) {
41
+ throw new Error("Not implemented");
42
+ }
43
+ async insertToCSV(data) {
44
+ if (data.length === 0)
45
+ return;
46
+ return await new Promise((resolve, reject) => {
47
+ for (const row of data) {
48
+ this._stringifier.write(row, (err) => {
49
+ if (err)
50
+ throw new Error(err.message);
51
+ if (row === data[data.length - 1]) {
52
+ resolve();
53
+ }
54
+ });
55
+ }
56
+ });
57
+ }
58
+ processCursorColumn(data, endCursor) {
59
+ const { cursorColumn } = this._config;
60
+ if (cursorColumn && data.some(
61
+ (row) => Number(row[cursorColumn]) !== Number(endCursor?.orderKey)
62
+ )) {
63
+ throw new Error(
64
+ `Mismatch of ${cursorColumn} and Cursor ${Number(endCursor?.orderKey)}`
65
+ );
66
+ }
67
+ if (cursorColumn) {
68
+ return data;
69
+ }
70
+ return data.map((row) => ({
71
+ ...row,
72
+ _cursor: Number(endCursor?.orderKey)
73
+ }));
74
+ }
75
+ }
76
+ const csv = (args) => {
77
+ const { csvOptions, filepath, ...sinkOptions } = args;
78
+ const stringifier = csvStringify.stringify({ ...csvOptions });
79
+ const writeStream = fs__default.createWriteStream(filepath, { flags: "a" });
80
+ stringifier.pipe(writeStream);
81
+ return new CsvSink(stringifier, sinkOptions);
82
+ };
83
+
84
+ exports.CsvSink = CsvSink;
85
+ exports.csv = csv;
@@ -0,0 +1,66 @@
1
+ import { Cursor } from '@apibara/protocol';
2
+ import { Options, Stringifier } from 'csv-stringify';
3
+ import { S as Sink, a as SinkCursorParams, b as SinkData } from '../shared/indexer.b9c8f0d8.cjs';
4
+
5
+ type CsvArgs = {
6
+ /**
7
+ * csv-stringy options
8
+ * @reference https://csv.js.org/stringify/options/
9
+ */
10
+ csvOptions?: Options;
11
+ /**
12
+ * filepath for your csv file
13
+ */
14
+ filepath: string;
15
+ };
16
+ type CsvSinkOptions = {
17
+ /**
18
+ * An optional column name used to store the cursor value. If specified,
19
+ * the value of this column must match the `endCursor.orderKey` for each row.
20
+ */
21
+ cursorColumn?: string;
22
+ };
23
+ type TxnParams = {
24
+ writer: {
25
+ insert: (data: SinkData[]) => void;
26
+ };
27
+ };
28
+ /**
29
+ * A sink that writes data to a CSV file.
30
+ *
31
+ * @example
32
+ *
33
+ * ```ts
34
+ * const sink = csv({
35
+ * filepath: "./data.csv",
36
+ * csvOptions: {
37
+ * header: true,
38
+ * },
39
+ * });
40
+ *
41
+ * ...
42
+ * async transform({context, endCursor}){
43
+ * const { writer } = useSink(context);
44
+ * const insertHelper = writer(endCursor);
45
+ *
46
+ * insertHelper.insert([
47
+ * { id: 1, name: "John" },
48
+ * { id: 2, name: "Jane" },
49
+ * ]);
50
+ * }
51
+ *
52
+ * ```
53
+ */
54
+ declare class CsvSink extends Sink {
55
+ private _stringifier;
56
+ private _config;
57
+ constructor(_stringifier: Stringifier, _config: CsvSinkOptions);
58
+ private write;
59
+ transaction({ cursor, endCursor, finality }: SinkCursorParams, cb: (params: TxnParams) => Promise<void>): Promise<void>;
60
+ invalidate(cursor?: Cursor): Promise<void>;
61
+ private insertToCSV;
62
+ private processCursorColumn;
63
+ }
64
+ declare const csv: (args: CsvArgs & CsvSinkOptions) => CsvSink;
65
+
66
+ export { type CsvArgs, CsvSink, type CsvSinkOptions, csv };
@@ -0,0 +1,66 @@
1
+ import { Cursor } from '@apibara/protocol';
2
+ import { Options, Stringifier } from 'csv-stringify';
3
+ import { S as Sink, a as SinkCursorParams, b as SinkData } from '../shared/indexer.b9c8f0d8.mjs';
4
+
5
+ type CsvArgs = {
6
+ /**
7
+ * csv-stringy options
8
+ * @reference https://csv.js.org/stringify/options/
9
+ */
10
+ csvOptions?: Options;
11
+ /**
12
+ * filepath for your csv file
13
+ */
14
+ filepath: string;
15
+ };
16
+ type CsvSinkOptions = {
17
+ /**
18
+ * An optional column name used to store the cursor value. If specified,
19
+ * the value of this column must match the `endCursor.orderKey` for each row.
20
+ */
21
+ cursorColumn?: string;
22
+ };
23
+ type TxnParams = {
24
+ writer: {
25
+ insert: (data: SinkData[]) => void;
26
+ };
27
+ };
28
+ /**
29
+ * A sink that writes data to a CSV file.
30
+ *
31
+ * @example
32
+ *
33
+ * ```ts
34
+ * const sink = csv({
35
+ * filepath: "./data.csv",
36
+ * csvOptions: {
37
+ * header: true,
38
+ * },
39
+ * });
40
+ *
41
+ * ...
42
+ * async transform({context, endCursor}){
43
+ * const { writer } = useSink(context);
44
+ * const insertHelper = writer(endCursor);
45
+ *
46
+ * insertHelper.insert([
47
+ * { id: 1, name: "John" },
48
+ * { id: 2, name: "Jane" },
49
+ * ]);
50
+ * }
51
+ *
52
+ * ```
53
+ */
54
+ declare class CsvSink extends Sink {
55
+ private _stringifier;
56
+ private _config;
57
+ constructor(_stringifier: Stringifier, _config: CsvSinkOptions);
58
+ private write;
59
+ transaction({ cursor, endCursor, finality }: SinkCursorParams, cb: (params: TxnParams) => Promise<void>): Promise<void>;
60
+ invalidate(cursor?: Cursor): Promise<void>;
61
+ private insertToCSV;
62
+ private processCursorColumn;
63
+ }
64
+ declare const csv: (args: CsvArgs & CsvSinkOptions) => CsvSink;
65
+
66
+ export { type CsvArgs, CsvSink, type CsvSinkOptions, csv };
@@ -0,0 +1,66 @@
1
+ import { Cursor } from '@apibara/protocol';
2
+ import { Options, Stringifier } from 'csv-stringify';
3
+ import { S as Sink, a as SinkCursorParams, b as SinkData } from '../shared/indexer.b9c8f0d8.js';
4
+
5
+ type CsvArgs = {
6
+ /**
7
+ * csv-stringy options
8
+ * @reference https://csv.js.org/stringify/options/
9
+ */
10
+ csvOptions?: Options;
11
+ /**
12
+ * filepath for your csv file
13
+ */
14
+ filepath: string;
15
+ };
16
+ type CsvSinkOptions = {
17
+ /**
18
+ * An optional column name used to store the cursor value. If specified,
19
+ * the value of this column must match the `endCursor.orderKey` for each row.
20
+ */
21
+ cursorColumn?: string;
22
+ };
23
+ type TxnParams = {
24
+ writer: {
25
+ insert: (data: SinkData[]) => void;
26
+ };
27
+ };
28
+ /**
29
+ * A sink that writes data to a CSV file.
30
+ *
31
+ * @example
32
+ *
33
+ * ```ts
34
+ * const sink = csv({
35
+ * filepath: "./data.csv",
36
+ * csvOptions: {
37
+ * header: true,
38
+ * },
39
+ * });
40
+ *
41
+ * ...
42
+ * async transform({context, endCursor}){
43
+ * const { writer } = useSink(context);
44
+ * const insertHelper = writer(endCursor);
45
+ *
46
+ * insertHelper.insert([
47
+ * { id: 1, name: "John" },
48
+ * { id: 2, name: "Jane" },
49
+ * ]);
50
+ * }
51
+ *
52
+ * ```
53
+ */
54
+ declare class CsvSink extends Sink {
55
+ private _stringifier;
56
+ private _config;
57
+ constructor(_stringifier: Stringifier, _config: CsvSinkOptions);
58
+ private write;
59
+ transaction({ cursor, endCursor, finality }: SinkCursorParams, cb: (params: TxnParams) => Promise<void>): Promise<void>;
60
+ invalidate(cursor?: Cursor): Promise<void>;
61
+ private insertToCSV;
62
+ private processCursorColumn;
63
+ }
64
+ declare const csv: (args: CsvArgs & CsvSinkOptions) => CsvSink;
65
+
66
+ export { type CsvArgs, CsvSink, type CsvSinkOptions, csv };
@@ -0,0 +1,78 @@
1
+ import fs from 'node:fs';
2
+ import { stringify } from 'csv-stringify';
3
+ import { S as Sink } from '../shared/indexer.93d6b2eb.mjs';
4
+ import 'consola';
5
+
6
+ const transactionHelper = (context) => {
7
+ return {
8
+ insert: (data) => {
9
+ context.buffer.push(...data);
10
+ }
11
+ };
12
+ };
13
+ class CsvSink extends Sink {
14
+ constructor(_stringifier, _config) {
15
+ super();
16
+ this._stringifier = _stringifier;
17
+ this._config = _config;
18
+ }
19
+ async write({
20
+ data,
21
+ endCursor
22
+ }) {
23
+ data = this.processCursorColumn(data, endCursor);
24
+ await this.insertToCSV(data);
25
+ }
26
+ async transaction({ cursor, endCursor, finality }, cb) {
27
+ const context = {
28
+ buffer: []
29
+ };
30
+ const writer = transactionHelper(context);
31
+ await cb({ writer });
32
+ await this.write({ data: context.buffer, endCursor });
33
+ }
34
+ async invalidate(cursor) {
35
+ throw new Error("Not implemented");
36
+ }
37
+ async insertToCSV(data) {
38
+ if (data.length === 0)
39
+ return;
40
+ return await new Promise((resolve, reject) => {
41
+ for (const row of data) {
42
+ this._stringifier.write(row, (err) => {
43
+ if (err)
44
+ throw new Error(err.message);
45
+ if (row === data[data.length - 1]) {
46
+ resolve();
47
+ }
48
+ });
49
+ }
50
+ });
51
+ }
52
+ processCursorColumn(data, endCursor) {
53
+ const { cursorColumn } = this._config;
54
+ if (cursorColumn && data.some(
55
+ (row) => Number(row[cursorColumn]) !== Number(endCursor?.orderKey)
56
+ )) {
57
+ throw new Error(
58
+ `Mismatch of ${cursorColumn} and Cursor ${Number(endCursor?.orderKey)}`
59
+ );
60
+ }
61
+ if (cursorColumn) {
62
+ return data;
63
+ }
64
+ return data.map((row) => ({
65
+ ...row,
66
+ _cursor: Number(endCursor?.orderKey)
67
+ }));
68
+ }
69
+ }
70
+ const csv = (args) => {
71
+ const { csvOptions, filepath, ...sinkOptions } = args;
72
+ const stringifier = stringify({ ...csvOptions });
73
+ const writeStream = fs.createWriteStream(filepath, { flags: "a" });
74
+ stringifier.pipe(writeStream);
75
+ return new CsvSink(stringifier, sinkOptions);
76
+ };
77
+
78
+ export { CsvSink, csv };