├── .gitignore ├── LICENSE ├── README.md ├── docs ├── apex-nitro-ts-configuration.png ├── intellisense-atom.gif └── intellisense-code.gif ├── examples └── scratch.ts ├── package.json ├── tsconfig.json └── types └── orclapex-js ├── index.d.ts ├── orclapex-js-tests.ts ├── tsconfig.json └── tslint.json /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.gitignore.io/api/osx,node,linux,macos,windows 3 | 4 | ### Linux ### 5 | *~ 6 | 7 | # temporary files which can be created if a process still has a handle open of a deleted file 8 | .fuse_hidden* 9 | 10 | # KDE directory preferences 11 | .directory 12 | 13 | # Linux trash folder which might appear on any partition or disk 14 | .Trash-* 15 | 16 | # .nfs files are created when an open file is removed but is still being accessed 17 | .nfs* 18 | 19 | ### macOS ### 20 | *.DS_Store 21 | .AppleDouble 22 | .LSOverride 23 | 24 | # Icon must end with two \r 25 | Icon 26 | 27 | # Thumbnails 28 | ._* 29 | 30 | # Files that might appear in the root of a volume 31 | .DocumentRevisions-V100 32 | .fseventsd 33 | .Spotlight-V100 34 | .TemporaryItems 35 | .Trashes 36 | .VolumeIcon.icns 37 | .com.apple.timemachine.donotpresent 38 | 39 | # Directories potentially created on remote AFP share 40 | .AppleDB 41 | .AppleDesktop 42 | Network Trash Folder 43 | Temporary Items 44 | .apdisk 45 | 46 | ### Node ### 47 | # Logs 48 | logs 49 | *.log 50 | npm-debug.log* 51 | yarn-debug.log* 52 | yarn-error.log* 53 | 54 | # Runtime data 55 | pids 56 | *.pid 57 | *.seed 58 | *.pid.lock 59 | 60 | # Directory for instrumented libs generated by jscoverage/JSCover 61 | lib-cov 62 | 63 | # Coverage directory used by tools like istanbul 64 | coverage 65 | 66 | # nyc test coverage 67 | .nyc_output 68 | 69 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 70 | .grunt 71 | 72 | # Bower dependency directory (https://bower.io/) 73 | bower_components 74 | 75 | # node-waf configuration 76 | .lock-wscript 77 | 78 | # Compiled binary addons (http://nodejs.org/api/addons.html) 79 | build/Release 80 | 81 | # Dependency directories 82 | node_modules/ 83 | jspm_packages/ 84 | 85 | # Typescript v1 declaration files 86 | typings/ 87 | 88 | # Optional npm cache directory 89 | .npm 90 | 91 | # Optional eslint cache 92 | .eslintcache 93 | 94 | # Optional REPL history 95 | .node_repl_history 96 | 97 | # Output of 'npm pack' 98 | *.tgz 99 | 100 | # Yarn Integrity file 101 | .yarn-integrity 102 | 103 | # dotenv environment variables file 104 | .env 105 | 106 | 107 | ### OSX ### 108 | 109 | # Icon must end with two \r 110 | 111 | # Thumbnails 112 | 113 | # Files that might appear in the root of a volume 114 | 115 | # Directories potentially created on remote AFP share 116 | 117 | ### Windows ### 118 | # Windows thumbnail cache files 119 | Thumbs.db 120 | ehthumbs.db 121 | ehthumbs_vista.db 122 | 123 | # Folder config file 124 | Desktop.ini 125 | 126 | # Recycle Bin used on file shares 127 | $RECYCLE.BIN/ 128 | 129 | # Windows Installer files 130 | *.cab 131 | *.msi 132 | *.msm 133 | *.msp 134 | 135 | # Windows shortcuts 136 | *.lnk 137 | 138 | # End of https://www.gitignore.io/api/osx,node,linux,macos,windows 139 | 140 | build -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2017 Adrian Png 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 4 | 5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 6 | 7 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # TypeScript Definitions for Oracle Application Express JavaScript API 2 | ## Introduction 3 | [TypeScript](https://www.typescriptlang.org) is a superset of JavaScript that introduces modern JS features and strongly-typed declarations that can be used to help reduce coding errors. TypeScript Declaration Files capture these definitions about third-party JavaScript libraries and/or modules, and are then used by the compiler for error-checking. Intergrated Development Environments (IDEs) that support TypeScript further enhance the developer experience by introducing features like error-highlighting and intellisense. 4 | 5 | Intellisense support in [Visual Studio Code](https://code.visualstudio.com/): 6 | 7 | ![Intellisense support in Visual Studio Code](./docs/intellisense-code.gif) 8 | 9 | Intellisense support in [Atom](https://atom.io/): 10 | 11 | ![Intellisense support in Atom](./docs/intellisense-atom.gif) 12 | 13 | The definitions in this project are manually curated based on Oracle's official APEX documentation. More work is required to validate that the definitions against the source JavaScript files, and also to complete the JSDoc comments that support the intellisense code hints. The ultimate goal is to integrate these defintions for the Oracle Application Express (APEX) JavaScript API, into the [DefinitelyTyped](http://definitelytyped.org/) repository. 14 | 15 | --- 16 | ### IMPORTANT! 17 | Please be mindful that this project is a **work-in progress**. Please feel free to post issues and/or recommendations. If you would like to contribute to the project, please contact the [project owner](https://twitter.com/fuzziebrain). 18 | 19 | --- 20 | 21 | ## Software Requirements 22 | * [Node.js](https://nodejs.org/) version 8.x (recommended) 23 | * [TypeScript](https://www.typescriptlang.org/) version 2.x 24 | 25 | To install TypeScript, run the following command after Node.js is installed: 26 | ```bash 27 | $ npm install -g typescript 28 | ``` 29 | 30 | For Atom, please also install the [atom-typescript](https://atom.io/packages/atom-typescript) plugin. 31 | 32 | ## Getting Started 33 | 1. Create the project folder. 34 | 2. Initialise the project: 35 | ```bash 36 | $ npm init 37 | ``` 38 | 3. Install the package from Git: 39 | ```bash 40 | $ npm install --save-dev https://github.com/fuzziebrain/orclapex-js.git 41 | ``` 42 | 4. Create a `tsconfig.json` file in the project root folder, containing at minimum, the following configuration: 43 | ```json 44 | { 45 | "compilerOptions": { 46 | "module": "commonjs", 47 | "lib": [ 48 | "es6", 49 | "dom" 50 | ] 51 | } 52 | } 53 | ``` 54 | 5. Add the reference to your TS file: 55 | ```typescript 56 | /// 57 | ``` 58 | 59 | For those who are not ready to start with TypeScript, Visual Studio Code provides type-checking and intellisense support for JavaScript. Add the following two lines of code: 60 | ```javascript 61 | //@ts-check 62 | /// 63 | ``` 64 | 65 | ## APEX Nitro Support for TypeScript 66 | [APEX Nitro](https://github.com/OraOpenSource/apex-nitro) version 4 and later supports TypeScript. Instructions to set up the project configuration forthcoming. 67 | 68 | ![Configure APEX Nitro support for TypeScript](./docs/apex-nitro-ts-configuration.png) 69 | 70 | ## Project Status 71 | | API / Namespace / Functions / Objects | Implementation Status | Code Hints (JSDoc) | Test Code | Validation | 72 | | - | - | - | - | - | 73 | | apex namespace | In progress | In progress | Not started | Not started | 74 | | apex.da namespace | Done | Done | Not started | Not started | 75 | | apex.debug namespace | Done | Done | Not started | Not started | 76 | | apex.event namespace | In progress | Not started | Not started | Not started | 77 | | apex.item | In progress | Not started | Not started | Not started | 78 | | apex.lang namespace | In progress | Not started | Not started | Not started | 79 | | apex.message namespace | In progress | Not started | Not started | Not started | 80 | | apex.navigation namespace | In progress | Not started | Not started | Not started | 81 | | apex.page namespace | In progress | Not started | Not started | Not started | 82 | | apex.region | In progress | Not started | Not started | Not started | 83 | | apex.server namespace | In progress | Not started | Not started | Not started | 84 | | apex.storage namespace | In progress | Not started | Not started | Not started | 85 | | apex.util namespace | In progress | In progress | Not started | Not started | 86 | | apex.widget namespace | In progress | In progress | Not started | Not started | 87 | | Events | Not started | Not started | Not started | Not started | 88 | | Non-namespace JavaScript APIs | In progress | In progress | Not started | Not started | 89 | | Legacy JavaScript APIs | Not implementing | - | - | - | -------------------------------------------------------------------------------- /docs/apex-nitro-ts-configuration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fuzziebrain/orclapex-js/ddee68133b87567afeaafd1895e06fb123e20435/docs/apex-nitro-ts-configuration.png -------------------------------------------------------------------------------- /docs/intellisense-atom.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fuzziebrain/orclapex-js/ddee68133b87567afeaafd1895e06fb123e20435/docs/intellisense-atom.gif -------------------------------------------------------------------------------- /docs/intellisense-code.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fuzziebrain/orclapex-js/ddee68133b87567afeaafd1895e06fb123e20435/docs/intellisense-code.gif -------------------------------------------------------------------------------- /examples/scratch.ts: -------------------------------------------------------------------------------- 1 | apex.page.submit("PROCESS"); 2 | 3 | let s: JQuery = $('a'); 4 | let valid: boolean = apex.page.validate(); 5 | 6 | let options: apex.page.SubmitOptions = { request: "SUBMIT", showWait: true, set: { "P1": "1", "P2": 2 }, reloadOnSubmit: "a" }; 7 | 8 | apex.page.confirm("Are you sure?", options); 9 | let x: JQuery = apex.util.showSpinner($("#container_id")); 10 | x.remove(); 11 | 12 | apex.util.delayLinger.start("test", function() { console.log('hello'); }); 13 | apex.util.delayLinger.finish("test", function() {}); 14 | apex.region("test").focus(); 15 | apex.region("myGridRegion").widget().interactiveGrid("getActions").invoke("add-row"); 16 | let logLevel: number = apex.debug.LOG_LEVEL.INFO; 17 | apex.debug.error("hello", "world"); 18 | let messageType: string = apex.message.TYPE.SUCCESS; 19 | apex.lang.addMessages({}); 20 | apex.lang.format("hello %0", "john"); 21 | let i = apex.item("P1_ITEM").getValue(); 22 | let mystring = $u_ArrayToString([1, "2"], ":"); -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "orclapex-js", 3 | "version": "0.1.0", 4 | "description": "TypeScript Declaration for Oracle Application Express JavaScript API", 5 | "main": "", 6 | "types": "./types/orclapex-js", 7 | "author": "Adrian Png 4 | 5 | /// 6 | 7 | declare namespace apex { 8 | const gPageContext$: any; 9 | 10 | const JQuery: JQuery; 11 | 12 | /** 13 | * apex.confirm Signature 1 (alias for apex.page.confirm) 14 | * @param {string} pMessage 15 | * @param {string} pRequest 16 | */ 17 | function confirm(pMessage: string, pRequest: string): void; 18 | 19 | /** 20 | * apex.confirm Signature 2 (alias for apex.page.confirm) 21 | * @param {string} pMessage 22 | * @param {page.SubmitOptions} pOptions 23 | * @returns {boolean | void} 24 | */ 25 | function confirm(pMessage: string, pOptions: page.SubmitOptions): boolean | void; 26 | 27 | /** 28 | * apex.page.submit Signature 1 (alias for apex.page.submit) 29 | * @param {string} pRequest 30 | */ 31 | function submit(pRequest: string): void; 32 | 33 | /** 34 | * apex.page.submit Signature 2 (alias for apex.page.submit) 35 | * @param {SubmitOptions} pOptions 36 | */ 37 | function submit(pOptions: page.SubmitOptions): void; 38 | 39 | /** 40 | * This API returns an Application Express item object, which can then be used to access item related functions and 41 | * properties. 42 | * 43 | * @param {HTMLElement} pNd - Application Express item name or DOM node. This parameter can refer to either a page 44 | * item or column item. 45 | */ 46 | function item(pNd: HTMLElement | string): item.ItemObject; 47 | 48 | /** 49 | * This API returns an Application Express region object for the given region id. The returned region object can then 50 | * be used to access region related functions and properties. 51 | * 52 | * @param {string} pRegionId - Region id or region static id. It is a best practice to give a region a Static ID if it 53 | * is going to be used from JavaScript otherwise an internally generated id is used. The 54 | * region id is substituted in the region template using the #REGION_STATIC_ID# string. 55 | * The region id can be found by viewing the page source in the browser. 56 | */ 57 | function region(pRegionId: string): region.Region; 58 | 59 | /** 60 | * This namespace holds all Dynamic Action functions in Oracle Application Express. 61 | */ 62 | namespace da { 63 | /** 64 | * This function resumes execution of a Dynamic Action. Execution of a Dynamic Action can be paused, if the action's 65 | * `Wait for Result` attribute is checked. The `Wait for Result` is a Dynamic Action plug-in standard attribute 66 | * designed for use with Ajax based Dynamic Actions. If a plug-in exposes this attribute, it needs to resume 67 | * execution by calling this function in the relevant place in the plug-in JavaScript code, otherwise, your action 68 | * breaks execution of Dynamic Actions. 69 | * 70 | * @param {Function} pCallback - This is a required parameter that references a callback function available from the 71 | * `this.resume` Callback property 72 | * @param {boolean} pErrorOccurred - This is a required parameter that indicates to the framework whether an error 73 | * has occurred. If an error has occurred and the action's Stop Execution on Error 74 | * attribute is checked, execution of the Dynamic Action is stopped. 75 | */ 76 | function resume(pCallback: Function, pErrorOccurred: boolean): void; 77 | } 78 | 79 | /** 80 | * This namespace stores all debug functions of Oracle Application Express. 81 | */ 82 | namespace debug { 83 | // We do not represent LOG_LEVEL as an enum since these values are defined in the JS file. 84 | let LOG_LEVEL: { 85 | /** 86 | * Logging is off. Value: 0 87 | */ 88 | OFF: number; 89 | 90 | /** 91 | * Error logging level. Value: 1 92 | */ 93 | ERROR: number; 94 | 95 | /** 96 | * Warning logging level. Value: 2 97 | */ 98 | WARN: number; 99 | 100 | /** 101 | * Information logging level. Value: 4 102 | */ 103 | INFO: number; 104 | 105 | /** 106 | * Application tracing logging level. Value: 6 107 | */ 108 | APP_TRACE: number; 109 | 110 | /** 111 | * Engine tracing logging level. Value: 9 112 | */ 113 | ENGINE_TRACE: number; 114 | } 115 | 116 | /** 117 | * Method that returns the debug log level. The debug log level is synchronized with hidden item "#pdebug". 118 | * 119 | * @returns { number } 120 | */ 121 | function getLevel(): number; 122 | 123 | /** 124 | * Method that sets the debug log level. Log messages at or below the specified level are written to the console 125 | * log. It is rarely necessary to call this function because the debug log level is synchronized with the hidden 126 | * item `#pdebug` that comes from the server. 127 | * 128 | * @param pLevel - A number from 1 to 9 where level 1 is most important and level 9 is least important. Can be one 129 | * of the `LOG_LEVEL` constants. Any other value such as 0 will turn off debug logging. 130 | */ 131 | function setLevel(pLevel: number): void; 132 | 133 | /** 134 | * Log an error message. The error function always writes the error regardless of the log level from the server or 135 | * set with `apex.debug.setLevel`. Messages are written using the browsers built-in console logging if available. If 136 | * supported `console.trace` is called. Older browsers may not support the console object or all of its features. 137 | * 138 | * @param message - Any number of parameters logged to the console. 139 | */ 140 | function error(...message: any[]): void; 141 | 142 | /** 143 | * Log an informational message. Similar toapex.debug.message with the level set to `INFO`. 144 | * 145 | * @param message - Any number of parameters logged to the console. 146 | */ 147 | function info(...message: any[]): void; 148 | 149 | /** 150 | * Log a message. Similar to `apex.debug.message` with the level set to the highest level. 151 | * 152 | * @param message - Any number of parameters logged to the console. 153 | */ 154 | function log(...message: any[]): void; 155 | 156 | /** 157 | * Log a message at the given debug log level. The log level set from the server or with `apex.debug.setLevel` 158 | * controls if the message is actually written. If the set log level is >= pLevel then the message is written. 159 | * Messages are written using the browsers built-in console logging if available. Older browsers may not support the 160 | * console object or all of its features. 161 | * 162 | * @param pLevel - A number from 1 to 9 where level 1 is most important and level 9 is least important. Can be one 163 | * of the `LOG_LEVEL` constants. Any other value such as 0 will turn off debug logging. 164 | * @param message - Any number of parameters logged to the console. 165 | */ 166 | function message(pLevel: number, ...message: any[]): void; 167 | 168 | /** 169 | * Log a trace message. Similar to `apex.debug.message` with the level set to `APP_TRACE`. 170 | * 171 | * @param message - Any number of parameters logged to the console. 172 | */ 173 | function trace(...message: any[]): void; 174 | 175 | /** 176 | * Log a warning message. Similar to `apex.debug.message` with the level set to `WARN`. 177 | * 178 | * @param message - Any number of parameters logged to the console. 179 | */ 180 | function warn(...message: any[]): void; 181 | } 182 | 183 | namespace event { 184 | /** 185 | * apex.event.trigger 186 | * @param {any} pSelector 187 | * @param {string} pEvent 188 | * @param {Object} pData 189 | * @return {boolean} 190 | */ 191 | function trigger(pSelector: any, pEvent: string, pData?: Object): boolean; 192 | } 193 | 194 | namespace item { 195 | interface ItemObject { 196 | id: string; 197 | node: HTMLElement; 198 | 199 | addValue(pValue: string): void; 200 | 201 | disable(): void; 202 | 203 | displayValueFor(pValue: string): string; 204 | 205 | enable(): void; 206 | 207 | getValidity(): ValidityState; 208 | 209 | getValidationMessage(): string; 210 | 211 | getValue(): string | string[]; 212 | 213 | hide(pHideRow?: boolean): void; 214 | 215 | isChanged(): boolean; 216 | 217 | isDisabled(): void; 218 | 219 | isEmpty(): boolean; 220 | 221 | setFocus(): void; 222 | 223 | setStyle(pPropertyName: string, pPropertyValue: string): void; 224 | 225 | setValue(pValue: string | string[], pDisplayValue?: string, pSuppressChangeEvent?: boolean): void; 226 | 227 | show(pShowRow?: boolean): void; 228 | } 229 | 230 | interface ValidityState { 231 | 232 | } 233 | 234 | // @todo A ItemImpl instead of ItemObject? 235 | function create(pName: HTMLElement | string, pItemImpl: ItemObject): void; 236 | } 237 | 238 | namespace lang { 239 | interface Message { 240 | [key: string]: string 241 | } 242 | function addMessages(pMessages: Message): void; 243 | 244 | function clearMessages(): void; 245 | 246 | function format(pPattern: string, ...replacementValue: any[]): string; 247 | 248 | function formatMessage(pKey: string, ...replacementValue: any[]): string; 249 | 250 | function formatMessageNoEscape(pKey: string, ...replacementValue: any[]): string; 251 | 252 | function formatNoEscape(pPattern: string, ...replacementValue: any[]): string; 253 | 254 | function getMessage(pKey: string): string; 255 | } 256 | 257 | namespace message { 258 | // We do not represent LOG_LEVEL as an enum since these values are defined in the JS file. 259 | let TYPE: { 260 | /** 261 | * Identifies a success message 262 | */ 263 | SUCCESS: string 264 | 265 | /** 266 | * Identifies an error message 267 | */ 268 | ERROR: string 269 | } 270 | 271 | interface Error { 272 | type?: string; 273 | location?: string | Array; 274 | pageItem?: string; 275 | message?: string; 276 | unsafe?: boolean; 277 | } 278 | 279 | interface ThemeHookOptions { 280 | beforeShow?: Function; 281 | beforeHide?: Function; 282 | closeNotificationSelector?: string; 283 | } 284 | 285 | function addVisibilityCheck(pFunction: Function): void; 286 | function alert(pMessage: string, pCallback: Function): void; 287 | function clearErrors(): void; 288 | function confirm(pMessage: string, pCallback: Function): void; 289 | function hidePageSuccess(): void; 290 | function setThemeHooks(): void; // @todo 291 | function showErrors(pErrors: Error | Array): void; // @todo 292 | function showPageSuccess(pMessage: string): void; 293 | } 294 | 295 | namespace navigation { 296 | function cancel(): void; 297 | function close(): void; 298 | function fireCloseHandler(): void; 299 | function registerCloseHandler(): void; 300 | function openInNewWindow(): void; 301 | function popup(): void; 302 | function redirect(): void; 303 | } 304 | 305 | namespace page { 306 | interface ParameterSet { 307 | [key: string]: string | number 308 | } 309 | 310 | interface SubmitOptions { 311 | request?: string, 312 | set?: ParameterSet, 313 | showWait?: boolean, 314 | submitIfEnter?: JQuery.Event, 315 | reloadOnSubmit?: string, 316 | ignoreChange?: boolean, 317 | validate?: boolean 318 | } 319 | 320 | /** 321 | * apex.page.confirm Signature 1 322 | * @param {string} pMessage 323 | * @param {string} pRequest 324 | */ 325 | function confirm(pMessage: string, pRequest: string): void; 326 | 327 | /** 328 | * apex.page.confirm Signature 2 329 | * @param {string} pMessage 330 | * @param {SubmitOptions} pOptions 331 | * @returns {boolean | void} 332 | */ 333 | function confirm(pMessage: string, pOptions: SubmitOptions): boolean | void; 334 | 335 | /** 336 | * apex.page.submit Signature 1 337 | * @param {string} pRequest 338 | */ 339 | function submit(pRequest: string): void; 340 | 341 | /** 342 | * apex.page.submit Signature 2 343 | * @param {SubmitOptions} pOptions 344 | */ 345 | function submit(pOptions: SubmitOptions): void; 346 | 347 | /** 348 | * apex.page.validate 349 | * @returns {boolean} 350 | */ 351 | function validate(): boolean; 352 | 353 | /** 354 | * apex.page.isChanged 355 | * @returns {boolean} 356 | */ 357 | function isChanged(): boolean; 358 | 359 | /** 360 | * apex.page.warnOnUnsavedChanges 361 | * @param pMessage 362 | * @param pExtraIsChanged 363 | */ 364 | function warnOnUnsavedChanges(pMessage: string, pExtraIsChanged: Function): void; 365 | } 366 | 367 | namespace region { 368 | interface Region { 369 | type: string; 370 | focus: Function; 371 | refresh: Function; 372 | widget(): widget.Widget; 373 | } 374 | 375 | function create(pRegionId: string, pRegionImpl: Region): void; 376 | 377 | function destroy(pRegionId: string): void; 378 | 379 | function isRegion(pRegionId: string): boolean; 380 | 381 | function findClosest(pTarget: HTMLElement | string): Region; 382 | } 383 | 384 | namespace server { 385 | interface ScriptConfig { 386 | path: string; 387 | requirejs: boolean; 388 | global?: string; 389 | } 390 | 391 | interface PluginData { 392 | pageItems: string | JQuery | HTMLElement | Array, 393 | x01?: string, 394 | x02?: string, 395 | x03?: string, 396 | x04?: string, 397 | x05?: string, 398 | x06?: string, 399 | x07?: string, 400 | x08?: string, 401 | x09?: string, 402 | x10?: string, 403 | f01?: string | Array 404 | f02?: string | Array 405 | f03?: string | Array 406 | f04?: string | Array 407 | f05?: string | Array 408 | f06?: string | Array 409 | f07?: string | Array 410 | f08?: string | Array 411 | f09?: string | Array 412 | f10?: string | Array 413 | f11?: string | Array 414 | f12?: string | Array 415 | f13?: string | Array 416 | f14?: string | Array 417 | f15?: string | Array 418 | f16?: string | Array 419 | f17?: string | Array 420 | f18?: string | Array 421 | f19?: string | Array 422 | f20?: string | Array 423 | } 424 | 425 | interface Queue { 426 | name: string, 427 | action: string 428 | } 429 | 430 | // @todo refreshObjectData 431 | interface PluginOptions { 432 | refreshObject?: string | JQuery | HTMLElement, 433 | refreshObjectData?: Object | Array 434 | clear?: Function, 435 | loadingIndicator?: string | JQuery | HTMLElement | Function, 436 | loadingIndicatorPosition?: string, 437 | queue?: Queue, 438 | target?: string | HTMLElement 439 | } 440 | 441 | function loadScript(pConfig: ScriptConfig, pCallback: Function): Function; 442 | 443 | // @todo return type 444 | function plugin(pAjaxIdentifier?: string, pData?: PluginData, pOptions?: PluginOptions): any; 445 | 446 | function pluginUrl(pAjaxIdentifier: string, pData?:PluginData): string; 447 | 448 | // @todo return type 449 | function process(pName: string, pData?: PluginData, pOptions?: PluginOptions): any; 450 | 451 | function url(pData?: PluginData, pPage?: string): string; 452 | } 453 | 454 | namespace storage { 455 | interface StorageOptions { 456 | prefix: string, 457 | useAppId: boolean, 458 | usePageId: boolean, 459 | regionId: string 460 | } 461 | 462 | interface ScopedStorage { 463 | prefix: string, 464 | length: number, 465 | key(n: number): string, 466 | getItem(key: string): any, 467 | setItem(key: string, data: any): void, 468 | removeItem(key: string): void, 469 | clear(): void, 470 | sync(): void 471 | } 472 | 473 | function getCookie(pName: string): string; 474 | 475 | function setCookie(pName: string, pValue: string): void; 476 | 477 | function hasLocalStorageSupport(): boolean; 478 | 479 | function hasSessionStorageSupport(): boolean; 480 | 481 | function getScopedLocalStorage(pOption: StorageOptions): ScopedStorage; 482 | 483 | function getScopedSessionStorage(pOption: StorageOptions): ScopedStorage; 484 | } 485 | 486 | /** 487 | * `apex.util namespace` contains general utility functions of Oracle Application Express. 488 | */ 489 | namespace util { 490 | let delayLinger: DelayLingerSingleton; 491 | 492 | interface DelayLingerSingleton { 493 | /** 494 | * Call this function when a potentially long running async process starts. For each call to start with a given 495 | * `pScopeName`, you must make a corresponding call to finish with the same `pScopeName`. Calls with different 496 | * `pScopeName` arguments will not interfere with each other. 497 | * 498 | * @param {string} pScopeName - Unique name for each unique progress indicator. 499 | * @param {Function} pAction - Function called to display the progress indicator. 500 | */ 501 | start(pScopeName: string, pAction: Function): void; 502 | 503 | /** 504 | * Call this function when a potentially long running async process finishes. For each call to start with a given 505 | * `pScopeName`, you must make a corresponding call to finish with the same pScopeName. The `pAction` is called 506 | * exactly once if and only if the corresponding start `pAction` was called. If there are multiple calls to finish 507 | * , the `pAction` from the last one is called. 508 | * 509 | * @param {string} pScopeName - Unique name for each unique progress indicator. 510 | * @param {Function} pAction - Function called to display the progress indicator. 511 | */ 512 | finish(pScopeName: string, pAction: Function): void; 513 | } 514 | 515 | interface PlaceholderSet { 516 | [key: string]: string 517 | } 518 | 519 | interface SubstitutionSet { 520 | [key: string]: string 521 | } 522 | 523 | interface SpinnerOptions { 524 | alert: string 525 | spinnerClass: string 526 | } 527 | 528 | // @todo model 529 | // @todo record 530 | interface TemplateOptions { 531 | placeholders?: PlaceholderSet, 532 | defaultEscapeFilter?: string, 533 | includePageItems?: boolean, 534 | model?: any, 535 | record?: any, 536 | extraSubstitutions?: SubstitutionSet, 537 | includeBuiltinSubstitutions?: boolean 538 | } 539 | 540 | /** 541 | * Returns string `pValue` with any CSS meta-characters are escaped. Use this function when the value is used as in 542 | * a CSS selector. Whenever possible constrain the value so that it cannot contain CSS meta-characters making it 543 | * unnecessary to use this function. 544 | * 545 | * @param {string} pValue - The string that may contain CSS meta-characters to be escaped. 546 | * @returns {string} - The escaped string. 547 | */ 548 | function escapeCSS(pValue: string): string; 549 | 550 | /** 551 | * Returns string `pValue` with any special HTML characters (`&<>"'/`) escaped to prevent cross site scripting (XSS) 552 | * attacks. 553 | * 554 | * @param {string} pValue - The string that may contain special HTML characters to be escaped. 555 | * @returns {string} - The escaped string. 556 | */ 557 | function escapeHTML(pValue: string): string; 558 | 559 | /** 560 | * Function that renders a spinning alert to show the user processing is taking place. Note that the alert is 561 | * defined as an ARIA alert so that assistive technologies such as screen readers are alerted to the processing 562 | * status. 563 | * 564 | * @param {JQuery} pContainer - Optional jQuery selector, jQuery, or DOM object identifying the container within 565 | * which you want to center the spinner. If not passed, the spinner will be centered on 566 | * the whole page. The default is `$("body")`. 567 | * @param {spinnerOptions} pOptions - Optional object with the following options: - "alert" Alert text visually 568 | * hidden, but available to assistive technologies. Defaults to Processing. The 569 | * default is Processing. 570 | */ 571 | function showSpinner(pContainer?: JQuery, pOptions?: SpinnerOptions): JQuery; 572 | 573 | /** 574 | * Return string `pText` with all HTML tags removed. 575 | * 576 | * @param {string} pText - A string that may contain HTML markup that you want removed. 577 | * @returns {string} 578 | */ 579 | function stripHTML(pText: string): string; 580 | 581 | /** 582 | * This function applies data to a template. It processes the template string given in pTemplate by substituting 583 | * values according to the options in pOptions. The template supports Application Express server style placeholder 584 | * and item substitution syntax. 585 | * 586 | * @param {string} pTemplate - A template string with the format described above. 587 | * @param {templateOptions} pOptions - An object that specifies how the template is to be processed. Refer to the 588 | * following pOptions properties table. 589 | */ 590 | function applyTemplate(pTemplate: string, pOptions: TemplateOptions): string; 591 | } 592 | 593 | /** 594 | * The `apex.widget` namespace stores all the general purpose widget related functions of Oracle Application Express. 595 | */ 596 | namespace widget { 597 | interface Widget { 598 | interactiveGrid(pName: string): InteractiveGrid 599 | } 600 | 601 | interface InteractiveGrid { 602 | invoke(pAction: string): void 603 | } 604 | 605 | /** 606 | * 607 | */ 608 | // function initPageItem(): void; 609 | } 610 | } 611 | 612 | // Non-namespaced APIs 613 | /** 614 | * 615 | * @param {HTMLElement | string} pNd 616 | * @returns {HTMLElement} 617 | */ 618 | declare function $x(pNd: HTMLElement | string): HTMLElement; 619 | 620 | /** 621 | * 622 | * @param {HTMLElement | string} pNd 623 | * @returns {string | number} 624 | */ 625 | declare function $v(pNd: HTMLElement | string): string | number; 626 | 627 | /** 628 | * 629 | * @param {HTMLElement | string} pNd 630 | * @returns {string | string[]} 631 | */ 632 | declare function $v2(pNd: HTMLElement | string): string | string[]; 633 | 634 | /** 635 | * 636 | * @param {HTMLElement | string }pNd 637 | * @param { string | string[]} pValue 638 | * @param { string } pDisplayValue 639 | * @param { boolean } pSuppressChangeEvent 640 | */ 641 | declare function $s( 642 | pNd: HTMLElement | string, 643 | pValue: string | string[], 644 | pDisplayValue: string, 645 | pSuppressChangeEvent: boolean 646 | ): void; 647 | 648 | /** 649 | * 650 | * @param { pItem: HTMLElement | string | string[] } pItem 651 | * @returns { HTMLElement | string | string[] | number[] } 652 | */ 653 | declare function $u_Narray(pItem: HTMLElement | string | string[]): HTMLElement | string | string[] | number[]; 654 | 655 | /** 656 | * 657 | * @param { pItem: HTMLElement | string | string[] } pItem 658 | * @returns { HTMLElement | string | string[] | number[] } 659 | */ 660 | declare function $u_Carray(pItem: HTMLElement | string | string[]): HTMLElement | string | string[] | number[]; 661 | 662 | /** 663 | * 664 | * @param { string | string[] } pTest 665 | * @param { string | string[] } pDefault 666 | * @returns { string | string[] } 667 | */ 668 | declare function $nvl(pTest: string | string[], pDefault: string | string[]): string | string[]; 669 | 670 | /** 671 | * 672 | * @param { HTMLElement | string | HTMLElement[] } pNd 673 | * @param { string } pStyle 674 | * @param { string } pString 675 | * @returns { HTMLElement | HTMLElement[] } 676 | */ 677 | declare function $x_Style( 678 | pNd: HTMLElement | string | HTMLElement[], 679 | pStyle: string, 680 | pString: string 681 | ): HTMLElement | HTMLElement[]; 682 | 683 | /** 684 | * 685 | * @param { HTMLElement | string | HTMLElement[] } pNd 686 | * @returns { HTMLElement | HTMLElement } 687 | */ 688 | declare function $x_Hide(pNd: HTMLElement | string | HTMLElement[]): HTMLElement | HTMLElement[]; 689 | 690 | /** 691 | * 692 | * @param { HTMLElement | string | HTMLElement[] } pNd 693 | * @returns { HTMLElement | HTMLElement } 694 | */ 695 | declare function $x_Show(pNd: HTMLElement | string | HTMLElement[]): HTMLElement | HTMLElement[]; 696 | 697 | /** 698 | * 699 | * @param { HTMLElement | string | HTMLElement[] } pNd 700 | * @returns { HTMLElement | HTMLElement } 701 | */ 702 | declare function $x_Toggle(pNd: HTMLElement | string | HTMLElement[]): HTMLElement | HTMLElement[]; 703 | 704 | /** 705 | * 706 | * @param { HTMLElement | string | HTMLElement[] } pNd 707 | * @returns { HTMLElement | HTMLElement } 708 | */ 709 | declare function $x_Remove(pNd: HTMLElement | string | HTMLElement[]): HTMLElement | HTMLElement[]; 710 | 711 | /** 712 | * 713 | * @param { HTMLElement | string | HTMLElement[] } pNd 714 | * @param { HTMLElement | HTMLElement } pValue 715 | */ 716 | declare function $x_Value(pNd: HTMLElement | string | HTMLElement[], pValue: string): void; 717 | 718 | /** 719 | * 720 | * @param { HTMLElement | string } pNd 721 | * @param { string } pToTag 722 | * @param { string } pToClass 723 | */ 724 | declare function $x_UpTill(pNd: HTMLElement | string, pToTag: string, pToClass?: string): HTMLElement | boolean; 725 | 726 | /** 727 | * 728 | * @param { HTMLElement | string | HTMLElement[] } pNd 729 | * @param { string } pFunc 730 | */ 731 | declare function $x_ItemRow(pNd: HTMLElement | string | HTMLElement[], pFunc: string): void; 732 | 733 | /** 734 | * 735 | * @param { HTMLElement | string | HTMLElement[] } pNd 736 | */ 737 | declare function $x_HideItemRow(pNd: HTMLElement | string | HTMLElement[]): void; 738 | 739 | /** 740 | * 741 | * @param { HTMLElement | string | HTMLElement[] } pNd 742 | */ 743 | declare function $x_ShowItemRow(pNd: HTMLElement | string | HTMLElement[]): void; 744 | 745 | /** 746 | * 747 | * @param { HTMLElement | string | HTMLElement[] } pNd 748 | */ 749 | declare function $x_ToggleItemRow(pNd: HTMLElement | string | HTMLElement[]): void; 750 | 751 | /** 752 | * 753 | * @param { HTMLElement | string | HTMLElement[] } pNd 754 | * @param { HTMLElement | string | string[] } pNdArray 755 | */ 756 | declare function $x_HideAllExcept( 757 | pNd: HTMLElement | string | HTMLElement[], 758 | pNdArray: HTMLElement | string | string[] 759 | ): void; 760 | 761 | /** 762 | * 763 | * @param { HTMLElement | string } pNd 764 | * @returns { HTMLElement } 765 | */ 766 | declare function $x_HideSiblings(pNd: HTMLElement | string): HTMLElement; 767 | 768 | /** 769 | * 770 | * @param { HTMLElement | string } pNd 771 | * @returns { HTMLElement } 772 | */ 773 | declare function $x_ShowSiblings(pNd: HTMLElement | string): HTMLElement; 774 | 775 | /** 776 | * 777 | * @param { HTMLElement | string | HTMLElement[] } pNd 778 | * @param { string } pClass 779 | */ 780 | declare function $x_Class(pNd: HTMLElement | string | HTMLElement[], pClass: string): void; 781 | 782 | /** 783 | * 784 | * @param { HTMLElement | string } pNd 785 | * @param { string } pClass 786 | * @param { string } pThisClass 787 | * @returns { HTMLElement | boolean } 788 | */ 789 | declare function $x_SetSiblingsClass( 790 | pNd: HTMLElement | string, 791 | pClass: string, 792 | pThisClass: string 793 | ): HTMLElement | boolean; 794 | 795 | /** 796 | * 797 | * @param { string } pClass 798 | * @param { HTMLElement | string } pNd 799 | * @param { string } pTag 800 | * @returns { HTMLElement[] } 801 | */ 802 | declare function $x_ByClass( 803 | pClass: string, 804 | pNd: HTMLElement | string, 805 | pTag: string 806 | ): HTMLElement[]; 807 | 808 | /** 809 | * 810 | * @param { HTMLElement | string } pNd 811 | * @param { string } pClass 812 | * @param { string } pTag 813 | */ 814 | declare function $x_ShowAllByClass( 815 | pNd: HTMLElement | string, 816 | pClass: string, 817 | pTag: string 818 | ): void; 819 | 820 | /** 821 | * 822 | * @param { HTMLElement | string } pNd 823 | */ 824 | declare function $x_ShowChildren(pNd: HTMLElement | string): void; 825 | 826 | /** 827 | * 828 | * @param { HTMLElement | string } pNd 829 | */ 830 | declare function $x_HideChildren(pNd: HTMLElement | string): void; 831 | 832 | /** 833 | * 834 | * @param { HTMLElement | string | HTMLElement[] } pNd 835 | * @param { boolean } a 836 | */ 837 | declare function $x_disableItem(pNd: HTMLElement | string | HTMLElement[], a: boolean): void; 838 | 839 | /** 840 | * 841 | * @param { HTMLElement | string | HTMLElement[] } pNd 842 | * @param { string } pclassFail 843 | * @param { string } pClass 844 | */ 845 | declare function $f_get_emptys( 846 | pNd: HTMLElement | string | HTMLElement[], 847 | pclassFail: string, 848 | pClass: string 849 | 850 | ): boolean | HTMLElement[]; 851 | 852 | /** 853 | * 854 | * @param { HTMLElement | stirng } pId 855 | * @returns { string[] | number[] } 856 | */ 857 | declare function $v_Array(pId: HTMLElement | string): string[] | number[]; 858 | 859 | /** 860 | * 861 | * @param { HTMLElement | stirng } pId 862 | * @returns { string[] | number[] } 863 | */ 864 | declare function $f_ReturnChecked(pId: HTMLElement | string): string[] | number[]; 865 | 866 | /** 867 | * 868 | * @param { HTMLElement | string | HTMLElement[] } pNd 869 | */ 870 | declare function $d_ClearAndHide(pNd: HTMLElement | string | HTMLElement[]): void; 871 | 872 | /** 873 | * 874 | * @param { HTMLElement | string } pNd 875 | * @returns { HTMLElement[] } 876 | */ 877 | declare function $f_SelectedOptions(pNd: HTMLElement | string): HTMLElement[]; 878 | 879 | /** 880 | * 881 | * @param { HTMLElement | string } pNd 882 | * @returns { HTMLElement[] | string } 883 | */ 884 | declare function $f_SelectValue(pNd: HTMLElement | string): HTMLElement[] | string; 885 | 886 | /** 887 | * 888 | * @param { (string | number)[] } pArray 889 | * @param { string } pDelim 890 | * @returns string 891 | */ 892 | declare function $u_ArrayToString(pArray: (string | number)[], pDelim: string): string; 893 | 894 | /** 895 | * 896 | * @param { HTMLElement | string } pId 897 | * @param { string } pSearch 898 | * @returns { boolean } 899 | */ 900 | declare function $x_CheckImageSrc(pId: HTMLElement | string, pSearch: string): boolean; 901 | 902 | /** 903 | * 904 | * @param { HTMLElement | string } pThis 905 | * @param { number | string | (number | string)[] } pValue 906 | * @returns { boolean } 907 | */ 908 | declare function $v_CheckValueAgainst( 909 | pThis: HTMLElement | string, 910 | pValue: number | string | (number | string)[] 911 | ): boolean; 912 | 913 | /** 914 | * 915 | * @param { HTMLElement | string } pThis 916 | * @param { HTMLElement | string | HTMLElement[] } pThat 917 | * @param { number | string | (number | string)[] } pValue 918 | * @returns { boolean } 919 | */ 920 | declare function $f_Hide_On_Value_Item( 921 | pThis: HTMLElement | string, 922 | pThat: HTMLElement | string | HTMLElement[], 923 | pValue: number | string | (number | string)[] 924 | ): boolean; 925 | 926 | /** 927 | * 928 | * @param { HTMLElement | string } pThis 929 | * @param { HTMLElement | string | HTMLElement[] } pThat 930 | * @param { number | string | (number | string)[] } pValue 931 | * @returns { boolean } 932 | */ 933 | declare function $f_Show_On_Value_Item( 934 | pThis: HTMLElement | string, 935 | pThat: HTMLElement | string | HTMLElement[], 936 | pValue: number | string | (number | string)[] 937 | ): boolean; 938 | 939 | /** 940 | * 941 | * @param { HTMLElement | string } pThis 942 | * @param { HTMLElement | string | HTMLElement[] } pThat 943 | * @param { number | string | (number | string)[] } pValue 944 | * @returns { boolean } 945 | */ 946 | declare function $f_Hide_On_Value_Item_Row( 947 | pThis: HTMLElement | string, 948 | pThat: HTMLElement | string | HTMLElement[], 949 | pValue: number | string | (number | string)[] 950 | ): boolean; 951 | 952 | /** 953 | * 954 | * @param { HTMLElement | string } pThis 955 | * @param { HTMLElement | string | HTMLElement[] } pThat 956 | * @param { number | string | (number | string)[] } pValue 957 | * @returns { boolean } 958 | */ 959 | declare function $f_Show_On_Value_Item_Row( 960 | pThis: HTMLElement | string, 961 | pThat: HTMLElement | string | HTMLElement[], 962 | pValue: number | string | (number | string)[] 963 | ): boolean; 964 | 965 | /** 966 | * 967 | * @param { HTMLElement | string } pThis 968 | * @param { number | string | (number | string)[] } pValue 969 | * @param { HTMLElement | string | HTMLElement[] } pThat 970 | * @returns { boolean } 971 | */ 972 | declare function $f_DisableOnValue( 973 | pThis: HTMLElement | string, 974 | pValue: number | string | (number | string)[], 975 | pThat: HTMLElement | string | HTMLElement[] 976 | ): boolean; 977 | 978 | /** 979 | * 980 | * @param { HTMLElement | string } pNd 981 | * @param { string } pClass 982 | * @param { string } pTag 983 | * @param { string } pClass2 984 | * @returns { HTMLElement | HTMLElement[] } 985 | */ 986 | declare function $x_ClassByClass( 987 | pNd: HTMLElement | string, 988 | pClass: string, 989 | pTag: string, 990 | pClass2: string 991 | ): HTMLElement | HTMLElement[]; 992 | 993 | /** 994 | * 995 | * @param { HTMLElement | string } pThis 996 | * @param { string } pClass 997 | * @param { string } pTag 998 | */ 999 | declare function $f_ValuesToArray(pThis: HTMLElement | string, pClass: string, pTag: string): void; 1000 | 1001 | /** 1002 | * 1003 | * @param { HTMLElement | string } pNd 1004 | * @param { HTMLElement } pType 1005 | * @returns { HTMLElement[] } 1006 | */ 1007 | declare function $x_FormItems(pNd: HTMLElement | string, pType: string): HTMLElement[]; 1008 | 1009 | /** 1010 | * 1011 | * @param { HTMLElement | string } pThis 1012 | * @param { boolean } pCheck 1013 | * @param { HTMLElement[] } pArray 1014 | */ 1015 | declare function $f_CheckAll(pThis: HTMLElement | string, pCheck: boolean, pArray: HTMLElement[]): void; 1016 | 1017 | /** 1018 | * 1019 | * @param { HTMLElement | string } pNd 1020 | * @returns { HTMLElement[] } 1021 | */ 1022 | declare function $f_CheckFirstColumn(pNd: HTMLElement | string): HTMLElement[]; 1023 | 1024 | /** 1025 | * 1026 | * @param { HTMLElement | string } pThis 1027 | * @param { HTMLElement | string | HTMLElement[] } pNd 1028 | * @returns { HTMLElement } 1029 | */ 1030 | declare function $x_ToggleWithImage( 1031 | pThis: HTMLElement | string, 1032 | pNd: HTMLElement | string | HTMLElement[] 1033 | ): HTMLElement; 1034 | 1035 | /** 1036 | * 1037 | * @param { HTMLElement | string } pNd 1038 | * @param { string } pSearch 1039 | * @param { string } pReplace 1040 | * @returns { HTMLElement | boolean } 1041 | */ 1042 | declare function $x_SwitchImageSrc(pNd: HTMLElement | string, pSearch: string, pReplace: string): HTMLElement | boolean; 1043 | 1044 | /** 1045 | * 1046 | * @param { HTMLElement | string } pNd 1047 | * @param { string } pSearch 1048 | * @returns { boolean } 1049 | */ 1050 | declare function $x_CheckImageSrc(pNd: HTMLElement | string, pSearch: string): boolean; 1051 | 1052 | /** 1053 | * 1054 | * @param { string } pText 1055 | * @param { string } pMatch 1056 | * @returns { boolean } 1057 | */ 1058 | declare function $u_SubString(pText: string, pMatch: string): boolean; 1059 | 1060 | /** 1061 | * 1062 | * @param { HTMLElement | string } pNd 1063 | */ 1064 | declare function html_RemoveAllChildren(pNd: HTMLElement | string): void; 1065 | 1066 | /** 1067 | * 1068 | * @param { HTMLElement | string } pId 1069 | * @param { string } pValue 1070 | */ 1071 | declare function html_SetSelectValue(pId: HTMLElement | string, pValue: string): void; 1072 | 1073 | /** 1074 | * 1075 | * @param { Function } pFunction 1076 | */ 1077 | declare function addLoadEvent(pFunction: Function): void; 1078 | 1079 | /** 1080 | * 1081 | * @param { HTMLElement | string } pThis 1082 | * @param { HTMLElement | string } pThat 1083 | */ 1084 | declare function $f_Swap(pThis: HTMLElement | string, pThat: HTMLElement | string): void; 1085 | 1086 | /** 1087 | * 1088 | * @param { HTMLElement[] } pArray 1089 | * @param { number } pMultiple 1090 | */ 1091 | declare function $f_SetValueSequence(pArray: HTMLElement[], pMultiple: number): void; 1092 | 1093 | /** 1094 | * 1095 | * @param { HTMLElement | string } pThis 1096 | * @param { string } pTag 1097 | * @param { string } pText 1098 | * @returns { HTMLElement } 1099 | */ 1100 | declare function $dom_AddTag(pThis: HTMLElement | string, pTag: string, pText: string): HTMLElement; 1101 | 1102 | /** 1103 | * 1104 | * @param { HTMLElement | string } pThis 1105 | * @param { string } pText 1106 | * @returns { HTMLElement } 1107 | */ 1108 | declare function $tr_AddTD(pThis: HTMLElement | string, pText: string): HTMLElement; 1109 | 1110 | /** 1111 | * 1112 | * @param { HTMLElement | string } pThis 1113 | * @param { string } pText 1114 | * @returns { HTMLElement } 1115 | */ 1116 | declare function $tr_AddTH(pThis: HTMLElement | string, pText: string): HTMLElement; 1117 | 1118 | /** 1119 | * 1120 | * @param { HTMLElement | string } pThis 1121 | * @param { string } pType 1122 | * @param { string } pId 1123 | * @param { string } pName 1124 | * @param { string } pValue 1125 | * @returns { HTMLElement } 1126 | */ 1127 | declare function $dom_AddInput( 1128 | pThis: HTMLElement | string, 1129 | pType: string, 1130 | pId: string, 1131 | pName: string, 1132 | pValue: string 1133 | ): HTMLElement; 1134 | 1135 | /** 1136 | * 1137 | * @param { HTMLElement | string } p_This 1138 | * @param { HTMLElement | string } p_Parent 1139 | */ 1140 | declare function $dom_MakeParent(p_This: HTMLElement | string, p_Parent: HTMLElement | string): void; 1141 | 1142 | /** 1143 | * 1144 | * @param { HTMLElement | string } pThis 1145 | * @param { string } pColor 1146 | */ 1147 | declare function $x_RowHighlight(pThis: HTMLElement | string, pColor: string): void; 1148 | 1149 | /** 1150 | * 1151 | * @param { HTMLElement | string } pThis 1152 | */ 1153 | declare function $x_RowHighlightOff(pThis: HTMLElement | string): void; 1154 | 1155 | /** 1156 | * 1157 | * @param { HTMLElement | string } pNd 1158 | */ 1159 | declare function $v_Upper(pNd: HTMLElement | string): void; 1160 | 1161 | /** 1162 | * 1163 | * @param { HTMLElement | string } pThis 1164 | * @param { string } pString 1165 | * @param { string } pTags 1166 | * @param { string } pClass 1167 | */ 1168 | declare function $d_Find(pThis: HTMLElement | string, pString: string, pTags: string, pClass: string): void; 1169 | 1170 | /** 1171 | * 1172 | * @param { HTMLElement | string } pNd 1173 | * @returns { boolean } 1174 | */ 1175 | declare function $f_First_field(pNd: HTMLElement | string): boolean; 1176 | // END - Non-namespaced APIs -------------------------------------------------------------------------------- /types/orclapex-js/orclapex-js-tests.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fuzziebrain/orclapex-js/ddee68133b87567afeaafd1895e06fb123e20435/types/orclapex-js/orclapex-js-tests.ts -------------------------------------------------------------------------------- /types/orclapex-js/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "lib": [ 5 | "es6", 6 | "dom" 7 | ], 8 | "noImplicitAny": true, 9 | "noImplicitThis": true, 10 | "strictNullChecks": true, 11 | "baseUrl": "../", 12 | "typeRoots": [ 13 | "../" 14 | ], 15 | "types": [], 16 | "noEmit": true, 17 | "forceConsistentCasingInFileNames": true 18 | }, 19 | "files": [ 20 | "index.d.ts", 21 | "orclapex-js-tests.ts" 22 | ] 23 | } -------------------------------------------------------------------------------- /types/orclapex-js/tslint.json: -------------------------------------------------------------------------------- 1 | { 2 | "rules": { 3 | "max-line-length": { 4 | "options": [ 5 | 120 6 | ] 7 | }, 8 | "new-parens": true, 9 | "no-arg": true, 10 | "no-bitwise": true, 11 | "no-conditional-assignment": true, 12 | "no-consecutive-blank-lines": false, 13 | "no-console": { 14 | "options": [ 15 | "debug", 16 | "info", 17 | "log", 18 | "time", 19 | "timeEnd", 20 | "trace" 21 | ] 22 | } 23 | }, 24 | "jsRules": { 25 | "max-line-length": { 26 | "options": [ 27 | 120 28 | ] 29 | } 30 | } 31 | } --------------------------------------------------------------------------------