@secondlayer/subgraphs 5.0.1 → 6.0.0

package/dist/index.d.ts

@@ -514,19 +514,34 @@ type SystemOrderByAliases = {
 	createdAt?: "asc" | "desc"
 	id?: "asc" | "desc"
 };
-/** Ordered list form for deterministic multi-column sort. */
-type OrderByList<TRow> = Array<[keyof (TRow & SystemOrderByAliases) & string, "asc" | "desc"]>;
 interface FindManyOptions<TRow> {
 	where?: WhereInput<TRow> & SystemWhereAliases;
 	/**
-	* Single-key object (common case) OR an ordered `[column, direction][]` list
-	* for deterministic multi-column sort (object key order isn't guaranteed).
+	* Single-column object, e.g. `{ price: "desc" }`. `/v1` sorts by one
+	* column only (the keyset cursor pairs it with `_id` as a tiebreaker) —
+	* a second key throws at call time, since a plain object type can't
+	* reject "more than one key" at compile time.
 	*/
-	orderBy?: ({ [K in keyof TRow]? : "asc" | "desc" } & SystemOrderByAliases) | OrderByList<TRow>;
+	orderBy?: { [K in keyof TRow]? : "asc" | "desc" } & SystemOrderByAliases;
 	limit?: number;
-	offset?: number;
+	/** Resume from a previous page's `nextCursor`. */
+	cursor?: string;
 	fields?: (keyof TRow & string)[];
 }
+/** Wire tip: chain height, subgraph's processed height, and the gap between
+*  them — same object on every `/v1` row/page response. */
+interface SubgraphTip {
+	block_height: number;
+	subgraph_height: number;
+	blocks_behind: number;
+}
+/** A page of rows from `findMany`, keyset-paginated. `nextCursor` is `null`
+*  on the last page; pass it back as `cursor` to resume. */
+interface FindManyPage<TRow> {
+	rows: TRow[];
+	nextCursor: string | null;
+	tip: SubgraphTip;
+}
 /** Options for the realtime row stream (SSE). */
 interface SubscribeOptions<TRow> {
 	/** Same column filters as `findMany`, applied server-side per row. */
@@ -587,7 +602,7 @@ interface SubgraphTableClient<TRow> {
 	*/
 	findMany<const F extends readonly (keyof TRow & string)[] = readonly (keyof TRow & string)[]>(options?: Omit<FindManyOptions<TRow>, "fields"> & {
 		fields?: F
-	}): Promise<Pick<TRow, F[number]>[]>;
+	}): Promise<FindManyPage<Pick<TRow, F[number]>>>;
 	count(where?: WhereInput<TRow> & SystemWhereAliases): Promise<number>;
 	/**
 	* Scalar aggregates over the filtered set. SUM/MIN/MAX accept numeric columns
@@ -1197,4 +1212,4 @@ interface ReindexOptions {
 	operationId?: string;
 	signal?: AbortSignal;
 }
-export { AggregateResult, AggregateSpec, AnyEvent, ChainReadCacheMode, ChainReadClient, ChainReadError, ChainReadMethods, ChainReadOptions, ColumnDiff, ColumnToTS, ColumnType, ComparisonFilter, ContractCallEvent, ContractCallFilter, ContractCallPayload, ContractDeployFilter, ContractDeployPayload, DeployDiff, DeployPlan, DrizzleGenOptions, ErasedChainReadClient, EventForFilter, FactoryScope, FindManyOptions, FtBurnFilter, FtBurnPayload, FtMintFilter, FtMintPayload, FtTransferFilter, FtTransferPayload, GeneratedSQL, IndexCodegenOptions, IndexCodegenTarget, InferColumnType, InferContext, InferSubgraphClient, InferTableRow, InferredPrintField, InferredTopicSchema, KyselyGenOptions, MapDeletePayload, MapWritePayload, NestedContractCallPayload, NftBurnFilter, NftBurnPayload, NftMintFilter, NftMintPayload, NftTransferFilter, NftTransferPayload, PinnedPrintEventFilter, PrintDataOf, PrintEventFilter, PrintEventFor, PrintEventPayload, PrintEventPrints, PrintField, PrintFieldToTS, PrintSample, PrintValidationResult, PrismaGenOptions, ReindexOptions, RowValue, SparseProbeTarget, StxBurnFilter, StxBurnPayload, StxLockFilter, StxLockPayload, StxMintFilter, StxMintPayload, StxTransferFilter, StxTransferPayload, SubgraphColumn, SubgraphContext, SubgraphDefinition, SubgraphFilter, SubgraphHandler, SubgraphSchema, SubgraphTable, SubgraphTableClient, SubscribeOptions, SystemRow, TableDiff, TraitPrintEventFilter, TxMeta, TypedHandlers, TypedSubgraphContext, TypedSubgraphDefinition, UnpinnedPrintEventFilter, VarSetPayload, WhereInput, WriteRow, camelizeKeys, canSparseScan, defineSchema, defineSubgraph, deploySchema, diffSchema, filterFieldsByType, generateDrizzleSchema, generateIndexSchema, generateKyselySchema, generatePrismaSchema, generateSubgraphSQL, hasBreakingChanges, inferPrintTopics, pgSchemaName, readContractAt, renderDeployPlan, sparseProbeTargets, validateSubgraphDefinition };
+export { AggregateResult, AggregateSpec, AnyEvent, ChainReadCacheMode, ChainReadClient, ChainReadError, ChainReadMethods, ChainReadOptions, ColumnDiff, ColumnToTS, ColumnType, ComparisonFilter, ContractCallEvent, ContractCallFilter, ContractCallPayload, ContractDeployFilter, ContractDeployPayload, DeployDiff, DeployPlan, DrizzleGenOptions, ErasedChainReadClient, EventForFilter, FactoryScope, FindManyOptions, FindManyPage, FtBurnFilter, FtBurnPayload, FtMintFilter, FtMintPayload, FtTransferFilter, FtTransferPayload, GeneratedSQL, IndexCodegenOptions, IndexCodegenTarget, InferColumnType, InferContext, InferSubgraphClient, InferTableRow, InferredPrintField, InferredTopicSchema, KyselyGenOptions, MapDeletePayload, MapWritePayload, NestedContractCallPayload, NftBurnFilter, NftBurnPayload, NftMintFilter, NftMintPayload, NftTransferFilter, NftTransferPayload, PinnedPrintEventFilter, PrintDataOf, PrintEventFilter, PrintEventFor, PrintEventPayload, PrintEventPrints, PrintField, PrintFieldToTS, PrintSample, PrintValidationResult, PrismaGenOptions, ReindexOptions, RowValue, SparseProbeTarget, StxBurnFilter, StxBurnPayload, StxLockFilter, StxLockPayload, StxMintFilter, StxMintPayload, StxTransferFilter, StxTransferPayload, SubgraphColumn, SubgraphContext, SubgraphDefinition, SubgraphFilter, SubgraphHandler, SubgraphSchema, SubgraphTable, SubgraphTableClient, SubgraphTip, SubscribeOptions, SystemRow, TableDiff, TraitPrintEventFilter, TxMeta, TypedHandlers, TypedSubgraphContext, TypedSubgraphDefinition, UnpinnedPrintEventFilter, VarSetPayload, WhereInput, WriteRow, camelizeKeys, canSparseScan, defineSchema, defineSubgraph, deploySchema, diffSchema, filterFieldsByType, generateDrizzleSchema, generateIndexSchema, generateKyselySchema, generatePrismaSchema, generateSubgraphSQL, hasBreakingChanges, inferPrintTopics, pgSchemaName, readContractAt, renderDeployPlan, sparseProbeTargets, validateSubgraphDefinition };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@secondlayer/subgraphs",
-	"version": "5.0.1",
+	"version": "6.0.0",
 	"description": "Describe the Stacks data you want as one TypeScript file; it fills itself and survives reorgs.",
 	"license": "MIT",
 	"repository": {