@base44-preview/sdk 0.8.13-pr.58.bc6cdc5 → 0.8.13-pr.63.6dc705a

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 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, } = config;
51
+ // Config takes precedence, fallback to URL query param in browser
52
+ const urlHasStagingDb = typeof window !== "undefined"
53
+ && new URLSearchParams(window.location.search).get("use_staging_db") === "true";
54
+ const useStagingDb = configUseStagingDb !== null && configUseStagingDb !== void 0 ? configUseStagingDb : urlHasStagingDb;
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
  ? {
@@ -104,11 +109,7 @@ export function createClient(config) {
104
109
  serverUrl,
105
110
  });
106
111
  const userModules = {
107
- entities: createEntitiesModule({
108
- axios: axiosClient,
109
- appId,
110
- getSocket,
111
- }),
112
+ entities: createEntitiesModule(axiosClient, appId),
112
113
  integrations: createIntegrationsModule(axiosClient, appId),
113
114
  auth: userAuthModule,
114
115
  functions: createFunctionsModule(functionsAxiosClient, appId),
@@ -135,11 +136,7 @@ export function createClient(config) {
135
136
  },
136
137
  };
137
138
  const serviceRoleModules = {
138
- entities: createEntitiesModule({
139
- axios: serviceRoleAxiosClient,
140
- appId,
141
- getSocket,
142
- }),
139
+ entities: createEntitiesModule(serviceRoleAxiosClient, appId),
143
140
  integrations: createIntegrationsModule(serviceRoleAxiosClient, appId),
144
141
  sso: createSsoModule(serviceRoleAxiosClient, appId, token),
145
142
  connectors: createConnectorsModule(serviceRoleAxiosClient, appId),
@@ -307,6 +304,7 @@ export function createClientFromRequest(request) {
307
304
  const appId = request.headers.get("Base44-App-Id");
308
305
  const serverUrlHeader = request.headers.get("Base44-Api-Url");
309
306
  const functionsVersion = request.headers.get("Base44-Functions-Version");
307
+ const useStagingDb = request.headers.get("Base44-Use-Staging-DB") === "true";
310
308
  const stateHeader = request.headers.get("Base44-State");
311
309
  if (!appId) {
312
310
  throw new Error("Base44-App-Id header is required, but is was not found on the request");
@@ -341,6 +339,7 @@ export function createClientFromRequest(request) {
341
339
  token: userToken,
342
340
  serviceToken: serviceRoleToken,
343
341
  functionsVersion: functionsVersion !== null && functionsVersion !== void 0 ? functionsVersion : undefined,
342
+ useStagingDb: useStagingDb !== null && useStagingDb !== void 0 ? useStagingDb : undefined,
344
343
  headers: additionalHeaders,
345
344
  });
346
345
  }
@@ -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
  */
package/dist/index.d.ts CHANGED
@@ -4,7 +4,7 @@ import { getAccessToken, saveAccessToken, removeAccessToken, getLoginUrl } from
4
4
  export { createClient, createClientFromRequest, Base44Error, getAccessToken, saveAccessToken, removeAccessToken, getLoginUrl, };
5
5
  export type { Base44Client, CreateClientConfig, CreateClientOptions, Base44ErrorJSON, };
6
6
  export * from "./types.js";
7
- export type { EntitiesModule, EntityHandler, RealtimeEventType, RealtimeEvent, RealtimeCallback, Subscription, } from "./modules/entities.types.js";
7
+ export type { EntitiesModule, EntityHandler, } from "./modules/entities.types.js";
8
8
  export type { AuthModule, LoginResponse, RegisterParams, VerifyOtpParams, ChangePasswordParams, ResetPasswordParams, User, } from "./modules/auth.types.js";
9
9
  export type { IntegrationsModule, IntegrationPackage, IntegrationEndpointFunction, CoreIntegrations, InvokeLLMParams, GenerateImageParams, GenerateImageResult, UploadFileParams, UploadFileResult, SendEmailParams, SendEmailResult, ExtractDataFromUploadedFileParams, ExtractDataFromUploadedFileResult, UploadPrivateFileParams, UploadPrivateFileResult, CreateFileSignedUrlParams, CreateFileSignedUrlResult, } from "./modules/integrations.types.js";
10
10
  export type { FunctionsModule } from "./modules/functions.types.js";
@@ -1,23 +1,5 @@
1
1
  import { AxiosInstance } from "axios";
2
2
  import { EntitiesModule } from "./entities.types";
3
- import { RoomsSocket } from "../utils/socket-utils";
4
- /**
5
- * Configuration for the entities module.
6
- * @internal
7
- */
8
- export interface EntitiesModuleConfig {
9
- axios: AxiosInstance;
10
- appId: string;
11
- getSocket: () => ReturnType<typeof RoomsSocket>;
12
- }
13
- /**
14
- * Creates the entities module for the Base44 SDK.
15
- *
16
- * @param config - Configuration object containing axios, appId, and getSocket
17
- * @returns Entities module with dynamic entity access
18
- * @internal
19
- */
20
- export declare function createEntitiesModule(config: EntitiesModuleConfig): EntitiesModule;
21
3
  /**
22
4
  * Creates the entities module for the Base44 SDK.
23
5
  *
@@ -25,6 +7,5 @@ export declare function createEntitiesModule(config: EntitiesModuleConfig): Enti
25
7
  * @param appId - Application ID
26
8
  * @returns Entities module with dynamic entity access
27
9
  * @internal
28
- * @deprecated Use the config object overload instead
29
10
  */
30
11
  export declare function createEntitiesModule(axios: AxiosInstance, appId: string): EntitiesModule;
@@ -1,15 +1,12 @@
1
- export function createEntitiesModule(configOrAxios, appIdArg) {
2
- // Handle both old and new signatures for backwards compatibility
3
- const config = "axios" in configOrAxios
4
- ? configOrAxios
5
- : {
6
- axios: configOrAxios,
7
- appId: appIdArg,
8
- getSocket: () => {
9
- throw new Error("Realtime subscriptions are not available. Please update your client configuration.");
10
- },
11
- };
12
- const { axios, appId, getSocket } = config;
1
+ /**
2
+ * Creates the entities module for the Base44 SDK.
3
+ *
4
+ * @param axios - Axios instance
5
+ * @param appId - Application ID
6
+ * @returns Entities module with dynamic entity access
7
+ * @internal
8
+ */
9
+ export function createEntitiesModule(axios, appId) {
13
10
  // Using Proxy to dynamically handle entity names
14
11
  return new Proxy({}, {
15
12
  get(target, entityName) {
@@ -20,40 +17,20 @@ export function createEntitiesModule(configOrAxios, appIdArg) {
20
17
  return undefined;
21
18
  }
22
19
  // Create entity handler
23
- return createEntityHandler(axios, appId, entityName, getSocket);
20
+ return createEntityHandler(axios, appId, entityName);
24
21
  },
25
22
  });
26
23
  }
27
- /**
28
- * Parses the realtime message data and extracts event information.
29
- * @internal
30
- */
31
- function parseRealtimeMessage(dataStr) {
32
- var _a;
33
- try {
34
- const parsed = JSON.parse(dataStr);
35
- return {
36
- type: parsed.type,
37
- data: parsed.data,
38
- id: parsed.id || ((_a = parsed.data) === null || _a === void 0 ? void 0 : _a.id),
39
- timestamp: parsed.timestamp || new Date().toISOString(),
40
- };
41
- }
42
- catch (_b) {
43
- return null;
44
- }
45
- }
46
24
  /**
47
25
  * Creates a handler for a specific entity.
48
26
  *
49
27
  * @param axios - Axios instance
50
28
  * @param appId - Application ID
51
29
  * @param entityName - Entity name
52
- * @param getSocket - Function to get the socket instance
53
30
  * @returns Entity handler with CRUD methods
54
31
  * @internal
55
32
  */
56
- function createEntityHandler(axios, appId, entityName, getSocket) {
33
+ function createEntityHandler(axios, appId, entityName) {
57
34
  const baseURL = `/apps/${appId}/entities/${entityName}`;
58
35
  return {
59
36
  // List entities with optional pagination and sorting
@@ -118,21 +95,5 @@ function createEntityHandler(axios, appId, entityName, getSocket) {
118
95
  },
119
96
  });
120
97
  },
121
- // Subscribe to realtime updates
122
- subscribe(callback) {
123
- const room = `entities:${appId}:${entityName}`;
124
- // Get the socket and subscribe to the room
125
- const socket = getSocket();
126
- const unsubscribe = socket.subscribeToRoom(room, {
127
- update_model: (msg) => {
128
- const event = parseRealtimeMessage(msg.data);
129
- if (!event) {
130
- return;
131
- }
132
- callback(event);
133
- },
134
- });
135
- return unsubscribe;
136
- },
137
98
  };
138
99
  }
@@ -1,28 +1,3 @@
1
- /**
2
- * Event types for realtime entity updates.
3
- */
4
- export type RealtimeEventType = "create" | "update" | "delete";
5
- /**
6
- * Payload received when a realtime event occurs.
7
- */
8
- export interface RealtimeEvent<T = Record<string, any>> {
9
- /** The type of change that occurred */
10
- type: RealtimeEventType;
11
- /** The entity data (new/updated for create/update, previous for delete) */
12
- data: T;
13
- /** The unique identifier of the affected entity */
14
- id: string;
15
- /** ISO 8601 timestamp of when the event occurred */
16
- timestamp: string;
17
- }
18
- /**
19
- * Callback function invoked when a realtime event occurs.
20
- */
21
- export type RealtimeCallback<T = Record<string, any>> = (event: RealtimeEvent<T>) => void;
22
- /**
23
- * Function returned from subscribe, call it to unsubscribe.
24
- */
25
- export type Subscription = () => void;
26
1
  /**
27
2
  * Entity handler providing CRUD operations for a specific entity type.
28
3
  *
@@ -267,26 +242,6 @@ export interface EntityHandler {
267
242
  * ```
268
243
  */
269
244
  importEntities(file: File): Promise<any>;
270
- /**
271
- * Subscribes to realtime updates for all records of this entity type.
272
- *
273
- * Receives notifications whenever any record is created, updated, or deleted.
274
- *
275
- * @param callback - Function called when an entity changes.
276
- * @returns Unsubscribe function to stop listening.
277
- *
278
- * @example
279
- * ```typescript
280
- * // Subscribe to all Task changes
281
- * const unsubscribe = base44.entities.Task.subscribe((event) => {
282
- * console.log(`Task ${event.id} was ${event.type}d:`, event.data);
283
- * });
284
- *
285
- * // Later, unsubscribe
286
- * unsubscribe();
287
- * ```
288
- */
289
- subscribe(callback: RealtimeCallback): Subscription;
290
245
  }
291
246
  /**
292
247
  * Entities module for managing app data.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@base44-preview/sdk",
3
- "version": "0.8.13-pr.58.bc6cdc5",
3
+ "version": "0.8.13-pr.63.6dc705a",
4
4
  "description": "JavaScript SDK for Base44 API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",