@postxl/generator 0.74.1 → 1.0.1

package/dist/generators/models/update/service.generator.js

@@ -1,302 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateModelBusinessLogicUpdate = void 0;
-const assert_1 = __importDefault(require("assert"));
-const imports_1 = require("../../../lib/imports");
-const meta_1 = require("../../../lib/meta");
-const fields_1 = require("../../../lib/schema/fields");
-const types_1 = require("../../../lib/schema/types");
-const types_2 = require("../../../lib/types");
-const typescript_1 = require("../../../lib/typescript");
-const jsdoc_1 = require("../../../lib/utils/jsdoc");
-const zod_1 = require("../../../lib/zod");
-/**
- * Generates update business logic for a given model.
- * The update logic handles all Create/Update/Delete/Upsert operations. See template's readme for more info.
- */
-function generateModelBusinessLogicUpdate({ model, meta }) {
-    const schemaMeta = (0, meta_1.getSchemaMetadata)({ config: model.schemaConfig });
-    const { view, update, types, data } = meta;
-    const imports = imports_1.ImportsGenerator.from(meta.update.serviceClassLocation.path).addImports({
-        [data.repository.location.import]: data.repository.className,
-        [types.importPath]: [model.brandedIdType, types.typeName, types.toBrandedIdTypeFnName, (0, types_1.toTypeName)('User')],
-        [view.serviceLocation.import]: [view.serviceClassName],
-        [schemaMeta.actions.execution.interfaceLocation.import]: [schemaMeta.actions.execution.interface],
-        [schemaMeta.actions.dispatcher.definitionLocation.import]: [schemaMeta.actions.dispatcher.definition],
-        [schemaMeta.update.serviceLocation.path]: schemaMeta.update.serviceClassName,
-        [schemaMeta.view.serviceLocation.import]: schemaMeta.view.serviceClassName,
-    });
-    for (const field of (0, fields_1.getRelationFields)(model)) {
-        // NOTE: We add `toBrandedType` functions for foreign models for decoders.
-        if (field.relationToModel.typeName === model.typeName) {
-            continue;
-        }
-        const refModelMeta = (0, meta_1.getModelMetadata)({ model: field.relationToModel });
-        imports.addImport({
-            from: refModelMeta.types.importPath,
-            items: [refModelMeta.types.toBrandedIdTypeFnName],
-        });
-    }
-    const cloneFn = generateCloneFn({ model, meta, imports });
-    return /* ts */ `
-    import { Inject, Injectable, forwardRef } from '@nestjs/common'
-    import { z } from 'zod'
-
-    ${imports.generate()}
-
-    import { TRPCError } from '@trpc/server'
-
-    export type Scope = "${meta.actions.actionScopeConstType}"
-
-    export type Actions = {
-      ${(0, jsdoc_1.toJsDocComment)([`Creates a new ${meta.userFriendlyName} and returns it.`])}
-      create: {
-        payload: CreatePayload
-        result: ${types.typeName}
-      }
-
-      ${(0, jsdoc_1.toJsDocComment)([`Updates a ${meta.userFriendlyName} and returns it.`])}
-      update: {
-        payload: UpdatePayload
-        result: ${types.typeName}
-      }
-
-      ${(0, jsdoc_1.toJsDocComment)([`Creates or updates a ${meta.userFriendlyName} and returns it.`])}
-      upsert: {
-        payload: UpsertPayload
-        result: ${types.typeName}
-      }
-
-      ${(0, jsdoc_1.toJsDocComment)([`Deletes a ${meta.userFriendlyName} and returns its id.`])}
-      delete: {
-        payload: ${model.brandedIdType}
-        result: ${model.brandedIdType}
-      }
-    }
-
-    /**
-     * Zod decoder for validating the create input of a ${meta.userFriendlyName}.
-     */
-    export const ${meta.update.createInputDecoder} = z.object({
-      ${model.fields
-        .filter((f) => !f.attributes.isReadonly)
-        .map((f) => `${f.name}: z.${(0, zod_1.getZodDecoderDefinition)({ field: f })}`)
-        .join(',')}
-    })
-
-    type CreatePayload = z.infer<typeof ${meta.update.createInputDecoder}>
-
-    /**
-     * Zod decoder for validating the update input of a ${meta.userFriendlyName} .
-     */
-    export const ${meta.update.updateInputDecoder} = z.object({
-      ${model.fields
-        .filter((f) => !f.attributes.isReadonly || f.kind === 'id')
-        .map((f) => `${f.name}: z.${(0, zod_1.getZodDecoderDefinition)({ field: f, allowAnyOptionalField: f.kind !== 'id' })}`)
-        .join(',')}
-    })
-
-    type UpdatePayload = z.infer<typeof ${meta.update.updateInputDecoder}>
-
-    /**
-     * Zod decoder for validating the upsert input of a ${meta.userFriendlyName} .
-     */
-    export const ${meta.update.upsertInputDecoder} = z.union([
-      ${meta.update.updateInputDecoder}, 
-      ${meta.update.createInputDecoder}
-    ])
-    
-    type UpsertPayload = z.infer<typeof ${meta.update.upsertInputDecoder}>
-
-    export type ${update.serviceInterfaceName} = ${schemaMeta.actions.dispatcher.definition}<Actions>
-
-    @Injectable()
-    export class ${update.serviceClassName} implements ${update.serviceInterfaceName} {
-
-      /**
-       * Instance of the ${meta.userFriendlyName} view service for convenience.
-       */
-      private view: ${view.serviceClassName}
-
-      constructor(
-        private readonly data: ${data.repository.className},
-        
-        @Inject(forwardRef(() => ${schemaMeta.update.serviceClassName})) 
-          private readonly updateService: ${schemaMeta.update.serviceClassName},
-
-        @Inject(forwardRef(() => ${schemaMeta.view.serviceClassName})) 
-          private readonly viewService: ${schemaMeta.view.serviceClassName}
-      ) {
-        this.view = this.viewService.${view.serviceVariableName}
-      }
-
-      ${(0, jsdoc_1.toJsDocComment)([`Creates a new ${meta.userFriendlyName} and returns it.`])}
-      public async create({ data, execution }: { 
-        data: CreatePayload; 
-        execution: ${schemaMeta.actions.execution.interface}
-      }): Promise<${types.typeName}> {
-        // NOTE: User from execution.user should be authorized to create this item.
-        // eslint-disable-next-line no-constant-condition
-        if (false) {
-          throw new TRPCError({
-            code: 'UNAUTHORIZED',
-            message: \`You are not authorized to create a ${meta.userFriendlyName}\`,
-          })
-        }
-
-        return this.data.create({ item: data, execution })
-      }
-
-      ${(0, jsdoc_1.toJsDocComment)([`Updates a ${meta.userFriendlyName} and returns it.`])}
-      public async update({ data, execution }: { 
-        data: UpdatePayload; 
-        execution: ${schemaMeta.actions.execution.interface}
-      }): Promise<${types.typeName}> {
-        // NOTE: We need to make sure that the user is authorized to access the item
-        await this.authorize(data.id, execution.user)
-
-        return this.data.update({ item: data, execution })
-      }
-
-      ${(0, jsdoc_1.toJsDocComment)([`Creates or updates a ${meta.userFriendlyName} and returns it.`])}
-      public async upsert({ data, execution }: {
-        data: UpsertPayload;
-        execution: ${schemaMeta.actions.execution.interface}
-      }): Promise<${types.typeName}> {
-        if ('id' in data) {
-          await this.authorize(data.id, execution.user)
-        } else {
-          // eslint-disable-next-line no-constant-condition
-          if (false) {
-            throw new TRPCError({
-              code: 'UNAUTHORIZED',
-              message: \`You are not authorized to create a ${meta.userFriendlyName}\`,
-            })
-          }
-        }
-
-        return this.data.upsert({ item: data, execution })
-      }
-
-      ${(0, jsdoc_1.toJsDocComment)([`Deletes a ${meta.userFriendlyName} instance and returns its id.`])}
-      public async delete({ data, execution }: { 
-        data: ${model.brandedIdType}; 
-        execution: ${schemaMeta.actions.execution.interface}
-      }): Promise<${model.brandedIdType}> {
-        // NOTE: We need to make sure that the user is authorized to access the item
-        await this.authorize(data, execution.user)
-
-        return this.data.delete({ id: data, execution })
-      }
-
-      ${cloneFn}
-
-      /**
-      * Authorizes access to ${meta.userFriendlyName}.
-      */
-      public async authorize(id: ${model.brandedIdType}, user: User): Promise<void> {
-        // NOTE: Root user is always authorized.
-        if (this.viewService.users.data.rootUser.id === user.id) {
-          return
-        }
-        const item = await this.data.get(id)
-        if (!item) {
-          throw new Error(\`${meta.userFriendlyName} with id \${id} not found\`)
-        }
-        // eslint-disable-next-line no-constant-condition
-        if (false) {
-          throw new TRPCError({
-            code: 'UNAUTHORIZED',
-            message: \`You are not authorized to access ${meta.userFriendlyName} with id \${id}\`,
-          })
-        }
-      }
-    }
- `;
-}
-exports.generateModelBusinessLogicUpdate = generateModelBusinessLogicUpdate;
-function generateCloneFn({ model, meta, imports }) {
-    const schemaMeta = (0, meta_1.getSchemaMetadata)({ config: model.schemaConfig });
-    for (const enumField of (0, fields_1.getEnumFields)(model)) {
-        const enumMeta = (0, meta_1.getEnumMetadata)(enumField);
-        imports.addTypeImport({
-            from: enumMeta.types.importPath,
-            items: [enumField.typeName],
-        });
-    }
-    const fnInputFields = model.fields
-        .filter((f) => {
-        switch (f.kind) {
-            case 'id':
-            case 'scalar':
-            case 'enum':
-                return true;
-            case 'relation':
-                return false;
-            default:
-                throw new types_2.ExhaustiveSwitchCheck(f);
-        }
-    })
-        .map((f) => {
-        const type = (0, typescript_1.getFieldType)(f);
-        switch (f.kind) {
-            case 'id':
-                return `${f.name}: ${type}`;
-            case 'scalar':
-            case 'enum':
-                if (f.isUnique) {
-                    // NOTE: `unique` fields require a new value.
-                    if (f.isRequired) {
-                        return `${f.name}: ${type}`;
-                    }
-                    return `${f.name}: ${type} | null`;
-                }
-                // NOTE: Non-unique fields can be copied from the source.
-                if (f.isRequired) {
-                    return `${f.name}?: ${type}`;
-                }
-                return `${f.name}?: ${type} | null`;
-            case 'relation':
-                (0, assert_1.default)(false);
-                break;
-            default:
-                throw new types_2.ExhaustiveSwitchCheck(f);
-        }
-    });
-    const foreignKeyMappings = (0, fields_1.getRelationFields)(model).map((f) => {
-        if (f.isRequired) {
-            return `${f.name}: mappings.get({ model: '${f.relationToModel.typeName}', id: item.${f.name} })`;
-        }
-        return `${f.name}: item.${f.name} ? mappings.get({ model: '${f.relationToModel.typeName}', id: item.${f.name} }) : null`;
-    });
-    if (foreignKeyMappings.length > 0) {
-        imports.addImports({
-            [schemaMeta.types.importPath]: [schemaMeta.types.idTypesIndex],
-            [(0, types_1.toPackageName)('@postxl/runtime')]: [(0, types_1.toClassName)('TypedMapping')],
-        });
-    }
-    return `
-  ${(0, jsdoc_1.toJsDocComment)([`Clones a ${meta.userFriendlyName} with mapped foreign ids.`])}
-  public async clone(
-    { data, execution }: {
-      data: { ${fnInputFields.join('; ')} },
-      execution: ${schemaMeta.actions.execution.interface}
-    },
-    ${foreignKeyMappings.length > 0 ? `mappings = new TypedMapping<${schemaMeta.types.idTypesIndex}>()` : ''}
-  ): Promise<${meta.types.typeName}> {
-    const clone = await this.data.clone({
-      id: data.id,
-      item: (${foreignKeyMappings.length > 0 ? 'item' : ''}) => ({
-        ...data,
-        ${foreignKeyMappings.join(',\n')}
-      }),
-      execution
-    })
-
-    return clone
-  }
-  `;
-}

package/dist/generators/models/view/service.generator.d.ts

@@ -1,10 +0,0 @@
-import { ModelMetaData } from '../../../lib/meta';
-import { Model } from '../../../lib/schema/schema';
-/**
- * Generates view business logic for a given model.
- * The view  logic exposes all information and links of a model. See template's readme for more info.
- */
-export declare function generateModelBusinessLogicView({ model, meta }: {
-    model: Model;
-    meta: ModelMetaData;
-}): string;

package/dist/generators/models/view/service.generator.js

@@ -1,239 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateModelBusinessLogicView = void 0;
-const imports_1 = require("../../../lib/imports");
-const meta_1 = require("../../../lib/meta");
-const fields_1 = require("../../../lib/schema/fields");
-const types_1 = require("../../../lib/schema/types");
-const ast_1 = require("../../../lib/utils/ast");
-/**
- * Generates view business logic for a given model.
- * The view  logic exposes all information and links of a model. See template's readme for more info.
- */
-function generateModelBusinessLogicView({ model, meta }) {
-    const schemaMeta = (0, meta_1.getSchemaMetadata)({ config: model.schemaConfig });
-    const imports = imports_1.ImportsGenerator.from(meta.view.serviceLocation.path);
-    imports.addImports({
-        [meta.data.repository.location.import]: meta.data.repository.className,
-        [meta.types.importPath]: [
-            (0, types_1.toAnnotatedTypeName)(model.brandedIdType),
-            (0, types_1.toAnnotatedTypeName)(meta.types.typeName),
-            (0, types_1.toAnnotatedTypeName)((0, types_1.toTypeName)('User')),
-        ],
-        [schemaMeta.view.serviceLocation.path]: schemaMeta.view.serviceClassName,
-    });
-    const compareFnBlock = (0, ast_1.createSwitchStatement)({
-        field: 'field',
-        cases: (0, fields_1.getScalarFields)({ fields: model.fields, tsTypeName: 'string' }).map((f) => ({
-            match: `"${f.name}"`,
-            block: `return (a[field] || '').localeCompare(b[field] || '')`,
-        })),
-        defaultBlock: 'return 0',
-    });
-    const stringFieldFilters = (0, fields_1.getScalarFields)({ fields: model.fields, tsTypeName: 'string' }).map((f) => {
-        return {
-            match: `"${f.name}"`,
-            block: `
-        if (typeof value !== 'string') {
-          return false
-        }
-
-        switch (operator) {
-          case 'contains': {
-            return (item[field] || '').toLowerCase().includes(value.toLowerCase())
-          }
-          default: {
-            return false
-          }
-        }
-      `,
-        };
-    });
-    const numberFieldsFilters = (0, fields_1.getScalarFields)({ fields: model.fields, tsTypeName: 'number' }).map((f) => {
-        return {
-            match: `"${f.name}"`,
-            block: `
-        const toCompare = item[field]
-        if (typeof value !== 'number' || toCompare === null) {
-          return false
-        }
-
-        switch (operator) {
-          case 'eq': {
-            return item[field] === value
-          }
-          case 'gt': {
-            return toCompare > value
-          }
-          case 'lt': {
-            return toCompare < value
-          }
-          default: {
-            return false
-          }
-        }
-      `,
-        };
-    });
-    const filterFnBlock = (0, ast_1.createSwitchStatement)({
-        field: 'field',
-        cases: [...stringFieldFilters, ...numberFieldsFilters],
-        defaultBlock: 'return false',
-    });
-    return /* ts */ `
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import z from 'zod'
-
-import { Inject, Injectable, forwardRef } from '@nestjs/common'
-
-${imports.generate()}
-
-import { TRPCError } from '@trpc/server'
-
-
-/**
- * Cursor decoder.
- */
-export const ${meta.view.cursorDecoder} = z.object({ startRow: z.number(), endRow: z.number() })
-
-type Cursor = z.infer<typeof ${meta.view.cursorDecoder}>
-
-/**
- * Filter operator decoder.
- */
-export const ${meta.view.filterOperatorDecoder} = z.enum([
-  'eq',
-  'neq',
-  'gt',
-  'gte',
-  'lt',
-  'lte',
-  'in',
-  'nin',
-  'contains',
-  'ncontains',
-  'starts',
-  'ends',
-])
-
-type FilterOperator = z.infer<typeof ${meta.view.filterOperatorDecoder}>
-
-@Injectable()
-export class ${meta.view.serviceClassName} {
-  constructor(
-    public readonly data: ${meta.data.repository.className},
-    @Inject(forwardRef(() => ${schemaMeta.view.serviceClassName})) 
-        private readonly viewService: ${schemaMeta.view.serviceClassName}
-  ) {}
-
-  /**
-   * Returns the raw ${meta.userFriendlyName} with the given id or null if it does not exist.
-   * Raw: The ${meta.userFriendlyName} only contains linked Ids, not the linked items themselves.
-   */
-  public async get({ id, user }: { id: ${model.brandedIdType}, user: User }): Promise<${meta.types.typeName} | null> {
-    const item = await this.data.get(id)
-    if (!item) {
-      return null
-    }
-
-    // NOTE: Authorizing user to access the item.
-    await this.authorize({ item, user })
-
-    return item
-  }
-
-  /**
-   * Returns a map of all ${meta.userFriendlyNamePlural}.
-   */
-  public async getAll(user: User): Promise<Map<${meta.types.brandedIdType}, ${model.typeName}>> {
-        const result = await this.data.getAll()
-
-        // NOTE: Removing non-authorized items from the result.
-        for (const [key, value] of result.entries()) {
-          try {
-            await this.authorize({ item: value, user })
-          } catch (e) {
-            result.delete(key)
-          }
-        }
-    
-        return result
-  }
-
-  /**
-   * Returns a list of filtered, sorted and paginated ${meta.userFriendlyNamePlural}.
-   */
-  public async getList({
-    filter,
-    sort,
-    cursor,
-    user,
-  }: {
-    filter?: { field: keyof ${model.typeName}; operator: FilterOperator; value: string | number }
-    sort?: { field: keyof ${model.typeName}; ascending: boolean }
-    cursor?: Cursor
-    user: User,
-  },
-) {
-    const items = await this.data.getAll()
-
-    // NOTE: Removing non-authorized items from the result.
-    for (const [key, value] of items.entries()) {
-      try {
-        await this.authorize({ item: value, user })
-      } catch (e) {
-        items.delete(key)
-      }
-    }
-    const authorized = [...items.values()]
-
-    const filtered = !filter
-      ? authorized
-      : authorized.filter((item) => filterFn(item, filter.field, filter.operator, filter.value))
-
-    const filteredAndSorted = !sort
-      ? filtered
-      : filtered.sort((a, b) => (sort.ascending ? compare(a, b, sort.field) : -compare(a, b, sort.field)))
-
-    const paginated = !cursor ? filteredAndSorted : filteredAndSorted.slice(cursor.startRow, cursor.endRow)
-    return { rows: paginated, count: authorized.length }
-  }
-
-  /**
-  * Authorizes access to ${meta.userFriendlyName}.
-  */
-  // eslint-disable-next-line @typescript-eslint/require-await
-  public async authorize({ item, user}: { item: ${model.typeName}, user: User }): Promise<void> {
-    // eslint-disable-next-line no-constant-condition
-    if (false) {
-      throw new TRPCError({
-        code: 'UNAUTHORIZED',
-        message: \`You are not authorized to access ${meta.userFriendlyName} with id \${item.id}\`,
-      })
-    }
-  }
-}
-
-// Utility Functions
-
-/**
- * Compares two ${model.typeName} instances by the given field.
- */
-function compare(a: ${model.typeName}, b: ${model.typeName}, field: keyof ${model.typeName}) {
-  ${compareFnBlock}
-}
-
-/**
- * Filters the given ${model.typeName} by the given field, using provided operator and value.
- */
-function filterFn(
-  item: ${model.typeName}, 
-  field: keyof ${model.typeName}, 
-  operator: FilterOperator, 
-  value: string | number
-): boolean {
-  ${filterFnBlock}
-}
-`;
-}
-exports.generateModelBusinessLogicView = generateModelBusinessLogicView;

package/dist/lib/attributes.d.ts

@@ -1,114 +0,0 @@
-export type AttributeValue = unknown;
-export type Attributes = Record<string, AttributeValue>;
-export type ModelAttributes = {
-    /**
-     * Schema tag: ´@@Ignore()`
-     */
-    ignore: boolean;
-    /**
-     * Schema tag: ´@@Description("Description of the model")`
-     */
-    description?: string;
-    /**
-     * Schema tag: ´@@Schema("Configuration")`
-     * The database schema that the model belongs to.
-     * @internal
-     * Note: Prisma has it's own schema attribute - but does not expose it in the DMMF.
-     */
-    databaseSchema: string;
-    /**
-     * Schema tag: ´@@Index()`
-     * Creates an index on the given fields.
-     */
-    index?: string[];
-    /**
-     * Schema tag: ´@@Seed()`
-     * Seed to use for random generation.
-     */
-    randomSeed?: number;
-    /**
-     * Schema tag: ´@@SystemUser()`
-     * The user that is used for system actions.
-     */
-    systemUser?: object;
-};
-export type FieldAttributes = {
-    /**
-     * Schema tag: ´@@Ignore()`
-     *
-     * Field will be ignored by the generator and not be exposed from the database.
-     */
-    ignore: boolean;
-    /**
-     * Schema tag: ´@@Readonly()`
-     *
-     * Field is generated by the database and shall not be edited by the user. It is readable though.
-     */
-    isReadonly: boolean;
-    /**
-     * Derived from Prisma's @updatedAt attribute.
-     *
-     * Field represents the last time the record was updated.
-     */
-    isUpdatedAt: boolean;
-    /**
-     * Automatically set is field name is "createdAt".
-     * Field represents the time the record was created.
-     */
-    isCreatedAt: boolean;
-    /**
-     * Schema tag: ´@@Description("Description of the field")`
-     *
-     * The description that is generated as a JSDoc comment in the code.
-     */
-    description?: string;
-    /**
-     * Schema tag: ´@@Examples("Example1", "Example2")` or `@@Example("Example1")`
-     *
-     * Examples that are generated as a JSDoc comment in the code and used as seed/test data.
-     */
-    examples?: (string | number | boolean | null)[];
-    /**
-     * Schema tag: ´@@DefaultField()`
-     * The property of the model that identifies the default row.
-     *
-     * If this is set, the repository will verify that exactly one record has this field set to true - and use it as the default record.
-     */
-    isDefaultField?: boolean;
-    /**
-     * Schema tag: `@@MaxLength(int)`
-     * The maximum length of a string.
-     */
-    maxLength?: number;
-    /**
-     * Schema tag: `@@IsNameField()`
-     * The field that should be used as the default label for the model.
-     *
-     * If this is set, the repository will verify that exactly one record has this field set to true - and use it as the default label.
-     *
-     * If this attribute is set, this field will be used in the code/UI as the field that specifies the model's name. If not provided, we check for the existence of the`name` field. If that is not found, we use the `id` field as the name field.
-     */
-    isNameField?: boolean;
-    /**
-     * Schema tag: `@@Label("Label")`
-     * The human readable label/name of the field.
-     *
-     * If not provided, we use the field name.
-     */
-    label: string;
-};
-export type EnumAttributes = {
-    /**
-     * The description of the enum.
-     * Schema tag: ´@@Description("Description of the model")`
-     */
-    description?: string;
-    /**
-     * A dictionary of value descriptions.
-     *
-     * Note: Unfortunately, the DMMF does not support attributes for Enum values. So we use an attribute on the enum itself to define the descriptions.
-     *
-     * Schema tag: ´@@Schema("ValueDescription")`
-     */
-    valueDescription?: Record<string, string>;
-};

package/dist/lib/attributes.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });