@d1vij/jassm 0.1.6 → 0.1.8

package/README.md

@@ -1,11 +1,15 @@
 # Just another static site maker
 
-Create content driven sites using mdx (markdown + react) with added support of route safety.
+Create content driven sites using mdx (markdown + react) with added support typescript based autocompletion for the pages.
 
 ## What is this ??
 
 JASSM is a simple abstraction layer over [mdx-js](https://mdxjs.com/) and its vite plugin for creating a route/file aware loader for mdx file.
 
+Each page is configured at a single source of truth (registry) and thereby provides typesafe access throughout.
+
+(ps the DX is similar to that of TanstackRouter or Elysia)
+
 ## Usage
 
 0. Initialize a react app using vite
@@ -26,7 +30,7 @@ bun add @d1vij/jassm
 import { defineConfig } from "vite";
 import react from "@vitejs/plugin-react";
 
-import jassm from "jassm/plugin";
+import jassm from "@d1vij/jassm/plugin";
 
 export default defineConfig({
     plugins: [
@@ -49,9 +53,9 @@ echo "# This is a Heading" > sample.mdx
 ```ts
 // src/Registry.tsx
 
-import { generateRegistry } from "jassm";
+import { Registry } from "@d1vij/jassm";
 
-export const registry = generateRegistry({
+export const registry = new Registry({
     modules: import.meta.glob("/src/assets/mdx/**/*.mdx"),
     source: "/src/assets/mdx",
     mountOn: "/root",
@@ -100,10 +104,20 @@ import {stylesmap} from "./stylesmap";
 
 import {MDXFromComponent} from "jassm";
 
+import {use} from "react";
+
+type ExportType = {
+    meta: {
+        title: string
+    }
+};
+
 export default function Content() {
-    const Component = registry["/root/sample"];
+    const Component = registry.getComponent("/root/sample");
+    const exports = use(registry.getExport<ExportType>("/root/sample")) // consuming the 'import' promise using use
     return (
         <div>
+            {exports.meta.title}
             <MDXFromComponent
                 SourceComponent={Component}
                 styles={stylesmap}
@@ -121,7 +135,7 @@ Using `MDXSourceComponent` automatically sets up the required enclosing StyleCon
 The setup can also be done manually as follows
 
 ```tsx
-import { StyleContext, Elements } from "jassm";
+import { StyleContext, Elements } from "@d1vij/jassm";
 
 import { registry } from "./Registry";
 import { stylesmap } from "./stylesmap";
@@ -142,3 +156,4 @@ export default function MyLoader() {
     );
 }
 ```
+---

package/dist/index.d.ts

@@ -12,7 +12,7 @@ type MustNotEndWithSlash<T extends string> = T extends `${string}/` ? never : T;
 /**
 * Options passed to {@link generateRegistries}
 */
-type MDXRegistryOptions<
+type RegistryOptions<
 	S extends string,
 	M extends string,
 	R extends Record<string, string>
@@ -23,15 +23,15 @@ type MDXRegistryOptions<
 	*/
 	modules: Record<string, () => Promise<unknown>>;
 	/**
-	*  Directory from which to resolve the source paths in {@link MDXRegistryOptions.records}
+	*  Directory from which to resolve the source paths in {@link RegistryOptions.records}
 	*/
 	source: MustNotEndWithSlash<S> & MustStartWithSlash<S>;
 	/**
-	* Virtual base path on which to mount the key of {@link MDXRegistryOptions.records}
+	* Virtual base path on which to mount the key of {@link RegistryOptions.records}
 	*/
 	mountOn: MustNotEndWithSlash<M> & MustStartWithSlash<M>;
 	/**
-	* Mappings of virtual path to file paths under {@link MDXRegistryOptions.source}
+	* Mappings of virtual path to file paths under {@link RegistryOptions.source}
 	*/
 	records: { [K in keyof R] : K extends string ? MustNotEndWithSlash<K> & MustStartWithSlash<K> extends never ? never : R[K] extends MustStartWithSlash<R[K]> & MDXFile ? R[K] : never : never };
 };
@@ -41,14 +41,14 @@ type RegistryKey<
 	R extends Record<string, string>
 > = keyof RegistryOf<unknown, S, M, R>;
 /**
-* Constructor for any generic registry with keys in the format of `mount-path/virtual-path` for each virual path passed in {@link MDXRegistryOptions.records}
+* Constructor for any generic registry with keys in the format of `mount-path/virtual-path` for each virual path passed in {@link RegistryOptions.records}
 */
 type RegistryOf<
 	T,
 	S extends string,
 	M extends string,
 	R extends Record<string, string>
-> = { [K in keyof MDXRegistryOptions<S, M, R>["records"] as `${MDXRegistryOptions<S, M, R>["mountOn"]}${Extract<K, string>}`] : T };
+> = { [K in keyof RegistryOptions<S, M, R>["records"] as `${RegistryOptions<S, M, R>["mountOn"]}${Extract<K, string>}`] : T };
 /**
 * Registry of react components
 */
@@ -74,14 +74,28 @@ declare function generateRegistries<
 	S extends string,
 	M extends string,
 	R extends Record<string, string>
->({ modules, source, mountOn, records }: MDXRegistryOptions<S, M, R>): [ComponentRegistry<S, M, R>, ExportsRegistry<S, M, R>];
+>({ modules, source, mountOn, records }: RegistryOptions<S, M, R>): [ComponentRegistry<S, M, R>, ExportsRegistry<S, M, R>];
 /**
 * The returned object has the type of {@link React.ComponentType} + whatever user passes
 */
-type ExportSingleType<T> = T & {
+type ExportSingleType<T> = Promise<T & {
 	default: React.ComponentType;
-};
+}>;
 type ExportAllType<T> = { [K in keyof T] : ExportSingleType<T[K]> };
+declare abstract class AbstractRegistry<
+	C extends Record<string, React.LazyExoticComponent<React.ComponentType>>,
+	E extends Record<string, unknown>
+> {
+	abstract components: C;
+	abstract exports: E;
+	getComponent<K extends keyof C>(key: K): C[K];
+	getComponents(): C;
+	getExport<
+		T extends object,
+		K extends keyof E
+	>(key: K): ExportSingleType<T>;
+	getExports<T extends Record<keyof C, object> = Record<keyof C, object>>(): ExportAllType<T>;
+}
 /**
 * Wrapper class over {@link generateRegistries}. Provides methods to access components and exports from typesafe keys
 */
@@ -89,14 +103,19 @@ declare class Registry<
 	S extends string,
 	M extends string,
 	R extends Record<string, string>
-> {
-	private readonly components;
-	private readonly exports;
-	constructor(registryOpts: MDXRegistryOptions<S, M, R>);
-	getComponent(key: RegistryKey<S, M, R>): ComponentRegistry<S, M, R>[RegistryKey<S, M, R>];
-	getComponents(): ComponentRegistry<S, M, R>;
-	getExport<T extends object = object>(key: RegistryKey<S, M, R>): ExportSingleType<T>;
-	getExports<T extends Record<RegistryKey<S, M, R>, object> = Record<RegistryKey<S, M, R>, object>>(): ExportAllType<T>;
+> extends AbstractRegistry<ComponentRegistry<S, M, R>, ExportsRegistry<S, M, R>> {
+	readonly components: ComponentRegistry<S, M, R>;
+	readonly exports: ExportsRegistry<S, M, R>;
+	constructor(registryOpts: RegistryOptions<S, M, R>);
+}
+type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+/**
+* Registry created by coalesing multiple {@link Registry} instances
+*/
+declare class CoalescedRegistry<R extends readonly AbstractRegistry<Record<string, React.LazyExoticComponent<React.ComponentType>>, Record<string, unknown>>[]> extends AbstractRegistry<Record<keyof UnionToIntersection<R[number]["components"]>, React.LazyExoticComponent<React.ComponentType>>, Record<keyof UnionToIntersection<R[number]["exports"]>, unknown>> {
+	readonly components: Record<keyof UnionToIntersection<R[number]["components"]>, React.LazyExoticComponent<React.ComponentType>>;
+	readonly exports: Record<keyof UnionToIntersection<R[number]["exports"]>, unknown>;
+	constructor(...registries: R);
 }
 /**
 * List of default style classes
@@ -123,4 +142,4 @@ type MDXFromComponentProps = {
 * Simple way to directly load a component from the Registry
 */
 declare function MDXFromComponent({ SourceComponent, styles, fallback, elements }: MDXFromComponentProps): JSX;
-export { useStyles, generateRegistries, StyleContext, StyleClassesMap, StyleClassesList, StyleClasses, RegistryOf, RegistryKey, Registry, MDXRegistryOptions, MDXFromComponentProps, MDXFromComponent, MDXFile, HeaderLevels, ExportsRegistry, ExportSingleType, ExportAllType, Elements, ComponentRegistry };
+export { useStyles, generateRegistries, StyleContext, StyleClassesMap, StyleClassesList, StyleClasses, RegistryOptions, RegistryOf, RegistryKey, Registry, MDXFromComponentProps, MDXFromComponent, MDXFile, HeaderLevels, ExportsRegistry, ExportSingleType, ExportAllType, Elements, ComponentRegistry, CoalescedRegistry };

package/dist/index.js

@@ -316,12 +316,7 @@ function generateRegistries({
   return [Object.fromEntries(components), Object.fromEntries(exports)];
 }
 
-class Registry {
-  components;
-  exports;
-  constructor(registryOpts) {
-    [this.components, this.exports] = generateRegistries(registryOpts);
-  }
+class AbstractRegistry {
   getComponent(key) {
     return this.components[key];
   }
@@ -335,6 +330,25 @@ class Registry {
     return this.exports;
   }
 }
+
+class Registry extends AbstractRegistry {
+  components;
+  exports;
+  constructor(registryOpts) {
+    super();
+    [this.components, this.exports] = generateRegistries(registryOpts);
+  }
+}
+
+class CoalescedRegistry extends AbstractRegistry {
+  components;
+  exports;
+  constructor(...registries) {
+    super();
+    this.components = Object.assign({}, ...registries.map((r) => r.getComponents()));
+    this.exports = Object.assign({}, ...registries.map((r) => r.getExports()));
+  }
+}
 // src/components/Loader.tsx
 import { jsx as jsx14 } from "react/jsx-runtime";
 function MDXFromComponent({
@@ -360,5 +374,6 @@ export {
   StyleClassesList,
   Registry,
   MDXFromComponent,
-  Elements
+  Elements,
+  CoalescedRegistry
 };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@d1vij/jassm",
     "description": "Just another static site maker. Create simple content driven sites using MDX and React along with Typescript safety.",
-    "version": "0.1.6",
+    "version": "0.1.8",
     "type": "module",
     "files": [
         "dist"