added some more reports

Author: moofoo

README.md

@@ -4,55 +4,94 @@
 git clone https://github.com/moofoo/nestjs-jsreport-examples && cd nestjs-jsreport-examples && yarn && yarn start:dev
 ```
 
-This repo demonstrates (very basic) NestJS + JSReport integration. The app has six endpoints which generate different reports, taken from the [JSReport Playground](https://playground.jsreport.net/). The goal here is not to present a robust JSReports module, but demonstrate the basics of initializing JsReports and generating reports from templates and data, in addition to covering some of the 'gotchas' and configuration quirks involved.
+This repo demonstrates NestJS + JSReport integration. I've replicated all of the JSReport "[showcase](https://jsreport.net/showcases/)" reports minus the "PDF Stock Report", due to it's complexity. Like seriously, they went to town with that one. I also did a few of the simpler example reports from the [JSReport Playground](https://playground.jsreport.net/), just because.
 
-The following 'Recipes' are used:
+The goal here is not to present a complete and self-contained JSReports module that others can import and use, though that might happen eventually. Rather, I wanted to
 
-- [DocX](https://jsreport.net/learn/docx)
-- [Chrome PDF](https://jsreport.net/learn/chrome-pdf) (html-to-pdf using headless chromium)
-- [Xlsx](https://jsreport.net/learn/xlsx)
-- [Html-to-Xlsx](https://jsreport.net/learn/html-to-xlsx)
+- Show that the integration is possible and its potential,
+- Work through the expected 'gotchas', quirks and pain points that come with the territory, so that future templating/report work that I'm actually getting paid for will be hella easy,
+- I also want to show off how powerful and fully-featured the core JSReport framework is, to anyone paying attenntion. JSReport is literally the only business reports company that has their entire code base, top to bottom, open source and free for anyone to use, and it's fucking **legit**
 
-## Report Endpoints
+Software like this deserves attention and love, especially given how ridiculously costly and frankly predatory so many SaaS services in the space are.
+
+#
+
+## Implemented Reports and Endpoints
+
+<hr>
+
+#
+
+### [http://localhost:3333/reports/pdf-dashboard](http://localhost:3333/reports/pdf-dashboard)
+
+- ![PDF Dashboard](images/tasks-report.png)
+
+- Chrome PDF
+- [Playground Link](https://playground.jsreport.net/w/admin/cBFKE3RY)
+
+#
+
+### [http://localhost:3333/reports/excel-dashboard](http://localhost:3333/reports/excel-dashboard)
+
+- ![Excel Dashboard](images/excel-dashboard.png)
+
+- Chrome PDF
+- [Playground Link](https://playground.jsreport.net/w/admin/VvaGnaE)
+
+#
 
 ### [http://localhost:3333/reports/student](http://localhost:3333/reports/student)
 
+- ![Students](images/docx-students.png)
+
 - DocX
 - [Playground Link](https://playground.jsreport.net/w/admin/d7o0nIWc)
 
+#
+
+### [http://localhost:3333/reports/ticket](http://localhost:3333/reports/ticket)
+
+- ![Ticket](images/e-ticket.png)
+
+- Chrome PDF
+- [Playground Link](https://playground.jsreport.net/w/admin/ms2EkdfI)
+
+#
+
+### [http://localhost:3333/reports/pdf-forms](http://localhost:3333/reports/pdf-forms)
+
+- ![Ticket](images/pdf-form.png)
+- Chrome PDF
+- [Playground Link](https://playground.jsreport.net/w/admin/lbhULCsP)
+
+#
+
 ### [http://localhost:3333/reports/invoice](http://localhost:3333/reports/invoice)
 
 - DocX
 - [Playground Link](https://playground.jsreport.net/w/admin/yo9J3hvu)
 
+#
+
 ### [http://localhost:3333/reports/invoice-xlsx](http://localhost:3333/reports/invoice-xlsx)
 
 - Xlsx
 - [Playground Link](https://playground.jsreport.net/w/admin/Lh8Kjc~f)
 
+#
+
 ### [http://localhost:3333/reports/population](http://localhost:3333/reports/population)
 
 - Xlsx
 - [Playground Link](https://playground.jsreport.net/w/admin/V71OgRWt)
 
+#
+
 ### [http://localhost:3333/reports/html-to-xlsx](http://localhost:3333/reports/html-to-xlsx)
 
 - Html-to-Xlsx
 - [Playground Link](https://playground.jsreport.net/w/admin/h45L49Dp)
 
-### [http://localhost:3333/reports/ticket](http://localhost:3333/reports/ticket)
-
-- Chrome PDF
-- [Playground Link](https://playground.jsreport.net/w/admin/ms2EkdfI)
-
-All endpoints except for `flight-ticket` endpoint will generate a PDF (instead of .docx or .xlsx) with the query `pdf=1` (i.e, http://localhost:3333/reports/invoice?pdf=1)
-
-## Why do this?
-
-Well, in terms of pure document generation chops (not talking about templating backends, GUIs or workflows), JSReport is more-or-less on par with what is possible using SaaS services like [Bold Reports](https://www.boldreports.com/), [DocxTemplater](https://docxtemplater.com/), [CarboneIO](https://carbone.io), [DocuPilot](https://docupilot.app/), [Formstack](https://www.formstack.com/), etc...
-
-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) 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.
+Most of these will generate a PDF (instead .docx or .xlsx) with the query `pdf=1` (i.e, http://localhost:3333/reports/invoice?pdf=1)

images/docx-students.png

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

images/e-ticket.png

@@ -27,6 +27,8 @@
     "@jsreport/jsreport-fs-store": "^3.2.4",
     "@jsreport/jsreport-handlebars": "^3.2.1",
     "@jsreport/jsreport-html-to-xlsx": "^3.3.1",
+    "@jsreport/jsreport-pdf-utils": "^3.9.0",
+    "@jsreport/jsreport-scripts": "^3.4.1",
     "@jsreport/jsreport-unoconv": "^3.0.1",
     "@jsreport/jsreport-xlsx": "^3.4.0",
     "@nestjs/common": "^9.4.2",
@@ -54,6 +56,7 @@
     "@types/jsreport-core": "^2.0.5",
     "@types/jsreport-docx": "^2.8.2",
     "@types/jsreport-html-to-xlsx": "^2.0.3",
+    "@types/jsreport-scripts": "^2.6.2",
     "@types/jsreport-xlsx": "^1.4.2",
     "@types/node": "20.2.3",
     "@types/supertest": "^2.0.12",

images/excel-dashboard.png

@@ -3,24 +3,40 @@ import fs from 'fs';
 
 export class AssetHelper {
   private readonly jsReport: JsReporter;
+  collectionName = 'assets';
 
-  constructor(jsReport: JsReporter) {
+  constructor(jsReport: JsReporter, collectionName = 'assets') {
+    this.collectionName = collectionName;
     this.jsReport = jsReport;
   }
 
   async stored(name: string) {
     const result = await this.jsReport.documentStore
-      .collection('assets')
+      .collection(this.collectionName)
       .find({ name });
 
     return result.length > 0;
   }
 
+  async shortId(name) {
+    const isStored = await this.stored(name);
+
+    if (!isStored) {
+      return 'shortId';
+    }
+
+    const found: any = await this.find(name);
+    console.log('FOUND', found);
+
+    return found.shortid;
+  }
+
   async insert(asset: {
     name: string;
     path?: string;
     content?: any;
     encoding?: string;
+    scope?: string;
   }) {
     const isStored = await this.stored(asset.name);
 
@@ -30,7 +46,9 @@ export class AssetHelper {
       }
     }
 
-    await this.jsReport.documentStore.collection('assets').insert(asset);
+    await this.jsReport.documentStore
+      .collection(this.collectionName)
+      .insert(asset);
   }
 
   async insertAll(
@@ -39,6 +57,7 @@ export class AssetHelper {
       path?: string;
       content?: any;
       encoding?: string;
+      scope?: string;
     }>,
   ) {
     for (const asset of assets) {
@@ -51,6 +70,7 @@ export class AssetHelper {
     path?: string;
     content?: any;
     encoding?: string;
+    scope?: string;
   }) {
     const isStored = await this.stored(asset.name);
 
@@ -61,20 +81,26 @@ export class AssetHelper {
         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 } },
-        );
+      await this.jsReport.documentStore.collection(this.collectionName).update(
+        { name: asset.name },
+        {
+          $set: {
+            content: asset.content,
+            encoding: asset.encoding,
+            scope: asset.scope,
+          },
+        },
+      );
     }
   }
 
   async remove(name: string) {
     const isStored = await this.stored(name);
 
     if (isStored) {
-      await this.jsReport.documentStore.collection('assets').remove({ name });
+      await this.jsReport.documentStore
+        .collection(this.collectionName)
+        .remove({ name });
     }
   }
 
@@ -83,14 +109,15 @@ export class AssetHelper {
 
     if (isStored) {
       const found = await this.jsReport.documentStore
-        .collection('assets')
+        .collection(this.collectionName)
         .find({ name });
 
       return found[found.length - 1] as {
         name: string;
         path?: string;
         content?: any;
         encoding?: string;
+        scope?: string;
       };
     }
   }

images/pdf-form.png

@@ -17,10 +17,13 @@ export class TemplateHelper {
     return result.length > 0;
   }
 
-  async insertFn<T = unknown>(name: string, templateFn: () => Named & T) {
+  async insertFn<T = unknown>(
+    name: string,
+    templateFn: () => (Named & T) | Promise<Named & T>,
+  ) {
     const isStored = await this.stored(name);
     if (!isStored) {
-      await this.insert(templateFn());
+      await this.insert(await templateFn());
     }
   }