@secondlayer/shared 0.2.0

package/dist/src/index.d.ts

@@ -0,0 +1,464 @@
+import { Generated, Insertable, Selectable, Updateable } from "kysely";
+interface BlocksTable {
+	height: number;
+	hash: string;
+	parent_hash: string;
+	burn_block_height: number;
+	timestamp: number;
+	canonical: Generated<boolean>;
+	created_at: Generated<Date>;
+}
+interface TransactionsTable {
+	tx_id: string;
+	block_height: number;
+	type: string;
+	sender: string;
+	status: string;
+	contract_id: string | null;
+	function_name: string | null;
+	raw_tx: string;
+	created_at: Generated<Date>;
+}
+interface EventsTable {
+	id: Generated<string>;
+	tx_id: string;
+	block_height: number;
+	event_index: number;
+	type: string;
+	data: unknown;
+	created_at: Generated<Date>;
+}
+interface StreamsTable {
+	id: Generated<string>;
+	name: string;
+	status: Generated<string>;
+	filters: unknown;
+	options: Generated<unknown>;
+	webhook_url: string;
+	webhook_secret: string | null;
+	api_key_id: string | null;
+	created_at: Generated<Date>;
+	updated_at: Generated<Date>;
+}
+interface StreamMetricsTable {
+	stream_id: string;
+	last_triggered_at: Date | null;
+	last_triggered_block: number | null;
+	total_deliveries: Generated<number>;
+	failed_deliveries: Generated<number>;
+	error_message: string | null;
+}
+interface JobsTable {
+	id: Generated<string>;
+	stream_id: string;
+	block_height: number;
+	status: Generated<string>;
+	attempts: Generated<number>;
+	locked_at: Date | null;
+	locked_by: string | null;
+	error: string | null;
+	backfill: Generated<boolean>;
+	created_at: Generated<Date>;
+	completed_at: Date | null;
+}
+interface IndexProgressTable {
+	network: string;
+	last_indexed_block: Generated<number>;
+	last_contiguous_block: Generated<number>;
+	highest_seen_block: Generated<number>;
+	updated_at: Generated<Date>;
+}
+interface DeliveriesTable {
+	id: Generated<string>;
+	stream_id: string;
+	job_id: string | null;
+	block_height: number;
+	status: string;
+	status_code: number | null;
+	response_time_ms: number | null;
+	attempts: Generated<number>;
+	error: string | null;
+	payload: unknown;
+	created_at: Generated<Date>;
+}
+interface ViewsTable {
+	id: Generated<string>;
+	name: string;
+	version: Generated<string>;
+	status: Generated<string>;
+	definition: unknown;
+	schema_hash: string;
+	handler_path: string;
+	schema_name: string | null;
+	last_processed_block: Generated<number>;
+	last_error: string | null;
+	last_error_at: Date | null;
+	total_processed: Generated<number>;
+	total_errors: Generated<number>;
+	api_key_id: string | null;
+	created_at: Generated<Date>;
+	updated_at: Generated<Date>;
+}
+interface ApiKeysTable {
+	id: Generated<string>;
+	key_hash: string;
+	key_prefix: string;
+	name: string | null;
+	status: Generated<string>;
+	rate_limit: Generated<number>;
+	ip_address: string;
+	account_id: string;
+	last_used_at: Date | null;
+	revoked_at: Date | null;
+	created_at: Generated<Date>;
+}
+interface AccountsTable {
+	id: Generated<string>;
+	email: string;
+	plan: Generated<string>;
+	created_at: Generated<Date>;
+}
+interface SessionsTable {
+	id: Generated<string>;
+	token_hash: string;
+	token_prefix: string;
+	account_id: string;
+	ip_address: string;
+	expires_at: Generated<Date>;
+	revoked_at: Date | null;
+	last_used_at: Date | null;
+	created_at: Generated<Date>;
+}
+interface MagicLinksTable {
+	id: Generated<string>;
+	email: string;
+	token: string;
+	expires_at: Date;
+	used_at: Date | null;
+	created_at: Generated<Date>;
+}
+interface UsageDailyTable {
+	account_id: string;
+	date: string;
+	api_requests: Generated<number>;
+	deliveries: Generated<number>;
+}
+interface UsageSnapshotsTable {
+	id: Generated<string>;
+	account_id: string;
+	measured_at: Generated<Date>;
+	storage_bytes: Generated<number>;
+}
+interface Database {
+	blocks: BlocksTable;
+	transactions: TransactionsTable;
+	events: EventsTable;
+	streams: StreamsTable;
+	stream_metrics: StreamMetricsTable;
+	jobs: JobsTable;
+	index_progress: IndexProgressTable;
+	deliveries: DeliveriesTable;
+	views: ViewsTable;
+	api_keys: ApiKeysTable;
+	accounts: AccountsTable;
+	sessions: SessionsTable;
+	magic_links: MagicLinksTable;
+	usage_daily: UsageDailyTable;
+	usage_snapshots: UsageSnapshotsTable;
+}
+type Block = Selectable<BlocksTable>;
+type InsertBlock = Insertable<BlocksTable>;
+type UpdateBlock = Updateable<BlocksTable>;
+type Transaction = Selectable<TransactionsTable>;
+type InsertTransaction = Insertable<TransactionsTable>;
+type UpdateTransaction = Updateable<TransactionsTable>;
+type Event = Selectable<EventsTable>;
+type InsertEvent = Insertable<EventsTable>;
+type UpdateEvent = Updateable<EventsTable>;
+type Stream = Selectable<StreamsTable>;
+type InsertStream = Insertable<StreamsTable>;
+type UpdateStreamRow = Updateable<StreamsTable>;
+type StreamMetrics = Selectable<StreamMetricsTable>;
+type InsertStreamMetrics = Insertable<StreamMetricsTable>;
+type UpdateStreamMetrics = Updateable<StreamMetricsTable>;
+type Job = Selectable<JobsTable>;
+type InsertJob = Insertable<JobsTable>;
+type UpdateJob = Updateable<JobsTable>;
+type IndexProgress = Selectable<IndexProgressTable>;
+type InsertIndexProgress = Insertable<IndexProgressTable>;
+type UpdateIndexProgress = Updateable<IndexProgressTable>;
+type Delivery = Selectable<DeliveriesTable>;
+type InsertDelivery = Insertable<DeliveriesTable>;
+type UpdateDelivery = Updateable<DeliveriesTable>;
+type View = Selectable<ViewsTable>;
+type InsertView = Insertable<ViewsTable>;
+type UpdateView = Updateable<ViewsTable>;
+type ApiKey = Selectable<ApiKeysTable>;
+type InsertApiKey = Insertable<ApiKeysTable>;
+type UpdateApiKey = Updateable<ApiKeysTable>;
+type Account = Selectable<AccountsTable>;
+type InsertAccount = Insertable<AccountsTable>;
+type MagicLink = Selectable<MagicLinksTable>;
+type InsertMagicLink = Insertable<MagicLinksTable>;
+type Session = Selectable<SessionsTable>;
+type InsertSession = Insertable<SessionsTable>;
+type UsageDaily = Selectable<UsageDailyTable>;
+type UsageSnapshot = Selectable<UsageSnapshotsTable>;
+import { z } from "zod";
+declare const envSchema: unknown;
+type Env = z.infer<typeof envSchema> & {
+	enabledNetworks: ("mainnet" | "testnet")[]
+};
+declare function getEnv(): Env;
+interface QueueStats {
+	pending: number;
+	processing: number;
+	completed: number;
+	failed: number;
+	total: number;
+}
+/**
+* Safely encode a JS value as a JSONB literal for Kysely inserts/updates.
+* Kysely + postgres.js double-encodes JSON when using parameterized queries
+* with ::jsonb casts. This uses sql.raw to inline a properly escaped literal.
+*/
+declare function jsonb(value: unknown);
+/**
+* Safely parse a JSONB value from the database.
+* Handles double-encoded strings where postgres.js returns a JSON string
+* instead of a parsed object.
+*/
+declare function parseJsonb<T = unknown>(value: unknown): T;
+import { Kysely } from "kysely";
+import postgres from "postgres";
+import { sql } from "kysely";
+declare function getDb(connectionString?: string): Kysely<Database>;
+/** Raw postgres.js client for dynamic schema DDL (CREATE SCHEMA, DROP, etc.) */
+declare function getRawClient(): ReturnType<typeof postgres>;
+/** Close the DB connection pool. Call in CLI commands to allow process exit. */
+declare function closeDb(): Promise<void>;
+/**
+* Base error class for all Stacks Streams errors
+*/
+declare class StreamsError extends Error {
+	code: string;
+	cause?: unknown;
+	constructor(code: string, message: string, cause?: unknown);
+	toJSON(): {};
+}
+/**
+* Stream not found error
+*/
+declare class StreamNotFoundError extends StreamsError {
+	constructor(streamId: string);
+}
+/**
+* Validation error for invalid input
+*/
+declare class ValidationError extends StreamsError {
+	constructor(message: string, cause?: unknown);
+}
+/**
+* Database operation error
+*/
+declare class DatabaseError extends StreamsError {
+	constructor(message: string, cause?: unknown);
+}
+/**
+* Webhook delivery error
+*/
+declare class WebhookDeliveryError extends StreamsError {
+	statusCode?: number;
+	constructor(message: string, statusCode?: number, cause?: unknown);
+	toJSON(): {};
+}
+/**
+* Filter evaluation error
+*/
+declare class FilterEvaluationError extends StreamsError {
+	constructor(message: string, cause?: unknown);
+}
+declare class AuthenticationError extends StreamsError {
+	constructor(message: string);
+}
+declare class AuthorizationError extends StreamsError {
+	constructor(message: string);
+}
+declare class RateLimitError extends StreamsError {
+	constructor(message: string);
+}
+declare const logger: unknown;
+declare namespace exports_queue {
+	export { stats, getWorkerId, fail, enqueue, complete, claim, WORKER_ID, QueueStats2 as QueueStats };
+}
+interface QueueStats2 {
+	pending: number;
+	processing: number;
+	completed: number;
+	failed: number;
+	total: number;
+}
+declare const WORKER_ID: unknown;
+/**
+* Enqueue a new job for stream evaluation
+*/
+declare function enqueue(streamId: string, blockHeight: number, backfill?: boolean): Promise<string>;
+/**
+* Claim a pending job using SKIP LOCKED to prevent concurrent access
+* Returns null if no jobs available
+*/
+declare function claim(): Promise<Job | null>;
+/**
+* Mark a job as completed
+*/
+declare function complete(jobId: string): Promise<void>;
+/**
+* Mark a job as failed
+* Re-queues if under max attempts, otherwise marks as permanently failed
+*/
+declare function fail(jobId: string, error: string, maxAttempts?: number): Promise<void>;
+/**
+* Get queue statistics
+*/
+declare function stats(): Promise<QueueStats2>;
+/**
+* Get worker ID for this process
+*/
+declare function getWorkerId(): string;
+import { z as z2 } from "zod";
+declare const StxTransferFilterSchema: unknown;
+declare const StxMintFilterSchema: unknown;
+declare const StxBurnFilterSchema: unknown;
+declare const StxLockFilterSchema: unknown;
+declare const FtTransferFilterSchema: unknown;
+declare const FtMintFilterSchema: unknown;
+declare const FtBurnFilterSchema: unknown;
+declare const NftTransferFilterSchema: unknown;
+declare const NftMintFilterSchema: unknown;
+declare const NftBurnFilterSchema: unknown;
+declare const ContractCallFilterSchema: unknown;
+declare const ContractDeployFilterSchema: unknown;
+declare const PrintEventFilterSchema: unknown;
+declare const StreamFilterSchema: unknown;
+type StxTransferFilter = z2.infer<typeof StxTransferFilterSchema>;
+type StxMintFilter = z2.infer<typeof StxMintFilterSchema>;
+type StxBurnFilter = z2.infer<typeof StxBurnFilterSchema>;
+type StxLockFilter = z2.infer<typeof StxLockFilterSchema>;
+type FtTransferFilter = z2.infer<typeof FtTransferFilterSchema>;
+type FtMintFilter = z2.infer<typeof FtMintFilterSchema>;
+type FtBurnFilter = z2.infer<typeof FtBurnFilterSchema>;
+type NftTransferFilter = z2.infer<typeof NftTransferFilterSchema>;
+type NftMintFilter = z2.infer<typeof NftMintFilterSchema>;
+type NftBurnFilter = z2.infer<typeof NftBurnFilterSchema>;
+type ContractCallFilter = z2.infer<typeof ContractCallFilterSchema>;
+type ContractDeployFilter = z2.infer<typeof ContractDeployFilterSchema>;
+type PrintEventFilter = z2.infer<typeof PrintEventFilterSchema>;
+type StreamFilter = z2.infer<typeof StreamFilterSchema>;
+import { z as z3 } from "zod";
+declare const DeployViewRequestSchema: unknown;
+type DeployViewRequest = z3.infer<typeof DeployViewRequestSchema>;
+interface DeployViewResponse {
+	action: "created" | "unchanged" | "updated" | "reindexed";
+	viewId: string;
+	message: string;
+}
+interface ViewSummary {
+	name: string;
+	version: string;
+	status: string;
+	lastProcessedBlock: number;
+	tables: string[];
+	createdAt: string;
+}
+interface ViewDetail {
+	name: string;
+	version: string;
+	status: string;
+	lastProcessedBlock: number;
+	health: {
+		totalProcessed: number
+		totalErrors: number
+		errorRate: number
+		lastError: string | null
+		lastErrorAt: string | null
+	};
+	tables: Record<string, {
+		endpoint: string
+		columns: Record<string, string>
+		rowCount: number
+		example: string
+	}>;
+	createdAt: string;
+	updatedAt: string;
+}
+interface ReindexResponse {
+	message: string;
+	fromBlock: number;
+	toBlock: number | string;
+}
+interface ViewQueryParams {
+	sort?: string;
+	order?: string;
+	limit?: number;
+	offset?: number;
+	fields?: string;
+	filters?: Record<string, string>;
+}
+import { z as z4 } from "zod";
+declare const StreamOptionsSchema: unknown;
+declare const CreateStreamSchema: unknown;
+declare const UpdateStreamSchema: unknown;
+declare const WebhookPayloadSchema: unknown;
+declare const StreamMetricsSchema: unknown;
+declare const StreamResponseSchema: unknown;
+type StreamOptions = z4.infer<typeof StreamOptionsSchema>;
+type CreateStream = z4.infer<typeof CreateStreamSchema>;
+type UpdateStream = z4.infer<typeof UpdateStreamSchema>;
+type WebhookPayload = z4.infer<typeof WebhookPayloadSchema>;
+type StreamResponse = z4.infer<typeof StreamResponseSchema>;
+type StreamMetricsResponse = z4.infer<typeof StreamMetricsSchema>;
+interface CreateStreamResponse {
+	stream: StreamResponse;
+	webhookSecret: string;
+}
+interface ListStreamsResponse {
+	streams: StreamResponse[];
+	total: number;
+}
+interface BulkPauseResponse {
+	paused: number;
+	streams: StreamResponse[];
+}
+interface BulkResumeResponse {
+	resumed: number;
+	streams: StreamResponse[];
+}
+declare namespace exports_hmac {
+	export { verifySignatureHeader, verifySignature, signPayload, generateSecret, createSignatureHeader };
+}
+/**
+* Generate a random secret for webhook signing
+* Returns 32 bytes as a 64-character hex string
+*/
+declare function generateSecret(): string;
+/**
+* Sign a payload with HMAC-SHA256
+* Returns the signature as a hex string
+*/
+declare function signPayload(payload: string, secret: string): string;
+/**
+* Verify an HMAC signature
+* Uses constant-time comparison to prevent timing attacks
+*/
+declare function verifySignature(payload: string, signature: string, secret: string): boolean;
+/**
+* Create a Stripe-style signature header
+* Format: t=timestamp,v1=signature
+*/
+declare function createSignatureHeader(payload: string, secret: string, timestamp?: number): string;
+/**
+* Parse and verify a Stripe-style signature header
+* Returns true if valid, false otherwise
+*/
+declare function verifySignatureHeader(payload: string, header: string, secret: string, toleranceSeconds?: number): boolean;
+export { sql, exports_queue as queue, parseJsonb, logger, jsonb, getRawClient, getEnv, getDb, exports_hmac as crypto, closeDb, WebhookPayloadSchema, WebhookPayload, WebhookDeliveryError, ViewsTable, ViewSummary, ViewQueryParams, ViewDetail, View, ValidationError, UsageSnapshotsTable, UsageSnapshot, UsageDailyTable, UsageDaily, UpdateView, UpdateTransaction, UpdateStreamSchema, UpdateStreamRow, UpdateStreamMetrics, UpdateStream, UpdateJob, UpdateIndexProgress, UpdateEvent, UpdateDelivery, UpdateBlock, UpdateApiKey, TransactionsTable, Transaction, StxTransferFilterSchema, StxTransferFilter, StxMintFilterSchema, StxMintFilter, StxLockFilterSchema, StxLockFilter, StxBurnFilterSchema, StxBurnFilter, StreamsTable, StreamsError, StreamResponseSchema, StreamResponse, StreamOptionsSchema, StreamOptions, StreamNotFoundError, StreamMetricsTable, StreamMetricsSchema, StreamMetricsResponse, StreamMetrics, StreamFilterSchema, StreamFilter, Stream, SessionsTable, Session, ReindexResponse, RateLimitError, QueueStats, PrintEventFilterSchema, PrintEventFilter, NftTransferFilterSchema, NftTransferFilter, NftMintFilterSchema, NftMintFilter, NftBurnFilterSchema, NftBurnFilter, MagicLinksTable, MagicLink, ListStreamsResponse, JobsTable, Job, InsertView, InsertTransaction, InsertStreamMetrics, InsertStream, InsertSession, InsertMagicLink, InsertJob, InsertIndexProgress, InsertEvent, InsertDelivery, InsertBlock, InsertApiKey, InsertAccount, IndexProgressTable, IndexProgress, FtTransferFilterSchema, FtTransferFilter, FtMintFilterSchema, FtMintFilter, FtBurnFilterSchema, FtBurnFilter, FilterEvaluationError, EventsTable, Event, Env, DeployViewResponse, DeployViewRequestSchema, DeployViewRequest, Delivery, DeliveriesTable, DatabaseError, Database, CreateStreamSchema, CreateStreamResponse, CreateStream, ContractDeployFilterSchema, ContractDeployFilter, ContractCallFilterSchema, ContractCallFilter, BulkResumeResponse, BulkPauseResponse, BlocksTable, Block, AuthorizationError, AuthenticationError, ApiKeysTable, ApiKey, AccountsTable, Account };