What's the correct type for defining a TinaCollection?

[coreyaus]

Issue

Since I upgraded tinacms past version 0.66.9 the TinaCollection/TinaCloudCollection types have been throwing the following type errors in my schema.ts:

Current types in use

That TypeScript error appears in schema.ts when running code like the following:

import pagesCollection from './schema/collections/pages'

export default defineSchema({
    collections: [pagesCollection],
})

As you can see in the screenshot above, the TS error appears on the collections: [pagesCollection] line. It claims that the types expected for that collections property are not compatible with the TinaCollection or TinaCloudCollection types used in the pagesCollection file, which are:

import type { TinaCollection, TinaCloudCollection } from '@tinacms/cli'
const pagesCollection: TinaCollection | TinaCloudCollection = {
    label: 'Pages',
    name: 'pages',
    path: 'content/pages',
    fields: [...],
}
export default pagesCollection

Question

I'd love to know whether there is something wrong with those types and what the correct version should be. The types above worked fine when running [email protected] so I'm not sure what might have changed and whether there is now a different way to import those types.

Thanks a bunch for any help you can offer!

Other things I've tried

1. Importing from the tinacms package rather than the @tinacms/cli package

   • i.e. import type { TinaCollection, TinaCloudCollection } from 'tinacms'
   • That throws a different error shown in the screenshot below

2. Using TinaCloudCollection<false> as the type, rather than just TinaCloudCollection

   • That's essentially what is suggested here: how to simplify the long path "_@[email protected]@@tinacms/schema-tools/dist/types/SchemaTypes" #2909, but it throw the following error:

   Type 'TinaCloudCollection' is not generic.ts

[coreyaus]

I think the underlying issue here is now resolved - there are further notes in this PR: #2793

It seems the correct option is not to import defineSchema from 'tinacms' (and also import the TinaCollection type from that library)