@postxl/generator 0.62.3 → 0.62.5

package/dist/generator.js

@@ -62,8 +62,8 @@ const repositories_generator_1 = require("./generators/indices/repositories.gene
 const routes_index_generator_1 = require("./generators/indices/routes-index.generator");
 const seed_migration_generator_1 = require("./generators/indices/seed-migration.generator");
 const seed_template_generator_1 = require("./generators/indices/seed-template.generator");
-const selectors_generator_1 = require("./generators/indices/selectors.generator");
 const testdata_service_generator_1 = require("./generators/indices/testdata-service.generator");
+const testids_generator_1 = require("./generators/indices/testids.generator");
 const types_generator_2 = require("./generators/indices/types.generator");
 const admin_page_generator_1 = require("./generators/models/admin.page.generator");
 const businesslogic_update_generator_1 = require("./generators/models/businesslogic-update.generator");
@@ -206,7 +206,7 @@ function generate({ models, enums, config, prismaClientPath, logger, }) {
         generated.write(`/${meta.data.dataService.location.path}.ts`, (0, dataservice_generator_1.generateDataService)({ models, meta }));
         generated.write(`/${meta.data.testDataServiceFilePath}.ts`, (0, testdata_service_generator_1.generateTestDataService)({ models, meta }));
         generated.write(`/${meta.e2e.dataMockerLocation.path}.ts`, (0, datamocker_generator_1.generateDataMocker)({ models, meta }));
-        generated.write(`/${meta.e2e.selectorsFilePath}.ts`, (0, selectors_generator_1.generateSelectors)());
+        generated.write(`/${meta.e2e.testIdsFilePath}.ts`, (0, testids_generator_1.generateTestIds)());
         generated.write(`/${meta.data.repository.constFilePath}.ts`, (0, repositories_generator_1.generateRepositoriesArray)({ models, meta }));
         generated.write(`/${meta.data.types.location.path}.ts`, (0, data_types_generator_1.generateDataTypes)({ models, meta }));
         // Import-Export

package/dist/generators/indices/testids.generator.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Generates list of test ids for E2E tests.
+ *
+ * Note: This generator does not need the models or meta data passed in.
+ * Instead it uses the TestIdCollector singleton that already collected all ids during the generation process of the individual models.
+ */
+export declare function generateTestIds(): string;

package/dist/generators/indices/{selectors.generator.js → testids.generator.js}

@@ -1,38 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateSelectors = void 0;
-const id_collector_1 = require("../../lib/id-collector");
+exports.generateTestIds = void 0;
+const test_id_collector_1 = require("../../lib/test-id-collector");
 /**
- * List of ids that are not generated but hardcoded across the template.
- */
-const HARDCODED_IDS = [
-    'indexPage-buttons-create',
-    'confirmationModal-buttons-confirm',
-    'confirmationModal-buttons-cancel',
-];
-/**
- * Generates list of component selectors for E2E tests.
+ * Generates list of test ids for E2E tests.
  *
  * Note: This generator does not need the models or meta data passed in.
- * Instead it uses the SelectorCollector singleton that already collected all ids during the generation process of the individual models.
+ * Instead it uses the TestIdCollector singleton that already collected all ids during the generation process of the individual models.
  */
-function generateSelectors() {
-    // SelectorCollector is a static singleton that collects all ids during the generation process. We flush it here to get all ids.
-    const collectedIds = id_collector_1.SelectorCollector.flush();
+function generateTestIds() {
+    // TestIdCollector is a static singleton that collects all ids during the generation process. We flush it here to get all ids.
+    const collectedIds = test_id_collector_1.TestIdCollector.flush();
     const object = {};
-    const ids = [...HARDCODED_IDS, ...collectedIds];
+    const ids = collectedIds;
     ids.sort();
     for (const id of ids) {
         const keys = id.split('-');
-        extendObject(object, keys, `[data-test-id=${id}]`);
+        extendObject(object, keys, id);
     }
-    const selectors = JSON.stringify(object, null, 2);
+    const testIds = JSON.stringify(object, null, 2);
     return /* ts */ `
-  export const SELECTORS =
-  ${selectors}
+  /**
+   * Object with all generated test ids.
+   */
+  export const MODEL_TEST_IDS =
+  ${testIds}
   `;
 }
-exports.generateSelectors = generateSelectors;
+exports.generateTestIds = generateTestIds;
 /**
  * Recursively traverses the keys and adds the value to the object in a nested way.
  * E.g. `{object, keys: ['post', 'create', 'name'], value}` will extend `object` with `{post: {create: {name: value}}}`.

package/dist/generators/models/admin.page.generator.js

@@ -21,9 +21,11 @@ import { Headline } from '@components/atoms/Headline'
 ${imports.generate()}
 
 import { Content, Layout } from '@components/shared/Layout'
+import { STATIC_TEST_IDS } from '@lib/static_test_ids'
 import { t } from '@i18n/translation'
 import { useState } from 'react'
 
+
 export default function Admin${meta.internalSingularNameCapitalized}Page() {
   const [query, setQuery] = useState('')
   const [isCreateModalOpen, setIsCreateModalOpen] = useState(false)
@@ -44,7 +46,7 @@ export default function Admin${meta.internalSingularNameCapitalized}Page() {
             <Spacer key="Spacer" />
 
             <ActionWrapper key="GlobalFilter">
-              <Button label={t['Create']} icon="plus" fill="fill" __e2e_selector__="indexPage-buttons-create" onClick={() => setIsCreateModalOpen(true)}/>
+              <Button label={t['Create']} icon="plus" fill="fill" __e2e_test_id__={STATIC_TEST_IDS.indexPage.buttons.create} onClick={() => setIsCreateModalOpen(true)}/>
             </ActionWrapper>
           </ActionsBarWrapper>
         </Header>

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

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateModelLibraryComponents = void 0;
-const id_collector_1 = require("../../../lib/id-collector");
 const imports_1 = require("../../../lib/imports");
+const test_id_collector_1 = require("../../../lib/test-id-collector");
 /**
  * Generates components that may be used to list all entries of a given data type.
  *
  */
 function generateModelLibraryComponents({ model, meta }) {
     const { react: { context, components }, } = meta;
-    const selectorCollector = id_collector_1.SelectorCollector.from(meta.seed.constantName + '-card');
+    const testIdCollector = test_id_collector_1.TestIdCollector.from(meta.seed.constantName + '-card');
     const titleProp = model.nameField.isRequired
         ? `title={item.${model.nameField.name}}`
         : `title={item.${model.nameField.name} ?? item.${model.idField.name}}`;
@@ -61,13 +61,13 @@ function generateModelLibraryComponents({ model, meta }) {
                   label: 'Edit',
                   icon: 'pencil-on-paper',
                   onClick: () => setIsEditModalOpen(true),
-                  __e2e_action_selector__: "${selectorCollector.idFor('edit', { typePrefix: 'actions' })}",
+                  __e2e_action_test_id__: "${testIdCollector.idFor('edit', { typePrefix: 'actions' })}",
                 },
                 {
                   label: 'Delete',
                   icon: 'trash',
                   onClick: () => setIsDeleteModalOpen(true),
-                  __e2e_action_selector__: "${selectorCollector.idFor('delete', { typePrefix: 'actions' })}",
+                  __e2e_action_test_id__: "${testIdCollector.idFor('delete', { typePrefix: 'actions' })}",
                 },
               ]}
             />

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

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateModelLookupComponents = void 0;
-const id_collector_1 = require("../../../lib/id-collector");
 const imports_1 = require("../../../lib/imports");
+const test_id_collector_1 = require("../../../lib/test-id-collector");
 /**
- * Returns a selector string that links the component to the global selectors index.
+ * Generates a test id that that can be used to identify a component in E2E tests.
  */
-function selector(meta, typePrefix, options) {
+function testId(meta, typePrefix, options) {
     var _a;
-    const selectorCollector = id_collector_1.SelectorCollector.from(meta.seed.constantName + '-formComponents');
-    return selectorCollector.idFor((_a = options === null || options === void 0 ? void 0 : options.element) !== null && _a !== void 0 ? _a : '', { typePrefix });
+    const testIdCollector = test_id_collector_1.TestIdCollector.from(meta.seed.constantName + '-formComponents');
+    return testIdCollector.idFor((_a = options === null || options === void 0 ? void 0 : options.element) !== null && _a !== void 0 ? _a : '', { typePrefix });
 }
 /**
  * Utility generator that generates lookup components for a given model.
@@ -61,7 +61,7 @@ export const ${components.forms.selectInputName} = ({
     options={list}
     ${labelProp}
     loading={!ready} 
-    __e2e_field_selector__="${selector(meta, 'selectInput')}"
+    __e2e_field_test_id__="${testId(meta, 'selectInput')}"
     {...delegated}
   />
 }
@@ -75,7 +75,7 @@ export const ${components.forms.selectFieldName} = ({
     options={list}
     ${labelProp}
     loading={!ready} 
-    __e2e_field_selector__="${selector(meta, 'selectField')}"
+    __e2e_field_test_id__="${testId(meta, 'selectField')}"
     {...delegated}
   />
 }
@@ -91,7 +91,7 @@ export const ${components.forms.menuSelectInputName} = ({
     options={list}
     ${labelProp}
     loading={!ready} 
-    __e2e_options_selector__="${selector(meta, 'menuSelectInput')}"
+    __e2e_options_test_id__="${testId(meta, 'menuSelectInput')}"
     {...delegated}
   />
 }
@@ -105,7 +105,7 @@ export const ${components.forms.menuSelectFieldName} = ({
     options={list}
     ${labelProp}
     loading={!ready} 
-    __e2e_options_selector__="${selector(meta, 'menuSelectField')}"
+    __e2e_options_test_id__="${testId(meta, 'menuSelectField')}"
     {...delegated}
   />
 }
@@ -121,8 +121,8 @@ export const ${components.forms.searchInputName} = ({
     options={list}
     ${labelProp}
     loading={!ready} 
-    __e2e_combobox_selector__="${selector(meta, 'searchInput', { element: 'field' })}"
-    __e2e_options_selector__="${selector(meta, 'searchInput', { element: 'options' })}"
+    __e2e_combobox_test_id__="${testId(meta, 'searchInput', { element: 'field' })}"
+    __e2e_options_test_id__="${testId(meta, 'searchInput', { element: 'options' })}"
     {...delegated}
   />
 }
@@ -136,8 +136,8 @@ export const ${components.forms.searchFieldName} = ({
     options={list}
     ${labelProp}
     loading={!ready} 
-    __e2e_combobox_selector__="${selector(meta, 'searchField', { element: 'field' })}"
-    __e2e_options_selector__="${selector(meta, 'searchField', { element: 'options' })}"
+    __e2e_combobox_test_id__="${testId(meta, 'searchField', { element: 'field' })}"
+    __e2e_options_test_id__="${testId(meta, 'searchField', { element: 'options' })}"
     {...delegated}
   />
 }
@@ -152,7 +152,7 @@ export const ${components.forms.tableSelectInputName} = ({
     options={list}
     ${labelProp}
     loading={!ready} 
-    __e2e_input_field_selector__="${selector(meta, 'tableSelectInput')}"
+    __e2e_input_field_test_id__="${testId(meta, 'tableSelectInput')}"
     {...delegated}
   />
 }
@@ -166,7 +166,7 @@ export const ${components.forms.tableSelectFieldName} = ({
     options={list}
     ${labelProp}
     loading={!ready} 
-    __e2e_input_field_selector__="${selector(meta, 'tableSelectField')}"
+    __e2e_input_field_test_id__="${testId(meta, 'tableSelectField')}"
     {...delegated}
   />
 }

package/dist/generators/models/react.generator/modals.generator.js

@@ -24,11 +24,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateDeleteModalModelComponent = exports.generateEditModalModelComponent = exports.generateModelCreateModalComponent = void 0;
-const id_collector_1 = require("../../../lib/id-collector");
 const imports_1 = require("../../../lib/imports");
 const meta_1 = require("../../../lib/meta");
 const fields_1 = require("../../../lib/schema/fields");
 const serializer_1 = require("../../../lib/serializer");
+const test_id_collector_1 = require("../../../lib/test-id-collector");
 const types_1 = require("../../../lib/types");
 const StringUtils = __importStar(require("../../../lib/utils/string"));
 /**
@@ -37,7 +37,7 @@ const StringUtils = __importStar(require("../../../lib/utils/string"));
 function generateModelCreateModalComponent({ model, meta }) {
     const { fields } = model;
     const { react: { components: { modals }, }, trpc, } = meta;
-    const selectorCollector = id_collector_1.SelectorCollector.from(meta.seed.constantName + '-createModal');
+    const testIdCollector = test_id_collector_1.TestIdCollector.from(meta.seed.constantName + '-createModal');
     const dimensions = getModalComponentDimensions({ model });
     return `
 /* eslint-disable @typescript-eslint/no-unused-vars */
@@ -150,10 +150,10 @@ export const ${modals.createComponentName} = ({
               fill="fill"
               onClick={submitForm}
               loading={isSubmitting}
-              __e2e_selector__="${selectorCollector.idFor('submit', { typePrefix: 'buttons' })}"
+              __e2e_test_id__="${testIdCollector.idFor('submit', { typePrefix: 'buttons' })}"
             />
 					}>
-						${getFormFieldComponents({ model, selectorCollector })}
+						${getFormFieldComponents({ model, testIdCollector: testIdCollector })}
           </ModalWithActions>
         )}
       </Typed.Formik>
@@ -170,7 +170,7 @@ exports.generateModelCreateModalComponent = generateModelCreateModalComponent;
 function generateEditModalModelComponent({ model, meta }) {
     const { fields } = model;
     const { react: { components }, trpc, } = meta;
-    const selectorCollector = id_collector_1.SelectorCollector.from(meta.seed.constantName + '-editModal');
+    const testIdCollector = test_id_collector_1.TestIdCollector.from(meta.seed.constantName + '-editModal');
     const dimensions = getModalComponentDimensions({ model });
     return `
 /* eslint-disable @typescript-eslint/no-unused-vars */
@@ -286,11 +286,11 @@ export const ${components.modals.editComponentName} = ({
                 color="primary"
                 onClick={submitForm}
                 loading={isSubmitting}
-                __e2e_selector__="${selectorCollector.idFor('submit', { typePrefix: 'buttons' })}"
+                __e2e_test_id__="${testIdCollector.idFor('submit', { typePrefix: 'buttons' })}"
               />
             }
           >
-            ${getFormFieldComponents({ model, selectorCollector })}
+            ${getFormFieldComponents({ model, testIdCollector: testIdCollector })}
           </ModalWithActions>
         )}
       </Typed.Formik>
@@ -559,7 +559,7 @@ function getEditFormikMutationData({ model: { fields } }) {
 /**
  * Returns a string containing all the components that should appear in the Formik form for this model.
  */
-function getFormFieldComponents({ model, selectorCollector, }) {
+function getFormFieldComponents({ model, testIdCollector, }) {
     var _a;
     const form = new serializer_1.Serializer();
     for (const field of model.fields.values()) {
@@ -584,7 +584,7 @@ function getFormFieldComponents({ model, selectorCollector, }) {
                 <Typed.TextField 
                   name="${formikFieldName}"
                   placeholder="Type..."
-                  __e2e_field_selector__="${selectorCollector.idFor(field.name, { typePrefix: 'fields' })}"
+                  __e2e_field_test_id__="${testIdCollector.idFor(field.name, { typePrefix: 'fields' })}"
                 />
               </div>
             `);
@@ -602,7 +602,7 @@ function getFormFieldComponents({ model, selectorCollector, }) {
                   name="${formikFieldName}"
                   placeholder="2511"
                   decimals={${decimals}}
-                  __e2e_field_selector__="${selectorCollector.idFor(field.name, { typePrefix: 'fields' })}"
+                  __e2e_field_test_id__="${testIdCollector.idFor(field.name, { typePrefix: 'fields' })}"
                 />
               </div>
             `);
@@ -615,7 +615,7 @@ function getFormFieldComponents({ model, selectorCollector, }) {
                 <Typed.CheckBoxField 
                   name="${formikFieldName}" 
                   label="${label}" 
-                  __e2e_field_selector__="${selectorCollector.idFor(field.name, { typePrefix: 'fields' })}"
+                  __e2e_field_test_id__="${testIdCollector.idFor(field.name, { typePrefix: 'fields' })}"
                 />
               </div>
             `);
@@ -640,8 +640,8 @@ function getFormFieldComponents({ model, selectorCollector, }) {
             <Typed.${refMeta.react.components.forms.searchFieldName} 
               name="${formikFieldName}" 
               placeholder="Search..." 
-              __e2e_options_selector__="${selectorCollector.idFor(field.name, { typePrefix: 'options' })}"
-              __e2e_combobox_selector__="${selectorCollector.idFor(field.name, { typePrefix: 'fields' })}"
+              __e2e_options_test_id__="${testIdCollector.idFor(field.name, { typePrefix: 'options' })}"
+              __e2e_combobox_test_id__="${testIdCollector.idFor(field.name, { typePrefix: 'fields' })}"
             />
           </div>
         `);
@@ -655,7 +655,7 @@ function getFormFieldComponents({ model, selectorCollector, }) {
             <Typed.${enumMeta.react.selectFieldName} 
               name="${formikFieldName}" 
               placeholder="Search..." 
-              __e2e_field_selector__="${selectorCollector.idFor(field.name, { typePrefix: 'fields' })}"
+              __e2e_field_test_id__="${testIdCollector.idFor(field.name, { typePrefix: 'fields' })}"
             />
           </div>
         `);

package/dist/lib/meta.d.ts

@@ -651,9 +651,9 @@ export type SchemaMetaData = {
          */
         dataMockerLocation: Types.ModuleLocation;
         /**
-         * Path to the file containing component selectors for e2e tests.
+         * Path to the file containing component test ids for e2e tests.
          */
-        selectorsFilePath: Types.FilePath;
+        testIdsFilePath: Types.FilePath;
     };
     /**
      * Path to the directory containing Prisma migrations.

package/dist/lib/meta.js

@@ -153,7 +153,7 @@ function getSchemaMetadata({ config }) {
         },
         e2e: {
             dataMockerLocation: Types.toModuleLocation(`e2e`, `${config.paths.playwrightPath}support/data-mocker.class`),
-            selectorsFilePath: Types.toPath(`${config.paths.playwrightPath}support/selectors`),
+            testIdsFilePath: Types.toPath(`${config.paths.playwrightPath}support/model-test-ids`),
         },
         importExport: {
             moduleLocation: Types.toModuleLocation(`import-export`, `${config.paths.importExportPath}import-export.module`),

package/dist/lib/{id-collector.d.ts → test-id-collector.d.ts}

@@ -1,17 +1,17 @@
-type ElementId = string & {
+export type TestId = string & {
     __brand: 'ElementId';
 };
 /**
- * The SelectorCollector is used to generate and track HTML element IDs.
+ * The TestIdCollector is used to generate and track HTML element IDs.
  * The idea is that it is instantiated once and then used to generate IDs throughout the generators.
  * After the files are generated, all generated IDs can be serialized to a file.
  *
  * An ID can for instance be something like `post-create-name, `${model.name}-${componentType}-${fieldName}`.
  *
- * Each code generator can instantiate an SelectorCollector - the constructor will require the current model & component type.
+ * Each code generator can instantiate a TestIdCollector - the constructor will require the current model & component type.
  * All generated Ids will be stored in a global static Set so we can serialize them later.
  */
-export declare class SelectorCollector {
+export declare class TestIdCollector {
     private _prefix;
     /**
      * We store all generated IDs in a global static Set so we can serialize them later.
@@ -19,9 +19,9 @@ export declare class SelectorCollector {
     private static _ids;
     constructor(_prefix: string);
     /**
-     * Creates a new instance of the SelectorCollector.
+     * Creates a new instance of the TestIdCollector.
      */
-    static from(prefix: string): SelectorCollector;
+    static from(prefix: string): TestIdCollector;
     /**
      * Generates a new ID for an element and stores it in the collector
      */
@@ -34,10 +34,9 @@ export declare class SelectorCollector {
          * Optional prefix for the type of the element, e.g. `field` or `button`.
          */
         typePrefix?: string;
-    }): string;
+    }): TestId;
     /**
      * Returns all generated IDs and resets the stored IDs.
      */
-    static flush(): ElementId[];
+    static flush(): TestId[];
 }
-export {};

package/dist/lib/{id-collector.js → test-id-collector.js}

@@ -1,25 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SelectorCollector = void 0;
+exports.TestIdCollector = void 0;
 /**
- * The SelectorCollector is used to generate and track HTML element IDs.
+ * The TestIdCollector is used to generate and track HTML element IDs.
  * The idea is that it is instantiated once and then used to generate IDs throughout the generators.
  * After the files are generated, all generated IDs can be serialized to a file.
  *
  * An ID can for instance be something like `post-create-name, `${model.name}-${componentType}-${fieldName}`.
  *
- * Each code generator can instantiate an SelectorCollector - the constructor will require the current model & component type.
+ * Each code generator can instantiate a TestIdCollector - the constructor will require the current model & component type.
  * All generated Ids will be stored in a global static Set so we can serialize them later.
  */
-class SelectorCollector {
+class TestIdCollector {
     constructor(_prefix) {
         this._prefix = _prefix;
     }
     /**
-     * Creates a new instance of the SelectorCollector.
+     * Creates a new instance of the TestIdCollector.
      */
     static from(prefix) {
-        return new SelectorCollector(prefix);
+        return new TestIdCollector(prefix);
     }
     /**
      * Generates a new ID for an element and stores it in the collector
@@ -31,23 +31,23 @@ class SelectorCollector {
     elementName, options) {
         const { typePrefix } = options !== null && options !== void 0 ? options : {};
         const id = [this._prefix, typePrefix, elementName].filter((x) => x !== undefined && x !== '').join('-');
-        if (SelectorCollector._ids.has(id)) {
+        if (TestIdCollector._ids.has(id)) {
             throw new Error(`ID ${id} already exists.`);
         }
-        SelectorCollector._ids.add(id);
+        TestIdCollector._ids.add(id);
         return id;
     }
     /**
      * Returns all generated IDs and resets the stored IDs.
      */
     static flush() {
-        const result = [...SelectorCollector._ids.values()];
-        SelectorCollector._ids.clear();
+        const result = [...TestIdCollector._ids.values()];
+        TestIdCollector._ids.clear();
         return result;
     }
 }
-exports.SelectorCollector = SelectorCollector;
+exports.TestIdCollector = TestIdCollector;
 /**
  * We store all generated IDs in a global static Set so we can serialize them later.
  */
-SelectorCollector._ids = new Set();
+TestIdCollector._ids = new Set();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postxl/generator",
-  "version": "0.62.3",
+  "version": "0.62.5",
   "main": "./dist/generator.js",
   "typings": "./dist/generator.d.ts",
   "bin": {

package/dist/generators/indices/selectors.generator.d.ts

@@ -1,7 +0,0 @@
-/**
- * Generates list of component selectors for E2E tests.
- *
- * Note: This generator does not need the models or meta data passed in.
- * Instead it uses the SelectorCollector singleton that already collected all ids during the generation process of the individual models.
- */
-export declare function generateSelectors(): string;