@jpmorganchase/mosaic-types 0.1.0-beta.89 → 0.1.0-beta.90

package/dist/IFileAccess.d.ts

@@ -1,21 +1,12 @@
-/// <reference types="node" resolution-mode="require"/>
 import type { Options, Pattern, Entry } from 'fast-glob';
-import type { DirectoryJSON, IRealpathOptions, IMkdirOptions, IReaddirOptions, IStatOptions, TData, TMode, TDataOut, Dirent, Stats, TStatNumber } from 'memfs';
-import type { PathLike, symlink } from 'fs';
+import type { DirectoryJSON, IFs } from 'memfs';
+import type { PathLike } from 'fs';
 import type { Page } from './Page.js';
 /**
  * This is the core underlying filesystem, which directly interfaces with a memfs Volume to mutate the filesystem
  */
-export interface IFileAccess {
+export interface IFileAccess extends Pick<IFs['promises'], 'mkdir' | 'readdir' | 'readFile' | 'realpath' | 'stat' | 'unlink' | 'symlink' | 'writeFile'> {
     glob(pattern: Pattern, options?: Omit<Options, 'absolute' | 'fs'>): Promise<string[] | Entry[]>;
-    mkdir(dir: PathLike, options?: TMode | IMkdirOptions): Promise<void>;
-    readdir(dir: PathLike, options?: string | IReaddirOptions): Promise<TDataOut[] | Dirent[]>;
-    readFile(file: PathLike): Promise<TDataOut>;
-    realpath(target: string, options?: string | IRealpathOptions): Promise<TDataOut>;
-    stat(file: PathLike, options?: IStatOptions): Promise<Stats<TStatNumber>>;
-    unlink(target: PathLike): Promise<void>;
-    symlink(target: PathLike, alias: PathLike, type?: symlink.Type): Promise<void>;
-    writeFile(file: PathLike, data: TData): Promise<void>;
     toJSON(): DirectoryJSON;
     fromJSON(json: DirectoryJSON): void;
     exists(file: PathLike): Promise<boolean>;

package/dist/Meta.d.ts

@@ -1,4 +1,4 @@
-export declare type Meta<AdditionalProps> = {
+export type Meta<AdditionalProps> = {
     title?: string;
     route: string;
     lastModified: Date;

package/dist/Mode.d.ts

@@ -13,4 +13,4 @@
  *
  * (A snapshot is an immutable/persisted copy of `active` content, created separately)
  */
-export declare type MosaicMode = 'active' | 'snapshot-file' | 'snapshot-s3';
+export type MosaicMode = 'active' | 'snapshot-file' | 'snapshot-s3';

package/dist/MutableData.d.ts

@@ -16,7 +16,7 @@ export interface BaseData {
     globalRefs?: GlobalRefs | [];
     aliases?: Aliases | [];
 }
-export declare type MutableData<T = {}> = ImmutableData<T> & {
+export type MutableData<T = {}> = ImmutableData<T> & {
     /**
      * Set arbitrary data onto the config object. This value will persist across plugins and
      * also be sent to the parent process when it executes plugins there as well.
@@ -63,7 +63,7 @@ export declare type MutableData<T = {}> = ImmutableData<T> & {
      */
     asReadOnly(): ImmutableData<T>;
 };
-export declare type ImmutableData<T = {}> = {
+export type ImmutableData<T = {}> = {
     readonly data: Readonly<T & {
         readonly refs: string[];
         readonly aliases: Set<{

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 = {
+export type Page = {
     fullPath: string;
     title?: string;
     /**

package/dist/Plugin.d.ts

@@ -3,9 +3,9 @@ import type { PluginModuleDefinition } from './index.js';
 import type { Serialiser } from './Serialiser.js';
 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 = {
+export type LoadedPlugin = Partial<Plugin<Page>> & PluginModuleDefinition;
+export type LifecycleMethod = keyof Plugin<Page>;
+export type PluginErrorDescriptor = {
     /**
      * The plugin lifecycle method running when the error occurred
      */
@@ -27,14 +27,14 @@ export declare type PluginErrorDescriptor = {
      */
     fullPath?: string;
 };
-export declare type PluginErrors = Array<PluginErrorDescriptor>;
-export declare type TrackPluginErrorCallback = (errors: Array<PluginErrorDescriptor>, lifecycleMethod: string) => void;
+export type PluginErrors = Array<PluginErrorDescriptor>;
+export 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,
  * it will trigger `pluginRunner` which executes it on every source automatically.
  */
-export declare type Plugin<TPage extends Page = Page, TOptions = Record<string, unknown>, ConfigData = Record<string, unknown>, GlobalConfigData = ConfigData> = {
+export 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

package/dist/Serialiser.d.ts

@@ -1,13 +1,13 @@
-import type { TDataOut } from 'memfs';
 import type { SerialiserModuleDefinition } from './index.js';
 import type { Page } from './Page.js';
+import type { TDataOut } from './Volume.js';
 /**
  * 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 Mosaic config file, to find a suitable parser.
  */
-export declare type Serialiser<TPage extends Page = Page> = {
+export 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)
@@ -23,4 +23,4 @@ export declare type Serialiser<TPage extends Page = Page> = {
      */
     serialise: (fullPath: string, page: TPage) => Promise<TDataOut>;
 };
-export declare type LoadedSerialiser = Serialiser & SerialiserModuleDefinition;
+export type LoadedSerialiser = Serialiser & SerialiserModuleDefinition;

package/dist/Session.d.ts

@@ -1,4 +1,4 @@
-export declare type JWT = {
+export type JWT = {
     exp: number;
     UserID?: string;
     JPMCIdentifier?: string;
@@ -16,7 +16,7 @@ export declare type JWT = {
     LOB?: string;
     LocationCode?: string;
 };
-export declare type Session<TUserProfile> = {
+export type Session<TUserProfile> = {
     isLoggedIn: boolean;
     user?: TUserProfile;
 };

package/dist/Source.d.ts

@@ -5,7 +5,7 @@ import { SourceSchedule } from './index.js';
 /**
  * Provided by Mosaic to a Source
  */
-export declare type SourceConfig = {
+export type SourceConfig = {
     /**
      * The allowed page extensions Mosaic has been configured to use
      */
@@ -19,6 +19,6 @@ export declare type SourceConfig = {
      */
     schedule: SourceSchedule;
 };
-export declare type Source<TOptions = Record<string, unknown>, TPage extends Page = Page> = {
+export type Source<TOptions = Record<string, unknown>, TPage extends Page = Page> = {
     create(options: TOptions, helpers: SourceConfig): Observable<TPage[]>;
 };

package/dist/SourceWorkflow.d.ts

@@ -1,12 +1,12 @@
-export declare type SourceWorkflowAction<TSourceOptions, TOptions> = (sendWorkflowProgressMessage: SendSourceWorkflowMessage, sourceOptions: TSourceOptions, workflowOptions: TOptions, ...args: any[]) => Promise<unknown>;
-export declare type SourceWorkflow<TSourceOptions = unknown, TOptions = Record<string, unknown>> = {
+export type SourceWorkflowAction<TSourceOptions, TOptions> = (sendWorkflowProgressMessage: SendSourceWorkflowMessage, sourceOptions: TSourceOptions, workflowOptions: TOptions, ...args: any[]) => Promise<unknown>;
+export type SourceWorkflow<TSourceOptions = unknown, TOptions = Record<string, 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 = {
+export type SourceWorkflowMessageStatus = 'SUCCESS' | 'ERROR' | 'IN_PROGRESS' | 'COMPLETE';
+export type SendSourceWorkflowMessage = (message: any, status: SourceWorkflowMessageStatus) => void;
+export type SourceWorkflowMessageEvent = {
     status: SourceWorkflowMessageStatus;
     message: any;
     channel?: string;

package/dist/Volume.d.ts

@@ -1,7 +1,8 @@
-/// <reference types="node" resolution-mode="require"/>
-import type { DirectoryJSON, IRealpathOptions, IMkdirOptions, IReaddirOptions, IStatOptions, TData, TMode, TDataOut, Dirent, Stats, TStatNumber } from 'memfs';
-import type { PathLike, symlink } from 'fs';
+import type { DirectoryJSON, IFs } from 'memfs';
+import type { PathLike } from 'fs';
 import type { Options, Pattern, Entry } from 'fast-glob';
+type TDataOut = string | Buffer;
+export type { TDataOut };
 /**
  * Volumes are lightweight decorators which wrap `FileAccess` and limit access to the underlying API for different use-cases
  * Examples include disallowing mutation or allowing underlying functions like resetting
@@ -17,17 +18,9 @@ export interface IVolume {
         }[];
     };
     fromJSON?(json: DirectoryJSON): void;
-    promises: {
+    promises: Pick<IFs['promises'], 'mkdir' | 'readdir' | 'readFile' | 'realpath' | 'stat' | 'symlink' | 'unlink' | 'writeFile'> & {
         exists(file: PathLike): Promise<boolean>;
         glob(pattern: Pattern, options?: Options): Promise<string[] | Entry[]>;
-        mkdir(dir: PathLike, options?: TMode | IMkdirOptions): Promise<void>;
-        readdir(dir: PathLike, options?: string | IReaddirOptions): Promise<TDataOut[] | Dirent[]>;
-        readFile(file: PathLike): Promise<TDataOut>;
-        realpath(target: string, options?: string | IRealpathOptions): Promise<TDataOut>;
-        stat(file: PathLike, options?: IStatOptions): Promise<Stats<TStatNumber>>;
-        symlink(target: PathLike, alias: PathLike, type?: symlink.Type): Promise<void>;
-        unlink(target: PathLike): Promise<void>;
-        writeFile(file: PathLike, data: TData): Promise<void>;
     };
 }
 export interface IVolumePartiallyMutable extends Omit<IVolume, 'reset' | 'fromJSON'> {

package/dist/WorkerData.d.ts

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

package/package.json

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