@jpmorganchase/mosaic-types 0.1.0-beta.51 → 0.1.0-beta.53

package/dist/Plugin.d.ts

@@ -139,4 +139,32 @@ export declare type Plugin<TPage extends Page = Page, TOptions = Record<string,
         ignorePages: string[];
         namespace: string;
     }, options?: TOptions) => Promise<boolean>;
+    /**
+     * Plugin lifecycle method that triggers inside the main process **ONLY** if the `shouldUpdateNamespaceSources` method returns true.
+     * Calls after the filesystem and symlinks have been reconstructed due to a change to the current source. This happens in the main thread.
+     * Pages will NOT be cached when read at this stage, to allow for reading content and writing a new copy of it without the cached version taking effect.
+     * This method is safe to use with lazy loading, as the filesystem should return the full page when read.
+     * NOTE: Plugin methods that trigger inside the parent process should be async and highly optimised to avoid holding up the main thread.
+     * You should also be mindful of race conditions when reading / writing to the global filesystem from this method - as other plugins may
+     * also have a read copy of the same file and it could end up out of sync.
+     * @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.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
+     */
+    afterNamespaceSourceUpdate?: (mutableFilesystem: IVolumePartiallyMutable, helpers: {
+        serialiser: Serialiser<TPage>;
+        config: ImmutableData<ConfigData>;
+        globalFilesystem: IUnionVolume;
+        sharedFilesystem: IVolumeMutable;
+        globalConfig: ImmutableData<GlobalConfigData>;
+        pageExtensions: string[];
+        ignorePages: string[];
+        namespace: string;
+    }, options?: TOptions) => Promise<void>;
 };

package/dist/SourceWorkflow.d.ts

@@ -1,6 +1,13 @@
-export declare type SourceWorkflowAction<TSourceOptions, TOptions> = (sourceOptions: TSourceOptions, workflowOptions: TOptions, ...args: any[]) => Promise<unknown>;
+export declare type SourceWorkflowAction<TSourceOptions, TOptions> = (sendWorkflowProgressMessage: SendSourceWorkflowMessage, sourceOptions: TSourceOptions, workflowOptions: TOptions, ...args: any[]) => Promise<unknown>;
 export declare type SourceWorkflow<TSourceOptions = unknown, TOptions = unknown> = {
     name: string;
     options?: TOptions;
     action: SourceWorkflowAction<TSourceOptions, TOptions>;
 };
+export declare type SourceWorkflowMessageStatus = 'SUCCESS' | 'ERROR' | 'IN_PROGRESS' | 'COMPLETE';
+export declare type SendSourceWorkflowMessage = (message: any, status: SourceWorkflowMessageStatus) => void;
+export declare type SourceWorkflowMessageEvent = {
+    status: SourceWorkflowMessageStatus;
+    message: any;
+    channel?: string;
+};

package/dist/index.d.ts

@@ -11,4 +11,5 @@ export * from './Volume.js';
 export * from './WorkerData.js';
 export * from './Mode.js';
 export * from './Session.js';
+export * from './SourceWorkflow.js';
 export { SerialiserModuleDefinition, MosaicConfig, PluginModuleDefinition, SourceModuleDefinition, SourceWorkflow, SourceSchedule };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jpmorganchase/mosaic-types",
-  "version": "0.1.0-beta.51",
+  "version": "0.1.0-beta.53",
   "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.51",
+    "@jpmorganchase/mosaic-schemas": "^0.1.0-beta.53",
     "memfs": "^3.4.12",
     "rxjs": "^7.5.5",
     "zod": "^3.22.3"