@jpmorganchase/mosaic-types 0.1.0-beta.6 → 0.1.0-beta.7

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @jpmorganchase/mosaic-types
 
+## 0.1.0-beta.7
+
+### Minor Changes
+
+- 46adaec: Initial release of theme and client side search
+
+  We are iterating towards deploying our site code.
+
+  This release includes
+
+  - initial work for client-side search support
+  - Mosaic theme.
+
 ## 0.1.0-beta.6
 
 ### Patch Changes

package/dist/Page.d.ts

@@ -1,7 +1,7 @@
 /**
  * `Page` is a type, which at a minimum has a `fullPath`, but can also contain metadata and `content`
  */
-export declare type Page<AdditionalProps = {}> = {
+export declare type Page = {
     fullPath: string;
     title?: string;
     /**
@@ -17,4 +17,4 @@ export declare type Page<AdditionalProps = {}> = {
     lastModified?: Date;
     type?: string;
     content?: string;
-} & Record<string, unknown> & AdditionalProps;
+};

package/dist/Plugin.d.ts

@@ -1,16 +1,16 @@
 import type { Page } from './Page';
-import type { MutableData } from './MutableData';
-import type { PluginModuleDefinition } from './PluginModuleDefinition';
-import type { ImmutableData } from './MutableData';
+import type { MutableData, ImmutableData } from './MutableData';
+import type { PluginModuleDefinition } from './index';
 import type { IUnionVolume, IVolumeImmutable, IVolumeMutable, IVolumePartiallyMutable } from './Volume';
 import type { Serialiser } from './Serialiser';
-export declare type LoadedPlugin = Partial<Plugin> & PluginModuleDefinition;
+export declare type LoadedPlugin = Partial<Plugin<Page>> & PluginModuleDefinition;
+export declare type LifecycleMethod = keyof Plugin<Page>;
 /**
  * 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,
  * it will trigger `pluginRunner` which executes it on every source automatically.
  */
-export declare type Plugin<ConfigData = {}, PluginOptions = {}, GlobalConfigData = ConfigData> = {
+export declare type Plugin<TPage extends Page = Page, TOptions = Record<string, unknown>, ConfigData = Record<string, unknown>, GlobalConfigData = ConfigData> = {
     /**
      * Plugin lifecycle method that triggers inside child processes.
      * The first lifecycle hook to trigger after receiving pages from a source. The pages can safely be mutated and will be reflected in the final
@@ -21,12 +21,12 @@ export declare type Plugin<ConfigData = {}, PluginOptions = {}, GlobalConfigData
      * @param options The options passed in when declaring the plugin
      * @returns {Promise<Page[]>} Must re-return an array of `Page` objects, modified or not
      */
-    $afterSource?(pages: Page[], {}: {
-        serialiser: Serialiser;
+    $afterSource?: (pages: TPage[], helpers: {
+        serialiser: Serialiser<TPage>;
         config: MutableData<ConfigData>;
         pageExtensions: string[];
         ignorePages: string[];
-    }, options?: Pick<PluginModuleDefinition, 'options'> & PluginOptions): Promise<Page[]>;
+    }, options?: TOptions) => Promise<Array<TPage>>;
     /**
      * Plugin lifecycle method that triggers inside child processes.
      * Calls after a filesystem has been built up from the source pages.
@@ -36,12 +36,12 @@ export declare type Plugin<ConfigData = {}, PluginOptions = {}, GlobalConfigData
      * @param options The options passed in when declaring the plugin
      * @returns {void} No return expected
      */
-    $beforeSend?(mutableFilesystem: IVolumePartiallyMutable, {}: {
-        serialiser: Serialiser;
+    $beforeSend?: (mutableFilesystem: IVolumePartiallyMutable, helpers: {
+        serialiser: Serialiser<TPage>;
         pageExtensions: string[];
         ignorePages: string[];
         config: MutableData<ConfigData>;
-    }, options?: Pick<PluginModuleDefinition, 'options'> & PluginOptions): Promise<void>;
+    }, options?: TOptions) => Promise<void>;
     /**
      * Plugin lifecycle method that triggers inside the main process.
      * Calls after the filesystem and symlinks have been reconstructed due to a change to the current source. This happens in the main thread.
@@ -59,15 +59,15 @@ export declare type Plugin<ConfigData = {}, PluginOptions = {}, GlobalConfigData
      * @param options The options passed in when declaring the plugin
      * @returns {void} No return expected
      */
-    afterUpdate?(mutableFilesystem: IVolumePartiallyMutable, {}: {
-        serialiser: Serialiser;
+    afterUpdate?: (mutableFilesystem: IVolumePartiallyMutable, helpers: {
+        serialiser: Serialiser<TPage>;
         config: ImmutableData<ConfigData>;
         globalFilesystem: IUnionVolume;
         sharedFilesystem: IVolumeMutable;
         globalConfig: ImmutableData<GlobalConfigData>;
         pageExtensions: string[];
         ignorePages: string[];
-    }, options?: Pick<PluginModuleDefinition, 'options'> & PluginOptions): Promise<void>;
+    }, options?: TOptions) => Promise<void>;
     /**
      * Plugin lifecycle method that triggers inside the main process everytime ANY source emits new pages.
      * This method should return a boolean that will indicate if this source should clear page caches.
@@ -80,12 +80,34 @@ export declare type Plugin<ConfigData = {}, PluginOptions = {}, GlobalConfigData
      * @param options The options passed in when declaring the plugin
      * @returns {Promise<boolean>} A boolean indicating whether to clear the cache for this source
      */
-    shouldClearCache?(updatedSourceFilesystem: IVolumeImmutable, {}: {
-        serialiser: Serialiser;
+    shouldClearCache?: (updatedSourceFilesystem: IVolumeImmutable, helpers: {
+        serialiser: Serialiser<TPage>;
         config: ImmutableData<ConfigData>;
         globalFilesystem: IUnionVolume;
         pageExtensions: string[];
         ignorePages: string[];
-    }, options?: Pick<PluginModuleDefinition, 'options'> & PluginOptions): Promise<boolean>;
+    }, 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>;
 };
-export declare type LifecycleMethod = keyof Plugin;

package/dist/Serialiser.d.ts

@@ -1,26 +1,26 @@
 import type { TDataOut } from 'memfs/lib/encoding';
+import type { SerialiserModuleDefinition } from './index';
 import type { Page } from './Page';
-import type { SerialiserModuleDefinition } from './SerialiserModuleDefinition';
 /**
- * Serialisers are a form of plugin that tells PullDocs how to turn a file from/to a storable form for the filesystem
+ * Serialisers are a form of plugin that tells Mosaic how to turn a file from/to a storable form for the filesystem
  * or a `Page` object.
  * For technical clarity - when a parser method is called, it will trigger `parserRunner` which checks the `fullPath` against
- * the `test` option that was passed in the PullDocs config file, to find a suitable parser.
+ * the `test` option that was passed in the Mosaic config file, to find a suitable parser.
  */
-export declare type Serialiser = {
+export declare type Serialiser<TPage extends Page = Page> = {
     /**
      * Method to turn a raw page (e.g. an MDX file) into a `Page` object
      * @param fullPath Route on virtual disk (should be full fullPath, not an alias)
      * @param page Page in string or buffer form (i.e. an MDX page with frontmatter or a JSON file as a string)
      * @returns Page object in the `Page` format
      */
-    deserialise: (fullPath: string, page: TDataOut) => Promise<Page>;
+    deserialise: (fullPath: string, page: TDataOut) => Promise<TPage>;
     /**
      * Method to load a raw page from disk (e.g. an MDX file) and return into a `Page` object
      * @param fullPath Route on virtual disk (should be full fullPath, not an alias)
      * @param page Page in `Page` form
      * @returns Page content
      */
-    serialise: (fullPath: string, page: Page) => Promise<TDataOut>;
+    serialise: (fullPath: string, page: TPage) => Promise<TDataOut>;
 };
 export declare type LoadedSerialiser = Serialiser & SerialiserModuleDefinition;

package/dist/SourceWorkflow.d.ts

@@ -0,0 +1,6 @@
+export declare type SourceWorkflowAction<TSourceOptions, TOptions> = (sourceOptions: TSourceOptions, workflowOptions: TOptions, ...args: any[]) => Promise<unknown>;
+export declare type SourceWorkflow<TSourceOptions = unknown, TOptions = unknown> = {
+    name: string;
+    options?: TOptions;
+    action: SourceWorkflowAction<TSourceOptions, TOptions>;
+};

package/dist/WorkerData.d.ts

@@ -1,6 +1,4 @@
-import type { SerialiserModuleDefinition } from './SerialiserModuleDefinition';
-import type { PluginModuleDefinition } from './PluginModuleDefinition';
-import type { SourceModuleDefinition } from './SourceModuleDefinition';
+import type { SerialiserModuleDefinition, PluginModuleDefinition, SourceModuleDefinition } from './index';
 export declare type WorkerData<Options = {}> = {
     options: Options & Pick<PluginModuleDefinition, 'options'> & Pick<SourceModuleDefinition, 'options'> & {
         pageExtensions: string[];

package/dist/index.d.ts

@@ -1,13 +1,11 @@
+import type { SerialiserModuleDefinition, MosaicConfig, PluginModuleDefinition, SourceModuleDefinition, SourceWorkflow } from '@jpmorganchase/mosaic-schemas';
 export * from './IFileAccess';
 export * from './Meta';
 export * from './MutableData';
 export * from './Page';
 export * from './Plugin';
-export * from './PluginModuleDefinition';
-export * from './PullDocsConfig';
 export * from './Serialiser';
-export * from './SerialiserModuleDefinition';
 export * from './Source';
-export * from './SourceModuleDefinition';
 export * from './Volume';
 export * from './WorkerData';
+export { SerialiserModuleDefinition, MosaicConfig, PluginModuleDefinition, SourceModuleDefinition, SourceWorkflow };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jpmorganchase/mosaic-types",
-  "version": "0.1.0-beta.6",
+  "version": "0.1.0-beta.7",
   "author": "",
   "description": "Mosaic BitBucket source for core file system",
   "license": "Apache-2.0",
@@ -20,6 +20,8 @@
     "clean": "rm -fr dist"
   },
   "devDependencies": {
-    "rxjs": "^7.5.5"
+    "@jpmorganchase/mosaic-schemas": "^0.1.0-beta.7",
+    "rxjs": "^7.5.5",
+    "zod": "^3.19.1"
   }
 }

package/dist/PluginModuleDefinition.d.ts

@@ -1,19 +0,0 @@
-export interface PluginModuleDefinition {
-    /**
-     * Options to pass to the plugin lifecycle methods.
-     */
-    options: Record<string, unknown>;
-    /**
-     * The importance of this plugin. This highest number plugin will be run first
-     */
-    priority?: number;
-    /**
-     * Exclude this plugin when running `mosaic build`
-     */
-    runTimeOnly?: boolean;
-    /**
-     * Path to the JS file for this plugin (can either export a `default` module with lifecycle methods,
-     * or export the methods individually)
-     */
-    modulePath: string;
-}

package/dist/PullDocsConfig.d.ts

@@ -1,10 +0,0 @@
-import type { PluginModuleDefinition } from './PluginModuleDefinition';
-import type { SerialiserModuleDefinition } from './SerialiserModuleDefinition';
-import type { SourceModuleDefinition } from './SourceModuleDefinition';
-export interface PullDocsConfig {
-    pageExtensions: Array<string>;
-    ignorePages?: Array<string>;
-    serialisers: Array<SerialiserModuleDefinition>;
-    plugins: Array<PluginModuleDefinition>;
-    sources: Array<SourceModuleDefinition>;
-}

package/dist/SerialiserModuleDefinition.d.ts

@@ -1,4 +0,0 @@
-import type { PluginModuleDefinition } from './PluginModuleDefinition';
-export declare type SerialiserModuleDefinition = PluginModuleDefinition & {
-    filter: RegExp;
-};

package/dist/SourceModuleDefinition.d.ts

@@ -1,5 +0,0 @@
-import type { PluginModuleDefinition } from './PluginModuleDefinition';
-export declare type SourceModuleDefinition = PluginModuleDefinition & {
-    namespace: string;
-    cache?: boolean;
-};