ngx-t-forms-types 0.0.26 → 0.0.27

package/dist/interfaces/FormBuilder/elementEditor.d.ts

@@ -38,7 +38,9 @@ export declare enum ElementEditorTypes {
     MapMatOptionsKeys = "mapMatOptionsKeys",
     FormPayloadProjection = "formPayloadProjection",
     /** Opt-in JSON body template ({@link PayloadTemplate}) for a POST value/options fetch. */
-    PayloadTemplate = "payloadTemplate"
+    PayloadTemplate = "payloadTemplate",
+    /** JSON request-header template ({@link HeaderTemplate}) for a value/options fetch (GET and POST alike). */
+    HeaderTemplate = "headerTemplate"
 }
 export interface ElementEditorConfigInterface {
     editorSections: Array<ElementEditorConfigSectionInterface>;

package/dist/interfaces/FormBuilder/elementEditor.js

@@ -33,6 +33,8 @@ export var ElementEditorTypes;
     ElementEditorTypes["FormPayloadProjection"] = "formPayloadProjection";
     /** Opt-in JSON body template ({@link PayloadTemplate}) for a POST value/options fetch. */
     ElementEditorTypes["PayloadTemplate"] = "payloadTemplate";
+    /** JSON request-header template ({@link HeaderTemplate}) for a value/options fetch (GET and POST alike). */
+    ElementEditorTypes["HeaderTemplate"] = "headerTemplate";
 })(ElementEditorTypes || (ElementEditorTypes = {}));
 // interface TStringExpressionValidationTest{
 //   expression: string;

package/dist/interfaces/FormBuilder/inputConfig/ElementEditConfig.js

@@ -848,6 +848,26 @@ export var ElementConfig = {
                     label: 'Configure MongoDB pipeline',
                     id: "7b2989ae-2f54-4849-93d0-aff56ac12ef2"
                 },
+                {
+                    name: SpecialElementKeys.Default,
+                    deepBind: ['matOptions', 'fetch', 'value', 'headerTemplate'],
+                    additionalTest: [
+                        {
+                            // Headers are a transport concern — offered for GET and POST
+                            // alike, but only once an API endpoint has been selected.
+                            expression: `source === ${DataSources.Api}`,
+                            deepBind: ['matOptions', 'fetch', 'value', 'source'],
+                        },
+                        {
+                            testType: 'exists',
+                            deepBind: ['matOptions', 'fetch', 'value', 'httpEndPoint'],
+                        },
+                    ],
+                    hint: `Author the request headers as JSON. Type $ to bind a header to a live field value; every other literal is a fixed default. The fetch waits until every bound field has a value.`,
+                    editType: ElementEditorTypes.HeaderTemplate,
+                    label: 'Request headers',
+                    id: "f4b1c8d2-6e35-4a71-9f08-3c7d2b6a5e14"
+                },
                 {
                     name: SpecialElementKeys.Default,
                     deepBind: ['matOptions', 'fetch', 'value', 'backEndConfig', 'requestBodyMode'],
@@ -1035,6 +1055,26 @@ export var ElementConfig = {
                     label: 'Select API to fetch data from',
                     id: "df9e2a34-7bf5-411e-a265-14ca4f85166d"
                 },
+                {
+                    name: SpecialElementKeys.Default,
+                    deepBind: ['matOptions', 'fetch', 'options', 'headerTemplate'],
+                    additionalTest: [
+                        {
+                            // Headers are a transport concern — offered for GET and POST
+                            // alike, but only once an API endpoint has been selected.
+                            expression: `source === ${DataSources.Api}`,
+                            deepBind: ['matOptions', 'fetch', 'options', 'source'],
+                        },
+                        {
+                            testType: 'exists',
+                            deepBind: ['matOptions', 'fetch', 'options', 'httpEndPoint'],
+                        },
+                    ],
+                    hint: `Author the request headers as JSON. Type $ to bind a header to a live field value; every other literal is a fixed default. The fetch waits until every bound field has a value.`,
+                    editType: ElementEditorTypes.HeaderTemplate,
+                    label: 'Request headers',
+                    id: "9a5e7c30-2d84-4b16-8e5f-6b0c4d1a7f92"
+                },
                 {
                     name: SpecialElementKeys.Default,
                     deepBind: ['matOptions', 'fetch', 'options', 'backEndConfig', 'requestBodyMode'],

package/dist/interfaces/environment/environment.d.ts

@@ -1,5 +1,6 @@
 import { IStoreFunctions } from "./IStoreFunctions.js";
 import { Moment } from 'moment';
+import type { FormSubmissionHandleInterface } from "../Form/formSubmissionHandleInterface.js";
 export interface IFinancialCycles {
     CURRENT_FINANCIAL_CYCLE: string;
     CURRENT_FINANCIAL_CYCLE_START_DATE: Moment;
@@ -16,5 +17,37 @@ export interface IFinancialCycles {
 export interface NgxTFormsConfig {
     base_url?: string;
     formBuilder: IStoreFunctions;
+    /**
+     * Submission configuration pre-inserted into every NEW form the builder creates.
+     *
+     * Applies ONLY at new-form creation. Forms loaded from storage keep whatever they
+     * already carry — including nothing — so an author can delete the pre-inserted
+     * endpoints and have that stick. Changing this value never rewrites existing forms.
+     *
+     * The value is deep-copied per form, so the builder editing one form's submission
+     * config can never mutate this object or leak into the next new form. API entry
+     * `_id`s are copied verbatim, so the same default yields the same ids across forms.
+     *
+     * Omit it and new forms start with `{ submissionAPI: [] }`, exactly as before.
+     *
+     * @example
+     *   provideNgxTForms({
+     *     formBuilder: myStoreFunctions,
+     *     defaultSubmissionHandle: {
+     *       innerComponentShowSubmitButton: false,
+     *       submissionAPI: [{
+     *         _id: '80eca6b1-923a-4c0e-a863-2f56a7e52a67',
+     *         name: 'Generate/Update WF Document',
+     *         httpEndPoint: '{{$iserve-back-end-url}}/api/form/generateWFFormValues',
+     *         httpMethod: 'POST',
+     *         postFormData: true,
+     *         backEndConfig: { minimumInputRequired: [] },
+     *         source: DataSources.Api,
+     *         projectFormData: 'data:{$formValue}',
+     *       }],
+     *     },
+     *   })
+     */
+    defaultSubmissionHandle?: FormSubmissionHandleInterface;
     [key: string]: string | Object | undefined;
 }

package/dist/interfaces/formInput/APIDataFetchingConfigurationInterface.d.ts

@@ -65,6 +65,44 @@ export type PayloadTemplate = {
  * configuration.
  */
 export type RequestBodyMode = 'mappedInputs' | 'template';
+/**
+ * A single header value in a {@link HeaderTemplate}.
+ *
+ * Scalars only — an HTTP header value is text on the wire, so a number/boolean
+ * literal is stringified at request time. Nesting is deliberately not expressible:
+ * a header has no structure to nest into.
+ */
+export type HeaderTemplateValue = string | number | boolean;
+/**
+ * Declarative request headers for a value/options fetch, authored in the same
+ * JSON editor as {@link PayloadTemplate} and resolved with the same
+ * `{{inputId}}` token syntax.
+ *
+ * A value that is EXACTLY `"{{inputId}}"` is replaced by that input's live value
+ * (stringified); a value that merely CONTAINS token(s) is interpolated
+ * (`"Bearer {{accessToken}}"`); every other literal is a fixed default. Header
+ * names are always literal.
+ *
+ * Applies to GET as well as POST — headers are a transport concern, not a body
+ * concern. The resolved map is merged into
+ * {@link APIDataFetchingConfigurationInterface.httpHeaderOptions}`.headers`
+ * (the template wins on a name collision) before the request is issued.
+ *
+ * Like a payload template, a token that resolves empty keeps the fetch **idle**:
+ * a request that would go out without its `Authorization`/tenant header is a
+ * request that fails, so the engine waits for the bound field instead of issuing
+ * a doomed call.
+ *
+ * @example
+ *   headerTemplate: {
+ *     Authorization: 'Bearer {{accessToken}}',
+ *     'x-tenant-id': '{{municipality}}',
+ *     'Content-Type': 'application/json',
+ *   }
+ */
+export type HeaderTemplate = {
+    [headerName: string]: HeaderTemplateValue;
+};
 export interface APIDataFetchingConfigurationInterface extends DataFetchingBaseConfig {
     _id: string;
     name: string;
@@ -89,6 +127,19 @@ export interface APIDataFetchingConfigurationInterface extends DataFetchingBaseC
             includeHeaders?: string[];
         } | boolean;
     };
+    /**
+     * Author-configured request headers, optionally bound to live form values (see
+     * {@link HeaderTemplate}). Merged over {@link httpHeaderOptions}`.headers` at
+     * request time; absent means "send exactly what `httpHeaderOptions` says",
+     * which is the historical behaviour.
+     */
+    headerTemplate?: HeaderTemplate;
+    /**
+     * The headers captured from the selected endpoint (e.g. the Postman request's
+     * enabled headers). Persisted only to seed {@link headerTemplate}'s editor so
+     * it never opens blank; never sent on its own.
+     */
+    capturedHeaders?: HeaderTemplate;
     backEndConfig: {
         /**
          * The default/mapTo mapping that shapes the POST body in `'mappedInputs'` mode.

package/dist/interfaces/formInput/index.d.ts

@@ -1,7 +1,7 @@
 import { IFolderItem, IPostmanCollection } from "../FormBuilder/postmanCollection.js";
 import { IWorkflowDocListCols, IWorkflowStepOption } from "../FormBuilder/workflowSelectionConfig.js";
 import { TreeNode } from "../FormSlide/accessTree.js";
-import { APIDataFetchingConfigurationInterface, InputAPIDataId, MongoDbPipeLineConfigInterface, PayloadTemplate, PayloadTemplateValue, RequestBodyMode } from "./APIDataFetchingConfigurationInterface.js";
+import { APIDataFetchingConfigurationInterface, HeaderTemplate, HeaderTemplateValue, InputAPIDataId, MongoDbPipeLineConfigInterface, PayloadTemplate, PayloadTemplateValue, RequestBodyMode } from "./APIDataFetchingConfigurationInterface.js";
 import { AutocapitalizeOptions, AutocompleteOptions, ElementTypes, IBasicFormInput, IFormElementTemplate, InputDataTypes, InputPipeTypes, InputTypes, OptionSelectTypes } from "./BasicFormInputInterface.js";
 import { IDateRangePickerInput } from "./DateRangePickerInput.js";
 import { AllDocumentFileExtensions, AllImageFileExtensions, FileUploadInputValueInterface, IFileUploadInput, InputFileType, UploadTypes } from "./FileUploadInputInterface.js";
@@ -25,4 +25,4 @@ import { CalculationFunctions, calculationVariableInterface } from "./calculatio
 import { IRichTextEditor, RichTextEditorType } from "./RichTextEditorInput.js";
 import { ValidationError, ValidationOptions } from "./schema.js";
 import { IUserSignature } from "./userSignature.js";
-export { ElementTypes, InputTypes, InputPipeTypes, AutocapitalizeOptions, AutocompleteOptions, InputDataTypes, MinInputTypes, IFormElementTemplate, IBasicFormInput, IFileUploadInput, IDateRangePickerInput, ITextareaProperties, IToggleInput, IMatrixInput, IMultiple, IMultipleInputCal, IScoaInput, TableConfigurationsInterface, TableColumnConfigInterface, FormControlCustomValidatorsInterface, InputObservedForChange, DraftFormControlCustomValidator, IFormValidationOverride, MinimumInputRequiredInterface, MinInputMapInput, CalculatedFieldRules, calculationVariableInterface, APIDataFetchingConfigurationInterface, PayloadTemplate, PayloadTemplateValue, RequestBodyMode, IGetTreeResponse, CalculationFunctions, TreeNode, IPostmanCollection, IFolderItem, FileUploadInputValueInterface, AllDocumentFileExtensions, AllImageFileExtensions, UploadTypes, InputFileType, IScoaAccount, IScoaInputConfig, ITableScoaSelectionRow, ScoaSegmentValue, ScoaSegmentValueBag, IIncludedSegmentConfig, AccountingBasis, ScoaAccountTree, IUserSignature, ValidationOptions, ValidationError, MatDataOptionsInterface, MongoDbPipeLineConfigInterface, InputAPIDataId, FormInputBasicOptionInterface, ScoaInterface, ScoaInnerInput, IAccountSegmentTreeKeys, IWorkflowDocumentPicker, IWorkflowDocumentPickerConfig, IWorkflowDocumentStepFilter, IDocumentPickerFilter, IDocumentPage, IDocumentQueryRequest, IDocumentReference, DocumentPickerFilterOperator, DocumentPickerFilterValueSource, DocumentPickerFilterValueType, DOCUMENT_PICKER_FILTER_OPERATORS, DOCUMENT_PICKER_FILTER_VALUE_SOURCES, DOCUMENT_PICKER_FILTER_VALUE_TYPES, workflowStepStatus, IWorkflowDocListCols, IWorkflowStepOption, JsDataTypes, AdjudicationSteps, IWorkflowAdjudicationInput, WorkflowAdjudicationScoreSheetValue, WorkflowAdjudicationMicroFlowReviewValue, WorkflowAdjudicationResponseElectedSupplierSelectionValue, ScoreSheetItem, AdjResponseReviewColumnMapping, OptionSelectTypes, ISelectInputInterface, MultipleInputAvailableOperations, RichTextEditorType, IRichTextEditor, };
+export { ElementTypes, InputTypes, InputPipeTypes, AutocapitalizeOptions, AutocompleteOptions, InputDataTypes, MinInputTypes, IFormElementTemplate, IBasicFormInput, IFileUploadInput, IDateRangePickerInput, ITextareaProperties, IToggleInput, IMatrixInput, IMultiple, IMultipleInputCal, IScoaInput, TableConfigurationsInterface, TableColumnConfigInterface, FormControlCustomValidatorsInterface, InputObservedForChange, DraftFormControlCustomValidator, IFormValidationOverride, MinimumInputRequiredInterface, MinInputMapInput, CalculatedFieldRules, calculationVariableInterface, APIDataFetchingConfigurationInterface, PayloadTemplate, PayloadTemplateValue, RequestBodyMode, HeaderTemplate, HeaderTemplateValue, IGetTreeResponse, CalculationFunctions, TreeNode, IPostmanCollection, IFolderItem, FileUploadInputValueInterface, AllDocumentFileExtensions, AllImageFileExtensions, UploadTypes, InputFileType, IScoaAccount, IScoaInputConfig, ITableScoaSelectionRow, ScoaSegmentValue, ScoaSegmentValueBag, IIncludedSegmentConfig, AccountingBasis, ScoaAccountTree, IUserSignature, ValidationOptions, ValidationError, MatDataOptionsInterface, MongoDbPipeLineConfigInterface, InputAPIDataId, FormInputBasicOptionInterface, ScoaInterface, ScoaInnerInput, IAccountSegmentTreeKeys, IWorkflowDocumentPicker, IWorkflowDocumentPickerConfig, IWorkflowDocumentStepFilter, IDocumentPickerFilter, IDocumentPage, IDocumentQueryRequest, IDocumentReference, DocumentPickerFilterOperator, DocumentPickerFilterValueSource, DocumentPickerFilterValueType, DOCUMENT_PICKER_FILTER_OPERATORS, DOCUMENT_PICKER_FILTER_VALUE_SOURCES, DOCUMENT_PICKER_FILTER_VALUE_TYPES, workflowStepStatus, IWorkflowDocListCols, IWorkflowStepOption, JsDataTypes, AdjudicationSteps, IWorkflowAdjudicationInput, WorkflowAdjudicationScoreSheetValue, WorkflowAdjudicationMicroFlowReviewValue, WorkflowAdjudicationResponseElectedSupplierSelectionValue, ScoreSheetItem, AdjResponseReviewColumnMapping, OptionSelectTypes, ISelectInputInterface, MultipleInputAvailableOperations, RichTextEditorType, IRichTextEditor, };

package/dist/schemas/MatOptionsSchema.js

@@ -22,6 +22,8 @@ const minimumInputRequiredSchema = Joi.object({
     activeChangeId: Joi.string().optional(),
     primaryKey: Joi.boolean().optional()
 });
+/** A flat `header name → scalar value` map (see `HeaderTemplate`). */
+const headerTemplateSchema = Joi.object().pattern(Joi.string(), Joi.alternatives().try(Joi.string().allow(''), Joi.number(), Joi.boolean()));
 const APIDataFetchingConfigurationSchema = Joi.object({
     _id: Joi.string().required(),
     name: Joi.string().required(),
@@ -42,6 +44,12 @@ const APIDataFetchingConfigurationSchema = Joi.object({
         withCredentials: Joi.boolean().optional(),
         transferCache: Joi.alternatives().try(Joi.object({ includeHeaders: Joi.array().items(Joi.string()).optional() }), Joi.boolean()).optional()
     }).optional(),
+    // Author-configured headers, values optionally carrying {{inputId}} tokens bound to
+    // live form values. Flat by construction — a header value is text on the wire, so
+    // only scalars are accepted (numbers/booleans are stringified at request time).
+    headerTemplate: headerTemplateSchema.optional(),
+    // Headers captured from the selected endpoint; seeds the editor, never sent alone.
+    capturedHeaders: headerTemplateSchema.optional(),
     backEndConfig: Joi.object({
         // Optional: a 'template'-mode fetch shapes its body from payloadTemplate and
         // carries no mapping; GET fetches never had one. Readers default it to [].

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-t-forms-types",
-  "version": "0.0.26",
+  "version": "0.0.27",
   "description": "Typings and interfaces for the ngx-t-forms library for dynamic forms.",
   "keywords": [
     "typings",