Release 23.9 (#82)

* Go: Add client and version headers * Dart: Generate client with SDK header and version * Dart: client with Configuration Export Configuration from api * Dart: remove 'part' directive and 'part of' header Move everything to src dir Fix linting error by renaming api.dart to aspose_barcode_cloud.dart Make SDK_VERSION public * Node: rename applyToRequest -> applyToRequestAsync * Node: Add defaultHeaders Remove request prefix from local variables * Java: Fix linting Java: Add missing comments final ApiClient * Java: Configuration added * Update Maven plugin versions Remove attach test jar * New Swagger spec * Fix start-release.bash script * Release 23.9 * Java 8 (JDK 1.8) * All SDKs were released
aspose-barcode-cloud · Sep 22, 2023 · 2e8980c · 2e8980c
1 parent 6490ad3
commit 2e8980c
Show file tree

Hide file tree

Showing 52 changed files with 718 additions and 460 deletions.
diff --git a/codegen/Templates/dart/README.mustache b/codegen/Templates/dart/README.mustache
@@ -1,6 +1,6 @@
 # Aspose.BarCode Cloud SDK for Dart
 
-[![Dart test](https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-dart/actions/workflows/dart-compile.yml/badge.svg?branch=main)](https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-dart/actions/workflows/dart-compile.yml)
+[![Dart test](https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-dart/actions/workflows/dart.yml/badge.svg?branch=main)](https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-dart/actions/workflows/dart.yml)
 
 - API version: {{appVersion}}
 - SDK version: {{pubVersion}}
@@ -44,7 +44,7 @@ dependencies:
 The examples below show how you can generate QR barcode and save it into a local file and then recognize using **{{pubName}}**:
 
 ```dart
-import 'package:aspose_barcode_cloud/api.dart' as barcode;
+import 'package:aspose_barcode_cloud/aspose_barcode_cloud.dart' as barcode;
 
 import 'dart:typed_data';
 import 'dart:io';
@@ -65,7 +65,7 @@ Future<void> main() async {
   Uint8List? generated =
       await api.getBarcodeGenerate("QR", "text", textLocation: "None");
   // Save generated image to file
-  await new File(fileName).writeAsBytes(generated!);
+  await File(fileName).writeAsBytes(generated!);
   print("Generated image saved to " + fileName);
 
   // Recognize generated image

diff --git a/codegen/Templates/dart/api.mustache b/codegen/Templates/dart/api.mustache
@@ -1,7 +1,11 @@
-part of {{pubName}}.api;
+import 'dart:typed_data' show Uint8List;
 
-{{#operations}}
+import 'package:http/http.dart' show MultipartFile, MultipartRequest;
+
+import '../../aspose_barcode_cloud.dart';
+import '../api_helper.dart';
 
+{{#operations}}
 
 class {{classname}} {
   {{classname}}(this.apiClient) {}
@@ -30,7 +34,7 @@ class {{classname}} {
     {{^required}}
     if({{paramName}} != null) {
     {{/required}}
-      queryParams.addAll(_convertParametersForCollectionFormat("{{collectionFormat}}", "{{baseName}}", {{paramName}}));
+      queryParams.addAll(convertParametersForCollectionFormat("{{collectionFormat}}", "{{baseName}}", {{paramName}}));
     {{^required}}
     }
     {{/required}}
@@ -53,7 +57,7 @@ class {{classname}} {
         mp.fields['{{baseName}}'] = parameterToString({{paramName}});
       }
       {{/notFile}}{{#isFile}}
-      mp = new MultipartRequest('{{httpMethod}}', Uri.parse(requestPath));
+      mp = MultipartRequest('{{httpMethod}}', Uri.parse(requestPath));
       // ignore: unnecessary_null_comparison
       if ({{paramName}} != null) {
         hasFields = true;
@@ -83,15 +87,15 @@ class {{classname}} {
                                              authNames);
 
     if(response.statusCode >= 400) {
-      throw new ApiException(response.statusCode, response.body);
+      throw ApiException(response.statusCode, response.body);
     } else {
       return
       {{#isListContainer}}
         {{#returnType}}(apiClient.deserialize(response.body, '{{{returnType}}}') as List).map((item) => item as {{returnBaseType}}).toList();{{/returnType}}
       {{/isListContainer}}
       {{^isListContainer}}
         {{#isMapContainer}}
-          {{#returnType}}new {{{returnType}}}.from(apiClient.deserialize(response.body, '{{{returnType}}}')) {{/returnType}};
+          {{#returnType}}{{{returnType}}}.from(apiClient.deserialize(response.body, '{{{returnType}}}')) {{/returnType}};
         {{/isMapContainer}}
         {{^isMapContainer}}
         {{#isResponseFile}}

diff --git a/codegen/Templates/dart/api_client.mustache b/codegen/Templates/dart/api_client.mustache
@@ -1,34 +1,40 @@
-part of {{pubName}}.api;
+import 'dart:convert' show json;
 
-class QueryParam {
-  String name;
-  String value;
+import 'package:http/http.dart' as Http show Client, MultipartRequest, Response;
 
-  QueryParam(this.name, this.value);
-}
+import '../aspose_barcode_cloud.dart';
+import 'api_helper.dart';
+import 'auth/authentication.dart';
+import 'auth/oauth.dart';
+
+const String SDK_VERSION = "{{pubVersion}}";
 
 class ApiClient {
 
-  String basePath;
-  final client = new {{#browserClient}}Browser{{/browserClient}}Client();
+  late final String basePath;
+  final httpClient = Http.Client();
+
+  static const String API_SDK_HEADER = "x-aspose-client";
+  static const String SDK_NAME = "dart sdk";
+  static const String API_CLIENT_VERSION_HEADER = "x-aspose-client-version";
+
+  Map<String, String> _defaultHeaderMap = {
+    API_SDK_HEADER: SDK_NAME,
+    API_CLIENT_VERSION_HEADER: SDK_VERSION,
+  };
 
-  Map<String, String> _defaultHeaderMap = {};
   late Authentication _authentication;
 
-  final _regList = new RegExp(r'^List<(.*)>$');
-  final _regMap = new RegExp(r'^Map<String,(.*)>$');
-
-  ApiClient(
-      {String? clientId,
-      String? clientSecret,
-      String? accessToken,
-      tokenUrl = "https://api.aspose.cloud/connect/token",
-      this.basePath = "https://api.aspose.cloud/v3.0"}) {
-    _authentication = new OAuth(
-        clientId: clientId,
-        clientSecret: clientSecret,
-        accessToken: accessToken,
-        tokenUrl: tokenUrl);
+  final _regList = RegExp(r'^List<(.*)>$');
+  final _regMap = RegExp(r'^Map<String,(.*)>$');
+
+  ApiClient(Configuration config) {
+    this.basePath = config.basePath;
+    _authentication = OAuth(
+        clientId: config.clientId,
+        clientSecret: config.clientSecret,
+        accessToken: config.accessToken,
+        tokenUrl: config.tokenUrl);
   }
 
   void addDefaultHeader(String key, String value) {
@@ -50,10 +56,10 @@ class ApiClient {
           {{#model}}
         case '{{classname}}':
             {{#isEnum}}
-           return new {{classname}}.fromJson(value);
+           return {{classname}}.fromJson(value);
             {{/isEnum}}
             {{^isEnum}}
-          return new {{classname}}.fromJson(value);
+          return {{classname}}.fromJson(value);
             {{/isEnum}}
           {{/model}}
         {{/models}}
@@ -67,15 +73,15 @@ class ApiClient {
             } else if (value is Map &&
                 (match = _regMap.firstMatch(targetType)) != null) {
               final newTargetType = match![1];
-              return new Map.fromIterables(value.keys,
+              return Map.fromIterables(value.keys,
                   value.values.map((v) => _deserialize(v, newTargetType!)));
             }
           }
       }
     } on Exception catch (e, stack) {
-      throw new ApiException.withInner(0, 'Exception during deserialization.', e, stack);
+      throw ApiException.withInner(0, 'Exception during deserialization.', e, stack);
     }
-    throw new ApiException(0, 'Could not find a suitable class for deserialization');
+    throw ApiException(0, 'Could not find a suitable class for deserialization');
   }
 
   dynamic deserialize(String jsonVal, String targetType) {
@@ -102,7 +108,7 @@ class ApiClient {
 
   // We don't use a Map<String, String> for queryParams.
   // If collectionFormat is 'multi' a key might appear multiple times.
-  Future<Response> invokeAPI(String path,
+  Future<Http.Response> invokeAPI(String path,
                              String method,
                              List<QueryParam> queryParams,
                              Object? body,
@@ -123,27 +129,27 @@ class ApiClient {
     headerParams.addAll(_defaultHeaderMap);
     headerParams['Content-Type'] = contentType;
 
-    if(body is MultipartRequest) {
-      final request = new MultipartRequest(method, Uri.parse(url));
+    if(body is Http.MultipartRequest) {
+      final request = Http.MultipartRequest(method, Uri.parse(url));
       request.fields.addAll(body.fields);
       request.files.addAll(body.files);
       request.headers.addAll(body.headers);
       request.headers.addAll(headerParams);
-      final response = await client.send(request);
-      return Response.fromStream(response);
+      final response = await httpClient.send(request);
+      return Http.Response.fromStream(response);
     } else {
       final msgBody = contentType == "application/x-www-form-urlencoded" ? formParams : serialize(body);
       switch(method) {
         case "POST":
-          return client.post(Uri.parse(url), headers: headerParams, body: msgBody);
+          return httpClient.post(Uri.parse(url), headers: headerParams, body: msgBody);
         case "PUT":
-          return client.put(Uri.parse(url), headers: headerParams, body: msgBody);
+          return httpClient.put(Uri.parse(url), headers: headerParams, body: msgBody);
         case "DELETE":
-          return client.delete(Uri.parse(url), headers: headerParams);
+          return httpClient.delete(Uri.parse(url), headers: headerParams);
         case "PATCH":
-          return client.patch(Uri.parse(url), headers: headerParams, body: msgBody);
+          return httpClient.patch(Uri.parse(url), headers: headerParams, body: msgBody);
         default:
-          return client.get(Uri.parse(url), headers: headerParams);
+          return httpClient.get(Uri.parse(url), headers: headerParams);
       }
     }
   }

diff --git a/codegen/Templates/dart/api_doc.mustache b/codegen/Templates/dart/api_doc.mustache
@@ -3,7 +3,7 @@
 
 ## Load the API package
 ```dart
-import 'package:{{pubName}}/api.dart';
+import 'package:{{pubName}}/aspose_barcode_cloud.dart';
 ```
 
 All URIs are relative to *{{basePath}}*
@@ -24,7 +24,7 @@ Method | HTTP request | Description
 
 ### Example
 ```dart
-import 'package:{{pubName}}/api.dart';
+import 'package:{{pubName}}/aspose_barcode_cloud.dart';
 {{#hasAuthMethods}}
 {{#authMethods}}
 {{#isBasic}}
@@ -45,9 +45,9 @@ import 'package:{{pubName}}/api.dart';
 {{/authMethods}}
 {{/hasAuthMethods}}
 
-final api_instance = new {{classname}}();
+final api_instance = {{classname}}();
 {{#allParams}}
-final {{paramName}} = {{#isListContainer}}[{{/isListContainer}}{{#isBodyParam}}new {{dataType}}(){{/isBodyParam}}{{^isBodyParam}}{{{example}}}{{/isBodyParam}}{{#isListContainer}}]{{/isListContainer}}; // {{{dataType}}} | {{{description}}}
+final {{paramName}} = {{#isListContainer}}[{{/isListContainer}}{{#isBodyParam}}{{dataType}}(){{/isBodyParam}}{{^isBodyParam}}{{{example}}}{{/isBodyParam}}{{#isListContainer}}]{{/isListContainer}}; // {{{dataType}}} | {{{description}}}
 {{/allParams}}
 
 try {

diff --git a/codegen/Templates/dart/api_exception.mustache b/codegen/Templates/dart/api_exception.mustache
@@ -1,5 +1,3 @@
-part of {{pubName}}.api;
-
 class ApiException implements Exception {
   int code = 0;
   String? message = null;

diff --git a/codegen/Templates/dart/api_helper.mustache b/codegen/Templates/dart/api_helper.mustache
@@ -1,9 +1,16 @@
-part of {{pubName}}.api;
+import '../aspose_barcode_cloud.dart';
 
 const _delimiters = const {'csv': ',', 'ssv': ' ', 'tsv': '\t', 'pipes': '|'};
 
+class QueryParam {
+  String name;
+  String value;
+
+  QueryParam(this.name, this.value);
+}
+
 // port from Java version
-Iterable<QueryParam> _convertParametersForCollectionFormat(
+Iterable<QueryParam> convertParametersForCollectionFormat(
   String collectionFormat, String name, dynamic value) {
   final params = <QueryParam>[];
 
@@ -13,7 +20,7 @@ Iterable<QueryParam> _convertParametersForCollectionFormat(
   }
 
   if (value is! List) {
-    params.add(new QueryParam(name, parameterToString(value)));
+    params.add(QueryParam(name, parameterToString(value)));
     return params;
   }
 
@@ -23,12 +30,12 @@ Iterable<QueryParam> _convertParametersForCollectionFormat(
   collectionFormat = collectionFormat.isEmpty ? "csv" : collectionFormat; // default: csv
 
   if (collectionFormat == "multi") {
-    return values.map((v) => new QueryParam(name, parameterToString(v)));
+    return values.map((v) => QueryParam(name, parameterToString(v)));
   }
 
   final String delimiter = _delimiters[collectionFormat] ?? ",";
 
-  params.add(new QueryParam(name, values.map((v) => parameterToString(v)).join(delimiter)));
+  params.add(QueryParam(name, values.map((v) => parameterToString(v)).join(delimiter)));
   return params;
 }
 

diff --git a/codegen/Templates/dart/apilib.mustache b/codegen/Templates/dart/apilib.mustache
@@ -1,18 +1,10 @@
 library {{pubName}}.api;
 
-import 'dart:async';
-import 'dart:convert';
-import 'dart:typed_data';{{#browserClient}}
-import 'package:http/browser_client.dart';{{/browserClient}}
-import 'package:http/http.dart';
+export 'src/configuration.dart' show Configuration;
+export 'src/api_client.dart' show ApiClient, SDK_VERSION;
+export 'src/api_exception.dart' show ApiException;
 
-part 'api_client.dart';
-part 'api_helper.dart';
-part 'api_exception.dart';
-part 'auth/authentication.dart';
-part 'auth/oauth.dart';
-
-{{#apiInfo}}{{#apis}}part 'api/{{classFilename}}.dart';
+{{#apiInfo}}{{#apis}}export 'src/api/{{classFilename}}.dart' show {{classname}};
 {{/apis}}{{/apiInfo}}
-{{#models}}{{#model}}part 'model/{{classFilename}}.dart';
+{{#models}}{{#model}}export 'src/model/{{classFilename}}.dart' show {{classname}};
 {{/model}}{{/models}}
diff --git a/codegen/Templates/dart/auth/api_key_auth.mustache b/codegen/Templates/dart/auth/api_key_auth.mustache
@@ -1,5 +1,3 @@
-part of {{pubName}}.api;
-
 class ApiKeyAuth implements Authentication {
 
   final String location;
@@ -19,7 +17,7 @@ class ApiKeyAuth implements Authentication {
     }
 
     if (location == 'query' && value != null) {
-      queryParams.add(new QueryParam(paramName, value));
+      queryParams.add(QueryParam(paramName, value));
     } else if (location == 'header' && value != null) {
       headerParams[paramName] = value;
     }

diff --git a/codegen/Templates/dart/auth/authentication.mustache b/codegen/Templates/dart/auth/authentication.mustache
@@ -1,4 +1,4 @@
-part of {{pubName}}.api;
+import '../api_helper.dart';
 
 abstract class Authentication {
 

diff --git a/codegen/Templates/dart/auth/http_basic_auth.mustache b/codegen/Templates/dart/auth/http_basic_auth.mustache
@@ -1,5 +1,3 @@
-part of {{pubName}}.api;
-
 class HttpBasicAuth implements Authentication {
 
   String? username;

diff --git a/codegen/Templates/dart/auth/oauth.mustache b/codegen/Templates/dart/auth/oauth.mustache
@@ -1,4 +1,10 @@
-part of {{pubName}}.api;
+import 'dart:convert' show jsonDecode;
+
+import 'package:http/http.dart' show MultipartRequest;
+
+import '../api_exception.dart';
+import '../api_helper.dart';
+import 'authentication.dart';
 
 class OAuth implements Authentication {
   String? clientId;
@@ -25,12 +31,12 @@ class OAuth implements Authentication {
       if (clientId != null && clientSecret != null) {
         await fetchToken(clientId!, clientSecret!);
       } else {
-        throw new ApiException(0, "clientId or clientSecret not defined");
+        throw ApiException(0, "clientId or clientSecret not defined");
       }
     }
 
     if (accessToken == null) {
-      throw new ApiException(0, "accessToken is null");
+      throw ApiException(0, "accessToken is null");
     }
     headerParams["Authorization"] = "Bearer " + accessToken!;
   }