@msbci/form-server 1.2.0 → 1.3.1

package/dist/index.d.mts

@@ -1,6 +1,7 @@
 import { PrismaClient } from '../generated/prisma';
-import { z } from 'zod';
+import { IFormDefinition } from '@msbci/form-core';
 export { IFormDefinition, IFormPage, IFormRoster, IFormVariable } from '@msbci/form-core';
+import { z } from 'zod';
 
 /**
  * Auth middleware — injectable hook for the host application.
@@ -132,6 +133,7 @@ declare class FormService {
         pageSize: number;
         search?: string;
         tenantId?: string;
+        scopeId?: string;
     }): Promise<{
         items: ({
             formType: {
@@ -174,6 +176,11 @@ declare class FormService {
             createdAt: Date;
             updatedAt: Date;
         } | null;
+        scopes: {
+            order: number;
+            scopeId: string;
+            formId: string;
+        }[];
         pages: ({
             variables: {
                 id: string;
@@ -187,7 +194,9 @@ declare class FormService {
                 conditions: string | null;
                 options: string | null;
                 pageId: string | null;
+                templateOverrides: string | null;
                 type: string;
+                rosterId: string | null;
                 isRequired: boolean;
                 isReadonly: boolean;
                 isHidden: boolean;
@@ -198,7 +207,7 @@ declare class FormService {
                 dataSourceId: string | null;
                 dataSourceDependencies: string | null;
                 style: string | null;
-                rosterId: string | null;
+                templateId: string | null;
             }[];
             rosters: ({
                 variables: {
@@ -213,7 +222,9 @@ declare class FormService {
                     conditions: string | null;
                     options: string | null;
                     pageId: string | null;
+                    templateOverrides: string | null;
                     type: string;
+                    rosterId: string | null;
                     isRequired: boolean;
                     isReadonly: boolean;
                     isHidden: boolean;
@@ -224,7 +235,7 @@ declare class FormService {
                     dataSourceId: string | null;
                     dataSourceDependencies: string | null;
                     style: string | null;
-                    rosterId: string | null;
+                    templateId: string | null;
                 }[];
             } & {
                 id: string;
@@ -248,13 +259,13 @@ declare class FormService {
             createdAt: Date;
             updatedAt: Date;
             order: number;
+            formId: string;
             isRepeatable: boolean;
             repeatMinInstances: number | null;
             repeatMaxInstances: number | null;
             repeatControlVarCode: string | null;
             repeatInstanceLabel: string | null;
             conditions: string | null;
-            formId: string;
         })[];
     } & {
         id: string;
@@ -279,6 +290,7 @@ declare class FormService {
         isPublished?: boolean;
         tenantId?: string;
         formTypeId?: string;
+        scopeIds?: string[];
         metadata?: Record<string, unknown>;
     }, ctx?: IRequestContext): Promise<{
         id: string;
@@ -302,8 +314,15 @@ declare class FormService {
         version: string;
         isPublished: boolean;
         formTypeId: string;
+        scopeIds: string[];
         metadata: Record<string, unknown>;
-    }>, ctx?: IRequestContext): Promise<{
+    }>, ctx?: IRequestContext): Promise<({
+        scopes: {
+            order: number;
+            scopeId: string;
+            formId: string;
+        }[];
+    } & {
         id: string;
         code: string;
         name: string;
@@ -317,7 +336,14 @@ declare class FormService {
         formTypeId: string | null;
         createdBy: string | null;
         updatedBy: string | null;
-    }>;
+    }) | null>;
+    /**
+     * Load a form by id and return it as a fully-resolved `IFormDefinition`
+     * (templates applied — Option B). Used by `GET /forms/:id/resolved` and
+     * `exportForm`. The original DB-include shape is still available via
+     * {@link getFormDefinition}.
+     */
+    getResolvedFormDefinition(id: string): Promise<IFormDefinition>;
     deleteFormDefinition(id: string): Promise<{
         id: string;
         code: string;
@@ -352,13 +378,13 @@ declare class FormService {
         createdAt: Date;
         updatedAt: Date;
         order: number;
+        formId: string;
         isRepeatable: boolean;
         repeatMinInstances: number | null;
         repeatMaxInstances: number | null;
         repeatControlVarCode: string | null;
         repeatInstanceLabel: string | null;
         conditions: string | null;
-        formId: string;
     }>;
     updateFormPage(id: string, data: Partial<{
         code: string;
@@ -379,13 +405,13 @@ declare class FormService {
         createdAt: Date;
         updatedAt: Date;
         order: number;
+        formId: string;
         isRepeatable: boolean;
         repeatMinInstances: number | null;
         repeatMaxInstances: number | null;
         repeatControlVarCode: string | null;
         repeatInstanceLabel: string | null;
         conditions: string | null;
-        formId: string;
     }>;
     deleteFormPage(id: string): Promise<{
         id: string;
@@ -395,13 +421,13 @@ declare class FormService {
         createdAt: Date;
         updatedAt: Date;
         order: number;
+        formId: string;
         isRepeatable: boolean;
         repeatMinInstances: number | null;
         repeatMaxInstances: number | null;
         repeatControlVarCode: string | null;
         repeatInstanceLabel: string | null;
         conditions: string | null;
-        formId: string;
     }>;
     createFormRoster(pageId: string, data: {
         code: string;
@@ -484,6 +510,8 @@ declare class FormService {
         dataSourceDependencies?: Record<string, string>;
         style?: unknown;
         metadata?: Record<string, unknown>;
+        templateId?: string;
+        templateOverrides?: Record<string, unknown>;
     }): Promise<{
         id: string;
         code: string;
@@ -496,7 +524,9 @@ declare class FormService {
         conditions: string | null;
         options: string | null;
         pageId: string | null;
+        templateOverrides: string | null;
         type: string;
+        rosterId: string | null;
         isRequired: boolean;
         isReadonly: boolean;
         isHidden: boolean;
@@ -507,7 +537,7 @@ declare class FormService {
         dataSourceId: string | null;
         dataSourceDependencies: string | null;
         style: string | null;
-        rosterId: string | null;
+        templateId: string | null;
     }>;
     updateFormVariable(id: string, data: Partial<{
         code: string;
@@ -528,6 +558,8 @@ declare class FormService {
         dataSourceDependencies: Record<string, string>;
         style: unknown;
         metadata: Record<string, unknown>;
+        templateId: string | null;
+        templateOverrides: Record<string, unknown> | null;
     }>): Promise<{
         id: string;
         code: string;
@@ -540,7 +572,9 @@ declare class FormService {
         conditions: string | null;
         options: string | null;
         pageId: string | null;
+        templateOverrides: string | null;
         type: string;
+        rosterId: string | null;
         isRequired: boolean;
         isReadonly: boolean;
         isHidden: boolean;
@@ -551,7 +585,7 @@ declare class FormService {
         dataSourceId: string | null;
         dataSourceDependencies: string | null;
         style: string | null;
-        rosterId: string | null;
+        templateId: string | null;
     }>;
     deleteFormVariable(id: string): Promise<{
         id: string;
@@ -565,7 +599,9 @@ declare class FormService {
         conditions: string | null;
         options: string | null;
         pageId: string | null;
+        templateOverrides: string | null;
         type: string;
+        rosterId: string | null;
         isRequired: boolean;
         isReadonly: boolean;
         isHidden: boolean;
@@ -576,7 +612,7 @@ declare class FormService {
         dataSourceId: string | null;
         dataSourceDependencies: string | null;
         style: string | null;
-        rosterId: string | null;
+        templateId: string | null;
     }>;
     getSubmissions(params: {
         formId: string;
@@ -654,9 +690,23 @@ declare class FormService {
     importForm(json: string, tenantId?: string): Promise<string>;
     /** Extract variable data for createFormVariable (omit `id` to let Prisma generate it) */
     private extractVariableData;
-    /** Convert Prisma DB result to IFormDefinition */
+    /**
+     * Convert a Prisma DB result to a fully-resolved `IFormDefinition`.
+     *
+     * Templates referenced by `IFormVariable.templateId` are loaded in a
+     * single batch and applied via `resolveFormTemplates` (Option B —
+     * in-memory only, no mutation in DB). Pass `resolveTemplates = false`
+     * to obtain the raw shape (useful for editor tooling that wants to
+     * preserve `templateOverrides`).
+     */
     private dbToFormDefinition;
     private dbToVariable;
+    /**
+     * Convert a Prisma VariableTemplate row to the domain type. Duplicated
+     * locally (kept in sync with `ScopeService.dbToTemplate`) to avoid an
+     * import cycle between the two services.
+     */
+    private dbToTemplate;
 }
 
 /**
@@ -730,6 +780,7 @@ declare const createFormDefinitionSchema: z.ZodObject<{
     isPublished: z.ZodDefault<z.ZodBoolean>;
     tenantId: z.ZodOptional<z.ZodString>;
     formTypeId: z.ZodOptional<z.ZodString>;
+    scopeIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, "strip", z.ZodTypeAny, {
     code: string;
@@ -740,6 +791,7 @@ declare const createFormDefinitionSchema: z.ZodObject<{
     metadata?: Record<string, unknown> | undefined;
     tenantId?: string | undefined;
     formTypeId?: string | undefined;
+    scopeIds?: string[] | undefined;
 }, {
     code: string;
     name: string;
@@ -749,6 +801,7 @@ declare const createFormDefinitionSchema: z.ZodObject<{
     version?: string | undefined;
     isPublished?: boolean | undefined;
     formTypeId?: string | undefined;
+    scopeIds?: string[] | undefined;
 }>;
 declare const updateFormDefinitionSchema: z.ZodObject<{
     code: z.ZodOptional<z.ZodString>;
@@ -758,6 +811,7 @@ declare const updateFormDefinitionSchema: z.ZodObject<{
     isPublished: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
     tenantId: z.ZodOptional<z.ZodOptional<z.ZodString>>;
     formTypeId: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    scopeIds: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
     metadata: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
 }, "strip", z.ZodTypeAny, {
     code?: string | undefined;
@@ -768,6 +822,7 @@ declare const updateFormDefinitionSchema: z.ZodObject<{
     version?: string | undefined;
     isPublished?: boolean | undefined;
     formTypeId?: string | undefined;
+    scopeIds?: string[] | undefined;
 }, {
     code?: string | undefined;
     name?: string | undefined;
@@ -777,6 +832,7 @@ declare const updateFormDefinitionSchema: z.ZodObject<{
     version?: string | undefined;
     isPublished?: boolean | undefined;
     formTypeId?: string | undefined;
+    scopeIds?: string[] | undefined;
 }>;
 declare const createFormPageSchema: z.ZodObject<{
     code: z.ZodString;
@@ -985,6 +1041,8 @@ declare const createFormVariableSchema: z.ZodObject<{
     dataSourceDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     style: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    templateId: z.ZodOptional<z.ZodString>;
+    templateOverrides: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, "strip", z.ZodTypeAny, {
     code: string;
     name: string;
@@ -1001,6 +1059,7 @@ declare const createFormVariableSchema: z.ZodObject<{
         metadata?: Record<string, unknown> | undefined;
         value?: unknown;
     }[] | undefined;
+    templateOverrides?: Record<string, unknown> | undefined;
     defaultValue?: unknown;
     placeholder?: string | undefined;
     validationRules?: {
@@ -1012,6 +1071,7 @@ declare const createFormVariableSchema: z.ZodObject<{
     dataSourceId?: string | undefined;
     dataSourceDependencies?: Record<string, string> | undefined;
     style?: Record<string, unknown> | undefined;
+    templateId?: string | undefined;
 }, {
     code: string;
     name: string;
@@ -1025,6 +1085,7 @@ declare const createFormVariableSchema: z.ZodObject<{
         metadata?: Record<string, unknown> | undefined;
         value?: unknown;
     }[] | undefined;
+    templateOverrides?: Record<string, unknown> | undefined;
     isRequired?: boolean | undefined;
     isReadonly?: boolean | undefined;
     isHidden?: boolean | undefined;
@@ -1039,6 +1100,7 @@ declare const createFormVariableSchema: z.ZodObject<{
     dataSourceId?: string | undefined;
     dataSourceDependencies?: Record<string, string> | undefined;
     style?: Record<string, unknown> | undefined;
+    templateId?: string | undefined;
 }>;
 declare const updateFormVariableSchema: z.ZodObject<{
     code: z.ZodOptional<z.ZodString>;
@@ -1083,6 +1145,8 @@ declare const updateFormVariableSchema: z.ZodObject<{
     dataSourceDependencies: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
     style: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
     metadata: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    templateId: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    templateOverrides: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
 }, "strip", z.ZodTypeAny, {
     code?: string | undefined;
     name?: string | undefined;
@@ -1095,6 +1159,7 @@ declare const updateFormVariableSchema: z.ZodObject<{
         metadata?: Record<string, unknown> | undefined;
         value?: unknown;
     }[] | undefined;
+    templateOverrides?: Record<string, unknown> | undefined;
     type?: string | undefined;
     isRequired?: boolean | undefined;
     isReadonly?: boolean | undefined;
@@ -1110,6 +1175,7 @@ declare const updateFormVariableSchema: z.ZodObject<{
     dataSourceId?: string | undefined;
     dataSourceDependencies?: Record<string, string> | undefined;
     style?: Record<string, unknown> | undefined;
+    templateId?: string | undefined;
 }, {
     code?: string | undefined;
     name?: string | undefined;
@@ -1122,6 +1188,7 @@ declare const updateFormVariableSchema: z.ZodObject<{
         metadata?: Record<string, unknown> | undefined;
         value?: unknown;
     }[] | undefined;
+    templateOverrides?: Record<string, unknown> | undefined;
     type?: string | undefined;
     isRequired?: boolean | undefined;
     isReadonly?: boolean | undefined;
@@ -1137,6 +1204,7 @@ declare const updateFormVariableSchema: z.ZodObject<{
     dataSourceId?: string | undefined;
     dataSourceDependencies?: Record<string, string> | undefined;
     style?: Record<string, unknown> | undefined;
+    templateId?: string | undefined;
 }>;
 declare const createSubmissionSchema: z.ZodObject<{
     formId: z.ZodString;