@stechquick/studio-cli 4.2.0-1 → 4.2.0-3

package/dist/studio-cli/kits/miniapp-app-kit/.ai-kit/ui-kit/reference/quick-api.json

@@ -0,0 +1,1746 @@
+{
+  "$comment": "Complete `quick.*` API surface, generated from the Quick runtime's scripting interface. Keys are full dotted call paths; each entry has signature, description, params, returns, example, deprecated where the source documents them. DO NOT READ THIS FILE WHOLE — grep the member you need (e.g. `grep -n '\"quick.Quick.region.setRegion\"' quick-api.json`) and read only that block. For the readable list of everything available, plus the authoring rules (QScript vs TypeScript, store prefixes, quick.return), see quick-api.md.",
+  "version": 2,
+  "api": {
+    "quick.Request": {
+      "namespace": true
+    },
+    "quick.Request.async": {
+      "description": "Sends a network request.",
+      "params": [
+        {
+          "name": "requestObject",
+          "description": "Request object that contains the request url, http method, data, responseField, onSuccess, onFail, blockRender, showSuccessMessage, showErrorMessage, args, headers, withCredentials, timeout."
+        }
+      ],
+      "example": "const requestObject = {\nurl: 'https://api.example.com/data',\nhttp: 'GET',\nonSuccess: 'onSuccessfulResponse',\nonFail: 'onFailedResponse',\nblockRender: true,\nresponseField: \"response\",\ntimeout: 2000\n};\nconst response = quick.Request.async(requestObject);",
+      "signature": "(requestObject: IRequest): Promise<INetworkResponse<Record<string, any>>> | undefined"
+    },
+    "quick.Request.download": {
+      "description": "Downloads files and resources through network request.",
+      "params": [
+        {
+          "name": "requestObject",
+          "description": "Request object that contains the request url, http method, data, responseField, onSuccess, onFail, blockRender, showSuccessMessage, showErrorMessage, args, headers, withCredentials, timeout."
+        }
+      ],
+      "example": "const req: IRequest = {\nurl: \"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf\",\ndata: null,\nblockRender: false,\nhttp: \"get\",\nonFail: null,\nonSuccess: null,\nresponseField: \"respo\",\ntimeout: 2000,\n};\nconst response = quick.Request.download(req);",
+      "signature": "(requestObject: IDownloadRequest): void"
+    },
+    "quick.MM": {
+      "namespace": true
+    },
+    "quick.MM.get": {
+      "description": "Retrieves the custom event from the Page Component.",
+      "params": [
+        {
+          "name": "eventName",
+          "description": "Custom event name to be retrieved."
+        }
+      ],
+      "signature": "(eventName: string): void"
+    },
+    "quick.MM.trigger": {
+      "description": "Triggers a custom event on the Page Component.",
+      "params": [
+        {
+          "name": "eventName",
+          "description": "Custom event name to be triggered."
+        },
+        {
+          "name": "parameters",
+          "description": "Parameters to be passed to the custom event."
+        }
+      ],
+      "signature": "(eventName: string, parameters?: Array<any>): any"
+    },
+    "quick.MM.delay": {
+      "description": "Triggers a custom event on the Page Component with a delay.",
+      "params": [
+        {
+          "name": "eventName",
+          "description": "Custom event name to be triggered."
+        },
+        {
+          "name": "parameters",
+          "description": "Parameters to be passed to the custom event."
+        }
+      ],
+      "signature": "( eventName: string, parameters?: { delayTime?: number; options?: Array<any> } ): void"
+    },
+    "quick.MM.clearTimeout": {
+      "signature": "(timer: any): void"
+    },
+    "quick.EM": {
+      "namespace": true
+    },
+    "quick.EM.trace": {
+      "description": "Writes a message to the browser console.",
+      "params": [
+        {
+          "name": "traceMessage",
+          "description": "A message to be written to the console."
+        },
+        {
+          "name": "options",
+          "description": "Options to be passed to specify the log type."
+        }
+      ],
+      "example": "quick.EM.trace('This is a trace message');",
+      "signature": "(traceMessage: any, options?: { logType?: LogType }) => void"
+    },
+    "quick.LR": {
+      "description": "Retrieves the language equivalent of the given key parameter with current language of the system.",
+      "params": [
+        {
+          "name": "key",
+          "description": "The key to retrieve the equivalent localization configuration."
+        },
+        {
+          "name": "dataSource",
+          "description": "Optional parameter to retrieve the localization configuration from the given data source."
+        }
+      ],
+      "returns": "Returns the equivalent localization configuration of the given key parameter as string.",
+      "signature": "(key: string, dataSource?: object | null) => string | null | undefined"
+    },
+    "quick.importLocalization": {
+      "description": "Imports localization data for a specific language and adds it to Global Localization.",
+      "params": [
+        {
+          "name": "langCode",
+          "description": "Language code (e.g., \"en-US\")."
+        },
+        {
+          "name": "localization",
+          "description": "Key-value pairs of localization information."
+        },
+        {
+          "name": "options",
+          "type": "Object",
+          "description": "Optional configuration object."
+        },
+        {
+          "name": "options.overwrite",
+          "type": "boolean",
+          "description": "=false] - If true, overwrites existing values; if false, ignores existing keys."
+        }
+      ],
+      "signature": "(langCode: string, localization: Record<string, string>, options?: { overrite?: boolean }) => void"
+    },
+    "quick.go": {
+      "description": "Triggers the go command in the shell with integrated WebSDK, routing to another page with the provided parameters.",
+      "params": [
+        {
+          "name": "args",
+          "description": "Variable number of arguments representing the parameters for the go command."
+        }
+      ],
+      "returns": "Returns the result of the go command.",
+      "example": "quick.go(\"<<qjson:d21r0xpa-krke-m6oi-mo8m-bk7whi3b>>\");\nquick.go(pageTitle, \"<<qjson:d21r0xpa-krke-m6oi-mo8m-bk7whi3b>>\", pageParams);\nquick.go('customer', 'RenderSecondPage');",
+      "signature": "(...args: any[]) => any"
+    },
+    "quick.getComponent": {
+      "description": "Retrieves the component instance by the given component id.",
+      "params": [
+        {
+          "name": "compID",
+          "description": "The ID of the component to be retrieved."
+        }
+      ],
+      "returns": "The component instance if found, otherwise null or undefined.",
+      "signature": "(compID: string): IComponent | null | undefined"
+    },
+    "quick.setFormData": {
+      "signature": "(compCol: object): void"
+    },
+    "quick.getArrangedNestedData": {
+      "signature": "(obj: object, pairChar: string): {}"
+    },
+    "quick.getFormData": {
+      "signature": "(componentQID?: string,): {}"
+    },
+    "quick.getArrangedFormData": {
+      "signature": "(formData: object, pairChar: string): {}"
+    },
+    "quick.bind": {
+      "signature": "(field: string) => any"
+    },
+    "quick.Quick": {
+      "namespace": true
+    },
+    "quick.Quick.theme": {
+      "description": "Provides methods for managing themes within the application.",
+      "example": "quick.Quick.theme.setTheme('dark-theme');\nconst availableThemes = quick.Quick.theme.getThemeList();\nquick.Quick.theme.addTheme('custom-theme');\nquick.Quick.theme.removeTheme('obsolete-theme');",
+      "namespace": true
+    },
+    "quick.Quick.theme.setTheme": {
+      "description": "Sets the current theme.",
+      "params": [
+        {
+          "name": "themeName",
+          "type": "string",
+          "description": "The name of the theme to set."
+        },
+        {
+          "name": "isLight",
+          "type": "string",
+          "description": "Apply light or dark version of the current theme."
+        }
+      ],
+      "signature": "(themeName: string, isLight?: boolean) => void"
+    },
+    "quick.Quick.theme.getThemeList": {
+      "description": "Retrieves the list of available themes.",
+      "returns": "An array of theme names or undefined.",
+      "signature": "() => Array<string> | undefined"
+    },
+    "quick.Quick.theme.addTheme": {
+      "description": "Adds a new theme to the list of available themes.",
+      "params": [
+        {
+          "name": "themeName",
+          "type": "string",
+          "description": "The name of the theme to add."
+        }
+      ],
+      "signature": "(themeName: string) => void"
+    },
+    "quick.Quick.theme.removeTheme": {
+      "description": "Removes a theme from the list of available themes.",
+      "params": [
+        {
+          "name": "themeName",
+          "type": "string",
+          "description": "The name of the theme to remove."
+        }
+      ],
+      "signature": "(themeName: string) => void"
+    },
+    "quick.Quick.redirect": {
+      "description": "Attempts to open a URL using the specified options for redirection.",
+      "params": [
+        {
+          "name": "url",
+          "description": "The URL to redirect to."
+        },
+        {
+          "name": "options",
+          "type": "IUrlOptions",
+          "description": "Optional configuration object for the redirection."
+        },
+        {
+          "name": "options.target",
+          "type": "UrlTarget",
+          "description": "=\"_self\"] - The target window or frame for the URL. Possible values: \"_blank\", \"_parent\", \"_self\", \"_top\"."
+        }
+      ],
+      "example": "quick.Quick.redirect(\"https://www.google.com.tr/\", { target: \"_parent\" });",
+      "signature": "(url: string, options?: IUrlOptions) => void"
+    },
+    "quick.Quick.back": {
+      "signature": "(...args: any[]) => any"
+    },
+    "quick.Quick.goHistory": {
+      "description": "Navigates between opened pages using the specified step number in the navigation history. To navigate back or forward in the page history, provide a positive or negative step number to the method. For example, quick.Quick.goHistory(1) navigates one step back in the history.",
+      "params": [
+        {
+          "name": "step",
+          "description": "The step number to navigate in the page history. A positive number for forward, a negative number for backward navigation."
+        }
+      ],
+      "signature": "(step: number) => void"
+    },
+    "quick.Quick.go": {
+      "description": "Triggers navigation to the specified page with optional configuration options.",
+      "params": [
+        {
+          "name": "qjsonPath",
+          "description": "The path or identifier of the page to navigate to, typically a qjson reference."
+        },
+        {
+          "name": "options",
+          "description": "Optional configuration object for the navigation."
+        },
+        {
+          "name": "options.newTab",
+          "description": "=false] - If true, opens the specified page in a new tab."
+        },
+        {
+          "name": "options.store",
+          "description": "=false] - If true, transmits store values to the new tab (valid only if newTab is true)."
+        },
+        {
+          "name": "options.mobileAnimation",
+          "type": "MobileAnimationType",
+          "description": "The animation to use for navigation transitions in mobile apps. Has no affect and should not be set for web apps. If not set, default value is { mobileAnimation: { type: \"slideIn\", slideType: \"fromRight\" } }. Pass one of: { type: \"slideIn\", slideType: \"fromRight\" | \"fromLeft\" | \"fromTop\" | \"fromBottom\" }; { type: \"slideOut\", slideType: \"toRight\" | \"toLeft\" | \"toTop\" | \"toBottom\" }; { type: \"fade\" }; or { type: \"instant\" }. slideType is required for slideIn and slideOut and is not used for fade or instant."
+        }
+      ],
+      "returns": "Returns the result of the navigation operation.",
+      "example": "quick.Quick.go(\"<<qjson:d21r0xpa-krke-m6oi-mo8m-bk7whi3b>>\", { newTab: true, store: true });\nquick.Quick.go(\"<<qjson:d21r0xpa-krke-m6oi-mo8m-bk7whi3b>>\", { mobileAnimation: { type: \"slideIn\", slideType: \"fromTop\" } });",
+      "signature": "(qjsonPath: string, options?: INavigationOptions) => any"
+    },
+    "quick.Quick.goNative": {
+      "optional": true,
+      "signature": "({ code, param, mobileAnimation }: { code: string; param?: Record<string, any>, mobileAnimation?: MobileAnimationType }) => void"
+    },
+    "quick.Quick.copy": {
+      "description": "Creates a deep copy of the provided object using a cloning technique. Changes made to the new object will not affect the original object. This method is useful for duplicating complex data structures.",
+      "params": [
+        {
+          "name": "object",
+          "description": "The object to be deep copied."
+        }
+      ],
+      "returns": "Returns a new object that is a deep copy of the original.",
+      "example": "const originalObject = { key: 'value', nested: { subKey: 'subValue' } };\nconst copiedObject = quick.Quick.copy(originalObject);\ncopiedObject.nested.subKey = 'modifiedSubValue'; // Does not affect originalObject",
+      "signature": "(object: Object): any"
+    },
+    "quick.Quick.setComponentsProperty": {
+      "description": "Sets the specifed component properties with the given values.",
+      "params": [
+        {
+          "name": "compId",
+          "description": "The id of the component that the properties will be set."
+        },
+        {
+          "name": "propertyName",
+          "description": "The name of the property that will be set."
+        },
+        {
+          "name": "propertyValue",
+          "description": "The value of the property that will be set."
+        }
+      ],
+      "signature": "(compId: string, propertyName: string, propertyValue: string) => void"
+    },
+    "quick.Quick.download": {
+      "description": "Initiates the download of a file using a base64-encoded string and specifying the file name.",
+      "params": [
+        {
+          "name": "options",
+          "description": "Configuration object for the download."
+        },
+        {
+          "name": "options.data",
+          "type": "string",
+          "description": "The base64-encoded string representing the file content."
+        },
+        {
+          "name": "options.name",
+          "type": "string",
+          "description": "The name to be used for the downloaded file."
+        }
+      ],
+      "returns": "Returns true if the download process is initiated successfully; otherwise, false.",
+      "example": "const fileData = 'base64-encoded-string-here';\nconst fileName = 'example-file.txt';\nquick.Quick.download({ data: fileData, name: fileName });",
+      "signature": "({ data, name }: { data: string; name: string }) => boolean"
+    },
+    "quick.Quick.shareData": {
+      "description": "Initiates the share of a file using a base64-encoded string or by using a link and specifying the file name.",
+      "params": [
+        {
+          "name": "sharedDataInfo",
+          "type": "ISharedDataInfo",
+          "description": "Configuration object for the shared data."
+        },
+        {
+          "name": "sharedDataInfo.data",
+          "type": "string",
+          "description": "The base64-encoded string representing the file content or by using a link."
+        },
+        {
+          "name": "sharedDataInfo.name",
+          "type": "string",
+          "description": "The name to be used for the shared data."
+        }
+      ],
+      "example": "let sharedDataInfo: ISharedDataInfo = { data: \"https://developer.mozilla.org\", name: \"example\" }\nquick.Quick.shareData(sharedDataInfo);",
+      "signature": "(sharedDataInfo: ISharedDataInfo) => void"
+    },
+    "quick.Quick.isObject": {
+      "description": "Check if the given input is an object.",
+      "params": [
+        {
+          "name": "obj",
+          "description": "The input to be checked."
+        }
+      ],
+      "returns": "True if the input is object, false otherwise.",
+      "signature": "(obj: any) => boolean"
+    },
+    "quick.Quick.validation": {
+      "description": "Collection of Quick Rule functions for input component validation.",
+      "example": "quick.Quick.validation.required('Enter a value')(inputValue);\nquick.Quick.validation.minLength(5, 'Enter at least 5 characters')(inputValue);\nquick.Quick.validation.maxLength(100, 'Exceeded maximum length')(inputValue);\nquick.Quick.validation.email('Invalid email address')(inputValue);\nquick.Quick.validation.iban('Invalid IBAN')(inputValue);\n// Custom regex validation:\nconst onlyNumbersRegex = '^[0-9\\._,]*$';\nquick.Quick.validation.regex(onlyNumbersRegex, 'Only numbers are allowed')(inputValue);\nquick.Quick.validation.tckn('Invalid TCKN')(inputValue);\nquick.Quick.validation.vkn('Invalid VKN')(inputValue);",
+      "namespace": true
+    },
+    "quick.Quick.validation.required": {
+      "description": "Validates that a value is not empty.",
+      "params": [
+        {
+          "name": "message",
+          "type": "any",
+          "description": "Custom error message for validation failure."
+        }
+      ],
+      "returns": "Validation function for required values.",
+      "signature": "(message?: any) => (value: any) => any"
+    },
+    "quick.Quick.validation.minLength": {
+      "description": "Validates that a value has a minimum length.",
+      "params": [
+        {
+          "name": "minLenght",
+          "type": "any",
+          "description": "The minimum length required."
+        },
+        {
+          "name": "message",
+          "type": "any",
+          "description": "Custom error message for validation failure."
+        },
+        {
+          "name": "options",
+          "type": "object",
+          "description": "Additional options for validation."
+        },
+        {
+          "name": "options.disableNewlineOnCount",
+          "type": "boolean",
+          "description": "Whether to disable newline counting in length."
+        }
+      ],
+      "returns": "Validation function for minimum length.",
+      "signature": "(minLenght: any, message?: any, options?: { disableNewlineOnCount?: boolean }) => (value: any) => any"
+    },
+    "quick.Quick.validation.maxLength": {
+      "description": "Validates that a value has a maximum length.",
+      "params": [
+        {
+          "name": "maxLenght",
+          "type": "any",
+          "description": "The maximum length allowed."
+        },
+        {
+          "name": "message",
+          "type": "any",
+          "description": "Custom error message for validation failure."
+        },
+        {
+          "name": "options",
+          "type": "object",
+          "description": "Additional options for validation."
+        },
+        {
+          "name": "options.disableNewlineOnCount",
+          "type": "boolean",
+          "description": "Whether to disable newline counting in length."
+        }
+      ],
+      "returns": "Validation function for maximum length.",
+      "signature": "(maxLenght: any, message?: any, options?: { disableNewlineOnCount?: boolean }) => (value: any) => any"
+    },
+    "quick.Quick.validation.email": {
+      "description": "Validates that a value is a valid email address.",
+      "params": [
+        {
+          "name": "message",
+          "type": "any",
+          "description": "Custom error message for validation failure."
+        }
+      ],
+      "returns": "Validation function for email addresses.",
+      "signature": "(message?: any) => (value: any) => any"
+    },
+    "quick.Quick.validation.iban": {
+      "description": "Validates that a value is a valid IBAN.",
+      "params": [
+        {
+          "name": "message",
+          "type": "any",
+          "description": "Custom error message for validation failure."
+        }
+      ],
+      "returns": "Validation function for IBAN.",
+      "signature": "(message?: any) => (value: any) => any"
+    },
+    "quick.Quick.validation.IBANNumOnly": {
+      "signature": "(message?: any) => (value: any) => any"
+    },
+    "quick.Quick.validation.regex": {
+      "description": "Validates that a value matches a specified regular expression.",
+      "params": [
+        {
+          "name": "regexVal",
+          "type": "any",
+          "description": "The regular expression to match against."
+        },
+        {
+          "name": "message",
+          "type": "any",
+          "description": "Custom error message for validation failure."
+        }
+      ],
+      "returns": "Validation function for regular expressions.",
+      "signature": "(regexVal: any, message?: any) => (value: any) => any"
+    },
+    "quick.Quick.validation.tckn": {
+      "description": "Validates that a value is a valid Turkish Identification Number (TCKN).",
+      "params": [
+        {
+          "name": "message",
+          "type": "any",
+          "description": "Custom error message for validation failure."
+        }
+      ],
+      "returns": "Validation function for TCKN.",
+      "signature": "(message?: any) => (value: any) => any"
+    },
+    "quick.Quick.validation.vkn": {
+      "description": "Validates that a value is a valid Tax Identification Number (VKN).",
+      "params": [
+        {
+          "name": "message",
+          "type": "any",
+          "description": "Custom error message for validation failure."
+        }
+      ],
+      "returns": "Validation function for VKN.",
+      "signature": "(message?: any) => (value: any) => any"
+    },
+    "quick.Quick.validate": {
+      "description": "Validates a component and all its child inputs.",
+      "params": [
+        {
+          "name": "compEID",
+          "description": "The ID of the component to validate, which may be an input or a container with inputs."
+        },
+        {
+          "name": "displayAlertBox",
+          "description": "If true, calls the alert function in UI configuration (or default alert function) and shows an alert box on validation failure."
+        },
+        {
+          "name": "unusedParameter",
+          "description": "This parameter is unused."
+        },
+        {
+          "name": "options",
+          "description": "Options for validation."
+        },
+        {
+          "name": "options.skipChildrenIfInvisible",
+          "description": "Validation will be skipped for the input component if its parent component is not visible."
+        }
+      ],
+      "returns": "Returns true if validation is successful; otherwise, returns undefined.",
+      "example": "const validationResult = quick.Quick.validate('exampleComponent', true, true);\nvalidationResult ? quick.EM.trace(\"Validation Success\") : quick.EM.trace(\"Validation Failed\");",
+      "signature": "(compEID: string, displayAlertBox: boolean, unusedParameter?: boolean, options?: { skipChildrenIfInvisible?: boolean }) => true | undefined"
+    },
+    "quick.Quick.validateAll": {
+      "description": "Validates all registered inputs in the page.",
+      "params": [
+        {
+          "name": "displayAlertBox",
+          "description": "If true, calls the alert function in UI configuration (or default alert function) and shows an alert box on validation failure."
+        },
+        {
+          "name": "unusedParameter",
+          "description": "This parameter is unused."
+        },
+        {
+          "name": "options",
+          "description": "Options for validation."
+        },
+        {
+          "name": "options.skipChildrenIfInvisible",
+          "description": "Validation will be skipped for the input component if its parent component is not visible."
+        }
+      ],
+      "returns": "Returns true if all validations are successful; otherwise, returns undefined.",
+      "example": "const result = quick.Quick.validateAll()\nquick.EM.trace('isValidationSuccess: ' + result)",
+      "signature": "(displayAlertBox: boolean, unusedParameter?: boolean, options?: { skipChildrenIfInvisible?: boolean }) => true | undefined"
+    },
+    "quick.Quick.resetValidation": {
+      "description": "Only clears validations, it has no effect on other variables.",
+      "params": [
+        {
+          "name": "compEID",
+          "description": "The ID of the component to be reset."
+        }
+      ],
+      "example": "quick.Quick.resetValidation(\"myComponent\");",
+      "signature": "(compEID: string) => void"
+    },
+    "quick.Quick.reset": {
+      "description": "Ensures that the set values and validations of the components are cleared.",
+      "params": [
+        {
+          "name": "compEID",
+          "description": "The ID of the component to be reset."
+        }
+      ],
+      "example": "quick.Quick.reset(\"myComponent\");",
+      "signature": "(compEID: string, options?: { triggerChangeEvent?: boolean }) => void"
+    },
+    "quick.Quick.createComponent": {
+      "description": "Creates a new component based on the provided template component and inserts it into the page at a specified location.",
+      "params": [
+        {
+          "name": "options",
+          "description": "Configuration options for creating the new component."
+        },
+        {
+          "name": "options.templateCompQID",
+          "description": "The ID of the template component used for creating the new component."
+        },
+        {
+          "name": "options.newCompQID",
+          "description": "The ID to be assigned to the newly created component. Should be unique."
+        },
+        {
+          "name": "options.dataSource",
+          "description": "The data source to be used in the new component, accessible with the 'data' prefix in the template."
+        },
+        {
+          "name": "options.place",
+          "description": "='Default'] - The location where the new component should be placed relative to the template component."
+        },
+        {
+          "name": "options.placeQID",
+          "description": "The ID of the component relative to which the new component should be placed."
+        },
+        {
+          "name": "options.childName",
+          "description": "The name assigned to the child component, accessible as data.newData in the template."
+        }
+      ],
+      "returns": "Returns the newly created component if successful; otherwise, returns undefined or null.",
+      "example": "let createdComp = quick.Quick.createComponent(\ntemplateCompQID: 'EdtrComp_1',\nnewCompQID: 'uniqueValue',\ndataSource: { name: 'Test Comp Name', id: [{ test: 'object' }] },\nplace: 'Before',\nplaceQID: 'EdtrComp_2'\n});",
+      "signature": "({ templateCompQID, newCompQID, dataSource, place, placeQID, childName }: { templateCompQID: string; newCompQID: string; dataSource?: any; place?: ElementLocation; placeQID?: string; childName?: string; reverseLook?: boolean }) => IComponent | undefined | null"
+    },
+    "quick.Quick.findCreateComponentRelative": {
+      "description": "Finds the desired dynamic component created with a template by giving a child component inside that dynamically created component.",
+      "params": [
+        {
+          "name": "sourceComp",
+          "description": "The instance of the child component used to search for the desired dynamic component."
+        },
+        {
+          "name": "targetCompID",
+          "description": "The ID of the component template used for creating the desired dynamic component."
+        }
+      ],
+      "returns": "Returns the instance of the desired dynamic component if found; otherwise, returns undefined.",
+      "example": "const component = quick.Quick.findCreateComponentRelative(quick.this, 'tmpCrsItemLatePayment');",
+      "signature": "(sourceComp: IComponent, targetCompID: string) => IComponent | undefined"
+    },
+    "quick.Quick.createChildren": {
+      "description": "Creates a child component based on the provided template child name and inserts it into the specified parent component.",
+      "params": [
+        {
+          "name": "options",
+          "description": "Configuration options for creating the child component."
+        },
+        {
+          "name": "options.parentCompQId",
+          "description": "The Quick ID of the parent component where the child component will be inserted."
+        },
+        {
+          "name": "options.templateChildName",
+          "description": "The name of the template child component used for creating the new child component."
+        },
+        {
+          "name": "options.newChildName",
+          "description": "The optional new name to be assigned to the created child component."
+        }
+      ],
+      "example": "quick.Quick.createChildren({ parentCompQId: 'parentComponent', templateChildName: 'templateChildComponent', newChildName: 'newChildComponent' });",
+      "signature": "({ parentCompQId, templateChildName, newChildName, }: { parentCompQId: string; templateChildName: string; newChildName?: string; }) => void"
+    },
+    "quick.Quick.deleteComponent": {
+      "description": "Deletes a component or DOM element from the page. Also deletes all child components and breaks the connection with the parent component if applicable.",
+      "params": [
+        {
+          "name": "componentInstance",
+          "description": "The instance of the component or DOM element to be deleted."
+        }
+      ],
+      "example": "const componentInstance = quick.Quick.findCreateComponentRelative(quick.this, 'templateComponent');\nquick.Quick.deleteComponent(componentInstance);\n// Or delete a DOM element directly:\nconst domElement = document.getElementById('exampleElement');\nquick.Quick.deleteComponent(domElement);",
+      "signature": "(componentInstance: IComponent | IDomElement) => void"
+    },
+    "quick.Quick.bind": {
+      "description": "Declares legacy store dependencies for the provided fields.",
+      "params": [
+        {
+          "name": "options",
+          "description": "Configuration options for declaring store dependencies."
+        },
+        {
+          "name": "options.bindedObject",
+          "description": "The identifier for the object to be bound (e.g., \"page\", \"bag\", \"global\")."
+        },
+        {
+          "name": "options.fields",
+          "description": "An array of field names or an object specifying the fields to be bound."
+        }
+      ],
+      "example": "// Declare the method in the PreRender stage and store the bound object.\n// Specify the bound fields as a string array in the second parameter.\nquick.Quick.bind({ bindedObject: \"store\", fields: [\"testField\"] });",
+      "deprecated": true,
+      "signature": "({ bindedObject, fields, }: { bindedObject: string | undefined; fields: Array<string> | object | undefined; }) => void"
+    },
+    "quick.Quick.setLanguage": {
+      "description": "Sets the system language to given parameter if you add it beforehand in the localization file.",
+      "params": [
+        {
+          "name": "LRType",
+          "description": "The language type to set for the system."
+        }
+      ],
+      "returns": "Returns a Promise if the language setting is asynchronous; otherwise, returns undefined.",
+      "example": "quick.Quick.setLanguage(\"en-US\");",
+      "signature": "(LRType: string) => Promise<void> | undefined"
+    },
+    "quick.Quick.getLanguage": {
+      "description": "Retrieves the currently set system language.",
+      "returns": "Returns the currently set system language as a string.",
+      "example": "const currentLanguage = quick.Quick.getLanguage();",
+      "signature": "() => string"
+    },
+    "quick.Quick.copyToClipboard": {
+      "description": "Allows copying a specified value to the clipboard.",
+      "params": [
+        {
+          "name": "value",
+          "description": "A value to be store to the clipboard"
+        }
+      ],
+      "example": "quick.Quick.copyToClipboard(components.VTextField.qValue);",
+      "optional": true,
+      "signature": "(value: string) => void"
+    },
+    "quick.Quick.updateComponent": {
+      "description": "Updates a component using its instance. The instance of the component must be given as a parameter.",
+      "params": [
+        {
+          "name": "Comp",
+          "description": "The instance of the component to be updated."
+        }
+      ],
+      "returns": "Returns the result of updating the component.",
+      "example": "const componentInstance = quick.Quick.findCreateComponentRelative(quick.this, 'templateComponent');\nquick.Quick.updateComponent(componentInstance);",
+      "signature": "(Comp?: IComponent) => any"
+    },
+    "quick.Quick.toLongDate": {
+      "description": "Takes the raw date value and converts it to a date format with month, day, year, hour and minute.",
+      "params": [
+        {
+          "name": "date",
+          "description": "The raw date value to be formatted."
+        },
+        {
+          "name": "formatType",
+          "description": "The format type for displaying the date."
+        }
+      ],
+      "returns": "The formatted long date string.",
+      "example": "const longDate = quick.Quick.toLongDate(new Date(), 'DD.MM.YYYY HH:mm')",
+      "signature": "(date: Date, formatType?: string) => string"
+    },
+    "quick.Quick.toShortDate": {
+      "description": "Converts a raw date value to a short date format with month, day, and year.",
+      "params": [
+        {
+          "name": "date",
+          "description": "The raw date value to be formatted."
+        },
+        {
+          "name": "formatType",
+          "description": "The format type for displaying the date."
+        }
+      ],
+      "returns": "The formatted short date string.",
+      "example": "const shortDate = quick.Quick.toShortDate(new Date(), 'DD.MM.YYYY');",
+      "signature": "(date: Date, formatType?: string) => string"
+    },
+    "quick.Quick.toLongTime": {
+      "description": "Converts a raw date value to a long time format with hour, minute, and second.",
+      "params": [
+        {
+          "name": "date",
+          "description": "The raw date value to be formatted."
+        },
+        {
+          "name": "formatType",
+          "description": "The format type for displaying the time."
+        }
+      ],
+      "returns": "The formatted long time string.",
+      "example": "const longTime = quick.Quick.toLongTime(new Date(), 'HH:mm:ss');",
+      "signature": "(date: Date, formatType?: string) => string"
+    },
+    "quick.Quick.toShortTime": {
+      "description": "Converts a raw date value to a short time format with hour and minute.",
+      "params": [
+        {
+          "name": "date",
+          "description": "The raw date value to be formatted."
+        },
+        {
+          "name": "formatType",
+          "description": "The format type for displaying the time."
+        }
+      ],
+      "returns": "The formatted short time string.",
+      "example": "const shortTime = quick.Quick.toShortTime(new Date(), 'HH:mm');",
+      "signature": "(date: Date, formatType?: string) => string"
+    },
+    "quick.Quick.toDate": {
+      "description": "Converts a string value to a Date object according to the given format type.",
+      "params": [
+        {
+          "name": "ateString",
+          "description": "The string value representing a date."
+        },
+        {
+          "name": "formatType",
+          "description": "The format type for parsing the date. If not provided, the format from the UI Settings File parameter 'displayDateFormat' is used. Default formatType is \"DDMMYYYY\"."
+        }
+      ],
+      "returns": "The Date object representing the parsed date.",
+      "example": "const dayInfo = quick.Quick.toDate(components.someComponent.qValue, \"YYYY-MM-DD\");",
+      "signature": "(dateString: string, formatType?: string) => Date"
+    },
+    "quick.Quick.dateFromNow": {
+      "description": "Calculates the time difference between a specified time and the present moment and returns a human-readable string.",
+      "params": [
+        {
+          "name": "dateString",
+          "description": "The string value representing a date."
+        },
+        {
+          "name": "formatType",
+          "description": "The format type for parsing the date. If not provided, the format from the UI Settings File parameter 'displayDateFormat' is used. Default formatType is \"DDMMYYYY\"."
+        }
+      ],
+      "returns": "A human-readable string representing the time difference.",
+      "example": "const fromNow1 = quick.Quick.dateFromNow(\"01032023\");",
+      "signature": "(dateString: string, formatType?: string) => string"
+    },
+    "quick.Quick.platform": {
+      "namespace": true
+    },
+    "quick.Quick.platform.isMobile": {
+      "description": "Returns whether the platform is a mobile platform (Android or iOS).",
+      "returns": "True if the platform is mobile (Android or iOS), false otherwise.",
+      "example": "const isMobile = quick.Quick.platform.isMobile();",
+      "signature": "() => boolean"
+    },
+    "quick.Quick.platform.isWeb": {
+      "description": "Returns whether the platform is a web browser.",
+      "returns": "True if the platform is a web browser, false otherwise.",
+      "example": "const isWeb = quick.Quick.platform.isWeb();",
+      "signature": "() => boolean"
+    },
+    "quick.Quick.platform.getPlatformType": {
+      "description": "Returns the current platform type.",
+      "returns": "The type of the current platform (\"iOS\" or \"Android\" or \"Web\").",
+      "example": "const platformType = quick.Quick.platform.getPlatformType();",
+      "signature": "() => PlatformType"
+    },
+    "quick.Quick.platform.getDeviceId": {
+      "description": "Returns the device ID that runs the application. It can be used in mobile devices.",
+      "returns": "The device ID as a string, or undefined if not available.",
+      "example": "const deviceId = quick.Quick.platform.getDeviceId();",
+      "signature": "() => string | undefined"
+    },
+    "quick.Quick.platform.getClientInfo": {
+      "signature": "() => IClientInfo | undefined"
+    },
+    "quick.Quick.getCurrentPosition": {
+      "description": "Retrieves the current geographical position of the device.",
+      "returns": "A Promise that resolves to the current location position, or undefined if the position cannot be determined.",
+      "example": "const location = await quick.Quick.getCurrentPosition();",
+      "signature": "() => Promise<ILocationPosition> | undefined"
+    },
+    "quick.Quick.toMoney": {
+      "description": "Converts a number or numeric string to a money-formatted string.",
+      "params": [
+        {
+          "name": "number",
+          "description": "The number or numeric string to be formatted."
+        },
+        {
+          "name": "formatType",
+          "description": "The locale or BCP 47 language tag specifying the formatting rules."
+        },
+        {
+          "name": "opt",
+          "type": "Intl.NumberFormatOptions",
+          "description": "An object with options for formatting the number."
+        },
+        {
+          "name": "bigDecimal",
+          "description": "A boolean indicating whether to treat the input as a BigDecimal (true) or a regular number (false)."
+        }
+      ],
+      "returns": "The money-formatted string.",
+      "example": "const num = Number.parseFloat('49546.3900');\nconst money = quick.Quick.toMoney(num);\n// money output: '49.546,39'\nquick.Quick.toMoney(555, 'tr-TR', { minimumFractionDigits: 2 });\n// Output is '555,00'\nquick.Quick.toMoney('97888888888888.48', undefined, undefined, true);\n// Output is '97,888,888,888,888.48'",
+      "signature": "(number: Number | string, formatType?: string, opt?: Intl.NumberFormatOptions, bigDecimal?: boolean) => string"
+    },
+    "quick.Quick.toDecimal": {
+      "description": "Converts a formatted string to its raw decimal value.",
+      "params": [
+        {
+          "name": "value",
+          "description": "The formatted string to be converted."
+        },
+        {
+          "name": "radixPoint",
+          "description": "The symbol used as the radix point for the decimal value. If not provided, the value from the Settings File parameter 'radixPoint' is used."
+        }
+      ],
+      "returns": "The raw decimal value.",
+      "example": "const decimalValue1 = quick.Quick.toDecimal(\"123.456.789,23 TL\");\n// Settings File => radixPoint: ','\n// decimalValue1 output: 123456789.23",
+      "signature": "(value: string, radixPoint?: string) => number"
+    },
+    "quick.Quick.toBigNumber": {
+      "signature": "(value: string) => Bignumber"
+    },
+    "quick.Quick.dm": {
+      "signature": "object"
+    },
+    "quick.Quick.getEditor": {
+      "signature": "() => IEditorInstance | undefined"
+    },
+    "quick.Quick.alert": {
+      "description": "Displays an alert component with the specified configuration.",
+      "params": [
+        {
+          "name": "options",
+          "description": "Configuration options for the alert."
+        },
+        {
+          "name": "options.title",
+          "description": "The title of the alert."
+        },
+        {
+          "name": "options.text",
+          "description": "The main text content of the alert."
+        },
+        {
+          "name": "options.category",
+          "description": "The category of the alert (Warning, Info, Success, Error)."
+        },
+        {
+          "name": "options.actionButtons",
+          "description": "An array of action buttons with names, types, and click event names."
+        },
+        {
+          "name": "options.error",
+          "description": "Details about an error, if applicable."
+        },
+        {
+          "name": "options.error.errorMessage",
+          "description": "The error message."
+        },
+        {
+          "name": "options.error.errorCode",
+          "description": "The error code."
+        },
+        {
+          "name": "options.error.errorSource",
+          "description": "The source of the error (Page, Network, Validation)."
+        },
+        {
+          "name": "options.additionals",
+          "description": "Additional options for customization."
+        },
+        {
+          "name": "options.additionals.props",
+          "description": "Additional props to be passed to the alert component."
+        },
+        {
+          "name": "options.additionals.events",
+          "description": "Additional events to be handled by the alert component."
+        }
+      ],
+      "example": "quick.Quick.alert({\ntext: 'Are you sure you want to delete the record?',\ncategory: 'Warning',\nactionButtons: [\n{ name: 'Confirm', type: 'Confirm', clickEventName: 'onConfirmTask' },\n{ name: 'Cancel', type: 'Cancel', clickEventName: 'onCancelTask' }\n],\nadditionals: {\nprops: { isPersistent: true },\nevents: {}\n}\n});",
+      "optional": true,
+      "signature": "(options: { title?: string | undefined; text?: string | undefined; category?: keyof typeof AlertType | undefined; actionButtons?: IActionButton[] | undefined; error?: | { errorMessage?: string | undefined; errorCode?: string | undefined; errorSource?: keyof typeof ErrorSource | undefined; } | undefined; additionals?: { props?: any; events?: any } | undefined; }) => void"
+    },
+    "quick.Quick.host": {
+      "namespace": true
+    },
+    "quick.Quick.host.trigger": {
+      "description": "⚠️❗️**Use quick.container instead of quick.Quick.host.trigger.** **See Container Configuration documentation:** **https://docs.onplateau.com/UI-Screens/UI-Settings/container-configuration**",
+      "deprecated": true,
+      "signature": "(functionName: string, params: Record<string, any>) => Promise<IHostResponseData> | undefined"
+    },
+    "quick.Quick.isEditMode": {
+      "signature": "boolean"
+    },
+    "quick.Quick.getComponentIdByInstance": {
+      "description": "Retrieves the ID of a component based on its instance.",
+      "params": [
+        {
+          "name": "componentInstance",
+          "description": "The instance of the component."
+        }
+      ],
+      "returns": "The ID of the component, or undefined if the ID cannot be determined.",
+      "example": "quick.Quick.getComponentIdByInstance(sourceComp: ComponentInstance);",
+      "signature": "(componentInstance: IComponent) => string | undefined"
+    },
+    "quick.Quick.yamlLogType": {
+      "signature": "any"
+    },
+    "quick.Quick.loading": {
+      "description": "Methods for managing loading indicators, including showing and hiding the loading state.",
+      "example": "quick.Quick.loading.show();\nquick.Quick.loading.hide();",
+      "namespace": true
+    },
+    "quick.Quick.loading.show": {
+      "description": "Displays the loading indicator.",
+      "signature": "() => void"
+    },
+    "quick.Quick.loading.hide": {
+      "description": "Hides the loading indicator.",
+      "signature": "() => void"
+    },
+    "quick.Quick.network": {
+      "namespace": true
+    },
+    "quick.Quick.network.isConnected": {
+      "description": "Determines the online/offline status of the network.",
+      "returns": "The online/offline status of the network.",
+      "signature": "boolean"
+    },
+    "quick.Quick.render": {
+      "namespace": true
+    },
+    "quick.Quick.render.block": {
+      "description": "Blocks rendering operations.",
+      "signature": "(): void"
+    },
+    "quick.Quick.render.resume": {
+      "description": "Resumes rendering operations.",
+      "signature": "(): void"
+    },
+    "quick.Quick.authentication": {
+      "namespace": true
+    },
+    "quick.Quick.authentication.getIamToken": {
+      "description": "Retrieves IAM token.",
+      "returns": "IAM token or undefined.",
+      "signature": "() => Promise<string | undefined> | undefined"
+    },
+    "quick.Quick.config": {
+      "namespace": true
+    },
+    "quick.Quick.config.get": {
+      "signature": "(key: string) => any | undefined"
+    },
+    "quick.containerServices": {
+      "optional": true,
+      "namespace": true
+    },
+    "quick.containerServices.extensions": {
+      "optional": true,
+      "signature": "Record<string, any>"
+    },
+    "quick.store": {
+      "namespace": true
+    },
+    "quick.store.set": {
+      "description": "Sets a value to the store.",
+      "params": [
+        {
+          "name": "name",
+          "description": "Key or name under which the data will be stored within the specified store context. Could have one of the prefixes: SharedStoreContext(&), GlobalStoreContext($), BagStoreContext(#), PageStoreContext(default)."
+        },
+        {
+          "name": "value",
+          "description": "Actual data to be stored."
+        }
+      ],
+      "example": "quick.store.set('someData', somedata);\nquick.store.set('#someData', somedata);\nquick.store.set('$someData', somedata);",
+      "signature": "(name: string, value: any) => void"
+    },
+    "quick.store.get": {
+      "description": "Gets a value from the store.",
+      "params": [
+        {
+          "name": "name",
+          "description": "Key or name under which the data will be retrieved from the specified store context. Could have one of the prefixes: SharedStoreContext(&), GlobalStoreContext($), BagStoreContext(#), PageStoreContext(default)."
+        }
+      ],
+      "returns": "Returns the value associated with the 'name' key in the stored object.",
+      "example": "quick.store.get('someData', somedata);\nquick.store.get('#someData', somedata);\nquick.store.get('$someData', somedata);",
+      "signature": "(name: any) => any"
+    },
+    "quick.store.getAll": {
+      "description": "Gets all values from the store.",
+      "params": [
+        {
+          "name": "name",
+          "description": "Key or name under which the data will be retrieved from every store context."
+        }
+      ],
+      "returns": "Returns all the value associated with the 'name' key in the stored object.",
+      "signature": "(name: any) => any"
+    },
+    "quick.store.delete": {
+      "description": "Deletes a value from the store.",
+      "params": [
+        {
+          "name": "name",
+          "description": "Key or name under which the data will be deleted from the specified store context. Could have one of the prefixes: SharedStoreContext(&), GlobalStoreContext($), BagStoreContext(#), PageStoreContext(default)."
+        }
+      ],
+      "example": "quick.store.delete('someData');\nquick.store.delete('#someData');\nquick.store.delete('$someData');",
+      "signature": "(name: any) => void"
+    },
+    "quick.store.deleteAll": {
+      "description": "Deletes all values from the store.",
+      "params": [
+        {
+          "name": "name",
+          "description": "Key or name under which the data will be deleted from every store context."
+        }
+      ],
+      "signature": "(name: any) => void"
+    },
+    "quick.permanentStore": {
+      "namespace": true
+    },
+    "quick.permanentStore.set": {
+      "description": "Sets a key-value pair object to the Permanent Store.",
+      "params": [
+        {
+          "name": "object",
+          "type": "IPermanentStoreObject",
+          "description": "The key-value pair object which will be stored within the permanent store."
+        },
+        {
+          "name": "object.key",
+          "type": "string",
+          "description": "Key under which the data will be stored within the permanent store."
+        },
+        {
+          "name": "object.value",
+          "type": "any",
+          "description": "Actual data to be stored."
+        }
+      ],
+      "example": "quick.permanentStore.set({ key: 'employeeInfo', value: [{ name: 'Ahmet', age: 32 }, { name: 'Mehmet', age: 45 }] });",
+      "signature": "<T>(object: IPermanentStoreObject<T>) => void"
+    },
+    "quick.permanentStore.get": {
+      "description": "Gets a key-value pair object from the Permanent Store.",
+      "params": [
+        {
+          "name": "key",
+          "type": "string",
+          "description": "Key under which the data will be retrieved from the permanent store."
+        }
+      ],
+      "returns": "Returns the key-value pair object associated with the 'key' in the permanent stored object.",
+      "example": "await quick.permanentStore.get(\"employeeInfo\");",
+      "signature": "<T>(key: string) => Promise<IPermanentStoreObject<T> | undefined>"
+    },
+    "quick.permanentStore.delete": {
+      "description": "Deletes a key-value pair object associated with the 'key' in the permanent store .",
+      "params": [
+        {
+          "name": "key",
+          "type": "string",
+          "description": "Key under which the data will be deleted from the permanent store."
+        }
+      ],
+      "example": "quick.permanentStore.delete(\"employeeInfo\");",
+      "signature": "(key: string) => Promise<void | undefined>"
+    },
+    "quick.permanentStore.getAll": {
+      "description": "Gets all key-value pair objects from the permanent store.",
+      "returns": "Returns all the key-value pair object list associated in the permanent store.",
+      "example": "await quick.permanentStore.getAll();",
+      "signature": "<T>() => Promise<IPermanentStoreObject<T>[] | undefined>"
+    },
+    "quick.permanentStore.createOrChangeStore": {
+      "description": "Provide the permanent store name that application will use.",
+      "example": "quick.permanentStore.createOrChangeStore(\"myStore\");",
+      "signature": "(storeName: string | undefined) => Promise<void>"
+    },
+    "quick.permanentStore.deleteStore": {
+      "description": "Deletes the Permanent Store.",
+      "example": "quick.permanentStore.deleteStore(\"myStore\");",
+      "signature": "(storeName: string | undefined) => Promise<void>"
+    },
+    "quick.permanentStore.defaultStoreName": {
+      "signature": "typeof Plateau_UI_PermanentStore_Name"
+    },
+    "quick.permanentStore.currentStoreName": {
+      "signature": "string"
+    },
+    "quick.cookie": {
+      "namespace": true
+    },
+    "quick.cookie.set": {
+      "description": "Sets a cookie with the provided key and cookie value.",
+      "params": [
+        {
+          "name": "key",
+          "description": "The key for the cookie."
+        },
+        {
+          "name": "cookieValue",
+          "description": "The value to be set for the cookie."
+        }
+      ],
+      "example": "quick.cookie.set('test', { value : 'testValue', expire : '2022-11-01T20:09:39.780Z'})",
+      "signature": "(key: string, cookieValue: ICookieValue) => void"
+    },
+    "quick.cookie.get": {
+      "description": "Gets the value of the cookie associated with the provided key.",
+      "params": [
+        {
+          "name": "key",
+          "description": "The key of the cookie to retrieve."
+        }
+      ],
+      "returns": "Returns the value of the cookie or undefined if not found.",
+      "example": "const myCookieValue = quick.cookie.get('myCookieKey');",
+      "signature": "(key: string) => string | undefined"
+    },
+    "quick.cookie.getAll": {
+      "description": "Gets all cookies as key-value pairs.",
+      "returns": "Returns all cookies as key-value pairs.",
+      "example": "const allCookies = quick.cookie.getAll();",
+      "signature": "() => Record<string, string>"
+    },
+    "quick.cookie.delete": {
+      "description": "Deletes the cookie associated with the provided key.",
+      "params": [
+        {
+          "name": "key",
+          "description": "The key of the cookie to delete."
+        }
+      ],
+      "example": "quick.cookie.delete('myCookieKey');",
+      "signature": "(key: string) => void"
+    },
+    "quick.localStorage": {
+      "namespace": true
+    },
+    "quick.localStorage.set": {
+      "description": "Sets a value in the local storage with the provided key.",
+      "params": [
+        {
+          "name": "key",
+          "description": "The key for the local storage."
+        },
+        {
+          "name": "value",
+          "description": "The value to be set in the local storage."
+        }
+      ],
+      "example": "quick.localStorage.set('myKey', 'myValue');",
+      "signature": "(key: string, value: string) => void"
+    },
+    "quick.localStorage.get": {
+      "description": "Gets the value from the local storage associated with the provided key.",
+      "params": [
+        {
+          "name": "key",
+          "description": "The key of the local storage to retrieve."
+        }
+      ],
+      "returns": "Returns the value of the local storage or null if not found.",
+      "example": "const myValue = quick.localStorage.get('myKey');",
+      "signature": "(key: string) => string | null"
+    },
+    "quick.localStorage.clear": {
+      "description": "Clears all values from the local storage.",
+      "example": "quick.localStorage.clear();",
+      "signature": "() => void"
+    },
+    "quick.localStorage.delete": {
+      "description": "Deletes the value from the local storage associated with the provided key.",
+      "params": [
+        {
+          "name": "key",
+          "description": "The key of the local storage to delete."
+        }
+      ],
+      "example": "quick.localStorage.delete('myKey');",
+      "signature": "(key: string) => void"
+    },
+    "quick.encryptedStorage": {
+      "namespace": true
+    },
+    "quick.encryptedStorage.set": {
+      "description": "Only uses for Mobile Apps. For IOS sets a value in the ios Keychain with the provided key. For Anroid sets a value in the Anroid EncryptedSharedPreferences with the provided key.",
+      "params": [
+        {
+          "name": "key",
+          "description": "The key for the storage."
+        },
+        {
+          "name": "value",
+          "description": "The value to be set in the storage."
+        }
+      ],
+      "example": "quick.encryptedStorage.set('myKey', 'myValue');",
+      "signature": "(key: string, value: string) => void"
+    },
+    "quick.encryptedStorage.get": {
+      "description": "Only uses for Mobile Apps. For IOS, gets the value from the ios Keychain associated with the provided key. For Anroid, gets the value from the Anroid EncryptedSharedPreferences associated with the provided key.",
+      "params": [
+        {
+          "name": "key",
+          "description": "The key of the storage to retrieve."
+        }
+      ],
+      "returns": "Returns the value of the storage or null if not found.",
+      "example": "const myValue = quick.encryptedStorage.get('myKey');",
+      "signature": "(key: string) => string | null"
+    },
+    "quick.encryptedStorage.clear": {
+      "description": "Only uses for Mobile Apps. For IOS, clears all values from the ios Keychain. For Anroid, clears all values from the Anroid EncryptedSharedPreferences.",
+      "example": "quick.encryptedStorage.clear();",
+      "signature": "() => void"
+    },
+    "quick.encryptedStorage.delete": {
+      "description": "Only uses for Mobile Apps. For IOS, deletes the value from the ios Keychain associated with the provided key. For Anroid, deletes the value from the Anroid EncryptedSharedPreferences associated with the provided key.",
+      "params": [
+        {
+          "name": "key",
+          "description": "The key of the storage to delete."
+        }
+      ],
+      "example": "quick.encryptedStorage.delete('myKey');",
+      "signature": "(key: string) => void"
+    },
+    "quick.Url": {
+      "namespace": true
+    },
+    "quick.Url.resolve": {
+      "signature": "({ url }: { url: string }) => string"
+    },
+    "quick.Url.getDeepLinkParams": {
+      "optional": true,
+      "signature": "() => Record<string, string | undefined>"
+    },
+    "quick.this": {
+      "signature": "IComponent | null | undefined"
+    },
+    "quick.parent": {
+      "namespace": true
+    },
+    "quick.parent.props": {
+      "description": "Properties defined in Messaging P: ExternalProps",
+      "signature": "Record<string, any> | undefined"
+    },
+    "quick.parent.events": {
+      "description": "Events defined in Messaging P: ExternalEvents",
+      "signature": "Record<string, Function> | undefined"
+    },
+    "quick.process": {
+      "optional": true,
+      "namespace": true
+    },
+    "quick.process.getMetadata": {
+      "description": "Gets the metadata.",
+      "returns": "The metadata.",
+      "example": "const metadata = quick.process.getMetadata();",
+      "signature": "() => any"
+    },
+    "quick.process.setMetadata": {
+      "description": "Sets the metadata.",
+      "params": [
+        {
+          "name": "options",
+          "description": "Options for setting metadata."
+        },
+        {
+          "name": "options.Metadata",
+          "description": "The metadata to be set."
+        }
+      ],
+      "example": "quick.process.setMetadata({\nMetadata: { key1: 'value1', key2: 'value2' }\n});",
+      "signature": "({ Metadata }: { Metadata: any }) => void"
+    },
+    "quick.process.changeProcessMetadata": {
+      "description": "Changes the process metadata.",
+      "params": [
+        {
+          "name": "key",
+          "description": "The key of the metadata to change."
+        },
+        {
+          "name": "onSuccess",
+          "description": "The event name to trigger on success."
+        }
+      ],
+      "example": "quick.process.changeProcessMetadata('someKey', 'onSuccessEvent');",
+      "optional": true,
+      "signature": "( key: string | undefined, onSuccess: string | undefined ) => void"
+    },
+    "quick.return": {
+      "description": "Returns a value from the current event (stops execution and returns).",
+      "params": [
+        {
+          "name": "retVal",
+          "description": "The value to return."
+        }
+      ],
+      "signature": "(retVal: any) => void"
+    },
+    "quick.await": {
+      "signature": "(retVal: any) => void"
+    },
+    "quick.currentPage": {
+      "namespace": true
+    },
+    "quick.currentPage.isRenderCompleted": {
+      "description": "Checks if the rendering process has been completed.",
+      "returns": "Returns true if the rendering process is completed; otherwise, returns false.",
+      "example": "const renderCompleted = quick.currentPage.isRenderCompleted();",
+      "signature": "() => boolean"
+    },
+    "quick.cryptography": {
+      "namespace": true
+    },
+    "quick.cryptography.hash": {
+      "description": "Hashing transforms specific data into a hash value using a chosen hashing algorithm.",
+      "params": [
+        {
+          "name": "data",
+          "type": "IHashDataRequest",
+          "description": "The hash data request"
+        },
+        {
+          "name": "data.data",
+          "type": "string",
+          "description": "The data to be hashed"
+        },
+        {
+          "name": "data.algorithm",
+          "type": "HashAlgorithm",
+          "description": "The hashing algorithm to use. HashAlgorithm for Web { SHA1, SHA256, SHA384, SHA512 }, HashAlgorithm for Mobile { SHA256, SHA384, SHA512 }"
+        }
+      ],
+      "returns": "Returns the hashedData.",
+      "example": "let hashResponse = await quick.cryptography.hash(hashRequest);",
+      "signature": "( data: IHashDataRequest ): Promise<IHashDataResponse | undefined>"
+    },
+    "quick.cryptography.encrypt": {
+      "description": "Encrypts a specific data using the specified encryption algorithm.",
+      "params": [
+        {
+          "name": "data",
+          "type": "IEncryptDataRequest",
+          "description": "The Encrypt data request"
+        },
+        {
+          "name": "data.data",
+          "type": "string",
+          "description": "The data to be encrypted"
+        },
+        {
+          "name": "data.key",
+          "type": "string",
+          "description": "The encryption key"
+        },
+        {
+          "name": "data.algorithm",
+          "type": "EncryptionAlgorithm",
+          "description": "Specifies which encryption algorithm to use. EncryptionAlgorithm for Web { RSAOAEP, AESCTR, AESCBC, AESGCM }, EncryptionAlgorithm for Mobile { RSAOAEP, AESGCM }"
+        }
+      ],
+      "returns": "Returns the encryptedData.",
+      "example": "let responseEncrypt = await quick.cryptography.encrypt(requestEncrypt);",
+      "signature": "( data: IEncryptDataRequest ): Promise<IEncryptDataResponse | undefined>"
+    },
+    "quick.cryptography.decrypt": {
+      "description": "Decryption is the process of converting encrypted data back to its original, readable form.",
+      "params": [
+        {
+          "name": "data",
+          "type": "IDecryptDataRequest ",
+          "description": "The Decrypt data request"
+        },
+        {
+          "name": "data.encryptedData",
+          "type": "string",
+          "description": "The encrypted data"
+        },
+        {
+          "name": "data.iv",
+          "type": "string",
+          "description": "The initialization vector used during encryption. ( If algorithm is \"RSAOAEP\", then iv is not used, otherwise it is required. )"
+        },
+        {
+          "name": "data.key",
+          "type": "string",
+          "description": "The encryption key"
+        },
+        {
+          "name": "data.algorithm",
+          "type": "EncryptionAlgorithm",
+          "description": "Specifies which encryption algorithm to use. EncryptionAlgorithm for Web { RSAOAEP, AESCTR, AESCBC, AESGCM }, EncryptionAlgorithm for Mobile { RSAOAEP, AESGCM }"
+        }
+      ],
+      "returns": "Returns the encryptedData.",
+      "example": "let responseDecrypt = await quick.cryptography.decrypt(requestDecrypt);",
+      "signature": "( data: IDecryptDataRequest ): Promise<IDecryptDataResponse | undefined>"
+    },
+    "quick.encoding": {
+      "namespace": true
+    },
+    "quick.encoding.atob": {
+      "description": "Transforms binary data into a text format to facilitate storage or transmission.",
+      "params": [
+        {
+          "name": "encodedString",
+          "description": "The encoded string to be decoded."
+        }
+      ],
+      "example": "quick.encoding.atob(encodedString);",
+      "signature": "(encodedString: string) => string"
+    },
+    "quick.encoding.btoa": {
+      "description": "Transforms Base64-encoded data back into its original binary form.",
+      "params": [
+        {
+          "name": "stringToEncode",
+          "description": "The string to be converted to binary form."
+        }
+      ],
+      "example": "quick.encoding.btoa(stringToEncode);",
+      "signature": "(stringToEncode: string) => string"
+    },
+    "quick.workflowStore": {
+      "optional": true,
+      "namespace": true
+    },
+    "quick.workflowStore.context": {
+      "namespace": true
+    },
+    "quick.workflowStore.context.dataInstance": {
+      "signature": "any"
+    },
+    "quick.workflowStore.context.processInstance": {
+      "signature": "any"
+    },
+    "quick.workflowStore.formContext": {
+      "namespace": true
+    },
+    "quick.workflowStore.formContext.task": {
+      "signature": "any"
+    },
+    "quick.workflowStore.formContext.form": {
+      "signature": "any"
+    },
+    "quick.workflowStore.formContext.swimlanes": {
+      "signature": "Record<string, string>"
+    },
+    "quick.workflow": {
+      "optional": true,
+      "namespace": true
+    },
+    "quick.workflow.RunFunction": {
+      "signature": "({ flowId, input, dataInstance, consumer, externalConsumerProps }: { flowId: string, input?: Record<string, any>, dataInstance?: Record<string, any>, consumer?: \"ui\" | \"externalWithProcess\" | \"externalWithoutProcess\", externalConsumerProps?: {processInstanceId: string, appId: string, userId: string} }) => Promise<{ output: Record<string, any> }>"
+    },
+    "quick.workflow.Commit": {
+      "signature": "() => Promise<void>"
+    },
+    "quick.RunBefunc": {
+      "description": "!!! DON'T CHANGE",
+      "optional": true,
+      "signature": "({ befuncId, input }: { befuncId: string, input?: Record<string, any> }) => Promise<{ output: Record<string, any> }>"
+    },
+    "quick.getConstant": {
+      "signature": "(constantId: string) => Promise<string | undefined>"
+    },
+    "quick.container": {
+      "signature": "{}"
+    },
+    "quick.Math": {
+      "context": "QScript only (drop the `quick.` prefix when calling)",
+      "namespace": true
+    },
+    "quick.Math.floor": {
+      "description": "Rounds a number down to the nearest integer.",
+      "params": [
+        {
+          "name": "x",
+          "description": "The number to round down."
+        }
+      ],
+      "returns": "The rounded-down integer.",
+      "signature": "(x: number) => number",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Math.random": {
+      "description": "Generates a random number between the specified minimum (inclusive) and maximum (exclusive) values.",
+      "params": [
+        {
+          "name": "min",
+          "description": "The minimum value (inclusive)."
+        },
+        {
+          "name": "max",
+          "description": "The maximum value (exclusive)."
+        }
+      ],
+      "returns": "The generated random number.",
+      "signature": "(min: number, max: number) => number",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Math.findIndex": {
+      "description": "Finds the index of an object in an array based on the specified key and search string.",
+      "params": [
+        {
+          "name": "array",
+          "description": "The array to search."
+        },
+        {
+          "name": "searchKey",
+          "description": "The key to search in the objects."
+        },
+        {
+          "name": "searchString",
+          "description": "The string to search for."
+        }
+      ],
+      "returns": "The index of the found object, or -1 if not found.",
+      "signature": "(array: Object[], searchKey: string, seacrhString: string) => number",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Math.round": {
+      "description": "Rounds a number to the specified number of decimal places.",
+      "params": [
+        {
+          "name": "roundNumber",
+          "description": "The number to round."
+        },
+        {
+          "name": "indexToSplit",
+          "description": "The number of decimal places."
+        }
+      ],
+      "returns": "The rounded number.",
+      "signature": "(roundNumber: number, indexToSplit: number): number",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.regex": {
+      "signature": "(value: string) => RegExp",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.typeOf": {
+      "signature": "( value: any ) => | \"string\" | \"number\" | \"bigint\" | \"boolean\" | \"symbol\" | \"undefined\" | \"object\" | \"function\"",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Date": {
+      "context": "QScript only (drop the `quick.` prefix when calling)",
+      "namespace": true
+    },
+    "quick.Date.parse": {
+      "signature": "(value: string | number, month: number | null) => Date",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Date.now": {
+      "signature": "() => Date",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Date.time": {
+      "signature": "() => number",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Date.compare": {
+      "signature": "(first: string | Date, second: string | Date) => boolean | \"Equal\"",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Date.getTimezoneOffset": {
+      "signature": "(date: Date) => number",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Date.ISOString": {
+      "signature": "() => string",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Date.differenceInDays": {
+      "signature": "(first: Date, second: Date): number",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Date.differenceInMonths": {
+      "signature": "(first: Date, second: Date): number",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Number": {
+      "context": "QScript only (drop the `quick.` prefix when calling)",
+      "namespace": true
+    },
+    "quick.Number.parse": {
+      "signature": "(value: string) => number",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Number.parseFloat": {
+      "signature": "(value: string) => number",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Number.mod": {
+      "signature": "(firstValue: number, secondValue: number) => number",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.JSON": {
+      "context": "QScript only (drop the `quick.` prefix when calling)",
+      "namespace": true
+    },
+    "quick.JSON.parse": {
+      "signature": "(jsonString: string) => any",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.string": {
+      "context": "QScript only (drop the `quick.` prefix when calling)",
+      "namespace": true
+    },
+    "quick.string.space": {
+      "signature": "string",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.string.replace": {
+      "signature": "( string: string, searchValue: string, replaceValue: string ) => string",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.Object": {
+      "signature": "Object",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.js": {
+      "context": "QScript only (drop the `quick.` prefix when calling)",
+      "namespace": true
+    },
+    "quick.js.Object": {
+      "signature": "ObjectConstructor",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.js.String": {
+      "signature": "StringConstructor",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.js.Math": {
+      "signature": "Math",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.js.Date": {
+      "signature": "DateConstructor",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    },
+    "quick.js.Number": {
+      "signature": "NumberConstructor",
+      "context": "QScript only (drop the `quick.` prefix when calling)"
+    }
+  }
+}