Merge remote-tracking branch 'origin/master' into release

Author: dynabic-billing-team

CHANGELOG.md

@@ -1,3 +1,12 @@
+## [22.3.0] - Aspose Words Cloud for Dart 22.3 Release Notes
+
+- Online methods returns the dictionary of files with included original filename as key instead of single file content in responses.
+- Parameters contained sensitive data should be passed in encrypted form. Names of the parameters have 'encrypted' prefix.
+- Added Encrypt method to encrypt data on the API public key. Use it to prepare values for parameters required encrypted data.
+- GetPublicKey method is not billable.
+- Changed type of enumerations for members of SaveOptionsData and other inherited classes from string to enum.
+
+
 ## [22.2.0] - Aspose Words Cloud for Dart 22.2 Release Notes
 
 - Made 'SaveOprionsData.SaveFormat' property readonly with default value.

README.md

@@ -27,7 +27,7 @@ Add this dependency to your *pubspec.yaml*:
 
 ```yaml
 dependencies:
-  aspose_words_cloud: 22.2.0
+  aspose_words_cloud: 22.3.0
 ```
 
 ## Getting Started

analysis_options.yaml

@@ -6,6 +6,7 @@ analyzer:
     prefer_adjacent_string_concatenation: ignore
     unnecessary_getters_setters: ignore
     prefer_final_fields: ignore
+    constant_identifier_names: ignore
   exclude:
     - examples/**
 linter:

examples/AcceptAllRevisionsOnline.dart

@@ -9,5 +9,5 @@ final requestDocument = (await File(fileName).readAsBytes()).buffer.asByteData()
 final request = AcceptAllRevisionsOnlineRequest(requestDocument);
 final acceptAllRevisionsOnlineResult = await wordsApi.acceptAllRevisionsOnline(request);
 await File('test_result.docx').writeAsBytes(
-    acceptAllRevisionsOnlineResult.document.buffer.asUint8List(acceptAllRevisionsOnlineResult.document.offsetInBytes, acceptAllRevisionsOnlineResult.document.lengthInBytes)
+    acceptAllRevisionsOnlineResult.document.values.first.buffer.asUint8List(acceptAllRevisionsOnlineResult.document.values.first.offsetInBytes, acceptAllRevisionsOnlineResult.document.values.first.lengthInBytes)
 );

lib/aspose_words_cloud.dart

@@ -196,6 +196,7 @@ export 'src/models/paragraph_response.dart';
 export 'src/models/pcl_save_options_data.dart';
 export 'src/models/pdf_digital_signature_details_data.dart';
 export 'src/models/pdf_encryption_details_data.dart';
+export 'src/models/pdf_permissions.dart';
 export 'src/models/pdf_save_options_data.dart';
 export 'src/models/png_save_options_data.dart';
 export 'src/models/preferred_width.dart';

lib/src/api_client.dart

@@ -37,6 +37,7 @@ import 'package:uuid/uuid.dart';
 
 import './api_request_data.dart';
 import './api_request_part.dart';
+import './body_part_data.dart';
 import './byte_data_extensions.dart';
 import './requests/batch_request.dart';
 import '../aspose_words_cloud.dart';
@@ -62,13 +63,21 @@ class ApiClient {
 
     _encryptorInitialized = true;
     try {
-        final rsaPublicKey = await _publicKeyRequester(GetPublicKeyRequest());
-        if (rsaPublicKey == null || rsaPublicKey.modulus == null || rsaPublicKey.exponent == null) {
-          throw ApiException(400, 'Invalid public key response.');
+        var exponentString = configuration.rsaExponent;
+        var modulusString = configuration.rsaModulus;
+
+        if (exponentString == null || exponentString.isEmpty || modulusString == null || modulusString.isEmpty)
+        {
+            final rsaPublicKey = await _publicKeyRequester(GetPublicKeyRequest());
+            if (rsaPublicKey == null || rsaPublicKey.modulus == null || rsaPublicKey.exponent == null) {
+              throw ApiException(400, 'Invalid public key response.');
+            }
+            exponentString = rsaPublicKey.modulus as String;
+            modulusString = rsaPublicKey.exponent as String;
         }
 
-        final modulus = BigInt.parse(hex.encode(base64Decode(rsaPublicKey.modulus as String)), radix: 16);
-        final exponent = BigInt.parse(hex.encode(base64Decode(rsaPublicKey.exponent as String)), radix: 16);
+        final modulus = BigInt.parse(hex.encode(base64Decode(modulusString)), radix: 16);
+        final exponent = BigInt.parse(hex.encode(base64Decode(exponentString)), radix: 16);
         var pubKey = RSAPublicKey(modulus, exponent);
 
         _encrypter.init(true, PublicKeyParameter<RSAPublicKey>(pubKey));
@@ -333,29 +342,54 @@ class ApiClient {
     return result;
   }
 
-  Map<String, ByteData> deserializeMultipartMap(final ByteData data) {
-    var result = <String, ByteData>{};
+  Map<String, BodyPartData> deserializeMultipartMap(final ByteData data) {
+    var result = <String, BodyPartData>{};
     for (final part in _deserializeMultipartBase(data)) {
       var headersEndIndex = part.indexOf(_newline2x);
       if (headersEndIndex == null) {
         throw ApiException(400, 'Failed to parse multipart response.');
       }
 
+      const contentDispositionStr = 'Content-Disposition:';
+      const contentTypeStr = 'Content-Disposition:';
       var headersData = ByteData.sublistView(part, 0, headersEndIndex);
       var headersStr = utf8.decoder.convert(headersData.buffer.asUint8List(headersData.offsetInBytes, headersData.lengthInBytes));
-      var contentDisposition = headersStr.split('\r\n').firstWhere((x) => x.trim().startsWith('Content-Disposition:'));
+      var headersRaw = headersStr.split('\r\n');
+      var contentDisposition = headersRaw.firstWhere((x) => x.trim().startsWith(contentDispositionStr)).replaceFirst(contentDispositionStr, '').trim();
+      var contentType = headersRaw.firstWhere((x) => x.trim().startsWith(contentTypeStr))?.replaceFirst(contentTypeStr, '')?.trim();
       var nameHeaderPart = contentDisposition.split(';').map((x) => x.trim()).firstWhere((x) => x.toLowerCase().startsWith('name'));
+      var filenameHeaderPart = contentDisposition.split(';').map((x) => x.trim()).firstWhere((x) => x.toLowerCase().startsWith('name'));
       var nameValueParts = nameHeaderPart.split('=');
+      var filenameValueParts = filenameHeaderPart?.split('=');
       if (nameValueParts.length != 2) {
         throw ApiException(400, 'Failed to parse multipart response.');
       }
 
-      var nameValue = nameValueParts.elementAt(1).trim().toLowerCase();
-      result[nameValue] = ByteData.sublistView(part, headersEndIndex + _newline2x.lengthInBytes, part.lengthInBytes - _newline.lengthInBytes);
+      var nameValue = nameValueParts.elementAt(1).trim().replaceAll('"', '').toLowerCase();
+      var filenameValue = filenameValueParts?.elementAt(1)?.trim()?.replaceAll('"', '');
+      var content = ByteData.sublistView(part, headersEndIndex + _newline2x.lengthInBytes, part.lengthInBytes - _newline.lengthInBytes);
+      result[nameValue] = BodyPartData(contentType, filenameValue, content);
     }
     return result;
   }
 
+  Map<String, ByteData> deserializeFilesCollection(final BodyPartData bodyPartData) {
+    var result = <String, ByteData>{};
+    if (bodyPartData.contentType != null && bodyPartData.contentType.startsWith('multipart/mixed'))
+    {
+      var subParts = deserializeMultipartMap(bodyPartData.content);
+      subParts.forEach((key, value) {
+        result[value.filename] = value.content;
+      });
+    }
+    else
+    {
+      result[bodyPartData.filename ?? ''] = bodyPartData.content;
+    }
+
+    return result;
+  }
+
   dynamic deserializeBatchPart(final RequestBase request, final ByteData partData) {
     var statusDataEndIndex = partData.indexOf(_newline);
     if (statusDataEndIndex == null) {
@@ -471,7 +505,7 @@ class ApiClient {
 
     var httpRequest = http.Request(requestData.method, Uri.parse(requestData.url));
     httpRequest.headers['x-aspose-client'] = 'dart sdk';
-    httpRequest.headers['x-aspose-client-version'] = '22.2';
+    httpRequest.headers['x-aspose-client-version'] = '22.3';
     httpRequest.headers['Authorization'] = await _getAuthToken();
     if (requestData.headers != null) {
       httpRequest.headers.addAll(requestData.headers);

lib/src/body_part_data.dart

@@ -0,0 +1,37 @@
+/*
+ * --------------------------------------------------------------------------------
+ * <copyright company="Aspose" file="body_part_data.dart">
+ *   Copyright (c) 2022 Aspose.Words for Cloud
+ * </copyright>
+ * <summary>
+ *   Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ * 
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ * 
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ * </summary>
+ * --------------------------------------------------------------------------------
+ */
+
+library aspose_words_cloud;
+
+import 'dart:typed_data';
+
+class BodyPartData {
+  final String contentType;
+  final String filename;
+  final ByteData content;
+  BodyPartData(final this.contentType, final this.filename, final this.content);
+}

lib/src/configuration.dart

@@ -33,15 +33,19 @@ class Configuration {
   final String baseUrl;
   final bool debugMode;
   final Duration timeout;
+  final String rsaExponent;
+  final String rsaModulus;
 
-  Configuration(final this.clientId, final this.clientSecret, {final this.baseUrl = 'https://api.aspose.cloud', final this.debugMode = false, final this.timeout = const Duration(seconds: 300)});
+  Configuration(final this.clientId, final this.clientSecret, {final this.baseUrl = 'https://api.aspose.cloud', final this.debugMode = false, final this.timeout = const Duration(seconds: 300), final this.rsaExponent = '', final this.rsaModulus = ''});
 
   Configuration.fromJson(final Map<String, dynamic> json)
     : clientId = json['ClientId'] as String,
       clientSecret = json['ClientSecret'] as String,
       baseUrl = json['BaseUrl'] as String ?? 'https://api.aspose.cloud',
       debugMode = json['DebugMode'] as bool,
-      timeout = Duration(seconds: json['Timeout'] as int ?? 300);
+      timeout = Duration(seconds: json['Timeout'] as int ?? 300),
+      rsaExponent = json['RsaExponent'] as String,
+      rsaModulus = json['RsaModulus'] as String;
 
   String getApiRootUrl()
   {

lib/src/models/bmp_save_options_data.dart

@@ -69,13 +69,22 @@ class BmpSaveOptionsData extends ImageSaveOptionsData {
     }
 
     if (json.containsKey('DmlEffectsRenderingMode')) {
-      dmlEffectsRenderingMode = json['DmlEffectsRenderingMode'] as String;
+      switch (json['DmlEffectsRenderingMode'] as String) {
+        case 'Simplified': dmlEffectsRenderingMode = SaveOptionsData_DmlEffectsRenderingModeEnum.simplified; break;
+        case 'None': dmlEffectsRenderingMode = SaveOptionsData_DmlEffectsRenderingModeEnum.none; break;
+        case 'Fine': dmlEffectsRenderingMode = SaveOptionsData_DmlEffectsRenderingModeEnum.fine; break;
+        default: dmlEffectsRenderingMode = null; break;
+      }
     } else {
       dmlEffectsRenderingMode = null;
     }
 
     if (json.containsKey('DmlRenderingMode')) {
-      dmlRenderingMode = json['DmlRenderingMode'] as String;
+      switch (json['DmlRenderingMode'] as String) {
+        case 'Fallback': dmlRenderingMode = SaveOptionsData_DmlRenderingModeEnum.fallback; break;
+        case 'DrawingML': dmlRenderingMode = SaveOptionsData_DmlRenderingModeEnum.drawingML; break;
+        default: dmlRenderingMode = null; break;
+      }
     } else {
       dmlRenderingMode = null;
     }
@@ -93,7 +102,11 @@ class BmpSaveOptionsData extends ImageSaveOptionsData {
     }
 
     if (json.containsKey('ImlRenderingMode')) {
-      imlRenderingMode = json['ImlRenderingMode'] as String;
+      switch (json['ImlRenderingMode'] as String) {
+        case 'Fallback': imlRenderingMode = SaveOptionsData_ImlRenderingModeEnum.fallback; break;
+        case 'InkML': imlRenderingMode = SaveOptionsData_ImlRenderingModeEnum.inkML; break;
+        default: imlRenderingMode = null; break;
+      }
     } else {
       imlRenderingMode = null;
     }
@@ -135,7 +148,11 @@ class BmpSaveOptionsData extends ImageSaveOptionsData {
     }
 
     if (json.containsKey('ColorMode')) {
-      colorMode = json['ColorMode'] as String;
+      switch (json['ColorMode'] as String) {
+        case 'Normal': colorMode = FixedPageSaveOptionsData_ColorModeEnum.normal; break;
+        case 'Grayscale': colorMode = FixedPageSaveOptionsData_ColorModeEnum.grayscale; break;
+        default: colorMode = null; break;
+      }
     } else {
       colorMode = null;
     }
@@ -154,7 +171,14 @@ class BmpSaveOptionsData extends ImageSaveOptionsData {
     }
 
     if (json.containsKey('NumeralFormat')) {
-      numeralFormat = json['NumeralFormat'] as String;
+      switch (json['NumeralFormat'] as String) {
+        case 'European': numeralFormat = FixedPageSaveOptionsData_NumeralFormatEnum.european; break;
+        case 'ArabicIndic': numeralFormat = FixedPageSaveOptionsData_NumeralFormatEnum.arabicIndic; break;
+        case 'EasternArabicIndic': numeralFormat = FixedPageSaveOptionsData_NumeralFormatEnum.easternArabicIndic; break;
+        case 'Context': numeralFormat = FixedPageSaveOptionsData_NumeralFormatEnum.context; break;
+        case 'System': numeralFormat = FixedPageSaveOptionsData_NumeralFormatEnum.system; break;
+        default: numeralFormat = null; break;
+      }
     } else {
       numeralFormat = null;
     }
@@ -190,7 +214,12 @@ class BmpSaveOptionsData extends ImageSaveOptionsData {
     }
 
     if (json.containsKey('ImageColorMode')) {
-      imageColorMode = json['ImageColorMode'] as String;
+      switch (json['ImageColorMode'] as String) {
+        case 'None': imageColorMode = ImageSaveOptionsData_ImageColorModeEnum.none; break;
+        case 'Grayscale': imageColorMode = ImageSaveOptionsData_ImageColorModeEnum.grayscale; break;
+        case 'BlackAndWhite': imageColorMode = ImageSaveOptionsData_ImageColorModeEnum.blackAndWhite; break;
+        default: imageColorMode = null; break;
+      }
     } else {
       imageColorMode = null;
     }
@@ -208,7 +237,20 @@ class BmpSaveOptionsData extends ImageSaveOptionsData {
     }
 
     if (json.containsKey('PixelFormat')) {
-      pixelFormat = json['PixelFormat'] as String;
+      switch (json['PixelFormat'] as String) {
+        case 'Format16BppRgb555': pixelFormat = ImageSaveOptionsData_PixelFormatEnum.format16BppRgb555; break;
+        case 'Format16BppRgb565': pixelFormat = ImageSaveOptionsData_PixelFormatEnum.format16BppRgb565; break;
+        case 'Format16BppArgb1555': pixelFormat = ImageSaveOptionsData_PixelFormatEnum.format16BppArgb1555; break;
+        case 'Format24BppRgb': pixelFormat = ImageSaveOptionsData_PixelFormatEnum.format24BppRgb; break;
+        case 'Format32BppRgb': pixelFormat = ImageSaveOptionsData_PixelFormatEnum.format32BppRgb; break;
+        case 'Format32BppArgb': pixelFormat = ImageSaveOptionsData_PixelFormatEnum.format32BppArgb; break;
+        case 'Format32BppPArgb': pixelFormat = ImageSaveOptionsData_PixelFormatEnum.format32BppPArgb; break;
+        case 'Format48BppRgb': pixelFormat = ImageSaveOptionsData_PixelFormatEnum.format48BppRgb; break;
+        case 'Format64BppArgb': pixelFormat = ImageSaveOptionsData_PixelFormatEnum.format64BppArgb; break;
+        case 'Format64BppPArgb': pixelFormat = ImageSaveOptionsData_PixelFormatEnum.format64BppPArgb; break;
+        case 'Format1bppIndexed': pixelFormat = ImageSaveOptionsData_PixelFormatEnum.format1bppIndexed; break;
+        default: pixelFormat = null; break;
+      }
     } else {
       pixelFormat = null;
     }

lib/src/models/doc_save_options_data.dart

@@ -99,13 +99,22 @@ class DocSaveOptionsData extends SaveOptionsData {
     }
 
     if (json.containsKey('DmlEffectsRenderingMode')) {
-      dmlEffectsRenderingMode = json['DmlEffectsRenderingMode'] as String;
+      switch (json['DmlEffectsRenderingMode'] as String) {
+        case 'Simplified': dmlEffectsRenderingMode = SaveOptionsData_DmlEffectsRenderingModeEnum.simplified; break;
+        case 'None': dmlEffectsRenderingMode = SaveOptionsData_DmlEffectsRenderingModeEnum.none; break;
+        case 'Fine': dmlEffectsRenderingMode = SaveOptionsData_DmlEffectsRenderingModeEnum.fine; break;
+        default: dmlEffectsRenderingMode = null; break;
+      }
     } else {
       dmlEffectsRenderingMode = null;
     }
 
     if (json.containsKey('DmlRenderingMode')) {
-      dmlRenderingMode = json['DmlRenderingMode'] as String;
+      switch (json['DmlRenderingMode'] as String) {
+        case 'Fallback': dmlRenderingMode = SaveOptionsData_DmlRenderingModeEnum.fallback; break;
+        case 'DrawingML': dmlRenderingMode = SaveOptionsData_DmlRenderingModeEnum.drawingML; break;
+        default: dmlRenderingMode = null; break;
+      }
     } else {
       dmlRenderingMode = null;
     }
@@ -123,7 +132,11 @@ class DocSaveOptionsData extends SaveOptionsData {
     }
 
     if (json.containsKey('ImlRenderingMode')) {
-      imlRenderingMode = json['ImlRenderingMode'] as String;
+      switch (json['ImlRenderingMode'] as String) {
+        case 'Fallback': imlRenderingMode = SaveOptionsData_ImlRenderingModeEnum.fallback; break;
+        case 'InkML': imlRenderingMode = SaveOptionsData_ImlRenderingModeEnum.inkML; break;
+        default: imlRenderingMode = null; break;
+      }
     } else {
       imlRenderingMode = null;
     }