Fix fdc3-commonjs build by including d.ts files#1694
Conversation
✅ Deploy Preview for fdc3 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Roaders
force-pushed
the
fdc3-commonjs-dts-fix
branch
from
1d8b63e to
2140bc6
Compare
|
|
Roaders
force-pushed
the
fdc3-commonjs-dts-fix
branch
from
2140bc6 to
e4b0191
Compare
|
|
1 similar comment
|
|
kriswest
left a comment
kriswest
left a comment
There was a problem hiding this comment.
LGTM, minor adjustment to make to changelog (See suggestion)
Co-authored-by: Kris West <kristopher.west@natwest.com>
|
|
|
Thanks for working on this @Roaders. I tested this out today in our project that has the most FDC3 usage (and which had to be locked to 2.1.0 because of the breaking change for node consumers in 2.2.0). In order to test I had to When this is actually released, does the |
|
There will still be a dependency on export * from '@finos/fdc3';in it. This means that we need to retain the dependency. It will only be consumed by Typescript at author / compile time and not used at runtime. |
|
|
|
ok, I've managed to bundle all the I don't know anything about the failing checks on this PR I am afraid. |
|
/netlify |
|
Thanks @Roaders I just tested it and it works. Without the circular dep I only need to install @finos/fdc3-commonjs and alias @finos/fdc3 to it. |
3 participants
Describe your change
Update the rollup config for
fdc3-commonjsto publishd.tsfiles as part of the build. Also addsmainandtypesfields to thepackage.json(for older versions of node that do not understandexportsand addedtypesandimportentries to the exports object.resolves #1691
Contributor License Agreement
Review Checklist
DesktopAgent,Channel,PrivateChannel,Listener,Bridging)?JSDoc comments on interfaces and types should be matched to the main documentation in /docs
Conformance test definitions should cover all required aspects of an FDC3 Desktop Agent implementation, which are usually marked with a MUST keyword, and optional features (SHOULD or MAY) where the format of those features is defined
The Web Connection protocol and Desktop Agent Communication Protocol schemas must be able to support all necessary aspects of the Desktop Agent API, while Bridging must support those aspects necessary for Desktop Agents to communicate with each other
npm run build) run and the results checked in?Generated code will be found at
/src/api/BrowserTypes.tsand/or/src/bridging/BridgingTypes.tsBaseContextschema applied viaallOf(as it is in existing types)?titleanddescriptionprovided for all properties defined in the schema?npm run build) run and the results checked in?Generated code will be found at
/src/context/ContextTypes.tsTHIS SOFTWARE IS CONTRIBUTED SUBJECT TO THE TERMS OF THE FINOS CORPORATE CONTRIBUTOR LICENSE AGREEMENT.
THIS SOFTWARE IS LICENSED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OF NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THIS SOFTWARE MAY BE REDISTRIBUTED TO OTHERS ONLY BY EFFECTIVELY USING THIS OR ANOTHER EQUIVALENT DISCLAIMER IN ADDITION TO ANY OTHER REQUIRED LICENSE TERMS.