asposeslidescloud 21.12.0 → 22.2.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.
Files changed (12) hide show
  1. package/README.md +87 -106
  2. package/api.d.ts +3507 -0
  3. package/api.js +11829 -11390
  4. package/internal/configuration.d.ts +44 -0
  5. package/internal/configuration.js +60 -60
  6. package/internal/objectSerializer.d.ts +18 -0
  7. package/internal/objectSerializer.js +184 -184
  8. package/internal/requestHelper.d.ts +33 -0
  9. package/internal/requestHelper.js +247 -247
  10. package/model.d.ts +6782 -0
  11. package/model.js +4164 -3522
  12. package/package.json +24 -24
package/README.md CHANGED
@@ -1,106 +1,87 @@
1
- ![](https://img.shields.io/badge/api-v3.0-lightgrey) ![npm](https://img.shields.io/npm/v/asposeslidescloud) ![npm bundle size](https://img.shields.io/bundlephobia/min/asposeslidescloud) ![node-current](https://img.shields.io/node/v/asposeslidescloud) ![npm type definitions](https://img.shields.io/npm/types/asposeslidescloud) [![GitHub license](https://img.shields.io/github/license/aspose-slides-cloud/aspose-slides-cloud-nodejs)](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs/blob/master/LICENSE)
2
-
3
- # Nodejs REST API to Process Presentation in Cloud
4
- This repository contains Aspose.Slides Cloud SDK for Nodejs source code. This SDK allows you to [process & manipulate PPT, PPTX, ODP, OTP](https://products.aspose.cloud/slides/nodejs) using Aspose.slides Cloud REST APIs in your Nodejs applications.
5
-
6
- You may want to check out Aspose free [PowerPoint to Word Converter](https://products.aspose.app/slides/conversion/ppt-to-word) because it is a live implementation of one of the most popular conversion processes.
7
-
8
- ## Presentation Processing Features
9
-
10
- - Fetch presentation images in any of the supported file formats.
11
- - Copy the layout side or clone the master slide from the source presentation.
12
- - Process slides shapes, slides notes, placeholders, colors & font theme info.
13
- - Programmatically create a presentation from HTML & export it to various formats.
14
- - Merge multiple presentations or split the single presentation into multiple ones.
15
- - Extract and replace text from a specific slide or an entire presentation.
16
-
17
- ## Read & Write Presentation Formats
18
-
19
- **Microsoft PowerPoint:** PPT, PPTX, PPS, PPSX, PPTM, PPSM, POTX, POTM
20
- **OpenOffice:** ODP, OTP, FODP
21
-
22
- ## Save Presentation As
23
-
24
- **Fixed Layout:** PDF, PDF/A, XPS
25
- **Images:** JPEG, PNG, BMP, TIFF, SVG
26
- **Web:** HTML/HTML5
27
- **Other:** SWF (export whole presentations)
28
-
29
- ## Enhancements in Version 21.12
30
- * New **ThreeDFormat**, **Camera**, **LightRig** and **ShapeBevel** classes allow to get and set 3D effects for shapes. New **ThreeDFormat** property of **ShapeBase** class allows to access those objects.
31
- * The declaration of **GetAnimation** and **GetSpecialSlideAnimation** methods is changed. New **paragraphIndex** parameter allows to get effects for a specific paragraph. New **ParagraphIndex** property of **Effect** class allows to set effects for a specific paragraph.
32
- * You can now use **Html5** value for **format** parameter in conversion methods and export presentations to HTML5 format.
33
- * New **Width** and **Height** parameters were added to **ExportOptions** class. You can now set custom size when convertion your documents.
34
-
35
- ## Enhancements in Version 21.9
36
- * New **options** parameter for **Convert**, **ConvertAndSave**, **DownloadSlideOnline**, **SaveSlideOnline**, **DownloadShapeOnline** and **SaveShapeOnline** methods that allows to specify options when converting presentations from request body.
37
- * New methods to manage shapes and animation for special slide types: master, layout and notes slides. The new methods are **GetSpecialSlideShapes**, **GetSpecialSlideSubshapes, **GetSpecialSlideShape**, **GetSpecialSlideSubshape**, **GetSpecialSlideParagraphs**, **GetSpecialSlideSubshapeParagraphs**, **GetSpecialSlideParagraph**, **GetSpecialSlideSubshapeParagraph**, **GetSpecialSlidePortions**, **GetSpecialSlideSubshapePortions**, **GetSpecialSlidePortion**, **GetSpecialSlideSubshapePortion**, **CreateSpecialSlideShape**, **CreateSpecialSlideSubshape**, **CreateSpecialSlideParagraph**, **CreateSpecialSlideSubshapeParagraph**, **CreateSpecialSlidePortion**, **CreateSpecialSlideSubshapePortion**, **UpdateSpecialSlideShape**, **UpdateSpecialSlideSubshape**, **UpdateSpecialSlideParagraph**, **UpdateSpecialSlideSubshapeParagraph**, **UpdateSpecialSlidePortion**, **UpdateSpecialSlideSubshapePortion**, **DeleteSpecialSlideShapes**, **DeleteSpecialSlideSubshapes**, **DeleteSpecialSlideShape**, **DeleteSpecialSlideSubshape**, **DeleteSpecialSlideParagraphs**, **DeleteSpecialSlideSubshapeParagraphs**, **DeleteSpecialSlideParagraph**, **DeleteSpecialSlideSubshapeParagraph**, **DeleteSpecialSlidePortions**, **DeleteSpecialSlideSubshapePortions**, **DeleteSpecialSlidePortion**, **DeleteSpecialSlideSubshapePortion**, **DownloadSpecialSlideShape**, **DownloadSpecialSlideSubshape**, **SaveSpecialSlideShape**, **SaveSpecialSlideSubshape**, **AlignSpecialSlideShapes**, **GetSpecialSlideAnimation**, **SetSpecialSlideAnimation**, **CreateSpecialSlideAnimationInteractiveSequence**, **CreateSpecialSlideAnimationEffect**, **CreateSpecialSlideAnimationInteractiveSequenceEffect**, **UpdateSpecialSlideAnimationEffect**, **UpdateSpecialSlideAnimationInteractiveSequenceEffect**, **DeleteSpecialSlideAnimation**, **DeleteSpecialSlideAnimationMainSequence**, **DeleteSpecialSlideAnimationInteractiveSequences**, **DeleteSpecialSlideAnimationInteractiveSequence**, **DeleteSpecialSlideAnimationEffect**, **DeleteSpecialSlideAnimationInteractiveSequenceEffect**.
38
-
39
- ## Enhancements in Version 21.8
40
- * New **slides** parameter for **Convert**, **ConvertAndSave**, **DownloadPresentation** and **SavePresentation** methods that allows to convert a specified set of slides in the presentation.
41
-
42
- ## Enhancements in Version 21.6
43
- * New **CreateComment**, **CreateCommentOnline**, **DeleteComments**, **DeleteCommentsOnline**, **DeleteSlideComments** and **DeleteSlideCommentsOnline** methods to add or delete comments in presentations.
44
-
45
- ## Enhancements in Version 21.4
46
- * New **CreateWatermark**, **CreateWatermarkOnline**, **CreateImageWatermark**, **CreateImageWatermarkOnline**, **DeleteWatermark** and **DeleteWatermarkOnline** methods to add or delete and remove watermark in presentations.
47
- * New **SetProtection**, **DeleteProtection**, **SetProtectionOnline** and **DeleteProtectionOnline** methods to set or clear presentation protection properties like read/write password, readonly flag.
48
-
49
- ## Enhancements in Version 21.3
50
- * New **MergeOnline** and **MergeAndSaveOnline** methods to merge presentations from multipart request body.
51
- * New **SplitOnline** and **SplitAndSaveOnline** methods to split presentation from request body.
52
- * New **DownloadSlideOnline**, **DownloadShapeOnline**, **DownloadImageDefaultFormatOnline**, **DownloadImageOnline**, **SaveSlideOnline** and **SaveShapeOnline** methods to convert slides, shapes and images to spefified format using presentation from request body.
53
- * New **DownloadImagesDefaultFormat**, **DownloadImages**, **DownloadImagesDefaultFormatOnline** and **DownloadImagesDefaultFormatOnline** methods to download all images from presentation as a ZIP archive.
54
- * New **ReplacePresentationTextOnline** and **ReplaceSlideTextOnline** methods to replace text in presentation from request body.
55
- * New **AlignShapes** method to align shapes in a slide.
56
- * Simplified method declarations. See the [Release notes](https://docs.aspose.cloud/slides/aspose-slides-cloud-21-3-release-notes/) for details. Old method declarations are deprecated and will be deleted in 21.6 release.
57
-
58
- ## Enhancements in Version 21.2
59
- * New **Map** value of **ChartTypeEnum** type to manage map charts.
60
- * New **SketchFromat** property of **LineFormat** class.
61
-
62
- ## Enhancements in Version 21.1
63
- * New **PostSlidesDocumentFromPdf** method allows creating presentations or adding slides to it using a PDF file as a source.
64
- * New **GetSlidesSlideProperties**, **GetSlidesProtectionProperties**, **PutSlidesSlideProperties**, **PutSlidesProtectionProperties** allow to get/set presentaion properties like slide size, orientaion, read-only etc.
65
- * **PutSlidesDocumentFromHtml** method is deprecated and will be deleted in 21.4 release. Use **PostSlidesDocumentFromHtml** method instead.
66
- * **PutSlidesSlideSize** method is deprecated and will be deleted in 21.4 release. Use **PutSlidesProtectionProperties** method instead.
67
-
68
- ## Licensing
69
- All Aspose.Slides Cloud SDKs are licensed under MIT License.
70
-
71
- ## How to use the SDK?
72
- The complete source code is available in this repository folder. You can either directly use it in your project via source code or get [NPM package](https://www.npmjs.com/package/asposeslidescloud) (recommended).
73
-
74
- ## Prerequisites
75
- To use Aspose Slides Cloud NodeJS SDK you need to register an account with [Aspose Cloud](https://www.aspose.cloud/) and lookup/create App Key and SID at [Cloud Dashboard](https://dashboard.aspose.cloud/#/apps). There is free quota available. For more details, see [Aspose Cloud Pricing](https://purchase.aspose.cloud/pricing).
76
-
77
- ### Installation
78
-
79
- From the command line:
80
-
81
- npm install asposeslidescloud --save
82
-
83
- ### Sample usage
84
-
85
- The example code below converts a PowerPoint document to PDF format using asposeslidescloud library:
86
- ```js
87
- const api = require("asposeslidescloud");
88
- const fs = require('fs');
89
-
90
- const slidesApi = new api.SlidesApi("MyClientId", "MyClientSecret");
91
- slidesApi.convert(fs.createReadStream("MyPresentation.pptx"), 'pdf').then((response) => {
92
- fs.writeFile("MyPresentation.pdf", response.body, (err) => {
93
- if (err) throw err;
94
- });
95
- });
96
- ```
97
- You can check more [Examples](Examples) of using the SDK.
98
-
99
- ## Aspose.Slides Cloud SDKs in Popular Languages
100
-
101
- | .NET | Java | PHP | Python | Ruby | Node.js | Android | Swift|Perl|Go|
102
- |---|---|---|---|---|---|---|--|--|--|
103
- | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-dotnet) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-java) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-php) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-python) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-ruby) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-android) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-swift)|[GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-perl) |[GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-go) |
104
- | [NuGet](https://www.nuget.org/packages/Aspose.slides-Cloud/) | [Maven](https://repository.aspose.cloud/webapp/#/artifacts/browse/tree/General/repo/com/aspose/aspose-slides-cloud) | [Composer](https://packagist.org/packages/aspose/slides-sdk-php) | [PIP](https://pypi.org/project/asposeslidescloud/) | [GEM](https://rubygems.org/gems/aspose_slides_cloud) | [NPM](https://www.npmjs.com/package/asposeslidescloud) | [Maven](https://repository.aspose.cloud/webapp/#/artifacts/browse/tree/General/repo/com/aspose/aspose-slides-cloud) | [Cocoapods](https://cocoapods.org/pods/AsposeslidesCloud)|[Meta Cpan](https://metacpan.org/release/AsposeSlidesCloud-SlidesApi) | [Go.Dev](https://pkg.go.dev/github.com/aspose-slides-cloud/aspose-slides-cloud-go/) |
105
-
106
- [Product Page](https://products.aspose.cloud/slides/nodejs) | [Documentation](https://docs.aspose.cloud/display/slidescloud/Home) | [API Reference](https://apireference.aspose.cloud/slides/) | [Code Samples](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs) | [Blog](https://blog.aspose.cloud/category/slides/) | [Free Support](https://forum.aspose.cloud/c/slides) | [Free Trial](https://dashboard.aspose.cloud/#/apps)
1
+ ![](https://img.shields.io/badge/api-v3.0-lightgrey) ![npm](https://img.shields.io/npm/v/asposeslidescloud) ![npm bundle size](https://img.shields.io/bundlephobia/min/asposeslidescloud) ![node-current](https://img.shields.io/node/v/asposeslidescloud) ![npm type definitions](https://img.shields.io/npm/types/asposeslidescloud) [![GitHub license](https://img.shields.io/github/license/aspose-slides-cloud/aspose-slides-cloud-nodejs)](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs/blob/master/LICENSE)
2
+
3
+ # Nodejs REST API to Process Presentation in Cloud
4
+ This repository contains Aspose.Slides Cloud SDK for Nodejs source code. This SDK allows you to [process & manipulate PPT, PPTX, ODP, OTP](https://products.aspose.cloud/slides/nodejs) using Aspose.slides Cloud REST APIs in your Nodejs applications.
5
+
6
+ You may want to check out Aspose free [PPT to PDF](https://products.aspose.app/slides/conversion), [PPT to Word](https://products.aspose.app/slides/conversion/ppt-to-word), and [PPT to JPG](https://products.aspose.app/slides/conversion/ppt-to-jpg) converters because they are live implementations of popular conversion processes.
7
+
8
+ ## Presentation Processing Features
9
+
10
+ - Fetch presentation images in any of the supported file formats.
11
+ - Copy the layout side or clone the master slide from the source presentation.
12
+ - Process slides shapes, slides notes, placeholders, colors & font theme info.
13
+ - Programmatically create a presentation from HTML & export it to various formats.
14
+ - Merge multiple presentations or split the single presentation into multiple ones.
15
+ - Extract and replace text from a specific slide or an entire presentation.
16
+
17
+ ## Read & Write Presentation Formats
18
+
19
+ **Microsoft PowerPoint:** PPT, PPTX, PPS, PPSX, PPTM, PPSM, POTX, POTM
20
+ **OpenOffice:** ODP, OTP, FODP
21
+ **Other**: PDF, PDF/A
22
+
23
+ ## Save Presentation As
24
+
25
+ **Fixed Layout:** XPS
26
+ **Images:** JPEG, PNG, BMP, TIFF, GIF, SVG
27
+ **Web:** HTML/HTML5
28
+ **Other:** MPEG4, SWF (export whole presentations)
29
+
30
+ ## Enhancements in Version 22.2
31
+ * Added **Mpeg4** to the list of allowed values for **ExportFormat** type. You can now convert presentations to video.
32
+ * New **HighlightShapeText** and **HighlightShapeRegex** methods.
33
+ * New **DeleteUnusedLayoutSlides** and **DeleteUnusedLayoutSlides** methods.
34
+ * New **ZoomFrame** and **ZoomObject** classes with a number of subclasses.
35
+ * Added **TextFrameFormat** property to **Shape** class to support WordArt.
36
+ * Added **XYSeries** class as a supercalss for **ScatterSeries** and **BubbleSeries** methods.
37
+ * Added **None** to the list of allowed values for **TimeUnitType** enum type.
38
+ * **Level** property of **Category** class is deprecated and will be removed after v22.4.
39
+
40
+ ## Enhancements in Version 22.1
41
+ * New **MathParagraph** property of **Portion** class allows to get and set math formulas. A set of **MathElement** subclasses allows to specify complex mathematical expressions.
42
+ * New **DownloadPortionAsMathMl** and **SavePortionAsMathMl** methods allow to export math formulas to MathML format.
43
+ * New **HyperlinkClick** and **HyperlinkMouseOver** methods of **ShapeBase** and **Portion** classes enable creation and manipulating hyperlinks for shapes and portions.
44
+ * New methods **GetShapeGeometryPath** and **SetShapeGeometryPath** can be used to get or set geometry paths for shapes. You can use lines, arcs and curves to specify custom shape boundaries.
45
+ * New **AlignSubshapes** method enables aligning shapes within a shape group.
46
+ * New **PlayAcrossSlides** and **RewindAudio** properties are added to **AudioFrame** class.
47
+ * Added **InClickSequence** to the list of allowable values for **AudioPlayModePreset** and **AudioPlayModePreset** enum types.
48
+
49
+ ## Licensing
50
+ All Aspose.Slides Cloud SDKs are licensed under MIT License.
51
+
52
+ ## How to use the SDK?
53
+ The complete source code is available in this repository folder. You can either directly use it in your project via source code or get [NPM package](https://www.npmjs.com/package/asposeslidescloud) (recommended).
54
+
55
+ ## Prerequisites
56
+ To use Aspose Slides Cloud NodeJS SDK you need to register an account with [Aspose Cloud](https://www.aspose.cloud/) and lookup/create App Key and SID at [Cloud Dashboard](https://dashboard.aspose.cloud/#/apps). There is free quota available. For more details, see [Aspose Cloud Pricing](https://purchase.aspose.cloud/pricing).
57
+
58
+ ### Installation
59
+
60
+ From the command line:
61
+
62
+ npm install asposeslidescloud --save
63
+
64
+ ### Sample usage
65
+
66
+ The example code below converts a PowerPoint document to PDF format using asposeslidescloud library:
67
+ ```js
68
+ const api = require("asposeslidescloud");
69
+ const fs = require('fs');
70
+
71
+ const slidesApi = new api.SlidesApi("MyClientId", "MyClientSecret");
72
+ slidesApi.convert(fs.createReadStream("MyPresentation.pptx"), 'pdf').then((response) => {
73
+ fs.writeFile("MyPresentation.pdf", response.body, (err) => {
74
+ if (err) throw err;
75
+ });
76
+ });
77
+ ```
78
+ You can check more [Examples](Examples) of using the SDK.
79
+
80
+ ## Aspose.Slides Cloud SDKs in Popular Languages
81
+
82
+ | .NET | Java | PHP | Python | Ruby | Node.js | Android | Swift|Perl|Go|
83
+ |---|---|---|---|---|---|---|--|--|--|
84
+ | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-dotnet) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-java) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-php) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-python) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-ruby) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-android) | [GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-swift)|[GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-perl) |[GitHub](https://github.com/aspose-slides-cloud/aspose-slides-cloud-go) |
85
+ | [NuGet](https://www.nuget.org/packages/Aspose.slides-Cloud/) | [Maven](https://repository.aspose.cloud/webapp/#/artifacts/browse/tree/General/repo/com/aspose/aspose-slides-cloud) | [Composer](https://packagist.org/packages/aspose/slides-sdk-php) | [PIP](https://pypi.org/project/asposeslidescloud/) | [GEM](https://rubygems.org/gems/aspose_slides_cloud) | [NPM](https://www.npmjs.com/package/asposeslidescloud) | [Maven](https://repository.aspose.cloud/webapp/#/artifacts/browse/tree/General/repo/com/aspose/aspose-slides-cloud) | [Cocoapods](https://cocoapods.org/pods/AsposeslidesCloud)|[Meta Cpan](https://metacpan.org/release/AsposeSlidesCloud-SlidesApi) | [Go.Dev](https://pkg.go.dev/github.com/aspose-slides-cloud/aspose-slides-cloud-go/) |
86
+
87
+ [Product Page](https://products.aspose.cloud/slides/nodejs) | [Documentation](https://docs.aspose.cloud/display/slidescloud/Home) | [API Reference](https://apireference.aspose.cloud/slides/) | [Code Samples](https://github.com/aspose-slides-cloud/aspose-slides-cloud-nodejs) | [Blog](https://blog.aspose.cloud/category/slides/) | [Free Support](https://forum.aspose.cloud/c/slides) | [Free Trial](https://dashboard.aspose.cloud/#/apps)