rewrite

Author: moofoo

.gitignore

@@ -14,6 +14,8 @@ lerna-debug.log*
 # OS
 .DS_Store
 
+.clinic
+
 # Tests
 /coverage
 /.nyc_output

README.md

@@ -53,25 +53,6 @@ Well, in terms of pure document generation chops (not talking about templating b
 
 However, unlike those services, JSReports does not gatekeep **ANY** functionality behind payment tiers. Rather, their business model is oriented around usage of their 'Studio' template builder GUI, which has SaaS and self-hosted versions, while the JSReport server code itself is completely open source and accessible.
 
-So, by making use of the [jsreport core package](https://github.com/jsreport/jsreport/tree/master/packages/jsreport-core), and with shockingly little effort, you can have self-hosted document generation that's on-par with any SaaS out there. **For $0.00.**
+So, by making use of the [jsreport core package](https://github.com/jsreport/jsreport/tree/master/packages/jsreport-core) you can have self-hosted document generation that's on-par with any SaaS out there.
 
-The [JSReport Studio GUI](https://playground.jsreport.net/w/admin/S3xqZ0Zc) is actually quite good, if that's something you're looking for. Very 'developer oriented' and flexible, unlike other templating backends I've tried (which are usually intended for document creators, not devs).
-
-## Notes
-
-- Passing a string of javascript to create custom template handlers seems...kinda weird? Am I missing something? I suppose it makes more sense in the context of the Studio GUI.
-
-- Note how the jsreport instance config affects the asset placeholder paths in [template.html](src/jsreport/examples/flight-ticket/template.html). Specifically the `rootDirectory` option:
-
-```typescript
-this.jsreport = require('@jsreport/jsreport-core')({
-  sandbox: { allowedModules: '*' },
-  rootDirectory: __dirname,
-  extensions: {
-    assets: {
-      allowedFiles: '**/*.*',
-      searchOnDiskIfNotFoundInStore: true,
-    },
-  },
-});
-```
+The [JSReport Studio GUI](https://playground.jsreport.net/w/admin/S3xqZ0Zc) is actually quite good, if that's something you're looking for.

nest-cli.json

@@ -2,5 +2,5 @@
   "$schema": "https://json.schemastore.org/nest-cli",
   "collection": "@nestjs/schematics",
   "sourceRoot": "src",
-  "compilerOptions": {"assets": ["**/template.*",  "**/*.png", "**/*.css"]}
+  "compilerOptions": {"assets": ["**/template.*",  "**/*.png", "**/*.css", "**/*.config.json"]}
 }

package.json

@@ -24,20 +24,23 @@
     "@jsreport/jsreport-chrome-pdf": "^3.3.0",
     "@jsreport/jsreport-core": "^3.11.4",
     "@jsreport/jsreport-docx": "^3.7.1",
+    "@jsreport/jsreport-fs-store": "^3.2.4",
     "@jsreport/jsreport-handlebars": "^3.2.1",
     "@jsreport/jsreport-html-to-xlsx": "^3.3.1",
     "@jsreport/jsreport-unoconv": "^3.0.1",
     "@jsreport/jsreport-xlsx": "^3.4.0",
     "@nestjs/common": "^9.4.2",
     "@nestjs/core": "^9.4.2",
     "@nestjs/platform-express": "^9.4.2",
+    "@nestjs/terminus": "^9.2.2",
     "bwip-js": "^3.4.0",
     "handlebars": "^4.7.7",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
     "puppeteer": "^20.4.0",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.1",
+    "v8": "^0.1.0",
     "xlsx": "^0.18.5"
   },
   "devDependencies": {

src/app.module.ts

@@ -1,7 +1,6 @@
 import { Module } from '@nestjs/common';
 import { AppController } from './app.controller';
-import { JsReportModule } from './jsreport/jsreport.module';
-
+import { JsReportModule } from './js-report/js-report.module';
 @Module({
   imports: [JsReportModule],
   controllers: [AppController],

src/js-report/helpers/asset.helper.ts

@@ -0,0 +1,97 @@
+import { JsReporter } from '../js-report.provider';
+import fs from 'fs';
+
+export class AssetHelper {
+  private readonly jsReport: JsReporter;
+
+  constructor(jsReport: JsReporter) {
+    this.jsReport = jsReport;
+  }
+
+  async stored(name: string) {
+    const result = await this.jsReport.documentStore
+      .collection('assets')
+      .find({ name });
+
+    return result.length > 0;
+  }
+
+  async insert(asset: {
+    name: string;
+    path?: string;
+    content?: any;
+    encoding?: string;
+  }) {
+    const isStored = await this.stored(asset.name);
+
+    if (!isStored) {
+      if (asset.path && !asset.content) {
+        asset.content = fs.readFileSync(asset.path, asset.encoding as any);
+      }
+    }
+
+    await this.jsReport.documentStore.collection('assets').insert(asset);
+  }
+
+  async insertAll(
+    assets: Array<{
+      name: string;
+      path?: string;
+      content?: any;
+      encoding?: string;
+    }>,
+  ) {
+    for (const asset of assets) {
+      await this.insert(asset);
+    }
+  }
+
+  async upsert(asset: {
+    name: string;
+    path?: string;
+    content?: any;
+    encoding?: string;
+  }) {
+    const isStored = await this.stored(asset.name);
+
+    if (!isStored) {
+      await this.insert(asset);
+    } else {
+      if (asset.path && !asset.content) {
+        asset.content = fs.readFileSync(asset.path, asset.encoding as any);
+      }
+
+      await this.jsReport.documentStore
+        .collection('assets')
+        .update(
+          { name: asset.name },
+          { $set: { content: asset.content, encoding: asset.encoding } },
+        );
+    }
+  }
+
+  async remove(name: string) {
+    const isStored = await this.stored(name);
+
+    if (isStored) {
+      await this.jsReport.documentStore.collection('assets').remove({ name });
+    }
+  }
+
+  async find(name: string) {
+    const isStored = await this.stored(name);
+
+    if (isStored) {
+      const found = await this.jsReport.documentStore
+        .collection('assets')
+        .find({ name });
+
+      return found[found.length - 1] as {
+        name: string;
+        path?: string;
+        content?: any;
+        encoding?: string;
+      };
+    }
+  }
+}

src/js-report/helpers/template.helper.ts

@@ -0,0 +1,69 @@
+import { JsReporter } from '../js-report.provider';
+
+import { Named } from '../types';
+
+export class TemplateHelper {
+  private readonly jsReport: JsReporter;
+
+  constructor(jsReport: JsReporter) {
+    this.jsReport = jsReport;
+  }
+
+  async stored(name: string) {
+    const result = await this.jsReport.documentStore
+      .collection('templates')
+      .find({ name });
+
+    return result.length > 0;
+  }
+
+  async insertFn<T = unknown>(name: string, templateFn: () => Named & T) {
+    const isStored = await this.stored(name);
+    if (!isStored) {
+      await this.insert(templateFn());
+    }
+  }
+
+  async insert<T = unknown>(template: Named & T) {
+    const isStored = await this.stored(template.name);
+    if (!isStored) {
+      await this.jsReport.documentStore
+        .collection('templates')
+        .insert(template);
+    }
+  }
+
+  async upsert<T = unknown>(template: Named & T) {
+    const isStored = await this.stored(template.name);
+
+    if (!isStored) {
+      await this.insert(template);
+    } else {
+      await this.jsReport.documentStore
+        .collection('templates')
+        .update({ name: template.name }, { $set: template });
+    }
+  }
+
+  async remove(name: string) {
+    const isStored = await this.stored(name);
+
+    if (isStored) {
+      await this.jsReport.documentStore
+        .collection('templates')
+        .remove({ name });
+    }
+  }
+
+  async find<T = unknown>(name: string) {
+    const isStored = await this.stored(name);
+
+    if (isStored) {
+      const found = await this.jsReport.documentStore
+        .collection('templates')
+        .find({ name });
+
+      return found[found.length - 1] as Named & T;
+    }
+  }
+}

src/jsreport/jsreport.controller.ts src/js-report/js-report.controller.tssrc/jsreport/jsreport.controller.ts renamed to src/js-report/js-report.controller.ts

@@ -1,10 +1,30 @@
 import { Controller, Res, Get, Query, StreamableFile } from '@nestjs/common';
-import { JsReportService } from './jsreport.service';
 import { Response } from 'express';
+import * as Reports from './reports';
+import { JsReportResult } from './types';
 
 @Controller('reports')
 export class JsReportController {
-  constructor(private readonly jsreport: JsReportService) {}
+  constructor(
+    private student: Reports.StudentReport,
+    private population: Reports.PopulationReport,
+    private ticket: Reports.TicketReport,
+    private html: Reports.HtmlToXlsxReport,
+    private invoice: Reports.InvoiceReport,
+    private invoiceXlsx: Reports.InvoiceXlsxReport,
+  ) {}
+
+  getContentHeaders(result: JsReportResult, pdf = false, defaultType = 'docx') {
+    return {
+      'Content-Type': pdf
+        ? 'application/pdf'
+        : `${result.meta.contentType}; charset=utf-8`,
+      'Content-Disposition': `attachment; filename="${result.meta.reportName}.${
+        pdf ? 'pdf' : defaultType
+      }"`,
+      'Content-Length': result.content.byteLength,
+    };
+  }
 
   // student docx ///////////////////////////
   @Get('/student')
@@ -14,9 +34,9 @@ export class JsReportController {
   ) {
     const pdf = query?.pdf === '1' ? true : false;
 
-    const result = await this.jsreport.renderStudent(pdf);
+    const result = await this.student.render(pdf);
 
-    res.set(this.jsreport.getContentHeaders(result, pdf, 'docx'));
+    res.set(this.getContentHeaders(result, pdf, 'docx'));
 
     return new StreamableFile(result.stream as any);
   }
@@ -29,9 +49,9 @@ export class JsReportController {
   ) {
     const pdf = query?.pdf === '1' ? true : false;
 
-    const result = await this.jsreport.renderInvoice(pdf);
+    const result = await this.invoice.render(pdf);
 
-    res.set(this.jsreport.getContentHeaders(result, pdf, 'docx'));
+    res.set(this.getContentHeaders(result, pdf, 'docx'));
 
     return new StreamableFile(result.stream as any);
   }
@@ -44,9 +64,9 @@ export class JsReportController {
   ) {
     const pdf = query?.pdf === '1' ? true : false;
 
-    const result = await this.jsreport.renderInvoiceSheet(pdf);
+    const result = await this.invoiceXlsx.render(pdf);
 
-    res.set(this.jsreport.getContentHeaders(result, pdf, 'xlsx'));
+    res.set(this.getContentHeaders(result, pdf, 'xlsx'));
 
     return new StreamableFile(result.stream as any);
   }
@@ -59,9 +79,9 @@ export class JsReportController {
   ) {
     const pdf = query?.pdf === '1' ? true : false;
 
-    const result = await this.jsreport.renderPopulation(pdf);
+    const result = await this.population.render(pdf);
 
-    res.set(this.jsreport.getContentHeaders(result, pdf, 'xlsx'));
+    res.set(this.getContentHeaders(result, pdf, 'xlsx'));
 
     return new StreamableFile(result.stream as any);
   }
@@ -74,17 +94,17 @@ export class JsReportController {
   ) {
     const pdf = query?.pdf === '1' ? true : false;
 
-    const result = await this.jsreport.renderHtmlToXlsx(pdf);
+    const result = await this.html.render(pdf);
 
-    res.set(this.jsreport.getContentHeaders(result, pdf, 'xlsx'));
+    res.set(this.getContentHeaders(result, pdf, 'xlsx'));
 
     return new StreamableFile(result.stream as any);
   }
 
   // ticket chrome-pdf (html to pdf) ///////////////////////////
   @Get('/ticket')
   async ticketReport(@Res({ passthrough: true }) res: Response) {
-    const result = await this.jsreport.renderTicket();
+    const result = await this.ticket.render();
 
     res.set({
       'Content-Type': `application/pdf`,

src/js-report/js-report.module.ts

@@ -0,0 +1,21 @@
+import { Module } from '@nestjs/common';
+import { JsReportProvider } from './js-report.provider';
+import { JsReportService } from './js-report.service';
+import * as Reports from './reports';
+import { JsReportController } from './js-report.controller';
+
+@Module({
+  providers: [
+    JsReportProvider,
+    JsReportService,
+    Reports.HtmlToXlsxReport,
+    Reports.InvoiceReport,
+    Reports.InvoiceXlsxReport,
+    Reports.PopulationReport,
+    Reports.PopulationReport,
+    Reports.StudentReport,
+    Reports.TicketReport,
+  ],
+  controllers: [JsReportController],
+})
+export class JsReportModule {}