Invalid apex.d.ts type defs are generated by the VSCode extension

[guillaumelachaud]

Description

Steps to Reproduce

• Create a new SFDX Project using the VSCode extension
• Enable Typescript support
• Use refreshApex in a LWC component

Expected Results

The type definitions have been generated properly and the component can compile

Actual Results

tsc will complain:

Module '"@salesforce/apex"' has no exported member 'refreshApex'.ts(2305)

Which appears to be true. An apex.d.ts appears to have been generated by the VSCode extension in .sfdx/typings/apex/ with the following code:

declare module "@salesforce/apex" {
    /**
     * Identifier for an object's field.
     */
    export interface FieldId {
        /** The field's API name. */
        fieldApiName: string;
        /** The object's API name. */
        objectApiName: string;
    }

    /**
     * Services for Apex.
     */
    export interface ApexServices {
        /**
         * Refreshes a property annotated with @wire. Queries the server for updated data and refreshes the cache.
         * @param wiredTargetValue A property annotated with @wire.
         * @returns Promise that resolves to the refreshed value. If an error occurs, the promise is rejected.
         */
        refreshApex: (wiredTargetValue: any) => Promise<any>;

        /**
         * Gets a field value from an Apex sObject.
         * @param sObject The sObject holding the field.
         * @param field The field to return.
         * @returns The field's value. If it doesn't exist, undefined is returned.
         */
        getSObjectValue: (sObject: object, field: string | FieldId) => any;
    }
}

The type def expose an interface with refreshApex but it is not clear how to use this. Rewriting the type def manually as follows works:

declare module "@salesforce/apex" {
    export function refreshApex(wiredTargetValue: any): Promise<any>;
  }

Is it expected for the generated apex.d.ts to be incorrect?

[wjhsf]

Thanks for filing this issue! This repo is just for the LWC framework itself. If you're having issues with the VS Code extension, you should file an issue in the repo for that project (forcedotcom/salesforcedx-vscode).

This specific issue occurs because the Lightning Language Server copies types from @salesforce-namespaced npm packages into the .sfdx/typings directory. One goal on our roadmap for TypeScript support is to remove this behavior and rely on TypeScript's ability to read from node_modules directly. Part of that effort is tracked at forcedotcom/lightning-language-server#602.

The types you are seeing are the types currently published by @salesforce/apex. That package doesn't have a public repo, but I'll explore internally to see who's responsible.