@onchaindb/sdk 2.0.0 → 2.1.0

package/src/database.ts

@@ -9,20 +9,72 @@ import {
     CreateApiCollectionRequest,
 } from './types';
 
+// ─── Write pricing (price index) ────────────────────────────────────────────
+// Mirrors Rust: WritePricingModel + PriceConfigRequest (indexing/types.rs)
+
+export type WritePricingModel = 'field_value' | 'per_kb' | 'per_record';
+
+/** Configuration for write-time payment collection (price indexes). */
+export interface WriteIndexConfig {
+  /** How the write cost is calculated. */
+  pricing_model?: WritePricingModel;
+  /** Cost per KB of data written, in USDC base units (6 decimals — e.g. 1_000_000 = 1 USDC). */
+  price_per_kb?: number;
+  /** Cost per record written, in USDC base units. */
+  price_per_record?: number;
+}
+
+// ─── Read pricing ────────────────────────────────────────────────────────────
+// Mirrors Rust: ReadPricingModel + ReadPriceConfigRequest (indexing/types.rs)
+
+export type ReadPricingModel = 'per_access' | 'per_kb' | 'per_query';
+
+/** Configuration for read-time payment collection. */
+export interface ReadIndexConfig {
+  /** How the read cost is calculated. */
+  pricing_model?: ReadPricingModel;
+  /** Cost per matched record returned, in USDC base units. */
+  price_per_access?: number;
+  /** Cost per KB of data returned, in USDC base units. */
+  price_per_kb?: number;
+  /** Flat cost per query execution, in USDC base units. */
+  price_per_query?: number;
+}
+
+// ─── Creator premium ─────────────────────────────────────────────────────────
+// Mirrors Rust: CreatorCutModel + CreatorPremiumConfigRequest (indexing/types.rs)
+
+export type CreatorCutModel = 'per_kb' | 'per_value_field' | 'per_value_percent' | 'fixed_amount';
+
+/** Configuration for creator revenue sharing on writes. */
+export interface CreatorPremiumConfig {
+  /** Dot-notation path to the creator's wallet address in the record (e.g. "user_address", "metadata.creator"). */
+  creator_address_resolution: string;
+  /** How the creator's cut is calculated. */
+  creator_cut_model: CreatorCutModel;
+  /** Amount or percentage value, depending on the model. */
+  creator_cut_value: number;
+  /** Field name used by per_value_field and per_value_percent models. */
+  value_field_name?: string;
+}
+
+// ─── Index ───────────────────────────────────────────────────────────────────
+
 export interface Index {
   name: string;
   collection: string;
   field_name: string;
   index_type: 'btree' | 'hash' | 'fulltext' | 'composite' | 'price';
   fields?: string[];
-  options?: IndexOptions;
-  price_config?: PriceConfig;
-}
-
-export interface PriceConfig {
-  app_owner_percentage: number;
-  platform_percentage: number;
-  app_owner_address: string;
+  store_values?: boolean;
+  unique_constraint?: boolean;
+  sort_enabled?: boolean;
+  /** Write-time payment config — only for index_type: 'price'. */
+  price_config?: WriteIndexConfig;
+  /** Read-time payment config — can be attached to any index type. */
+  read_price_config?: ReadIndexConfig;
+  /** Creator revenue sharing config — can be attached to any index type. */
+  creator_premium_config?: CreatorPremiumConfig;
 }
 
 export interface IndexOptions {
@@ -100,37 +152,116 @@ export class DatabaseManager {
   }
 
   /**
-   * Create a Price index for on-chain commerce
+   * Create a write-priced index (price index).
    *
-   * Price indexes enable automatic payment splits when writing to collections.
-   * Perfect for order/purchase collections where you want to charge based on item price.
+   * Charges writers a fee each time a record is written to the collection.
+   * The broker collects payment via the x402 protocol on every `/store` call.
+   *
+   * @param collection - Target collection name
+   * @param fieldName  - Field to index (used for routing/lookups)
+   * @param config     - Write pricing model and amounts (USDC base units, 6 decimals)
+   * @param opts       - Optional: override generated index name, store_values, unique_constraint, sort_enabled
    *
    * @example
    * ```typescript
-   * await db.database().createPriceIndex('orders', 'total_price', {
-   *   app_owner_percentage: 0.80,
-   *   platform_percentage: 0.20,
-   *   app_owner_address: 'celestia1abc...'
+   * await db.database().createWriteIndex('posts', 'author', {
+   *   pricing_model: 'per_record',
+   *   price_per_record: 500_000  // 0.50 USDC per write
    * });
    * ```
    */
-  async createPriceIndex(
+  async createWriteIndex(
     collection: string,
     fieldName: string,
-    config?: Partial<PriceConfig>
+    config: WriteIndexConfig,
+    opts?: { name?: string; storeValues?: boolean; uniqueConstraint?: boolean; sortEnabled?: boolean }
   ): Promise<Index> {
-    const priceConfig: PriceConfig = {
-      app_owner_percentage: config?.app_owner_percentage ?? 0.80,
-      platform_percentage: config?.platform_percentage ?? 0.20,
-      app_owner_address: config?.app_owner_address ?? ''
-    };
-
     return this.createIndex({
-      name: `${collection}_${fieldName}_price_index`,
+      name: opts?.name ?? `${collection}_${fieldName}_write_idx`,
       collection,
       field_name: fieldName,
       index_type: 'price',
-      price_config: priceConfig
+      store_values: opts?.storeValues ?? true,
+      unique_constraint: opts?.uniqueConstraint ?? false,
+      sort_enabled: opts?.sortEnabled ?? true,
+      price_config: config,
+    });
+  }
+
+  /**
+   * Create a read-priced index.
+   *
+   * Charges readers a fee each time the index is hit during a query.
+   * Can be applied to any index type (btree, hash, fulltext).
+   *
+   * @param collection - Target collection name
+   * @param fieldName  - Field to index
+   * @param config     - Read pricing model and amounts (USDC base units, 6 decimals)
+   * @param opts       - Optional: override index type (default btree), name, and other index options
+   *
+   * @example
+   * ```typescript
+   * await db.database().createReadIndex('articles', 'content', {
+   *   pricing_model: 'per_access',
+   *   price_per_access: 100_000  // 0.10 USDC per matched record
+   * }, { indexType: 'fulltext' });
+   * ```
+   */
+  async createReadIndex(
+    collection: string,
+    fieldName: string,
+    config: ReadIndexConfig,
+    opts?: { name?: string; indexType?: 'btree' | 'hash' | 'fulltext'; storeValues?: boolean; uniqueConstraint?: boolean; sortEnabled?: boolean }
+  ): Promise<Index> {
+    return this.createIndex({
+      name: opts?.name ?? `${collection}_${fieldName}_read_idx`,
+      collection,
+      field_name: fieldName,
+      index_type: opts?.indexType ?? 'btree',
+      store_values: opts?.storeValues ?? true,
+      unique_constraint: opts?.uniqueConstraint ?? false,
+      sort_enabled: opts?.sortEnabled ?? true,
+      read_price_config: config,
+    });
+  }
+
+  /**
+   * Create a creator-premium index.
+   *
+   * Routes a portion of write revenue directly to the content creator resolved
+   * from a field in each record. Creator gets 100% of the premium portion;
+   * the platform takes its 20% cut only from the base transaction.
+   *
+   * @param collection - Target collection name
+   * @param fieldName  - Field to index
+   * @param config     - Creator address resolution path, cut model, and cut value
+   * @param opts       - Optional: override index type (default btree), name, and other index options
+   *
+   * @example
+   * ```typescript
+   * await db.database().createCreatorPremiumIndex('tracks', 'title', {
+   *   creator_address_resolution: 'metadata.artist_address',
+   *   creator_cut_model: 'per_value_percent',
+   *   creator_cut_value: 10,          // 10% of the price field
+   *   value_field_name: 'price_usdc'
+   * });
+   * ```
+   */
+  async createCreatorPremiumIndex(
+    collection: string,
+    fieldName: string,
+    config: CreatorPremiumConfig,
+    opts?: { name?: string; indexType?: 'btree' | 'hash' | 'fulltext'; storeValues?: boolean; uniqueConstraint?: boolean; sortEnabled?: boolean }
+  ): Promise<Index> {
+    return this.createIndex({
+      name: opts?.name ?? `${collection}_${fieldName}_creator_idx`,
+      collection,
+      field_name: fieldName,
+      index_type: opts?.indexType ?? 'btree',
+      store_values: opts?.storeValues ?? true,
+      unique_constraint: opts?.uniqueConstraint ?? false,
+      sort_enabled: opts?.sortEnabled ?? true,
+      creator_premium_config: config,
     });
   }
 
@@ -148,9 +279,11 @@ export class DatabaseManager {
   }
 
   async queryView<T = any>(viewName: string, query: ViewQueryRequest = {}): Promise<ViewDataResponse<T>> {
+    // Server always requires `select` — default to empty object (return all fields)
+    const body = { select: {}, ...query };
     const response = await this.httpClient.post(
       `/api/views/${this.appId}/${viewName}/data`,
-      query,
+      body,
       { headers: this.getHeaders() }
     );
     return response.data;

package/src/index.ts

@@ -1,7 +1,21 @@
 // Main SDK exports
 export { OnDBClient } from './client';
 export { QueryBuilder } from './query-sdk';
-export { DatabaseManager, createDatabaseManager } from './database';
+export {
+    DatabaseManager,
+    createDatabaseManager,
+    type Index,
+    type WriteIndexConfig,
+    type WritePricingModel,
+    type ReadIndexConfig,
+    type ReadPricingModel,
+    type CreatorPremiumConfig,
+    type CreatorCutModel,
+    IndexOptions,
+    MaterializedView,
+    ViewInfo,
+    ListViewsResponse,
+} from './database';
 
 // Core type exports
 export type {
@@ -68,15 +82,7 @@ export type {
     PaymentMethod,
 } from './x402';
 
-// Database management type exports
-export type {
-    Index,
-    IndexOptions,
-    PriceConfig,
-    MaterializedView,
-    ViewInfo,
-    ListViewsResponse,
-} from './database';
+
 
 // Error exports
 export {

package/src/query-sdk/NestedBuilders.ts

@@ -160,16 +160,26 @@ export class NestedFieldConditionBuilder {
         return this.cond('b64', value);
     }
 
-    inDataset(dataset: string): LogicalOperator {
-        return this.cond('inDataset', dataset);
+    /** Case-sensitive membership check — use this when exact casing matters. For case-insensitive use .in() */
+    inDataset(values: string[]): LogicalOperator {
+        return this.cond('inDataset', values as any);
     }
 
     inCountry(countryCode: string): LogicalOperator {
         return this.cond('inCountry', countryCode);
     }
 
-    cidr(cidr: string): LogicalOperator {
-        return this.cond('CIDR', cidr);
+    /**
+     * Checks whether the data IP falls within any of the given CIDR ranges.
+     * Always sends the "$cidr" alias — never "CIDR", which causes a stack overflow in Scepter.
+     */
+    cidr(ranges: string | string[]): LogicalOperator {
+        return this.cond('$cidr', (Array.isArray(ranges) ? ranges : [ranges]) as any);
+    }
+
+    /** Matches if the field value contains ANY of the given keywords (case-insensitive substring). */
+    keywords(keywords: string[]): LogicalOperator {
+        return this.cond('keywords', keywords as any);
     }
 
     // ===== CONVENIENCE =====