netglue / prismic-client

PHP Api Client for Prismic.io

Net Glue Ltd

… is a small web design and development firm located in Devon, UK. We/I have been going for a pretty long time… Since around 2003.

Net Glue Ltd is mostly gsteel

There's not a huge volume of public repositories on this GitHub account - what is here, tends to be open source work relating to Laminas and Mezzio which tends to be the main frameworks and tools we use for making stuff. Also worth mentioning is the open source work we've written for working with the "Prismic" headless content management system.

If you'd like to get in touch, you can find contact details on our old and tired public website, but please bear in mind that our availablity is pretty scant at the moment.

prismic-client's Issues

Ugly Exception Message…

This should be implode(', ', ...)

prismic-client/src/Exception/ImageViewNotFound.php

Lines 14 to 21 in 5443a84

	public static function withNameAndImage(string $name, Image $image): self
	{
	return new self(sprintf(
	'The image view "%s" does not exist. Known view names are: %s',
	$name,
	implode($image->knownViews())
	));
	}

Always in Preview Mode due to Prismic Toolbar Tracking Cookies

At some point prismic started setting the preview cookie to a JSON payload containing a tracking identifier anywhere you have the toolbar installed.

This meant that there is a cookie set with a value similar to {"_tracker":"SomeUUID"} whether you are logged into the dashboard or not.

The Api::inPreview() method needs to be updated to ignore the presence of the preview cookie when it only contains tracking information

Investigate and implement the Tags Endpoint

Not sure how new this is, but it's potentially useful. Given that the initial payload includes tags anyway, it's difficult to see the point.

Tags Endpoint Documentation

Introduce a constant for the absolute max result set size

It'd be useful to define the max result set size as a public constant - it's 100

Deprecate "Bookmark" related code

Apparently, Prismic are deprecating the "bookmark" functionality of the API.

• Reference 1

• Reference 2

• Deprecate bookmarks in the next minor

• Remove in v2

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• Lock file maintenance

---

Warning

Renovate failed to look up the following dependencies: Failed to look up packagist package psr/http-client-implementation.

Files affected: composer.json

---

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency phpunit/phpunit to v11

Detected dependencies

composer

composer.json

• php ~8.1 || ~8.2 || ~8.3
• laminas/laminas-escaper ^2.9
• php-http/discovery ^1.18.0
• psr/cache ^1.0.0 || ^2.0.0 || ^3.0.0
• psr/http-client-implementation *
• psr/http-client ^1.0
• psr/http-factory ^1.0
• psr/http-message ^1.0 || ^2.0
• doctrine/coding-standard ^12.0
• laminas/laminas-diactoros ^3.3.0
• php-http/cache-plugin ^2.0.0
• php-http/curl-client ^2.3.1
• php-http/mock-client ^1.6
• phpunit/phpunit ^10.5.9
• psalm/plugin-phpunit ^0.19.0
• squizlabs/php_codesniffer ^3.8.1
• symfony/cache ^6.4.2 || ^7.0
• vimeo/psalm ^5.20.0

github-actions

.github/workflows/continuous-integration.yml

• actions/checkout v4.1.7
• shivammathur/setup-php 2.31.1
• ramsey/composer-install 3.0.0
• codecov/codecov-action v4
• actions/checkout v4.1.7
• shivammathur/setup-php 2.31.1
• ramsey/composer-install 3.0.0

.github/workflows/release-on-milestone-closed.yml

---

• Check this box to trigger a request for Renovate to run again on this repository

Predicate::hasTag() incorrect

Tag should be [['tag']] not ['tag'] in order to send an array to the api

Prismic have changed the token expiry error again

As usual, a breaking change has been made by @prismicio - When a preview token expires, the error becomes a 404 and the JSON message body is completely different.

The body now looks like this:

{
  "type":"api_security_error",
  "message":"This preview token has expired",
  "oauth_initiate":"https://something.prismic.io/auth",
  "oauth_token":"https://something.prismic.io/auth/token"
}

The PreviewTokenExpired exception needs to be updated to take this into account.

Paginated Results are Unauthenticated

Attempting to retrieve the next or previous result set fails for repositories that require a token because the URIs provided in the current result set do not include the access_token parameter

Make Query safe to serialise?

It could be very useful for queries to be serialisable. We should be able to get rid of the UriFactory usage pretty easily, and as they are immutable, queries as configuration might yield benefits for consumers

"routers" parameter for queries

Apparently, you can provide a routers query parameter to the API and it will "resolve" urls for documents and links with this information on the server returning the urls in the payload.

This means that all types would possibly contain a top-level url property and url may also be present in links that have Document type.

The documentation is pretty scant:

• https://prismic.io/docs/core-concepts/link-resolver-route-resolver#route-resolver

… but it looks like you can provide router config during initialisation and then reuse the config for every request thereafter. I assume that the config will be included in the meta-data payload as default options for the forms property.

Currently, it looks like routers should be specified as a JSON array of objects, something like this:

let routers = [
    {
        "type": "my-type", // Name of document type
        "path": "/products/:range/:category/:uid", // Where ":category" is the UID of the linked category document and ":range" is the UID of the grandparent category.range document
        "resolvers": {
            "category": "parent-category", // Top-level content relationship to a "category" type where "parent-category" is the property name of "my-type"
            "range": "category.range" // "range" is a property of "category" in this example being a content-relationship to a range document.
        }
    },
    {
        "type": "blog-post",
        "path": "/:lang/blog/:uid" // :lang is the document locale ie 'en-gb'
    },
    // Not yet known whether other types/properties are feasible such as
    {
        "type": "whatever",
        "path": "/:id/:date-published/:tags" // <- Who knows?
    }
];

Deal with BC Break in the Prismic API

Ref: #366

A new field has been added to the shape of images in the response called edit - this breaks the client because it expects the edit field to be an image view or thumbnail.

A fix is already implemented, but this edit property needs to be dealt with properly and we need new fixtures and tests for it.

GeoPoint data sometimes decodes as an integer

GeoPoint coordinates cannot be guaranteed to be a float, so it's likely that numeric values will need to be coerced.

Investigate and implement the Custom Types API

Been waiting for this for ages, but looks like something is in beta at least:

Prismic Custom Types API

This will enable programatic CRUD of shared slices and document types and will be an invaluable development tool.

Initial thoughts:

• Probably best implemented as a completely separate Client due to the fact that a specific token must be generated. Confusing the content api and a tool like this would be pretty crap
• Being able to visually diff the local version and the remote version might be really handy - or, something that could be implemented in the cli tool
• The cli tool is most likely target for consuming this feature…

Incorrect argument type for the `in` predicate

list<scalar> is not accurate, in only accepts document id or document uid of which both are strings

prismic-client/src/Predicate.php

Lines 116 to 119 in 5443a84

	/**
	* @param list<scalar> $values
	*/
	public static function in(string $fragment, array $values): self