v14.2.0

Author: bodrovis

dist/main.d.ts

@@ -11,6 +11,7 @@ interface PaginatedResult$1<T = any> {
     readonly resultsPerPage: number;
     readonly currentPage: number;
     readonly items: T[];
+    readonly responseTooBig: boolean;
     hasNextPage(): boolean;
     hasPrevPage(): boolean;
     isLastPage(): boolean;
@@ -243,6 +244,7 @@ declare class PaginatedResult<T> implements PaginatedResult$1 {
     totalPages: number;
     resultsPerPage: number;
     currentPage: number;
+    responseTooBig: boolean;
     items: T[];
     constructor(items: T[], headers: Headers);
     hasNextPage(): boolean;
@@ -436,8 +438,9 @@ declare abstract class BaseCollection<ElementType, SecondaryType = ElementType>
     /**
      * Return the raw JSON as-is.
      * @param json The raw JSON object or array returned by the API.
+     * @param _headers The response headers (if needed).
      */
-    protected returnBareJSON<T>(json: Keyable | Keyable[]): T;
+    protected returnBareJSON<T>(json: Keyable | Keyable[], _headers: Headers): T;
     /**
      * Convert a single object into an array if it's not already an array.
      * @param raw_body The raw request body.
@@ -466,6 +469,7 @@ declare abstract class BaseCollection<ElementType, SecondaryType = ElementType>
      * @throws Error if no URI or prefixURI is provided.
      */
     protected getUri(uri: string | null): string;
+    protected isResponseTooBig(headers: Headers): boolean;
     /**
      * Determine if the response headers indicate pagination.
      * @param headers The response headers.
@@ -658,6 +662,7 @@ type DownloadBundle = {
     project_id: string;
     bundle_url: string;
     branch?: string;
+    responseTooBig?: boolean;
 };
 type FileDeleted = {
     project_id: string;
@@ -750,6 +755,7 @@ declare class Files extends BaseCollection<File, QueuedProcess> {
     protected get rootElementName(): string;
     protected get secondaryElementClass(): new (json: Keyable) => QueuedProcess;
     protected get secondaryElementNameSingular(): string;
+    protected returnBareJSON<T>(json: Keyable | Keyable[], headers: Headers): T;
     list(request_params: ListFileParams): Promise<PaginatedResult$1<File>>;
     upload(project_id: string, upload: UploadFileParams): Promise<QueuedProcess>;
     download(project_id: string, download: DownloadFileParams): Promise<DownloadBundle>;

dist/main.js

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.0.1)
+    activesupport (8.0.2)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -27,7 +27,7 @@ GEM
     commonmarker (0.23.11)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.0)
-    csv (3.3.2)
+    csv (3.3.3)
     dnsruby (1.72.4)
       base64 (~> 0.2.0)
       logger (~> 1.6.5)
@@ -218,7 +218,7 @@ GEM
       gemoji (>= 3, < 5)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    json (2.10.1)
+    json (2.10.2)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -233,12 +233,12 @@ GEM
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.25.4)
+    minitest (5.25.5)
     net-http (0.6.0)
       uri
-    nokogiri (1.18.3-x64-mingw-ucrt)
+    nokogiri (1.18.5-x64-mingw-ucrt)
       racc (~> 1.4)
-    nokogiri (1.18.3-x86_64-linux-gnu)
+    nokogiri (1.18.5-x86_64-linux-gnu)
       racc (~> 1.4)
     octokit (4.25.1)
       faraday (>= 1, < 3)

dist/main.js.map

@@ -1,5 +1,21 @@
 # Changelog
 
+## 14.2.0 (20-Mar-2025)
+
+* Added `responseTooBig` attribute to paginated responses and file download responses. For example:
+
+```js
+const response = await lokaliseApi.files().download(projectId, params);
+
+response.responseTooBig; // false
+
+const keys = await lokaliseApi.keys().list({ project_id: projectId });
+
+keys.responseTooBig; // true
+```
+
+* This attribute is introduced to help users prepare for the upcoming changes to the API.
+
 ## 14.1.0 (11-Mar-2025)
 
 * Added `uuid` fields to contrbiturs and projects for internal purposes