@base44-preview/sdk 0.8.5-pr.52.f01053f → 0.8.6-pr.48.d625f02

package/dist/utils/axios-client.js

@@ -1,7 +1,37 @@
 import axios from "axios";
 import { isInIFrame } from "./common.js";
 import { v4 as uuidv4 } from "uuid";
+/**
+ * Custom error class for Base44 SDK errors.
+ *
+ * This error is thrown when API requests fail. It extends the standard `Error` class and includes additional information about the HTTP status, error code, and response data from the server.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await client.entities.Todo.get('invalid-id');
+ * } catch (error) {
+ *   if (error instanceof Base44Error) {
+ *     console.error('Status:', error.status);      // 404
+ *     console.error('Message:', error.message);    // "Not found"
+ *     console.error('Code:', error.code);          // "NOT_FOUND"
+ *     console.error('Data:', error.data);          // Full response data
+ *   }
+ * }
+ * ```
+ *
+ */
 export class Base44Error extends Error {
+    /**
+     * Creates a new Base44Error instance.
+     *
+     * @param message - Human-readable error message
+     * @param status - HTTP status code
+     * @param code - Error code from the API
+     * @param data - Full response data from the server
+     * @param originalError - Original axios error object
+     * @internal
+     */
     constructor(message, status, code, data, originalError) {
         super(message);
         this.name = "Base44Error";
@@ -10,7 +40,33 @@ export class Base44Error extends Error {
         this.data = data;
         this.originalError = originalError;
     }
-    // Add a method to safely serialize this error without circular references
+    /**
+     * Serializes the error to a JSON-safe object.
+     *
+     * Useful for logging or sending error information to external services
+     * without circular reference issues.
+     *
+     * @returns JSON-safe representation of the error.
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   await client.entities.Todo.get('invalid-id');
+     * } catch (error) {
+     *   if (error instanceof Base44Error) {
+     *     const json = error.toJSON();
+     *     console.log(json);
+     *     // {
+     *     //   name: "Base44Error",
+     *     //   message: "Not found",
+     *     //   status: 404,
+     *     //   code: "NOT_FOUND",
+     *     //   data: { ... }
+     *     // }
+     *   }
+     * }
+     * ```
+     */
     toJSON() {
         return {
             name: this.name,
@@ -22,9 +78,11 @@ export class Base44Error extends Error {
     }
 }
 /**
- * Safely logs error information without circular references
- * @param {string} prefix - Prefix for the log message
- * @param {Error} error - The error to log
+ * Safely logs error information without circular references.
+ *
+ * @param prefix - Prefix for the log message
+ * @param error - The error to log
+ * @internal
  */
 function safeErrorLog(prefix, error) {
     if (error instanceof Base44Error) {
@@ -43,15 +101,18 @@ function safeErrorLog(prefix, error) {
     }
 }
 /**
- * Creates an axios client with default configuration and interceptors
- * @param {Object} options - Client configuration options
- * @param {string} options.baseURL - Base URL for all requests
- * @param {Object} options.headers - Additional headers
- * @param {string} options.token - Auth token
- * @param {boolean} options.requiresAuth - Whether the application requires authentication
- * @param {string|number} options.appId - Application ID (needed for login redirect)
- * @param {string} options.serverUrl - Server URL (needed for login redirect)
- * @returns {import('axios').AxiosInstance} Configured axios instance
+ * Creates an axios client with default configuration and interceptors.
+ *
+ * Sets up an axios instance with:
+ * - Default headers
+ * - Authentication token injection
+ * - Response data unwrapping
+ * - Error transformation to Base44Error
+ * - iframe messaging support
+ *
+ * @param options - Client configuration options
+ * @returns Configured axios instance
+ * @internal
  */
 export function createAxiosClient({ baseURL, headers = {}, token, interceptResponses = true, onError, }) {
     const client = axios.create({

package/dist/utils/axios-client.types.d.ts

@@ -0,0 +1,28 @@
+/**
+ * JSON representation of a Base44Error.
+ *
+ * This is the structure returned by {@linkcode Base44Error.toJSON | Base44Error.toJSON()}.
+ * Useful for logging or sending error information to external services.
+ */
+export interface Base44ErrorJSON {
+    /**
+     * The error name, always "Base44Error".
+     */
+    name: string;
+    /**
+     * Human-readable error message.
+     */
+    message: string;
+    /**
+     * HTTP status code of the error.
+     */
+    status: number;
+    /**
+     * Error code from the API.
+     */
+    code: string;
+    /**
+     * Full response data from the server containing error details.
+     */
+    data: any;
+}

package/dist/utils/axios-client.types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/common.d.ts

@@ -1,3 +1,2 @@
 export declare const isNode: boolean;
-export declare const isBrowser: boolean;
 export declare const isInIFrame: boolean;

package/dist/utils/common.js

@@ -1,3 +1,2 @@
 export const isNode = typeof window === "undefined";
-export const isBrowser = !isNode;
-export const isInIFrame = isBrowser && window.self !== window.top;
+export const isInIFrame = !isNode && window.self !== window.top;

package/dist/utils/socket-utils.d.ts

@@ -1,11 +1,11 @@
 import { Socket } from "socket.io-client";
-export type RoomsSocketConfig = {
+export interface RoomsSocketConfig {
     serverUrl: string;
     mountPath: string;
     transports: string[];
     appId: string;
     token?: string;
-};
+}
 export type TSocketRoom = string;
 export type TJsonStr = string;
 type RoomsSocketEventsMap = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.5-pr.52.f01053f",
+  "version": "0.8.6-pr.48.d625f02",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,7 +16,12 @@
     "test:e2e": "vitest run tests/e2e",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",
-    "prepublishOnly": "npm run build"
+    "docs": "typedoc",
+    "prepublishOnly": "npm run build",
+    "create-docs": "npm run create-docs:generate && npm run create-docs:process",
+    "push-docs": "node scripts/mintlify-post-processing/push-to-docs-repo.js",
+    "create-docs:generate": "typedoc",
+    "create-docs:process": "node scripts/mintlify-post-processing/file-processing/file-processing.js"
   },
   "dependencies": {
     "axios": "^1.6.2",
@@ -24,15 +29,19 @@
     "uuid": "^13.0.0"
   },
   "devDependencies": {
+    "@types/hast": "^3.0.4",
     "@types/node": "^25.0.1",
+    "@types/unist": "^3.0.3",
     "@vitest/coverage-istanbul": "^1.0.0",
     "@vitest/coverage-v8": "^1.0.0",
     "@vitest/ui": "^1.0.0",
     "dotenv": "^16.3.1",
     "eslint": "^8.54.0",
     "nock": "^13.4.0",
+    "typedoc": "^0.28.14",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "^5.3.2",
-    "vitest": "^1.0.0"
+    "vitest": "^1.6.1"
   },
   "keywords": [
     "base44",

package/dist/utils/app-params.d.ts

@@ -1,13 +0,0 @@
-export declare const appParams: {
-    appId?: undefined;
-    serverUrl?: undefined;
-    token?: undefined;
-    fromUrl?: undefined;
-    functionsVersion?: undefined;
-} | {
-    appId: any;
-    serverUrl: any;
-    token: any;
-    fromUrl: any;
-    functionsVersion: any;
-};

package/dist/utils/app-params.js

@@ -1,44 +0,0 @@
-import { isBrowser } from './common';
-const toSnakeCase = (str) => {
-    return str.replace(/([A-Z])/g, '_$1').toLowerCase();
-};
-const getAppParamValue = (paramName, { defaultValue = undefined, removeFromUrl = false } = {}) => {
-    const storageKey = `base44_${toSnakeCase(paramName)}`;
-    const urlParams = new URLSearchParams(window.location.search);
-    const searchParam = urlParams.get(paramName);
-    if (removeFromUrl) {
-        urlParams.delete(paramName);
-        const newUrl = `${window.location.pathname}${urlParams.toString() ? `?${urlParams.toString()}` : ""}${window.location.hash}`;
-        window.history.replaceState({}, document.title, newUrl);
-    }
-    if (searchParam) {
-        localStorage.setItem(storageKey, searchParam);
-        return searchParam;
-    }
-    if (defaultValue) {
-        localStorage.setItem(storageKey, defaultValue);
-        return defaultValue;
-    }
-    const storedValue = localStorage.getItem(storageKey);
-    if (storedValue) {
-        return storedValue;
-    }
-    return null;
-};
-const getAppParams = () => {
-    if (!isBrowser) {
-        return {};
-    }
-    if (getAppParamValue("clear_access_token") === 'true') {
-        localStorage.removeItem('base44_access_token');
-        localStorage.removeItem('token');
-    }
-    return {
-        appId: getAppParamValue("app_id", { defaultValue: import.meta.env.VITE_BASE44_APP_ID }),
-        serverUrl: getAppParamValue("server_url", { defaultValue: import.meta.env.VITE_BASE44_BACKEND_URL }),
-        token: getAppParamValue("access_token", { removeFromUrl: true }),
-        fromUrl: getAppParamValue("from_url", { defaultValue: window.location.href }),
-        functionsVersion: getAppParamValue("functions_version", { defaultValue: import.meta.env.VITE_BASE44_FUNCTIONS_VERSION }),
-    };
-};
-export const appParams = getAppParams();