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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,23 @@
1
+ /**
2
+ * Checks if a field is a label-only/display field that cannot be queried directly.
3
+ * Label fields are virtual fields derived from code/id fields (e.g., `actionstatus` from `actionstatuscode`).
4
+ * Fireberry returns them automatically when you query their code counterpart.
5
+ *
6
+ * @param fieldName - The field name to check
7
+ * @param allFieldNames - All field names for this object type (from metadata)
8
+ * @param objectType - The object type ID
9
+ * @returns True if the field is a label-only field that should not be included in queries
10
+ */
11
+ declare function isLabelOnlyField(fieldName: string, allFieldNames: string[], objectType: string | number): boolean;
12
+ /**
13
+ * Filters out label-only fields from a field list, returning only queryable fields.
14
+ * Use this before sending fields to the Fireberry query API.
15
+ *
16
+ * @param fieldNames - Array of field names to filter
17
+ * @param objectType - The object type ID
18
+ * @returns Array with label-only fields removed
19
+ */
20
+ declare function filterLabelOnlyFields(fieldNames: string[], objectType: string | number): string[];
1
21
  /**
2
22
  * Converts a field API name to its corresponding label field.
3
23
  *
@@ -64,4 +84,4 @@ declare function isDateField(systemFieldTypeId: string): boolean;
64
84
  */
65
85
  declare function getFieldTypeName(systemFieldTypeId: string): string;
66
86
 
67
- 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 };
87
+ 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 };
@@ -1,3 +1,23 @@
1
+ /**
2
+ * Checks if a field is a label-only/display field that cannot be queried directly.
3
+ * Label fields are virtual fields derived from code/id fields (e.g., `actionstatus` from `actionstatuscode`).
4
+ * Fireberry returns them automatically when you query their code counterpart.
5
+ *
6
+ * @param fieldName - The field name to check
7
+ * @param allFieldNames - All field names for this object type (from metadata)
8
+ * @param objectType - The object type ID
9
+ * @returns True if the field is a label-only field that should not be included in queries
10
+ */
11
+ declare function isLabelOnlyField(fieldName: string, allFieldNames: string[], objectType: string | number): boolean;
12
+ /**
13
+ * Filters out label-only fields from a field list, returning only queryable fields.
14
+ * Use this before sending fields to the Fireberry query API.
15
+ *
16
+ * @param fieldNames - Array of field names to filter
17
+ * @param objectType - The object type ID
18
+ * @returns Array with label-only fields removed
19
+ */
20
+ declare function filterLabelOnlyFields(fieldNames: string[], objectType: string | number): string[];
1
21
  /**
2
22
  * Converts a field API name to its corresponding label field.
3
23
  *
@@ -64,4 +84,4 @@ declare function isDateField(systemFieldTypeId: string): boolean;
64
84
  */
65
85
  declare function getFieldTypeName(systemFieldTypeId: string): string;
66
86
 
67
- 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 };
87
+ 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/index.cjs CHANGED
@@ -2881,6 +2881,10 @@ var FIELDS_WITHOUT_LABEL_FIELD = [
2881
2881
  // Object 7 - no name field exists
2882
2882
  ];
2883
2883
  var OBJECT_TYPE_OVERRIDES = {
2884
+ // Account (1) - uses *codename pattern for some fields
2885
+ 1: {
2886
+ excludedCodeFields: ["actionstatuscode", "businesstypecode"]
2887
+ },
2884
2888
  // CRM Orders (13) - uses *idname and *codename patterns
2885
2889
  13: {
2886
2890
  excludedIdFields: ["ownerid", "accountid", "printtemplateid", "pcfaccountid"],