Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@prismicio/custom-types-client

prismicio270.2kApache-2.02.1.0TypeScript support: included

JavaScript client to interact with the Prismic Custom Types API

typescript, prismic

readme

@prismicio/custom-types-client

npm version npm downloads Github Actions CI Codecov Conventional Commits License

JavaScript client to interact with the Prismic Custom Types API.

  • 🎣  Fetch Custom Type and Shared Slice models
  • 🛠  Insert, update, and delete models

Install

npm install @prismicio/custom-types-client @prismicio/client

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, check out the detailed CONTRIBUTING.md document.

License

Copyright 2013-2024 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.

2.1.0 (2024-06-20)

Features

Documentation

2.1.0-alpha.0 (2024-06-06)

Features

  • support groups in groups (e49feea)

2.0.0 (2024-06-04)

⚠ BREAKING CHANGES

  • bulk-update: drop support for bulk endpoint

Features

  • bulk-update: replace bulk by bulk-update endpoint (#15) (477d2f7)
  • pass arbitrary options to fetch() with the fetchOptions parameter (#9) (ae76fe8)
  • support bulk transactions (#10) (38968f7)

Bug Fixes

  • make @prismicio/client a peer dependency (#14) (99d2b67)
  • replace @prismicio/types with @prismicio/client (#11) (77474e6)

Chore

2.0.0-alpha.1 (2024-05-29)

2.0.0-alpha.0 (2024-05-29)

⚠ BREAKING CHANGES

  • bulk-update: drop support for bulk endpoint

Features

  • bulk-update: replace bulk by bulk-update endpoint (abfcd13)
  • pass arbitrary options to fetch() with the fetchOptions parameter (#9) (ae76fe8)
  • support bulk transactions (#10) (38968f7)

Bug Fixes

  • make @prismicio/client a peer dependency (#14) (99d2b67)
  • replace @prismicio/types with @prismicio/client (#11) (77474e6)

Chore

1.3.1 (2024-04-17)

Bug Fixes

  • make @prismicio/client a peer dependency (#14) (99d2b67)

1.3.0 (2024-01-27)

Features

Bug Fixes

  • replace @prismicio/types with @prismicio/client (#11) (77474e6)

Chore

1.2.0 (2023-12-05)

Features

  • pass arbitrary options to fetch() with the fetchOptions parameter (#9) (ae76fe8)

1.1.0 (2023-03-28)

Documentation

1.1.0-alpha.1 (2023-03-27)

Features

  • support 401 Unauthorized errors (937aabd)

1.0.2 (2022-12-19)

Bug Fixes

  • no longer require /customtypes in the endpoint option (#6) (62f1950)

1.0.1 (2022-12-15)

Bug Fixes

  • don't append trailing slash twice to endpoint (8154b96)

Chore

1.1.0-alpha.0 (2022-12-13)

Features

  • allow easier class extension (e2586c8)

Chore

  • deps: maintain dependencies (8669412)

1.0.0 (2022-09-03)

⚠ BREAKING CHANGES

  • remove deprecated getAll(), getByID(), insert(), update(), and remove() methods (#4)

Features

  • remove deprecated getAll(), getByID(), insert(), update(), and remove() methods (#4) (05dcb18)

Bug Fixes

  • use narrower type for FetchLike (#3) (a62a894)

0.0.7 (2022-03-17)

Features

  • rename Custom Type-related methods to include "CustomType" (#2) (999b3f7)

0.0.6 (2021-09-14)

Chore

  • update @prismicio/types (91c27d7)

0.0.5 (2021-09-14)

Chore

0.0.4 (2021-08-11)

Chore

  • add eslint-plugin-tsdoc and prettier-plugin-jsdoc (71a7746)
  • update dependencies (74a11fc)

0.0.3 (2021-07-14)

Bug Fixes

  • use correct Shared Slices endpoints (5e073be)

Chore

0.0.2 (2021-07-13)

Bug Fixes

  • correct return type for getAll (f6a96a4)

Chore

  • remove private property from package.json (ee5e207)

0.0.1 (2021-07-08)

Features

  • complete implementation with tests (6e98185)
  • initial commit (f08fc82)

Documentation

Chore

  • move @prismicio/types to devDependencies (e8e1623)
  • update dependencies (5f714a4)
  • update pull request template (422078a)