Provide better Typescript definition files

Hi Prismic folks 😃

I’m trying to use the nodejs package with its bundled d.ts files. However, types are not properly imported when using the module. It comes from several facts:

• First, this comes from the way the module is declared, ie. using a namespace. declare namespace Prismic {...} & export = Prismic;. Only what is in the namespace is visible if i’m not mistaken.
• As a library, the barel file (index.d.ts) should re-export all public APIs. When fetching the api object with Prismic.getApi(...), I cannot write the proper response type since the PrismicApi type is hidden in the namespace.

It could be better to change the namespace to a plain object while re-exporting all sub modules. This way, both the Prismic object and all APIs are visible.

Last but not the least, a little quote from the TS documentation :

Exporting a namespace from your module is an example of adding too many layers of nesting. While namespaces sometime have their uses, they add an extra level of indirection when using modules. This can quickly become a pain point for users, and is usually unnecessary.

What do you guys think ?

[evolkmann]

Unfortunately this is still open. I guess the issue could be resolved for many of us if d.ts/index.d.ts would also export the other parts of the declaration files, for example ResolvedApi.d.ts.

Now with Angular 9, the compiler issues a warning about the deep import paths, for example here: https://github.com/exportarts/ngx-prismic/issues/109.

I wonder if there is even still the need for separate d.ts files since the project is written in typescript anyway (see #69). What do you think?

[FibHeap]

with typescript > 2.8 this should work

import * as Prismic from 'prismic-javascript'

type ThenArg<T> = T extends Promise<infer U> ? U : T
type PrismicAPIPromise = ReturnType<typeof Prismic.getApi>
type PrismicAPI = ThenArg<PrismicAPIPromise>