Package detail

@prismicio/types

prismicio390.4kApache-2.00.2.9

Type definitions for Prismic related structure

typescript, types, utils, toolbox

readme

Note: This package has been merged into @prismicio/client ≥ v7.

This package and repository will no longer be updated, except in special circumstances.

@prismicio/types

npm version npm downloads Github Actions CI Codecov Conventional Commits License

⚠ This project is in an experimental state and therefore primarily meant to be used by Prismic kits. Use it at your own risks or stay tuned for the official release!

Type definitions for Prismic related structure.

  • 📄  Per-field type definitions;
  • 🌐  Dedicated GraphQL API support.

Install

npm install --save-dev @prismicio/types

Documentation

To discover what's new on this package check out the changelog. For full documentation, visit the official Prismic documentation.

Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!

Asking a question: Open a new topic on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.

Reporting a bug: Open an issue explaining your application's setup and the bug you're encountering.

Suggesting an improvement: Open an issue explaining your improvement or feature so we can discuss and learn more.

Submitting code changes: For small fixes, feel free to open a pull request with a description of your changes. For large changes, please first open an issue so we can discuss if and how the changes should be implemented.

For more clarity on this project and its structure you can also check out the detailed CONTRIBUTING.md document.

License

   Copyright 2013-2022 Prismic <contact@prismic.io> (https://prismic.io)

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

0.2.9 (2024-05-24)

Features

  • backport extended media API response (#58) (ef1d286)

Documentation

  • link to @prismicio/client (9971531)

0.2.8 (2023-05-31)

Bug Fixes

  • backport IntegrationFields to IntegrationField rename from @prismicio/client v7 (#57) (0537151)

0.2.7 (2022-12-19)

0.2.6 (2022-12-19)

0.2.5 (2022-12-19)

Chore

  • deps: maintain dependencies (f5cbcd2)

0.2.4 (2022-11-16)

Bug Fixes

  • allow ContentRelationshipField's data property to be overrided (#51) (fd7bb34)

Chore

0.2.3 (2022-08-22)

Documentation

Refactor

Chore

0.2.2 (2022-08-12)

Documentation

0.2.1 (2022-08-05)

Features

0.2.1-alpha.1 (2022-08-02)

Refactor

Chore

0.2.1-alpha.0 (2022-07-28)

Features

Chore

0.2.0 (2022-07-08)

⚠ BREAKING CHANGES

  • update model type definitions to match @prismicio/types-internal (#43)

Features

  • update model type definitions to match @prismicio/types-internal (#43) (e283d99)

Bug Fixes

  • add imageUrl to SharedSliceModelVariation (#42) (f7c39e3)

0.1.29 (2022-06-13)

0.1.28 (2022-06-09)

Bug Fixes

  • add [@deprecated](https://github.com/deprecated) tag to slugs document property (#36) (d5951ca)
  • correct IntegrationFields to not use the Integration Fields API shape (#40) (33b8e24)

Chore

  • deps: upgrade dependencies (c44af72)
  • upgrade to latest Prismic package standards (#37) (97714c3)

0.1.27 (2022-03-03)

Bug Fixes

  • ImageField should be a valid ImageFieldImage extension (#32) (87681d4)
  • image thumbnail state should be the same as the master image (82ee5c6)

0.1.26 (2022-02-28)

Bug Fixes

0.1.25 (2022-02-18)

Bug Fixes

  • fields: api can yield an empty string for keytext field in certain cases (#26) (70fec9f)

Chore

0.1.24 (2022-02-09)

Features

  • document: use looser default data (60e0283)

Refactor

  • fields: use oembed specs for embed field (#24) (8e254a2)

0.1.23 (2022-02-03)

Features

  • support unknown EmbedField properties by default (#23) (de4880d)

0.1.22 (2022-01-28)

Chore

  • support React Native's Metro bundler (aed51a3)

0.1.21 (2021-12-20)

Features

  • add PrismicDocumentWithUID and PrismicDocumentWithoutUID (49b4f1b)
  • add webhook types (60d709d)

Refactor

0.1.20 (2021-12-16)

Bug Fixes

  • constrict SelectField values to string (ac1a973)
  • filled Group and Slice Zone fields contain at least one element (f60a20e)

0.1.19 (2021-12-03)

Chore

  • deps: maintain dependencies (c2a2a6c)

0.1.18 (2021-11-17)

Bug Fixes

  • prevent compatibility issues with enum types (#18) (508fb73)

0.1.17 (2021-11-04)

Bug Fixes

  • correct Title block spans field (912359b)

0.1.16 (2021-11-04)

Features

  • support stateful Rich Text and Title fields (367ea03)

Bug Fixes

  • narrow link data field type (3c7fdca)

Chore

  • maintain template (b17ae84)
  • separate type tests into types script (d4ea1e9)

0.1.15 (2021-10-12)

Features

  • add State generic to field types (#13) (368d968)
  • add ThumbnailNames generic to CustomTypeModelImageField (28b58a0)
  • export FieldState (97cee39)

Chore

  • deps: update dependencies (646a4ce)
  • mark package as side effect free (8ad52cf)
  • sort package.json (7e233f3)

0.1.14 (2021-10-05)

Documentation

  • add graphql and document field TSDocs (#12) (ff2c36e)

Chore

  • prettier ignore CHANGELOG (ada0e7b)

0.1.13 (2021-09-23)

Bug Fixes

  • use non-const enum for Element (ddae971)

0.1.12 (2021-09-14)

Chore

0.1.11 (2021-09-14)

Features

  • add empty/filled Image field (a05bb5d)

Bug Fixes

  • type ImageField as nullable (3f60434)

0.1.10 (2021-08-20)

Features

Bug Fixes

  • export API types using export type (b4a9565)

0.1.9 (2021-08-19)

Features

Bug Fixes

  • use standard "Integration Fields" name (8f303d2)

0.1.8 (2021-08-19)

0.1.7 (2021-08-19)

Features

Chore

  • add TSDoc plugins for ESLint and Prettier (4ad8db0)

Documentation

0.1.6 (2021-08-11)

Bug Fixes

  • add customtypes and tags to CustomTypeModelContentRelationshipField (c274837)
  • allow null alt on Rich Text image blocks (e531e2c)
  • export CustomTypeModelDefinition (79a5011)
  • normalize Rich Text embed block with Embed field (14f32ff)
  • use more flexible Option generic for CustomTypeModelSelectField (6eaeba4)

Chore

0.1.5 (2021-08-04)

Features

  • add CustomTypeModelDefinition and restructure CustomTypeModel (453328c)

0.1.4 (2021-07-14)

Bug Fixes

  • export SharedSlice and SharedSliceVariation (02498d3)

0.1.3 (2021-07-14)

Features

  • add SharedSlice and SharedSliceVariation (cd9db5f)

Chore

  • update pull request template (c8b2339)

0.1.2 (2021-07-07)

Features

Bug Fixes

  • image node can feature a linkTo property (fa3adba)

Chore

  • add integration field to regular field type list (0bb0e25)

0.1.1 (2021-07-03)

Bug Fixes

  • add data property to FilledLinkToDocumentField (cc62bf0), closes #1
  • looser SharedSliceModel variation generic (b97f2c1)

0.1.0 (2021-07-01)

⚠ BREAKING CHANGES

  • rename CustomType prefix to CustomTypeModel

Features

  • add Shared Slice types (c815c2d)
  • rename CustomType prefix to CustomTypeModel (7a493eb)

0.0.12 (2021-07-01)

Features

Chore

0.0.11 (2021-06-25)

Bug Fixes

0.0.10 (2021-06-23)

Features

Chore

  • deps: maintain dependencies (ddeac23)
  • prefer npm as a package manager (b028ec8)
  • update prettier config (f8449ef)

0.0.9 (2021-06-15)

Bug Fixes

  • rich text span definition (e43ac1f)

Chore

  • deps: maintain dependencies (3077caf)

0.0.8 (2021-06-11)

Features

  • allow GroupField generic value (006fbe0)

Chore

Refactor

  • use Record over object literal syntax (b8fa931)

0.0.7 (2021-05-27)

Chore

0.0.6 (2021-05-20)

Bug Fixes

  • use less strict typing for link type (d9e02e3)

Chore

0.0.5 (2021-05-18)

Features

  • use less strict type for link types (6365216)

Chore

  • config: run lcov reporter for codecov collection (6760c57)
  • config: setup tests (b0942e9)
  • config: update coverage reporters (3d456c3)

0.0.4 (2021-05-17)

Bug Fixes

  • document: alternate language typing (bce6ceb)

Chore

  • deps: maintain dependencies (c113013)

Documentation

  • update readme and issue template (f9bb134)

0.0.3 (2021-05-11)

⚠ BREAKING CHANGES

  • rename link exports for consistency

Features

  • add graphql support (080b640)
  • export embed types and empty link field type (6039947)

Refactor

  • rename link exports for consistency (35338fd)

0.0.2 (2021-05-10)

Features

  • document: add prismic document header and document (924f324)
  • fields: expose filled link fields (86846e6)

0.0.1 (2021-05-10)

Features

Chore