@secondlayer/subgraphs 7.0.2 → 7.0.4

package/dist/index.d.ts

@@ -17,6 +17,7 @@ import { AbiContract, ExtractFunctionArgs, ExtractFunctionOutput, ExtractReadOnl
 *   first answer forever, so it is opt-in and never inferred.
 */
 type ChainReadCacheMode = "per-block" | "contract-constant";
+/** Options for a contract read, such as cache mode. */
 type ChainReadOptions = {
 	cache?: ChainReadCacheMode;
 };
@@ -137,7 +138,7 @@ interface SubgraphTable {
 	/** Unique key constraints (each entry is an array of column names). Required for upsert. */
 	uniqueKeys?: readonly (readonly string[])[];
 }
-/** Subgraph schema — maps table names to table definitions */
+/** Maps table names to table definitions. */
 type SubgraphSchema = Record<string, SubgraphTable>;
 /** STX event filters */
 interface StxTransferFilter {
@@ -409,7 +410,7 @@ type UnpinnedPrintEventFilter = PrintEventFields & {
 * `prints`; trait and unpinned sources may omit it.
 */
 type PrintEventFilter = PinnedPrintEventFilter | TraitPrintEventFilter | UnpinnedPrintEventFilter;
-/** All subgraph filter types — discriminated on `type` */
+/** A subgraph filter, discriminated on `type`. */
 type SubgraphFilter = StxTransferFilter | StxMintFilter | StxBurnFilter | StxLockFilter | FtTransferFilter | FtMintFilter | FtBurnFilter | NftTransferFilter | NftMintFilter | NftBurnFilter | ContractCallFilter | ContractDeployFilter | PrintEventFilter | NestedContractCallFilter | VarSetFilter | MapWriteFilter;
 /** Transaction metadata available in handlers */
 interface TxMeta {
@@ -943,8 +944,11 @@ type TypedHandlers<
 	Sources extends Record<string, SubgraphFilter>,
 	S extends SubgraphSchema
 > = { [K in keyof Sources]-? : HandlerFn<Sources[K], S> };
-/** Subgraph definition with `sources`/`schema` literals preserved for typed
-* handlers and downstream query-client inference (`getSubgraph`). */
+/**
+* A subgraph definition that keeps `sources` and `schema` literals typed.
+*
+* Preserved for typed handlers and downstream query-client inference (`getSubgraph`).
+*/
 type TypedSubgraphDefinition<
 	Sources extends Record<string, SubgraphFilter>,
 	S extends SubgraphSchema
@@ -1070,6 +1074,7 @@ interface InferredPrintField {
 	/** Only when optional observed: share of present samples that were some */
 	optional_some_rate?: number;
 }
+/** The fields seen in one `print` topic, with counts and heights. */
 interface InferredTopicSchema {
 	topic: string;
 	count: number;
@@ -1132,6 +1137,7 @@ declare function deriveVerification(def: Pick<SubgraphDefinition, "sources" | "b
 * contract is enforced, and the scan broke it.
 */
 declare function isDeterminismViolation(v: SubgraphVerification): boolean;
+/** What a pin is computed from: schema hash, handler code, network. */
 interface PinInput {
 	/** Existing `schema_hash` (name + schema + sources). */
 	schemaHash: string;
@@ -1171,6 +1177,7 @@ declare class HandlerReadError extends Error {
 * every handler wrapped to receive the {@link deterministicContext} facade.
 */
 declare function loadDeterministicDefinition(handlerCode: string): Promise<SubgraphDefinition>;
+/** The SQL statements for a subgraph's tables and their hash. */
 interface GeneratedSQL {
 	statements: string[];
 	hash: string;
@@ -1181,6 +1188,7 @@ interface GeneratedSQL {
 * each with auto-columns and indexes.
 */
 declare function generateSubgraphSQL(def: SubgraphDefinition, schemaNameOverride?: string): GeneratedSQL;
+/** Options for generating Prisma models. */
 interface PrismaGenOptions {
 	/** Postgres schema the tables live in (account-scoped). */
 	schemaName?: string;
@@ -1199,11 +1207,13 @@ interface PrismaGenOptions {
 * schema.
 */
 declare function generatePrismaSchema(def: SubgraphDefinition, opts?: PrismaGenOptions): string;
+/** Options for generating Drizzle table definitions. */
 interface DrizzleGenOptions {
 	schemaName?: string;
 }
 /** Generates Drizzle table definitions for a subgraph's tables. */
 declare function generateDrizzleSchema(def: SubgraphDefinition, opts?: DrizzleGenOptions): string;
+/** Options for generating Kysely table interfaces. */
 interface KyselyGenOptions {
 	/** Postgres schema the tables live in (account-scoped). */
 	schemaName?: string;
@@ -1222,7 +1232,9 @@ declare function generateKyselySchema(def: SubgraphDefinition, opts?: KyselyGenO
 * physical PK is a synthetic id excluded from the read contract (chain_reorgs) have
 * no read-set key and are omitted from Prisma output (other targets still emit them).
 */
+/** A portable, typed schema target for the public Index read domain. */
 type IndexCodegenTarget = "prisma" | "kysely" | "drizzle" | "json-schema";
+/** Options for generating the Index schema: tables, schema name. */
 interface IndexCodegenOptions {
 	/** Restrict output to these Index tables (default: all). */
 	tables?: string[];
@@ -1242,6 +1254,7 @@ import { pgSchemaName } from "@secondlayer/shared/db/queries/subgraphs";
 import { Database as Database2 } from "@secondlayer/shared/db";
 import { Kysely as Kysely2 } from "kysely";
 type AnyDb = Kysely2<Database2>;
+/** Tables added, removed, or changed between two schemas. */
 interface TableDiff {
 	/** Tables added to the schema */
 	addedTables: string[];
@@ -1290,6 +1303,7 @@ declare function hasBreakingChanges(diff: TableDiff): {
 	breaking: boolean;
 	reasons: string[];
 };
+/** The tables and columns a deploy adds, removes, or breaks. */
 interface DeployDiff {
 	addedTables: string[];
 	removedTables: string[];
@@ -1300,6 +1314,7 @@ interface DeployDiff {
 	/** uniqueKeys added in place via ALTER TABLE … ADD CONSTRAINT. */
 	addedUniqueKeys?: Record<string, string[][]>;
 }
+/** The schema name and SQL a deploy will run. */
 interface DeployPlan {
 	schemaName: string;
 	/** `DROP SCHEMA … CASCADE` a destructive rebuild would run first. */

package/dist/index.js

@@ -787,7 +787,7 @@ import { createHash } from "node:crypto";
 // package.json
 var package_default = {
   name: "@secondlayer/subgraphs",
-  version: "7.0.2",
+  version: "7.0.4",
   description: "Describe the Stacks data you want as one TypeScript file; it fills itself and survives reorgs.",
   license: "MIT",
   repository: {
@@ -847,9 +847,9 @@ var package_default = {
     prepublishOnly: "bun run build"
   },
   dependencies: {
-    "@secondlayer/shared": "^12.1.1",
-    "@secondlayer/stacks": "^6.2.1",
-    "@secondlayer/verify": "^0.5.3",
+    "@secondlayer/shared": "^13.0.0",
+    "@secondlayer/stacks": "^6.2.2",
+    "@secondlayer/verify": "^0.5.4",
     esbuild: "^0.28.2",
     kysely: "0.28.17",
     zod: "^4.3.6"
@@ -2949,5 +2949,5 @@ export {
   validateSubgraphDefinition
 };
 
-//# debugId=C76A905109964E7E64756E2164756E21
+//# debugId=DCD9274CFF218C3164756E2164756E21
 //# sourceMappingURL=index.js.map