fireberry-api-client 1.0.0-beta.2.1 → 1.0.0-beta.2.3

package/README.md

@@ -188,18 +188,16 @@ await client.batch.delete('1', ['id-1', 'id-2', 'id-3']);
 // Get all objects
 const objects = await client.metadata.getObjects();
 
-// Get fields for an object
+// Get fields for an object (includes lookup relationships by default)
 const fields = await client.metadata.getFields('1');
 
-// Get fields with lookup relationships (shows which object each lookup field references)
-const fieldsWithRelations = await client.metadata.getFields('1', {
-  includeLookupRelations: true
-});
-
-// Example: Find related object for a lookup field
-const primaryContact = fieldsWithRelations.fields.find(f => f.fieldName === 'primarycontactid');
+// Find which object a lookup field references
+const primaryContact = fields.fields.find(f => f.fieldName === 'primarycontactid');
 console.log(primaryContact?.relatedObjectType); // 2 (Contact)
 
+// Disable lookup relations for faster response (skips additional API call)
+const fieldsOnly = await client.metadata.getFields('1', { includeLookupRelations: false });
+
 // Get dropdown values
 const values = await client.metadata.getFieldValues('1', 'statuscode');
 ```

package/dist/index.cjs

@@ -570,26 +570,27 @@ var MetadataAPI = class {
    *
    * @param objectType - The object type ID (e.g., '1' for Account)
    * @param options - Optional settings
-   * @param options.includeLookupRelations - If true, fetches related object types for lookup fields (requires additional API call)
+   * @param options.includeLookupRelations - Fetches related object types for lookup fields (default: true)
    * @param options.signal - Optional AbortSignal for cancellation
    * @returns List of fields with metadata
    *
    * @example
    * ```typescript
+   * // Lookup relations are included by default
    * const result = await client.metadata.getFields('1');
-   * console.log(result.fields); // [{ fieldName: 'accountid', label: 'Account ID', ... }, ...]
-   *
-   * // With lookup relations
-   * const result = await client.metadata.getFields('1', { includeLookupRelations: true });
    * console.log(result.fields.find(f => f.fieldName === 'primarycontactid')?.relatedObjectType); // 2
+   *
+   * // Disable lookup relations for faster response
+   * const result = await client.metadata.getFields('1', { includeLookupRelations: false });
    * ```
    */
   async getFields(objectType, options) {
     const objectTypeStr = String(objectType);
-    const opts = options instanceof AbortSignal ? { signal: options, includeLookupRelations: false } : { signal: options?.signal, includeLookupRelations: options?.includeLookupRelations };
-    if (!opts.includeLookupRelations) {
-      const cached = this.client.getCached("fields", objectTypeStr);
-      if (cached) {
+    const opts = options instanceof AbortSignal ? { signal: options, includeLookupRelations: true } : { signal: options?.signal, includeLookupRelations: options?.includeLookupRelations ?? true };
+    const cached = this.client.getCached("fields", objectTypeStr);
+    if (cached) {
+      const cachedHasRelations = cached.fields.some((f) => f.relatedObjectType !== void 0);
+      if (!opts.includeLookupRelations || cachedHasRelations) {
         return cached;
       }
     }