@lokalise/node-api - npm Package Compare versions

Comparing version 7.1.0 to 7.1.1

dist/interfaces/paginated_result.d.ts

@@ -1,2 +0,2 @@
-export interface PaginatedResult {
+export interface PaginatedResult<T = any> {
     readonly totalResults: number;
@@ -6,3 +6,3 @@ readonly totalPages: number;
     readonly currentPage: number;
-    readonly items: any[];
+    readonly items: T[];
     hasNextPage(): boolean;
@@ -9,0 +9,0 @@ hasPrevPage(): boolean;

dist/interfaces/project.d.ts

@@ -0,1 +1,3 @@
+import { ProjectSettings } from "./project_settings";
+import { ProjectStatistics } from "./project_statistics";
 export interface Project {
@@ -13,4 +15,4 @@ project_id: string;
     base_language_iso: string;
-    settings: object;
-    statistics: object;
+    settings: ProjectSettings;
+    statistics: ProjectStatistics;
 }

dist/interfaces/standart_params.d.ts

 export interface StandartParams {
     page?: number;
     limit?: number;
+    project_id?: string;
     [paramName: string]: any;
 }

dist/models/project.d.ts

 import { Project as ProjectInterface } from "../interfaces/project";
+import { ProjectSettings } from "../interfaces/project_settings";
+import { ProjectStatistics } from "../interfaces/project_statistics";
 import { BaseModel } from "./base_model";
@@ -15,4 +17,4 @@ export declare class Project extends BaseModel implements ProjectInterface {
     base_language_iso: string;
-    settings: object;
-    statistics: object;
+    settings: ProjectSettings;
+    statistics: ProjectStatistics;
 }

docs/additional_info/changelog.md

 # Changelog
 
+## 7.1.1 (21-Feb-2022)
+
+* Updated certain types (thanks, @arelstone) 
+
 ## 7.1.0 (17-Dec-2021)
@@ -4,0 +8,0 @@

docs/api/files.md

@@ -54,5 +54,5 @@ # Translation files
 // You'll obtain `process_id` after calling `files.upload()`
-process = await lokaliseApi.queuedProcesses.get(process.process_id, { project_id: project_id })
+process = await lokaliseApi.queuedProcesses().get(process.process_id, { project_id: project_id })
 
 process.status // => 'finished'
 ```

index.d.ts

@@ -164,2 +164,48 @@ import { Options } from "got";
 
+  export interface ProjectStatistics {
+    progress_total: number;
+    keys_total: number;
+    team: number;
+    base_words: number;
+    qa_issues_total: number;
+    qa_issues: {
+      not_reviewed: number;
+      unverified: number;
+      spelling_grammar: number;
+      inconsistent_placeholders: number;
+      inconsistent_html: number;
+      different_number_of_urls: number;
+      different_urls: number;
+      leading_whitespace: number;
+      trailing_whitespace: number;
+      different_number_of_email_address: number;
+      different_email_address: number;
+      different_brackets: number;
+      different_numbers: number;
+      double_space: number;
+      special_placeholder: number;
+      unbalanced_brackets: number;
+    };
+    languages: Array<{
+      language_id: number;
+      language_iso: string;
+      progress: number;
+      words_to_do: number;
+    }>;
+  }
+
+  export interface ProjectSettings {
+    per_platform_key_names: boolean;
+    reviewing: boolean;
+    upvoting: boolean;
+    auto_toggle_unverified: boolean;
+    offline_translation: boolean;
+    key_editing: boolean;
+    inline_machine_translations: boolean;
+    branching: boolean;
+    segmentation: boolean;
+    custom_translation_statuses: boolean;
+    custom_translation_statuses_allow_multiple: boolean;
+  }
+
   export interface Project {
@@ -177,4 +223,4 @@ project_id: string;
     base_language_iso: string;
-    settings: object;
-    statistics: object;
+    settings: ProjectSettings;
+    statistics: ProjectStatistics;
   }
@@ -234,2 +280,3 @@
     limit?: number;
+    project_id?: string;
     [paramName: string]: any;
@@ -379,3 +426,3 @@ }
 
-  export interface PaginatedResult {
+  export interface PaginatedResult<T = any> {
     totalResults: number;
@@ -385,3 +432,3 @@ totalPages: number;
     currentPage: number;
-    items: any[];
+    items: T[];
     hasNextPage(): boolean;
@@ -761,3 +808,3 @@ hasPrevPage(): boolean;
 
-    constructor(params: Object);
+    constructor(params: { apiKey: string });
 
@@ -764,0 +811,0 @@ branches(): Branches;

package.json

 {
   "name": "@lokalise/node-api",
-  "version": "7.1.0",
+  "version": "7.1.1",
   "description": "Official Lokalise API 2.0 Node.js client",
@@ -31,4 +31,3 @@ "license": "BSD-3-Clause",
     "chai": "^4.2.0",
-    "codecov": "^3.8.2",
-    "dotenv": "^10.0.0",
+    "dotenv": "^16.0.0",
     "eslint": "^8.3.0",
@@ -35,0 +34,0 @@ "eslint-config-prettier": "^8.0.0",

README.md

 # Lokalise API v2 official Node.js client
 
 ![npm](https://img.shields.io/npm/v/@lokalise/node-api)
-[![Build Status](https://travis-ci.com/lokalise/node-lokalise-api.svg?branch=master)](https://travis-ci.com/github/lokalise/node-lokalise-api)
+![CI](https://github.com/lokalise/node-lokalise-api/actions/workflows/ci.yml/badge.svg)
 [![Test Coverage](https://codecov.io/gh/lokalise/node-lokalise-api/graph/badge.svg)](https://codecov.io/gh/lokalise/node-lokalise-api)
@@ -6,0 +6,0 @@ ![Downloads total](https://img.shields.io/npm/dt/@lokalise/node-api)

src/collections/segments.ts

@@ -0,0 +0,0 @@ import { Segment as SegmentModel } from "../models/segment";

src/http_client/base.ts

@@ -0,0 +0,0 @@ import { RequestError, Response, Options } from "got";

src/interfaces/paginated_result.ts

@@ -1,2 +0,2 @@
-export interface PaginatedResult {
+export interface PaginatedResult<T = any> {
   readonly totalResults: number;
@@ -6,3 +6,3 @@ readonly totalPages: number;
   readonly currentPage: number;
-  readonly items: any[];
+  readonly items: T[];
   hasNextPage(): boolean;
@@ -9,0 +9,0 @@ hasPrevPage(): boolean;

src/interfaces/project.ts

@@ -0,1 +1,4 @@
+import { ProjectSettings } from "./project_settings";
+import { ProjectStatistics } from "./project_statistics";
+
 export interface Project {
@@ -13,4 +16,4 @@ project_id: string;
   base_language_iso: string;
-  settings: object;
-  statistics: object;
+  settings: ProjectSettings;
+  statistics: ProjectStatistics;
 }

src/interfaces/segment.ts

@@ -0,0 +0,0 @@ export interface Segment {

src/interfaces/standart_params.ts

 export interface StandartParams {
   page?: number;
   limit?: number;
+  project_id?: string;
   [paramName: string]: any;
 }

src/lokalise/lokalise_api.ts

@@ -0,0 +0,0 @@ import { Branches } from "../collections/branches";

src/models/project.ts

 import { Project as ProjectInterface } from "../interfaces/project";
+import { ProjectSettings } from "../interfaces/project_settings";
+import { ProjectStatistics } from "../interfaces/project_statistics";
 import { BaseModel } from "./base_model";
@@ -16,4 +18,4 @@
   public base_language_iso: string;
-  public settings: object;
-  public statistics: object;
+  public settings: ProjectSettings;
+  public statistics: ProjectStatistics;
 }

src/models/segment.ts

@@ -0,0 +0,0 @@ import { BaseModel } from "./base_model";

test/segments/segments.spec.ts

@@ -0,0 +0,0 @@ require("../setup");

No alert changes

Improved metrics

Total package byte prevSize

1067425

increased by0.54%

Dev dependency count

21

decreased by-4.55%

Number of package files

581

increased by2.11%

Lines of code

7857

increased by2.52%

No dependency changes