aspose-barcode-cloud-node 24.3.0 → 24.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  [![npm](https://img.shields.io/npm/v/aspose-barcode-cloud-node)](https://www.npmjs.com/package/aspose-barcode-cloud-node)
6
6
 
7
7
  + API version: 3.0
8
- + Package version: 24.3.0
8
+ + Package version: 24.5.0
9
9
 
10
10
  ## Demo applications
11
11
 
@@ -52,8 +52,8 @@ async function generateBarcode(api) {
52
52
  const request = new Barcode.GetBarcodeGenerateRequest(
53
53
  Barcode.EncodeBarcodeType.QR,
54
54
  'Aspose.BarCode for Cloud Sample');
55
- request.textLocation = "None";
56
-
55
+ request.textLocation = Barcode.CodeLocation.None;
56
+
57
57
  const oneBarcode = await api.getBarcodeGenerate(request);
58
58
 
59
59
  const fileName = 'QR.png'
@@ -62,14 +62,11 @@ async function generateBarcode(api) {
62
62
  return fileName;
63
63
  }
64
64
 
65
- async function recognizeBarcode(api, fileName) {
66
- const request = new Barcode.PostBarcodeRecognizeFromUrlOrContentRequest();
67
- request.image = fs.readFileSync(fileName);
68
- request.type = Barcode.DecodeBarcodeType.QR;
69
- request.preset = Barcode.PresetType.HighPerformance;
70
- request.fastScanOnly = true;
65
+ async function scanBarcode(api, fileName) {
66
+ const request = new Barcode.ScanBarcodeRequest(fs.readFileSync(fileName));
67
+ request.decodeTypes = [Barcode.DecodeBarcodeType.QR];
71
68
 
72
- const result = await api.postBarcodeRecognizeFromUrlOrContent(request);
69
+ const result = await api.scanBarcode(request);
73
70
 
74
71
  return result.body.barcodes;
75
72
  }
@@ -82,7 +79,7 @@ generateBarcode(api)
82
79
  console.log('Barcode saved to ' + fileName);
83
80
 
84
81
  console.log('Trying to recognize barcode...');
85
- recognizeBarcode(api, fileName)
82
+ scanBarcode(api, fileName)
86
83
  .then(barcodes => {
87
84
  console.log('Recognized barcodes are:');
88
85
  console.log(JSON.stringify(barcodes, null, 2));
@@ -122,6 +119,7 @@ BarcodeApi | [**postGenerateMultiple**](docs/index.md#postgeneratemultiple) | **
122
119
  BarcodeApi | [**putBarcodeGenerateFile**](docs/index.md#putbarcodegeneratefile) | **PUT** /barcode/{name}/generate | Generate barcode and save on server (from query params or from file with json or xml content)
123
120
  BarcodeApi | [**putBarcodeRecognizeFromBody**](docs/index.md#putbarcoderecognizefrombody) | **PUT** /barcode/{name}/recognize | Recognition of a barcode from file on server with parameters in body.
124
121
  BarcodeApi | [**putGenerateMultiple**](docs/index.md#putgeneratemultiple) | **PUT** /barcode/{name}/generateMultiple | Generate image with multiple barcodes and put new file on server
122
+ BarcodeApi | [**scanBarcode**](docs/index.md#scanbarcode) | **POST** /barcode/scan | Quickly scan a barcode from an image.
125
123
  FileApi | [**copyFile**](docs/index.md#copyfile) | **PUT** /barcode/storage/file/copy/{srcPath} | Copy file
126
124
  FileApi | [**deleteFile**](docs/index.md#deletefile) | **DELETE** /barcode/storage/file/{path} | Delete file
127
125
  FileApi | [**downloadFile**](docs/index.md#downloadfile) | **GET** /barcode/storage/file/{path} | Download file
@@ -1,7 +1,7 @@
1
- import { HttpOptions } from './httpClient';
2
- export interface Authentication {
3
- /**
4
- * Apply authentication settings to header and query params.
5
- */
6
- applyToRequestAsync(requestOptions: HttpOptions): Promise<void>;
7
- }
1
+ import { HttpOptions } from './httpClient';
2
+ export interface Authentication {
3
+ /**
4
+ * Apply authentication settings to header and query params.
5
+ */
6
+ applyToRequestAsync(requestOptions: HttpOptions): Promise<void>;
7
+ }
@@ -1,30 +1,30 @@
1
- import { Authentication } from './Authentication';
2
- export declare enum ApiVersion {
3
- v3 = "v3.0"
4
- }
5
- export declare class Configuration {
6
- /**
7
- * Authentication type.
8
- */
9
- authentication: Authentication;
10
- /**
11
- * Client Id.
12
- */
13
- clientId: string;
14
- /**
15
- * Client Secret.
16
- */
17
- clientSecret: string;
18
- /**
19
- * Base Url.
20
- */
21
- baseUrl: string;
22
- readonly version: ApiVersion;
23
- readonly accessToken: string;
24
- readonly tokenUrl: string;
25
- constructor(clientId: string, clientSecret: string, baseUrl?: string, accessToken?: string, tokenUrl?: string);
26
- /**
27
- * Returns api base url
28
- */
29
- getApiBaseUrl(): string;
30
- }
1
+ import { Authentication } from './Authentication';
2
+ export declare enum ApiVersion {
3
+ v3 = "v3.0"
4
+ }
5
+ export declare class Configuration {
6
+ /**
7
+ * Authentication type.
8
+ */
9
+ authentication: Authentication;
10
+ /**
11
+ * Client Id.
12
+ */
13
+ clientId: string;
14
+ /**
15
+ * Client Secret.
16
+ */
17
+ clientSecret: string;
18
+ /**
19
+ * Base Url.
20
+ */
21
+ baseUrl: string;
22
+ readonly version: ApiVersion;
23
+ readonly accessToken: string;
24
+ readonly tokenUrl: string;
25
+ constructor(clientId: string, clientSecret: string, baseUrl?: string, accessToken?: string, tokenUrl?: string);
26
+ /**
27
+ * Returns api base url
28
+ */
29
+ getApiBaseUrl(): string;
30
+ }
package/dist/JWTAuth.d.ts CHANGED
@@ -1,14 +1,14 @@
1
- import { Configuration } from './Configuration';
2
- import { Authentication } from './Authentication';
3
- import { HttpOptions } from './httpClient';
4
- export declare class JWTAuth implements Authentication {
5
- private _accessToken?;
6
- private readonly _configuration;
7
- private _client;
8
- constructor(configuration: Configuration);
9
- /**
10
- * Apply authentication settings to header and query params.
11
- */
12
- applyToRequestAsync(requestOptions: HttpOptions): Promise<void>;
13
- private requestToken;
14
- }
1
+ import { Configuration } from './Configuration';
2
+ import { Authentication } from './Authentication';
3
+ import { HttpOptions } from './httpClient';
4
+ export declare class JWTAuth implements Authentication {
5
+ private _accessToken?;
6
+ private readonly _configuration;
7
+ private _client;
8
+ constructor(configuration: Configuration);
9
+ /**
10
+ * Apply authentication settings to header and query params.
11
+ */
12
+ applyToRequestAsync(requestOptions: HttpOptions): Promise<void>;
13
+ private requestToken;
14
+ }
package/dist/api.d.ts CHANGED
@@ -1,219 +1,228 @@
1
- /// <reference types="node" />
2
- import { Configuration } from './Configuration';
3
- import { HttpResponse } from './httpClient';
4
- import { BarcodeResponseList, DiscUsage, FileVersions, FilesList, FilesUploadResult, ObjectExist, ResultImageInfo, StorageExist } from './models';
5
- import { GetBarcodeGenerateRequest, GetBarcodeRecognizeRequest, PostBarcodeRecognizeFromUrlOrContentRequest, PostGenerateMultipleRequest, PutBarcodeGenerateFileRequest, PutBarcodeRecognizeFromBodyRequest, PutGenerateMultipleRequest, CopyFileRequest, DeleteFileRequest, DownloadFileRequest, MoveFileRequest, UploadFileRequest, CopyFolderRequest, CreateFolderRequest, DeleteFolderRequest, GetFilesListRequest, MoveFolderRequest, GetDiscUsageRequest, GetFileVersionsRequest, ObjectExistsRequest, StorageExistsRequest } from './models';
6
- export * from './models';
7
- export declare class BarcodeApi {
8
- protected defaultHeaders: any;
9
- protected _configuration: Configuration;
10
- private _client;
11
- constructor(configuration: Configuration);
12
- /**
13
- *
14
- * @summary Generate barcode.
15
- * @param request GetBarcodeGenerateRequest
16
- */
17
- getBarcodeGenerate(request: GetBarcodeGenerateRequest): Promise<{
18
- response: HttpResponse;
19
- body: Buffer;
20
- }>;
21
- /**
22
- *
23
- * @summary Recognize barcode from a file on server.
24
- * @param request GetBarcodeRecognizeRequest
25
- */
26
- getBarcodeRecognize(request: GetBarcodeRecognizeRequest): Promise<{
27
- response: HttpResponse;
28
- body: BarcodeResponseList;
29
- }>;
30
- /**
31
- *
32
- * @summary Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type \"application/octet-stream\". An image can also be passed as a form field.
33
- * @param request PostBarcodeRecognizeFromUrlOrContentRequest
34
- */
35
- postBarcodeRecognizeFromUrlOrContent(request: PostBarcodeRecognizeFromUrlOrContentRequest): Promise<{
36
- response: HttpResponse;
37
- body: BarcodeResponseList;
38
- }>;
39
- /**
40
- *
41
- * @summary Generate multiple barcodes and return in response stream
42
- * @param request PostGenerateMultipleRequest
43
- */
44
- postGenerateMultiple(request: PostGenerateMultipleRequest): Promise<{
45
- response: HttpResponse;
46
- body: Buffer;
47
- }>;
48
- /**
49
- *
50
- * @summary Generate barcode and save on server (from query params or from file with json or xml content)
51
- * @param request PutBarcodeGenerateFileRequest
52
- */
53
- putBarcodeGenerateFile(request: PutBarcodeGenerateFileRequest): Promise<{
54
- response: HttpResponse;
55
- body: ResultImageInfo;
56
- }>;
57
- /**
58
- *
59
- * @summary Recognition of a barcode from file on server with parameters in body.
60
- * @param request PutBarcodeRecognizeFromBodyRequest
61
- */
62
- putBarcodeRecognizeFromBody(request: PutBarcodeRecognizeFromBodyRequest): Promise<{
63
- response: HttpResponse;
64
- body: BarcodeResponseList;
65
- }>;
66
- /**
67
- *
68
- * @summary Generate image with multiple barcodes and put new file on server
69
- * @param request PutGenerateMultipleRequest
70
- */
71
- putGenerateMultiple(request: PutGenerateMultipleRequest): Promise<{
72
- response: HttpResponse;
73
- body: ResultImageInfo;
74
- }>;
75
- }
76
- export declare class FileApi {
77
- protected defaultHeaders: any;
78
- protected _configuration: Configuration;
79
- private _client;
80
- constructor(configuration: Configuration);
81
- /**
82
- *
83
- * @summary Copy file
84
- * @param request CopyFileRequest
85
- */
86
- copyFile(request: CopyFileRequest): Promise<{
87
- response: HttpResponse;
88
- body?: any;
89
- }>;
90
- /**
91
- *
92
- * @summary Delete file
93
- * @param request DeleteFileRequest
94
- */
95
- deleteFile(request: DeleteFileRequest): Promise<{
96
- response: HttpResponse;
97
- body?: any;
98
- }>;
99
- /**
100
- *
101
- * @summary Download file
102
- * @param request DownloadFileRequest
103
- */
104
- downloadFile(request: DownloadFileRequest): Promise<{
105
- response: HttpResponse;
106
- body: Buffer;
107
- }>;
108
- /**
109
- *
110
- * @summary Move file
111
- * @param request MoveFileRequest
112
- */
113
- moveFile(request: MoveFileRequest): Promise<{
114
- response: HttpResponse;
115
- body?: any;
116
- }>;
117
- /**
118
- *
119
- * @summary Upload file
120
- * @param request UploadFileRequest
121
- */
122
- uploadFile(request: UploadFileRequest): Promise<{
123
- response: HttpResponse;
124
- body: FilesUploadResult;
125
- }>;
126
- }
127
- export declare class FolderApi {
128
- protected defaultHeaders: any;
129
- protected _configuration: Configuration;
130
- private _client;
131
- constructor(configuration: Configuration);
132
- /**
133
- *
134
- * @summary Copy folder
135
- * @param request CopyFolderRequest
136
- */
137
- copyFolder(request: CopyFolderRequest): Promise<{
138
- response: HttpResponse;
139
- body?: any;
140
- }>;
141
- /**
142
- *
143
- * @summary Create the folder
144
- * @param request CreateFolderRequest
145
- */
146
- createFolder(request: CreateFolderRequest): Promise<{
147
- response: HttpResponse;
148
- body?: any;
149
- }>;
150
- /**
151
- *
152
- * @summary Delete folder
153
- * @param request DeleteFolderRequest
154
- */
155
- deleteFolder(request: DeleteFolderRequest): Promise<{
156
- response: HttpResponse;
157
- body?: any;
158
- }>;
159
- /**
160
- *
161
- * @summary Get all files and folders within a folder
162
- * @param request GetFilesListRequest
163
- */
164
- getFilesList(request: GetFilesListRequest): Promise<{
165
- response: HttpResponse;
166
- body: FilesList;
167
- }>;
168
- /**
169
- *
170
- * @summary Move folder
171
- * @param request MoveFolderRequest
172
- */
173
- moveFolder(request: MoveFolderRequest): Promise<{
174
- response: HttpResponse;
175
- body?: any;
176
- }>;
177
- }
178
- export declare class StorageApi {
179
- protected defaultHeaders: any;
180
- protected _configuration: Configuration;
181
- private _client;
182
- constructor(configuration: Configuration);
183
- /**
184
- *
185
- * @summary Get disc usage
186
- * @param request GetDiscUsageRequest
187
- */
188
- getDiscUsage(request: GetDiscUsageRequest): Promise<{
189
- response: HttpResponse;
190
- body: DiscUsage;
191
- }>;
192
- /**
193
- *
194
- * @summary Get file versions
195
- * @param request GetFileVersionsRequest
196
- */
197
- getFileVersions(request: GetFileVersionsRequest): Promise<{
198
- response: HttpResponse;
199
- body: FileVersions;
200
- }>;
201
- /**
202
- *
203
- * @summary Check if file or folder exists
204
- * @param request ObjectExistsRequest
205
- */
206
- objectExists(request: ObjectExistsRequest): Promise<{
207
- response: HttpResponse;
208
- body: ObjectExist;
209
- }>;
210
- /**
211
- *
212
- * @summary Check if storage exists
213
- * @param request StorageExistsRequest
214
- */
215
- storageExists(request: StorageExistsRequest): Promise<{
216
- response: HttpResponse;
217
- body: StorageExist;
218
- }>;
219
- }
1
+ /// <reference types="node" />
2
+ import { Configuration } from './Configuration';
3
+ import { HttpResponse } from './httpClient';
4
+ import { BarcodeResponseList, DiscUsage, FileVersions, FilesList, FilesUploadResult, ObjectExist, ResultImageInfo, StorageExist } from './models';
5
+ import { GetBarcodeGenerateRequest, GetBarcodeRecognizeRequest, PostBarcodeRecognizeFromUrlOrContentRequest, PostGenerateMultipleRequest, PutBarcodeGenerateFileRequest, PutBarcodeRecognizeFromBodyRequest, PutGenerateMultipleRequest, ScanBarcodeRequest, CopyFileRequest, DeleteFileRequest, DownloadFileRequest, MoveFileRequest, UploadFileRequest, CopyFolderRequest, CreateFolderRequest, DeleteFolderRequest, GetFilesListRequest, MoveFolderRequest, GetDiscUsageRequest, GetFileVersionsRequest, ObjectExistsRequest, StorageExistsRequest } from './models';
6
+ export * from './models';
7
+ export declare class BarcodeApi {
8
+ protected defaultHeaders: any;
9
+ protected _configuration: Configuration;
10
+ private _client;
11
+ constructor(configuration: Configuration);
12
+ /**
13
+ *
14
+ * @summary Generate barcode.
15
+ * @param request GetBarcodeGenerateRequest
16
+ */
17
+ getBarcodeGenerate(request: GetBarcodeGenerateRequest): Promise<{
18
+ response: HttpResponse;
19
+ body: Buffer;
20
+ }>;
21
+ /**
22
+ *
23
+ * @summary Recognize barcode from a file on server.
24
+ * @param request GetBarcodeRecognizeRequest
25
+ */
26
+ getBarcodeRecognize(request: GetBarcodeRecognizeRequest): Promise<{
27
+ response: HttpResponse;
28
+ body: BarcodeResponseList;
29
+ }>;
30
+ /**
31
+ *
32
+ * @summary Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type \"application/octet-stream\". An image can also be passed as a form field.
33
+ * @param request PostBarcodeRecognizeFromUrlOrContentRequest
34
+ */
35
+ postBarcodeRecognizeFromUrlOrContent(request: PostBarcodeRecognizeFromUrlOrContentRequest): Promise<{
36
+ response: HttpResponse;
37
+ body: BarcodeResponseList;
38
+ }>;
39
+ /**
40
+ *
41
+ * @summary Generate multiple barcodes and return in response stream
42
+ * @param request PostGenerateMultipleRequest
43
+ */
44
+ postGenerateMultiple(request: PostGenerateMultipleRequest): Promise<{
45
+ response: HttpResponse;
46
+ body: Buffer;
47
+ }>;
48
+ /**
49
+ *
50
+ * @summary Generate barcode and save on server (from query params or from file with json or xml content)
51
+ * @param request PutBarcodeGenerateFileRequest
52
+ */
53
+ putBarcodeGenerateFile(request: PutBarcodeGenerateFileRequest): Promise<{
54
+ response: HttpResponse;
55
+ body: ResultImageInfo;
56
+ }>;
57
+ /**
58
+ *
59
+ * @summary Recognition of a barcode from file on server with parameters in body.
60
+ * @param request PutBarcodeRecognizeFromBodyRequest
61
+ */
62
+ putBarcodeRecognizeFromBody(request: PutBarcodeRecognizeFromBodyRequest): Promise<{
63
+ response: HttpResponse;
64
+ body: BarcodeResponseList;
65
+ }>;
66
+ /**
67
+ *
68
+ * @summary Generate image with multiple barcodes and put new file on server
69
+ * @param request PutGenerateMultipleRequest
70
+ */
71
+ putGenerateMultiple(request: PutGenerateMultipleRequest): Promise<{
72
+ response: HttpResponse;
73
+ body: ResultImageInfo;
74
+ }>;
75
+ /**
76
+ *
77
+ * @summary Quickly scan a barcode from an image.
78
+ * @param request ScanBarcodeRequest
79
+ */
80
+ scanBarcode(request: ScanBarcodeRequest): Promise<{
81
+ response: HttpResponse;
82
+ body: BarcodeResponseList;
83
+ }>;
84
+ }
85
+ export declare class FileApi {
86
+ protected defaultHeaders: any;
87
+ protected _configuration: Configuration;
88
+ private _client;
89
+ constructor(configuration: Configuration);
90
+ /**
91
+ *
92
+ * @summary Copy file
93
+ * @param request CopyFileRequest
94
+ */
95
+ copyFile(request: CopyFileRequest): Promise<{
96
+ response: HttpResponse;
97
+ body?: any;
98
+ }>;
99
+ /**
100
+ *
101
+ * @summary Delete file
102
+ * @param request DeleteFileRequest
103
+ */
104
+ deleteFile(request: DeleteFileRequest): Promise<{
105
+ response: HttpResponse;
106
+ body?: any;
107
+ }>;
108
+ /**
109
+ *
110
+ * @summary Download file
111
+ * @param request DownloadFileRequest
112
+ */
113
+ downloadFile(request: DownloadFileRequest): Promise<{
114
+ response: HttpResponse;
115
+ body: Buffer;
116
+ }>;
117
+ /**
118
+ *
119
+ * @summary Move file
120
+ * @param request MoveFileRequest
121
+ */
122
+ moveFile(request: MoveFileRequest): Promise<{
123
+ response: HttpResponse;
124
+ body?: any;
125
+ }>;
126
+ /**
127
+ *
128
+ * @summary Upload file
129
+ * @param request UploadFileRequest
130
+ */
131
+ uploadFile(request: UploadFileRequest): Promise<{
132
+ response: HttpResponse;
133
+ body: FilesUploadResult;
134
+ }>;
135
+ }
136
+ export declare class FolderApi {
137
+ protected defaultHeaders: any;
138
+ protected _configuration: Configuration;
139
+ private _client;
140
+ constructor(configuration: Configuration);
141
+ /**
142
+ *
143
+ * @summary Copy folder
144
+ * @param request CopyFolderRequest
145
+ */
146
+ copyFolder(request: CopyFolderRequest): Promise<{
147
+ response: HttpResponse;
148
+ body?: any;
149
+ }>;
150
+ /**
151
+ *
152
+ * @summary Create the folder
153
+ * @param request CreateFolderRequest
154
+ */
155
+ createFolder(request: CreateFolderRequest): Promise<{
156
+ response: HttpResponse;
157
+ body?: any;
158
+ }>;
159
+ /**
160
+ *
161
+ * @summary Delete folder
162
+ * @param request DeleteFolderRequest
163
+ */
164
+ deleteFolder(request: DeleteFolderRequest): Promise<{
165
+ response: HttpResponse;
166
+ body?: any;
167
+ }>;
168
+ /**
169
+ *
170
+ * @summary Get all files and folders within a folder
171
+ * @param request GetFilesListRequest
172
+ */
173
+ getFilesList(request: GetFilesListRequest): Promise<{
174
+ response: HttpResponse;
175
+ body: FilesList;
176
+ }>;
177
+ /**
178
+ *
179
+ * @summary Move folder
180
+ * @param request MoveFolderRequest
181
+ */
182
+ moveFolder(request: MoveFolderRequest): Promise<{
183
+ response: HttpResponse;
184
+ body?: any;
185
+ }>;
186
+ }
187
+ export declare class StorageApi {
188
+ protected defaultHeaders: any;
189
+ protected _configuration: Configuration;
190
+ private _client;
191
+ constructor(configuration: Configuration);
192
+ /**
193
+ *
194
+ * @summary Get disc usage
195
+ * @param request GetDiscUsageRequest
196
+ */
197
+ getDiscUsage(request: GetDiscUsageRequest): Promise<{
198
+ response: HttpResponse;
199
+ body: DiscUsage;
200
+ }>;
201
+ /**
202
+ *
203
+ * @summary Get file versions
204
+ * @param request GetFileVersionsRequest
205
+ */
206
+ getFileVersions(request: GetFileVersionsRequest): Promise<{
207
+ response: HttpResponse;
208
+ body: FileVersions;
209
+ }>;
210
+ /**
211
+ *
212
+ * @summary Check if file or folder exists
213
+ * @param request ObjectExistsRequest
214
+ */
215
+ objectExists(request: ObjectExistsRequest): Promise<{
216
+ response: HttpResponse;
217
+ body: ObjectExist;
218
+ }>;
219
+ /**
220
+ *
221
+ * @summary Check if storage exists
222
+ * @param request StorageExistsRequest
223
+ */
224
+ storageExists(request: StorageExistsRequest): Promise<{
225
+ response: HttpResponse;
226
+ body: StorageExist;
227
+ }>;
228
+ }