@oicana/node 0.1.0-alpha.1

package/LICENSE.md

@@ -0,0 +1,131 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose.  However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software.  Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for
+the benefit of public knowledge, personal study, private
+entertainment, hobby projects, amateur pursuits, or religious
+observance, without any anticipated commercial application,
+is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution,
+public research organization, public safety or health
+organization, environmental protection organization,
+or government institution is use for a permitted purpose
+regardless of the source of funding or obligations resulting
+from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else.  These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice.  Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization.  **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

package/README.md

@@ -0,0 +1,9 @@
+# Oicana
+*Dynamic PDF Generation based on Typst*
+
+https://oicana.com
+
+Oicana offers seamless PDF templating across multiple platforms. Define your templates in Typst, specify dynamic inputs, and generate high quality PDFs from any environment - whether it's a web browser, server application, or desktop software.
+
+> **Oicana is in Alpha! It is rough around the edges and has a limited number of integrations.**
+

package/biome.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.2.4/schema.json",
+  "vcs": {
+    "enabled": false,
+    "clientKind": "git",
+    "useIgnoreFile": false
+  },
+  "files": {
+    "ignoreUnknown": false,
+    "includes": ["**", "!**/dist"]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space"
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single"
+    }
+  },
+  "assist": {
+    "enabled": true,
+    "actions": {
+      "source": {
+        "organizeImports": "on"
+      }
+    }
+  }
+}

package/dist/CompilationMode.d.ts

@@ -0,0 +1,4 @@
+export declare enum CompilationMode {
+    Development = "development",
+    Production = "production"
+}

package/dist/CompilationMode.js

@@ -0,0 +1,6 @@
+export var CompilationMode;
+(function (CompilationMode) {
+    CompilationMode["Development"] = "development";
+    CompilationMode["Production"] = "production";
+})(CompilationMode || (CompilationMode = {}));
+//# sourceMappingURL=CompilationMode.js.map

package/dist/CompilationMode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompilationMode.js","sourceRoot":"","sources":["../src/CompilationMode.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,8CAA2B,CAAA;IAC3B,4CAAyB,CAAA;AAC3B,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B"}

package/dist/ExportFormat.d.ts

@@ -0,0 +1,9 @@
+export type ExportFormat = {
+    format: 'pdf' | 'svg';
+} | {
+    format: 'png';
+    pixelsPerPt: number;
+};
+export declare const Pdf: ExportFormat;
+export declare const Svg: ExportFormat;
+export declare const Png: (pixelsPerPt: number) => ExportFormat;

package/dist/ExportFormat.js

@@ -0,0 +1,7 @@
+export const Pdf = { format: 'pdf' };
+export const Svg = { format: 'svg' };
+export const Png = (pixelsPerPt) => ({
+    format: 'png',
+    pixelsPerPt,
+});
+//# sourceMappingURL=ExportFormat.js.map

package/dist/ExportFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExportFormat.js","sourceRoot":"","sources":["../src/ExportFormat.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,GAAG,GAAiB,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AACnD,MAAM,CAAC,MAAM,GAAG,GAAiB,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AACnD,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,WAAmB,EAAgB,EAAE,CAAC,CAAC;IACzD,MAAM,EAAE,KAAK;IACb,WAAW;CACZ,CAAC,CAAC"}

package/dist/Template.d.ts

@@ -0,0 +1,54 @@
+import { CompilationMode } from './CompilationMode';
+import type { ExportFormat } from './ExportFormat';
+import type { BlobWithMetadata } from './inputs';
+/**
+ * A template
+ *
+ * The zip file is loaded during the instance creation and cached afterward.
+ */
+export declare class Template {
+    private readonly template;
+    private defaultCompilationMode;
+    /**
+     * Register a template with the given name and template file
+     * @param name of the template
+     * @param template - the packed Oicana template file
+     */
+    constructor(name: string, template: Uint8Array);
+    /**
+     * Register a template with the given name, template file, and inputs
+     * @param name of the template
+     * @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
+     */
+    constructor(name: string, template: Uint8Array, jsonInputs: Map<string, string>, blobInputs: Map<string, BlobWithMetadata>);
+    /**
+     * Compile the template to a PDF file without any inputs in production mode
+     */
+    compile(): Uint8Array;
+    /**
+     * Compile the template to a PDF file with given inputs in production mode
+     * @param jsonInputs
+     * @param blobInputs
+     */
+    compile(jsonInputs: Map<string, string>, blobInputs: Map<string, BlobWithMetadata>): Uint8Array;
+    /**
+     * Compile the template with the given inputs
+     * @param jsonInputs
+     * @param blobInputs
+     * @param exportFormat
+     */
+    compile(jsonInputs: Map<string, string>, blobInputs: Map<string, BlobWithMetadata>, exportFormat: 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
+     */
+    setDefaultMode(compilationMode: CompilationMode): void;
+    private convertBlobWithMetadata;
+    private mapCompilationMode;
+}

package/dist/Template.js

@@ -0,0 +1,67 @@
+import { compileTemplate, registerTemplate, } from '@oicana/node-native';
+import { CompilationMode } from './CompilationMode';
+/**
+ * A template
+ *
+ * The zip file is loaded during the instance creation and cached afterward.
+ */
+export class Template {
+    template;
+    defaultCompilationMode;
+    /**
+     * Register a template with the given name, template file, and inputs
+     * @param name of the template
+     * @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
+     */
+    constructor(name, template, jsonInputs, blobInputs, compilationMode) {
+        this.template = name;
+        this.defaultCompilationMode = CompilationMode.Production;
+        const format = { format: 'pdf' };
+        registerTemplate(this.template, template, Object.fromEntries(jsonInputs ?? new Map()), this.convertBlobWithMetadata(blobInputs ?? new Map()), JSON.stringify(format), this.mapCompilationMode(compilationMode ?? CompilationMode.Development));
+    }
+    /**
+     * Compile the template with the given inputs
+     * @param jsonInputs
+     * @param blobInputs
+     * @param exportFormat
+     * @param compilationMode
+     */
+    compile(jsonInputs, blobInputs, exportFormat, compilationMode) {
+        const format = exportFormat ?? { format: 'pdf' };
+        return compileTemplate(this.template, Object.fromEntries(jsonInputs ?? new Map()), this.convertBlobWithMetadata(blobInputs ?? new Map()), JSON.stringify(format), this.mapCompilationMode(compilationMode ?? CompilationMode.Production));
+    }
+    /**
+     * 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;
+    }
+    convertBlobWithMetadata(blobInputs) {
+        return Object.fromEntries(Array.from(blobInputs.entries(), ([key, value]) => {
+            const nativeValue = {
+                bytes: value.bytes,
+                meta: value.meta === undefined ? '{}' : JSON.stringify(value.meta),
+            };
+            return [key, nativeValue];
+        }));
+    }
+    mapCompilationMode(mode) {
+        switch (mode) {
+            case CompilationMode.Development:
+                return 1 /* NativeCompilationMode.Development */;
+            case CompilationMode.Production:
+                return 0 /* NativeCompilationMode.Production */;
+        }
+    }
+}
+//# sourceMappingURL=Template.js.map

package/dist/Template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Template.js","sourceRoot":"","sources":["../src/Template.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAEf,gBAAgB,GACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIpD;;;;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;QACzD,MAAM,MAAM,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QAEjC,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,SAAS,CAAC,MAAM,CAAC,EACtB,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,OAAO,eAAe,CACpB,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,SAAS,CAAC,MAAM,CAAC,EACtB,IAAI,CAAC,kBAAkB,CAAC,eAAe,IAAI,eAAe,CAAC,UAAU,CAAC,CACvE,CAAC;IACJ,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"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './CompilationMode';
+export * from './ExportFormat';
+export * from './inputs';
+export * from './Template';

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from './CompilationMode';
+export * from './ExportFormat';
+export * from './inputs';
+export * from './Template';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC"}

package/dist/inputs/BlobInput.d.ts

@@ -0,0 +1,17 @@
+export interface BlobWithMetadata {
+    bytes: Uint8Array;
+    meta?: {
+        image_format?: string;
+        [key: string]: any;
+    };
+}
+export interface BlobInputDefinition {
+    key: string;
+    default: {
+        file: string;
+        meta?: {
+            image_format?: string;
+            [key: string]: any;
+        };
+    };
+}

package/dist/inputs/BlobInput.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=BlobInput.js.map

package/dist/inputs/BlobInput.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlobInput.js","sourceRoot":"","sources":["../../src/inputs/BlobInput.ts"],"names":[],"mappings":""}

package/dist/inputs/JsonInput.d.ts

@@ -0,0 +1,5 @@
+export interface JsonInputDefinition {
+    key: string;
+    default: string;
+    schema?: string;
+}

package/dist/inputs/JsonInput.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=JsonInput.js.map

package/dist/inputs/JsonInput.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonInput.js","sourceRoot":"","sources":["../../src/inputs/JsonInput.ts"],"names":[],"mappings":""}

package/dist/inputs/index.d.ts

@@ -0,0 +1,7 @@
+import { BlobInputDefinition, BlobWithMetadata } from './BlobInput';
+import { JsonInputDefinition } from './JsonInput';
+export { JsonInputDefinition, BlobInputDefinition, BlobWithMetadata };
+export interface Inputs {
+    json: JsonInputDefinition[];
+    blob: BlobInputDefinition[];
+}

package/dist/inputs/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/inputs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/inputs/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@oicana/node",
+  "author": "Oicana <hello@oicana.com>",
+  "version": "0.1.0-alpha.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "readme": "README.md",
+  "license": "PolyForm-Noncommercial-1.0.0",
+  "homepage": "https://oicana.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/oicana/oicana.git"
+  },
+  "bugs": {
+    "url": "https://github.com/oicana/oicana/issues"
+  },
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "format": "biome check --write",
+    "test": "vitest",
+    "lint": "biome ci"
+  },
+  "dependencies": {
+    "@oicana/node-native": "0.1.0-alpha.1"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.2.4",
+    "@types/node": "24.6.2",
+    "@vitest/coverage-v8": "3.2.4",
+    "globals": "15.9.0",
+    "jsdom": "26.1.0",
+    "typescript": "5.7.3",
+    "vite": "7.1.3",
+    "vite-plugin-top-level-await": "1.6.0",
+    "vite-plugin-wasm": "3.5.0",
+    "vitest": "3.2.4"
+  }
+}

package/src/CompilationMode.ts

@@ -0,0 +1,4 @@
+export enum CompilationMode {
+  Development = 'development',
+  Production = 'production',
+}

package/src/ExportFormat.ts

@@ -0,0 +1,10 @@
+export type ExportFormat =
+  | { format: 'pdf' | 'svg' }
+  | { format: 'png'; pixelsPerPt: number };
+
+export const Pdf: ExportFormat = { format: 'pdf' };
+export const Svg: ExportFormat = { format: 'svg' };
+export const Png = (pixelsPerPt: number): ExportFormat => ({
+  format: 'png',
+  pixelsPerPt,
+});

package/src/Template.ts

@@ -0,0 +1,162 @@
+import {
+  type BlobWithMetadata as BlobWithMetadataNative,
+  compileTemplate,
+  CompilationMode as NativeCompilationMode,
+  registerTemplate,
+} from '@oicana/node-native';
+import { CompilationMode } from './CompilationMode';
+import type { ExportFormat } from './ExportFormat';
+import type { BlobWithMetadata } from './inputs';
+
+/**
+ * A template
+ *
+ * The zip file is loaded during the instance creation and cached afterward.
+ */
+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
+   * @param template - the packed Oicana template file
+   */
+  public constructor(name: string, template: Uint8Array);
+
+  /**
+   * Register a template with the given name, template file, and inputs
+   * @param name of the template
+   * @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
+   */
+  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
+   * @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
+   */
+  public constructor(
+    name: string,
+    template: Uint8Array,
+    jsonInputs?: Map<string, string>,
+    blobInputs?: Map<string, BlobWithMetadata>,
+    compilationMode?: CompilationMode,
+  ) {
+    this.template = name;
+    this.defaultCompilationMode = CompilationMode.Production;
+    const format = { format: 'pdf' };
+
+    registerTemplate(
+      this.template,
+      template,
+      Object.fromEntries(jsonInputs ?? new Map<string, string>()),
+      this.convertBlobWithMetadata(
+        blobInputs ?? new Map<string, BlobWithMetadata>(),
+      ),
+      JSON.stringify(format),
+      this.mapCompilationMode(compilationMode ?? CompilationMode.Development),
+    );
+  }
+
+  /**
+   * Compile the template to a PDF file without any inputs in production mode
+   */
+  public compile(): Uint8Array;
+
+  /**
+   * Compile the template to a PDF file with given inputs in production mode
+   * @param jsonInputs
+   * @param blobInputs
+   */
+  public compile(
+    jsonInputs: Map<string, string>,
+    blobInputs: Map<string, BlobWithMetadata>,
+  ): Uint8Array;
+
+  /**
+   * Compile the template with the given inputs
+   * @param jsonInputs
+   * @param blobInputs
+   * @param exportFormat
+   */
+  public compile(
+    jsonInputs: Map<string, string>,
+    blobInputs: Map<string, BlobWithMetadata>,
+    exportFormat: ExportFormat,
+  ): Uint8Array;
+
+  /**
+   * Compile the template with the given inputs
+   * @param jsonInputs
+   * @param blobInputs
+   * @param exportFormat
+   * @param compilationMode
+   */
+  public compile(
+    jsonInputs?: Map<string, string>,
+    blobInputs?: Map<string, BlobWithMetadata>,
+    exportFormat?: ExportFormat,
+    compilationMode?: CompilationMode,
+  ): Uint8Array {
+    const format: ExportFormat = exportFormat ?? { format: 'pdf' };
+
+    return compileTemplate(
+      this.template,
+      Object.fromEntries(jsonInputs ?? new Map<string, string>()),
+      this.convertBlobWithMetadata(
+        blobInputs ?? new Map<string, BlobWithMetadata>(),
+      ),
+      JSON.stringify(format),
+      this.mapCompilationMode(compilationMode ?? CompilationMode.Production),
+    );
+  }
+
+  /**
+   * 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> {
+    return Object.fromEntries(
+      Array.from(blobInputs.entries(), ([key, value]) => {
+        const nativeValue = {
+          bytes: value.bytes,
+          meta: value.meta === undefined ? '{}' : JSON.stringify(value.meta),
+        };
+        return [key, nativeValue];
+      }),
+    );
+  }
+
+  private mapCompilationMode(mode: CompilationMode): NativeCompilationMode {
+    switch (mode) {
+      case CompilationMode.Development:
+        return NativeCompilationMode.Development;
+      case CompilationMode.Production:
+        return NativeCompilationMode.Production;
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './CompilationMode';
+export * from './ExportFormat';
+export * from './inputs';
+export * from './Template';

package/src/inputs/BlobInput.ts

@@ -0,0 +1,20 @@
+export interface BlobWithMetadata {
+  bytes: Uint8Array;
+  meta?: {
+    image_format?: string;
+    // biome-ignore lint/suspicious/noExplicitAny: Really anything that can pe serilized and deserialized into a Typst Dict is OK
+    [key: string]: any;
+  };
+}
+
+export interface BlobInputDefinition {
+  key: string;
+  default: {
+    file: string;
+    meta?: {
+      image_format?: string;
+      // biome-ignore lint/suspicious/noExplicitAny: Really anything that can pe serilized and deserialized into a Typst Dict is OK
+      [key: string]: any;
+    };
+  };
+}

package/src/inputs/JsonInput.ts

@@ -0,0 +1,5 @@
+export interface JsonInputDefinition {
+  key: string;
+  default: string;
+  schema?: string;
+}

package/src/inputs/index.ts

@@ -0,0 +1,9 @@
+import { BlobInputDefinition, BlobWithMetadata } from './BlobInput';
+import { JsonInputDefinition } from './JsonInput';
+
+export { JsonInputDefinition, BlobInputDefinition, BlobWithMetadata };
+
+export interface Inputs {
+  json: JsonInputDefinition[];
+  blob: BlobInputDefinition[];
+}

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "target": "esnext",
+    "sourceMap": true,
+    "declaration": true,
+    "outDir": "dist",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "exclude": [
+    "dist/**",
+    "node_modules/**",
+    "**/*.test.ts/**",
+    "testOutput/**",
+    "test-setup.ts",
+    "vite.config.ts"
+  ]
+}