This is an automated email from the ASF dual-hosted git repository. thiagohp pushed a commit to branch javax in repository https://gitbox.apache.org/repos/asf/tapestry-5.git
The following commit(s) were added to refs/heads/javax by this push: new b57e3ee9a TAP5-2812: preparing to publish npm package. b57e3ee9a is described below commit b57e3ee9a22c3abc4e371240829df7d256af6361 Author: Thiago H. de Paula Figueiredo <thi...@arsmachina.com.br> AuthorDate: Sun Aug 31 19:20:59 2025 -0300 TAP5-2812: preparing to publish npm package. --- .../META-INF/assets/es-modules/t5/.gitignore | 4 +- tapestry-core/src/main/typescript/.gitignore | 3 + tapestry-core/src/main/typescript/.npmignore | 5 + tapestry-core/src/main/typescript/LICENSE.txt | 202 +++++++++++++++++++++ tapestry-core/src/main/typescript/README | 21 +++ .../src/main/typescript/package-lock.json | 6 +- tapestry-core/src/main/typescript/package.json | 30 +-- .../typescript/src/t5/core/t5-core-dom-jquery.ts | 3 + .../src/t5/core/t5-core-dom-prototype.ts | 7 +- .../src/main/typescript/src/t5/core/zone.ts | 1 + tapestry-core/src/main/typescript/tsconfig.json | 5 +- 11 files changed, 270 insertions(+), 17 deletions(-) diff --git a/tapestry-core/src/main/resources/META-INF/assets/es-modules/t5/.gitignore b/tapestry-core/src/main/resources/META-INF/assets/es-modules/t5/.gitignore index 0c3030243..fca0f15d5 100644 --- a/tapestry-core/src/main/resources/META-INF/assets/es-modules/t5/.gitignore +++ b/tapestry-core/src/main/resources/META-INF/assets/es-modules/t5/.gitignore @@ -1,2 +1,2 @@ -beanvalidator/*.js -core/*.js \ No newline at end of file +beanvalidator +core \ No newline at end of file diff --git a/tapestry-core/src/main/typescript/.gitignore b/tapestry-core/src/main/typescript/.gitignore index ea683cd2f..cf80f06d3 100644 --- a/tapestry-core/src/main/typescript/.gitignore +++ b/tapestry-core/src/main/typescript/.gitignore @@ -1,2 +1,5 @@ +/dist/ /node_modules/ +/src/ /output/ +/types/ \ No newline at end of file diff --git a/tapestry-core/src/main/typescript/.npmignore b/tapestry-core/src/main/typescript/.npmignore new file mode 100644 index 000000000..8becf519b --- /dev/null +++ b/tapestry-core/src/main/typescript/.npmignore @@ -0,0 +1,5 @@ +./dist +./node_modules +./src +./output +./types \ No newline at end of file diff --git a/tapestry-core/src/main/typescript/LICENSE.txt b/tapestry-core/src/main/typescript/LICENSE.txt new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/tapestry-core/src/main/typescript/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/tapestry-core/src/main/typescript/README b/tapestry-core/src/main/typescript/README new file mode 100644 index 000000000..8b6995f46 --- /dev/null +++ b/tapestry-core/src/main/typescript/README @@ -0,0 +1,21 @@ +# Tapestry 5 TypeScript type files + +This package provides the TypeScript type files for the +[Apache Tapestry 5](https://tapestry.apache.org)-provided +JavaScript code. + +Their installation in your npm/pnpm/yarn TypeScript project requires executing once these 2 actions: + +1. Running `npm install --save @thiagohp/tapestry-5` in your command line (or the corresponding command in pnpm or yarn). +2. Adding an entry to the `paths` setting +of your `tsconfig.json` file like this: + +``` +{ + "compilerOptions": { + "paths": { + "t5/core/*": [ "./node_modules/@thiagohp/tapestry-5/types/t5/core/*.d.ts" ], + } + } +} +``` \ No newline at end of file diff --git a/tapestry-core/src/main/typescript/package-lock.json b/tapestry-core/src/main/typescript/package-lock.json index 5259a5fbb..c4e13ab5a 100644 --- a/tapestry-core/src/main/typescript/package-lock.json +++ b/tapestry-core/src/main/typescript/package-lock.json @@ -13,7 +13,8 @@ "moment": "^2.30.1", "typedoc": "^0.28.1", "typescript": "^5.0.0" - } + }, + "version": "0.0.3" }, "node_modules/@gerrit0/mini-shiki": { "version": "3.2.2", @@ -446,5 +447,6 @@ "node": ">=12" } } - } + }, + "version": "0.0.3" } diff --git a/tapestry-core/src/main/typescript/package.json b/tapestry-core/src/main/typescript/package.json index 32f83b0b9..51d7af186 100644 --- a/tapestry-core/src/main/typescript/package.json +++ b/tapestry-core/src/main/typescript/package.json @@ -8,22 +8,27 @@ "moment": "^2.30.1", "@types/underscore": "^1.13.0" }, - "dependencies": { - }, + "dependencies": {}, "scripts": { - "build": "npm run build-es-module; npm run build-amd", - "build-es-module": "npx tsc --outDir ../resources/META-INF/assets/es-modules/t5/; npm run adjust-es-module;", - "build-amd": "npx tsc --module amd --outDir ../resources/META-INF/modules/t5/; npm run adjust-amd;", + "build": "npm run build-es-module; npm run build-amd; rm -f .", + "build-es-module": "npx tsc --outDir ../resources/META-INF/assets/es-modules/; npm run adjust-es-module;", + "build-amd": "npx tsc --module amd --outDir ../resources/META-INF/modules/; npm run adjust-amd;", "clean-amd": "rm -rf ../resources/META-INF/modules/t5/core/*.js; rm -rf ../resources/META-INF/modules/t5/beanvalidation/*.js;", - "clean-es-module": "rm -rf ../resources/META-INF/assets/es-modules/t5/core/*.js; ../resources/META-INF/assets/es-modules/t5/beanvalidation/*.js", - "clean": "npm run clean-amd; npm run clean-es-module; npm run clean-docs;", + "clean-es-module": "rm -rf ../resources/META-INF/assets/es-modules/t5/core/*.js; ../resources/META-INF/assets/es-modules/t5/beanvalidation/*.js;", + "clean": "npm run clean-amd; npm run clean-es-module; npm run clean-docs; npm run clean-tsc;", "adjust-amd": "mv ../resources/META-INF/modules/t5/core/messages-amd.js ../resources/META-INF/modules/t5/core/messages.js; rm ../resources/META-INF/modules/t5/core/messages-es-module.js;", - "adjust-es-module": "mv ../resources/META-INF/assets/es-modules/t5/core/messages-es-module.js ../resources/META-INF/assets/es-modules/t5/core/messages.js; rm ../resources/META-INF/assets/es-modules/t5/core/messages-amd.js", + "adjust-es-module": "mv ../resources/META-INF/assets/es-modules/t5/core/messages-es-module.js ../resources/META-INF/assets/es-modules/t5/core/messages.js; rm ../resources/META-INF/assets/es-modules/t5/core/messages-amd.js;", "docs": "typedoc", - "clean-docs": "rm -rf docs" + "clean-docs": "rm -rf docs", + "tsc": "tsc", + "clean-tsc": "rm -rf ./types/*", + "generate-type-definitions": "tsc --emitDeclarationOnly --outDir ./types", + "test-publish-to-npm": "npm run clean-tsc; npm run generate-type-definitions; npm pack;", + "publish-to-npm": "npm run clean-tsc; npm run generate-type-definitions; npm publish --access public;" }, "license": "Apache-2.0", - "name": "tapestry-5", + "name": "@thiagohp/tapestry-5", + "version": "0.0.3", "url": "https://tapestry.apache.org", "bugs": { "url": "https://issues.apache.org/jira/projects/TAP5/issues/" @@ -33,10 +38,13 @@ "displayName": "Apache Tapestry's JS code", "repository": { "type": "git", - "url": "https://github.com/apache/tapestry-5", + "url": "git+https://github.com/apache/tapestry-5.git", "directory": "tapestry-core/src/main/typescript" }, "keywords": [ "tapestry" + ], + "files": [ + "types" ] } diff --git a/tapestry-core/src/main/typescript/src/t5/core/t5-core-dom-jquery.ts b/tapestry-core/src/main/typescript/src/t5/core/t5-core-dom-jquery.ts index 379a79809..d99e1a2c2 100644 --- a/tapestry-core/src/main/typescript/src/t5/core/t5-core-dom-jquery.ts +++ b/tapestry-core/src/main/typescript/src/t5/core/t5-core-dom-jquery.ts @@ -400,7 +400,9 @@ let ajaxRequest = function(url: string, options?: AjaxRequestOptions) { message += " -- " + text; } message += "."; + // @ts-ignore if (options.failure) { + // @ts-ignore options.failure(new JQueryResponseWrapper(jqXHR, {}), message); } else { throw new Error(message); @@ -408,6 +410,7 @@ let ajaxRequest = function(url: string, options?: AjaxRequestOptions) { }, success: function(data, textStatus, jqXHR) { adjustAjaxCount(-1); + // @ts-ignore options.success && options.success(new JQueryResponseWrapper(jqXHR, data)); } }); diff --git a/tapestry-core/src/main/typescript/src/t5/core/t5-core-dom-prototype.ts b/tapestry-core/src/main/typescript/src/t5/core/t5-core-dom-prototype.ts index 9f70b31e9..f582425ad 100644 --- a/tapestry-core/src/main/typescript/src/t5/core/t5-core-dom-prototype.ts +++ b/tapestry-core/src/main/typescript/src/t5/core/t5-core-dom-prototype.ts @@ -110,7 +110,7 @@ type PrototypeEvent = { } const onevent = function(elements: HTMLElement[], eventNames: string[], match: string | null, handler: OnEventHandler) { - let element, eventHandlers, eventName, i, j, len, len1, wrapped; + let element, eventHandlers: Array<any>, eventName, i, j, len, len1, wrapped; if (handler == null) { throw new Error("No event handler was provided."); } @@ -474,7 +474,9 @@ const ajaxRequest = function(url: string, options: AjaxRequestOptions | undefine onException(ajaxRequest: any, exception: any) { adjustAjaxCount(-1); + // @ts-ignore if (options.exception) { + // @ts-ignore options.exception(exception); } else { throw exception; @@ -492,7 +494,9 @@ const ajaxRequest = function(url: string, options: AjaxRequestOptions | undefine message += " -- " + text; } message += "."; + // @ts-ignore if (options.failure) { + // @ts-ignore options.failure(new PrototypeResponseWrapper(response), message); } else { throw new Error(message); @@ -507,6 +511,7 @@ const ajaxRequest = function(url: string, options: AjaxRequestOptions | undefine finalOptions.onFailure(new PrototypeResponseWrapper(response)); return; } + // @ts-ignore options.success && options.success(new PrototypeResponseWrapper(response)); } }; diff --git a/tapestry-core/src/main/typescript/src/t5/core/zone.ts b/tapestry-core/src/main/typescript/src/t5/core/zone.ts index f08479029..7b18f1722 100644 --- a/tapestry-core/src/main/typescript/src/t5/core/zone.ts +++ b/tapestry-core/src/main/typescript/src/t5/core/zone.ts @@ -34,6 +34,7 @@ import { ElementWrapper, ResponseWrapper }from "t5/core/types"; if ((typeof ajax) !== "function") { console.error("ajax variable is not a function, but instead it is " + JSON.stringify(ajax)); + // @ts-ignore console.error(ajax); throw new Error("ajax variable is not a function"); } diff --git a/tapestry-core/src/main/typescript/tsconfig.json b/tapestry-core/src/main/typescript/tsconfig.json index 927c678ee..33aa9ddde 100644 --- a/tapestry-core/src/main/typescript/tsconfig.json +++ b/tapestry-core/src/main/typescript/tsconfig.json @@ -34,7 +34,10 @@ // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ "skipLibCheck": true /* Skip type checking all .d.ts files. */, - "outDir": "../resources/META-INF/assets/es-modules/t5/core/", + "declaration": true, + + "outDir": "output", + "rootDir": "src", },