README

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, and do the same for 'Shared Slices'

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

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).

It's worth noting that document types and slices are not validated in any way. That's up to you, but, you should get descriptive exceptions when your JSON doesn't validate on the remote server.

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
)

Usage

CRUD for Document Types

use Prismic\DocumentType\Client;
use Prismic\DocumentType\Definition;

assert($client instanceof Client);

// Insert or update a document type:
$client->saveDefinition(Definition::new(
    id: 'my-type',
    label: 'Some Label',
    repeatable: true,
    active: true,
    json: $someJsonPayloadAsAString,
));

// Fetch all remote document type defs
$client->fetchAllDefinitions();

// Fetch a single definition
$client->getDefinition('some-type');

// Delete a document type definition
$client->deleteDefinition('some-type');

CRUD for Shared Slices

use Prismic\DocumentType\SharedSlice;use Prismic\DocumentType\SharedSliceManagementClient;

assert($client instanceof SharedSliceManagementClient);

// Insert or update a slice def:
$client->saveSharedSlice(SharedSlice::new(
    id: 'some-slice-id',
    json: $someJsonPayloadAsAString, 
));

// Fetch all slice defs:
$client->fetchAllSharedSlices();

// Fetch one slice def:
$client->getSharedSlice('whatever');

// Delete a shared slice:
$client->deleteSharedSlice('some-id');

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.

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.

netglue / prismic-doctype-client

Maintainers

Details