Skip to content

Commit 694a455

Browse files
committed
Updated sources
1 parent ff1681f commit 694a455

30 files changed

Lines changed: 2208 additions & 353 deletions

LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2003-2020 Aspose Pty Ltd
3+
Copyright (c) 2003-2021 Aspose Pty Ltd
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

README.md

Lines changed: 25 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,18 @@
1-
![](https://img.shields.io/badge/api-v2.0-lightgrey) ![npm](https://img.shields.io/npm/v/groupdocs-annotation-cloud) ![npm bundle size](https://img.shields.io/bundlephobia/min/groupdocs-annotation-cloud) ![node-current](https://img.shields.io/node/v/groupdocs-annotation-cloud) ![npm type definitions](https://img.shields.io/npm/types/groupdocs-annotation-cloud) ![npm](https://img.shields.io/npm/dt/groupdocs-annotation-cloud) [![GitHub license](https://img.shields.io/github/license/groupdocs-annotation-cloud/groupdocs-annotation-cloud-node)](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-node/blob/master/LICENSE)
1+
# GroupDocs.Annotation Cloud Node.js SDK
22

3-
# Node.js SDK for Document Annotation
4-
5-
[GroupDocs.Annotation Cloud SDK for Node.js](https://products.groupdocs.cloud/annotation/nodejs) wraps GroupDocs.Annotation RESTful APIs so you may integrate Document Annotation features in your own apps with zero initial cost.
6-
7-
The solution helps in applying annotations, sticky notes, watermark overlays, redactions, text replacements and markups to documents, presentations, emails, spreadsheets, PDF, images, and other file formats.
8-
9-
## Annotate Documents & Images in the Cloud
10-
11-
- Import document annotations.
12-
- Add or remove annotations.
13-
- Export annotated document back to its original format.
14-
- Preview document pages as images.
15-
- Fetch document information, such as, page count & file size.
16-
17-
Check out the [Developer's Guide](https://docs.groupdocs.cloud/annotation/developer-guide/) to know more about GroupDocs.Annotation REST API.
18-
19-
## Microsoft Office Formats
20-
21-
**Microsoft Word:** DOC, DOCM, DOCX, DOT, DOTM, DOTX, RTF\
22-
**Microsoft Excel:** XLS, XLSX\
23-
**Microsoft PowerPoint:** PPT, PPTX, PPSX\
24-
**Microsoft Visio:** VSSX, VSS, VSSM, VDX, VSD, VSDX, VSDM, VSTM, VSX, VTX\
25-
**Microsoft Outlook:** EML, EMLX, MSG
26-
27-
## Other Document Formats
28-
29-
**Portable:** PDF\
30-
**OpenDocument:** ODT, OTT, ODP, OTP\
31-
**Images:** BMP, PNG, JPG, JPEG, TIFF, TIF, GIF\
32-
**Web:** MHTML\
33-
**Others:** TXT
34-
35-
## Get Started with GroupDocs.Annotation Cloud SDK for Node.js
36-
37-
First create an account at [GroupDocs for Cloud](https://dashboard.groupdocs.cloud/) and get your application information. Next, follow the installation steps to get started.
3+
Node.js module for communicating with the GroupDocs.Annotation Cloud API
384

395
## Installation
406

41-
GroupDocs.Annotation Cloud SDK for Node.js is available at [npmjs.com](https://www.npmjs.com/package/groupdocs-annotation-cloud). You can install it as follows.
7+
A package `groupdocs-annotation-cloud` is available at [npmjs.com](https://www.npmjs.com/package/groupdocs-annotation-cloud). You can install it with:
428

439
```shell
4410
npm install groupdocs-annotation-cloud
4511
```
4612

47-
## Get All Supported Formats for Annotation
13+
## Getting Started
14+
15+
Please follow the [installation](#installation) procedure and then run the following JavaScript code:
4816

4917
```js
5018
// load the module
@@ -70,19 +38,18 @@ infoApi.getSupportedFileFormats()
7038
});
7139
```
7240

73-
Or compile and run the same written in TypeScript:
41+
Or compile and run same written in TypeScript:
7442

7543
```ts
7644
// load the module
77-
import { InfoApi, Configuration } from "groupdocs-annotation-cloud";
45+
import { InfoApi } from "groupdocs-annotation-cloud";
7846

79-
// Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
80-
const myClientId: string = "";
81-
const myClientSecret: string = "";
47+
// get your appSid and appKey at https://dashboard.groupdocs.cloud (free registration is required).
48+
const appSid: string = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
49+
const appKey: string = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
8250

83-
// Create instance of the API
84-
const configuration: Configuration = Configuration(myClientId, myClientSecret);
85-
const infoApi: InfoApi = InfoApi.fromConfig(configuration);
51+
// construct AnnotationApi
52+
const infoApi: InfoApi = InfoApi.fromKeys(appSid, appKey);
8653

8754
// retrieve supported file-formats
8855
infoApi.getSupportedFileFormats()
@@ -97,12 +64,18 @@ infoApi.getSupportedFileFormats()
9764
});
9865
```
9966

100-
## GroupDocs.Annotation Cloud SDKs in Popular Languages
67+
## Licensing
68+
69+
GroupDocs.Annotation Cloud Node.js SDK licensed under [MIT License](LICENSE).
70+
71+
## Resources
10172

102-
| .NET | Java | PHP | Python | Ruby | Node.js |
103-
|---|---|---|---|---|---|
104-
| [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-dotnet) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-php) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-python) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-node) |
105-
| [NuGet](https://www.nuget.org/packages/GroupDocs.Annotation-Cloud/) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-annotation-cloud) | [Composer](https://packagist.org/packages/groupdocscloud/groupdocs-annotation-cloud) | [PIP](https://pypi.org/project/groupdocs-annotation-cloud/) | [GEM](https://rubygems.org/gems/groupdocs_annotation_cloud) | [NPM](https://www.npmjs.com/package/groupdocs-annotation-cloud) |
73+
+[**Website**](https://www.groupdocs.cloud)
74+
+[**Product Home**](https://products.groupdocs.cloud/annotation)
75+
+[**Documentation**](https://docs.groupdocs.cloud/annotation/)
76+
+[**Free Support Forum**](https://forum.groupdocs.cloud/c/annotation)
77+
+[**Blog**](https://blog.groupdocs.cloud/category/annotation)
10678

107-
[Home](https://www.groupdocs.cloud/) | [Product Page](https://products.groupdocs.cloud/annotation/nodejs) | [Documentation](https://docs.groupdocs.cloud/annotation/) | [Live Demo](https://products.groupdocs.app/annotation/total) | [API Reference](https://apireference.groupdocs.cloud/annotation/) | [Code Samples](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-node-samples) | [Blog](https://blog.groupdocs.cloud/category/annotation/) | [Free Support](https://forum.groupdocs.cloud/c/annotation) | [Free Trial](https://dashboard.groupdocs.cloud)
79+
## Contact Us
10880

81+
Your feedback is very important to us. Please feel free to contact us using our [Support Forums](https://forum.groupdocs.cloud/c/annotation).

package-lock.json

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "groupdocs-annotation-cloud",
3-
"version": "20.10.0",
3+
"version": "21.2.0",
44
"description": "GroupDocs.Annotation Cloud SDK for Node.js",
55
"homepage": "https://products.groupdocs.cloud/annotation",
66
"author": {
@@ -36,13 +36,13 @@
3636
"@types/request": "*"
3737
},
3838
"devDependencies": {
39-
"@types/chai": "^4.2.9",
39+
"@types/chai": "^4.2.14",
4040
"@types/mocha": "^5.2.7",
41-
"@types/node": "^12.0.8",
42-
"mocha": "^7.0.1",
41+
"@types/node": "^12.19.15",
4342
"chai": "^4.2.0",
43+
"mocha": "^7.0.1",
4444
"ts-node": "^8.6.2",
45-
"tslint": "^5.17.0",
45+
"tslint": "^5.17.0",
4646
"typescript": "^3.7.5"
4747
}
48-
}
48+
}

0 commit comments

Comments
 (0)