@walkthru-earth/objex-utils 0.1.0 → 1.0.0

package/dist/index.d.cts

@@ -1,5 +1,34 @@
 import { Table } from 'apache-arrow';
 
+/**
+ * Shared constants used across the application.
+ * Centralizes magic strings, numbers, and sets to prevent duplication.
+ */
+declare const STORAGE_KEYS: {
+    readonly SETTINGS: "obstore-explore-settings";
+    readonly CONNECTIONS: "obstore-explore-connections";
+    readonly QUERY_HISTORY: "obstore-explore-query-history";
+};
+/** EPSG codes considered WGS84 (no reprojection needed). */
+declare const WGS84_CODES: Set<number>;
+/** Default target CRS for ST_Transform. */
+declare const DEFAULT_TARGET_CRS = "EPSG:4326";
+/** DuckDB-WASM initialization timeout in ms. */
+declare const DUCKDB_INIT_TIMEOUT_MS = 30000;
+/** Maximum entries kept in query history. */
+declare const MAX_QUERY_HISTORY_ENTRIES = 200;
+/** SQL preview truncation length (characters). */
+declare const SQL_PREVIEW_LENGTH = 120;
+/** Extensions that represent "virtual files" — directories that open as viewers. */
+declare const VIEWER_DIR_EXTENSIONS: Set<string>;
+/**
+ * Golden-angle-based hue multiplier for evenly distributing layer colors.
+ * 137 ≈ 360 × (1 − 1/φ) where φ is the golden ratio.
+ */
+declare const LAYER_HUE_MULTIPLIER = 137;
+/** Duration (ms) to show "Copied!" feedback before resetting. */
+declare const COPY_FEEDBACK_MS = 2000;
+
 /**
  * Centralized file type detection module.
  *
@@ -121,7 +150,7 @@ interface FileEntry {
 interface Connection {
     id: string;
     name: string;
-    provider: 's3' | 'gcs' | 'r2' | 'minio' | 'azure' | 'storj';
+    provider: string;
     endpoint: string;
     bucket: string;
     region: string;
@@ -131,7 +160,7 @@ interface Connection {
 }
 interface ConnectionConfig {
     name: string;
-    provider: 's3' | 'gcs' | 'r2' | 'minio' | 'azure' | 'storj';
+    provider: string;
     endpoint: string;
     bucket: string;
     region: string;
@@ -203,6 +232,15 @@ declare function typeColor(category: TypeCategory): string;
 declare function typeBadgeClass(category: TypeCategory): string;
 declare function typeLabel(category: TypeCategory): string;
 
+/**
+ * Shared error handling for async viewer load operations.
+ */
+/**
+ * Extract an error message from an unknown caught value.
+ * Returns null for AbortError (caller should silently return).
+ */
+declare function handleLoadError(err: unknown): string | null;
+
 /**
  * Formats a byte count into a human-readable string.
  */
@@ -217,6 +255,16 @@ declare function formatDate(timestamp: number): string;
  * Returns an empty string if no extension is found.
  */
 declare function getFileExtension(filename: string): string;
+/**
+ * JSON replacer that converts BigInt values to strings.
+ * Use with `JSON.stringify(value, jsonReplacerBigInt)`.
+ */
+declare function jsonReplacerBigInt(_key: string, value: unknown): unknown;
+/**
+ * Format a value for display in tables, attribute panels, and exports.
+ * Handles null, undefined, Date, BigInt, and objects uniformly.
+ */
+declare function formatValue(value: unknown): string;
 
 /**
  * Direct WKB → GeoArrow bridge (zero-copy).
@@ -358,7 +406,7 @@ declare function extractBounds(geo: GeoParquetMeta): [number, number, number, nu
  *
  * Also handles plain bucket names (no protocol).
  */
-type StorageProvider = 's3' | 'gcs' | 'r2' | 'minio' | 'azure' | 'storj' | 'unknown';
+type StorageProvider = string;
 interface ParsedStorageUrl {
     bucket: string;
     region: string;
@@ -430,4 +478,4 @@ declare function findGeoColumnFromRows(rows: Record<string, unknown>[], schema:
     type: string;
 }[]): string | null;
 
-export { type Connection, type ConnectionConfig, type Defaults, type DuckDbReadFn, type FileCategory, type FileEntry, type FileTypeInfo, type GeoArrowGeomType, type GeoArrowResult, type GeoColumnMeta, type GeoParquetMeta, type GeoType, type HexRow, type ListPage, type MapQueryHandle, type MapQueryResult, type ParquetFileMetadata, type ParsedGeometry, type ParsedStorageUrl, QueryCancelledError, type QueryEngine, type QueryHandle, type QueryResult, type SchemaField, type StorageAdapter, type StorageProvider, type Tab, type Theme, type TypeCategory, UrlAdapter, type ViewerKind, type WriteResult, buildDuckDbSource, buildGeoArrowTables, classifyType, describeParseResult, extractBounds, extractEpsgFromGeoMeta, extractGeometryTypes, findGeoColumn, findGeoColumnFromRows, formatDate, formatFileSize, generateHexDump, getDuckDbReadFn, getFileExtension, getFileTypeInfo, getMimeType, getViewerKind, isCloudNativeFormat, isQueryable, looksLikeUrl, normalizeGeomType, parseStorageUrl, parseWKB, readParquetMetadata, toBinary, typeBadgeClass, typeColor, typeLabel };
+export { COPY_FEEDBACK_MS, type Connection, type ConnectionConfig, DEFAULT_TARGET_CRS, DUCKDB_INIT_TIMEOUT_MS, type Defaults, type DuckDbReadFn, type FileCategory, type FileEntry, type FileTypeInfo, type GeoArrowGeomType, type GeoArrowResult, type GeoColumnMeta, type GeoParquetMeta, type GeoType, type HexRow, LAYER_HUE_MULTIPLIER, type ListPage, MAX_QUERY_HISTORY_ENTRIES, type MapQueryHandle, type MapQueryResult, type ParquetFileMetadata, type ParsedGeometry, type ParsedStorageUrl, QueryCancelledError, type QueryEngine, type QueryHandle, type QueryResult, SQL_PREVIEW_LENGTH, STORAGE_KEYS, type SchemaField, type StorageAdapter, type StorageProvider, type Tab, type Theme, type TypeCategory, UrlAdapter, VIEWER_DIR_EXTENSIONS, type ViewerKind, WGS84_CODES, type WriteResult, buildDuckDbSource, buildGeoArrowTables, classifyType, describeParseResult, extractBounds, extractEpsgFromGeoMeta, extractGeometryTypes, findGeoColumn, findGeoColumnFromRows, formatDate, formatFileSize, formatValue, generateHexDump, getDuckDbReadFn, getFileExtension, getFileTypeInfo, getMimeType, getViewerKind, handleLoadError, isCloudNativeFormat, isQueryable, jsonReplacerBigInt, looksLikeUrl, normalizeGeomType, parseStorageUrl, parseWKB, readParquetMetadata, toBinary, typeBadgeClass, typeColor, typeLabel };

package/dist/index.d.ts

@@ -1,5 +1,34 @@
 import { Table } from 'apache-arrow';
 
+/**
+ * Shared constants used across the application.
+ * Centralizes magic strings, numbers, and sets to prevent duplication.
+ */
+declare const STORAGE_KEYS: {
+    readonly SETTINGS: "obstore-explore-settings";
+    readonly CONNECTIONS: "obstore-explore-connections";
+    readonly QUERY_HISTORY: "obstore-explore-query-history";
+};
+/** EPSG codes considered WGS84 (no reprojection needed). */
+declare const WGS84_CODES: Set<number>;
+/** Default target CRS for ST_Transform. */
+declare const DEFAULT_TARGET_CRS = "EPSG:4326";
+/** DuckDB-WASM initialization timeout in ms. */
+declare const DUCKDB_INIT_TIMEOUT_MS = 30000;
+/** Maximum entries kept in query history. */
+declare const MAX_QUERY_HISTORY_ENTRIES = 200;
+/** SQL preview truncation length (characters). */
+declare const SQL_PREVIEW_LENGTH = 120;
+/** Extensions that represent "virtual files" — directories that open as viewers. */
+declare const VIEWER_DIR_EXTENSIONS: Set<string>;
+/**
+ * Golden-angle-based hue multiplier for evenly distributing layer colors.
+ * 137 ≈ 360 × (1 − 1/φ) where φ is the golden ratio.
+ */
+declare const LAYER_HUE_MULTIPLIER = 137;
+/** Duration (ms) to show "Copied!" feedback before resetting. */
+declare const COPY_FEEDBACK_MS = 2000;
+
 /**
  * Centralized file type detection module.
  *
@@ -121,7 +150,7 @@ interface FileEntry {
 interface Connection {
     id: string;
     name: string;
-    provider: 's3' | 'gcs' | 'r2' | 'minio' | 'azure' | 'storj';
+    provider: string;
     endpoint: string;
     bucket: string;
     region: string;
@@ -131,7 +160,7 @@ interface Connection {
 }
 interface ConnectionConfig {
     name: string;
-    provider: 's3' | 'gcs' | 'r2' | 'minio' | 'azure' | 'storj';
+    provider: string;
     endpoint: string;
     bucket: string;
     region: string;
@@ -203,6 +232,15 @@ declare function typeColor(category: TypeCategory): string;
 declare function typeBadgeClass(category: TypeCategory): string;
 declare function typeLabel(category: TypeCategory): string;
 
+/**
+ * Shared error handling for async viewer load operations.
+ */
+/**
+ * Extract an error message from an unknown caught value.
+ * Returns null for AbortError (caller should silently return).
+ */
+declare function handleLoadError(err: unknown): string | null;
+
 /**
  * Formats a byte count into a human-readable string.
  */
@@ -217,6 +255,16 @@ declare function formatDate(timestamp: number): string;
  * Returns an empty string if no extension is found.
  */
 declare function getFileExtension(filename: string): string;
+/**
+ * JSON replacer that converts BigInt values to strings.
+ * Use with `JSON.stringify(value, jsonReplacerBigInt)`.
+ */
+declare function jsonReplacerBigInt(_key: string, value: unknown): unknown;
+/**
+ * Format a value for display in tables, attribute panels, and exports.
+ * Handles null, undefined, Date, BigInt, and objects uniformly.
+ */
+declare function formatValue(value: unknown): string;
 
 /**
  * Direct WKB → GeoArrow bridge (zero-copy).
@@ -358,7 +406,7 @@ declare function extractBounds(geo: GeoParquetMeta): [number, number, number, nu
  *
  * Also handles plain bucket names (no protocol).
  */
-type StorageProvider = 's3' | 'gcs' | 'r2' | 'minio' | 'azure' | 'storj' | 'unknown';
+type StorageProvider = string;
 interface ParsedStorageUrl {
     bucket: string;
     region: string;
@@ -430,4 +478,4 @@ declare function findGeoColumnFromRows(rows: Record<string, unknown>[], schema:
     type: string;
 }[]): string | null;
 
-export { type Connection, type ConnectionConfig, type Defaults, type DuckDbReadFn, type FileCategory, type FileEntry, type FileTypeInfo, type GeoArrowGeomType, type GeoArrowResult, type GeoColumnMeta, type GeoParquetMeta, type GeoType, type HexRow, type ListPage, type MapQueryHandle, type MapQueryResult, type ParquetFileMetadata, type ParsedGeometry, type ParsedStorageUrl, QueryCancelledError, type QueryEngine, type QueryHandle, type QueryResult, type SchemaField, type StorageAdapter, type StorageProvider, type Tab, type Theme, type TypeCategory, UrlAdapter, type ViewerKind, type WriteResult, buildDuckDbSource, buildGeoArrowTables, classifyType, describeParseResult, extractBounds, extractEpsgFromGeoMeta, extractGeometryTypes, findGeoColumn, findGeoColumnFromRows, formatDate, formatFileSize, generateHexDump, getDuckDbReadFn, getFileExtension, getFileTypeInfo, getMimeType, getViewerKind, isCloudNativeFormat, isQueryable, looksLikeUrl, normalizeGeomType, parseStorageUrl, parseWKB, readParquetMetadata, toBinary, typeBadgeClass, typeColor, typeLabel };
+export { COPY_FEEDBACK_MS, type Connection, type ConnectionConfig, DEFAULT_TARGET_CRS, DUCKDB_INIT_TIMEOUT_MS, type Defaults, type DuckDbReadFn, type FileCategory, type FileEntry, type FileTypeInfo, type GeoArrowGeomType, type GeoArrowResult, type GeoColumnMeta, type GeoParquetMeta, type GeoType, type HexRow, LAYER_HUE_MULTIPLIER, type ListPage, MAX_QUERY_HISTORY_ENTRIES, type MapQueryHandle, type MapQueryResult, type ParquetFileMetadata, type ParsedGeometry, type ParsedStorageUrl, QueryCancelledError, type QueryEngine, type QueryHandle, type QueryResult, SQL_PREVIEW_LENGTH, STORAGE_KEYS, type SchemaField, type StorageAdapter, type StorageProvider, type Tab, type Theme, type TypeCategory, UrlAdapter, VIEWER_DIR_EXTENSIONS, type ViewerKind, WGS84_CODES, type WriteResult, buildDuckDbSource, buildGeoArrowTables, classifyType, describeParseResult, extractBounds, extractEpsgFromGeoMeta, extractGeometryTypes, findGeoColumn, findGeoColumnFromRows, formatDate, formatFileSize, formatValue, generateHexDump, getDuckDbReadFn, getFileExtension, getFileTypeInfo, getMimeType, getViewerKind, handleLoadError, isCloudNativeFormat, isQueryable, jsonReplacerBigInt, looksLikeUrl, normalizeGeomType, parseStorageUrl, parseWKB, readParquetMetadata, toBinary, typeBadgeClass, typeColor, typeLabel };