@base44-preview/sdk 0.8.12-pr.63.3980328 → 0.8.12-pr.63.4708bce
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/dist/client.js +8 -1
- package/dist/client.types.d.ts +5 -0
- package/dist/modules/analytics.d.ts +2 -0
- package/dist/modules/analytics.js +40 -0
- package/dist/modules/entities.js +8 -13
- package/package.json +1 -1
package/dist/client.js
CHANGED
|
@@ -47,7 +47,11 @@ import { createAnalyticsModule } from "./modules/analytics.js";
|
|
|
47
47
|
* ```
|
|
48
48
|
*/
|
|
49
49
|
export function createClient(config) {
|
|
50
|
-
const { serverUrl = "https://base44.app", appId, token, serviceToken, requiresAuth = false, appBaseUrl, options, functionsVersion, headers: optionalHeaders, } = config;
|
|
50
|
+
const { serverUrl = "https://base44.app", appId, token, serviceToken, requiresAuth = false, appBaseUrl, options, functionsVersion, headers: optionalHeaders, useStagingDb: configUseStagingDb = false, } = config;
|
|
51
|
+
// URL param is source of truth for staging DB in browser
|
|
52
|
+
const urlHasStagingDb = typeof window !== "undefined"
|
|
53
|
+
&& new URLSearchParams(window.location.search).get("use_staging_db") === "true";
|
|
54
|
+
const useStagingDb = urlHasStagingDb || configUseStagingDb;
|
|
51
55
|
const socketConfig = {
|
|
52
56
|
serverUrl,
|
|
53
57
|
mountPath: "/ws-user-apps/socket.io/",
|
|
@@ -67,6 +71,7 @@ export function createClient(config) {
|
|
|
67
71
|
const headers = {
|
|
68
72
|
...optionalHeaders,
|
|
69
73
|
"X-App-Id": String(appId),
|
|
74
|
+
"Base44-Use-Staging-DB": String(useStagingDb),
|
|
70
75
|
};
|
|
71
76
|
const functionHeaders = functionsVersion
|
|
72
77
|
? {
|
|
@@ -299,6 +304,7 @@ export function createClientFromRequest(request) {
|
|
|
299
304
|
const appId = request.headers.get("Base44-App-Id");
|
|
300
305
|
const serverUrlHeader = request.headers.get("Base44-Api-Url");
|
|
301
306
|
const functionsVersion = request.headers.get("Base44-Functions-Version");
|
|
307
|
+
const useStagingDb = request.headers.get("Base44-Use-Staging-DB") === "true";
|
|
302
308
|
const stateHeader = request.headers.get("Base44-State");
|
|
303
309
|
if (!appId) {
|
|
304
310
|
throw new Error("Base44-App-Id header is required, but is was not found on the request");
|
|
@@ -333,6 +339,7 @@ export function createClientFromRequest(request) {
|
|
|
333
339
|
token: userToken,
|
|
334
340
|
serviceToken: serviceRoleToken,
|
|
335
341
|
functionsVersion: functionsVersion !== null && functionsVersion !== void 0 ? functionsVersion : undefined,
|
|
342
|
+
useStagingDb: useStagingDb !== null && useStagingDb !== void 0 ? useStagingDb : undefined,
|
|
336
343
|
headers: additionalHeaders,
|
|
337
344
|
});
|
|
338
345
|
}
|
package/dist/client.types.d.ts
CHANGED
|
@@ -60,6 +60,11 @@ export interface CreateClientConfig {
|
|
|
60
60
|
* @internal
|
|
61
61
|
*/
|
|
62
62
|
headers?: Record<string, string>;
|
|
63
|
+
/**
|
|
64
|
+
* Whether to use the staging database. Defaults to false.
|
|
65
|
+
* When true, API requests will use the staging database instead of production.
|
|
66
|
+
*/
|
|
67
|
+
useStagingDb?: boolean;
|
|
63
68
|
/**
|
|
64
69
|
* Additional client options.
|
|
65
70
|
*/
|
|
@@ -2,6 +2,8 @@ import { AxiosInstance } from "axios";
|
|
|
2
2
|
import { TrackEventParams, AnalyticsModuleOptions } from "./analytics.types";
|
|
3
3
|
import type { AuthModule } from "./auth.types";
|
|
4
4
|
export declare const USER_HEARTBEAT_EVENT_NAME = "__user_heartbeat_event__";
|
|
5
|
+
export declare const ANALYTICS_INITIALIZATION_EVENT_NAME = "__initialization_event__";
|
|
6
|
+
export declare const ANALYTICS_SESSION_DURATION_EVENT_NAME = "__session_duration_event__";
|
|
5
7
|
export declare const ANALYTICS_CONFIG_ENABLE_URL_PARAM_KEY = "analytics-enable";
|
|
6
8
|
export declare const ANALYTICS_SESSION_ID_LOCAL_STORAGE_KEY = "base44_analytics_session_id";
|
|
7
9
|
export interface AnalyticsModuleArgs {
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { getSharedInstance } from "../utils/sharedInstance.js";
|
|
2
2
|
import { generateUuid } from "../utils/common.js";
|
|
3
3
|
export const USER_HEARTBEAT_EVENT_NAME = "__user_heartbeat_event__";
|
|
4
|
+
export const ANALYTICS_INITIALIZATION_EVENT_NAME = "__initialization_event__";
|
|
5
|
+
export const ANALYTICS_SESSION_DURATION_EVENT_NAME = "__session_duration_event__";
|
|
4
6
|
export const ANALYTICS_CONFIG_ENABLE_URL_PARAM_KEY = "analytics-enable";
|
|
5
7
|
export const ANALYTICS_SESSION_ID_LOCAL_STORAGE_KEY = "base44_analytics_session_id";
|
|
6
8
|
const defaultConfiguration = {
|
|
@@ -20,7 +22,9 @@ const analyticsSharedState = getSharedInstance(ANALYTICS_SHARED_STATE_NAME, () =
|
|
|
20
22
|
requestsQueue: [],
|
|
21
23
|
isProcessing: false,
|
|
22
24
|
isHeartBeatProcessing: false,
|
|
25
|
+
wasInitializationTracked: false,
|
|
23
26
|
sessionContext: null,
|
|
27
|
+
sessionStartTime: null,
|
|
24
28
|
config: {
|
|
25
29
|
...defaultConfiguration,
|
|
26
30
|
...getAnalyticsConfigFromUrlParams(),
|
|
@@ -95,10 +99,12 @@ export const createAnalyticsModule = ({ axiosClient, serverUrl, appId, userAuthM
|
|
|
95
99
|
batchSize,
|
|
96
100
|
});
|
|
97
101
|
clearHeartBeatProcessor = startHeartBeatProcessor(track);
|
|
102
|
+
setSessionDurationTimerStart();
|
|
98
103
|
};
|
|
99
104
|
const onDocHidden = () => {
|
|
100
105
|
stopAnalyticsProcessor();
|
|
101
106
|
clearHeartBeatProcessor === null || clearHeartBeatProcessor === void 0 ? void 0 : clearHeartBeatProcessor();
|
|
107
|
+
trackSessionDurationEvent(track);
|
|
102
108
|
// flush entire queue on visibility change and hope for the best //
|
|
103
109
|
const eventsData = analyticsSharedState.requestsQueue.splice(0);
|
|
104
110
|
flush(eventsData, { isBeacon: true });
|
|
@@ -124,6 +130,8 @@ export const createAnalyticsModule = ({ axiosClient, serverUrl, appId, userAuthM
|
|
|
124
130
|
startProcessing();
|
|
125
131
|
// start the heart beat processor //
|
|
126
132
|
clearHeartBeatProcessor = startHeartBeatProcessor(track);
|
|
133
|
+
// track the referrer event //
|
|
134
|
+
trackInitializationEvent(track);
|
|
127
135
|
// start the visibility change listener //
|
|
128
136
|
if (typeof window !== "undefined") {
|
|
129
137
|
window.addEventListener("visibilitychange", onVisibilityChange);
|
|
@@ -166,6 +174,38 @@ function startHeartBeatProcessor(track) {
|
|
|
166
174
|
analyticsSharedState.isHeartBeatProcessing = false;
|
|
167
175
|
};
|
|
168
176
|
}
|
|
177
|
+
function trackInitializationEvent(track) {
|
|
178
|
+
if (typeof window === "undefined" ||
|
|
179
|
+
analyticsSharedState.wasInitializationTracked) {
|
|
180
|
+
return;
|
|
181
|
+
}
|
|
182
|
+
analyticsSharedState.wasInitializationTracked = true;
|
|
183
|
+
track({
|
|
184
|
+
eventName: ANALYTICS_INITIALIZATION_EVENT_NAME,
|
|
185
|
+
properties: {
|
|
186
|
+
referrer: document === null || document === void 0 ? void 0 : document.referrer,
|
|
187
|
+
},
|
|
188
|
+
});
|
|
189
|
+
}
|
|
190
|
+
function setSessionDurationTimerStart() {
|
|
191
|
+
if (typeof window === "undefined" ||
|
|
192
|
+
analyticsSharedState.sessionStartTime !== null) {
|
|
193
|
+
return;
|
|
194
|
+
}
|
|
195
|
+
analyticsSharedState.sessionStartTime = new Date().toISOString();
|
|
196
|
+
}
|
|
197
|
+
function trackSessionDurationEvent(track) {
|
|
198
|
+
if (typeof window === "undefined" ||
|
|
199
|
+
analyticsSharedState.sessionStartTime === null)
|
|
200
|
+
return;
|
|
201
|
+
const sessionDuration = new Date().getTime() -
|
|
202
|
+
new Date(analyticsSharedState.sessionStartTime).getTime();
|
|
203
|
+
analyticsSharedState.sessionStartTime = null;
|
|
204
|
+
track({
|
|
205
|
+
eventName: ANALYTICS_SESSION_DURATION_EVENT_NAME,
|
|
206
|
+
properties: { sessionDuration },
|
|
207
|
+
});
|
|
208
|
+
}
|
|
169
209
|
function getEventIntrinsicData() {
|
|
170
210
|
return {
|
|
171
211
|
timestamp: new Date().toISOString(),
|
package/dist/modules/entities.js
CHANGED
|
@@ -32,10 +32,6 @@ export function createEntitiesModule(axios, appId) {
|
|
|
32
32
|
*/
|
|
33
33
|
function createEntityHandler(axios, appId, entityName) {
|
|
34
34
|
const baseURL = `/apps/${appId}/entities/${entityName}`;
|
|
35
|
-
const isDevMode = typeof window !== "undefined"
|
|
36
|
-
? new URLSearchParams(window.location.search).get("use_staging_db") === "true"
|
|
37
|
-
: false;
|
|
38
|
-
const headers = { "X-Use-Staging-DB": String(isDevMode) };
|
|
39
35
|
return {
|
|
40
36
|
// List entities with optional pagination and sorting
|
|
41
37
|
async list(sort, limit, skip, fields) {
|
|
@@ -48,7 +44,7 @@ function createEntityHandler(axios, appId, entityName) {
|
|
|
48
44
|
params.skip = skip;
|
|
49
45
|
if (fields)
|
|
50
46
|
params.fields = Array.isArray(fields) ? fields.join(",") : fields;
|
|
51
|
-
return axios.get(baseURL, { params
|
|
47
|
+
return axios.get(baseURL, { params });
|
|
52
48
|
},
|
|
53
49
|
// Filter entities based on query
|
|
54
50
|
async filter(query, sort, limit, skip, fields) {
|
|
@@ -63,31 +59,31 @@ function createEntityHandler(axios, appId, entityName) {
|
|
|
63
59
|
params.skip = skip;
|
|
64
60
|
if (fields)
|
|
65
61
|
params.fields = Array.isArray(fields) ? fields.join(",") : fields;
|
|
66
|
-
return axios.get(baseURL, { params
|
|
62
|
+
return axios.get(baseURL, { params });
|
|
67
63
|
},
|
|
68
64
|
// Get entity by ID
|
|
69
65
|
async get(id) {
|
|
70
|
-
return axios.get(`${baseURL}/${id}
|
|
66
|
+
return axios.get(`${baseURL}/${id}`);
|
|
71
67
|
},
|
|
72
68
|
// Create new entity
|
|
73
69
|
async create(data) {
|
|
74
|
-
return axios.post(baseURL, data
|
|
70
|
+
return axios.post(baseURL, data);
|
|
75
71
|
},
|
|
76
72
|
// Update entity by ID
|
|
77
73
|
async update(id, data) {
|
|
78
|
-
return axios.put(`${baseURL}/${id}`, data
|
|
74
|
+
return axios.put(`${baseURL}/${id}`, data);
|
|
79
75
|
},
|
|
80
76
|
// Delete entity by ID
|
|
81
77
|
async delete(id) {
|
|
82
|
-
return axios.delete(`${baseURL}/${id}
|
|
78
|
+
return axios.delete(`${baseURL}/${id}`);
|
|
83
79
|
},
|
|
84
80
|
// Delete multiple entities based on query
|
|
85
81
|
async deleteMany(query) {
|
|
86
|
-
return axios.delete(baseURL, { data: query
|
|
82
|
+
return axios.delete(baseURL, { data: query });
|
|
87
83
|
},
|
|
88
84
|
// Create multiple entities in a single request
|
|
89
85
|
async bulkCreate(data) {
|
|
90
|
-
return axios.post(`${baseURL}/bulk`, data
|
|
86
|
+
return axios.post(`${baseURL}/bulk`, data);
|
|
91
87
|
},
|
|
92
88
|
// Import entities from a file
|
|
93
89
|
async importEntities(file) {
|
|
@@ -95,7 +91,6 @@ function createEntityHandler(axios, appId, entityName) {
|
|
|
95
91
|
formData.append("file", file, file.name);
|
|
96
92
|
return axios.post(`${baseURL}/import`, formData, {
|
|
97
93
|
headers: {
|
|
98
|
-
...headers,
|
|
99
94
|
"Content-Type": "multipart/form-data",
|
|
100
95
|
},
|
|
101
96
|
});
|