fireberry-api-client 1.0.2-beta.1.0 → 1.0.2-beta.1.2
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.
- package/README.md +97 -10
- package/dist/{excludedFields-CuQ8Dp-N.d.cts → excludedFields-Dk-ILROQ.d.cts} +95 -1
- package/dist/{excludedFields-CuQ8Dp-N.d.ts → excludedFields-Dk-ILROQ.d.ts} +95 -1
- package/dist/index.cjs +721 -294
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +720 -295
- package/dist/index.js.map +1 -1
- package/dist/{relatedFieldMapping-Plja-OuE.d.ts → relatedFieldMapping-6o0SKPT2.d.ts} +311 -118
- package/dist/{relatedFieldMapping-jprv6Lhg.d.cts → relatedFieldMapping-uUVpIJk9.d.cts} +311 -118
- package/dist/sdk/index.d.cts +3 -96
- package/dist/sdk/index.d.ts +3 -96
- package/dist/utils/index.d.cts +3 -3
- package/dist/utils/index.d.ts +3 -3
- package/package.json +1 -1
package/dist/sdk/index.d.ts
CHANGED
|
@@ -1,100 +1,7 @@
|
|
|
1
|
-
|
|
1
|
+
import { i as FireberrySDKAPI, S as SDKQueryPayload, j as SDKResponseData, F as FireberrySDKClient, k as SDKContext } from '../excludedFields-Dk-ILROQ.js';
|
|
2
|
+
export { C as ConditionBuilder, E as EXCLUDED_FIELDS_FOR_STAR_QUERY, l as FIELD_TYPE_IDS, m as FIELD_TYPE_MAPPINGS, O as OBJECT_ID_MAP, n as OBJECT_NAME_MAP, Q as QueryBuilder, e as escapeQueryValue, x as getExcludedFieldsForStarQuery, p as getNameFieldByObjectType, o as getObjectIdFieldName, s as sanitizeQuery } from '../excludedFields-Dk-ILROQ.js';
|
|
2
3
|
export { g as getLabelFieldForField, i as isDropdownField, b as isDropdownOrLookupField, a as isLookupField } from '../fieldTypes-BLzJTzpI.js';
|
|
3
4
|
|
|
4
|
-
/**
|
|
5
|
-
* Type definitions for @fireberry/sdk compatibility
|
|
6
|
-
* These types mirror the Fireberry SDK's API for seamless integration
|
|
7
|
-
*/
|
|
8
|
-
/**
|
|
9
|
-
* Query payload expected by the Fireberry SDK
|
|
10
|
-
*/
|
|
11
|
-
interface SDKQueryPayload {
|
|
12
|
-
/** Comma-separated field names to return */
|
|
13
|
-
fields: string;
|
|
14
|
-
/** Query filter string */
|
|
15
|
-
query: string;
|
|
16
|
-
/** Number of records per page */
|
|
17
|
-
page_size?: number;
|
|
18
|
-
/** Page number (1-based) */
|
|
19
|
-
page_number?: number;
|
|
20
|
-
}
|
|
21
|
-
/**
|
|
22
|
-
* Response error from SDK
|
|
23
|
-
*/
|
|
24
|
-
interface SDKResponseError {
|
|
25
|
-
data: Record<string, unknown> & {
|
|
26
|
-
Message?: string;
|
|
27
|
-
};
|
|
28
|
-
status: number;
|
|
29
|
-
statusText: string;
|
|
30
|
-
}
|
|
31
|
-
/**
|
|
32
|
-
* Response data from SDK operations
|
|
33
|
-
*/
|
|
34
|
-
interface SDKResponseData<T = Record<string, unknown>> {
|
|
35
|
-
type?: string;
|
|
36
|
-
success: boolean;
|
|
37
|
-
data: T & {
|
|
38
|
-
requestId?: string;
|
|
39
|
-
};
|
|
40
|
-
error?: SDKResponseError;
|
|
41
|
-
isParentReady: boolean;
|
|
42
|
-
requestId: string;
|
|
43
|
-
}
|
|
44
|
-
/**
|
|
45
|
-
* Record details from SDK context
|
|
46
|
-
*/
|
|
47
|
-
interface SDKRecordDetails {
|
|
48
|
-
type?: number;
|
|
49
|
-
id?: string;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* User details from SDK context
|
|
53
|
-
*/
|
|
54
|
-
interface SDKUserDetails {
|
|
55
|
-
fullName?: string;
|
|
56
|
-
id?: string;
|
|
57
|
-
}
|
|
58
|
-
/**
|
|
59
|
-
* SDK context information
|
|
60
|
-
*/
|
|
61
|
-
interface SDKContext {
|
|
62
|
-
user: SDKUserDetails;
|
|
63
|
-
record: SDKRecordDetails;
|
|
64
|
-
}
|
|
65
|
-
/**
|
|
66
|
-
* Generic payload type for create/update operations
|
|
67
|
-
*/
|
|
68
|
-
type SDKPayload = Record<string, unknown>;
|
|
69
|
-
/**
|
|
70
|
-
* Fireberry SDK API interface
|
|
71
|
-
* Matches the API surface of @fireberry/sdk
|
|
72
|
-
*/
|
|
73
|
-
interface FireberrySDKAPI<TData = Record<string, unknown>> {
|
|
74
|
-
/** Query records with filtering and pagination */
|
|
75
|
-
query: (objectType: string | number, payload: SDKQueryPayload) => Promise<SDKResponseData<TData>>;
|
|
76
|
-
/** Create a new record */
|
|
77
|
-
create: <T extends SDKPayload>(objectType: string | number, payload: T) => Promise<SDKResponseData<TData>>;
|
|
78
|
-
/** Delete a record by ID */
|
|
79
|
-
delete: (objectType: string | number, recordId: string) => Promise<SDKResponseData<TData>>;
|
|
80
|
-
/** Update an existing record */
|
|
81
|
-
update: <T extends SDKPayload>(objectType: string | number, recordId: string, payload: T) => Promise<SDKResponseData<TData>>;
|
|
82
|
-
}
|
|
83
|
-
/**
|
|
84
|
-
* Fireberry SDK Client interface
|
|
85
|
-
* Matches the structure of FireberryClientSDK from @fireberry/sdk
|
|
86
|
-
*/
|
|
87
|
-
interface FireberrySDKClient<TData = Record<string, unknown>> {
|
|
88
|
-
/** Access to CRUD API methods */
|
|
89
|
-
readonly api: FireberrySDKAPI<TData>;
|
|
90
|
-
/** Current context (record and user info) - null if not initialized */
|
|
91
|
-
readonly context: SDKContext | null;
|
|
92
|
-
/** Initialize context from parent Fireberry window */
|
|
93
|
-
initializeContext(): Promise<FireberrySDKClient<TData>>;
|
|
94
|
-
/** Clean up event listeners and pending requests */
|
|
95
|
-
destroy(): void;
|
|
96
|
-
}
|
|
97
|
-
|
|
98
5
|
/**
|
|
99
6
|
* SDK Adapter for @fireberry/sdk
|
|
100
7
|
*
|
|
@@ -369,4 +276,4 @@ declare class EnhancedSDK<TData = Record<string, unknown>> {
|
|
|
369
276
|
destroy(): void;
|
|
370
277
|
}
|
|
371
278
|
|
|
372
|
-
export { EnhancedSDK,
|
|
279
|
+
export { EnhancedSDK, FireberrySDKAPI, FireberrySDKClient, SDKContext, SDKQueryBuilder, SDKQueryPayload, SDKResponseData, createSDKQueryBuilder };
|
package/dist/utils/index.d.cts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { C as ConditionBuilder, D as DateConditionBuilder, E as EXCLUDED_FIELDS_FOR_STAR_QUERY,
|
|
2
|
-
import { F as FireberryClient } from '../relatedFieldMapping-
|
|
3
|
-
export { d as FieldMetadataMap, I as ID_FIELD_TO_OBJECT_TYPE, b as RelatedFieldInfo, c as RelatedFieldResolution, R as RelatedFieldResolver, e as expandRelatedFields,
|
|
1
|
+
export { C as ConditionBuilder, D as DateConditionBuilder, E as EXCLUDED_FIELDS_FOR_STAR_QUERY, l as FIELD_TYPE_IDS, m as FIELD_TYPE_MAPPINGS, O as OBJECT_ID_MAP, n as OBJECT_NAME_MAP, Q as QueryBuilder, r as addDays, e as escapeQueryValue, x as getExcludedFieldsForStarQuery, p as getNameFieldByObjectType, o as getObjectIdFieldName, v as getStartOfMonth, u as getStartOfWeek, t as getToday, w as isExcludedFromStarQuery, q as isPureDate, s as sanitizeQuery } from '../excludedFields-Dk-ILROQ.cjs';
|
|
2
|
+
import { F as FireberryClient } from '../relatedFieldMapping-uUVpIJk9.cjs';
|
|
3
|
+
export { d as FieldMetadataMap, I as ID_FIELD_TO_OBJECT_TYPE, b as RelatedFieldInfo, c as RelatedFieldResolution, R as RelatedFieldResolver, e as expandRelatedFields, a2 as getCodeFieldFromLabel, a3 as getLabelFieldFromCode, a as getObjectTypeFromReferenceField, g as getRelatedFieldInfo, a1 as isCodeField, a4 as isDropdownFieldByMetadata, p as parseRelatedField, r as resolveRelatedField } from '../relatedFieldMapping-uUVpIJk9.cjs';
|
|
4
4
|
export { f as getFieldTypeName, g as getLabelFieldForField, e as isDateField, i as isDropdownField, b as isDropdownOrLookupField, a as isLookupField, d as isNumericField, c as isTextField } from '../fieldTypes-BLzJTzpI.cjs';
|
|
5
5
|
|
|
6
6
|
/**
|
package/dist/utils/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { C as ConditionBuilder, D as DateConditionBuilder, E as EXCLUDED_FIELDS_FOR_STAR_QUERY,
|
|
2
|
-
import { F as FireberryClient } from '../relatedFieldMapping-
|
|
3
|
-
export { d as FieldMetadataMap, I as ID_FIELD_TO_OBJECT_TYPE, b as RelatedFieldInfo, c as RelatedFieldResolution, R as RelatedFieldResolver, e as expandRelatedFields,
|
|
1
|
+
export { C as ConditionBuilder, D as DateConditionBuilder, E as EXCLUDED_FIELDS_FOR_STAR_QUERY, l as FIELD_TYPE_IDS, m as FIELD_TYPE_MAPPINGS, O as OBJECT_ID_MAP, n as OBJECT_NAME_MAP, Q as QueryBuilder, r as addDays, e as escapeQueryValue, x as getExcludedFieldsForStarQuery, p as getNameFieldByObjectType, o as getObjectIdFieldName, v as getStartOfMonth, u as getStartOfWeek, t as getToday, w as isExcludedFromStarQuery, q as isPureDate, s as sanitizeQuery } from '../excludedFields-Dk-ILROQ.js';
|
|
2
|
+
import { F as FireberryClient } from '../relatedFieldMapping-6o0SKPT2.js';
|
|
3
|
+
export { d as FieldMetadataMap, I as ID_FIELD_TO_OBJECT_TYPE, b as RelatedFieldInfo, c as RelatedFieldResolution, R as RelatedFieldResolver, e as expandRelatedFields, a2 as getCodeFieldFromLabel, a3 as getLabelFieldFromCode, a as getObjectTypeFromReferenceField, g as getRelatedFieldInfo, a1 as isCodeField, a4 as isDropdownFieldByMetadata, p as parseRelatedField, r as resolveRelatedField } from '../relatedFieldMapping-6o0SKPT2.js';
|
|
4
4
|
export { f as getFieldTypeName, g as getLabelFieldForField, e as isDateField, i as isDropdownField, b as isDropdownOrLookupField, a as isLookupField, d as isNumericField, c as isTextField } from '../fieldTypes-BLzJTzpI.js';
|
|
5
5
|
|
|
6
6
|
/**
|