fireberry-api-client 1.0.0-beta.1

package/dist/sdk/index.d.ts

@@ -0,0 +1,372 @@
+export { C as ConditionBuilder, E as EXCLUDED_FIELDS_FOR_STAR_QUERY, F as FIELD_TYPE_IDS, a as FIELD_TYPE_MAPPINGS, O as OBJECT_ID_MAP, b as OBJECT_NAME_MAP, Q as QueryBuilder, e as escapeQueryValue, d as getExcludedFieldsForStarQuery, c as getNameFieldByObjectType, g as getObjectIdFieldName, s as sanitizeQuery } from '../excludedFields-CGXgZN8Y.js';
+export { g as getLabelFieldForField, i as isDropdownField, b as isDropdownOrLookupField, a as isLookupField } from '../fieldTypes-BLzJTzpI.js';
+
+/**
+ * Type definitions for @fireberry/sdk compatibility
+ * These types mirror the Fireberry SDK's API for seamless integration
+ */
+/**
+ * Query payload expected by the Fireberry SDK
+ */
+interface SDKQueryPayload {
+    /** Comma-separated field names to return */
+    fields: string;
+    /** Query filter string */
+    query: string;
+    /** Number of records per page */
+    page_size?: number;
+    /** Page number (1-based) */
+    page_number?: number;
+}
+/**
+ * Response error from SDK
+ */
+interface SDKResponseError {
+    data: Record<string, unknown> & {
+        Message?: string;
+    };
+    status: number;
+    statusText: string;
+}
+/**
+ * Response data from SDK operations
+ */
+interface SDKResponseData<T = Record<string, unknown>> {
+    type?: string;
+    success: boolean;
+    data: T & {
+        requestId?: string;
+    };
+    error?: SDKResponseError;
+    isParentReady: boolean;
+    requestId: string;
+}
+/**
+ * Record details from SDK context
+ */
+interface SDKRecordDetails {
+    type?: number;
+    id?: string;
+}
+/**
+ * User details from SDK context
+ */
+interface SDKUserDetails {
+    fullName?: string;
+    id?: string;
+}
+/**
+ * SDK context information
+ */
+interface SDKContext {
+    user: SDKUserDetails;
+    record: SDKRecordDetails;
+}
+/**
+ * Generic payload type for create/update operations
+ */
+type SDKPayload = Record<string, unknown>;
+/**
+ * Fireberry SDK API interface
+ * Matches the API surface of @fireberry/sdk
+ */
+interface FireberrySDKAPI<TData = Record<string, unknown>> {
+    /** Query records with filtering and pagination */
+    query: (objectType: string | number, payload: SDKQueryPayload) => Promise<SDKResponseData<TData>>;
+    /** Create a new record */
+    create: <T extends SDKPayload>(objectType: string | number, payload: T) => Promise<SDKResponseData<TData>>;
+    /** Delete a record by ID */
+    delete: (objectType: string | number, recordId: string) => Promise<SDKResponseData<TData>>;
+    /** Update an existing record */
+    update: <T extends SDKPayload>(objectType: string | number, recordId: string, payload: T) => Promise<SDKResponseData<TData>>;
+}
+/**
+ * Fireberry SDK Client interface
+ * Matches the structure of FireberryClientSDK from @fireberry/sdk
+ */
+interface FireberrySDKClient<TData = Record<string, unknown>> {
+    /** Access to CRUD API methods */
+    readonly api: FireberrySDKAPI<TData>;
+    /** Current context (record and user info) - null if not initialized */
+    readonly context: SDKContext | null;
+    /** Initialize context from parent Fireberry window */
+    initializeContext(): Promise<FireberrySDKClient<TData>>;
+    /** Clean up event listeners and pending requests */
+    destroy(): void;
+}
+
+/**
+ * SDK Adapter for @fireberry/sdk
+ *
+ * This module provides utilities to enhance the Fireberry SDK with
+ * QueryBuilder and field mapping capabilities from fireberry-api-client.
+ *
+ * @example
+ * ```typescript
+ * import FireberryClientSDK from '@fireberry/sdk/client';
+ * import { createSDKQueryBuilder, EnhancedSDK } from 'fireberry-api-client/sdk';
+ *
+ * // Option 1: Use query builder factory
+ * const sdk = new FireberryClientSDK();
+ * await sdk.initializeContext();
+ *
+ * const queryBuilder = createSDKQueryBuilder(sdk);
+ * const results = await queryBuilder(1)
+ *   .select('accountid', 'accountname', 'statuscode')
+ *   .where('statuscode').equals('1')
+ *   .execute();
+ *
+ * // Option 2: Use enhanced SDK wrapper
+ * const enhanced = EnhancedSDK.create(sdk);
+ * const results = await enhanced
+ *   .query(1)
+ *   .select('accountid', 'accountname')
+ *   .where('statuscode').equals('1')
+ *   .execute();
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * Condition builder that returns SDKQueryBuilder for fluent chaining
+ */
+interface SDKConditionBuilder {
+    equals(value: string | number): SDKQueryBuilder;
+    notEquals(value: string | number): SDKQueryBuilder;
+    lessThan(value: string | number): SDKQueryBuilder;
+    greaterThan(value: string | number): SDKQueryBuilder;
+    lessThanOrEqual(value: string | number): SDKQueryBuilder;
+    greaterThanOrEqual(value: string | number): SDKQueryBuilder;
+    contains(value: string): SDKQueryBuilder;
+    notContains(value: string): SDKQueryBuilder;
+    startsWith(value: string): SDKQueryBuilder;
+    notStartsWith(value: string): SDKQueryBuilder;
+    isNull(): SDKQueryBuilder;
+    isNotNull(): SDKQueryBuilder;
+}
+/**
+ * SDK-compatible query builder that executes via the Fireberry SDK
+ */
+declare class SDKQueryBuilder {
+    private builder;
+    private objectTypeId;
+    private sdk;
+    private selectedFields;
+    private pageSizeValue?;
+    private pageNum;
+    constructor(sdk: FireberrySDKAPI, objectType: number | string);
+    /**
+     * Select fields to return
+     * @param fields - Field names to include in results
+     */
+    select(...fields: string[]): this;
+    /**
+     * Select fields with their label fields automatically included
+     * Useful for dropdown and lookup fields where you want both ID and display value
+     * @param fields - Field names to include
+     */
+    selectWithLabels(...fields: string[]): this;
+    /**
+     * Start a WHERE condition
+     * @param field - Field name to filter on
+     */
+    where(field: string): SDKConditionBuilder;
+    /**
+     * Add AND logical operator
+     */
+    and(): this;
+    /**
+     * Add OR logical operator
+     */
+    or(): this;
+    /**
+     * Set page size for pagination
+     * @param size - Number of records per page
+     */
+    pageSize(size: number): this;
+    /**
+     * Set page number for pagination
+     * @param page - Page number (1-based)
+     */
+    page(page: number): this;
+    /**
+     * Build the query payload without executing
+     * Useful if you want to modify the payload before sending
+     */
+    toQueryPayload(): SDKQueryPayload;
+    /**
+     * Execute the query via the SDK
+     */
+    execute<T = Record<string, unknown>>(): Promise<SDKResponseData<T>>;
+}
+/**
+ * Creates a query builder factory bound to a Fireberry SDK instance
+ *
+ * @param sdk - Fireberry SDK client or API instance
+ * @returns Factory function that creates SDKQueryBuilder instances
+ *
+ * @example
+ * ```typescript
+ * import FireberryClientSDK from '@fireberry/sdk/client';
+ * import { createSDKQueryBuilder } from 'fireberry-api-client/sdk';
+ *
+ * const sdk = new FireberryClientSDK();
+ * await sdk.initializeContext();
+ *
+ * const queryBuilder = createSDKQueryBuilder(sdk);
+ *
+ * // Query accounts where status is active
+ * const results = await queryBuilder(1) // 1 = Account object type
+ *   .select('accountid', 'accountname', 'statuscode', 'status')
+ *   .where('statuscode').equals('1')
+ *   .pageSize(50)
+ *   .execute();
+ * ```
+ */
+declare function createSDKQueryBuilder(sdk: FireberrySDKClient | FireberrySDKAPI): (objectType: number | string) => SDKQueryBuilder;
+/**
+ * Enhanced SDK wrapper that combines Fireberry SDK with utility functions
+ * Provides a more feature-rich API for working with Fireberry data
+ */
+declare class EnhancedSDK<TData = Record<string, unknown>> {
+    private sdk;
+    private constructor();
+    /**
+     * Create an EnhancedSDK wrapper around an existing SDK instance
+     * The SDK should already be initialized with context
+     *
+     * @param sdk - Initialized Fireberry SDK client
+     */
+    static create<T = Record<string, unknown>>(sdk: FireberrySDKClient<T>): EnhancedSDK<T>;
+    /**
+     * Get the current context (user and record info)
+     */
+    get context(): SDKContext | null;
+    /**
+     * Get the underlying SDK API for direct access
+     */
+    get api(): FireberrySDKAPI<TData>;
+    /**
+     * Get the current user ID from context
+     */
+    get userId(): string | undefined;
+    /**
+     * Get the current user's full name from context
+     */
+    get userFullName(): string | undefined;
+    /**
+     * Get the current record ID from context
+     */
+    get recordId(): string | undefined;
+    /**
+     * Get the current record's object type from context
+     */
+    get recordType(): number | undefined;
+    /**
+     * Start building a query for an object type
+     *
+     * @param objectType - Object type ID (e.g., 1 for Account, 2 for Contact)
+     * @returns SDKQueryBuilder for fluent query construction
+     *
+     * @example
+     * ```typescript
+     * const results = await enhanced
+     *   .query(1)
+     *   .select('accountid', 'accountname')
+     *   .where('ownerid').equals(enhanced.userId)
+     *   .execute();
+     * ```
+     */
+    query(objectType: number | string): SDKQueryBuilder;
+    /**
+     * Get the primary key field name for an object type
+     *
+     * @param objectType - Object type ID
+     * @returns Primary key field name (e.g., 'accountid' for type 1)
+     *
+     * @example
+     * ```typescript
+     * const idField = enhanced.getIdField(1); // 'accountid'
+     * const idField = enhanced.getIdField(2); // 'contactid'
+     * ```
+     */
+    getIdField(objectType: number | string): string;
+    /**
+     * Get the display name field for an object type
+     *
+     * @param objectType - Object type ID
+     * @returns Name field (e.g., 'accountname' for type 1, 'fullname' for type 2)
+     *
+     * @example
+     * ```typescript
+     * const nameField = enhanced.getNameField(1); // 'accountname'
+     * const nameField = enhanced.getNameField(2); // 'fullname'
+     * ```
+     */
+    getNameField(objectType: number | string): string;
+    /**
+     * Get the label field for a dropdown or lookup field
+     *
+     * @param fieldName - API field name
+     * @param objectType - Object type ID
+     * @returns Label field name, or empty string if not applicable
+     *
+     * @example
+     * ```typescript
+     * const labelField = enhanced.getLabelField('statuscode', 1); // 'status'
+     * const labelField = enhanced.getLabelField('ownerid', 1);    // 'ownername'
+     * ```
+     */
+    getLabelField(fieldName: string, objectType: number | string): string;
+    /**
+     * Get fields that should be excluded from * (star) queries for an object type
+     * Some fields cause API errors when included in broad queries
+     *
+     * @param objectType - Object type ID
+     * @returns Array of field names to exclude
+     */
+    getExcludedFields(objectType: number | string): string[];
+    /**
+     * Expand field list to include label fields for dropdowns and lookups
+     *
+     * @param fields - Original field list
+     * @param objectType - Object type ID
+     * @returns Expanded field list with label fields
+     *
+     * @example
+     * ```typescript
+     * const fields = enhanced.expandFieldsWithLabels(['statuscode', 'ownerid'], 1);
+     * // Returns: ['statuscode', 'status', 'ownerid', 'ownername']
+     * ```
+     */
+    expandFieldsWithLabels(fields: string[], objectType: number | string): string[];
+    /**
+     * Create a record
+     *
+     * @param objectType - Object type ID
+     * @param data - Record data
+     */
+    create<T extends Record<string, unknown>>(objectType: number | string, data: T): Promise<SDKResponseData<TData>>;
+    /**
+     * Update a record
+     *
+     * @param objectType - Object type ID
+     * @param recordId - Record ID to update
+     * @param data - Updated field values
+     */
+    update<T extends Record<string, unknown>>(objectType: number | string, recordId: string, data: T): Promise<SDKResponseData<TData>>;
+    /**
+     * Delete a record
+     *
+     * @param objectType - Object type ID
+     * @param recordId - Record ID to delete
+     */
+    delete(objectType: number | string, recordId: string): Promise<SDKResponseData<TData>>;
+    /**
+     * Clean up the underlying SDK
+     */
+    destroy(): void;
+}
+
+export { EnhancedSDK, type FireberrySDKAPI, type FireberrySDKClient, type SDKContext, SDKQueryBuilder, type SDKQueryPayload, type SDKResponseData, createSDKQueryBuilder };