@jpmorganchase/mosaic-core 0.1.0-beta.4 → 0.1.0-beta.41

package/dist/PluginError.d.ts

@@ -0,0 +1,2 @@
+export default class PluginError extends Error {
+}

package/dist/PluginError.js

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class PluginError extends Error {
+export default class PluginError extends Error {
 }
-exports.default = PluginError;
 //# sourceMappingURL=PluginError.js.map

package/dist/PluginError.js.map

@@ -1 +1 @@
-{"version":3,"file":"PluginError.js","sourceRoot":"","sources":["../src/PluginError.ts"],"names":[],"mappings":";;AAAA,MAAqB,WAAY,SAAQ,KAAK;CAE7C;AAFD,8BAEC"}
+{"version":3,"file":"PluginError.js","sourceRoot":"","sources":["../src/PluginError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,KAAK;CAAG"}

package/dist/PullDocs.d.ts

@@ -0,0 +1,22 @@
+import { MosaicConfig, SourceModuleDefinition } from '@jpmorganchase/mosaic-types';
+import UnionVolume from './filesystems/UnionVolume.js';
+export default class PullDocs {
+    #private;
+    /**
+     *
+     * @param config.sources Sources are observables that emit pages
+     * @param config.plugins Plugins are modules with lifecycles methods for manipulating files and/or the virtual filesystem
+     * @param config.serialisers  Serialisers are a form of plugin that tell PullDocs how to turn a file from/to a storable form for the filesystem - or back into a `Page` object
+     * @param config.ignorePages Page names to exclude from lazy loading / `$ref`s / `$tag`s / serialisers and also any plugins that expect pages as input. Example input would be "ignore-me.xml"
+     * @param config.pageExtensions Exts of files to treat as pages. Pages contain metadata and content, in any file format (as long as a serialiser exists to encode/decode them). They can be referenced via `$ref`s / `$tag`s and also support lazy loading
+     * @param config.schedule Schedule to re-pull content from remote sources
+     */
+    constructor(config: MosaicConfig);
+    get filesystem(): UnionVolume;
+    onSourceUpdate(callback: any): () => boolean;
+    start(): Promise<import("./Source.js").default[]>;
+    stop(): Promise<void>;
+    triggerWorkflow(name: string, filePath: string, data: any): Promise<unknown>;
+    addSource(sourceDefinition: SourceModuleDefinition): Promise<import("./Source.js").default>;
+    stopSource(id: symbol): Promise<void>;
+}

package/dist/PullDocs.js

@@ -1,39 +1,21 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-var _PullDocs_instances, _PullDocs_sourceDefinitions, _PullDocs_sourceManager, _PullDocs_ufs, _PullDocs_vfs, _PullDocs_addSource;
-Object.defineProperty(exports, "__esModule", { value: true });
-const unionfs_1 = require("unionfs");
-const SourceManager_1 = __importDefault(require("./SourceManager"));
+import { createRequire } from 'node:module';
+import { Union } from 'unionfs';
+import { Volume } from 'memfs';
+import { mosaicConfigSchema, validateMosaicSchema } from '@jpmorganchase/mosaic-schemas';
 // TODO:
 // Remove $ref /index resolution
-const MutableVolume_1 = __importDefault(require("./filesystems/MutableVolume"));
-const UnionFileAccess_1 = __importDefault(require("./filesystems/UnionFileAccess"));
-const UnionVolume_1 = __importDefault(require("./filesystems/UnionVolume"));
-const memfs_1 = require("memfs");
-const FileAccess_1 = __importDefault(require("./filesystems/FileAccess"));
-class PullDocs {
+import FileAccess from './filesystems/FileAccess.js';
+import MutableVolume from './filesystems/MutableVolume.js';
+import UnionFileAccess from './filesystems/UnionFileAccess.js';
+import UnionVolume from './filesystems/UnionVolume.js';
+import SourceManager from './SourceManager.js';
+import parsePluginModuleDefinitions from './helpers/parsePluginModuleDefinitions.js';
+const require = createRequire(import.meta.url);
+export default class PullDocs {
+    #sourceDefinitions;
+    #sourceManager;
+    #ufs = new Union();
+    #vfs;
     /**
      *
      * @param config.sources Sources are observables that emit pages
@@ -41,79 +23,75 @@ class PullDocs {
      * @param config.serialisers  Serialisers are a form of plugin that tell PullDocs how to turn a file from/to a storable form for the filesystem - or back into a `Page` object
      * @param config.ignorePages Page names to exclude from lazy loading / `$ref`s / `$tag`s / serialisers and also any plugins that expect pages as input. Example input would be "ignore-me.xml"
      * @param config.pageExtensions Exts of files to treat as pages. Pages contain metadata and content, in any file format (as long as a serialiser exists to encode/decode them). They can be referenced via `$ref`s / `$tag`s and also support lazy loading
+     * @param config.schedule Schedule to re-pull content from remote sources
      */
     constructor(config) {
-        _PullDocs_instances.add(this);
-        _PullDocs_sourceDefinitions.set(this, void 0);
-        _PullDocs_sourceManager.set(this, void 0);
-        _PullDocs_ufs.set(this, new unionfs_1.Union());
-        _PullDocs_vfs.set(this, void 0);
-        const sharedFilesystem = new MutableVolume_1.default(new FileAccess_1.default(new memfs_1.Volume()), '*');
-        __classPrivateFieldGet(this, _PullDocs_ufs, "f").use(sharedFilesystem);
-        const { ignorePages = [], sources = [], plugins = [], serialisers = [], pageExtensions = ['.mdx'] } = config;
-        __classPrivateFieldSet(this, _PullDocs_sourceDefinitions, sources, "f");
-        __classPrivateFieldSet(this, _PullDocs_vfs, new UnionVolume_1.default(new UnionFileAccess_1.default(__classPrivateFieldGet(this, _PullDocs_ufs, "f")), '*'), "f");
-        __classPrivateFieldSet(this, _PullDocs_sourceManager, new SourceManager_1.default(
+        const { ignorePages = [], sources = [], plugins = [], serialisers = [], pageExtensions = ['.mdx'], schedule } = validateMosaicSchema(mosaicConfigSchema, config, true);
+        const sharedFilesystem = new MutableVolume(new FileAccess(new Volume()), '*');
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this.#ufs.use(sharedFilesystem);
+        this.#sourceDefinitions = sources.filter((source) => !source.disabled);
+        this.#vfs = new UnionVolume(new UnionFileAccess(this.#ufs), '*');
+        this.#sourceManager = new SourceManager(this.#vfs, sharedFilesystem, 
         // Refs and aliases should be applied after all other plugins, so we add them manually with a negative priority
-        plugins
+        parsePluginModuleDefinitions(plugins)
+            .filter((plugin) => !plugin.disabled)
             .concat({
-            modulePath: require.resolve('@jpmorganchase/mosaic-plugins/dist/$TagPlugin'),
+            modulePath: require.resolve('@jpmorganchase/mosaic-plugins/$TagPlugin'),
             options: {}
         }, {
-            modulePath: require.resolve('@jpmorganchase/mosaic-plugins/dist/$CodeModPlugin'),
+            modulePath: require.resolve('@jpmorganchase/mosaic-plugins/$CodeModPlugin'),
             options: {},
             // Make sure this happens as the very first plugin, so it can fix any page issues
             priority: Number.POSITIVE_INFINITY
         }, {
-            modulePath: require.resolve('@jpmorganchase/mosaic-plugins/dist/$AliasPlugin'),
+            modulePath: require.resolve('@jpmorganchase/mosaic-plugins/$AliasPlugin'),
             options: {},
             priority: -1
         }, {
-            modulePath: require.resolve('@jpmorganchase/mosaic-plugins/dist/$RefPlugin'),
+            modulePath: require.resolve('@jpmorganchase/mosaic-plugins/$RefPlugin'),
             options: {},
             priority: -1
         })
             .sort(({ priority: priorityA = 0 }, { priority: priorityB = 0 }) => priorityB - priorityA), 
         // Auto add JSON serialiser
         serialisers.concat({
-            modulePath: require.resolve('@jpmorganchase/mosaic-serialisers/dist/json'),
-            filter: /\.json$/,
-            options: {}
-        }), pageExtensions, ignorePages, __classPrivateFieldGet(this, _PullDocs_vfs, "f"), sharedFilesystem), "f");
+            modulePath: require.resolve('@jpmorganchase/mosaic-serialisers/json'),
+            filter: /\.json$/
+        }), pageExtensions, ignorePages, schedule);
     }
     get filesystem() {
-        return __classPrivateFieldGet(this, _PullDocs_vfs, "f");
+        return this.#vfs;
     }
     onSourceUpdate(callback) {
-        return __classPrivateFieldGet(this, _PullDocs_sourceManager, "f").onSourceUpdate(callback);
+        return this.#sourceManager.onSourceUpdate(callback);
     }
-    start() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return Promise.all(__classPrivateFieldGet(this, _PullDocs_sourceDefinitions, "f").map(source => __classPrivateFieldGet(this, _PullDocs_instances, "m", _PullDocs_addSource).call(this, source)));
-        });
+    async start() {
+        return Promise.all(this.#sourceDefinitions.map(source => this.addSource(source)));
     }
-    stop() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return __classPrivateFieldGet(this, _PullDocs_sourceManager, "f").destroyAll();
-        });
+    async stop() {
+        return this.#sourceManager.destroyAll();
     }
-}
-exports.default = PullDocs;
-_PullDocs_sourceDefinitions = new WeakMap(), _PullDocs_sourceManager = new WeakMap(), _PullDocs_ufs = new WeakMap(), _PullDocs_vfs = new WeakMap(), _PullDocs_instances = new WeakSet(), _PullDocs_addSource = function _PullDocs_addSource(sourceDefinition) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const source = yield __classPrivateFieldGet(this, _PullDocs_sourceManager, "f").addSource(sourceDefinition, {});
+    async triggerWorkflow(name, filePath, data) {
+        return this.#sourceManager.triggerWorkflow(name, filePath, data);
+    }
+    async addSource(sourceDefinition) {
+        const source = await this.#sourceManager.addSource(sourceDefinition, {});
         source.onError(error => {
-            console.error(new Error(`Source '${source.id.description}' threw an exception. See below:`));
+            console.error(new Error(`[Mosaic] Source '${source.id.description}' threw an exception. See below:`));
             console.error(error);
         });
         source.onExit(() => {
-            __classPrivateFieldGet(this, _PullDocs_ufs, "f").fss.splice(__classPrivateFieldGet(this, _PullDocs_ufs, "f").fss.indexOf(source.filesystem), 1);
-            if (__classPrivateFieldGet(this, _PullDocs_ufs, "f").fss.length < 1) {
-                console.debug("[PullDocs] All of my source have been terminated. That's sad :-(");
+            this.#ufs.fss.splice(this.#ufs.fss.indexOf(source.filesystem), 1);
+            if (this.#ufs.fss.length < 1) {
+                console.debug("[Mosaic] All of my source have been terminated. That's sad :-(");
             }
         });
-        __classPrivateFieldGet(this, _PullDocs_ufs, "f").use(source.filesystem);
+        this.#ufs.use(source.filesystem);
         return source;
-    });
-};
+    }
+    async stopSource(id) {
+        return this.#sourceManager.destroySource(id);
+    }
+}
 //# sourceMappingURL=PullDocs.js.map

package/dist/PullDocs.js.map

@@ -1 +1 @@
-{"version":3,"file":"PullDocs.js","sourceRoot":"","sources":["../src/PullDocs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,qCAAgC;AAOhC,oEAA4C;AAE5C,QAAQ;AACR,gCAAgC;AAChC,gFAAwD;AACxD,oFAA4D;AAC5D,4EAAoD;AACpD,iCAA+B;AAC/B,0EAAkD;AAElD,MAAqB,QAAQ;IAM3B;;;;;;;OAOG;IACH,YAAY,MAMX;;QAnBD,8CAA6C;QAC7C,0CAA8B;QAC9B,wBAAO,IAAI,eAAK,EAAyC,EAAC;QAC1D,gCAAkB;QAiBhB,MAAM,gBAAgB,GAAG,IAAI,uBAAa,CAAC,IAAI,oBAAU,CAAC,IAAI,cAAM,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QAC9E,uBAAA,IAAI,qBAAK,CAAC,GAAG,CAAC,gBAAkC,CAAC,CAAC;QAClD,MAAM,EACJ,WAAW,GAAG,EAAE,EAChB,OAAO,GAAG,EAAE,EACZ,OAAO,GAAG,EAAE,EACZ,WAAW,GAAG,EAAE,EAChB,cAAc,GAAG,CAAC,MAAM,CAAC,EAC1B,GAAG,MAAM,CAAC;QACX,uBAAA,IAAI,+BAAsB,OAAO,MAAA,CAAC;QAClC,uBAAA,IAAI,iBAAQ,IAAI,qBAAW,CAAC,IAAI,yBAAe,CAAC,uBAAA,IAAI,qBAAK,CAAC,EAAE,GAAG,CAAC,MAAA,CAAC;QACjE,uBAAA,IAAI,2BAAkB,IAAI,uBAAa;QACrC,+GAA+G;QAC/G,OAAO;aACJ,MAAM,CACL;YACE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,+CAA+C,CAAC;YAC5E,OAAO,EAAE,EAAE;SACZ,EACD;YACE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,mDAAmD,CAAC;YAChF,OAAO,EAAE,EAAE;YACX,iFAAiF;YACjF,QAAQ,EAAE,MAAM,CAAC,iBAAiB;SACnC,EACD;YACE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,iDAAiD,CAAC;YAC9E,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,CAAC,CAAC;SACb,EACD;YACE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,+CAA+C,CAAC;YAC5E,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,CAAC,CAAC;SACb,CACF;aACA,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,GAAG,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,SAAS,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC;QAC5F,2BAA2B;QAC3B,WAAW,CAAC,MAAM,CAAC;YACjB,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,6CAA6C,CAAC;YAC1E,MAAM,EAAE,SAAS;YACjB,OAAO,EAAE,EAAE;SACZ,CAAC,EACF,cAAc,EACd,WAAW,EACX,uBAAA,IAAI,qBAAK,EACT,gBAAgB,CACjB,MAAA,CAAC;IACJ,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,uBAAA,IAAI,qBAAK,CAAC;IACnB,CAAC;IAED,cAAc,CAAC,QAAQ;QACrB,OAAO,uBAAA,IAAI,+BAAe,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAEK,KAAK;;YACT,OAAO,OAAO,CAAC,GAAG,CAAC,uBAAA,IAAI,mCAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,uBAAA,IAAI,gDAAW,MAAf,IAAI,EAAY,MAAM,CAAC,CAAC,CAAC,CAAC;QACrF,CAAC;KAAA;IAEK,IAAI;;YACR,OAAO,uBAAA,IAAI,+BAAe,CAAC,UAAU,EAAE,CAAC;QAC1C,CAAC;KAAA;CAoBF;AAzGD,2BAyGC;4OAlBkB,gBAAgB;;QAC/B,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,+BAAe,CAAC,SAAS,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;QACzE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACrB,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,MAAM,CAAC,EAAE,CAAC,WAAW,kCAAkC,CAAC,CAAC,CAAC;YAC7F,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;YACjB,uBAAA,IAAI,qBAAK,CAAC,GAAG,CAAC,MAAM,CAAC,uBAAA,IAAI,qBAAK,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;YAElE,IAAI,uBAAA,IAAI,qBAAK,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC5B,OAAO,CAAC,KAAK,CAAC,kEAAkE,CAAC,CAAC;aACnF;QACH,CAAC,CAAC,CAAC;QAEH,uBAAA,IAAI,qBAAK,CAAC,GAAG,CAAC,MAAM,CAAC,UAA4B,CAAC,CAAC;QAEnD,OAAO,MAAM,CAAC;IAChB,CAAC"}
+{"version":3,"file":"PullDocs.js","sourceRoot":"","sources":["../src/PullDocs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAM/B,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAEzF,QAAQ;AACR,gCAAgC;AAChC,OAAO,UAAU,MAAM,6BAA6B,CAAC;AACrD,OAAO,aAAa,MAAM,gCAAgC,CAAC;AAC3D,OAAO,eAAe,MAAM,kCAAkC,CAAC;AAC/D,OAAO,WAAW,MAAM,8BAA8B,CAAC;AACvD,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,4BAA4B,MAAM,2CAA2C,CAAC;AAErF,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE/C,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,kBAAkB,CAA2B;IAC7C,cAAc,CAAgB;IAC9B,IAAI,GAAG,IAAI,KAAK,EAAyC,CAAC;IAC1D,IAAI,CAAc;IAElB;;;;;;;;OAQG;IACH,YAAY,MAAoB;QAC9B,MAAM,EACJ,WAAW,GAAG,EAAE,EAChB,OAAO,GAAG,EAAE,EACZ,OAAO,GAAG,EAAE,EACZ,WAAW,GAAG,EAAE,EAChB,cAAc,GAAG,CAAC,MAAM,CAAC,EACzB,QAAQ,EACT,GAAG,oBAAoB,CAAC,kBAAkB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAC3D,MAAM,gBAAgB,GAAG,IAAI,aAAa,CAAC,IAAI,UAAU,CAAC,IAAI,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QAC9E,8DAA8D;QAC9D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAkC,CAAC,CAAC;QAElD,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAA8B,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC/F,IAAI,CAAC,IAAI,GAAG,IAAI,WAAW,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACjE,IAAI,CAAC,cAAc,GAAG,IAAI,aAAa,CACrC,IAAI,CAAC,IAAI,EACT,gBAAgB;QAChB,+GAA+G;QAC/G,4BAA4B,CAAC,OAAO,CAAC;aAClC,MAAM,CAAC,CAAC,MAA8B,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;aAC5D,MAAM,CACL;YACE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,0CAA0C,CAAC;YACvE,OAAO,EAAE,EAAE;SACZ,EACD;YACE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,8CAA8C,CAAC;YAC3E,OAAO,EAAE,EAAE;YACX,iFAAiF;YACjF,QAAQ,EAAE,MAAM,CAAC,iBAAiB;SACnC,EACD;YACE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,4CAA4C,CAAC;YACzE,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,CAAC,CAAC;SACb,EACD;YACE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,0CAA0C,CAAC;YACvE,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,CAAC,CAAC;SACb,CACF;aACA,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,GAAG,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,SAAS,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC;QAC5F,2BAA2B;QAC3B,WAAW,CAAC,MAAM,CAAC;YACjB,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,wCAAwC,CAAC;YACrE,MAAM,EAAE,SAAS;SAClB,CAAC,EACF,cAAc,EACd,WAAW,EACX,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,cAAc,CAAC,QAAQ;QACrB,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,KAAK;QACT,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACpF,CAAC;IAED,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,IAAY,EAAE,QAAgB,EAAE,IAAI;QACxD,OAAO,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,gBAAwC;QACtD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;QACzE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACrB,OAAO,CAAC,KAAK,CACX,IAAI,KAAK,CAAC,oBAAoB,MAAM,CAAC,EAAE,CAAC,WAAW,kCAAkC,CAAC,CACvF,CAAC;YACF,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;YACjB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;YAElE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC5B,OAAO,CAAC,KAAK,CAAC,gEAAgE,CAAC,CAAC;aACjF;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,UAAiC,CAAC,CAAC;QAExD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IAC/C,CAAC;CACF"}

package/dist/Source.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="node" resolution-mode="require"/>
+import EventEmitter from 'events';
+import type { IUnionVolume, IVolumeImmutable, MutableData, PluginModuleDefinition, Serialiser, SerialiserModuleDefinition, SourceModuleDefinition, SourceWorkflow } from '@jpmorganchase/mosaic-types';
+import MutableVolume from './filesystems/MutableVolume.js';
+export default class Source {
+    #private;
+    config: MutableData<Record<string, unknown>>;
+    serialiser: Serialiser;
+    namespace: string;
+    id: symbol;
+    filesystem: MutableVolume;
+    constructor({ modulePath, namespace, schedule }: SourceModuleDefinition, mergedOptions: Record<string, unknown>, pageExtensions: string[], ignorePages: string[], globalFilesystem: IUnionVolume, workflows?: SourceWorkflow[]);
+    onUpdate(callback: any): () => EventEmitter;
+    onError(callback: any): () => EventEmitter;
+    onStart(callback: any): () => EventEmitter;
+    onExit(callback: any): () => EventEmitter;
+    stop(): void;
+    /**
+     * Called when another source (not this one) has changed.
+     * This source can then ask its plugins if they also want to clear their cache in response to the other source's change.
+     */
+    requestCacheClear(updatedSourceFilesystem: IVolumeImmutable): Promise<void>;
+    use(plugins?: PluginModuleDefinition[], serialisers?: SerialiserModuleDefinition[]): Promise<void>;
+    invokeAfterUpdate(sharedFilesystem: any, globalConfig: any): Promise<void>;
+    start(): Promise<void>;
+    isOwner(filePath: string): Promise<any>;
+    triggerWorkflow(name: string, filePath: string, data: unknown): Promise<any>;
+}

package/dist/Source.js

@@ -1,165 +1,166 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-var _Source_instances, _Source_emitter, _Source_modulePath, _Source_plugins, _Source_serialisers, _Source_worker, _Source_globalFilesystem, _Source_pluginApi, _Source_mergedOptions, _Source_pageExtensions, _Source_ignorePages, _Source_createWorker;
-Object.defineProperty(exports, "__esModule", { value: true });
-const events_1 = __importDefault(require("events"));
-const memfs_1 = require("memfs");
-const util_1 = __importDefault(require("util"));
-const md5_1 = __importDefault(require("md5"));
-const path_1 = __importDefault(require("path"));
-const plugin_1 = require("./plugin");
-const WorkerSubscription_1 = __importDefault(require("./WorkerSubscription"));
-const WorkerSubscription_2 = require("./WorkerSubscription");
-const createConfig_1 = __importDefault(require("./helpers/createConfig"));
-const MutableVolume_1 = __importDefault(require("./filesystems/MutableVolume"));
-const FileAccess_1 = __importDefault(require("./filesystems/FileAccess"));
-class Source {
-    constructor({ modulePath, namespace }, mergedOptions, pageExtensions, ignorePages, globalFilesystem) {
-        _Source_instances.add(this);
-        _Source_emitter.set(this, new events_1.default());
-        _Source_modulePath.set(this, void 0);
-        _Source_plugins.set(this, []);
-        _Source_serialisers.set(this, []);
-        _Source_worker.set(this, void 0);
-        _Source_globalFilesystem.set(this, void 0);
-        _Source_pluginApi.set(this, void 0);
-        _Source_mergedOptions.set(this, void 0);
-        _Source_pageExtensions.set(this, void 0);
-        _Source_ignorePages.set(this, void 0);
-        __classPrivateFieldSet(this, _Source_modulePath, modulePath, "f");
-        __classPrivateFieldSet(this, _Source_mergedOptions, mergedOptions, "f");
-        __classPrivateFieldSet(this, _Source_globalFilesystem, globalFilesystem, "f");
-        __classPrivateFieldSet(this, _Source_ignorePages, ignorePages, "f");
+import EventEmitter from 'events';
+import md5 from 'md5';
+import { Volume } from 'memfs';
+import path from 'path';
+import util from 'util';
+import FileAccess from './filesystems/FileAccess.js';
+import MutableVolume from './filesystems/MutableVolume.js';
+import createConfig from './helpers/createConfig.js';
+import { bindPluginMethods, bindSerialiser } from './plugin/index.js';
+import WorkerSubscription, { EVENT } from './WorkerSubscription.js';
+export default class Source {
+    #emitter = new EventEmitter();
+    #modulePath;
+    #plugins = [];
+    #serialisers = [];
+    #worker;
+    #globalFilesystem;
+    #pluginApi;
+    #mergedOptions;
+    #pageExtensions;
+    #ignorePages;
+    #workflows = [];
+    #schedule;
+    config;
+    serialiser;
+    namespace;
+    id;
+    filesystem;
+    constructor({ modulePath, namespace, schedule }, mergedOptions, pageExtensions, ignorePages, globalFilesystem, workflows = []) {
+        this.#modulePath = modulePath;
+        this.#mergedOptions = mergedOptions;
+        this.#globalFilesystem = globalFilesystem;
+        this.#ignorePages = ignorePages;
+        this.#workflows = workflows;
+        this.#schedule = schedule;
         this.namespace = namespace;
-        this.id = Symbol(`${path_1.default.basename(path_1.default.dirname(path_1.default.resolve(modulePath, '../')))}#${(0, md5_1.default)(util_1.default.inspect(__classPrivateFieldGet(this, _Source_mergedOptions, "f"), { sorted: true })).substring(0, 8)}`);
-        this.filesystem = new MutableVolume_1.default(new FileAccess_1.default(new memfs_1.Volume()), this.namespace);
-        __classPrivateFieldSet(this, _Source_pageExtensions, pageExtensions, "f");
+        this.id = Symbol(`${path.basename(path.dirname(path.resolve(modulePath, '../')))}#${md5(util.inspect(this.#mergedOptions, { sorted: true })).substring(0, 8)}`);
+        this.filesystem = new MutableVolume(new FileAccess(new Volume()), this.namespace);
+        this.#pageExtensions = pageExtensions;
     }
     onUpdate(callback) {
-        __classPrivateFieldGet(this, _Source_emitter, "f").on(WorkerSubscription_2.EVENT.UPDATE, callback);
-        return () => __classPrivateFieldGet(this, _Source_emitter, "f").off(WorkerSubscription_2.EVENT.UPDATE, callback);
+        this.#emitter.on(EVENT.UPDATE, callback);
+        return () => this.#emitter.off(EVENT.UPDATE, callback);
     }
     onError(callback) {
-        __classPrivateFieldGet(this, _Source_emitter, "f").once(WorkerSubscription_2.EVENT.ERROR, callback);
-        return () => __classPrivateFieldGet(this, _Source_emitter, "f").off(WorkerSubscription_2.EVENT.ERROR, callback);
+        this.#emitter.once(EVENT.ERROR, callback);
+        return () => this.#emitter.off(EVENT.ERROR, callback);
     }
     onStart(callback) {
-        __classPrivateFieldGet(this, _Source_emitter, "f").once(WorkerSubscription_2.EVENT.START, callback);
-        return () => __classPrivateFieldGet(this, _Source_emitter, "f").off(WorkerSubscription_2.EVENT.START, callback);
+        this.#emitter.once(EVENT.START, callback);
+        return () => this.#emitter.off(EVENT.START, callback);
     }
     onExit(callback) {
-        __classPrivateFieldGet(this, _Source_emitter, "f").once(WorkerSubscription_2.EVENT.EXIT, callback);
-        return () => __classPrivateFieldGet(this, _Source_emitter, "f").off(WorkerSubscription_2.EVENT.EXIT, callback);
+        this.#emitter.once(EVENT.EXIT, callback);
+        return () => this.#emitter.off(EVENT.EXIT, callback);
     }
     stop() {
-        if (__classPrivateFieldGet(this, _Source_worker, "f") && __classPrivateFieldGet(this, _Source_worker, "f").closed) {
+        if (this.#worker && this.#worker.closed) {
             throw new Error('Cannot stop source that has not started');
         }
-        if (__classPrivateFieldGet(this, _Source_worker, "f")) {
-            __classPrivateFieldGet(this, _Source_worker, "f").stop();
+        if (this.#worker) {
+            this.#worker.stop();
         }
     }
     /**
      * Called when another source (not this one) has changed.
      * This source can then ask its plugins if they also want to clear their cache in response to the other source's change.
      */
-    requestCacheClear(updatedSourceFilesystem) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const initTime = new Date().getTime();
-            const shouldInvokeAfterUpdate = yield __classPrivateFieldGet(this, _Source_pluginApi, "f").shouldClearCache(updatedSourceFilesystem, {
-                globalFilesystem: __classPrivateFieldGet(this, _Source_globalFilesystem, "f"),
-                pageExtensions: __classPrivateFieldGet(this, _Source_pageExtensions, "f"),
-                ignorePages: __classPrivateFieldGet(this, _Source_ignorePages, "f"),
-                serialiser: this.serialiser,
-                config: this.config.asReadOnly()
-            });
-            const timeTaken = new Date().getTime() - initTime;
-            if (timeTaken > 400) {
-                console.warn(`Lifecycle phase 'shouldClearCache' for source '${this.id.description}' took ${timeTaken}ms to complete. The method is async, so this may not be an accurate measurement of execution time, but consider optimising this method if it is performing intensive operations.`);
-            }
-            if (shouldInvokeAfterUpdate === true) {
-                this.filesystem.clearCache();
-            }
+    async requestCacheClear(updatedSourceFilesystem) {
+        const initTime = new Date().getTime();
+        const shouldInvokeAfterUpdate = await this.#pluginApi.shouldClearCache(updatedSourceFilesystem, {
+            globalFilesystem: this.#globalFilesystem,
+            pageExtensions: this.#pageExtensions,
+            ignorePages: this.#ignorePages,
+            serialiser: this.serialiser,
+            config: this.config.asReadOnly()
         });
+        const timeTaken = new Date().getTime() - initTime;
+        if (timeTaken > 400) {
+            console.warn(`Lifecycle phase 'shouldClearCache' for source '${this.id.description}' took ${timeTaken}ms to complete. The method is async, so this may not be an accurate measurement of execution time, but consider optimising this method if it is performing intensive operations.`);
+        }
+        if (shouldInvokeAfterUpdate === true) {
+            this.filesystem.clearCache();
+        }
+    }
+    async use(plugins = [], serialisers = []) {
+        if (this.namespace.startsWith('preview-')) {
+            console.log('[Mosaic] Preview source detected, filtering plugins to use.');
+            this.#plugins.push(...plugins.filter(plugin => !plugin.previewDisabled));
+        }
+        else {
+            this.#plugins.push(...plugins);
+        }
+        this.#serialisers.push(...serialisers);
     }
-    use(plugins = [], serialisers = []) {
-        return __awaiter(this, void 0, void 0, function* () {
-            __classPrivateFieldGet(this, _Source_plugins, "f").push(...plugins);
-            __classPrivateFieldGet(this, _Source_serialisers, "f").push(...serialisers);
+    async invokeAfterUpdate(sharedFilesystem, globalConfig) {
+        const initTime = new Date().getTime();
+        await this.#pluginApi.afterUpdate(this.filesystem.asRestricted(), {
+            globalFilesystem: this.#globalFilesystem,
+            sharedFilesystem,
+            globalConfig,
+            pageExtensions: this.#pageExtensions,
+            ignorePages: this.#ignorePages,
+            serialiser: this.serialiser,
+            config: this.config.asReadOnly()
         });
+        const timeTaken = new Date().getTime() - initTime;
+        if (timeTaken > 800) {
+            console.warn(`Lifecycle phase 'afterUpdate' for source '${this.id.description}' took ${timeTaken / 1000}s to complete. The method is async, so this may not be an accurate measurement of execution time, but consider optimising this method if it is performing intensive operations.`);
+        }
     }
-    invokeAfterUpdate(sharedFilesystem, globalConfig) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const initTime = new Date().getTime();
-            yield __classPrivateFieldGet(this, _Source_pluginApi, "f").afterUpdate(this.filesystem.asRestricted(), {
-                globalFilesystem: __classPrivateFieldGet(this, _Source_globalFilesystem, "f"),
-                sharedFilesystem,
-                globalConfig,
-                pageExtensions: __classPrivateFieldGet(this, _Source_pageExtensions, "f"),
-                ignorePages: __classPrivateFieldGet(this, _Source_ignorePages, "f"),
-                serialiser: this.serialiser,
-                config: this.config.asReadOnly()
-            });
-            const timeTaken = new Date().getTime() - initTime;
-            if (timeTaken > 800) {
-                console.warn(`Lifecycle phase 'afterUpdate' for source '${this.id.description}' took ${timeTaken / 1000}s to complete. The method is async, so this may not be an accurate measurement of execution time, but consider optimising this method if it is performing intensive operations.`);
-            }
+    #createWorker() {
+        const worker = new WorkerSubscription({
+            modulePath: this.#modulePath,
+            name: this.id.description,
+            options: this.#mergedOptions,
+            namespace: this.namespace,
+            pageExtensions: this.#pageExtensions,
+            ignorePages: this.#ignorePages,
+            plugins: this.#plugins,
+            serialisers: this.#serialisers,
+            schedule: this.#schedule
         });
+        worker.once(EVENT.ERROR, error => this.#emitter.emit(EVENT.ERROR, error));
+        worker.once(EVENT.EXIT, () => {
+            this.#emitter.emit(EVENT.EXIT);
+            this.#emitter.removeAllListeners();
+            // this.filesystem.reset();
+            this.filesystem = null;
+        });
+        worker.once(EVENT.START, () => this.#emitter.emit(EVENT.START));
+        return worker;
     }
-    start() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.serialiser = yield (0, plugin_1.bindSerialiser)(__classPrivateFieldGet(this, _Source_serialisers, "f"));
-            __classPrivateFieldSet(this, _Source_pluginApi, yield (0, plugin_1.bindPluginMethods)(__classPrivateFieldGet(this, _Source_plugins, "f")), "f");
-            __classPrivateFieldSet(this, _Source_worker, __classPrivateFieldGet(this, _Source_instances, "m", _Source_createWorker).call(this), "f");
-            __classPrivateFieldGet(this, _Source_worker, "f").on(WorkerSubscription_2.EVENT.UPDATE, ({ data: { pages, symlinks, data } }) => __awaiter(this, void 0, void 0, function* () {
-                this.config = (0, createConfig_1.default)(data);
-                __classPrivateFieldGet(this, _Source_emitter, "f").emit(WorkerSubscription_2.EVENT.UPDATE, { pages, symlinks, data });
-            }));
+    async start() {
+        this.serialiser = await bindSerialiser(this.#serialisers);
+        this.#pluginApi = await bindPluginMethods(this.#plugins);
+        this.#worker = this.#createWorker();
+        this.#worker.on(EVENT.UPDATE, async ({ data: { pages, symlinks, data } }) => {
+            this.config = createConfig(data);
+            this.#emitter.emit(EVENT.UPDATE, { pages, symlinks, data });
         });
     }
+    async isOwner(filePath) {
+        const isFileInSource = await this.filesystem.promises.exists(filePath);
+        return isFileInSource;
+    }
+    async triggerWorkflow(name, filePath, data) {
+        const foundWorkflows = this.#workflows.filter(workflow => workflow.name === name);
+        if (foundWorkflows.length === 0) {
+            return {
+                error: `[Mosaic] Workflow ${name} not found for ${this.id.description.toString()}`
+            };
+        }
+        if (foundWorkflows.length > 1) {
+            return {
+                error: `[Mosaic] Multiple workflows with "${name}" found for ${this.id.description.toString()}`
+            };
+        }
+        const triggeredWorkflow = foundWorkflows[0];
+        if (triggeredWorkflow) {
+            return triggeredWorkflow.action(this.#mergedOptions, triggeredWorkflow.options, filePath, data);
+        }
+        return false;
+    }
 }
-exports.default = Source;
-_Source_emitter = new WeakMap(), _Source_modulePath = new WeakMap(), _Source_plugins = new WeakMap(), _Source_serialisers = new WeakMap(), _Source_worker = new WeakMap(), _Source_globalFilesystem = new WeakMap(), _Source_pluginApi = new WeakMap(), _Source_mergedOptions = new WeakMap(), _Source_pageExtensions = new WeakMap(), _Source_ignorePages = new WeakMap(), _Source_instances = new WeakSet(), _Source_createWorker = function _Source_createWorker() {
-    const worker = new WorkerSubscription_1.default({
-        modulePath: __classPrivateFieldGet(this, _Source_modulePath, "f"),
-        name: this.id.description,
-        options: __classPrivateFieldGet(this, _Source_mergedOptions, "f"),
-        namespace: this.namespace,
-        pageExtensions: __classPrivateFieldGet(this, _Source_pageExtensions, "f"),
-        ignorePages: __classPrivateFieldGet(this, _Source_ignorePages, "f"),
-        plugins: __classPrivateFieldGet(this, _Source_plugins, "f"),
-        serialisers: __classPrivateFieldGet(this, _Source_serialisers, "f")
-    });
-    worker.once(WorkerSubscription_2.EVENT.ERROR, error => __classPrivateFieldGet(this, _Source_emitter, "f").emit(WorkerSubscription_2.EVENT.ERROR, error));
-    worker.once(WorkerSubscription_2.EVENT.EXIT, () => {
-        __classPrivateFieldGet(this, _Source_emitter, "f").emit(WorkerSubscription_2.EVENT.EXIT);
-        __classPrivateFieldGet(this, _Source_emitter, "f").removeAllListeners();
-        //this.filesystem.reset();
-        this.filesystem = null;
-    });
-    worker.once(WorkerSubscription_2.EVENT.START, () => __classPrivateFieldGet(this, _Source_emitter, "f").emit(WorkerSubscription_2.EVENT.START));
-    return worker;
-};
 //# sourceMappingURL=Source.js.map