Custom command cannot be found on keyof Chainable<any> when parameter types are imported.

[J-Benyon]

If we take a look at this example commands.ts file here

declare namespace Cypress {
    interface Chainable {
      artefact: (testArtefact: string) => void;
    }
}

Cypress.Commands.add('artefact', (testArtefact: string) => {
    return testArtefact;
});

This works perfectly file, and the custom command can be used as normal, however when I import something from a types.ts file, it no longer can find the value, as shown below.

import { TestArtefact } from './types';

declare namespace Cypress {
    interface Chainable {
      artefact: (testArtefact: string) => void;
    }
}

Cypress.Commands.add('artefact', (testArtefact: string) => {
    return testArtefact;
});

We get the error Argument of type '"artefact"' is not assignable to parameter of type 'keyof Chainable<any>' even thoough nothing has changed with the custom command itself.

This is my types.ts

export enum GroupBrands {
    Brand1,
    Brand2,
    Brand3
}

export type OMSResult = {
    orderTotal: number;
    email: string;
    deliveryMethodName: string;
    paymentMethod: string;
    item: Array<Record<string, string | number>>;
}

export enum DeliveryMethod {
    uk,
    eu,
    dpd
}

export enum PaymentMethod {
    Card,
    Finance
}

export enum TestScenario {
    CompleteOrder,
    FullRefund,
    PartialRefund,
    Cancellation,
    PartialCancellation,
    FullGCRefund,
    GCRefund,
    GCPartialRefund
}

export enum Locale {
    UK,
    US,
    IE,
    FR,
    GR,
    IT
}

export type ProductLine = {
    sku: string;
    quantity: number;
}

export type TestArtefact = {
    orderNumber: string;
    orderTotal: number;
    orderEmail: string;
    deliveryMethod: DeliveryMethod;
    paymentMethod: PaymentMethodChangeEvent;
    items: Array<ProductLine>;
    groupBrand: GroupBrands;
    testScenario: TestScenario;
    locale: Locale;
}

What could be causing this?

[trungne]

I have the same problem. To fix this, you need to move your import statements inside the namespace, that should do it. I follow the docs' provided repo here. https://github.com/cypress-io/cypress-realworld-app/blob/develop/cypress/global.d.ts

[a-di-ez]

same issue after upgrade to 12

this only applies to files with this declaration:

declare namespace Cypress {
    interface Chainable {

try change to:

declare global {
    namespace Cypress {
        interface Chainable {