netglue/prismic-doctype-client

Prismic Custom Type API Client

0.1.2 2021-12-16 10:44 UTC

README

Build Status

codecov Psalm Type Coverage

Latest Stable Version Total Downloads

Introduction

This library provides an API client so that you can read and write your document type definitions using the Prismic Custom Types API.

Currently, you can list, read, insert and update document types.

The client requires that you make use of (And similarly, it returns instances of) the shipped Definition value object.

Typically, you wouldn't interact with the client directly, but as part of a build process that takes care of all that stuff for you. This client is quite fresh, but it's primary use will soon be part of netglue/prismic-cli, so that it will become trivial to synchronise your local development document definitions with those in your production Prismic repository (and vice-versa).

Installation

The only supported installation method is via composer:

composer require --dev netglue/prismic-doctype-client

Configuration

The client has been designed to work with whatever PSR-18 HTTP Client and PSR-7 and PSR-17 implementations that you like to use. Once you have got hold of an API token for the custom types API, you can create a client with:

<?php
use Prismic\DocumentType\BaseClient;

$client = new BaseClient(
    'some-token',
    'my-repository-name',
    $httpClient,     // \Psr\Http\Client\ClientInterface
    $requestFactory, // \Psr\Http\Message\RequestFactoryInterface
    $uriFactory,     // \Psr\Http\Message\UriFactoryInterface
    $streamFactory   // \Psr\Http\Message\StreamFactoryInterface
)

Limitations/Roadmap

Authentication

Currently, authentication is only possible with a permanent access token that you create/retrieve from the Prismic repository settings. Session based tokens are not supported.

Slices

CRUD operations on shared slices are not yet implemented but are planned for future development. If you really want this feature, you're welcome to contribute.

Contributing

Please feel free to get involved with development. The project uses PHPUnit for tests, Psalm for static analysis and Infection for mutation testing. CI should have your back if you want to submit a feature or fix ;)

License

MIT Licensed.

Changelog

See CHANGELOG.md.