CHANGELOG.md

Changelog

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

7.3.1 (2023-10-11)

Bug Fixes

• support expired preview token and repository not found API error (#328) (d098a7f)

7.3.0 (2023-10-09)

Features

• add @prismicio/client/richtext entry (#318) (fb555fd)
• helpers: support attribute shorthand for map serializer (#321) (b43557d)
• support expired and not-found ref API errors (#327) (26d5b0f)
• support extended media API response (#326) (5e5d057)

7.2.0 (2023-08-25)

Features

• automatically retry rate-limited requests (#319) (e0c8c49)

7.1.1 (2023-08-11)

Bug Fixes

• reduce the return type of unstable_mapSliceZone() to only include necessary properties (#308) (d52cdfd)
• throw NotFoundError when a document cannot be found (#316) (74fce89)

Documentation

• Updated tags and oauth_token definitions in repository.ts (#311) (cad174d)

Chore

• deps: update all dependencies (#307) (eb8cccc)
• deps: update dependencies (#317) (d80b64a)

7.1.0 (2023-06-07)

Features

• add unstable_mapSliceZone() (#302) (9e604d3)
• customtype: support new format property (#295) (c68a557)

Bug Fixes

• type PrismicDocument.*_publication_date as TimestampField<"filled"> (#304) (7cce22a)

7.0.1 (2023-05-22)

Bug Fixes

• properly resolve types when using TypeScript's latest module resolution strategy (#300) (a2b1084)

Documentation

• add migration guides in CHANGELOG.md (aebbfa7)
• typo (f06924c)

7.0.0 (2023-05-17)

Check out the migration guide for how to migrate to @prismicio/client v7

Bug Fixes

• update Prismic terms to use the latest language style (#293) (1fce99c)

Documentation

• update link resolver, route resolver, and rich text serializer names (#297) (a991a6c)

Chore

• @prismicio/types-internal: upgrade @prismicio/types-internal dependency (#294) (edaa83d)

6.8.0 (2023-05-15)

Features

• add fetchOptions parameter to control fetch() (#291) (a492a40)

Chore

• release: 6.8.0 (4a3773e)

6.7.3 (2022-12-19)

Chore

• deps: maintain dependencies (c821960)
• release: 6.7.3 (8f36b01)

6.7.2 (2022-12-19)

Bug Fixes

• wrong example (7dababc)

Chore

• deps: maintain dependencies (5d19954)
• release: 6.7.2 (74833e8)

7.0.0-alpha.5 (2023-05-16)

⚠ BREAKING CHANGES

• rename config htmlRichTextSerializer to serializer

Refactor

• rename config htmlRichTextSerializer to serializer (b4bdf7f)

7.0.0-alpha.4 (2023-05-09)

Features

• add fetchOptions parameter to control fetch() (#289) (88bb32d)
• client: warn when non-.cdn endpoints are used #284 (81ab2bf)
• support Web API Requests containing partial URLs (#286) (f2e8895)

Refactor

• helpers: standardize helpers interface (#288) (59f84ed)
• rename predicate tests to filter (3100b3a)

Documentation

• mark optimize option as [@experimental](https://github.com/experimental) (343534f)
• wording and style (0801785)

7.0.0-alpha.3 (2023-04-28)

Features

• add optimize options (#285) (ff5dc42)

7.0.0-alpha.2 (2023-04-22)

Features

• export AsLinkAttrsConfig (3957ab5)

7.0.0-alpha.1 (2023-04-20)

⚠ BREAKING CHANGES

• change LinkResolver's default return type to string | null | undefined

Features

• add asLinkAttrs() helper (#282) (a520aa4)
• add getToolbarSrc() helper (#281) (f0e768c)
• add HTMLRichTextSerializer export (014f15e)
• change LinkResolver's default return type to string | null | undefined (3e1fc53), closes #273
• optimize concurrent queries via shared network requests (7b72988)
• port downstream changes from @prismicio/helpers and @prismicio/types (409a6d6)

Bug Fixes

• delete fetch job even if the network request rejects (92dd2e7)
• export helper types from the correct locations (21375d1)

Refactor

• organize types, errors, and imports (#275) (90245e2)
• rename HTMLSerializer to HTMLRichTextSerializer (84088d6)
• rename predicate to filter (6e45c28)
• replace nullish coalescing with || or ternaries (#280) (d4720ad)
• use backwards compatible ||= syntax (b021748)

Documentation

• add comment about fetchJobs strategy (3fcdb42)
• port #271 fix (a3a6609)
• update documentation links (af81b62)

Chore

• add "custom" header to .prettierignore (325505d)
• deprecate orderings string values, resolves #269 (#279) (25b9019)
• deps: inline escape-html (530e49b)
• deps: maintain dependencies (4a25c66)
• deps: update all dependencies (0b0eaee)
• update .prettierrc import order (74ddbe9)
• update LICENSE (d94a9e8)

7.0.0-alpha.0 (2022-10-14)

Bug Fixes

• refactor ImageField for better isFilled.image() compatibility (44369fa)

Chore

• merge helpers and types, remove deprecated APIs (3201188)
• remove deprecated APIs (610ddbc)
• update .github (9600113)

Documentation

• fix comment typos (9b8aee0)

Refactor

• examples (e37c9af)
• make getPreviewCookie() break early (3d639a7)
• remove unused function (9b6b3bd)

6.7.1 (2022-09-08)

Bug Fixes

• widen AbortSignal for greater support of fetch implementations (#263) (70a2eb4)

6.7.0 (2022-08-23)

Features

• support Route Resolver uid, lang, and brokenRoute options (#258) (22f01c6)

Chore

• deps: upgrade dependencies (#259) (4d17090)

6.6.4 (2022-08-06)

Chore

• deps: upgrade dependencies (#253) (3beb148)

6.6.3 (2022-07-26)

Chore

• deps: upgrade dependencies (#251) (25918ab)

6.6.2 (2022-07-21)

Bug Fixes

• adjust AbortSignalLike to support native AbortSignal (#250) (62fdae1)

Refactor

• optimize getFirst() and dependent methods (#249) (ed06cec)

6.6.1 (2022-06-22)

Bug Fixes

• restore previous explicit document type parameter handling (fixes #246) (#247) (6a33564)

6.6.0 (2022-06-17)

Features

• declare document TypeScript types in createClient() (#238) (92d8f84)

Bug Fixes

• resolve issue where getTags() returned an empty array for secured repositories (#245) (b073edc)

Chore

• deps: upgrade dependencies (ed571d7)

6.5.1 (2022-05-31)

Bug Fixes

• correctly detect HTTP requests with parsed queries (#244) (d014bc8)

6.5.0 (2022-05-26)

Features

• accept Web API Request object in enableAutoPreviewsFromReq() (#240) (66e01b9)

Bug Fixes

• accept not predicate type (#241) (a1812fd)

Chore

• deps: upgrade dependencies (c3bd66c)
• remove reverted CHANGELOG entry (f93af08)

6.4.3 (2022-04-15)

Bug Fixes

• add limit to all getAll*() methods (fixes #233) (#234) (7d3e4c3)
• optimize pageSize when a limit less than pageSize is given (#236) (3bec394)

Chore

• deps: upgrade dependencies (8e27a71)
• fix coverage (933200a)

6.4.2 (2022-03-23)

Bug Fixes

• support boolean and dates in basic predicates, closes #229 (f15f606)

Documentation

• update with-express example to use a per-request client (#228) (edc8280)

Chore

• add issues workflow (5541a06)
• deps: maintain dependencies (a03704a)

6.4.1 (2022-03-10)

Bug Fixes

• cache-bust GraphQL requests made with graphQLFetch() (#227) (894e7a8)

6.4.0 (2022-03-10)

Features

• rename graphqlFetch() to graphQLFetch() (c1651ba)

Bug Fixes

• return default URL resolvePreviewURL() does not resolve a string URL (#226) (8b5a689)
• use pageSize from defaultParams if given when calling dangerouslyGetAll() (0787631)

6.3.0 (2022-02-16)

Features

• add getRepositoryEndpoint(), getRepositoryName(), isRepositoryName(), isRepositoryEndpoint(); deprecate getEndpoint() (#222) (27bf0ee)
• support providing a repository name to createClient() in place of an API endpoint (#224) (8c88382)

Chore

• deps: update dependencies (283d5f0)
• update license (91f1b61)

6.2.0 (2022-02-04)

Features

• support abortable requests via AbortController (#221) (5891a83)

Bug Fixes

• minify GraphQL queries by removing whitespace (#219) (96cad0b)
• resolve 'document.tags' expected a [list] of 'string' literals error when using tag methods with a single tag (50c78f7)

Documentation

• fix caching example by using .clone() method (#218) (52b455c)
• remove version-specific docs link (b141ba7)

Chore

• deps: update dependencies (5452f87)

Refactor

• remove type-fest dependency (f1d8124)

6.1.1 (2022-01-28)

Chore

• deps: update dependencies (d35e2da)
• support React Native's Metro bundler (9c5a38b)

6.1.0 (2022-01-18)

Features

• add getGraphQLEndpoint and Client.prototype.graphqlFetch (9b5a126)

Bug Fixes

• resolve previewed document URL any language (#208) (a7504be)

Refactor

• simplify graphqlFetch by unsupporting RequestInfo and RequestInit (580c4d5)

Documentation

• add TSDoc to Client.prototype.graphqlFetch (a883f7e)
• fix links (144b6bd)

Chore

• add build step to test script (1d0a8a7)
• add custom-timeout example (#205) (d4e55d4)
• add size limit (8eb5170)
• deps: maintain dependencies (2f337a3)
• deps: update dependencies (7e1746a)

6.0.0 (2022-01-05)

Check out the migration guide for how to migrate to @prismicio/client v6

6.0.0-beta.5 (2021-12-21)

Features

• ensure Prismic Rest API V2 endpoint is used (#203) (18faf65)
• throw NotFoundError if repository does not exist (bf7b862)

Documentation

• update README links [skip ci] (298e062)

Chore

• deps: update dependencies (3c8414d)

6.0.0-beta.4 (2021-12-03)

Bug Fixes

• add predicate aliases for smoother upgrade path (4a1f49c)

Chore

• deps: maintain dependencies (6250df3)

6.0.0-beta.3 (2021-11-09)

Features

• throttle getAll* methods and rename getAll to dangerouslyGetAll (#193) (4efdfa0)

6.0.0-beta.2 (2021-10-30)

Bug Fixes

• revert to providing access token via URL parameter (7a5140e)

6.0.0-beta.1 (2021-10-25)

Features

• add getBySomeTags, rename getByTags to getByEveryTag (#194) (37385dc)
• extend all custom errors from PrismicError (c4be6ce)
• use authorization header for access token (#192) (42af240)

Bug Fixes

• on getAll methods, use MAX_PAGE_SIZE when pageSize param is falsey (#195) (46b638a)

Chore

• deps: update dependencies (e7dbd7f)
• mark package as side effect free (dc02db7)

Refactor

• optimize code for bundle size (#196) (9dc32e0)

6.0.0-beta.0 (2021-09-29)

Chore

• deps: maintain dependencies (312ce48)
• update template config (8dbc214)

6.0.0-alpha.15 (2021-09-14)

Chore

• update @prismicio/types and @prismicio/helpers (c4e00a1)

6.0.0-alpha.14 (2021-09-14)

Chore

• update dependencies (a383ec7)

6.0.0-alpha.13 (2021-09-10)

Features

• add getByUIDs and getAllByUIDs (52a8cc9), closes #191

6.0.0-alpha.12 (2021-09-09)

Features

• use API types from @prismicio/types (632c2ae)

Bug Fixes

• builds (5f49827)
• use "ID" over "Id" in method names (2bcdabf)

6.0.0-alpha.11 (2021-08-24)

Features

• provide routes as top-level client options (69f2002)

Chore

• update dependencies (d70c228)

6.0.0-alpha.10 (2021-08-19)

Chore

• update dependencies (1d7723f)

6.0.0-alpha.9 (2021-08-17)

Bug Fixes

• allow optional Link Resolver in resolvePreviewURL (4321921), closes #183
• mark resolvers as optional in Routes (d84658a)
• use "main" as primary branch (c4c02e6)

Chore

• revert previous commit (a0cf5cb)
• update dotfiles per standard template (5f4dee0)
• update pull request template (f618d62)

6.0.0-alpha.8 (2021-07-06)

Bug Fixes

• support unauthorized repository response (022d278)
• use access_token URL parameter over Authorization header (#182) (4c44109)

Chore

• deps: update examples dependencies (1c8f2b2)

6.0.0-alpha.7 (2021-07-03)

Bug Fixes

• use in predicate for getByIDs (fc522a2)

6.0.0-alpha.6 (2021-07-03)

Chore

• update dependencies (2a18d2e)
• update dependencies (eb9b13e)

6.0.0-alpha.5 (2021-06-27)

Bug Fixes

• use @prismicio/helpers for resolvePreviewURL (2db45d2)

5.1.0 (2021-06-11)

6.0.0-alpha.4 (2021-06-23)

Bug Fixes

• support global fetch if provided explicitly (d22ae21)

6.0.0-alpha.3 (2021-06-23)

Features

• support Route Resolver with routes param (063b5ee)

Bug Fixes

• resolve issue using global fetch (83c6290), closes #180
• throw if an invalid fetch function is given (ec01c59)

Refactor

• simplify SimpleTTLCache and add internal docs (f255a27)

6.0.0-alpha.2 (2021-06-11)

Features

• add wrapper errors (3dfba0f), closes #177
• return API error message on failed requests (8de2873)

Chore

• rename license file (f496697)

6.0.0-alpha.1 (2021-06-07)

Features

• [wip] cache master ref for a short period (b73a7d0)
• support cached refs for releases (7a46513)

Bug Fixes

• use cjs export to support non-esm (63219e8)

Chore

• add test dir format script (e4594f5)

Documentation

• add internal comments (61d4c14)

5.0.0 (2021-05-27)

Chore

• release: 5.0.0 fix (ed15e96)

6.0.0-alpha.0 (2021-05-27)

5.0.0-alpha.1 (2021-05-27)

Chore

• fix release script (23bcc88)

5.0.0-alpha.0 (2021-05-27)

Features

• add "query from" methods and replace ref with release (7d894a5)
• add getAllByIDs (297a70c)
• add getTags (164c8d5)
• add initial client (ee886bd)
• add release-specific methods (wip) [skip ci] (4f66405)
• add resolvePreviewUrl (53ed409)
• export HttpRequestLike (96f1e1e)
• export predicates under root package (18d742c)
• expose HTTPError (fdf370a)
• restore form type (c38e067)
• restore ref methods and scope release methods (1ff8f72)
• use normalized HTTPError (0eb9fab)

Bug Fixes

• asc orderings direction should not be included in query (46431fd)
• clone responses for better cache support (67ef2ba)
• correct typings and predicate generation fn (c81da44)
• export types using export type (a1fad4a)
• getByIds should return paginated results (fb94561)
• ignore nullish ordering param (51e53b7)
• use correct uid predicate for getByUID (5735d28)
• widen types of fetch-related APIs (412205b)

Documentation

• add comment to server-usage example (b04d359)
• add custom-caching README (ec26d6a)
• add examples (62004a0)
• add multiple-languages example (9d9592d)
• add server-usage example (c4b2e2f)
• add TSDoc for all client methods (01cd9d9)
• add TSDocs for client instance properties (15d0187)
• add TSDocs to remaining functions (38052d2)
• add with-typescript example (5c7f396)
• describe internal predicate functions [skip ci] (e4fed22)
• fix badges (7fd6541)
• fix orderings parameter sketch (0f43762)
• more descriptive getResolvedRefString comment [skip ci] (d9ae04b)
• new kit name typos fixes #152 (873bd58)
• refactor custom-caching example (9dd2daa)
• remove inaccurate docs (974d160)
• replace remaining usage of @see with @link (02feadc)
• update comment wording (3535c32)
• update README (1a9c5b8)
• use {@link} and @typeParam (2d2a2c5)

Refactor

• assume the cookie store is always a string (5d563b0)
• client (f0c5206)
• explicitly export types (b5b34fe)
• export all in root (2bdfd3f)
• internal predicate fns for readability (731a444)
• remove ref methods (a333921)
• remove unnecessary abstraction (d976a11)
• revert tags refactor (0240a18)
• share code among tags and ref fns (5c9e7ea)
• share fetch types (a91a6c3)
• use @prismicio/types where possible (bb2b514)

Chore

• deps: bump @prismicio/types (a21a8fd)
• add .editorconfig (535206a)
• add code coverage via nyc (7c2643b)
• add commitlint for conventional commits (81107c0)
• add examples (4163944)
• add LICENSE.md (b5e77a6)
• add release scripts (515722d)
• add simple example to README [skip ci] (a384c8f)
• add status to README [skip ci] (865362e)
• add test CI (5856481)
• add TODO to migrate to @prismicio/types when ready (5f2c580)
• add TODO to widen fetch type (f8dcee9)
• bootstrap v5 (107ca1b)
• fix nyc (5bb1f23)
• fix package.json version (757a46d)
• maintain dependencies (0482128)
• mirror @prismicio/helpers project config (155065e)
• move git-simple-hooks config (c17d070)
• new README (5694f3b)
• update dependencies (508df11)
• update dotfiles to match repo (79017f4)
• update IDEAS based on feedback (8bd6754)
• upgrade dependencies (7cb449a)
• upgrade dev dependencies (cb167e4)