Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@internal API elements are erased for all languages except TypeScript #1947

Closed
1 of 4 tasks
rix0rrr opened this issue Aug 25, 2020 · 1 comment · Fixed by #2172
Closed
1 of 4 tasks

@internal API elements are erased for all languages except TypeScript #1947

rix0rrr opened this issue Aug 25, 2020 · 1 comment · Fixed by #2172
Assignees
Labels
bug This issue is a bug. effort/large Large work item – several weeks of effort language/typescript Related to Typescript code p1

Comments

@rix0rrr
Copy link
Contributor

rix0rrr commented Aug 25, 2020

🐛 Bug Report

Affected Languages

  • TypeScript or Javascript
  • Python
  • Java
  • .NET (C#, F#, ...)

What is the problem?

Currently in compliance.ts:

/**
 * @internal
 */
export interface InternalInterface {
  readonly prop: string;
}

export interface ExtendsInternalInterface extends InternalInterface {
  readonly boom: boolean;
}

We made this work (with lots of effort) for jsii client languages... but then forget to do it for TypeScript. The .d.ts looks like this:

// (...nothing about InternalInterface)

export interface ExtendsInternalInterface extends InternalInterface {   // <--- asplodes!
    readonly boom: boolean;
}

This leads to compilation errors for TypeScript.

@rix0rrr rix0rrr added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Aug 25, 2020
@SomayaB SomayaB added language/typescript Related to Typescript code and removed needs-triage This issue or PR still needs to be triaged. labels Aug 31, 2020
@RomainMuller RomainMuller added effort/large Large work item – several weeks of effort p1 labels Sep 14, 2020
@mergify mergify bot closed this as completed in #2172 Oct 23, 2020
mergify bot pushed a commit that referenced this issue Oct 23, 2020
…wnstream (#2172)

Stop setting `stipInternal: true` in `tsconfig.json` files, as this makes it impossible
to mark intentionally unexported types as `@internal` without causing downstream
compilation failures due to missing type declarations.

Fixes #1947
Related to #1830 

---

By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license].

[Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0
@github-actions
Copy link
Contributor

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

nija-at pushed a commit to aws/aws-cdk that referenced this issue Oct 29, 2020
This reverts commit 65be3a0.
Original PR: #10531
Co-authored-by: Ayush Goyal <goyalayu@amazon.com>

This commit was previously reverted due to a bug in jsii - aws/jsii#1947
and aws/jsii#1830. This has been fixed in jsii version 1.14.0.
mergify bot pushed a commit to aws/aws-cdk that referenced this issue Oct 30, 2020
This reverts commit 65be3a0.
Original PR: #10531
Co-authored-by: Ayush Goyal <goyalayu@amazon.com>
relates #10119

This commit was previously reverted due to a bug in jsii - aws/jsii#1947
and aws/jsii#1830. This has been fixed in jsii version 1.14.0.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
eladb pushed a commit to cdklabs/decdk that referenced this issue Jan 18, 2022
This reverts commit 4641fd47a464ea20f5536c0d58cfb8f24f9698fe.
Original PR: #10531
Co-authored-by: Ayush Goyal <goyalayu@amazon.com>
relates #10119

This commit was previously reverted due to a bug in jsii - aws/jsii#1947
and aws/jsii#1830. This has been fixed in jsii version 1.14.0.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. effort/large Large work item – several weeks of effort language/typescript Related to Typescript code p1
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants