@d1vij/jassm 0.1.3 → 0.1.4

package/dist/index.d.ts

@@ -7,30 +7,15 @@ import { MDXComponents as MDXComponents2, MDXProps } from "mdx/types";
 * File extension(s) to accept
 */
 type MDXFile = `${string}.mdx`;
-/**
-* Generated registry type
-*/
-type LazyRegistry<T extends Record<string, MDXFile>> = { readonly [K in keyof T] : React.LazyExoticComponent<React.ComponentType> };
-type Expand<T> = T extends infer O ? { [K in keyof O] : O[K] } : never;
 type MustStartWithSlash<T extends string> = T extends `/${string}` ? T : never;
 type MustNotEndWithSlash<T extends string> = T extends `${string}/` ? never : T;
 /**
-* Function to generate Registry mappings
-* @param MDXRegistryOptions
-* @returns
+* Options passed to {@link generateRegistries}
 */
-declare function generateRegistry<
+type MDXRegistryOptions<
 	S extends string,
 	M extends string,
 	R extends Record<string, string>
->({ modules, source, mountOn, records }: MDXRegistryOptions<S, M, R>): Expand<LazyRegistry<{ [K in keyof typeof records as `${typeof mountOn}${Extract<K, string>}`] : MDXFile }>>;
-/**
-* Options passed to {@link generateRegistry}
-*/
-type MDXRegistryOptions<
-	S extends string = string,
-	M extends string = string,
-	R extends Record<string, string> = Record<string, string>
 > = {
 	/**
 	* Module object returned from `import.meta.glob`
@@ -50,6 +35,62 @@ type MDXRegistryOptions<
 	*/
 	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 };
 };
+type RegistryKey<
+	S extends string,
+	M extends string,
+	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}
+*/
+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 };
+/**
+* Registry of react components
+*/
+type ComponentRegistry<
+	S extends string,
+	M extends string,
+	R extends Record<string, string>
+> = RegistryOf<React.LazyExoticComponent<React.ComponentType>, S, M, R>;
+/**
+* Registry of promise objects equivalent to return type of `import(<path>)`
+*/
+type ExportsRegistry<
+	S extends string,
+	M extends string,
+	R extends Record<string, string>
+> = RegistryOf<Promise<Record<string, unknown>>, S, M, R>;
+/**
+* Function to generate Registry mappings, use {@link Registry} class instead of this.
+* @param MDXRegistryOptions
+* @returns Tuple of [{@link ComponentRegistry}, {@link ExportsRegistry}]
+*/
+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>];
+/**
+* Wrapper class over {@link generateRegistries}. Provides methods to access components and exports from typesafe keys
+*/
+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>];
+	getExport(key: RegistryKey<S, M, R>): ExportsRegistry<S, M, R>[RegistryKey<S, M, R>];
+	getComponents(): ComponentRegistry<S, M, R>;
+	getExports(): ExportsRegistry<S, M, R>;
+}
 /**
 * List of default style classes
 */
@@ -75,4 +116,4 @@ type MDXFromComponentProps = {
 * Simple way to directly load a component from the Registry
 */
 declare function MDXFromComponent({ SourceComponent, styles, fallback, elements }: MDXFromComponentProps): JSX;
-export { useStyles, generateRegistry, StyleContext, StyleClassesMap, StyleClassesList, StyleClasses, MDXRegistryOptions, MDXFromComponentProps, MDXFromComponent, MDXFile, LazyRegistry, HeaderLevels, Elements };
+export { useStyles, generateRegistries, StyleContext, StyleClassesMap, StyleClassesList, StyleClasses, RegistryOf, RegistryKey, Registry, MDXRegistryOptions, MDXFromComponentProps, MDXFromComponent, MDXFile, HeaderLevels, ExportsRegistry, Elements, ComponentRegistry };

package/dist/index.js

@@ -296,22 +296,44 @@ import { Suspense } from "react";
 
 // src/lib/Registry.ts
 import { lazy } from "react";
-function generateRegistry({
+function generateRegistries({
   modules,
   source,
   mountOn,
   records
 }) {
-  const paths = [];
+  const components = [];
+  const exports = [];
   for (const [virtual, path] of Object.entries(records)) {
     const src = `${source}${path}`;
     const loader = modules[src];
     if (!loader) {
       throw new Error(`No such file exsits as ${src}`);
     }
-    paths.push([`${mountOn}${virtual}`, lazy(loader)]);
+    components.push([`${mountOn}${virtual}`, lazy(loader)]);
+    exports.push([`${mountOn}${virtual}`, import(src)]);
+  }
+  return [Object.fromEntries(components), Object.fromEntries(exports)];
+}
+
+class Registry {
+  components;
+  exports;
+  constructor(registryOpts) {
+    [this.components, this.exports] = generateRegistries(registryOpts);
+  }
+  getComponent(key) {
+    return this.components[key];
+  }
+  getExport(key) {
+    return this.exports[key];
+  }
+  getComponents() {
+    return this.components;
+  }
+  getExports() {
+    return this.exports;
   }
-  return Object.fromEntries(paths);
 }
 // src/components/Loader.tsx
 import { jsx as jsx14 } from "react/jsx-runtime";
@@ -333,9 +355,10 @@ function MDXFromComponent({
 }
 export {
   useStyles,
-  generateRegistry,
+  generateRegistries,
   StyleContext,
   StyleClassesList,
+  Registry,
   MDXFromComponent,
   Elements
 };

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.3",
+    "version": "0.1.4",
     "type": "module",
     "files": [
         "dist"
@@ -23,7 +23,7 @@
     },
     "repository": {
         "type": "git",
-        "url": "https://github.com/d1vij/jassm"
+        "url": "git+https://github.com/d1vij/jassm.git"
     },
     "homepage": "https://github.com/d1vij/jassm",
     "license": "MIT",