@postxl/generator 0.4.0 → 0.5.0

package/dist/src/generators/indices/repositories.generator.js

@@ -11,9 +11,9 @@ function generateRepositoriesIndex({ models, meta }) {
     const exports = exports_1.ExportsGenerator.from(meta.data.repositoriesIndexFilePath);
     for (const model of models) {
         const meta = (0, meta_1.getModelMetadata)({ model });
-        exports.exportEverythingFrom(meta.data.repoFilePath);
+        exports.exportEverythingFromPath(meta.data.repoFilePath);
     }
-    exports.exportEverythingFrom(meta.data.repositoriesConstFilePath);
+    exports.exportEverythingFromPath(meta.data.repositoriesConstFilePath);
     return exports.generate();
 }
 exports.generateRepositoriesIndex = generateRepositoriesIndex;

package/dist/src/generators/indices/seed.generator.js

@@ -10,7 +10,7 @@ function generateSeedIndex({ models, meta }) {
     const exports = exports_1.ExportsGenerator.from(meta.seed.indexFilePath);
     for (const model of models) {
         const meta = (0, meta_1.getModelMetadata)({ model });
-        exports.exportEverythingFrom(meta.seed.filePath);
+        exports.exportEverythingFromPath(meta.seed.filePath);
     }
     return exports.generate();
 }

package/dist/src/generators/indices/stubs.generator.js

@@ -10,7 +10,7 @@ function generateStubsIndex({ models, meta }) {
     const exports = exports_1.ExportsGenerator.from(meta.data.stubIndexFilePath);
     for (const model of models) {
         const meta = (0, meta_1.getModelMetadata)({ model });
-        exports.exportEverythingFrom(meta.data.stubFilePath);
+        exports.exportEverythingFromPath(meta.data.stubFilePath);
     }
     return exports.generate();
 }

package/dist/src/generators/indices/types.generator.js

@@ -10,11 +10,11 @@ function generateTypesIndex({ models, enums, meta, }) {
     const exports = exports_1.ExportsGenerator.from(meta.types.indexFilePath);
     for (const model of models) {
         const meta = (0, meta_1.getModelMetadata)({ model });
-        exports.exportEverythingFrom(meta.types.filePath);
+        exports.exportEverythingFromPath(meta.types.filePath);
     }
     for (const enumerator of enums) {
         const meta = (0, meta_1.getEnumMetadata)({ enumerator });
-        exports.exportEverythingFrom(meta.types.filePath);
+        exports.exportEverythingFromPath(meta.types.filePath);
     }
     return exports.generate();
 }

package/dist/src/generators/models/react.generator/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateReactComponentsForModel = void 0;
+const exports_1 = require("../../../lib/exports");
 const vfs_1 = require("../../../lib/vfs");
 const context_generator_1 = require("./context.generator");
 const library_generator_1 = require("./library.generator");
@@ -10,23 +11,27 @@ const modals_generator_1 = require("./modals.generator");
  * Generates generic React components for a given model.
  */
 function generateReactComponentsForModel({ model, meta }) {
-    const vfs = new vfs_1.VirtualFS({
-        '/index.ts': `
-        export * from './CreateModal'
-        export * from './EditModal'
-        export * from './DeleteModal'
-
-        export * from './Form'
-        export * from './context'
-        export * from './Library'
-			`,
-    });
+    const vfs = new vfs_1.VirtualFS({});
+    const exports = exports_1.ExportsGenerator.fromRoot()
+        .exportEverythingFromFile('./CreateModal')
+        .exportEverythingFromFile('./EditModal')
+        .exportEverythingFromFile('./DeleteModal')
+        .exportEverythingFromFile('./Form')
+        .exportEverythingFromFile('./context');
     vfs.write(`/context.tsx`, (0, context_generator_1.generateModelContext)({ model, meta }));
     vfs.write(`/CreateModal.tsx`, (0, modals_generator_1.generateModelCreateModalComponent)({ model, meta }));
     vfs.write(`/EditModal.tsx`, (0, modals_generator_1.generateEditModalModelComponent)({ model, meta }));
     vfs.write(`/DeleteModal.tsx`, (0, modals_generator_1.generateDeleteModalModelComponent)({ model, meta }));
     vfs.write(`/Form.tsx`, (0, lookup_generator_1.generateModelLookupComponents)({ model, meta }));
-    vfs.write(`/Library.tsx`, (0, library_generator_1.generateModelLibraryComponents)({ model, meta }));
+    // NOTE: library generator expects that the model has a `name` field.
+    //        Make sure that you don't make a dependency on this
+    //        component without checking that a model has a name field.
+    const hasNameField = model.nameField != null;
+    if (hasNameField) {
+        vfs.write(`/Library.tsx`, (0, library_generator_1.generateModelLibraryComponents)({ model, meta }));
+        exports.exportEverythingFromFile('./Library');
+    }
+    vfs.write(`/index.ts`, exports.generate());
     return vfs;
 }
 exports.generateReactComponentsForModel = generateReactComponentsForModel;

package/dist/src/generators/models/react.generator/library.generator.d.ts

@@ -2,6 +2,9 @@ import { ModelMetaData } from '../../../lib/meta';
 import { Model } from '../../../lib/schema/schema';
 /**
  * Generates components that may be used to list all entries of a given data type.
+ *
+ * NOTE: Library expects that the model has a `name` field. Make sure that you don't make a dependency on
+ *      this component without checking that a model has a name field.
  */
 export declare function generateModelLibraryComponents({ model, meta }: {
     model: Model;

package/dist/src/generators/models/react.generator/library.generator.js

@@ -6,6 +6,9 @@ const fields_1 = require("../../../lib/schema/fields");
 const imports_1 = require("../../../lib/imports");
 /**
  * Generates components that may be used to list all entries of a given data type.
+ *
+ * NOTE: Library expects that the model has a `name` field. Make sure that you don't make a dependency on
+ *      this component without checking that a model has a name field.
  */
 function generateModelLibraryComponents({ model, meta }) {
     const { react: { context, components }, } = meta;

package/dist/src/generators/models/react.generator/lookup.generator.js

@@ -17,6 +17,11 @@ function generateModelLookupComponents({ model, meta }) {
         from: meta.types.importPath,
     });
     const typeName = model.typeName;
+    // NOTE: Depending on the model definition - whether it has a `name` field or not - we'll either
+    //        auto-populate the `label` property or not.
+    const hasNameField = model.nameField != null;
+    const tsOmittedFields = hasNameField ? `'label' | 'options' | 'loading'` : `'options' | 'loading'`;
+    const reactLabelField = hasNameField ? `label={(l) => l.name}` : '';
     return `
 import React, { useMemo } from 'react'
 
@@ -34,63 +39,63 @@ ${imports.generate()}
 
 export const ${components.forms.selectInputName} = ({
   ...delegated
-}: UnionOmit<React.ComponentPropsWithoutRef<typeof SelectInput<${typeName}>>, 'label' | 'options' | 'loading'>) => {
+}: UnionOmit<React.ComponentPropsWithoutRef<typeof SelectInput<${typeName}>>, ${tsOmittedFields}>) => {
   const { list, ready } = ${context.hookFnName}()
-  return <SelectInput<${typeName}> options={list} label={(l) => l.name} loading={!ready} {...delegated} />
+  return <SelectInput<${typeName}> options={list} ${reactLabelField} loading={!ready} {...delegated} />
 }
 
 export const ${components.forms.selectFieldName} = ({
   ...delegated
-}: Omit<React.ComponentPropsWithoutRef<typeof SelectField<${typeName}>>, 'label' | 'options' | 'loading'>) => {
+}: Omit<React.ComponentPropsWithoutRef<typeof SelectField<${typeName}>>, ${tsOmittedFields}>) => {
   const { list, ready } = ${context.hookFnName}()
-  return <SelectField<${typeName}> options={list} label={(l) => l.name} loading={!ready} {...delegated} />
+  return <SelectField<${typeName}> options={list} ${reactLabelField} loading={!ready} {...delegated} />
 }
 
 // Menu Select
 
 export const ${components.forms.menuSelectInputName} = ({
 	...delegated
-}: UnionOmit<React.ComponentPropsWithoutRef<typeof MenuSelectInput<${typeName}>>, 'label' | 'options' | 'loading'>) => {
+}: UnionOmit<React.ComponentPropsWithoutRef<typeof MenuSelectInput<${typeName}>>, ${tsOmittedFields}>) => {
 	const { list, ready } = ${context.hookFnName}()
-	return <MenuSelectInput<${typeName}> options={list} label={(l) => l.name} loading={!ready} {...delegated} />
+	return <MenuSelectInput<${typeName}> options={list} ${reactLabelField} loading={!ready} {...delegated} />
 }
 
 export const ${components.forms.menuSelectFieldName} = ({
 	...delegated
-}: UnionOmit<React.ComponentPropsWithoutRef<typeof MenuSelectField<${typeName}>>, 'label' | 'options' | 'loading'>) => {
+}: UnionOmit<React.ComponentPropsWithoutRef<typeof MenuSelectField<${typeName}>>, ${tsOmittedFields}>) => {
 	const { list, ready } = ${context.hookFnName}()
-	return <MenuSelectField<${typeName}> options={list} label={(l) => l.name} loading={!ready} {...delegated} />
+	return <MenuSelectField<${typeName}> options={list} ${reactLabelField} loading={!ready} {...delegated} />
 }
 
 // Search
 
 export const ${components.forms.searchInputName} = ({
 	...delegated
-}: UnionOmit<React.ComponentPropsWithoutRef<typeof SearchInput<${typeName}>>, 'label' | 'options' | 'loading'>) => {
+}: UnionOmit<React.ComponentPropsWithoutRef<typeof SearchInput<${typeName}>>, ${tsOmittedFields}>) => {
 	const { list, ready } = ${context.hookFnName}()
-	return <SearchInput<${typeName}> options={list} label={(l) => l.name} loading={!ready} {...delegated} />
+	return <SearchInput<${typeName}> options={list} ${reactLabelField} loading={!ready} {...delegated} />
 }
 export const ${components.forms.searchFieldName} = ({
   ...delegated
-}: Omit<React.ComponentPropsWithoutRef<typeof SearchField<${typeName}>>, 'label' | 'options' | 'loading'>) => {
+}: Omit<React.ComponentPropsWithoutRef<typeof SearchField<${typeName}>>, ${tsOmittedFields}>) => {
   const { list, ready } = ${context.hookFnName}()
-  return <SearchField<${typeName}> options={list} label={(l) => l.name} loading={!ready} {...delegated} />
+  return <SearchField<${typeName}> options={list} ${reactLabelField} loading={!ready} {...delegated} />
 }
 
 // Table
 
 export const ${components.forms.tableSelectInputName} = ({
 	...delegated
-}: UnionOmit<React.ComponentPropsWithoutRef<typeof TableSelectInput<${typeName}>>, 'label' | 'options' | 'loading'>) => {
+}: UnionOmit<React.ComponentPropsWithoutRef<typeof TableSelectInput<${typeName}>>, ${tsOmittedFields}>) => {
 	const { list, ready } = ${context.hookFnName}()
-	return <TableSelectInput<${typeName}> options={list} label={(l) => l.name} loading={!ready} {...delegated} />
+	return <TableSelectInput<${typeName}> options={list} ${reactLabelField} loading={!ready} {...delegated} />
 }
 
 export const ${components.forms.tableSelectFieldName} = ({
 	...delegated
-}: UnionOmit<React.ComponentPropsWithoutRef<typeof TableSelectField<${typeName}>>, 'label' | 'options' | 'loading'>) => {
+}: UnionOmit<React.ComponentPropsWithoutRef<typeof TableSelectField<${typeName}>>, ${tsOmittedFields}>) => {
 	const { list, ready } = ${context.hookFnName}()
-	return <TableSelectField<${typeName}> options={list} label={(l) => l.name} loading={!ready} {...delegated} />
+	return <TableSelectField<${typeName}> options={list} ${reactLabelField} loading={!ready} {...delegated} />
 }
 `;
 }

package/dist/src/lib/exports.d.ts

@@ -8,17 +8,32 @@ export declare class ExportsGenerator {
      * Path of the file we're generating exports for.
      */
     private _path;
-    constructor({ path }: {
+    /**
+     * Tells whether this generator acts as a root.
+     */
+    private isRoot;
+    constructor({ path, isRoot }: {
         path: string;
+        isRoot?: boolean;
     });
     /**
      * Creates a new instance of the exports generator.
      */
     static from(path: Types.Path): ExportsGenerator;
+    /**
+     * Creates a new instance of the exports generator from this folder (i.e. every path is relative to this folder).
+     */
+    static fromRoot(): ExportsGenerator;
+    /**
+     * Adds a given file to the collection of files we're exporting everything from.
+     */
+    exportEverythingFromPath(from: Types.Path): ExportsGenerator;
     /**
      * Adds a given file to the collection of files we're exporting everything from.
+     *
+     * NOTE: This should only be used when the generator is a root generator.
      */
-    exportEverythingFrom(from: Types.Path): ExportsGenerator;
+    exportEverythingFromFile(file: string): ExportsGenerator;
     /**
      * Returns the TypeScript export statements.
      */

package/dist/src/lib/exports.js

@@ -6,9 +6,10 @@ const file_1 = require("./utils/file");
  * A utility component that lets you generate TypeScript export statements that export all items from a given file.
  */
 class ExportsGenerator {
-    constructor({ path }) {
+    constructor({ path, isRoot }) {
         this._path = path;
         this._exports = new Set();
+        this.isRoot = isRoot !== null && isRoot !== void 0 ? isRoot : false;
     }
     /**
      * Creates a new instance of the exports generator.
@@ -16,14 +17,35 @@ class ExportsGenerator {
     static from(path) {
         return new ExportsGenerator({ path });
     }
+    /**
+     * Creates a new instance of the exports generator from this folder (i.e. every path is relative to this folder).
+     */
+    static fromRoot() {
+        return new ExportsGenerator({ path: './', isRoot: true });
+    }
     /**
      * Adds a given file to the collection of files we're exporting everything from.
      */
-    exportEverythingFrom(from) {
+    exportEverythingFromPath(from) {
+        if (this.isRoot) {
+            throw new Error(`Cannot use "exportEverythingFromPath" on a root generator.`);
+        }
         const resolvedPath = (0, file_1.getRelativePath)({ from: this._path, to: from });
         this._exports.add(resolvedPath);
         return this;
     }
+    /**
+     * Adds a given file to the collection of files we're exporting everything from.
+     *
+     * NOTE: This should only be used when the generator is a root generator.
+     */
+    exportEverythingFromFile(file) {
+        if (!this.isRoot) {
+            throw new Error(`Cannot use "exportEverythingFromFile" on a non-root generator.`);
+        }
+        this._exports.add(file);
+        return this;
+    }
     /**
      * Returns the TypeScript export statements.
      */