@ironsoftware/ironpdf-engine-macos-arm64 2024.3.1 → 2024.5.1

package/index.js

@@ -1,4 +1,4 @@
-let version = "2024.3.4"
+let version = "2024.5.2"
 let dir = __dirname
 
 

package/{ironpdf-engine-bin-2024.3.4 → ironpdf-engine-bin-2024.5.2}/IronPdf.xml

@@ -1646,6 +1646,122 @@
         <member name="P:IronPdf.ChromePdfRenderOptions.JpegQuality">
             <exclude/>
         </member>
+        <member name="T:IronPdf.Cleaner">
+            <summary>
+            The Cleaner class can be used to scan or sanitize (remove any potentially harmful content) PDF document.
+            </summary>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeWithSvg(System.String)">
+            <summary>
+            Sanitize PDF by convert PDF To an SVG image and convert it back to PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            <list type = "bullet" >
+            <item><description>Quicker than <see cref="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)"/></description></item>
+            <item><description>Resulted as a serachable PDF</description></item>
+            <item><description>Layout might be inconsistency.</description></item>
+            </list>
+            </summary>
+            <param name="pdfFilePath">A PDF File path.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)">
+            <summary>
+            Sanitize PDF by convert PDF To an SVG image and convert it back to PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            <list type = "bullet" >
+            <item><description>Quicker than <see cref="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)"/></description></item>
+            <item><description>Resulted as a serachable PDF</description></item>
+            <item><description>Layout might be inconsistency.</description></item>
+            </list>
+            </summary>
+            <param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeWithBitmap(System.String)">
+            <summary>
+            Sanitize PDF by convert PDF To an Bitmap image and convert it back to PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            </summary>
+            <list type = "bullet" >
+            <item><description>Slower than <see cref="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)"/></description></item>
+            <item><description>Visually look the same</description></item>
+            <item><description>Resulted as a non-serachable PDF</description></item>
+            </list>
+            <param name="pdfFilePath">A PDF File path.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)">
+            <summary>
+            Sanitize PDF by convert PDF To an Bitmap image and convert it back to PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            </summary>
+            <list type = "bullet" >
+            <item><description>Slower than <see cref="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)"/></description></item>
+            <item><description>Visually look the same</description></item>
+            <item><description>Resulted as a non-serachable PDF</description></item>
+            </list>
+            <param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeByRemoveSomeElements(IronPdf.PdfDocument)">
+            <summary>
+            Sanitize PDF by remove some elements from the original PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            </summary>
+            <list type = "bullet" >
+            <item><description>Some function of original PDF might not working</description></item>
+            <item><description>Some content might be missing</description></item>
+            </list>
+            <param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.SanitizeByRecreatePdf(IronPdf.PdfDocument)">
+            <summary>
+            Sanitize PDF by re-create PDF document with only text and image from the original PDF.
+            Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
+            </summary>
+            <param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
+        </member>
+        <member name="M:IronPdf.Cleaner.ScanPdf(System.String,System.String[])">
+            <summary>
+            Scan for any risk that might exists in a PDF. 
+            </summary>
+            <param name="pdfFilePath">A PDF File path</param>
+            <param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
+            <returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
+        </member>
+        <member name="M:IronPdf.Cleaner.ScanPdf(System.Byte[],System.String[])">
+            <summary>
+            Scan for any risk that might exists in a PDF. 
+            </summary>
+            <param name="pdfBytes">a PDF bytes</param>
+            <param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
+            <returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
+        </member>
+        <member name="M:IronPdf.Cleaner.ScanPdf(IronPdf.PdfDocument,System.String[])">
+            <summary>
+            Scan for any risk that might exists in a PDF. 
+            </summary>
+            <param name="pdfDocument">a PdfDocument object</param>
+            <param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
+            <returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
+        </member>
+        <member name="T:IronPdf.CleanerScanResult">
+            <summary>
+            Result from Cleaner scan functions. E.g. <see cref="M:IronPdf.Cleaner.ScanPdf(IronPdf.PdfDocument,System.String[])"/>
+            </summary>
+        </member>
+        <member name="P:IronPdf.CleanerScanResult.IsDetected">
+            <summary>
+            Is any risk was found
+            </summary>
+        </member>
+        <member name="P:IronPdf.CleanerScanResult.Risks">
+            <summary>
+            A list of risk that has been detected.
+            </summary>
+        </member>
+        <member name="M:IronPdf.CleanerScanResult.ToString">
+            <summary>
+            A text summary of CleanerScanResult 
+            </summary>
+            <returns>A text summary of CleanerScanResult </returns>
+        </member>
         <member name="T:IronPdf.Deployment.ExternalSettings">
             <summary>
             This class will search for a class named "IronPdfExternalSettings" in all assembly and try to get the settings from that class
@@ -3129,12 +3245,7 @@
             then destroys the render.
             </summary>
         </member>
-        <member name="M:IronPdf.Engines.Chrome.LocalChromeClient.FormatAndRenderStaticHtmlHeaderFooter(IronSoftware.IPdfDocumentId,IronPdf.ChromePdfRenderOptions,IronPdf.Engines.Chrome.CefRenderSettings,IronPdf.Engines.Chrome.CefBrowserSettings,System.Int32,System.String,System.String,System.Int32,System.Int32,IronSoftware.Drawing.Color,IronSoftware.Drawing.Color,System.ValueTuple{System.Double,System.Double},System.Int32)">
-            <summary>
-            Performs the actual formatting and rendering of a static HTML Header/Footer. Involves setting the correct dimensions on the page, replacing text, and performing the actual rendering.
-            </summary>
-        </member>
-        <member name="M:IronPdf.Engines.Chrome.LocalChromeClient.FormatAndRenderDynamicHtmlHeaderFooter(IronSoftware.IPdfDocumentId,IronPdf.ChromePdfRenderOptions,IronPdf.Engines.Chrome.CefRenderSettings,IronPdf.Engines.Chrome.CefBrowserSettings,System.Int32,System.String,System.String,System.Int32,System.Int32,IronSoftware.Drawing.Color,IronSoftware.Drawing.Color,System.ValueTuple{System.Double,System.Double},System.Collections.Generic.List{System.Int32})">
+        <member name="M:IronPdf.Engines.Chrome.LocalChromeClient.FormatAndRenderHtmlHeaderFooter(IronSoftware.IPdfDocumentId,IronPdf.ChromePdfRenderOptions,IronPdf.Engines.Chrome.CefRenderSettings,IronPdf.Engines.Chrome.CefBrowserSettings,System.Int32,System.String,System.String,System.Int32,System.Int32,IronSoftware.Drawing.Color,IronSoftware.Drawing.Color,System.ValueTuple{System.Double,System.Double},System.Collections.Generic.List{System.Int32})">
             <summary>
             Performs the actual formatting and rendering of a dynamic HTML Header/Footer. Involves setting the correct dimensions on the page, replacing text, and performing the actual rendering.
             </summary>
@@ -5068,6 +5179,13 @@
             <param name="DesiredHeights">Desired heights</param>
             <param name="PixelFormat">Pixel format</param>
         </member>
+        <member name="M:IronPdf.PdfDocument.Compress(IronPdf.CompressionOptions)">
+            <summary>
+            Compress the PDF document using the specified options
+            </summary>
+            <param name="Options">Compression options. See <see cref="T:IronPdf.CompressionOptions"/></param>
+            <remarks>Compression can drastically reduce the size of a document by removing unused features or by reducing quality.</remarks>
+        </member>
         <member name="M:IronPdf.PdfDocument.CompressImages(System.Int32,System.Boolean,System.Boolean)">
             <summary>
             Compress existing images using JPG encoding and the specified settings
@@ -5570,23 +5688,12 @@
             <returns>The number of printed pages.</returns>
             <seealso cref="M:IronPdf.PdfDocument.GetPrintDocument(System.Drawing.Printing.PrinterSettings,System.Drawing.Printing.PrintController)"/>
         </member>
-        <member name="M:IronPdf.PdfDocument.Print(System.Int32)">
-            <summary>
-            Prints this PDF by sending it to the computer's printer.   <para>For even more advanced real-world printing
-            options please see overloads of this method and also <see cref="M:IronPdf.PdfDocument.GetPrintDocument(System.Drawing.Printing.PrinterSettings,System.Drawing.Printing.PrintController)"/>.</para> 
-            <para>Note: '<see cref="M:IronPdf.PdfDocument.Print(System.Int32)"/>'  is only supported on: 'Windows'.</para>
-            <param name="dpi">the horizontal and vertical PDF resolutions, in dots per inch. if <c>-1</c> print with default
-            printer resolution. Default value is <c>-1</c>.</param> 
-            </summary>
-            <returns>The number of printed pages.</returns>
-            <seealso cref="M:IronPdf.PdfDocument.GetPrintDocument(System.Drawing.Printing.PrinterSettings,System.Drawing.Printing.PrintController)"/>
-        </member>
         <member name="M:IronPdf.PdfDocument.Print(System.String)">
             <summary>
             Prints this PDF by sending it to the computer's printer.   <para>For even more advanced real-world printing
             options please see overloads of this method and also <see cref="M:IronPdf.PdfDocument.GetPrintDocument(System.Drawing.Printing.PrinterSettings,System.Drawing.Printing.PrintController)"/>.</para> 
             <para>Note: '<see cref="M:IronPdf.PdfDocument.Print(System.String)"/>' is only supported on: 'Windows'.</para>
-            <param name="printerName">the name of a printer, set<see langword="null"/> or an empty string ("") to use default print. Default value is <see langword="null"/>.</param> 
+            <param name="PrinterName">the name of a printer, set<see langword="null"/> or an empty string ("") to use default print. Default value is <see langword="null"/>.</param> 
             </summary>
             <returns>The number of printed pages.</returns>
             <seealso cref="M:IronPdf.PdfDocument.GetPrintDocument(System.Drawing.Printing.PrinterSettings,System.Drawing.Printing.PrintController)"/>
@@ -5598,9 +5705,9 @@
             <para>Note: '<see cref="M:IronPdf.PdfDocument.Print(System.Int32,System.String,System.String)"/>' is only supported on: 'Windows'.</para>
             <param name="dpi">the horizontal and vertical PDF resolutions, in dots per inch. if <c>-1</c> print with default
             printer resolution. Default value is <c>-1</c>.</param> 
-            <param name="printerName">the name of a printer, set<see langword="null"/> or an empty string ("") to use default print. Default value is <see langword="null"/>.</param> 
-            <param name="filePath">the file path, when printing to a file, set <see angword="null"/> or an empty string ("") for printing output is sent to a port instead of the 
-            <paramref name="filePath"/>. The default value is <see langword="null"/>.</param> 
+            <param name="PrinterName">the name of a printer, set<see langword="null"/> or an empty string ("") to use default print. Default value is <see langword="null"/>.</param> 
+            <param name="FilePath">the file path, when printing to a file, set <see angword="null"/> or an empty string ("") for printing output is sent to a port instead of the 
+            <paramref name="FilePath"/>. The default value is <see langword="null"/>.</param> 
             </summary>
             <returns>The number of printed pages.</returns>
             <seealso cref="M:IronPdf.PdfDocument.GetPrintDocument(System.Drawing.Printing.PrinterSettings,System.Drawing.Printing.PrintController)"/>
@@ -5642,24 +5749,6 @@
             <returns>The number of printed pages.</returns>
             <seealso cref="M:IronPdf.PdfDocument.GetPrintDocument(System.Drawing.Printing.PrinterSettings,System.Drawing.Printing.PrintController)"/>
         </member>
-        <member name="M:IronPdf.PdfDocument.Print(System.Boolean)">
-            <exclude />
-        </member>
-        <member name="M:IronPdf.PdfDocument.Print(System.Int32,System.Boolean)">
-            <exclude />
-        </member>
-        <member name="M:IronPdf.PdfDocument.PrintToFile(System.String,System.Boolean)">
-            <exclude />
-        </member>
-        <member name="M:IronPdf.PdfDocument.PrintToFile(System.Int32,System.String,System.Boolean)">
-            <exclude />
-        </member>
-        <member name="M:IronPdf.PdfDocument.Print(System.String,System.Boolean)">
-            <exclude />
-        </member>
-        <member name="M:IronPdf.PdfDocument.Print(System.Int32,System.String,System.String,System.Boolean)">
-            <exclude />
-        </member>
         <member name="M:IronPdf.PdfDocument.RemovePage(System.Int32)">
             <summary>
             Removes a page from the PDF at the given index.
@@ -6481,6 +6570,11 @@
             Disables AppAnalytics for IronPdf. Limitations apply.
             </summary>
         </member>
+        <member name="M:IronPdf.License.AssertLicense">
+            <summary>
+            Throw exceltion if license is not set.
+            </summary>
+        </member>
         <member name="T:IronPdf.Pages.LineTextObject">
             <summary>
             Represents a line of text within a document
@@ -6625,6 +6719,42 @@
             The count of pages.
             </value>
         </member>
+        <member name="T:IronPdf.CompressionOptions">
+            <summary>
+            Various compression options for reducing the size of a PDF document
+            </summary>
+        </member>
+        <member name="P:IronPdf.CompressionOptions.CompressImages">
+            <summary>
+            Compress existing images using JPG encoding and the specified settings
+            </summary>
+        </member>
+        <member name="P:IronPdf.CompressionOptions.RemoveStructureTree">
+            <summary>
+            Remove document struct tree information which describes the logical layout of the document.
+            <para>
+            Removing the "structure tree" can significantly reduce the disk space used by the document.
+            </para>
+            <para>
+            Removing the "structure tree" of a complicated document can negatively impact text selection.
+            </para>
+            </summary>
+        </member>
+        <member name="P:IronPdf.CompressionOptions.ShrinkImages">
+            <summary>
+            Scale down the image resolution according to its visible size in the PDF document. This will drastically reduce the size and quality of the images.
+            </summary>
+        </member>
+        <member name="P:IronPdf.CompressionOptions.HighQualityImageSubsampling">
+            <summary>
+            True to use 444 chroma subsampling for a higher quality image. False to use 411 chrome subsampling to further reduce the image size.
+            </summary>
+        </member>
+        <member name="P:IronPdf.CompressionOptions.JpegQuality">
+            <summary>
+            JPEG quality (1 - 100) to use during image compression
+            </summary>
+        </member>
         <member name="T:IronPdf.PdfClientAccessor">
             <summary>
             Accesses PDF client implementations
@@ -7117,6 +7247,13 @@
             <param name="headerQueue">A queue of headers.</param>
             <returns>An enumeration of page numbers.</returns>
         </member>
+        <member name="M:IronPdf.TableOfContents.TableOfContentsHelper.GetTableOnContentsPageIndices(IronPdf.PdfDocument)">
+            <summary>
+            Find the page indices on which Table of Contents is shown by looking for link annotations.
+            </summary>
+            <param name="document">The PDF document to search.</param>
+            <returns>A list if page indices for pages that display the Table of Contents.</returns>
+        </member>
         <member name="M:IronPdf.TableOfContents.TableOfContentsHelper.ParseHeaders(System.String)">
             <summary>
             Parse all headers from an HTML string. 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@ironsoftware/ironpdf-engine-macos-arm64",
-	"version": "2024.3.1",
-	"ironPdfEngineVersion": "2024.3.4",
+	"version": "2024.5.1",
+	"ironPdfEngineVersion": "2024.5.2",
 	"homepage": "https://ironpdf.com/nodejs",
 	"platform": "MacOS",
 	"arch": "arm64",