@shad0wz7/nestjs-pdf 1.1.0 → 1.1.1

package/dist/index.d.mts

@@ -87,9 +87,51 @@ declare class PuppeteerService {
 declare class NestjsPdfService {
     private readonly puppeteerService;
     constructor(puppeteerService: PuppeteerService);
+    /**
+     * @param html HTML string to convert to PDF
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided HTML
+     * @description This method uses the Puppeteer service to generate a PDF from an HTML string. Generation options can be customized by passing a `PuppeteerParameters` object as the second argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromHtml(html: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param template Handlebars template string
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided Handlebars template with parameters applied
+     * @description This method generates a PDF from a Handlebars template provided as a string. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromTemplateString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param file Path to the Handlebars template file
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the Handlebars template at the provided file path with parameters applied
+     * @description This method generates a PDF from a Handlebars template located at the specified file path. The file path is passed as a string in the `file` parameter. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromTemplateFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param pdf The PDF bytes to modify
+     * @param fieldName The name of the signature field to add (default: 'SignatureDebtor')
+     * @param anchorText The text anchor to locate the signature field position (default: '__SIG_DEBTOR_ANCHOR__')
+     * @returns Modified PDF with a signature field added at the anchor position
+     * @description This method adds a signature field to a PDF using a text anchor as a reference for the field position. It uses the `addSignatureFieldUsingAnchor` function which finds the anchor in the PDF and inserts a signature field at that location. The signature field is named according to the `fieldName` parameter and the anchor is defined by `anchorText`.
+     *
+     * Usage example:
+     * ```typescript
+     * const modifiedPdf = await pdfService.addSignatureFieldSignatureDebtorRaw(
+     *   originalPdfBytes,
+     *   'SignatureDebtor',
+     *   '__SIG_DEBTOR_ANCHOR__'
+     * );
+     * ```
+     *
+     * In this example, `originalPdfBytes` is a byte array representing the original PDF, `SignatureDebtor` is the name of the signature field to add, and `__SIG_DEBTOR_ANCHOR__` is the anchor text used to position the signature field in the PDF.
+     *
+     * If the anchor is not found, the signature field will be added at a default position (centered at the bottom of the last page).
+     *
+     * Note: Ensure that the input PDF contains the anchor defined by `anchorText` for the signature field to be positioned correctly. Otherwise, it will be added at a default position.
+     */
     addSignatureFieldSignatureDebtorRaw(pdf: Uint8Array | Buffer, fieldName?: string, anchorText?: string): Promise<Uint8Array<ArrayBufferLike>>;
 }
 
@@ -116,6 +158,15 @@ declare class PuppeteerHandlebarsModule {
     static forRootAsync(options: PuppeteerHandlebarsModuleAsyncOptions): DynamicModule;
 }
 
+/**
+ * Get the relative path to a value from the module directory.
+ * @param moduleDir the path of the module, typically __dirname
+ * @param relativeToModule the path to the value relative to the module directory
+ * @returns the relative path from the current working directory to the value
+ * @example
+ * getRelativePathToValue(__dirname, './templates/my-template.hbs');
+ * // returns 'context/pdf/templates/my-template.hbs' if the current working directory is '/
+ */
 declare function getRelativePathToValue(moduleDir: string, relativeToModule: string): string;
 
 export { NestjsPdfModule, NestjsPdfService, type PdfLibModuleAsyncOptions, PuppeteerHandlebarsModule, type PuppeteerHandlebarsModuleAsyncOptions, PuppeteerModule, type PuppeteerModuleAsyncOptions, type PuppeteerParameters, PuppeteerService, getRelativePathToValue };

package/dist/index.d.ts

@@ -87,9 +87,51 @@ declare class PuppeteerService {
 declare class NestjsPdfService {
     private readonly puppeteerService;
     constructor(puppeteerService: PuppeteerService);
+    /**
+     * @param html HTML string to convert to PDF
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided HTML
+     * @description This method uses the Puppeteer service to generate a PDF from an HTML string. Generation options can be customized by passing a `PuppeteerParameters` object as the second argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromHtml(html: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param template Handlebars template string
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided Handlebars template with parameters applied
+     * @description This method generates a PDF from a Handlebars template provided as a string. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromTemplateString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param file Path to the Handlebars template file
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the Handlebars template at the provided file path with parameters applied
+     * @description This method generates a PDF from a Handlebars template located at the specified file path. The file path is passed as a string in the `file` parameter. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromTemplateFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param pdf The PDF bytes to modify
+     * @param fieldName The name of the signature field to add (default: 'SignatureDebtor')
+     * @param anchorText The text anchor to locate the signature field position (default: '__SIG_DEBTOR_ANCHOR__')
+     * @returns Modified PDF with a signature field added at the anchor position
+     * @description This method adds a signature field to a PDF using a text anchor as a reference for the field position. It uses the `addSignatureFieldUsingAnchor` function which finds the anchor in the PDF and inserts a signature field at that location. The signature field is named according to the `fieldName` parameter and the anchor is defined by `anchorText`.
+     *
+     * Usage example:
+     * ```typescript
+     * const modifiedPdf = await pdfService.addSignatureFieldSignatureDebtorRaw(
+     *   originalPdfBytes,
+     *   'SignatureDebtor',
+     *   '__SIG_DEBTOR_ANCHOR__'
+     * );
+     * ```
+     *
+     * In this example, `originalPdfBytes` is a byte array representing the original PDF, `SignatureDebtor` is the name of the signature field to add, and `__SIG_DEBTOR_ANCHOR__` is the anchor text used to position the signature field in the PDF.
+     *
+     * If the anchor is not found, the signature field will be added at a default position (centered at the bottom of the last page).
+     *
+     * Note: Ensure that the input PDF contains the anchor defined by `anchorText` for the signature field to be positioned correctly. Otherwise, it will be added at a default position.
+     */
     addSignatureFieldSignatureDebtorRaw(pdf: Uint8Array | Buffer, fieldName?: string, anchorText?: string): Promise<Uint8Array<ArrayBufferLike>>;
 }
 
@@ -116,6 +158,15 @@ declare class PuppeteerHandlebarsModule {
     static forRootAsync(options: PuppeteerHandlebarsModuleAsyncOptions): DynamicModule;
 }
 
+/**
+ * Get the relative path to a value from the module directory.
+ * @param moduleDir the path of the module, typically __dirname
+ * @param relativeToModule the path to the value relative to the module directory
+ * @returns the relative path from the current working directory to the value
+ * @example
+ * getRelativePathToValue(__dirname, './templates/my-template.hbs');
+ * // returns 'context/pdf/templates/my-template.hbs' if the current working directory is '/
+ */
 declare function getRelativePathToValue(moduleDir: string, relativeToModule: string): string;
 
 export { NestjsPdfModule, NestjsPdfService, type PdfLibModuleAsyncOptions, PuppeteerHandlebarsModule, type PuppeteerHandlebarsModuleAsyncOptions, PuppeteerModule, type PuppeteerModuleAsyncOptions, type PuppeteerParameters, PuppeteerService, getRelativePathToValue };