ziemniakoss / lwc-typings-generator Goto Github PK

TS typings generator for LWC

JavaScript 0.08% Batchfile 0.03% TypeScript 99.89%

lwc salesforce sfdx-plugin ts

lwc-typings-generator's Introduction

Hello 👋

My Projects

These projects are maintained in spare time. Due to the fact that I just discovered WII (console), I have almost none :). Please be patient with response times.

Bitbucket pipes

Universal Code Insights creator

Related to Salesforce

apex parser for prettier in docker.

SFDX Plugins

Mainly CI related stuff but also some plugins that enhance IDE inteligence (like autocompletions and so on)

For better autocompletion

Other

lwc-typings-generator's People

Contributors

Stargazers

Watchers

Forkers

pavilionsoftworks okonomi

lwc-typings-generator's Issues

missing new action for standard__objectPage

When navigating to the standard__objectPage page, the action type parameter doesn't have "new" option

Support for message service

https://developer.salesforce.com/docs/component-library/bundle/lightning-message-service/documentation

Support for new User Interface API functionality

New wirable methods were added in latest release: https://help.salesforce.com/s/articleView?id=release-notes.rn_api_ui.htm&type=5&release=238

All fields visible in typings

Fields that are not marked with

@api

decorator shouldn't be visible in results of

this.template.querySelector

Open files api

Reocrd page mentioned in this docs page doesn't exist in typings

Generate labels from local resources

speed up generation
less network trafic

Support for flow events

https://developer.salesforce.com/docs/component-library/bundle/lightning-flow-support/documentation

Support for new static property shadowSupportMode

In this release new property was introduced with 2 possible values
https://help.salesforce.com/s/articleView?id=release-notes.rn_lwc_mixed_shadow.htm&type=5&release=238

possibility to generate typings in specific folder

Barcode api

Barcode api is not supported

Support for LocationService API

LocationService API isn't supported yet

Add noResolve=true to jsconfigs

This option prevents autocompletion from node_modules

Support for Contacts API

Contacts API isn't supported, it would be great to support it

Ignore node modules in autocompletions

Check if this is even possible and in which IDEs

dispatchEvent in Base lwc should accept customEvents

Api for platiformResourceLoader is missing

Set lib version

Set lib version to correct one, for example "lib": ["ES2021"],

Generate deeper schema

Schema imports support are supported for up to 5-level depth relationships. Currently, we are generating typings only for first level

Cookie consent support

Cookie Consent is not yet supported

Missing support for lightning/actions module

https://developer.salesforce.com/docs/component-library/documentation/en/lwc/lwc.use_quick_actions_screen

Option to generate tsconfig instead of jsconfig

When component has tsconfig, vscode enables stricter types checking.
It would be usefull to have option to generate tsconfigs instead of jsconfigs

comm__namedPage does not report all pages names

In community, autocompletion for custom pages are not provided on field name

Modal support

https://developer.salesforce.com/docs/component-library/bundle/lightning-modal/documentation

Apex class generation should generate required sobject types

When generating typings for apex it would be cool to have an option to automatically generate required sobject types

Support for refresh api

https://help.salesforce.com/s/articleView?id=release-notes.rn_lc_refreshview.htm&type=5&release=240

Better typings for querySelector

Typing for

temple.querySelector

doesn't support standard html tags. Official extension uses

HTMLElementTagNameMap

to provide typings for standard elements, maybe it could be used here

labelsData is not iterable

Error while generating labels using

sfdx typings:lwc

TypeError: labelsData is not iterable
    at ~/.local/share/sfdx/node_modules/lwc-typings-generator/lib/LabelsTypingsGenerator.js:51:36

EMP API support

It would be cool to support emp api

Support for OmniscriptBaseMixin

https://help.salesforce.com/s/articleView?id=sf.os_extend_the_omniscriptbasemixin_component_17717.htm&type=5

Fields on schema.SObejctName should be nullable

Support for new modal component

https://help.salesforce.com/s/articleView?id=release-notes.rn_lc_modal.htm&type=5&release=240

Mark cacheable methods for better ts suggestions

Check if we can mark cacheable methods is such way that using wire annotation with method that is not cacheable would result in validation error

Typings for inner classes are not genearated

ShowToastEvent fields mode and variant should not be required

staticResources is not iterable when generating typings

When I tried to generate typings for static resources, an error occurred in StaticResourcesTypingGenerator.generateTypingsForProject with message

staticResources is not iterable

Support for new Addres field in SObjects

https://help.salesforce.com/s/articleView?id=release-notes.rn_forcecom_custom_fields_address.htm&type=5&release=240

Support for Voice Toolkit API

https://developer.salesforce.com/docs/component-library/bundle/lightning-service-cloud-voice-toolkit-api

Tab names type

It would be useful to have some type that contains all tabs names, like for example in navigable component

this[NavigationMixin.Navigate]({
            type: 'standard__navItemPage',
            attributes: {
                apiName: CustomTabApiName
            },
          state: { 
                c__id: this.recordId 
           }
});

apiNames of custom tabs could be suggested by IDE

in updateRecord apiName should be optional

Error while generating stdlib

When i tried to generate standard library typings, error occurred with a message

Cannot read properties of undefined (reading 'map')

From stack trace I can see that it occurs after listing existining LWC components in org.
I presume that it was caused by the fact that there were no LWC components in my org.

Account[] acc

are generated correctly but when generic notation is used, like

List<Account> acc

generated type is any which isn't useful. Same goes for maps and sets

Invalid record types types generation

For Sobjects without Record types type for Record Types is not generated correctly. Example could be SObject PricebookEntryAdjustment where type is generate like this

type PricebookEntryAdjustment__RecordType__DevName = ;