@jsreport/jsreport-fs-store

    3.2.1 • Public • Published

    @jsreport/jsreport-fs-store

    NPM Version

    jsreport template store extension. Supports editing templates in the external editors and browser's live reload and preview!

    See the docs https://jsreport.net/learn/fs-store

    Installation

    npm install jsreport-fs-store

    Then alter jsreport configuration

    {
    	'store': { 'provider': 'fs' }
    }

    Changelog

    3.2.1

    • fix external entities changes sync reload
    • changes to enable new trustUserCode option

    3.2.0

    • properly support absolute path in blobStorage.dataDirectory
    • various optimizations regarding profiler persistence

    3.1.0

    • add fs-store ignore option to ignore directories/files during the load
    • add socket.io as explicit dep
    • optimization: don't delete nested folders when updating folder
    • fix losing entities in fs store data directory when updating folder in transaction

    3.0.0-beta.1

    Adaptations for the v3 APIs

    Development

    (This section is intended to jsreport extension developers audience.)

    Entity definitions

    Use splitIntoDirectories attribute in registerEntitySet to use the directory structure for storing. Otherwise the storage will put every entity row into the one single file.

    this.documentStore.registerEntitySet("templates", {entityType: "jsreport.TemplateType", splitIntoDirectories: true});

    Not every jsreport entity should be spitted into the tree structure. It is especially not desired for the entities where you expect thousands of entries. In this case just remove the splitIntoDirectories attribute.

    The second required step is to extend the entity type with name attribute which defines the attribute used for the row directory name. And also adding the document for the attributes you want to extract into dedicated files.

    var templateAttributes = {
    	...
        shortid: { type: "Edm.String" },
        name: { type: "Edm.String" },
        content: {
            type: "Edm.String",
    	    document: { extension: "html", engine: true }
    	}
        ...
    };

    Engines

    Engines like handlebars or jade are able to override the default file extension for the template content files. This can be done using file extension resolver....

    reporter.documentStore.addFileExtensionResolver(function(doc, entitySetName, entityType, propertyType) {
            if (doc.engine === "handlebars" && propertyType.document.engine) {
                return "handlebars";
            };
        });

    Keywords

    Install

    npm i @jsreport/jsreport-fs-store

    DownloadsWeekly Downloads

    584

    Version

    3.2.1

    License

    MIT

    Unpacked Size

    437 kB

    Total Files

    20

    Last publish

    Collaborators

    • pofider
    • bjrmatos