Initial examples implementation

RakhimAimaganbetov · MrRakhim · yevgen-nykytenko · web-flow · commit 781354bc145e · 2023-07-20T18:32:12.000+05:00
* initial commit * initial commit #2 * add gitignore * add dependency dowloader, module & lowerize the method names * Update README.md * Update README.md * update Readme.md * make all files camelCased * remove dsStores & move runExample into examples * Update README.md * interacting with a published package * update readme.md * process files without license --------- Co-authored-by: Rakhim <rz.aimaganbetov@gmail.com> Co-authored-by: Yevgen Nykytenko <yevgen.nykytenko@aspose.com>
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,45 @@
+### VisualStudioCode ###
+.vscode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+# Ignore all local history of files
+.history
+.ionide
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+Output
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
diff --git a/Examples/AdvancedUsage/ConvertToPdfWithAdvancedOptions.js b/Examples/AdvancedUsage/ConvertToPdfWithAdvancedOptions.js
@@ -0,0 +1,24 @@
+/**
+ * This example demonstrates how to convert DOCX file into PDF format with advanced options.
+ * For more details about Microsoft Word Open XML Document (.docx) to Portable Document (.pdf) conversion please check this documentation article 
+ * https://docs.groupdocs.com/conversion
+ */
+async function convertToPdfWithAdvancedOptions(groupdocs, inputFilePath) {
+  const loadOptions = new groupdocs.conversion.WordProcessingLoadOptions()
+  loadOptions.setPassword('12345')
+
+  const converter = new groupdocs.conversion.Converter(inputFilePath, loadOptions)
+
+  const outputPath = `${groupdocs.outputFolder}/ConvertToPdfWithAdvancedOptions.pdf`
+  const convertOptions = new groupdocs.conversion.PdfConvertOptions()
+  convertOptions.setPageNumber(2)
+  convertOptions.setPagesCount(1)
+  convertOptions.setRotate(groupdocs.conversion.Rotation.On180)
+  convertOptions.setDpi(300)
+  convertOptions.setWidth(1024)
+  convertOptions.setHeight(768)
+  console.log(`Converted to ${outputPath}`)
+  return converter.convert(outputPath, convertOptions)
+}
+
+module.exports = convertToPdfWithAdvancedOptions
diff --git a/Examples/BasicUsage/ConvertToPdf.js b/Examples/BasicUsage/ConvertToPdf.js
@@ -0,0 +1,15 @@
+/**
+ * This example demonstrates how to convert DOCX file into PDF format.
+ * For more details about Microsoft Word Open XML Document (.docx) to Portable Document (.pdf) conversion please check this documentation article 
+ * https://docs.groupdocs.com/conversion
+ */
+async function convertToPdf(groupdocs, inputFilePath) {
+  const converter = new groupdocs.conversion.Converter(inputFilePath)
+  const convertOptions = new groupdocs.conversion.PdfConvertOptions()
+  const outputPath = `${groupdocs.outputFolder}/output.pdf`
+
+  console.log(`Converted to ${outputPath}`)
+  return converter.convert(outputPath, convertOptions)
+}
+
+module.exports = convertToPdf
diff --git a/Examples/BasicUsage/ConvertToPresentation.js b/Examples/BasicUsage/ConvertToPresentation.js
@@ -0,0 +1,15 @@
+/**
+ * This example demonstrates how to convert DOCX file into PPTX format.
+ * For more details about Microsoft Word Open XML Document (.docx) to PowerPoint Open XML Presentation (.pptx) conversion please check this documentation article 
+ * https://docs.groupdocs.com/conversion
+ */
+async function convertToPresentation(groupdocs, inputFilePath) {
+  const converter = new groupdocs.conversion.Converter(inputFilePath)
+  const convertOptions = new groupdocs.conversion.PresentationConvertOptions()
+  const outputPath = `${groupdocs.outputFolder}/output.pptx`
+
+  console.log(`Converted to ${outputPath}`)
+  return converter.convert(outputPath, convertOptions)
+}
+
+module.exports = convertToPresentation
diff --git a/Examples/BasicUsage/ConvertToSpreadsheet.js b/Examples/BasicUsage/ConvertToSpreadsheet.js
@@ -0,0 +1,15 @@
+/**
+ * This example demonstrates how to convert DOCX file into XLSX format.
+ * For more details about Microsoft Word Open XML Document (.docx) to Microsoft Excel Open XML Spreadsheet (.xlsx) conversion please check this documentation article 
+ * https://docs.groupdocs.com/conversion
+ */
+async function convertToSpreadsheet(groupdocs, inputFilePath) {
+  const converter = new groupdocs.conversion.Converter(inputFilePath)
+  const convertOptions = new groupdocs.conversion.SpreadsheetConvertOptions()
+  const outputPath = `${groupdocs.outputFolder}/output.xlsx`
+
+  console.log(`Converted to ${outputPath}`)
+  return converter.convert(outputPath, convertOptions)
+}
+
+module.exports = convertToSpreadsheet
diff --git a/Examples/BasicUsage/ConvertToWordProcessing.js b/Examples/BasicUsage/ConvertToWordProcessing.js
@@ -0,0 +1,15 @@
+/**
+ * This example demonstrates how to convert PDF file into DOCX format.
+ * For more details about Portable Document (.pdf) to Microsoft Word Open XML Document (.docx) conversion please check this documentation article 
+ * https://docs.groupdocs.com/conversion
+ */
+async function convertToWordProcessing(groupdocs, inputFilePath) {
+  const converter = new groupdocs.conversion.Converter(inputFilePath)
+  const convertOptions = new groupdocs.conversion.WordProcessingConvertOptions()
+  const outputPath = `${groupdocs.outputFolder}/output.docx`
+
+  console.log(`Converted to ${outputPath}`)
+  return converter.convert(outputPath, convertOptions)
+}
+
+module.exports = convertToWordProcessing
diff --git a/Examples/BasicUsage/GetPossibleConversions.js b/Examples/BasicUsage/GetPossibleConversions.js
@@ -0,0 +1,32 @@
+const util = require('util')
+
+/**
+ * This example demonstrates how to get to what formats the source document could be converted
+ */
+function getPossibleConversions(groupdocs, inputFilePath) {
+  const converter = new groupdocs.conversion.Converter(inputFilePath)
+  const conversions = converter.getPossibleConversions()
+  console.log(
+    util.format(
+      '%s is of type %s and could be converted to:\n',
+      inputFilePath,
+      conversions.getSource().getExtension()
+    )
+  )
+
+  const items = conversions.getAll()
+  console.log(items)
+
+  items.spliterator().getExactSizeIfKnown()
+
+  for (let i = 0; i < items.size(); i += 1) {
+    const item = items.get(i)
+    console.log(
+      `\t ${item.getFormat().getExtension()} as ${
+        item.isPrimary() ? 'primary' : 'secondary'
+      } conversion.\n`
+    )
+  }
+}
+
+module.exports = getPossibleConversions
diff --git a/Examples/BasicUsage/convertToImagePng.js b/Examples/BasicUsage/convertToImagePng.js
@@ -0,0 +1,23 @@
+const util = require('util')
+const fs = require('fs')
+
+/** 
+ * This example demonstrates how to convert DOCX file into PNG format.
+ * For more details about Microsoft Word Open XML Document (.docx) to Portable Network Graphic (.png) conversion please check this documentation article 
+ * https://docs.groupdocs.com/conversion
+ */
+async function convertToImagePng(groupdocs, inputFilePath, outputFolder) {
+  const outputFileTemplate = `${outputFolder}/converted-page-%d.png`
+
+  const getPageStream = fs.createWriteStream(util.format(outputFileTemplate, 1))
+  const converter = new groupdocs.conversion.Converter(inputFilePath)
+
+  const convertOptions = new groupdocs.conversion.ImageConvertOptions()
+  convertOptions.setFormat(groupdocs.conversion.ImageFileType.Png)
+  convertOptions.setPagesCount(1)
+
+  console.log(`Converted to ${outputFolder}`)
+  return converter.convert(getPageStream, convertOptions)
+}
+
+module.exports = convertToImagePng
diff --git a/Examples/BasicUsage/getSourceDocumenInfo.js b/Examples/BasicUsage/getSourceDocumenInfo.js
@@ -0,0 +1,21 @@
+/**
+ * This example demonstrates how to get basic information about source document.
+ */
+function getSourceDocumentInfo(groupdocs, inputFilePath) {
+  const converter = new groupdocs.conversion.Converter(inputFilePath)
+  const pdfInfo = converter.getDocumentInfo()
+
+  console.log(`Author: ${pdfInfo.getAuthor()}`)
+  console.log(`Creation date: ${pdfInfo.getCreationDate()}`)
+  console.log(`Title: ${pdfInfo.getTitle()}`)
+  console.log(`Version: ${pdfInfo.getVersion()}`)
+  console.log(`Pages count: ${pdfInfo.getPagesCount()}`)
+  console.log(`Width: ${pdfInfo.getWidth()}`)
+  console.log(`Height: ${pdfInfo.getHeight()}`)
+  console.log(`Is landscaped: ${pdfInfo.isLandscape()}`)
+  console.log(`Is Encrypted: ${pdfInfo.isPasswordProtected()}`)
+
+  console.log('\nDocument info retrieved successfully.')
+}
+
+module.exports = getSourceDocumentInfo
diff --git a/Examples/QuickStart/SetLicense.js b/Examples/QuickStart/SetLicense.js
@@ -0,0 +1,27 @@
+const fs = require('fs')
+
+/**
+ * This example demonstrates how to set license from stream.
+ */
+async function setLicense(groupdocs, licensePath) {
+  const lic = new groupdocs.conversion.License()
+  const readStream = fs.createReadStream(licensePath)
+
+  return new Promise((resolve, reject) =>
+    // eslint-disable-next-line no-promise-executor-return
+    groupdocs.conversion.License.setLicenseFromStream(lic, readStream, err => {
+      if (err) {
+        console.log("\nWe do not ship any license with this example. " +
+        "\nVisit the GroupDocs site to obtain either a temporary or permanent license. " +
+        "\nLearn more about licensing at https://purchase.groupdocs.com/faqs/licensing. " +
+        "\nLear how to request temporary license at https://purchase.groupdocs.com/temporary-license.");
+        resolve()
+      } else {
+        console.log('License set successfully.')
+        resolve()
+      }
+    })
+  )
+}
+
+module.exports = setLicense
diff --git a/Examples/Resources/SampleFiles/password_protected.docx b/Examples/Resources/SampleFiles/password_protected.docx
diff --git a/Examples/Resources/SampleFiles/sample.docx b/Examples/Resources/SampleFiles/sample.docx
diff --git a/Examples/Resources/SampleFiles/sample.pdf b/Examples/Resources/SampleFiles/sample.pdf
diff --git a/Examples/constants.js b/Examples/constants.js
@@ -0,0 +1,11 @@
+const path = require('path')
+const SamplePath = path.join(__dirname, './Resources/SampleFiles')
+
+module.exports = {
+  LicensePath: '',
+  SamplePath,
+  OutputPath: path.join(__dirname, 'Output'),
+  SAMPLE_DOCX: SamplePath + '/sample.docx',
+  SAMPLE_PDF: SamplePath + '/sample.pdf',
+  SAMPLE_DOCX_WITH_PASSWORD: SamplePath + '/password_protected.docx'
+}
diff --git a/Examples/conversionExamples.js b/Examples/conversionExamples.js
@@ -0,0 +1,88 @@
+const fs = require('fs')
+
+const conversion = require('@groupdocs/groupdocs.conversion')
+
+// Constant Variables 
+const Constants = require('./constants')
+
+// Basic Methods
+const getPossibleConversions = require('./BasicUsage/getPossibleConversions')
+const getSourceDocumentInfo = require('./BasicUsage/getSourceDocumenInfo')
+const setLicense = require('./QuickStart/setLicense')
+
+// Conversion Methods
+const convertToPdf = require('./BasicUsage/convertToPdf')
+const convertToWordProcessing = require('./BasicUsage/convertToWordProcessing')
+const convertToSpreadsheet = require('./BasicUsage/convertToSpreadsheet')
+const convertToPresentation = require('./BasicUsage/convertToPresentation')
+const convertToPdfWithAdvancedOptions = require('./AdvancedUsage/convertToPdfWithAdvancedOptions')
+
+class ConversionExamples {
+  constructor() {
+    // Initialize the License
+    let lic = Constants.LicensePath
+    if (!lic || !lic.endsWith('.lic')) console.log('License is not found, continuing with demo version!')
+    else this.licensePath = lic
+
+    // Initialize the model
+    this.conversion = conversion
+
+    // Initialize files
+    this.initializeInputFiles()
+    this.initializeOutputFolder()
+  }
+
+  initializeInputFiles() {
+    this.inputFiles = {
+      samplePdf: Constants.SAMPLE_PDF,
+      sampleDocx: Constants.SAMPLE_DOCX,
+      sampleDocxPasswordProtected: Constants.SAMPLE_DOCX_WITH_PASSWORD,
+    }
+  }
+
+  initializeOutputFolder() {
+    this.outputFolder = Constants.OutputPath
+    try {
+      if (!fs.existsSync(this.outputFolder)) fs.mkdirSync(this.outputFolder)
+    } catch (error) {
+      console.error(error)
+    }
+  }
+
+  getPossibleConversions(inputFilePath = '') {
+    return getPossibleConversions(this, inputFilePath || this.inputFiles.samplePdf)
+  }
+
+  getSourceDocumentInfo(inputFilePath = '') {
+    return getSourceDocumentInfo(this, inputFilePath || this.inputFiles.samplePdf)
+  }
+
+  async setLicense(licensePath = '') {
+    if (this.licensePath) return setLicense(this, licensePath || this.licensePath)
+  }
+
+  async convertToPdf(inputFilePath = '') {
+    return convertToPdf(this, inputFilePath || this.inputFiles.sampleDocx)
+  }
+
+  async convertToPresentation(inputFilePath = '') {
+    return convertToPresentation(this, inputFilePath || this.inputFiles.sampleDocx)
+  }
+
+  async convertToSpreadsheet(inputFilePath = '') {
+    return convertToSpreadsheet(this, inputFilePath || this.inputFiles.sampleDocx)
+  }
+
+  async convertToWordProcessing(inputFilePath = '') {
+    return convertToWordProcessing(this, inputFilePath || this.inputFiles.samplePdf)
+  }
+
+  async convertToPdfWithAdvancedOptions(inputFilePath = '') {
+    return convertToPdfWithAdvancedOptions(
+      this,
+      inputFilePath || this.inputFiles.sampleDocxPasswordProtected
+    )
+  }
+}
+
+module.exports = new ConversionExamples()
diff --git a/Examples/runExamples.js b/Examples/runExamples.js
@@ -0,0 +1,28 @@
+const examples = require('./conversionExamples')
+
+// CALL EXAMPLES
+
+examples.getPossibleConversions()
+examples.getSourceDocumentInfo()
+;(async () => {
+  try {
+    console.log('Start conversion. \nIn Main() method uncomment the example that you want to run.')
+    await examples.setLicense() // You can pass the licensePath as an argument, it's optional
+
+    await Promise.all([
+      // NOTE: Please uncomment the example you want to try out
+      // Basic usage
+      examples.convertToPdf(),
+      examples.convertToPresentation(),
+      examples.convertToSpreadsheet(),
+      examples.convertToWordProcessing(),
+      // Advanced usage
+      examples.convertToPdfWithAdvancedOptions(),
+    ])
+    console.log('The end of process.')
+    process.exit(0)
+  } catch (err) {
+    console.error(err)
+    process.exit(1)
+  }
+})()
diff --git a/README.md b/README.md
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
