@totemsdk/spatial-proof 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,126 @@
+/**
+ * @totemsdk/spatial-proof — Type definitions
+ *
+ * Pure schema for geospatial relationship proofs.
+ *
+ * COORDINATE ORDER: GeoJSON order — [longitude, latitude] in decimal degrees
+ * (WGS84 / EPSG:4326). This is the opposite of "lat, lon". All geometry
+ * functions and hashes in this package assume [lon, lat].
+ *
+ * No network, no storage, no map rendering, no GIS engine dependency.
+ */
+export type Coordinate = [number, number];
+export type GeoGeometry = GeoPointGeometry | GeoLineStringGeometry | GeoPolygonGeometry | GeoMultiPolygonGeometry;
+export interface GeoPointGeometry {
+    type: 'Point';
+    coordinates: Coordinate;
+}
+export interface GeoLineStringGeometry {
+    type: 'LineString';
+    coordinates: Coordinate[];
+}
+export interface GeoPolygonGeometry {
+    type: 'Polygon';
+    coordinates: Coordinate[][];
+}
+export interface GeoMultiPolygonGeometry {
+    type: 'MultiPolygon';
+    coordinates: Coordinate[][][];
+}
+/** Optional feature-type geometry that can be normalized to bbox or points. */
+export type SpatialSubjectGeometry = GeoGeometry;
+export interface BoundingBox {
+    minLon: number;
+    minLat: number;
+    maxLon: number;
+    maxLat: number;
+}
+export type SpatialObjectKind = 'site-boundary' | 'zone' | 'route' | 'scene-footprint' | 'asset-footprint' | 'restricted-area' | 'inspection-area' | 'custom';
+export interface SpatialObject {
+    spatialId: string;
+    kind: SpatialObjectKind;
+    geometry: GeoGeometry;
+    crs?: 'EPSG:4326' | string;
+    name?: string;
+    metadata?: Record<string, unknown>;
+}
+export type SpatialRelationType = 'inside' | 'outside' | 'intersects' | 'overlaps' | 'covers' | 'covered_by' | 'within_distance' | 'near_boundary' | 'on_route' | 'entered_zone' | 'exited_zone' | 'unknown';
+export interface EngineInfo {
+    name: string;
+    version: string;
+    algorithm: string;
+}
+export interface SpatialRelationClaimInputs {
+    /** totem:geo:<hex> hash of the subject geometry (when supplied). */
+    subjectGeometryHash?: string;
+    /** totem:geo:<hex> hash of the spatial object's geometry. */
+    spatialGeometryHash: string;
+    /** Optional subject proof ID the geometry was derived from. */
+    subjectProofId?: string;
+    /** Optional location claim ID the geometry was derived from. */
+    locationClaimId?: string;
+    /** Optional raster/scene manifest ID the geometry was derived from. */
+    rasterManifestId?: string;
+}
+export interface SpatialRelationClaimResult {
+    matched: boolean;
+    distanceM?: number;
+    confidenceScore?: number;
+    /**
+     * Explicit notes on approximation. Present whenever a relation was
+     * evaluated with an approximate algorithm (e.g. bbox-only). Honesty is
+     * critical — the package never silently claims exactness.
+     */
+    uncertainty?: string[];
+}
+export interface SpatialRelationClaim {
+    relationId: string;
+    subjectId: string;
+    subjectKind: string;
+    spatialObjectId: string;
+    relation: SpatialRelationType;
+    computedAt: number;
+    engine: EngineInfo;
+    inputs: SpatialRelationClaimInputs;
+    result: SpatialRelationClaimResult;
+    metadata?: Record<string, unknown>;
+}
+export interface SpatialValidationResult {
+    valid: boolean;
+    errors: string[];
+    warnings: string[];
+}
+export interface EvaluateSpatialRelationParams {
+    subjectId: string;
+    subjectKind: string;
+    spatialObject: SpatialObject;
+    relation: SpatialRelationType;
+    subjectGeometry?: SpatialSubjectGeometry;
+    /** Required for distance-based relations (within_distance, on_route, near_boundary). */
+    maxDistanceM?: number;
+    computedAt?: number;
+    subjectProofId?: string;
+    locationClaimId?: string;
+    rasterManifestId?: string;
+    metadata?: Record<string, unknown>;
+}
+export interface CreateSpatialProofParams {
+    claim: SpatialRelationClaim;
+    /** Full spatial object used to compute its evidence hash. */
+    spatialObject: SpatialObject;
+    /** Optional subject geometry used to add a geometry evidence ref. */
+    subjectGeometry?: GeoGeometry;
+    issuer?: string;
+    issuedAt?: number;
+    expiresAt?: number;
+}
+export interface SpatialProofVerifyResult {
+    valid: boolean;
+    reason?: string;
+    signerAddress?: string;
+    spatialObjectId?: string;
+    relationId?: string;
+    payloadValid?: boolean;
+    evidenceHashValid?: boolean;
+    relationIdValid?: boolean;
+}

package/dist/types.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * @totemsdk/spatial-proof — Type definitions
+ *
+ * Pure schema for geospatial relationship proofs.
+ *
+ * COORDINATE ORDER: GeoJSON order — [longitude, latitude] in decimal degrees
+ * (WGS84 / EPSG:4326). This is the opposite of "lat, lon". All geometry
+ * functions and hashes in this package assume [lon, lat].
+ *
+ * No network, no storage, no map rendering, no GIS engine dependency.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@totemsdk/spatial-proof",
+  "version": "0.1.0",
+  "description": "Generic spatial relationship proof primitives for Totem Edge — geometry hashes, geofence relations, route checks, and proof envelope integration",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@totemsdk/core": "^1.2.7",
+    "@totemsdk/proof": "^0.1.2",
+    "@totemsdk/location-proof": "^0.1.0",
+    "@totemsdk/proofgraph": "^0.1.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^20.0.0",
+    "jest": "^30.4.2",
+    "ts-jest": "^29.0.0",
+    "typescript": "^7.0.2"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "author": "Totem SDK",
+  "homepage": "https://totem.ing",
+  "bugs": {
+    "url": "https://github.com/totem-sdk/totem-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/totem-sdk/totem-sdk.git",
+    "directory": "packages/spatial-proof"
+  },
+  "keywords": [
+    "totem",
+    "totemsdk",
+    "spatial",
+    "geojson",
+    "geofence",
+    "proof",
+    "location",
+    "route",
+    "boundary",
+    "edge",
+    "autonomous-devices"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "test": "jest"
+  }
+}