@maravilla-labs/types 0.1.9 → 0.1.11

package/index.d.ts

@@ -0,0 +1,117 @@
+/**
+ * TypeScript definitions for Maravilla Runtime platform APIs
+ */
+/**
+ * Request options for KV list operations with cursor-based pagination
+ */
+export interface KvListRequest {
+    /** Optional cursor for pagination continuation */
+    cursor?: string;
+    /** Maximum number of keys to return (max 1000) */
+    limit?: number;
+    /** Optional prefix filter for keys */
+    prefix?: string;
+}
+/**
+ * Metadata for a single key in KV list results
+ */
+export interface KvKeyMetadata {
+    /** Key name */
+    name: string;
+    /** Optional expiration timestamp (Unix timestamp in seconds) */
+    expiration?: number;
+}
+/**
+ * Pagination result information
+ */
+export interface KvResultInfo {
+    /** Cursor for next page (undefined if no more results) */
+    cursor?: string;
+    /** Number of keys returned in this response */
+    count: number;
+}
+/**
+ * Response structure for KV list operations
+ */
+export interface KvListResponse {
+    /** List of key metadata */
+    result: KvKeyMetadata[];
+    /** Success indicator */
+    success: boolean;
+    /** Pagination information */
+    result_info: KvResultInfo;
+}
+/**
+ * Options for KV put operations
+ */
+export interface KvPutOptions {
+    /** Time-to-live in seconds */
+    ttl?: number;
+}
+/**
+ * KV Store interface
+ */
+export interface KvStore {
+    /**
+     * Get a value by key
+     */
+    get(namespace: string, key: string): Promise<any>;
+    /**
+     * Put a value with optional TTL
+     */
+    put(namespace: string, key: string, value: any, options?: KvPutOptions): Promise<void>;
+    /**
+     * Delete a key
+     */
+    delete(namespace: string, key: string): Promise<void>;
+    /**
+     * List keys with cursor-based pagination
+     */
+    list(namespace: string, options?: KvListRequest): Promise<KvListResponse>;
+}
+/**
+ * Database find options
+ */
+export interface DbFindOptions {
+    limit?: number;
+    skip?: number;
+    sort?: Record<string, 1 | -1>;
+    projection?: Record<string, 1 | 0>;
+}
+/**
+ * Database collection interface
+ */
+export interface DbCollection {
+    find(filter?: Record<string, any>, options?: DbFindOptions): Promise<any[]>;
+    findOne(filter?: Record<string, any>): Promise<any | null>;
+    insertOne(document: Record<string, any>): Promise<string>;
+    updateOne(filter: Record<string, any>, update: Record<string, any>): Promise<void>;
+    deleteOne(filter: Record<string, any>): Promise<void>;
+}
+/**
+ * Database interface with dynamic collection access
+ */
+export interface Database {
+    [collection: string]: DbCollection;
+}
+/**
+ * Main platform interface available in runtime
+ */
+export interface Platform {
+    /** KV Store instance */
+    kv: KvStore;
+    /** Database instance with dynamic collection access */
+    db: Database;
+    /** Legacy aliases for compatibility */
+    env: {
+        KV: KvStore;
+        DB: Database;
+    };
+}
+/**
+ * Global platform object available in runtime
+ */
+declare global {
+    const platform: Platform;
+}
+export { Platform as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maravilla-labs/types",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "TypeScript definitions for Maravilla Runtime platform APIs",
   "main": "index.ts",
   "types": "index.ts",

package/tsconfig.json

@@ -0,0 +1 @@
+{"compilerOptions":{"declaration":true,"emitDeclarationOnly":true,"strict":true,"target":"ES2022","module":"ESNext"},"include":["index.ts"]}