fireberry-api-client 1.0.2-beta.2.3 → 1.0.2-beta.2.4

package/dist/{fieldTypes-BLzJTzpI.d.cts → fieldTypes-DZpAev83.d.cts}

@@ -1,3 +1,23 @@
+/**
+ * Checks if a field is a label-only/display field that cannot be queried directly.
+ * Label fields are virtual fields derived from code/id fields (e.g., `actionstatus` from `actionstatuscode`).
+ * Fireberry returns them automatically when you query their code counterpart.
+ *
+ * @param fieldName - The field name to check
+ * @param allFieldNames - All field names for this object type (from metadata)
+ * @param objectType - The object type ID
+ * @returns True if the field is a label-only field that should not be included in queries
+ */
+declare function isLabelOnlyField(fieldName: string, allFieldNames: string[], objectType: string | number): boolean;
+/**
+ * Filters out label-only fields from a field list, returning only queryable fields.
+ * Use this before sending fields to the Fireberry query API.
+ *
+ * @param fieldNames - Array of field names to filter
+ * @param objectType - The object type ID
+ * @returns Array with label-only fields removed
+ */
+declare function filterLabelOnlyFields(fieldNames: string[], objectType: string | number): string[];
 /**
  * Converts a field API name to its corresponding label field.
  *
@@ -64,4 +84,4 @@ declare function isDateField(systemFieldTypeId: string): boolean;
  */
 declare function getFieldTypeName(systemFieldTypeId: string): string;
 
-export { isLookupField as a, isDropdownOrLookupField as b, isTextField as c, isNumericField as d, isDateField as e, getFieldTypeName as f, getLabelFieldForField as g, isDropdownField as i };
+export { isDropdownField as a, isLookupField as b, isDropdownOrLookupField as c, isTextField as d, isNumericField as e, filterLabelOnlyFields as f, getLabelFieldForField as g, isDateField as h, isLabelOnlyField as i, getFieldTypeName as j };

package/dist/{fieldTypes-BLzJTzpI.d.ts → fieldTypes-DZpAev83.d.ts}

@@ -1,3 +1,23 @@
+/**
+ * Checks if a field is a label-only/display field that cannot be queried directly.
+ * Label fields are virtual fields derived from code/id fields (e.g., `actionstatus` from `actionstatuscode`).
+ * Fireberry returns them automatically when you query their code counterpart.
+ *
+ * @param fieldName - The field name to check
+ * @param allFieldNames - All field names for this object type (from metadata)
+ * @param objectType - The object type ID
+ * @returns True if the field is a label-only field that should not be included in queries
+ */
+declare function isLabelOnlyField(fieldName: string, allFieldNames: string[], objectType: string | number): boolean;
+/**
+ * Filters out label-only fields from a field list, returning only queryable fields.
+ * Use this before sending fields to the Fireberry query API.
+ *
+ * @param fieldNames - Array of field names to filter
+ * @param objectType - The object type ID
+ * @returns Array with label-only fields removed
+ */
+declare function filterLabelOnlyFields(fieldNames: string[], objectType: string | number): string[];
 /**
  * Converts a field API name to its corresponding label field.
  *
@@ -64,4 +84,4 @@ declare function isDateField(systemFieldTypeId: string): boolean;
  */
 declare function getFieldTypeName(systemFieldTypeId: string): string;
 
-export { isLookupField as a, isDropdownOrLookupField as b, isTextField as c, isNumericField as d, isDateField as e, getFieldTypeName as f, getLabelFieldForField as g, isDropdownField as i };
+export { isDropdownField as a, isLookupField as b, isDropdownOrLookupField as c, isTextField as d, isNumericField as e, filterLabelOnlyFields as f, getLabelFieldForField as g, isDateField as h, isLabelOnlyField as i, getFieldTypeName as j };