@oicana/node 0.1.0-alpha.3 → 0.1.0-alpha.4

package/dist/Template.d.ts

@@ -8,21 +8,18 @@ import type { BlobWithMetadata } from './inputs/index.js';
  */
 export declare class Template {
     private readonly template;
-    private defaultCompilationMode;
     /**
-     * Register a template with the given name and template file
-     * @param name of the template
+     * Register a template with the given template file
      * @param template - the packed Oicana template file
      */
-    constructor(name: string, template: Uint8Array);
+    constructor(template: Uint8Array);
     /**
-     * Register a template with the given name, template file, and inputs
-     * @param name of the template
+     * Register a template with the given template file and inputs
      * @param template - the packed Oicana template file
-     * @param jsonInputs for the initial rendering to warm up the cache
-     * @param blobInputs for the initial rendering to warm up the cache
+     * @param jsonInputs for the initial compilation to warm up the cache
+     * @param blobInputs for the initial compilation to warm up the cache
      */
-    constructor(name: string, template: Uint8Array, jsonInputs: Map<string, string>, blobInputs: Map<string, BlobWithMetadata>);
+    constructor(template: Uint8Array, jsonInputs: Map<string, string>, blobInputs: Map<string, BlobWithMetadata>);
     /**
      * Compile the template to a PDF file without any inputs in production mode
      */
@@ -37,18 +34,17 @@ export declare class Template {
      * Compile the template with the given inputs
      * @param jsonInputs
      * @param blobInputs
-     * @param exportFormat
+     * @param exportOptions
      */
-    compile(jsonInputs: Map<string, string>, blobInputs: Map<string, BlobWithMetadata>, exportFormat: ExportFormat): Uint8Array;
+    compile(jsonInputs: Map<string, string>, blobInputs: Map<string, BlobWithMetadata>, exportOptions: ExportFormat): Uint8Array;
     /**
-     * Get the default compilation mode of this template
-     */
-    defaultMode(): CompilationMode;
-    /**
-     * Set the default compilation mode of this template
-     * @param compilationMode to use as default when compiling this template
+     * Compile the template with the given inputs
+     * @param jsonInputs
+     * @param blobInputs
+     * @param exportOptions
+     * @param compilationOptions
      */
-    setDefaultMode(compilationMode: CompilationMode): void;
+    compile(jsonInputs: Map<string, string>, blobInputs: Map<string, BlobWithMetadata>, exportOptions: ExportFormat, compilationOptions: CompilationMode): Uint8Array;
     private convertBlobWithMetadata;
     private mapCompilationMode;
 }

package/dist/Template.js

@@ -1,4 +1,5 @@
-import { compileTemplate, registerTemplate, exportDocument } from '@oicana/node-native';
+import { randomUUID } from 'node:crypto';
+import { compileTemplate, exportDocument, registerTemplate, removeDocument, } from '@oicana/node-native';
 import { CompilationMode } from './CompilationMode.js';
 /**
  * A template
@@ -7,44 +8,33 @@ import { CompilationMode } from './CompilationMode.js';
  */
 export class Template {
     template;
-    defaultCompilationMode;
     /**
-     * Register a template with the given name, template file, and inputs
-     * @param name of the template
+     * Register a template with the given template file and inputs
      * @param template - the packed Oicana template file
-     * @param jsonInputs for the initial rendering to warm up the cache
-     * @param blobInputs for the initial rendering to warm up the cache
-     * @param compilation mode for the initial rendering to warm up the cache
+     * @param jsonInputs for the initial compilation to warm up the cache (defaults to empty map)
+     * @param blobInputs for the initial compilation to warm up the cache (defaults to empty map)
+     * @param compilationOptions for the initial compilation to warm up the cache (defaults to Development)
      */
-    constructor(name, template, jsonInputs, blobInputs, compilationMode) {
-        this.template = name;
-        this.defaultCompilationMode = CompilationMode.Production;
-        registerTemplate(this.template, template, Object.fromEntries(jsonInputs ?? new Map()), this.convertBlobWithMetadata(blobInputs ?? new Map()), this.mapCompilationMode(compilationMode ?? CompilationMode.Development));
+    constructor(template, jsonInputs, blobInputs, compilationOptions) {
+        this.template = randomUUID();
+        registerTemplate(this.template, template, Object.fromEntries(jsonInputs ?? new Map()), this.convertBlobWithMetadata(blobInputs ?? new Map()), this.mapCompilationMode(compilationOptions ?? CompilationMode.Development));
     }
     /**
      * Compile the template with the given inputs
-     * @param jsonInputs
-     * @param blobInputs
-     * @param exportFormat
-     * @param compilationMode
+     * @param jsonInputs - JSON inputs for the template (defaults to empty map)
+     * @param blobInputs - Blob inputs for the template (defaults to empty map)
+     * @param exportOptions - Export format specification (defaults to PDF)
+     * @param compilationOptions - Compilation mode (defaults to Production)
      */
-    compile(jsonInputs, blobInputs, exportFormat, compilationMode) {
-        const format = exportFormat ?? { format: 'pdf' };
-        const document = compileTemplate(this.template, Object.fromEntries(jsonInputs ?? new Map()), this.convertBlobWithMetadata(blobInputs ?? new Map()), this.mapCompilationMode(compilationMode ?? CompilationMode.Production));
-        return exportDocument(document, JSON.stringify(format));
-    }
-    /**
-     * Get the default compilation mode of this template
-     */
-    defaultMode() {
-        return this.defaultCompilationMode;
-    }
-    /**
-     * Set the default compilation mode of this template
-     * @param compilationMode to use as default when compiling this template
-     */
-    setDefaultMode(compilationMode) {
-        this.defaultCompilationMode = compilationMode;
+    compile(jsonInputs, blobInputs, exportOptions, compilationOptions) {
+        const format = exportOptions ?? { format: 'pdf' };
+        const document = compileTemplate(this.template, Object.fromEntries(jsonInputs ?? new Map()), this.convertBlobWithMetadata(blobInputs ?? new Map()), this.mapCompilationMode(compilationOptions ?? CompilationMode.Production));
+        try {
+            return exportDocument(document, JSON.stringify(format));
+        }
+        finally {
+            removeDocument(document);
+        }
     }
     convertBlobWithMetadata(blobInputs) {
         return Object.fromEntries(Array.from(blobInputs.entries(), ([key, value]) => {

package/dist/Template.js.map

@@ -1 +1 @@
-{"version":3,"file":"Template.js","sourceRoot":"","sources":["../src/Template.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAEf,gBAAgB,EAChB,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAIvD;;;;GAIG;AACH,MAAM,OAAO,QAAQ;IACF,QAAQ,CAAS;IAC1B,sBAAsB,CAAkB;IAuBhD;;;;;;;OAOG;IACH,YACE,IAAY,EACZ,QAAoB,EACpB,UAAgC,EAChC,UAA0C,EAC1C,eAAiC;QAEjC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,sBAAsB,GAAG,eAAe,CAAC,UAAU,CAAC;QAEzD,gBAAgB,CACd,IAAI,CAAC,QAAQ,EACb,QAAQ,EACR,MAAM,CAAC,WAAW,CAAC,UAAU,IAAI,IAAI,GAAG,EAAkB,CAAC,EAC3D,IAAI,CAAC,uBAAuB,CAC1B,UAAU,IAAI,IAAI,GAAG,EAA4B,CAClD,EACD,IAAI,CAAC,kBAAkB,CAAC,eAAe,IAAI,eAAe,CAAC,WAAW,CAAC,CACxE,CAAC;IACJ,CAAC;IA6BD;;;;;;OAMG;IACI,OAAO,CACZ,UAAgC,EAChC,UAA0C,EAC1C,YAA2B,EAC3B,eAAiC;QAEjC,MAAM,MAAM,GAAiB,YAAY,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QAE/D,MAAM,QAAQ,GAAG,eAAe,CAC9B,IAAI,CAAC,QAAQ,EACb,MAAM,CAAC,WAAW,CAAC,UAAU,IAAI,IAAI,GAAG,EAAkB,CAAC,EAC3D,IAAI,CAAC,uBAAuB,CAC1B,UAAU,IAAI,IAAI,GAAG,EAA4B,CAClD,EACD,IAAI,CAAC,kBAAkB,CAAC,eAAe,IAAI,eAAe,CAAC,UAAU,CAAC,CACvE,CAAC;QACF,OAAO,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAA;IACzD,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,sBAAsB,CAAC;IACrC,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,eAAgC;QACpD,IAAI,CAAC,sBAAsB,GAAG,eAAe,CAAC;IAChD,CAAC;IAEO,uBAAuB,CAC7B,UAAyC;QAEzC,OAAO,MAAM,CAAC,WAAW,CACvB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAChD,MAAM,WAAW,GAAG;gBAClB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;aACnE,CAAC;YACF,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAC5B,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,IAAqB;QAC9C,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,eAAe,CAAC,WAAW;gBAC9B,iDAAyC;YAC3C,KAAK,eAAe,CAAC,UAAU;gBAC7B,gDAAwC;QAC5C,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"Template.js","sourceRoot":"","sources":["../src/Template.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAEL,eAAe,EACf,cAAc,EAEd,gBAAgB,EAChB,cAAc,GACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAIvD;;;;GAIG;AACH,MAAM,OAAO,QAAQ;IACF,QAAQ,CAAS;IAoBlC;;;;;;OAMG;IACH,YACE,QAAoB,EACpB,UAAgC,EAChC,UAA0C,EAC1C,kBAAoC;QAEpC,IAAI,CAAC,QAAQ,GAAG,UAAU,EAAE,CAAC;QAE7B,gBAAgB,CACd,IAAI,CAAC,QAAQ,EACb,QAAQ,EACR,MAAM,CAAC,WAAW,CAAC,UAAU,IAAI,IAAI,GAAG,EAAkB,CAAC,EAC3D,IAAI,CAAC,uBAAuB,CAC1B,UAAU,IAAI,IAAI,GAAG,EAA4B,CAClD,EACD,IAAI,CAAC,kBAAkB,CACrB,kBAAkB,IAAI,eAAe,CAAC,WAAW,CAClD,CACF,CAAC;IACJ,CAAC;IA2CD;;;;;;OAMG;IACI,OAAO,CACZ,UAAgC,EAChC,UAA0C,EAC1C,aAA4B,EAC5B,kBAAoC;QAEpC,MAAM,MAAM,GAAiB,aAAa,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QAEhE,MAAM,QAAQ,GAAG,eAAe,CAC9B,IAAI,CAAC,QAAQ,EACb,MAAM,CAAC,WAAW,CAAC,UAAU,IAAI,IAAI,GAAG,EAAkB,CAAC,EAC3D,IAAI,CAAC,uBAAuB,CAC1B,UAAU,IAAI,IAAI,GAAG,EAA4B,CAClD,EACD,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,IAAI,eAAe,CAAC,UAAU,CAAC,CAC1E,CAAC;QACF,IAAI,CAAC;YACH,OAAO,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1D,CAAC;gBAAS,CAAC;YACT,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAEO,uBAAuB,CAC7B,UAAyC;QAEzC,OAAO,MAAM,CAAC,WAAW,CACvB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAChD,MAAM,WAAW,GAAG;gBAClB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;aACnE,CAAC;YACF,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAC5B,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,IAAqB;QAC9C,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,eAAe,CAAC,WAAW;gBAC9B,iDAAyC;YAC3C,KAAK,eAAe,CAAC,UAAU;gBAC7B,gDAAwC;QAC5C,CAAC;IACH,CAAC;CACF"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oicana/node",
   "author": "Oicana <hello@oicana.com>",
-  "version": "0.1.0-alpha.3",
+  "version": "0.1.0-alpha.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "readme": "README.md",

package/src/Template.ts

@@ -1,3 +1,4 @@
+import { randomUUID } from 'node:crypto';
 import {
   type BlobWithMetadata as BlobWithMetadataNative,
   compileTemplate,
@@ -17,46 +18,39 @@ import type { BlobWithMetadata } from './inputs/index.js';
  */
 export class Template {
   private readonly template: string;
-  private defaultCompilationMode: CompilationMode;
 
   /**
-   * Register a template with the given name and template file
-   * @param name of the template
+   * Register a template with the given template file
    * @param template - the packed Oicana template file
    */
-  public constructor(name: string, template: Uint8Array);
+  public constructor(template: Uint8Array);
 
   /**
-   * Register a template with the given name, template file, and inputs
-   * @param name of the template
+   * Register a template with the given template file and inputs
    * @param template - the packed Oicana template file
-   * @param jsonInputs for the initial rendering to warm up the cache
-   * @param blobInputs for the initial rendering to warm up the cache
+   * @param jsonInputs for the initial compilation to warm up the cache
+   * @param blobInputs for the initial compilation to warm up the cache
    */
   public constructor(
-    name: string,
     template: Uint8Array,
     jsonInputs: Map<string, string>,
     blobInputs: Map<string, BlobWithMetadata>,
   );
 
   /**
-   * Register a template with the given name, template file, and inputs
-   * @param name of the template
+   * Register a template with the given template file and inputs
    * @param template - the packed Oicana template file
-   * @param jsonInputs for the initial rendering to warm up the cache
-   * @param blobInputs for the initial rendering to warm up the cache
-   * @param compilation mode for the initial rendering to warm up the cache
+   * @param jsonInputs for the initial compilation to warm up the cache (defaults to empty map)
+   * @param blobInputs for the initial compilation to warm up the cache (defaults to empty map)
+   * @param compilationOptions for the initial compilation to warm up the cache (defaults to Development)
    */
   public constructor(
-    name: string,
     template: Uint8Array,
     jsonInputs?: Map<string, string>,
     blobInputs?: Map<string, BlobWithMetadata>,
-    compilationMode?: CompilationMode,
+    compilationOptions?: CompilationMode,
   ) {
-    this.template = name;
-    this.defaultCompilationMode = CompilationMode.Production;
+    this.template = randomUUID();
 
     registerTemplate(
       this.template,
@@ -65,7 +59,9 @@ export class Template {
       this.convertBlobWithMetadata(
         blobInputs ?? new Map<string, BlobWithMetadata>(),
       ),
-      this.mapCompilationMode(compilationMode ?? CompilationMode.Development),
+      this.mapCompilationMode(
+        compilationOptions ?? CompilationMode.Development,
+      ),
     );
   }
 
@@ -88,28 +84,42 @@ export class Template {
    * Compile the template with the given inputs
    * @param jsonInputs
    * @param blobInputs
-   * @param exportFormat
+   * @param exportOptions
    */
   public compile(
     jsonInputs: Map<string, string>,
     blobInputs: Map<string, BlobWithMetadata>,
-    exportFormat: ExportFormat,
+    exportOptions: ExportFormat,
   ): Uint8Array;
 
   /**
    * Compile the template with the given inputs
    * @param jsonInputs
    * @param blobInputs
-   * @param exportFormat
-   * @param compilationMode
+   * @param exportOptions
+   * @param compilationOptions
+   */
+  public compile(
+    jsonInputs: Map<string, string>,
+    blobInputs: Map<string, BlobWithMetadata>,
+    exportOptions: ExportFormat,
+    compilationOptions: CompilationMode,
+  ): Uint8Array;
+
+  /**
+   * Compile the template with the given inputs
+   * @param jsonInputs - JSON inputs for the template (defaults to empty map)
+   * @param blobInputs - Blob inputs for the template (defaults to empty map)
+   * @param exportOptions - Export format specification (defaults to PDF)
+   * @param compilationOptions - Compilation mode (defaults to Production)
    */
   public compile(
     jsonInputs?: Map<string, string>,
     blobInputs?: Map<string, BlobWithMetadata>,
-    exportFormat?: ExportFormat,
-    compilationMode?: CompilationMode,
+    exportOptions?: ExportFormat,
+    compilationOptions?: CompilationMode,
   ): Uint8Array {
-    const format: ExportFormat = exportFormat ?? { format: 'pdf' };
+    const format: ExportFormat = exportOptions ?? { format: 'pdf' };
 
     const document = compileTemplate(
       this.template,
@@ -117,7 +127,7 @@ export class Template {
       this.convertBlobWithMetadata(
         blobInputs ?? new Map<string, BlobWithMetadata>(),
       ),
-      this.mapCompilationMode(compilationMode ?? CompilationMode.Production),
+      this.mapCompilationMode(compilationOptions ?? CompilationMode.Production),
     );
     try {
       return exportDocument(document, JSON.stringify(format));
@@ -126,21 +136,6 @@ export class Template {
     }
   }
 
-  /**
-   * Get the default compilation mode of this template
-   */
-  public defaultMode(): CompilationMode {
-    return this.defaultCompilationMode;
-  }
-
-  /**
-   * Set the default compilation mode of this template
-   * @param compilationMode to use as default when compiling this template
-   */
-  public setDefaultMode(compilationMode: CompilationMode) {
-    this.defaultCompilationMode = compilationMode;
-  }
-
   private convertBlobWithMetadata(
     blobInputs: Map<string, BlobWithMetadata>,
   ): Record<string, BlobWithMetadataNative> {