feat!: update model type definitions to match `@prismicio/types-internal`

[lihbr]

This is an attempt as making sure external type definitions for models match internal ones, but I kinda hate it 🤔

• We lose a lot of precision and DX in some of the types as @prismicio/types-internal accounts for a lot of legacy property (useAsTitle for example, or placeholder on images);
• Model config property is always fully optional in @prismicio/types-internal, but I think that's because it catches errors manually after if some "required" config properties are missing, I don't think it's representative of real config object;
• This very likely break @prismicio/mock as well as prismic-ts-codegen.

From what I experienced:

• Types from @prismicio/types are usually proper extends of @prismicio/types-internal types
• Types from @prismicio/types-internal are never proper extends of @prismicio/types types, this mainly due because @prismicio/types-internal uses an enum for field types (see: https://github.com/prismicio/prismic-types-internal/blob/HEAD/src/customtypes/widgets/WidgetTypes.ts)

As stated in the branch name, this is really just an experimental PR, it caught a few errors at least (namely, placeholder_true/placeholder_false on external boolean model type)

[codecov-commenter]

Codecov Report

Merging #43 (b88f47d) into master (f7c39e3) will not change coverage. The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master       #43   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines         1698      1768   +70     
  Branches         7         7           
=========================================
+ Hits          1698      1768   +70     

Impacted Files	Coverage Δ
src/customType.ts	100.00% <100.00%> (ø)
src/index.ts	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update f7c39e3...b88f47d. Read the comment docs.

[lihbr]

OK, so I refactored the PR following our discussion so that we only focus on having external types (these types) being compatible with internal types.

const fn = (obj: ExternalType) => {};

const internal: InternalType = {};
const external: ExternalType = {};

fn(internal); // OK
fn(external); // OK

I tried to shave it down to what made sense, however, I couldn't get rid of:

• Range type being an alias of the Number type (valid but undocumented/not maintained)
• Separator type being deprecated and broken (crashes on document saving)
• LegacySlices type being deprecated and broken (crashes custom type editor)

Let me know if you think those updated types seem manageable by prismic-ts-codegen and if you have any better idea on how to better hide the 3 above~

[lihbr]

Alright, fixed style and reverted back readonly's as discussed above.

Right now @prismicio/types are properly compatible with object types with @prismicio/types-internal, not the other way around. We'll add test back for those when we get @prismicio/types object compatible with @prismicio/types-internal.

[arnaudlewis]

Ongoing draft PR on types-internal to simplify the integration: https://github.com/prismicio/prismic-types-internal/pull/3

[lihbr]

Ongoing draft PR on types-internal to simplify the integration: prismicio/prismic-types-internal#3

Added back two-ways test with 0b872c7, tested with https://github.com/prismicio/prismic-types-internal/pull/3 and everything passes cleanly 🙌

edit: I don't get why types is passing in the CI since it doesn't have the PR yet 🤔 https://github.com/prismicio/prismic-types/runs/7090783719?check_suite_focus=true#step:7:1, locally it's not passing without the PR

[angeloashmore]

I corrected a small error in a test and made the link field tests more specific.

I'm going to merge and publish this PR. We can adjust the link field tests later if there's something we need to change.