@postxl/generator 0.34.0 → 0.35.0

package/dist/lib/utils/jsdoc.js

@@ -1,14 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsDocComment = void 0;
+exports.toJsDocComment = void 0;
 /**
  * Returns a string of JSDoc comments from an array of lines.
  */
-function jsDocComment(lines) {
-    const _lines = lines
+function toJsDocComment(comments) {
+    if (!comments || comments.length === 0) {
+        return '';
+    }
+    return `/**${comments
         .filter((c) => c !== '')
         .map((c) => `\n   * ${c}`)
-        .join('');
-    return `/**${_lines}\n   */`;
+        .join('')} \n   */`;
 }
-exports.jsDocComment = jsDocComment;
+exports.toJsDocComment = toJsDocComment;

package/dist/lib/utils/string.js

@@ -70,8 +70,9 @@ const irregularPlurals = {
  * Returns a pluralized version of the given string based on the count.
  */
 const pluralize = (s, count = 2) => {
-    if (count === 1)
+    if (count === 1) {
         return s;
+    }
     if (s.endsWith('y') &&
         !s.endsWith('ay') &&
         !s.endsWith('ey') &&

package/dist/prisma/attributes.js

@@ -11,16 +11,18 @@ const string_1 = require("../lib/utils/string");
  */
 function parseAttributesFromDocumentation({ documentation }) {
     const prefix = '@@';
-    if (!documentation)
+    if (!documentation) {
         return {};
+    }
     return documentation
         .split('\n')
         .filter((d) => d.startsWith(prefix))
         .map((d) => d.replace(prefix, ''))
         .reduce((acc, line) => {
         const pattern = /(\w+)\((.*?)\)$/;
-        if (!pattern.test(line))
+        if (!pattern.test(line)) {
             return acc;
+        }
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         const [attribute, arg] = line.match(pattern).slice(1);
         acc[(0, string_1.toCamelCase)(attribute)] = parseArgumentToStringOrStringArray(arg);
@@ -71,6 +73,7 @@ function getModelAttributes(model) {
         description: zod_1.default.string().optional(),
         schema: zod_1.default.string().optional(),
         index: zod_1.default.array(zod_1.default.string()).optional(),
+        seed: zod_1.default.string().optional(),
     })
         .transform((obj) => ({
         ignore: obj.ignore,
@@ -78,6 +81,7 @@ function getModelAttributes(model) {
         description: obj.description,
         databaseSchema: obj.schema,
         index: obj.index,
+        randomSeed: obj.seed !== undefined ? parseInt(obj.seed, 10) : undefined,
     }));
     const result = decoder.safeParse(attributes);
     if (!result.success) {
@@ -144,7 +148,7 @@ function getFieldAttributes(field) {
             isLabel: obj.label,
             examples: obj.examples || obj.example,
             maxLength: obj.maxLength,
-            isReadonly: obj.readonly || field.isGenerated || field.isUpdatedAt || field.name === 'createdAt',
+            isReadonly: obj.readonly || field.isGenerated || field.isUpdatedAt || field.name === 'createdAt' || field.isId,
             isUpdatedAt: (_a = field.isUpdatedAt) !== null && _a !== void 0 ? _a : false,
             isCreatedAt: field.name === 'createdAt',
         });

package/dist/prisma/parse.js

@@ -28,19 +28,34 @@ const Types = __importStar(require("../lib/schema/types"));
 const error_1 = require("../lib/utils/error");
 const string_1 = require("../lib/utils/string");
 const attributes_1 = require("./attributes");
+/**
+ * These models are required for the generators/backend to work.
+ */
+const REQUIRED_MODELS = ['User', 'Config', 'File', 'Action', 'Mutation'];
 /**
  * Converts a Prisma schema (DMMF) document to a Schema that's passed around generators.
  */
 function parsePrismaSchema({ datamodel: { enums: enumsRaw, models: modelsRaw }, config, }) {
+    ensureRequiredModelsExists(modelsRaw);
     // NOTE: We preprocess models and enums so that we can populate relationships.
     const models = modelsRaw.map((dmmfModel) => parseModelCore({ dmmfModel, config }));
     const enums = enumsRaw.map((dmmfEnum) => parseEnum({ dmmfEnum, config }));
     const modelsWithFields = modelsRaw
         .map((dmmfModel) => parseModel({ dmmfModel, models, enums, config }))
-        .filter((model) => !model.attributes.ignore);
+        .filter(isModelNotIgnored);
     return { models: modelsWithFields, enums };
 }
 exports.parsePrismaSchema = parsePrismaSchema;
+function ensureRequiredModelsExists(models) {
+    for (const requiredModel of REQUIRED_MODELS) {
+        if (!models.find((m) => m.name === requiredModel)) {
+            (0, error_1.throwError)(`Required model ${requiredModel} not found in schema!`);
+        }
+    }
+}
+function isModelNotIgnored(model) {
+    return model !== undefined && !model.attributes.ignore;
+}
 /**
  * Parses the core properties of a model without fields.
  */
@@ -63,6 +78,10 @@ function parseModelCore({ dmmfModel, config, }) {
  */
 function parseModel({ dmmfModel, enums, models, config, }) {
     const core = parseModelCore({ dmmfModel, config });
+    // NOTE: We ignore models which are marked as ignored.
+    if (core.attributes.ignore) {
+        return undefined;
+    }
     // NOTE: We assume that each relation may only reference one field. Because of this,
     // we can "relate" a given relation to a scalar field used in the relation.
     //   Since Prisma doesn't mark those fields as relations, we need to preprocess
@@ -287,13 +306,14 @@ function getTsTypeForScalar(field) {
         case 'Float':
         case 'Int':
             return Types.toTypeName('number');
-        case 'JSON':
+        case 'Json':
         case 'Bytes':
             (0, error_1.throwError)('Not implemented yet');
-            break;
+        // While TypeScript understands that throwError never returns, eslint doesn't and complains.
+        // Hence we ignore the fallthrough error.
+        // eslint-disable-next-line no-fallthrough
         default:
-            // return field.type
-            (0, error_1.throwError)(`Investigate: 'default' case in getTypescriptType for field ${field.name} of type ${field.type}`);
+            (0, error_1.throwError)(`Investigate: 'default' case in getTsTypeForScalar for field ${field.name} of type ${field.type}`);
     }
 }
 /**

package/package.json

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

package/dist/generators/indices/businesslogicindex.generator.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateBusinessLogicIndex = void 0;
-const exports_1 = require("../../lib/exports");
-const meta_1 = require("../../lib/meta");
-/**
- * Generates index file for all businessLogic files.
- */
-function generateBusinessLogicIndex({ models, meta }) {
-    const exports = exports_1.ExportsGenerator.from(meta.businessLogic.indexFilePath);
-    exports.exportEverythingFromPath(meta.businessLogic.serviceFilePath);
-    exports.exportEverythingFromPath(meta.businessLogic.moduleFilePath);
-    for (const model of models) {
-        const meta = (0, meta_1.getModelMetadata)({ model });
-        exports.exportEverythingFromPath(meta.businessLogic.serviceFilePath);
-    }
-    return exports.generate();
-}
-exports.generateBusinessLogicIndex = generateBusinessLogicIndex;

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

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateSeedIndex = void 0;
-const exports_1 = require("../../lib/exports");
-const meta_1 = require("../../lib/meta");
-/**
- * Generates index file for all seed files.
- */
-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.exportEverythingFromPath(meta.seed.filePath);
-    }
-    return exports.generate();
-}
-exports.generateSeedIndex = generateSeedIndex;

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

@@ -1,9 +0,0 @@
-import { SchemaMetaData } from '../../lib/meta';
-import { Model } from '../../lib/schema/schema';
-/**
- * Generates a generic data service object that may be used on the server to access database.
- */
-export declare function generateTestDataService({ meta, models }: {
-    meta: SchemaMetaData;
-    models: Model[];
-}): string;

package/dist/generators/indices/testdataservice.generator.js

@@ -1,78 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateTestDataService = void 0;
-const meta_1 = require("../../lib/meta");
-const Types = __importStar(require("../../lib/schema/types"));
-const imports_1 = require("../../lib/imports");
-/**
- * Generates a generic data service object that may be used on the server to access database.
- */
-function generateTestDataService({ meta, models }) {
-    const imports = imports_1.ImportsGenerator.from(meta.data.testDataServiceFilePath).addImport({
-        items: [Types.toVariableName('MockData')],
-        from: meta.data.dataMockModuleFilePath,
-    });
-    const mm = models.map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }));
-    for (const { meta } of mm) {
-        imports.addImport({
-            items: [meta.data.repositoryClassName],
-            from: meta.data.repoFilePath,
-        });
-    }
-    const constructor = mm
-        .map(({ meta }) => `private ${meta.data.dataServiceName} :${meta.data.repositoryClassName}`)
-        .join(',\n');
-    return `
-		import { Injectable, Logger } from '@nestjs/common'
-
-		import { ResetService } from '@pxl/common'
-		import { DbService } from '@${meta.config.project}/db'
-
-		${imports.generate()}
-
-		@Injectable()
-		export class TestDataService {
-			private logger = new Logger(TestDataService.name)
-			constructor(
-				private db: DbService,
-				private resetService: ResetService,
-				${constructor}
-			) {}
-
-			public async resetTestData(data: MockData) {
-				this.logger.log(\`✅ Reset test data\`)
-				await this.db.emptyDatabase()
-
-				${mm
-        .map(({ meta }) => `await this.${meta.data.dataServiceName}.reInit(data.${meta.data.mockDataPropertyName} ?? [])`)
-        .join('\n')}
-				
-					return this.resetService.reset()
-			}
-		}
-	`;
-}
-exports.generateTestDataService = generateTestDataService;

package/dist/generators/models/businesslogic.generator.d.ts

@@ -1,9 +0,0 @@
-import { ModelMetaData } from '../../lib/meta';
-import { Model } from '../../lib/schema/schema';
-/**
- * Generates business logic for a given model.
- */
-export declare function generateModelBusinessLogic({ model, meta }: {
-    model: Model;
-    meta: ModelMetaData;
-}): string;