@urbackend/sdk 0.4.0 → 0.4.2

package/dist/index.d.cts

@@ -537,8 +537,8 @@ declare class AuthModule {
      * Exchanges social authentication rtCode for a refresh token
      *
      * @param {SocialExchangePayload} payload - Social exchange data
+     * @param {string} payload.token - Access token fragment from social provider
      * @param {string} payload.rtCode - Return code from social provider
-     * @param {string} payload.provider - Social provider ('github' or 'google')
      * @returns {Promise<SocialExchangeResponse>} Promise resolving to authentication response
      *
      * @throws {AuthError} If rtCode is invalid or expired
@@ -546,13 +546,14 @@ declare class AuthModule {
      *
      * @example
      * // After user returns from social login
-     * const rtCode = new URLSearchParams(window.location.search).get('rtCode');
-     * if (rtCode) {
-     *   const response = await auth.socialExchange({
-     *     rtCode: rtCode,
-     *     provider: 'github'
-     *   });
-     *   console.log('Social login successful:', response.accessToken);
+     * const urlParams = new URLSearchParams(window.location.search);
+     * const hashParams = new URLSearchParams(window.location.hash.substring(1));
+     * const rtCode = urlParams.get('rtCode');
+     * const token = hashParams.get('token');
+     * if (rtCode && token) {
+     *   const response = await auth.socialExchange({ token, rtCode });
+     *   console.log('Refresh token exchange successful, proceeding to token refresh:', response.rtToken);
+     *   await auth.refreshToken();
      * }
      */
     socialExchange(payload: SocialExchangePayload): Promise<SocialExchangeResponse>;
@@ -670,6 +671,7 @@ declare class DatabaseModule {
      * @template T - The document type (extends DocumentData)
      * @param {string} collection - Name of the collection to query
      * @param {QueryParams} [params={}] - Optional query parameters for filtering, sorting, pagination
+     * @param {string} [token] - Optional authentication token (required for private-mode reads with publishable keys)
      * @returns {Promise<T[]>} Promise resolving to an array of documents (empty array if none found)
      *
      * @throws {Error} If collection name is invalid
@@ -696,12 +698,13 @@ declare class DatabaseModule {
      *   expand: ['profile']
      * });
      */
-    getAll<T extends DocumentData>(collection: string, params?: QueryParams): Promise<T[]>;
+    getAll<T extends DocumentData>(collection: string, params?: QueryParams, token?: string): Promise<T[]>;
     /**
      * Counts documents in a collection with optional filters
      *
      * @param {string} collection - Name of the collection to count
      * @param {Omit<QueryParams, 'count'>} [params={}] - Optional filter parameters
+     * @param {string} [token] - Optional authentication token (required for private-mode reads with publishable keys)
      * @returns {Promise<number>} Promise resolving to the total count of matching documents
      *
      * @throws {Error} If collection name is invalid
@@ -725,7 +728,7 @@ declare class DatabaseModule {
      * });
      * const totalPages = Math.ceil(total / 10);
      */
-    count(collection: string, params?: Omit<QueryParams, 'count'>): Promise<number>;
+    count(collection: string, params?: Omit<QueryParams, 'count'>, token?: string): Promise<number>;
     /**
      * Fetches a single document by its ID
      *
@@ -735,6 +738,7 @@ declare class DatabaseModule {
      * @param {Object} [options={}] - Optional parameters
      * @param {string|string[]} [options.populate] - Fields to populate with related data
      * @param {string|string[]} [options.expand] - Fields to expand with nested data
+     * @param {string} [token] - Optional authentication token (required for private-mode reads with publishable keys)
      * @returns {Promise<T>} Promise resolving to the document
      *
      * @throws {NotFoundError} If document with given ID does not exist
@@ -765,7 +769,7 @@ declare class DatabaseModule {
     getOne<T extends DocumentData>(collection: string, id: string, options?: {
         populate?: string | string[];
         expand?: string | string[];
-    }): Promise<T>;
+    }, token?: string): Promise<T>;
     /**
      * Inserts a new document into a collection
      *

package/dist/index.d.ts

@@ -537,8 +537,8 @@ declare class AuthModule {
      * Exchanges social authentication rtCode for a refresh token
      *
      * @param {SocialExchangePayload} payload - Social exchange data
+     * @param {string} payload.token - Access token fragment from social provider
      * @param {string} payload.rtCode - Return code from social provider
-     * @param {string} payload.provider - Social provider ('github' or 'google')
      * @returns {Promise<SocialExchangeResponse>} Promise resolving to authentication response
      *
      * @throws {AuthError} If rtCode is invalid or expired
@@ -546,13 +546,14 @@ declare class AuthModule {
      *
      * @example
      * // After user returns from social login
-     * const rtCode = new URLSearchParams(window.location.search).get('rtCode');
-     * if (rtCode) {
-     *   const response = await auth.socialExchange({
-     *     rtCode: rtCode,
-     *     provider: 'github'
-     *   });
-     *   console.log('Social login successful:', response.accessToken);
+     * const urlParams = new URLSearchParams(window.location.search);
+     * const hashParams = new URLSearchParams(window.location.hash.substring(1));
+     * const rtCode = urlParams.get('rtCode');
+     * const token = hashParams.get('token');
+     * if (rtCode && token) {
+     *   const response = await auth.socialExchange({ token, rtCode });
+     *   console.log('Refresh token exchange successful, proceeding to token refresh:', response.rtToken);
+     *   await auth.refreshToken();
      * }
      */
     socialExchange(payload: SocialExchangePayload): Promise<SocialExchangeResponse>;
@@ -670,6 +671,7 @@ declare class DatabaseModule {
      * @template T - The document type (extends DocumentData)
      * @param {string} collection - Name of the collection to query
      * @param {QueryParams} [params={}] - Optional query parameters for filtering, sorting, pagination
+     * @param {string} [token] - Optional authentication token (required for private-mode reads with publishable keys)
      * @returns {Promise<T[]>} Promise resolving to an array of documents (empty array if none found)
      *
      * @throws {Error} If collection name is invalid
@@ -696,12 +698,13 @@ declare class DatabaseModule {
      *   expand: ['profile']
      * });
      */
-    getAll<T extends DocumentData>(collection: string, params?: QueryParams): Promise<T[]>;
+    getAll<T extends DocumentData>(collection: string, params?: QueryParams, token?: string): Promise<T[]>;
     /**
      * Counts documents in a collection with optional filters
      *
      * @param {string} collection - Name of the collection to count
      * @param {Omit<QueryParams, 'count'>} [params={}] - Optional filter parameters
+     * @param {string} [token] - Optional authentication token (required for private-mode reads with publishable keys)
      * @returns {Promise<number>} Promise resolving to the total count of matching documents
      *
      * @throws {Error} If collection name is invalid
@@ -725,7 +728,7 @@ declare class DatabaseModule {
      * });
      * const totalPages = Math.ceil(total / 10);
      */
-    count(collection: string, params?: Omit<QueryParams, 'count'>): Promise<number>;
+    count(collection: string, params?: Omit<QueryParams, 'count'>, token?: string): Promise<number>;
     /**
      * Fetches a single document by its ID
      *
@@ -735,6 +738,7 @@ declare class DatabaseModule {
      * @param {Object} [options={}] - Optional parameters
      * @param {string|string[]} [options.populate] - Fields to populate with related data
      * @param {string|string[]} [options.expand] - Fields to expand with nested data
+     * @param {string} [token] - Optional authentication token (required for private-mode reads with publishable keys)
      * @returns {Promise<T>} Promise resolving to the document
      *
      * @throws {NotFoundError} If document with given ID does not exist
@@ -765,7 +769,7 @@ declare class DatabaseModule {
     getOne<T extends DocumentData>(collection: string, id: string, options?: {
         populate?: string | string[];
         expand?: string | string[];
-    }): Promise<T>;
+    }, token?: string): Promise<T>;
     /**
      * Inserts a new document into a collection
      *

package/dist/index.mjs

@@ -45,8 +45,34 @@ async function parseApiError(response) {
   let data;
   try {
     data = await response.json();
-    if (typeof data === "object" && data !== null && "message" in data) {
-      message = data.message || message;
+    if (typeof data === "object" && data !== null) {
+      const errData = data;
+      if ("error" in errData) {
+        let candidate = "";
+        if (typeof errData.error === "string") {
+          candidate = errData.error;
+        } else if (Array.isArray(errData.error) && errData.error.length > 0) {
+          candidate = errData.error.map((e) => {
+            if (typeof e === "object" && e !== null && "message" in e) {
+              return String(e.message);
+            }
+            return String(e);
+          }).join(", ");
+        } else {
+          candidate = JSON.stringify(errData.error);
+        }
+        if (candidate && candidate.trim().length > 0 && candidate !== "[]" && candidate !== "null") {
+          message = candidate;
+        } else if ("message" in errData) {
+          message = typeof errData.message === "string" ? errData.message : JSON.stringify(errData.message);
+        }
+      } else if ("message" in errData) {
+        if (typeof errData.message === "string") {
+          message = errData.message;
+        } else {
+          message = JSON.stringify(errData.message);
+        }
+      }
     }
   } catch {
     message = response.statusText || message;
@@ -499,8 +525,8 @@ var AuthModule = class {
    * Exchanges social authentication rtCode for a refresh token
    * 
    * @param {SocialExchangePayload} payload - Social exchange data
+   * @param {string} payload.token - Access token fragment from social provider
    * @param {string} payload.rtCode - Return code from social provider
-   * @param {string} payload.provider - Social provider ('github' or 'google')
    * @returns {Promise<SocialExchangeResponse>} Promise resolving to authentication response
    * 
    * @throws {AuthError} If rtCode is invalid or expired
@@ -508,13 +534,14 @@ var AuthModule = class {
    * 
    * @example
    * // After user returns from social login
-   * const rtCode = new URLSearchParams(window.location.search).get('rtCode');
-   * if (rtCode) {
-   *   const response = await auth.socialExchange({
-   *     rtCode: rtCode,
-   *     provider: 'github'
-   *   });
-   *   console.log('Social login successful:', response.accessToken);
+   * const urlParams = new URLSearchParams(window.location.search);
+   * const hashParams = new URLSearchParams(window.location.hash.substring(1));
+   * const rtCode = urlParams.get('rtCode');
+   * const token = hashParams.get('token');
+   * if (rtCode && token) {
+   *   const response = await auth.socialExchange({ token, rtCode });
+   *   console.log('Refresh token exchange successful, proceeding to token refresh:', response.rtToken);
+   *   await auth.refreshToken();
    * }
    */
   async socialExchange(payload) {
@@ -631,6 +658,7 @@ var DatabaseModule = class {
    * @template T - The document type (extends DocumentData)
    * @param {string} collection - Name of the collection to query
    * @param {QueryParams} [params={}] - Optional query parameters for filtering, sorting, pagination
+   * @param {string} [token] - Optional authentication token (required for private-mode reads with publishable keys)
    * @returns {Promise<T[]>} Promise resolving to an array of documents (empty array if none found)
    * 
    * @throws {Error} If collection name is invalid
@@ -657,11 +685,18 @@ var DatabaseModule = class {
    *   expand: ['profile']
    * });
    */
-  async getAll(collection, params = {}) {
+  async getAll(collection, params = {}, token) {
     const queryString = this.buildQueryString(params);
     const path = `/api/data/${collection}${queryString}`;
     try {
-      return await this.client.request("GET", path);
+      const result = await this.client.request("GET", path, { token });
+      if (Array.isArray(result)) {
+        return result;
+      }
+      if (result && typeof result === "object" && Array.isArray(result.items)) {
+        return result.items;
+      }
+      return [];
     } catch (e) {
       if (e instanceof NotFoundError) {
         return [];
@@ -674,6 +709,7 @@ var DatabaseModule = class {
    * 
    * @param {string} collection - Name of the collection to count
    * @param {Omit<QueryParams, 'count'>} [params={}] - Optional filter parameters
+   * @param {string} [token] - Optional authentication token (required for private-mode reads with publishable keys)
    * @returns {Promise<number>} Promise resolving to the total count of matching documents
    * 
    * @throws {Error} If collection name is invalid
@@ -697,10 +733,10 @@ var DatabaseModule = class {
    * });
    * const totalPages = Math.ceil(total / 10);
    */
-  async count(collection, params = {}) {
+  async count(collection, params = {}, token) {
     const queryString = this.buildQueryString({ ...params, count: "true" });
     const path = `/api/data/${collection}${queryString}`;
-    const result = await this.client.request("GET", path);
+    const result = await this.client.request("GET", path, { token });
     return result.count;
   }
   /**
@@ -712,6 +748,7 @@ var DatabaseModule = class {
    * @param {Object} [options={}] - Optional parameters
    * @param {string|string[]} [options.populate] - Fields to populate with related data
    * @param {string|string[]} [options.expand] - Fields to expand with nested data
+   * @param {string} [token] - Optional authentication token (required for private-mode reads with publishable keys)
    * @returns {Promise<T>} Promise resolving to the document
    * 
    * @throws {NotFoundError} If document with given ID does not exist
@@ -739,9 +776,9 @@ var DatabaseModule = class {
    *   }
    * }
    */
-  async getOne(collection, id, options = {}) {
+  async getOne(collection, id, options = {}, token) {
     const queryString = this.buildQueryString(options);
-    return this.client.request("GET", `/api/data/${collection}/${id}${queryString}`);
+    return this.client.request("GET", `/api/data/${collection}/${id}${queryString}`, { token });
   }
   /**
    * Inserts a new document into a collection
@@ -1015,17 +1052,43 @@ var StorageModule = class {
    * }
    */
   async upload(file, filename) {
-    const formData = new FormData();
-    if (typeof window === "undefined" && typeof Buffer !== "undefined" && Buffer.isBuffer(file)) {
-      const blob = new Blob([file]);
-      formData.append("file", blob, filename || "file");
+    let resolvedName = filename || "file";
+    let contentType = "application/octet-stream";
+    let fileSize;
+    let fileData;
+    if (typeof File !== "undefined" && file instanceof File) {
+      resolvedName = filename || file.name;
+      contentType = file.type || contentType;
+      fileSize = file.size;
+      fileData = file;
+    } else if (file instanceof Blob) {
+      contentType = file.type || contentType;
+      fileSize = file.size;
+      fileData = file;
+    } else if (typeof Buffer !== "undefined" && Buffer.isBuffer(file)) {
+      fileSize = file.length;
+      fileData = file;
     } else {
-      formData.append("file", file, filename);
+      throw new Error("Unsupported file type. Pass a File, Blob, or Buffer.");
     }
-    return this.client.request("POST", "/api/storage/upload", {
-      body: formData,
-      isMultipart: true
+    const { signedUrl, filePath } = await this.client.request(
+      "POST",
+      "/api/storage/upload-request",
+      { body: { filename: resolvedName, contentType, size: fileSize } }
+    );
+    const putResponse = await fetch(signedUrl, {
+      method: "PUT",
+      headers: { "Content-Type": contentType },
+      body: fileData
     });
+    if (!putResponse.ok) {
+      throw new Error(`Direct upload to cloud failed: ${putResponse.status} ${putResponse.statusText}`);
+    }
+    return this.client.request(
+      "POST",
+      "/api/storage/upload-confirm",
+      { body: { filePath, size: fileSize } }
+    );
   }
   /**
    * Deletes a file from storage by its path
@@ -1199,6 +1262,9 @@ var MailModule = class {
 // src/client.ts
 var UrBackendClient = class {
   constructor(config) {
+    if (!config.apiKey) {
+      throw new Error("urbackend-sdk: apiKey is required to initialize the client.");
+    }
     this.apiKey = config.apiKey;
     this.baseUrl = config.baseUrl || "https://api.ub.bitbros.in";
     this.headers = config.headers || {};
@@ -1251,7 +1317,7 @@ var UrBackendClient = class {
     const url = `${this.baseUrl}${path}`;
     const headers = {
       "x-api-key": this.apiKey,
-      "User-Agent": `urbackend-sdk-js/0.2.2`,
+      "User-Agent": `urbackend-sdk-js/0.4.2`,
       ...this.headers
     };
     if (options.token) {