feat: allow graphql for crowdin.com, add croql to listTmSegments

src/core/index.ts

@@ -77,7 +77,7 @@
  */
 export interface PatchRequest {
     /** Patch value */
     value?: any;
 
     /** Patch operation to perform */
     op: PatchOperation;
@@ -139,7 +139,7 @@
     }
 }
 
 function isAxiosError(error: any): error is AxiosError {
     return error instanceof AxiosError || !!error.response?.data;
 }
 
@@ -147,10 +147,10 @@
  * @internal
  */
 export function handleHttpClientError(error: HttpClientError): never {
     let crowdinResponseErrors: any = null;
 
     if (isAxiosError(error)) {
         crowdinResponseErrors = (error.response?.data as any)?.errors || (error.response?.data as any)?.error;
     } else if (error instanceof FetchClientJsonPayloadError) {
         crowdinResponseErrors =
             error.jsonPayload &&
@@ -163,13 +163,13 @@
     if (Array.isArray(crowdinResponseErrors)) {
         const validationCodes: { key: string; codes: string[] }[] = [];
         const validationMessages: string[] = [];
         crowdinResponseErrors.forEach((e: any) => {
             if (typeof e.index === 'number' || typeof e.error?.key === 'number') {
                 throw new CrowdinValidationError(JSON.stringify(crowdinResponseErrors, null, 2), []);
             }
             if (e.error?.key && Array.isArray(e.error?.errors)) {
                 const codes: string[] = [];
                 e.error.errors.forEach((er: any) => {
                     if (er.message && er.code) {
                         codes.push(er.code);
                         validationMessages.push(er.message);
@@ -253,16 +253,16 @@
         this.config = config;
     }
 
     graphql<T>(req: { query: string; operationName?: string; variables?: any }): Promise<ResponseObject<T>> {
-        if (!this.organization) {
-            throw new Error('GraphQL API could be used only with Crowdin Enterprise.');
+        let url;
+
+        if (this.organization) {
+            url = `https://${this.organization}.api.crowdin.com/api/graphql`;
+        } else {
+            url = 'https://api.crowdin.com/api/graphql';
         }
 
-        return this.post<ResponseObject<T>>(
-            `https://${this.organization}.api.crowdin.com/api/graphql`,
-            req,
-            this.defaultConfig(),
-        );
+        return this.post<ResponseObject<T>>(url, req, this.defaultConfig());
     }
 
     protected addQueryParam(url: string, name: string, value?: string | number): string {
@@ -314,7 +314,7 @@
         return this;
     }
 
     protected async getList<T = any>(
         url: string,
         limit?: number,
         offset?: number,

src/translationMemory/index.ts

@@ -95,8 +95,12 @@ export class TranslationMemory extends CrowdinApi {
      * @param options optional paramerers for the request
      * @see https://developer.crowdin.com/api/v2/#operation/api.tms.segments.getMany
      */
-    listTmSegments(tmId: number, options?: PaginationOptions): Promise<ResponseList<TranslationMemoryModel.TMSegment>> {
-        const url = `${this.url}/tms/${tmId}/segments`;
+    listTmSegments(
+        tmId: number,
+        options?: TranslationMemoryModel.ListSegmentsOptions,
+    ): Promise<ResponseList<TranslationMemoryModel.TMSegment>> {
+        let url = `${this.url}/tms/${tmId}/segments`;
+        url = this.addQueryParam(url, 'croql', options?.croql);
         return this.getList(url, options?.limit, options?.offset);
     }
 
@@ -358,6 +362,10 @@ export namespace TranslationMemoryModel {
         userId?: number;
     }
 
+    export interface ListSegmentsOptions extends PaginationOptions {
+        croql?: string;
+    }
+
     export interface TMSegment {
         id: number;
         records: TMSegmentRecord[];