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

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @jpmorganchase/mosaic-types
 
+## 0.1.0-beta.6
+
+### Patch Changes
+
+- c103b24: Release fixes for snapshot serve
+
+## 0.1.0-beta.5
+
+### Patch Changes
+
+- 61a246c: This releases add support for generate / build and serve snapshots
+
 ## 0.1.0-beta.4
 
 ### Patch Changes

package/dist/IFileAccess.d.ts

@@ -6,12 +6,12 @@ import type Stats from 'memfs/lib/Stats';
 import type { TStatNumber } from 'memfs/lib/Stats';
 import type { IStatOptions } from 'memfs/lib/volume';
 import type { PathLike, symlink } from 'fs';
-import type Page from './Page';
+import type { Page } from './Page';
 import type { Options, Pattern, Entry } from 'fast-glob';
 /**
  * This is the core underlying filesystem, which directly interfaces with a memfs Volume to mutate the filesystem
  */
-export default interface IFileAccess {
+export interface IFileAccess {
     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[]>;
@@ -26,7 +26,7 @@ export default interface IFileAccess {
     exists(file: PathLike): Promise<boolean>;
     $$reset(): void;
     $$freeze(): void;
-    get $$frozen(): boolean;
+    readonly $$frozen: boolean;
     $$unfreeze(): void;
     $$clearCache(): void;
     $$symlinksFromJSON(page: {

package/dist/Meta.d.ts

@@ -1,6 +1,5 @@
-declare type Meta<AdditionalProps> = {
+export declare type Meta<AdditionalProps> = {
     title?: string;
     route: string;
     lastModified: Date;
 } & Record<string, unknown> & AdditionalProps;
-export default Meta;

package/dist/MutableData.d.ts

@@ -1,4 +1,22 @@
-declare type MutableData<T = {}> = ImmutableData<T> & {
+export interface Aliases {
+    [key: string]: Set<string>;
+}
+export interface FSRef {
+    $$path?: string | string[];
+    $$value?: string;
+}
+export interface GlobalRefs {
+    [key: string]: FSRef;
+}
+export interface ScopedRefs {
+    [key: string]: FSRef;
+}
+export interface BaseData {
+    refs?: ScopedRefs | [];
+    globalRefs?: GlobalRefs | [];
+    aliases?: Aliases | [];
+}
+export declare 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.
@@ -54,4 +72,3 @@ export declare type ImmutableData<T = {}> = {
         }>;
     }>;
 };
-export default MutableData;

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`
  */
-declare type Page<AdditionalProps = {}> = {
+export declare type Page<AdditionalProps = {}> = {
     fullPath: string;
     title?: string;
     /**
@@ -18,4 +18,3 @@ declare type Page<AdditionalProps = {}> = {
     type?: string;
     content?: string;
 } & Record<string, unknown> & AdditionalProps;
-export default Page;

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 { Page } from './Page';
+import type { MutableData } from './MutableData';
+import type { PluginModuleDefinition } from './PluginModuleDefinition';
 import type { ImmutableData } from './MutableData';
 import type { IUnionVolume, IVolumeImmutable, IVolumeMutable, IVolumePartiallyMutable } from './Volume';
-import type Serialiser from './Serialiser';
+import type { Serialiser } from './Serialiser';
 export declare type LoadedPlugin = Partial<Plugin> & PluginModuleDefinition;
 /**
  * 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.
  */
-declare type Plugin<ConfigData = {}, PluginOptions = {}, GlobalConfigData = ConfigData> = {
+export declare type Plugin<ConfigData = {}, PluginOptions = {}, 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
@@ -89,4 +89,3 @@ declare type Plugin<ConfigData = {}, PluginOptions = {}, GlobalConfigData = Conf
     }, options?: Pick<PluginModuleDefinition, 'options'> & PluginOptions): Promise<boolean>;
 };
 export declare type LifecycleMethod = keyof Plugin;
-export default Plugin;

package/dist/PluginModuleDefinition.d.ts

@@ -1,4 +1,4 @@
-export default interface PluginModuleDefinition {
+export interface PluginModuleDefinition {
     /**
      * Options to pass to the plugin lifecycle methods.
      */

package/dist/PullDocsConfig.d.ts

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

package/dist/Serialiser.d.ts

@@ -1,6 +1,6 @@
 import type { TDataOut } from 'memfs/lib/encoding';
-import type Page from './Page';
-import type SerialiserModuleDefinition from './SerialiserModuleDefinition';
+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
  * or a `Page` object.
@@ -24,4 +24,3 @@ export declare type Serialiser = {
     serialise: (fullPath: string, page: Page) => Promise<TDataOut>;
 };
 export declare type LoadedSerialiser = Serialiser & SerialiserModuleDefinition;
-export default Serialiser;

package/dist/SerialiserModuleDefinition.d.ts

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

package/dist/Source.d.ts

@@ -1,10 +1,9 @@
 import type { Observable } from 'rxjs';
-import type Serialiser from './Serialiser';
-import type Page from './Page';
-declare type Source<Options = {}> = {
+import type { Serialiser } from './Serialiser';
+import type { Page } from './Page';
+export declare type Source<Options = {}> = {
     create(options: Options, { serialiser, pageExtensions }: {
         pageExtensions: string[];
         serialiser: Serialiser;
     }): Observable<Page[]>;
 };
-export default Source;

package/dist/SourceModuleDefinition.d.ts

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

package/dist/Volume.d.ts

@@ -11,7 +11,7 @@ import type { Options, Pattern, Entry } from 'fast-glob';
  * 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
  */
-interface IVolume {
+export interface IVolume {
     namespace: string;
     reset?(): void;
     toJSON(): DirectoryJSON;
@@ -107,7 +107,7 @@ export interface IVolumeMutable extends IVolume {
      * Is this filesystem frozen/mutable?
      * @returns {boolean}
      */
-    get frozen(): boolean;
+    readonly frozen: boolean;
     /**
      * Appends content to the filesystem
      * @param json A JSON blob in the form of {[fullPath]: "{fullPath: '', content: ''}"}
@@ -128,4 +128,3 @@ export interface IVolumeMutable extends IVolume {
 export interface IVolumeImmutable extends Omit<IVolumePartiallyMutable, 'fromJSON' | 'reset' | 'promises' | '__internal_do_not_use_addReadFileHook'> {
     promises: Omit<IVolume['promises'], 'writeFile' | 'symlink' | 'mkdir' | 'unlink' | 'rmdir' | 'rm' | 'rename'>;
 }
-export {};

package/dist/WorkerData.d.ts

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

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+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';

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@jpmorganchase/mosaic-types",
-  "version": "0.1.0-beta.4",
+  "version": "0.1.0-beta.6",
   "author": "",
   "description": "Mosaic BitBucket source for core file system",
   "license": "Apache-2.0",
-  "types": "./dist/**",
+  "types": "./dist/index.d.ts",
   "engines": {
     "node": ">= 12.0.0"
   },
@@ -22,4 +22,4 @@
   "devDependencies": {
     "rxjs": "^7.5.5"
   }
-}
+}