@flusys/nestjs-entity-builder 9.1.2 → 9.2.1

package/fesm/897.js

@@ -9,18 +9,12 @@ export const __rspack_esm_ids = [897];
 export const __webpack_modules__ = {
 6576(__unused_rspack_module, __webpack_exports__, __webpack_require__) {
 const ENTITY_BUILDER_MODULE_OPTIONS = 'ENTITY_BUILDER_MODULE_OPTIONS';
-/**
- * Largest bundle file plan-import / apply-import accept. The bundle is uploaded as a file, so the app's
- * JSON body limit (Express's 100kb default) never applies to it and the app needs no setup for it.
- */ const ENTITY_BUNDLE_MAX_BYTES = 20 * 1024 * 1024;
-/** A name `${var:NAME}` can carry; any other name could never be resolved on import. */ const BUNDLE_VARIABLE_NAME_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*$/;
-/**
- * Identifier whitelist enforced on every EntityDefinition/FieldDefinition `code`.
- * Also the exact contract SchemaSyncService's DDL engine validates against
- * before generating a table/column name.
- */ const ENTITY_CODE_PATTERN = /^[a-z][a-z0-9_]{2,59}$/;
-/** Matches the `code` column length on both EntityDefinition and FieldDefinition. */ const ENTITY_CODE_MAX_LENGTH = 63;
-/** Defense-in-depth prefix applied to every dynamically created table name. */ const ENTITY_TABLE_PREFIX = 'eb_';
+/** The bundle is uploaded as a file, so the app's JSON body limit (Express's 100kb default) never applies to it - this does. */ const ENTITY_BUNDLE_MAX_BYTES = 20 * 1024 * 1024;
+/** A split export writes one file per entity and per flow; together they stay under ENTITY_BUNDLE_MAX_BYTES. */ const ENTITY_BUNDLE_MAX_FILES = 1000;
+/** Any other `${var:NAME}` name could never be resolved on import. */ const BUNDLE_VARIABLE_NAME_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*$/;
+/** Every entity and field `code`; the DDL engine checks the same pattern before it names a table or column. */ const ENTITY_CODE_PATTERN = /^[a-z][a-z0-9_]{2,59}$/;
+const ENTITY_CODE_MAX_LENGTH = 63;
+const ENTITY_TABLE_PREFIX = 'eb_';
 /** The generic API controller's record endpoints - each can be created as a ready-made flow with the entity. */ const ENTITY_FLOW_ENDPOINTS = [
     'insert',
     'insertMany',
@@ -156,11 +150,7 @@ _ts_decorate([
     (0,class_validator__rspack_import_3.IsNotEmpty)(),
     _ts_metadata("design:type", String)
 ], UpdateEntityDefinitionDto.prototype, "id", void 0);
-/**
- * One initial field spec passed alongside entity creation - identical to
- * CreateFieldDefinitionDto but without entityDefinitionId, which does not
- * exist yet until SchemaSyncService.createEntity assigns it.
- */ class EntityFieldSpecDto extends (0,_nestjs_swagger__rspack_import_1.OmitType)(_field_definition_dto_js__rspack_import_4/* .CreateFieldDefinitionDto */.Vj, [
+/** A field created with its entity (or by add_field): the entity id comes from the request, not the field. */ class EntityFieldSpecDto extends (0,_nestjs_swagger__rspack_import_1.OmitType)(_field_definition_dto_js__rspack_import_4/* .CreateFieldDefinitionDto */.Vj, [
     'entityDefinitionId'
 ]) {
 }
@@ -269,8 +259,6 @@ _ts_decorate([
 ], EntityFlowNamesDto.prototype, "delete", void 0);
 /** Labels of the inputs the endpoints add besides the entity fields. */ class EntityFlowInputLabelsDto {
     id;
-    ids;
-    search;
 }
 _ts_decorate([
     (0,_nestjs_swagger__rspack_import_1.ApiPropertyOptional)({
@@ -281,24 +269,6 @@ _ts_decorate([
     (0,class_validator__rspack_import_3.MaxLength)(FLOW_TEXT_MAX_LENGTH),
     _ts_metadata("design:type", String)
 ], EntityFlowInputLabelsDto.prototype, "id", void 0);
-_ts_decorate([
-    (0,_nestjs_swagger__rspack_import_1.ApiPropertyOptional)({
-        example: 'Ids'
-    }),
-    (0,class_validator__rspack_import_3.IsString)(),
-    (0,class_validator__rspack_import_3.IsOptional)(),
-    (0,class_validator__rspack_import_3.MaxLength)(FLOW_TEXT_MAX_LENGTH),
-    _ts_metadata("design:type", String)
-], EntityFlowInputLabelsDto.prototype, "ids", void 0);
-_ts_decorate([
-    (0,_nestjs_swagger__rspack_import_1.ApiPropertyOptional)({
-        example: 'Search'
-    }),
-    (0,class_validator__rspack_import_3.IsString)(),
-    (0,class_validator__rspack_import_3.IsOptional)(),
-    (0,class_validator__rspack_import_3.MaxLength)(FLOW_TEXT_MAX_LENGTH),
-    _ts_metadata("design:type", String)
-], EntityFlowInputLabelsDto.prototype, "search", void 0);
 /**
  * Text written into the entity's flow, sent by the designer in the creator's language so the
  * saved flow reads like one the user wrote. Anything left out falls back to English.
@@ -306,6 +276,7 @@ _ts_decorate([
     names;
     inputLabels;
     noMatchMessage;
+    deleteOnlyMessage;
 }
 _ts_decorate([
     (0,_nestjs_swagger__rspack_import_1.ApiPropertyOptional)({
@@ -335,12 +306,17 @@ _ts_decorate([
     (0,class_validator__rspack_import_3.MaxLength)(255),
     _ts_metadata("design:type", String)
 ], EntityFlowTextsDto.prototype, "noMatchMessage", void 0);
-/**
- * Creates a dynamic entity and its initial table in one DDL transaction.
- * Consumed by SchemaSyncService.createEntity, not by the generic ApiController
- * insert endpoint (which is disabled for EntityDefinitionController - metadata
- * rows must never be created without a matching real table).
- */ class CreateDynamicEntityDto extends CreateEntityDefinitionDto {
+_ts_decorate([
+    (0,_nestjs_swagger__rspack_import_1.ApiPropertyOptional)({
+        description: 'Message of the 400 answer of the delete endpoint for a restore or permanent delete',
+        example: 'Only delete is supported.'
+    }),
+    (0,class_validator__rspack_import_3.IsString)(),
+    (0,class_validator__rspack_import_3.IsOptional)(),
+    (0,class_validator__rspack_import_3.MaxLength)(255),
+    _ts_metadata("design:type", String)
+], EntityFlowTextsDto.prototype, "deleteOnlyMessage", void 0);
+/** create-entity: the entity, its table and initial fields in one DDL transaction (the generic insert is disabled). */ class CreateDynamicEntityDto extends CreateEntityDefinitionDto {
     fields;
     flowEndpoints;
     flowTexts;
@@ -606,6 +582,7 @@ _ts_decorate([
     (0,_nestjs_swagger__rspack_import_1.ApiPropertyOptional)({
         description: 'Options for SINGLE_SELECT/MULTI_SELECT fields'
     }),
+    (0,class_validator__rspack_import_3.IsArray)(),
     (0,class_validator__rspack_import_3.IsOptional)(),
     _ts_metadata("design:type", Array)
 ], CreateFieldDefinitionDto.prototype, "selectOptions", void 0);
@@ -1181,6 +1158,41 @@ const FLOW_NODE_TYPES = [
     'object',
     'list'
 ];
+/**
+ * Which API controller endpoint a Request step stands in for. It fixes the body shape (a list for the
+ * `*_many` / `bulk_upsert` ones) and adds that endpoint's own fields ahead of the designer's: get_all takes
+ * `FilterAndPaginationDto` (`filter`, `pagination`, `sort`, `select`, `withDeleted`; search arrives as `?q=`),
+ * get_by_id `{ id, select }`, get_by_ids `{ ids, select }`, update / update_many an `id`, delete `DeleteDto`
+ * (`id`: one id or a list, read as a list; `type`). custom (default): only the declared body and fields.
+ */ const FLOW_REQUEST_CONTRACTS = [
+    'custom',
+    'get_all',
+    'get_by_id',
+    'get_by_ids',
+    'get_by_filter',
+    'insert',
+    'insert_many',
+    'update',
+    'update_many',
+    'bulk_upsert',
+    'delete'
+];
+const LIST_BODY_CONTRACTS = new Set([
+    'insert_many',
+    'update_many',
+    'bulk_upsert'
+]);
+/**
+ * The shape a Respond step answers in. raw (default): the body exactly as built. The others are the API
+ * controller envelope `{ success, message, messageKey, messageVariables?, data?, meta? }`: single (`data`
+ * one value), list (`data` a list, `meta` paging), bulk (`data` a list, `meta` counts), message (no data).
+ */ const FLOW_RESPONSE_FORMATS = [
+    'raw',
+    'single',
+    'list',
+    'bulk',
+    'message'
+];
 const FLOW_INPUT_TYPES = [
     'string',
     'text',
@@ -1276,6 +1288,7 @@ const FLOW_LIMITS = {
     MAX_EMAIL_TEMPLATE_SLUG_LENGTH: 255,
     MAX_HTTP_TIMEOUT_MS: 15_000,
     MAX_HTTP_RESPONSE_BYTES: 1_000_000,
+    DEFAULT_QUERY_LIMIT: 50,
     MAX_QUERY_LIMIT: 200,
     MAX_WRITE_ITEMS: 1000,
     DEFAULT_WRITE_FILTER_LIMIT: 100,
@@ -1294,8 +1307,7 @@ const FLOW_LIMITS = {
     DEFAULT_CODE_TIMEOUT_MS: 1000,
     MIN_CODE_TIMEOUT_MS: 10,
     MAX_CODE_TIMEOUT_MS: 5000,
-    CODE_MEMORY_LIMIT_BYTES: 32 * 1024 * 1024,
-    CODE_STACK_SIZE_BYTES: 512 * 1024,
+    /** Heap plus buffers of the worker a code step runs on, packages it loaded included. */ CODE_MEMORY_LIMIT_BYTES: 128 * 1024 * 1024,
     MAX_CODE_OUTPUT_BYTES: 1_000_000,
     MAX_CODE_LOG_LINES: 50,
     MAX_CODE_LOG_LINE_CHARS: 500
@@ -1305,6 +1317,119 @@ const FLOW_SLUG_PATTERN = /^[a-z][a-z0-9-]{2,62}$/;
 const FLOW_INPUT_NAME_PATTERN = /^[A-Za-z][A-Za-z0-9_]{0,59}$/;
 const FLOW_ENDPOINT_PATH_PATTERN = /^[a-z][a-z0-9-]{0,62}$/;
 /** A record, user or company id. */ const FLOW_ID_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
+const SELECT_FIELD = {
+    name: 'select',
+    type: 'array',
+    itemType: 'string',
+    maxLength: 64
+};
+/** The fields an API controller endpoint's DTO takes, checked ahead of the designer's own. */ function contractFields(contract) {
+    switch(contract){
+        case 'get_all':
+            return [
+                {
+                    name: 'filter',
+                    type: 'object'
+                },
+                {
+                    name: 'pagination',
+                    type: 'object',
+                    fields: [
+                        {
+                            name: 'currentPage',
+                            type: 'integer',
+                            required: true,
+                            default: 0,
+                            min: 0
+                        },
+                        {
+                            name: 'pageSize',
+                            type: 'integer',
+                            required: true,
+                            default: 10,
+                            min: 1,
+                            max: FLOW_LIMITS.MAX_QUERY_LIMIT
+                        }
+                    ]
+                },
+                {
+                    name: 'sort',
+                    type: 'object'
+                },
+                SELECT_FIELD,
+                {
+                    name: 'withDeleted',
+                    type: 'boolean'
+                }
+            ];
+        case 'get_by_id':
+            return [
+                {
+                    name: 'id',
+                    type: 'uuid',
+                    required: true
+                },
+                SELECT_FIELD
+            ];
+        case 'get_by_ids':
+            return [
+                {
+                    name: 'ids',
+                    type: 'array',
+                    itemType: 'uuid',
+                    required: true
+                },
+                SELECT_FIELD
+            ];
+        case 'update':
+        case 'update_many':
+            return [
+                {
+                    name: 'id',
+                    type: 'uuid',
+                    required: true
+                }
+            ];
+        case 'delete':
+            return [
+                {
+                    name: 'id',
+                    type: 'array',
+                    itemType: 'uuid',
+                    required: true
+                },
+                {
+                    name: 'type',
+                    type: 'choice',
+                    options: [
+                        'delete',
+                        'restore',
+                        'permanent'
+                    ],
+                    required: true
+                }
+            ];
+        default:
+            return [];
+    }
+}
+/** A Request step's contract; an unknown one reads as custom, which the validator refuses on save. */ function triggerContract(config) {
+    return config.contract && FLOW_REQUEST_CONTRACTS.includes(config.contract) ? config.contract : 'custom';
+}
+/** The body a Request step takes: the contract's, or for custom the declared one. */ function endpointBody(config) {
+    const contract = triggerContract(config);
+    const declared = Array.isArray(config.inputSchema) ? config.inputSchema : [];
+    const own = contractFields(contract);
+    const taken = new Set(own.map((f)=>f.name));
+    return {
+        contract,
+        bodyType: contract === 'custom' ? config.bodyType ?? 'object' : LIST_BODY_CONTRACTS.has(contract) ? 'list' : 'object',
+        inputSchema: [
+            ...own,
+            ...declared.filter((f)=>!taken.has(f?.name))
+        ]
+    };
+}
 /** Who may start a run at a Request step; an unknown mode reads as the default, which the validator refuses on save. */ function endpointAuth(config) {
     const authMode = config.authMode && FLOW_AUTH_MODES.includes(config.authMode) ? config.authMode : DEFAULT_AUTH_MODE;
     return {
@@ -1327,8 +1452,7 @@ const FLOW_ENDPOINT_PATH_PATTERN = /^[a-z][a-z0-9-]{0,62}$/;
         return {
             nodeId: node.id,
             path,
-            bodyType: config.bodyType ?? 'object',
-            inputSchema: Array.isArray(config.inputSchema) ? config.inputSchema : [],
+            ...endpointBody(config),
             ...endpointAuth(config),
             isTransactional: config.isTransactional === true,
             timeoutMs: config.timeoutMs ?? FLOW_LIMITS.DEFAULT_TIMEOUT_MS,
@@ -1389,11 +1513,14 @@ const FLOW_ENDPOINT_PATH_PATTERN = /^[a-z][a-z0-9-]{0,62}$/;
 __webpack_require__.d(__webpack_exports__, {
   IE: () => (startEndpoint),
   Xr: () => (flowEndpoints),
+  _h: () => (contractFields),
   a5: () => (portsOf),
   um: () => (triggerPath),
+  v7: () => (triggerContract),
   vS: () => (findEndpoint),
   xA: () => (isStoredApiKey)
 }, {
+  A4: FLOW_RESPONSE_FORMATS,
   At: NON_CONTINUABLE_NODE_TYPES,
   B9: FLOW_EMAIL_TARGETS,
   Dn: RECORD_WRITE_TARGETS,
@@ -1415,6 +1542,7 @@ __webpack_require__.d(__webpack_exports__, {
   fP: isFunctionFlow,
   fZ: FLOW_INPUT_NAME_PATTERN,
   iM: FLOW_ACCESS_SUBJECTS,
+  j_: FLOW_REQUEST_CONTRACTS,
   q2: FLOW_NODE_TYPES,
   sk: FLOW_BRANCH_COMPANIES,
   v1: FLOW_EMAIL_MODES,
@@ -1439,6 +1567,7 @@ __webpack_require__.d(__webpack_exports__, {
     'updated_by_id',
     'deleted_by_id'
 ];
+/** A RELATION field is indexed unless the request says otherwise: child lists, parent-id filters and lookups all read by it. */ const indexedByDefault = (spec)=>spec.isIndexed ?? spec.fieldType === _enums_field_type_enum_js__rspack_import_2/* .FieldType.RELATION */.P.RELATION;
 /** Field types stored as unbounded text or JSON: an index or unique constraint on them fails (MySQL) or breaks on large values (PostgreSQL). */ const NON_INDEXABLE_FIELD_TYPES = [
     _enums_field_type_enum_js__rspack_import_2/* .FieldType.LONG_TEXT */.P.LONG_TEXT,
     _enums_field_type_enum_js__rspack_import_2/* .FieldType.JSON */.P.JSON,
@@ -1506,12 +1635,17 @@ const NAME_HASH_LENGTH = 8;
     const room = maxLength - prefix.length - hash.length - 2;
     return `${prefix}_${`${table}_${column}`.slice(0, room)}_${hash}`;
 }
-const plainIndex = (table, column, driver, adapter)=>new typeorm__rspack_import_1.TableIndex({
+/** The predicate of a plain index over live rows only (`performance.partialIndexes`, PostgreSQL). */ const LIVE_ROWS_WHERE = '"deleted_at" IS NULL';
+/** `liveOnly` (PostgreSQL only - MySQL has no partial indexes): the index covers rows that are not soft-deleted. */ const plainIndex = (table, column, driver, adapter, liveOnly = false)=>new typeorm__rspack_import_1.TableIndex({
         name: indexName('idx', table, column, adapter.maxIdentifierLength(driver)),
         columnNames: [
             column
-        ]
+        ],
+        ...liveOnly && driver === 'postgres' ? {
+            where: LIVE_ROWS_WHERE
+        } : {}
     });
+/** Whether an index read back from the database covers live rows only (PostgreSQL reports `(deleted_at IS NULL)`). */ const isLiveRowsIndex = (index)=>/^\(*"?deleted_at"?\s+IS\s+NULL\)*$/i.test((index.where ?? '').trim());
 const tableUnique = (table, column, driver, adapter)=>new typeorm__rspack_import_1.TableUnique({
         name: indexName('uq', table, column, adapter.maxIdentifierLength(driver)),
         columnNames: [
@@ -1589,11 +1723,13 @@ __webpack_require__.d(__webpack_exports__, {
   G7: sameColumns,
   HK: auditColumns,
   OG: softDeleteColumn,
+  YS: isLiveRowsIndex,
   d4: isIndexableFieldType,
-  gW: NON_INDEXABLE_FIELD_TYPES,
   mq: SYSTEM_COLUMN_NAMES,
   uy: tableUnique,
-  v7: plainIndex
+  v7: plainIndex,
+  vx: LIVE_ROWS_WHERE,
+  w5: indexedByDefault
 });