@jpmorganchase/mosaic-types 0.1.0-beta.41 → 0.1.0-beta.43

package/dist/Plugin.d.ts

@@ -5,6 +5,30 @@ import type { Page } from './Page.js';
 import type { MutableData, ImmutableData } from './MutableData.js';
 export declare type LoadedPlugin = Partial<Plugin<Page>> & PluginModuleDefinition;
 export declare type LifecycleMethod = keyof Plugin<Page>;
+export declare type PluginErrorDescriptor = {
+    /**
+     * The plugin lifecycle method running when the error occurred
+     */
+    lifecycleMethod: string;
+    /**
+     * The path to the loaded plugin module
+     */
+    pluginModulePath: string;
+    /**
+     * The name of the plugin
+     */
+    pluginName: string;
+    /**
+     * The name of the error
+     */
+    name: string;
+    /**
+     * The path of the file that triggered the plugin error
+     */
+    fullPath?: string;
+};
+export declare type PluginErrors = Array<PluginErrorDescriptor>;
+export declare type TrackPluginErrorCallback = (errors: Array<PluginErrorDescriptor>, lifecycleMethod: string) => void;
 /**
  * Plugins are lifecycle-based hooks that are called on every source at different stages.
  * Consumers will never need to invoke a lifecycle method; but for technical clarity - when a lifecycle method is called,
@@ -18,6 +42,7 @@ export declare type Plugin<TPage extends Page = Page, TOptions = Record<string,
      * @param pages Array of pages from the source
      * @param param.serialiser A matching `Serialiser` for serialising/deserialising pages when reading/writing to the filesystem
      * @param param.config A mutable object for sharing data with other lifecycle phases of all plugins for this source (including in the main thread) in this plugin
+     * @param param.namespace The namespace of the source running the plugin
      * @param options The options passed in when declaring the plugin
      * @returns {Promise<Page[]>} Must re-return an array of `Page` objects, modified or not
      */
@@ -26,6 +51,7 @@ export declare type Plugin<TPage extends Page = Page, TOptions = Record<string,
         config: MutableData<ConfigData>;
         pageExtensions: string[];
         ignorePages: string[];
+        namespace: string;
     }, options?: TOptions) => Promise<Array<TPage>>;
     /**
      * Plugin lifecycle method that triggers inside child processes.
@@ -33,6 +59,7 @@ export declare type Plugin<TPage extends Page = Page, TOptions = Record<string,
      * @param mutableFilesystem Mutable virtual filesystem instance with all of this source's pages inside (and symlinks applied)
      * @param param.serialiser A matching `Serialiser` for serialising/deserialising pages when reading/writing to the filesystem
      * @param param.config A mutable object for sharing data with other lifecycle phases of all plugins for this source (including in the main thread) in this plugin
+     * @param param.namespace The namespace of the source running the plugin
      * @param options The options passed in when declaring the plugin
      * @returns {void} No return expected
      */
@@ -41,6 +68,7 @@ export declare type Plugin<TPage extends Page = Page, TOptions = Record<string,
         pageExtensions: string[];
         ignorePages: string[];
         config: MutableData<ConfigData>;
+        namespace: string;
     }, options?: TOptions) => Promise<void>;
     /**
      * Plugin lifecycle method that triggers inside the main process.
@@ -56,6 +84,7 @@ export declare type Plugin<TPage extends Page = Page, TOptions = Record<string,
      * @param param.globalConfig An immutable object for reading data from other lifecycle phases of all plugins. Shared across all sources.
      * @param param.sharedFilesystem Mutable filesystem instance independent of any sources. Useful for global pages, like sitemaps
      * @param param.globalFilesystem Immutable union filesystem instance with all source's pages (and symlinks applied)
+     * @param param.namespace The namespace of the source running the plugin
      * @param options The options passed in when declaring the plugin
      * @returns {void} No return expected
      */
@@ -67,6 +96,7 @@ export declare type Plugin<TPage extends Page = Page, TOptions = Record<string,
         globalConfig: ImmutableData<GlobalConfigData>;
         pageExtensions: string[];
         ignorePages: string[];
+        namespace: string;
     }, options?: TOptions) => Promise<void>;
     /**
      * Plugin lifecycle method that triggers inside the main process everytime ANY source emits new pages.
@@ -77,6 +107,7 @@ export declare type Plugin<TPage extends Page = Page, TOptions = Record<string,
      * @param param.config An immutable object for reading data from other lifecycle phases of all plugins for this source in the child process for this plugin
      * @param param.serialiser A matching `Serialiser` for serialising/deserialising pages when reading/writing to the filesystem
      * @param param.globalFilesystem Immutable union filesystem instance with all source's pages (and symlinks applied)
+     * @param param.namespace The namespace of the source running the plugin
      * @param options The options passed in when declaring the plugin
      * @returns {Promise<boolean>} A boolean indicating whether to clear the cache for this source
      */
@@ -86,28 +117,6 @@ export declare type Plugin<TPage extends Page = Page, TOptions = Record<string,
         globalFilesystem: IUnionVolume;
         pageExtensions: string[];
         ignorePages: string[];
-    }, options?: TOptions) => Promise<boolean>;
-    /**
-     * Plugin lifecycle method that triggers inside the main process whenever a request to save content is made.
-     * This method should return the result of the save
-     * Returning `undefined`, false or no value, will result in the plugin runner discarding the result.
-     * @param path the route of the content being edited.
-     * @param data the data from the the request
-     * @param sourceOptions options used to create the source that is running the plugin
-     * @param mutableFilesystem Mutable filesystem instance with all of this source's pages inside (and symlinks re-applied)
-     * @param param.serialiser A matching `Serialiser` for serialising/deserialising pages when reading/writing to the filesystem
-     * @param param.config An immutable object for reading data from other lifecycle phases of all plugins for this source in the child process for this plugin. Shared only with this source.
-     * @param param.sharedFilesystem Mutable filesystem instance independent of any sources. Useful for global pages, like sitemaps
-     * @param param.namespace The namespace of the source running the plugin
-     * @param options The options passed in when declaring the plugin
-     * @returns {Promise<unknown>} The result of the save
-     */
-    saveContent?(path: string, data: unknown, sourceOptions: unknown, helpers: {
-        serialiser: Serialiser<TPage>;
-        config: ImmutableData<ConfigData>;
-        sharedFilesystem: IVolumeMutable;
-        pageExtensions: string[];
-        ignorePages: string[];
         namespace: string;
-    }, options?: TOptions): Promise<unknown>;
+    }, options?: TOptions) => Promise<boolean>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jpmorganchase/mosaic-types",
-  "version": "0.1.0-beta.41",
+  "version": "0.1.0-beta.43",
   "description": "Mosaic BitBucket source for core file system",
   "license": "Apache-2.0",
   "author": "",
@@ -28,7 +28,7 @@
     "lint": "eslint --ignore-pattern \"**/__tests__/**\""
   },
   "devDependencies": {
-    "@jpmorganchase/mosaic-schemas": "^0.1.0-beta.41",
+    "@jpmorganchase/mosaic-schemas": "^0.1.0-beta.43",
     "memfs": "^3.4.12",
     "rxjs": "^7.5.5",
     "zod": "^3.19.1"