fireberry-api-client 1.0.2-beta.1.0 → 1.0.2-beta.1.2

package/dist/{relatedFieldMapping-Plja-OuE.d.ts → relatedFieldMapping-6o0SKPT2.d.ts}

@@ -1,11 +1,23 @@
-import { Q as QueryBuilder, a as QueryOptions, b as QueryResult } from './excludedFields-CuQ8Dp-N.js';
+import { F as FireberrySDKClient, a as QueryOptions, b as QueryResult, Q as QueryBuilder } from './excludedFields-Dk-ILROQ.js';
 
 /**
  * Configuration options for FireberryClient
+ * Supports two modes:
+ * 1. API Key mode: Provide apiKey for direct HTTP API access
+ * 2. SDK mode: Provide sdk for iframe messaging (CRUD only, metadata requires apiKey)
+ * 3. Hybrid mode: Provide both sdk and apiKey (SDK for CRUD, API for metadata)
  */
 interface FireberryClientConfig {
-    /** Fireberry API key */
-    apiKey: string;
+    /**
+     * Fireberry API key (required for API mode, optional for SDK mode)
+     * If using SDK mode without apiKey, metadata operations will not be available
+     */
+    apiKey?: string;
+    /**
+     * Fireberry SDK client instance (optional)
+     * When provided, CRUD operations will use SDK iframe messaging instead of HTTP
+     */
+    sdk?: FireberrySDKClient;
     /** Base URL for API requests (default: https://api.fireberry.com) */
     baseUrl?: string;
     /** Request timeout in milliseconds (default: 30000) */
@@ -62,6 +74,263 @@ interface CacheControl {
     clearObjects(): void;
 }
 
+/**
+ * Generic record type
+ */
+type FireberryRecord = Record<string, unknown>;
+/**
+ * Options for create operation
+ */
+interface CreateOptions {
+    /** AbortSignal for cancellation */
+    signal?: AbortSignal;
+}
+/**
+ * Options for update operation
+ */
+interface UpdateOptions {
+    /** AbortSignal for cancellation */
+    signal?: AbortSignal;
+}
+/**
+ * Options for delete operation
+ */
+interface DeleteOptions {
+    /** AbortSignal for cancellation */
+    signal?: AbortSignal;
+}
+/**
+ * Options for upsert operation
+ */
+interface UpsertOptions {
+    /** AbortSignal for cancellation */
+    signal?: AbortSignal;
+}
+/**
+ * Result of upsert operation
+ */
+interface UpsertResult {
+    /** Whether the operation was successful */
+    success: boolean;
+    /** Type of operation performed */
+    operationType: 'create' | 'update';
+    /** Key fields used for matching */
+    upsertKeys: string[];
+    /** Values of key fields */
+    upsertKeyValues: Record<string, unknown>;
+    /** Previous record data (null if created) */
+    oldRecord: FireberryRecord | null;
+    /** New record data */
+    newRecord: FireberryRecord;
+}
+/**
+ * Options for batch create operation
+ */
+interface BatchCreateOptions {
+    /** AbortSignal for cancellation */
+    signal?: AbortSignal;
+}
+/**
+ * Options for batch update operation
+ */
+interface BatchUpdateOptions {
+    /** AbortSignal for cancellation */
+    signal?: AbortSignal;
+}
+/**
+ * Record for batch update (includes id)
+ */
+interface BatchUpdateRecord {
+    id: string;
+    record: FireberryRecord;
+}
+/**
+ * Options for batch delete operation
+ */
+interface BatchDeleteOptions {
+    /** AbortSignal for cancellation */
+    signal?: AbortSignal;
+}
+/**
+ * Result of batch operation
+ */
+interface BatchResult {
+    /** Whether the operation was successful */
+    success: boolean;
+    /** Response data from API */
+    data: unknown[];
+    /** Number of records processed */
+    count: number;
+}
+/**
+ * Result of batch delete operation
+ */
+interface BatchDeleteResult {
+    /** Whether the operation was successful */
+    success: boolean;
+    /** IDs of deleted records */
+    ids: string[];
+    /** Number of records deleted */
+    count: number;
+}
+
+/**
+ * Transport layer types for abstracting communication with Fireberry
+ * Supports both HTTP API and SDK iframe messaging
+ */
+
+/**
+ * Generic transport request options
+ */
+interface TransportRequestOptions {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    endpoint: string;
+    query?: Record<string, string | number | boolean>;
+    body?: unknown;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+}
+/**
+ * Transport interface that both HTTP and SDK implementations must follow
+ */
+interface Transport {
+    /**
+     * Execute a raw request through this transport
+     */
+    request<T = unknown>(options: TransportRequestOptions): Promise<T>;
+    /**
+     * Execute a query operation
+     */
+    query(options: QueryOptions): Promise<QueryResult>;
+    /**
+     * Create a record
+     */
+    createRecord(objectType: string, data: FireberryRecord, signal?: AbortSignal): Promise<FireberryRecord>;
+    /**
+     * Update a record
+     */
+    updateRecord(objectType: string, recordId: string, data: FireberryRecord, signal?: AbortSignal): Promise<FireberryRecord>;
+    /**
+     * Delete a record
+     */
+    deleteRecord(objectType: string, recordId: string, signal?: AbortSignal): Promise<{
+        success: boolean;
+        id: string;
+    }>;
+    /**
+     * Batch create records
+     */
+    batchCreate(objectType: string, records: FireberryRecord[], signal?: AbortSignal): Promise<{
+        success: boolean;
+        data: unknown[];
+        count: number;
+    }>;
+    /**
+     * Batch update records
+     */
+    batchUpdate(objectType: string, records: Array<{
+        id: string;
+        record: FireberryRecord;
+    }>, signal?: AbortSignal): Promise<{
+        success: boolean;
+        data: unknown[];
+        count: number;
+    }>;
+    /**
+     * Batch delete records
+     */
+    batchDelete(objectType: string, recordIds: string[], signal?: AbortSignal): Promise<{
+        success: boolean;
+        ids: string[];
+        count: number;
+    }>;
+    /**
+     * Get the transport type
+     */
+    getType(): 'http' | 'sdk';
+}
+/**
+ * Configuration for HTTP transport
+ */
+interface HTTPTransportConfig {
+    apiKey: string;
+    baseUrl?: string;
+    timeout?: number;
+    retryOn429?: boolean;
+    maxRetries?: number;
+    retryDelay?: number;
+}
+/**
+ * Configuration for SDK transport
+ */
+interface SDKTransportConfig {
+    sdk: FireberrySDKClient;
+}
+/**
+ * Union type for transport configuration
+ */
+type TransportConfig = HTTPTransportConfig | SDKTransportConfig;
+/**
+ * Type guard to check if config is HTTP transport config
+ */
+declare function isHTTPTransportConfig(config: TransportConfig): config is HTTPTransportConfig;
+/**
+ * Type guard to check if config is SDK transport config
+ */
+declare function isSDKTransportConfig(config: TransportConfig): config is SDKTransportConfig;
+
+/**
+ * HTTP Transport implementation for Fireberry API
+ * Uses direct HTTP requests with API key authentication
+ */
+
+/**
+ * HTTP transport for API key-based communication
+ */
+declare class HTTPTransport implements Transport {
+    private readonly config;
+    constructor(config: HTTPTransportConfig);
+    getType(): 'http';
+    request<T = unknown>(options: TransportRequestOptions): Promise<T>;
+    query(options: QueryOptions): Promise<QueryResult>;
+    createRecord(objectType: string, data: FireberryRecord, signal?: AbortSignal): Promise<FireberryRecord>;
+    updateRecord(objectType: string, recordId: string, data: FireberryRecord, signal?: AbortSignal): Promise<FireberryRecord>;
+    deleteRecord(objectType: string, recordId: string, signal?: AbortSignal): Promise<{
+        success: boolean;
+        id: string;
+    }>;
+    batchCreate(objectType: string, records: FireberryRecord[], signal?: AbortSignal): Promise<{
+        success: boolean;
+        data: unknown[];
+        count: number;
+    }>;
+    batchUpdate(objectType: string, records: Array<{
+        id: string;
+        record: FireberryRecord;
+    }>, signal?: AbortSignal): Promise<{
+        success: boolean;
+        data: unknown[];
+        count: number;
+    }>;
+    batchDelete(objectType: string, recordIds: string[], signal?: AbortSignal): Promise<{
+        success: boolean;
+        ids: string[];
+        count: number;
+    }>;
+    /**
+     * Fetches all pages of a query
+     */
+    private queryAllPages;
+    /**
+     * Executes a fetch request with retry logic for 429 errors
+     */
+    private executeWithRetry;
+    /**
+     * Combines multiple abort signals into one
+     */
+    private combineSignals;
+}
+
 /**
  * Fireberry object/entity type
  */
@@ -158,6 +427,11 @@ interface GetFieldValuesResult {
 declare class MetadataAPI {
     private readonly client;
     constructor(client: FireberryClient);
+    /**
+     * Checks if metadata operations are available and throws error if not
+     * @private
+     */
+    private ensureMetadataAvailable;
     /**
      * Gets all available objects/entity types from Fireberry
      *
@@ -217,106 +491,6 @@ declare class MetadataAPI {
     getFieldValues(objectType: string | number, fieldName: string, signal?: AbortSignal): Promise<GetFieldValuesResult>;
 }
 
-/**
- * Generic record type
- */
-type FireberryRecord = Record<string, unknown>;
-/**
- * Options for create operation
- */
-interface CreateOptions {
-    /** AbortSignal for cancellation */
-    signal?: AbortSignal;
-}
-/**
- * Options for update operation
- */
-interface UpdateOptions {
-    /** AbortSignal for cancellation */
-    signal?: AbortSignal;
-}
-/**
- * Options for delete operation
- */
-interface DeleteOptions {
-    /** AbortSignal for cancellation */
-    signal?: AbortSignal;
-}
-/**
- * Options for upsert operation
- */
-interface UpsertOptions {
-    /** AbortSignal for cancellation */
-    signal?: AbortSignal;
-}
-/**
- * Result of upsert operation
- */
-interface UpsertResult {
-    /** Whether the operation was successful */
-    success: boolean;
-    /** Type of operation performed */
-    operationType: 'create' | 'update';
-    /** Key fields used for matching */
-    upsertKeys: string[];
-    /** Values of key fields */
-    upsertKeyValues: Record<string, unknown>;
-    /** Previous record data (null if created) */
-    oldRecord: FireberryRecord | null;
-    /** New record data */
-    newRecord: FireberryRecord;
-}
-/**
- * Options for batch create operation
- */
-interface BatchCreateOptions {
-    /** AbortSignal for cancellation */
-    signal?: AbortSignal;
-}
-/**
- * Options for batch update operation
- */
-interface BatchUpdateOptions {
-    /** AbortSignal for cancellation */
-    signal?: AbortSignal;
-}
-/**
- * Record for batch update (includes id)
- */
-interface BatchUpdateRecord {
-    id: string;
-    record: FireberryRecord;
-}
-/**
- * Options for batch delete operation
- */
-interface BatchDeleteOptions {
-    /** AbortSignal for cancellation */
-    signal?: AbortSignal;
-}
-/**
- * Result of batch operation
- */
-interface BatchResult {
-    /** Whether the operation was successful */
-    success: boolean;
-    /** Response data from API */
-    data: unknown[];
-    /** Number of records processed */
-    count: number;
-}
-/**
- * Result of batch delete operation
- */
-interface BatchDeleteResult {
-    /** Whether the operation was successful */
-    success: boolean;
-    /** IDs of deleted records */
-    ids: string[];
-    /** Number of records deleted */
-    count: number;
-}
-
 /**
  * Records API for CRUD operations on Fireberry records
  */
@@ -707,9 +881,12 @@ declare class FilesAPI {
  */
 declare class FireberryClient {
     private readonly config;
+    private readonly normalizedConfig;
     private readonly cacheStore;
     private readonly inFlightQueries;
     private readonly queryCache;
+    private readonly transport;
+    private readonly metadataTransport;
     /** Metadata API operations */
     readonly metadata: MetadataAPI;
     /** Records CRUD operations */
@@ -725,9 +902,35 @@ declare class FireberryClient {
      */
     constructor(config: FireberryClientConfig);
     /**
-     * Gets the client configuration
+     * Gets the client configuration with all defaults applied
+     */
+    getConfig(): Readonly<FireberryClientConfig & {
+        baseUrl: string;
+        timeout: number;
+        retryOn429: boolean;
+        maxRetries: number;
+        retryDelay: number;
+        cacheMetadata: boolean;
+        cacheTTL: number;
+        cacheQueryResults: boolean;
+        queryResultCacheTTL: number;
+        invalidateCacheOnMutation: boolean;
+    }>;
+    /**
+     * Gets the transport instance (for internal use by API modules)
+     * @internal
+     */
+    getTransport(): Transport;
+    /**
+     * Gets the metadata transport instance (for internal use by MetadataAPI)
+     * Returns null if metadata is not available (SDK-only mode without API key)
+     * @internal
+     */
+    getMetadataTransport(): HTTPTransport | null;
+    /**
+     * Checks if metadata operations are available
      */
-    getConfig(): Readonly<Required<FireberryClientConfig>>;
+    isMetadataAvailable(): boolean;
     /**
      * Cache control methods
      */
@@ -826,26 +1029,16 @@ declare class FireberryClient {
      * Internal query execution (without deduplication)
      */
     private executeQuery;
-    /**
-     * Fetches all pages of a query
-     */
-    private queryAllPages;
     /**
      * Expands '*' fields to actual field names, excluding problematic fields for specific object types
      */
     private expandStarFields;
     /**
      * Makes a raw API request to the Fireberry API
+     * @deprecated Use getTransport() or getMetadataTransport() for new code
+     * @internal This method is kept for backwards compatibility with API modules
      */
     request<T = unknown>(options: RequestOptions): Promise<T>;
-    /**
-     * Executes a fetch request with retry logic for 429 errors
-     */
-    private executeWithRetry;
-    /**
-     * Combines multiple abort signals into one
-     */
-    private combineSignals;
 }
 
 /**
@@ -1076,4 +1269,4 @@ declare function expandRelatedFields(fields: string[]): string[];
  */
 declare function getRelatedFieldInfo(fieldName: string): (RelatedFieldInfo & RelatedFieldResolution) | null;
 
-export { type CreateTextFieldOptions as A, type BatchCreateOptions as B, type CacheControl as C, type DeleteOptions as D, type CreateNumberFieldOptions as E, FireberryClient as F, type GetObjectsResult as G, type CreateLookupFieldOptions as H, ID_FIELD_TO_OBJECT_TYPE as I, type CreatePicklistFieldOptions as J, type CreateSummaryFieldOptions as K, type FormulaFieldType as L, type CreateFormulaFieldOptions as M, type CreateSimpleFieldOptions as N, type CreateFieldOptions as O, type PicklistValue as P, type CreateFieldResult as Q, RelatedFieldResolver as R, type SummaryType as S, type FileUploadOptions as T, type UpdateOptions as U, type FileUploadResult as V, isCodeField as W, getCodeFieldFromLabel as X, getLabelFieldFromCode as Y, isDropdownFieldByMetadata as Z, getObjectTypeFromReferenceField as a, type RelatedFieldInfo as b, type RelatedFieldResolution as c, type FieldMetadataMap as d, expandRelatedFields as e, type FireberryClientConfig as f, getRelatedFieldInfo as g, type RequestOptions as h, type FireberryRecord as i, type CreateOptions as j, type UpsertOptions as k, type UpsertResult as l, type BatchUpdateOptions as m, type BatchUpdateRecord as n, type BatchDeleteOptions as o, parseRelatedField as p, type BatchResult as q, resolveRelatedField as r, type BatchDeleteResult as s, type FireberryObject as t, type FireberryField as u, type FieldValue as v, type GetFieldsResult as w, type GetFieldValuesResult as x, type CreateFieldType as y, type CreateFieldOptionsBase as z };
+export { isHTTPTransportConfig as $, type CreateTextFieldOptions as A, type BatchCreateOptions as B, type CacheControl as C, type DeleteOptions as D, type CreateNumberFieldOptions as E, FireberryClient as F, type GetObjectsResult as G, type CreateLookupFieldOptions as H, ID_FIELD_TO_OBJECT_TYPE as I, type CreatePicklistFieldOptions as J, type CreateSummaryFieldOptions as K, type FormulaFieldType as L, type CreateFormulaFieldOptions as M, type CreateSimpleFieldOptions as N, type CreateFieldOptions as O, type PicklistValue as P, type CreateFieldResult as Q, RelatedFieldResolver as R, type SummaryType as S, type FileUploadOptions as T, type UpdateOptions as U, type FileUploadResult as V, type Transport as W, type TransportRequestOptions as X, type HTTPTransportConfig as Y, type SDKTransportConfig as Z, type TransportConfig as _, getObjectTypeFromReferenceField as a, isSDKTransportConfig as a0, isCodeField as a1, getCodeFieldFromLabel as a2, getLabelFieldFromCode as a3, isDropdownFieldByMetadata as a4, type RelatedFieldInfo as b, type RelatedFieldResolution as c, type FieldMetadataMap as d, expandRelatedFields as e, type FireberryClientConfig as f, getRelatedFieldInfo as g, type RequestOptions as h, type FireberryRecord as i, type CreateOptions as j, type UpsertOptions as k, type UpsertResult as l, type BatchUpdateOptions as m, type BatchUpdateRecord as n, type BatchDeleteOptions as o, parseRelatedField as p, type BatchResult as q, resolveRelatedField as r, type BatchDeleteResult as s, type FireberryObject as t, type FireberryField as u, type FieldValue as v, type GetFieldsResult as w, type GetFieldValuesResult as x, type CreateFieldType as y, type CreateFieldOptionsBase as z };