@crowdin/app-project-module 1.10.0 → 1.11.0

package/out/modules/api/components.d.ts

@@ -54,7 +54,6 @@
  *    IntegrationFiles:
  *      type: array
  *      description: 'List of integration files and folders'
- *      example: [{id: '1', name: 'Landing pages'}, {id: '73291251883', name: 'Intro', parentId: '1', type: 'json'}]
  *      items:
  *        anyOf:
  *          - type: object
@@ -69,6 +68,17 @@
  *              parentId:
  *                type: string
  *                description: 'Parent folder identifier'
+ *              path:
+ *                type: string
+ *                description: 'Full path to the folder'
+ *              createdAt:
+ *                type: string
+ *                format: date-time
+ *                description: 'Folder creation timestamp (ISO 8601)'
+ *              updatedAt:
+ *                type: string
+ *                format: date-time
+ *                description: 'Folder last update timestamp (ISO 8601)'
  *          - type: object
  *            description: 'File'
  *            properties:
@@ -84,18 +94,29 @@
  *              type:
  *                type: string
  *                description: 'File type (e.g., json, xml, html)'
+ *              path:
+ *                type: string
+ *                description: 'Full path to the file'
+ *              createdAt:
+ *                type: string
+ *                format: date-time
+ *                description: 'File creation timestamp (ISO 8601)'
+ *              updatedAt:
+ *                type: string
+ *                format: date-time
+ *                description: 'File last update timestamp (ISO 8601)'
  *              isNew:
  *                type: boolean
- *                description: 'Whether file is new (not synced before)'
+ *                description: 'Whether file is new (created after last sync)'
  *              isUpdated:
  *                type: boolean
  *                description: 'Whether file was updated since last sync'
  *              notSynced:
  *                type: boolean
- *                description: 'Whether file was never synced'
+ *                description: 'Whether file was never synced to Crowdin'
  *              synced:
  *                type: boolean
- *                description: 'Whether file is synced'
+ *                description: 'Whether file was previously synced to Crowdin'
  *    UpdateCrowdinFiles:
  *      title: 'Sync Files to Crowdin'
  *      required:
@@ -145,9 +166,19 @@
  *          example: '067da473-fc0b-43e3-b0a2-09d26af130c1'
  *    SettingsData:
  *      type: object
- *      example: {schedule: 0, condition: 0}
- *      additionalProperties:
- *        type: string
+ *      description: 'Application configuration settings. Fields depend on integration implementation.'
+ *      additionalProperties: true
+ *      example:
+ *        schedule: '3'
+ *        condition: '1'
+ *        new-crowdin-files: true
+ *        new-integration-files: false
+ *        inContext: false
+ *        importEqSuggestions: true
+ *        autoApproveImported: false
+ *        translateHidden: false
+ *        includeByFilePath: '/content/**'
+ *        excludeByFilePath: '/drafts/**'
  *    UpdateSettingsData:
  *      title: 'Update Application Settings'
  *      required:
@@ -162,33 +193,128 @@
  *          $ref: '#/components/schemas/SettingsData'
  *    SettingsResponse:
  *      $ref: '#/components/schemas/SettingsData'
+ *    SettingsSchemaResponse:
+ *      type: array
+ *      description: 'List of configuration fields with metadata'
+ *      items:
+ *        type: object
+ *        properties:
+ *          key:
+ *            type: string
+ *            description: 'Unique field identifier'
+ *            example: 'schedule'
+ *          label:
+ *            type: string
+ *            description: 'Human-readable field label'
+ *            example: 'Sync schedule'
+ *          labelHtml:
+ *            type: string
+ *            description: 'HTML label (alternative to label)'
+ *          type:
+ *            type: string
+ *            enum: [checkbox, text, select, textarea, notice, password, file]
+ *            description: 'Field input type'
+ *            example: 'select'
+ *          defaultValue:
+ *            type: string
+ *            description: 'Default value for the field'
+ *            example: '0'
+ *          helpText:
+ *            type: string
+ *            description: 'Plain text help description'
+ *          helpTextHtml:
+ *            type: string
+ *            description: 'HTML help description'
+ *          category:
+ *            type: string
+ *            description: 'Field category (general, sync, advanced)'
+ *            example: 'sync'
+ *          position:
+ *            type: integer
+ *            description: 'Display order within category'
+ *            example: 0
+ *          options:
+ *            type: array
+ *            description: 'Available options (for select type)'
+ *            items:
+ *              type: object
+ *              properties:
+ *                value:
+ *                  type: string
+ *                label:
+ *                  type: string
+ *          dependencySettings:
+ *            type: string
+ *            description: 'JSON string defining field visibility rules'
+ *          isSearchable:
+ *            type: boolean
+ *            description: 'Allow searching options (for select type)'
+ *          isMulti:
+ *            type: boolean
+ *            description: 'Allow multiple selection (for select type)'
+ *          noticeType:
+ *            type: string
+ *            enum: [info, warning, danger, success]
+ *            description: 'Notice type (for notice type fields)'
+ *          noIcon:
+ *            type: boolean
+ *            description: 'Hide icon in notice (for notice type)'
  *    CrowdinSyncSettingsResponse:
  *      type: object
- *      example:
- *        102: ['uk', 'de']
+ *      description: 'Mapping of Crowdin file IDs to target language codes for auto-sync'
  *      additionalProperties:
  *        type: array
+ *        description: 'Array of language codes to sync for this file'
  *        items:
  *          type: string
+ *          description: 'Language code (e.g., uk, de, fr)'
+ *      example:
+ *        '102': ['uk', 'de', 'fr']
+ *        '999': ['uk', 'es']
  *    IntegrationSyncSettingsResponse:
  *      type: array
+ *      description: 'List of integration files configured for auto-sync with their current status'
  *      items:
  *        type: object
+ *        required:
+ *          - id
+ *          - name
+ *          - node_type
  *        properties:
- *          name:
- *            type: string
  *          id:
  *            type: string
- *          parentId:
+ *            description: 'Unique file identifier'
+ *          name:
+ *            type: string
+ *            description: 'File name'
+ *          parent_id:
  *            type: string
+ *            description: 'Parent folder identifier'
  *          type:
  *            type: string
+ *            description: 'File type (e.g., html, json)'
  *          node_type:
  *            $ref: '#/components/schemas/NodeType'
  *          schedule:
  *            type: boolean
+ *            description: 'Whether auto-sync is enabled for this file'
+ *          sync:
+ *            type: boolean
+ *            description: 'Sync status flag'
+ *          isNew:
+ *            type: boolean
+ *            description: 'Whether file is new (created after last sync)'
+ *          isUpdated:
+ *            type: boolean
+ *            description: 'Whether file was updated since last sync'
+ *          notSynced:
+ *            type: boolean
+ *            description: 'Whether file was never synced to Crowdin'
+ *          synced:
+ *            type: boolean
+ *            description: 'Whether file was previously synced to Crowdin'
  *    UpdateSyncSettingsData:
- *      title: 'Update Application Sync Settings'
+ *      title: 'Update Auto-Sync Files Configuration'
  *      required:
  *        - projectId
  *        - provider
@@ -200,13 +326,15 @@
  *          example: 12
  *        provider:
  *          type: string
+ *          description: 'Sync direction: "crowdin" for Crowdin→Integration, "integration" for Integration→Crowdin'
  *          enum:
  *            - crowdin
  *            - integration
  *        files:
+ *          description: 'Format depends on provider. For "crowdin" - object with fileId→languages mapping. For "integration" - array of file objects.'
  *          oneOf:
- *            - { $ref: '#/components/schemas/CrowdinSyncSettingsResponse' }
- *            - { $ref: '#/components/schemas/IntegrationSyncSettingsResponse' }
+ *            - $ref: '#/components/schemas/CrowdinSyncSettingsResponse'
+ *            - $ref: '#/components/schemas/IntegrationSyncSettingsResponse'
  *    FileProgress:
  *      title: 'Language Translation Progress'
  *      description: 'Language Translation File Progress Response Model'
@@ -218,6 +346,59 @@
  *        eTag:
  *          type: string
  *          example: fd0ea167420ef1687fd16635b9fb67a3
+ *        language:
+ *          type: object
+ *          description: 'Complete language information'
+ *          nullable: true
+ *          properties:
+ *            id:
+ *              type: string
+ *              example: uk
+ *            name:
+ *              type: string
+ *              example: Ukrainian
+ *            editorCode:
+ *              type: string
+ *              example: uk
+ *            twoLettersCode:
+ *              type: string
+ *              example: uk
+ *            threeLettersCode:
+ *              type: string
+ *              example: ukr
+ *            locale:
+ *              type: string
+ *              example: uk-UA
+ *            androidCode:
+ *              type: string
+ *              example: uk-rUA
+ *            osxCode:
+ *              type: string
+ *              example: uk.lproj
+ *            osxLocale:
+ *              type: string
+ *              example: uk
+ *            pluralCategoryNames:
+ *              type: array
+ *              items:
+ *                type: string
+ *              example: ['one', 'few', 'many', 'other']
+ *            pluralRules:
+ *              type: string
+ *              example: '((n%10==1 && n%100!=11) ? 0 : ...)'
+ *            pluralExamples:
+ *              type: array
+ *              items:
+ *                type: string
+ *              example: ['1, 21, 31...', '2-4, 22-24...']
+ *            textDirection:
+ *              type: string
+ *              enum: [ltr, rtl]
+ *              example: ltr
+ *            dialectOf:
+ *              type: string
+ *              nullable: true
+ *              example: null
  *        words:
  *          properties:
  *            total:
@@ -226,6 +407,9 @@
  *            translated:
  *              type: integer
  *              example: 3651
+ *            preTranslateAppliedTo:
+ *              type: integer
+ *              example: 0
  *            approved:
  *              type: integer
  *              example: 3637
@@ -238,16 +422,35 @@
  *            translated:
  *              type: integer
  *              example: 2631
+ *            preTranslateAppliedTo:
+ *              type: integer
+ *              example: 0
  *            approved:
  *              type: integer
  *              example: 2622
  *          type: object
  *        translationProgress:
- *          type: integer
- *          example: 86
+ *          type: string
+ *          example: '86'
  *        approvalProgress:
- *          type: integer
- *          example: 86
+ *          type: string
+ *          example: '86'
+ *        qaChecksStatus:
+ *          type: object
+ *          description: 'QA checks status information'
+ *          properties:
+ *            total:
+ *              type: integer
+ *              example: 0
+ *            inProgress:
+ *              type: integer
+ *              example: 0
+ *            passed:
+ *              type: integer
+ *              example: 0
+ *            failed:
+ *              type: integer
+ *              example: 0
  *    LoginFieldsResponse:
  *      type: object
  *      properties:

package/out/modules/api/components.js

@@ -55,7 +55,6 @@
  *    IntegrationFiles:
  *      type: array
  *      description: 'List of integration files and folders'
- *      example: [{id: '1', name: 'Landing pages'}, {id: '73291251883', name: 'Intro', parentId: '1', type: 'json'}]
  *      items:
  *        anyOf:
  *          - type: object
@@ -70,6 +69,17 @@
  *              parentId:
  *                type: string
  *                description: 'Parent folder identifier'
+ *              path:
+ *                type: string
+ *                description: 'Full path to the folder'
+ *              createdAt:
+ *                type: string
+ *                format: date-time
+ *                description: 'Folder creation timestamp (ISO 8601)'
+ *              updatedAt:
+ *                type: string
+ *                format: date-time
+ *                description: 'Folder last update timestamp (ISO 8601)'
  *          - type: object
  *            description: 'File'
  *            properties:
@@ -85,18 +95,29 @@
  *              type:
  *                type: string
  *                description: 'File type (e.g., json, xml, html)'
+ *              path:
+ *                type: string
+ *                description: 'Full path to the file'
+ *              createdAt:
+ *                type: string
+ *                format: date-time
+ *                description: 'File creation timestamp (ISO 8601)'
+ *              updatedAt:
+ *                type: string
+ *                format: date-time
+ *                description: 'File last update timestamp (ISO 8601)'
  *              isNew:
  *                type: boolean
- *                description: 'Whether file is new (not synced before)'
+ *                description: 'Whether file is new (created after last sync)'
  *              isUpdated:
  *                type: boolean
  *                description: 'Whether file was updated since last sync'
  *              notSynced:
  *                type: boolean
- *                description: 'Whether file was never synced'
+ *                description: 'Whether file was never synced to Crowdin'
  *              synced:
  *                type: boolean
- *                description: 'Whether file is synced'
+ *                description: 'Whether file was previously synced to Crowdin'
  *    UpdateCrowdinFiles:
  *      title: 'Sync Files to Crowdin'
  *      required:
@@ -146,9 +167,19 @@
  *          example: '067da473-fc0b-43e3-b0a2-09d26af130c1'
  *    SettingsData:
  *      type: object
- *      example: {schedule: 0, condition: 0}
- *      additionalProperties:
- *        type: string
+ *      description: 'Application configuration settings. Fields depend on integration implementation.'
+ *      additionalProperties: true
+ *      example:
+ *        schedule: '3'
+ *        condition: '1'
+ *        new-crowdin-files: true
+ *        new-integration-files: false
+ *        inContext: false
+ *        importEqSuggestions: true
+ *        autoApproveImported: false
+ *        translateHidden: false
+ *        includeByFilePath: '/content/**'
+ *        excludeByFilePath: '/drafts/**'
  *    UpdateSettingsData:
  *      title: 'Update Application Settings'
  *      required:
@@ -163,33 +194,128 @@
  *          $ref: '#/components/schemas/SettingsData'
  *    SettingsResponse:
  *      $ref: '#/components/schemas/SettingsData'
+ *    SettingsSchemaResponse:
+ *      type: array
+ *      description: 'List of configuration fields with metadata'
+ *      items:
+ *        type: object
+ *        properties:
+ *          key:
+ *            type: string
+ *            description: 'Unique field identifier'
+ *            example: 'schedule'
+ *          label:
+ *            type: string
+ *            description: 'Human-readable field label'
+ *            example: 'Sync schedule'
+ *          labelHtml:
+ *            type: string
+ *            description: 'HTML label (alternative to label)'
+ *          type:
+ *            type: string
+ *            enum: [checkbox, text, select, textarea, notice, password, file]
+ *            description: 'Field input type'
+ *            example: 'select'
+ *          defaultValue:
+ *            type: string
+ *            description: 'Default value for the field'
+ *            example: '0'
+ *          helpText:
+ *            type: string
+ *            description: 'Plain text help description'
+ *          helpTextHtml:
+ *            type: string
+ *            description: 'HTML help description'
+ *          category:
+ *            type: string
+ *            description: 'Field category (general, sync, advanced)'
+ *            example: 'sync'
+ *          position:
+ *            type: integer
+ *            description: 'Display order within category'
+ *            example: 0
+ *          options:
+ *            type: array
+ *            description: 'Available options (for select type)'
+ *            items:
+ *              type: object
+ *              properties:
+ *                value:
+ *                  type: string
+ *                label:
+ *                  type: string
+ *          dependencySettings:
+ *            type: string
+ *            description: 'JSON string defining field visibility rules'
+ *          isSearchable:
+ *            type: boolean
+ *            description: 'Allow searching options (for select type)'
+ *          isMulti:
+ *            type: boolean
+ *            description: 'Allow multiple selection (for select type)'
+ *          noticeType:
+ *            type: string
+ *            enum: [info, warning, danger, success]
+ *            description: 'Notice type (for notice type fields)'
+ *          noIcon:
+ *            type: boolean
+ *            description: 'Hide icon in notice (for notice type)'
  *    CrowdinSyncSettingsResponse:
  *      type: object
- *      example:
- *        102: ['uk', 'de']
+ *      description: 'Mapping of Crowdin file IDs to target language codes for auto-sync'
  *      additionalProperties:
  *        type: array
+ *        description: 'Array of language codes to sync for this file'
  *        items:
  *          type: string
+ *          description: 'Language code (e.g., uk, de, fr)'
+ *      example:
+ *        '102': ['uk', 'de', 'fr']
+ *        '999': ['uk', 'es']
  *    IntegrationSyncSettingsResponse:
  *      type: array
+ *      description: 'List of integration files configured for auto-sync with their current status'
  *      items:
  *        type: object
+ *        required:
+ *          - id
+ *          - name
+ *          - node_type
  *        properties:
- *          name:
- *            type: string
  *          id:
  *            type: string
- *          parentId:
+ *            description: 'Unique file identifier'
+ *          name:
+ *            type: string
+ *            description: 'File name'
+ *          parent_id:
  *            type: string
+ *            description: 'Parent folder identifier'
  *          type:
  *            type: string
+ *            description: 'File type (e.g., html, json)'
  *          node_type:
  *            $ref: '#/components/schemas/NodeType'
  *          schedule:
  *            type: boolean
+ *            description: 'Whether auto-sync is enabled for this file'
+ *          sync:
+ *            type: boolean
+ *            description: 'Sync status flag'
+ *          isNew:
+ *            type: boolean
+ *            description: 'Whether file is new (created after last sync)'
+ *          isUpdated:
+ *            type: boolean
+ *            description: 'Whether file was updated since last sync'
+ *          notSynced:
+ *            type: boolean
+ *            description: 'Whether file was never synced to Crowdin'
+ *          synced:
+ *            type: boolean
+ *            description: 'Whether file was previously synced to Crowdin'
  *    UpdateSyncSettingsData:
- *      title: 'Update Application Sync Settings'
+ *      title: 'Update Auto-Sync Files Configuration'
  *      required:
  *        - projectId
  *        - provider
@@ -201,13 +327,15 @@
  *          example: 12
  *        provider:
  *          type: string
+ *          description: 'Sync direction: "crowdin" for Crowdin→Integration, "integration" for Integration→Crowdin'
  *          enum:
  *            - crowdin
  *            - integration
  *        files:
+ *          description: 'Format depends on provider. For "crowdin" - object with fileId→languages mapping. For "integration" - array of file objects.'
  *          oneOf:
- *            - { $ref: '#/components/schemas/CrowdinSyncSettingsResponse' }
- *            - { $ref: '#/components/schemas/IntegrationSyncSettingsResponse' }
+ *            - $ref: '#/components/schemas/CrowdinSyncSettingsResponse'
+ *            - $ref: '#/components/schemas/IntegrationSyncSettingsResponse'
  *    FileProgress:
  *      title: 'Language Translation Progress'
  *      description: 'Language Translation File Progress Response Model'
@@ -219,6 +347,59 @@
  *        eTag:
  *          type: string
  *          example: fd0ea167420ef1687fd16635b9fb67a3
+ *        language:
+ *          type: object
+ *          description: 'Complete language information'
+ *          nullable: true
+ *          properties:
+ *            id:
+ *              type: string
+ *              example: uk
+ *            name:
+ *              type: string
+ *              example: Ukrainian
+ *            editorCode:
+ *              type: string
+ *              example: uk
+ *            twoLettersCode:
+ *              type: string
+ *              example: uk
+ *            threeLettersCode:
+ *              type: string
+ *              example: ukr
+ *            locale:
+ *              type: string
+ *              example: uk-UA
+ *            androidCode:
+ *              type: string
+ *              example: uk-rUA
+ *            osxCode:
+ *              type: string
+ *              example: uk.lproj
+ *            osxLocale:
+ *              type: string
+ *              example: uk
+ *            pluralCategoryNames:
+ *              type: array
+ *              items:
+ *                type: string
+ *              example: ['one', 'few', 'many', 'other']
+ *            pluralRules:
+ *              type: string
+ *              example: '((n%10==1 && n%100!=11) ? 0 : ...)'
+ *            pluralExamples:
+ *              type: array
+ *              items:
+ *                type: string
+ *              example: ['1, 21, 31...', '2-4, 22-24...']
+ *            textDirection:
+ *              type: string
+ *              enum: [ltr, rtl]
+ *              example: ltr
+ *            dialectOf:
+ *              type: string
+ *              nullable: true
+ *              example: null
  *        words:
  *          properties:
  *            total:
@@ -227,6 +408,9 @@
  *            translated:
  *              type: integer
  *              example: 3651
+ *            preTranslateAppliedTo:
+ *              type: integer
+ *              example: 0
  *            approved:
  *              type: integer
  *              example: 3637
@@ -239,16 +423,35 @@
  *            translated:
  *              type: integer
  *              example: 2631
+ *            preTranslateAppliedTo:
+ *              type: integer
+ *              example: 0
  *            approved:
  *              type: integer
  *              example: 2622
  *          type: object
  *        translationProgress:
- *          type: integer
- *          example: 86
+ *          type: string
+ *          example: '86'
  *        approvalProgress:
- *          type: integer
- *          example: 86
+ *          type: string
+ *          example: '86'
+ *        qaChecksStatus:
+ *          type: object
+ *          description: 'QA checks status information'
+ *          properties:
+ *            total:
+ *              type: integer
+ *              example: 0
+ *            inProgress:
+ *              type: integer
+ *              example: 0
+ *            passed:
+ *              type: integer
+ *              example: 0
+ *            failed:
+ *              type: integer
+ *              example: 0
  *    LoginFieldsResponse:
  *      type: object
  *      properties: