@base44-preview/sdk 0.8.12-pr.68.4468d62 → 0.8.12-pr.70.fb3fcc2

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.
@@ -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(),
@@ -11,9 +11,7 @@ export interface ConnectorAccessTokenResponse {
11
11
  /**
12
12
  * Connectors module for managing OAuth tokens for external services.
13
13
  *
14
- * This module allows you to retrieve OAuth access tokens for external services
15
- * that the app has connected to. Use these tokens to make API
16
- * calls to external services.
14
+ * This module allows you to retrieve OAuth access tokens for external services that the app has connected to. Connectors are app-scoped. When an app builder connects an integration like Google Calendar or Slack, all users of the app share that same connection.
17
15
  *
18
16
  * Unlike the integrations module that provides pre-built functions, connectors give you
19
17
  * raw OAuth tokens so you can call external service APIs directly with full control over
@@ -26,9 +24,9 @@ export interface ConnectorsModule {
26
24
  /**
27
25
  * Retrieves an OAuth access token for a specific external integration type.
28
26
  *
29
- * Returns the OAuth token string for an external service that the app
30
- * has connected to. You can then use this token to make authenticated API calls
31
- * to that external service.
27
+ * Returns the OAuth token string for an external service that an app builder
28
+ * has connected to. This token represents the connected app builder's account
29
+ * and can be used to make authenticated API calls to that external service on behalf of the app.
32
30
  *
33
31
  * @param integrationType - The type of integration, such as `'googlecalendar'`, `'slack'`, or `'github'`.
34
32
  * @returns Promise resolving to the access token string.
@@ -3,20 +3,23 @@
3
3
  */
4
4
  export interface CustomIntegrationCallParams {
5
5
  /**
6
- * Request body payload to send to the external API.
6
+ * Request body to send to the external API. The payload is JSON-serialized before being sent.
7
7
  */
8
8
  payload?: Record<string, any>;
9
9
  /**
10
- * Path parameters to substitute in the URL (e.g., `{ owner: "user", repo: "repo" }`).
10
+ * Path parameters to substitute into the URL template.
11
+ * For example, if the API endpoint is `/repos/{owner}/{repo}/issues`,
12
+ * pass `{ owner: "myorg", repo: "myrepo" }`.
11
13
  */
12
14
  pathParams?: Record<string, string>;
13
15
  /**
14
16
  * Query string parameters to append to the URL.
17
+ * For example, `{ state: "open", per_page: 50 }` becomes `?state=open&per_page=50`.
15
18
  */
16
19
  queryParams?: Record<string, any>;
17
20
  /**
18
- * Additional headers to send with this specific request.
19
- * These are merged with the integration's configured headers.
21
+ * Additional HTTP headers to include in the request.
22
+ * These headers are merged with any headers configured for the integration itself, with headers specified here taking precedence in case of conflicts.
20
23
  */
21
24
  headers?: Record<string, string>;
22
25
  }
@@ -33,66 +36,25 @@ export interface CustomIntegrationCallResponse {
33
36
  */
34
37
  status_code: number;
35
38
  /**
36
- * The response data from the external API.
37
- * Can be any JSON-serializable value depending on the external API's response.
39
+ * The parsed JSON response body from the external API.
40
+ * The structure depends on the API endpoint being called.
38
41
  */
39
42
  data: any;
40
43
  }
41
44
  /**
42
- * Module for calling custom workspace-level API integrations.
43
- *
44
- * Custom integrations allow workspace administrators to connect any external API
45
- * by importing an OpenAPI specification. Apps in the workspace can then call
46
- * these integrations using this module.
47
- *
48
- * Unlike the built-in integrations (like `Core`), custom integrations:
49
- * - Are defined per-workspace by importing OpenAPI specs
50
- * - Use a slug-based identifier instead of package names
51
- * - Proxy requests through Base44's backend (credentials never exposed to frontend)
52
- *
53
- * @example
54
- * ```typescript
55
- * // Call a custom GitHub integration
56
- * const response = await base44.integrations.custom.call(
57
- * "github", // integration slug (defined by workspace admin)
58
- * "listIssues", // operation ID from the OpenAPI spec
59
- * {
60
- * pathParams: { owner: "myorg", repo: "myrepo" },
61
- * queryParams: { state: "open", per_page: 100 }
62
- * }
63
- * );
64
- *
65
- * if (response.success) {
66
- * console.log("Issues:", response.data);
67
- * } else {
68
- * console.error("API returned error:", response.status_code);
69
- * }
70
- * ```
71
- *
72
- * @example
73
- * ```typescript
74
- * // Call with request body payload
75
- * const response = await base44.integrations.custom.call(
76
- * "github",
77
- * "createIssue",
78
- * {
79
- * pathParams: { owner: "myorg", repo: "myrepo" },
80
- * payload: {
81
- * title: "Bug report",
82
- * body: "Something is broken",
83
- * labels: ["bug"]
84
- * }
85
- * }
86
- * );
87
- * ```
45
+ * Custom integrations module for calling workspace-level API integrations.
88
46
  */
89
47
  export interface CustomIntegrationsModule {
90
48
  /**
91
49
  * Call a custom integration endpoint.
92
50
  *
93
- * @param slug - The integration's unique identifier (slug), as defined by the workspace admin.
94
- * @param operationId - The operation ID from the OpenAPI spec (e.g., "listIssues", "getUser").
95
- * @param params - Optional parameters including payload, pathParams, queryParams, and headers.
51
+ * Custom integrations are external APIs that have been pre-configured by a workspace administrator who imports an OpenAPI specification. Each integration is identified by a slug and exposes operations defined in the specification.
52
+ *
53
+ * Requests are proxied through Base44's backend, so API credentials aren't exposed. That means you can safely use this method to call external APIs from frontend code.
54
+ *
55
+ * @param slug - The integration's unique identifier, as defined by the workspace admin.
56
+ * @param operationId - The operation ID from the OpenAPI specification, such as `"listIssues"` or `"getUser"`.
57
+ * @param params - Optional parameters to send to the external API.
96
58
  * @returns Promise resolving to the integration call response.
97
59
  *
98
60
  * @throws {Error} If slug is not provided.
@@ -100,6 +62,38 @@ export interface CustomIntegrationsModule {
100
62
  * @throws {Base44Error} If the integration or operation is not found (404).
101
63
  * @throws {Base44Error} If the external API call fails (502).
102
64
  * @throws {Base44Error} If the request times out (504).
65
+ *
66
+ * @example
67
+ * ```typescript
68
+ * // GET request with path and query parameters
69
+ * const response = await base44.integrations.custom.call(
70
+ * "github",
71
+ * "listRepoIssues",
72
+ * {
73
+ * pathParams: { owner: "myorg", repo: "myrepo" },
74
+ * queryParams: { state: "open", per_page: 50 }
75
+ * }
76
+ * );
77
+ *
78
+ * if (response.success) {
79
+ * console.log("Found issues:", response.data.length);
80
+ * }
81
+ * ```
82
+ *
83
+ * @example
84
+ * ```typescript
85
+ * // POST request with a JSON body
86
+ * const response = await base44.integrations.custom.call(
87
+ * "slack",
88
+ * "postMessage",
89
+ * {
90
+ * payload: {
91
+ * channel: "#general",
92
+ * text: "Hello from Base44!"
93
+ * }
94
+ * }
95
+ * );
96
+ * ```
103
97
  */
104
98
  call(slug: string, operationId: string, params?: CustomIntegrationCallParams): Promise<CustomIntegrationCallResponse>;
105
99
  }
@@ -320,22 +320,28 @@ export interface CoreIntegrations {
320
320
  CreateFileSignedUrl(params: CreateFileSignedUrlParams): Promise<CreateFileSignedUrlResult>;
321
321
  }
322
322
  /**
323
- * Integrations module for calling integration endpoints.
323
+ * Integrations module for calling integration methods.
324
324
  *
325
- * This module provides access to integration endpoints for interacting with external
326
- * services. Integrations are organized into packages. Base44 provides built-in integrations
327
- * in the `Core` package.
325
+ * This module provides access to integration methods for interacting with external services. Unlike the connectors module that gives you raw OAuth tokens, integrations provide pre-built functions that Base44 executes on your behalf.
328
326
  *
329
- * Unlike the connectors module that gives you raw OAuth tokens, integrations provide
330
- * pre-built functions that Base44 executes on your behalf.
327
+ * There are two types of integrations:
331
328
  *
332
- * Integration endpoints are accessed dynamically using the pattern:
333
- * `base44.integrations.PackageName.EndpointName(params)`
329
+ * - **Built-in integrations** (`Core`): Pre-built functions provided by Base44 for common tasks such as AI-powered text generation, image creation, file uploads, and email. Access core integration methods using:
330
+ * ```
331
+ * base44.integrations.Core.FunctionName(params)
332
+ * ```
333
+ *
334
+ * - **Custom integrations** (`custom`): Pre-configured external APIs. Custom integration calls are proxied through Base44's backend, so credentials are never exposed to the frontend. Access custom integration methods using:
335
+ * ```
336
+ * base44.integrations.custom.call(slug, operationId, params)
337
+ * ```
338
+ *
339
+ * <Info>To call a custom integration, it must be pre-configured by a workspace administrator who imports an OpenAPI specification.</Info>
334
340
  *
335
341
  * This module is available to use with a client in all authentication modes:
336
342
  *
337
- * - **Anonymous or User authentication** (`base44.integrations`): Integration endpoints are invoked with the current user's permissions. Anonymous users invoke endpoints without authentication, while authenticated users invoke endpoints with their authentication context.
338
- * - **Service role authentication** (`base44.asServiceRole.integrations`): Integration endpoints are invoked with elevated admin-level permissions. The endpoints execute with admin authentication context.
343
+ * - **Anonymous or User authentication** (`base44.integrations`): Integration methods are invoked with the current user's permissions. Anonymous users invoke methods without authentication, while authenticated users invoke methods with their authentication context.
344
+ * - **Service role authentication** (`base44.asServiceRole.integrations`): Integration methods are invoked with elevated admin-level permissions. The methods execute with admin authentication context.
339
345
  */
340
346
  export type IntegrationsModule = {
341
347
  /**
@@ -343,22 +349,7 @@ export type IntegrationsModule = {
343
349
  */
344
350
  Core: CoreIntegrations;
345
351
  /**
346
- * Custom integrations module for calling workspace-level API integrations.
347
- *
348
- * Allows calling external APIs that workspace admins have configured
349
- * by importing OpenAPI specifications.
350
- *
351
- * @example
352
- * ```typescript
353
- * const response = await base44.integrations.custom.call(
354
- * "github", // integration slug
355
- * "listIssues", // operation ID
356
- * {
357
- * pathParams: { owner: "myorg", repo: "myrepo" },
358
- * queryParams: { state: "open" }
359
- * }
360
- * );
361
- * ```
352
+ * Custom integrations module for calling pre-configured external APIs.
362
353
  */
363
354
  custom: CustomIntegrationsModule;
364
355
  } & {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@base44-preview/sdk",
3
- "version": "0.8.12-pr.68.4468d62",
3
+ "version": "0.8.12-pr.70.fb3fcc2",
4
4
  "description": "JavaScript SDK for Base44 API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -55,10 +55,10 @@
55
55
  "license": "MIT",
56
56
  "repository": {
57
57
  "type": "git",
58
- "url": "git+https://github.com/base44/sdk.git"
58
+ "url": "git+https://github.com/base44/javascript-sdk.git"
59
59
  },
60
60
  "bugs": {
61
- "url": "https://github.com/base44/sdk/issues"
61
+ "url": "https://github.com/base44/javascript-sdk/issues"
62
62
  },
63
- "homepage": "https://github.com/base44/sdk#readme"
63
+ "homepage": "https://github.com/base44/javascript-sdk#readme"
64
64
  }