@nexdk/driver-symfony

API Platform (Symfony) REST driver over Hydra / JSON-LD. Built with defineDriver.

Install

Not published to npm yet. Build it from the repository (packages/drivers/symfony).

Once published, install the package with everything it needs:

pnpm add nexdk @nexdk/http @nexdk/driver-symfony

Config

import { createSdk } from 'nexdk'
import { createSymfonyDriver } from '@nexdk/driver-symfony'

const sdk = createSdk({
  drivers: {
    symfony: createSymfonyDriver({
      baseUrl: 'https://api.example.com',
      headers: async () => ({ Authorization: 'Bearer …' }),
    }),
  },
})

const { data: books } = await sdk.symfony.books.get({ page: 1 })

Methods

Method	Maps to	Notes
get(query?, onEvent?)	GET /{resource}	Returns hydra:member, else member, else the body. One request, no page following: the server returns 10 items unless you pass itemsPerPage. The array carries a non-enumerable pagination property with totalItems and view.
find({ id }, onEvent?)	GET /{resource}/{id}	Returns one record.
create(body, onEvent?)	POST /{resource}	Content-Type: application/ld+json.
update({ id, ...fields }, onEvent?)	PATCH /{resource}/{id}	Content-Type: application/merge-patch+json, which API Platform requires.
remove({ id }, onEvent?)	DELETE /{resource}/{id}	Returns { success: boolean }.

Requests send Accept: application/ld+json. Any header can be overridden through headers, except the Content-Type of update, which stays application/merge-patch+json. The resource name and the id are URL-encoded.

fetch is optional: pass any function (input, init?) => Promise<Response> (the FetchLike type, exported by nexdk and @nexdk/http) and every HTTP request goes through it instead of globalThis.fetch, for example mock.fetch from shamock or the fetch of bun-types, without a cast.

Compared with nest, the differences are the Hydra unwrap and the merge-patch content type.

Errors

A failure emits error with { message, status, errors }, then throws an HttpError. The message is the backend message when there is one and errors is normalized to { field: [message] } when possible (see @nexdk/http); data keeps the raw body. The thrown error and the event carry the same status and errors. The timeout (milliseconds) and signal (AbortSignal) config options abort a request with a status 0 error; neither is set by default. A resource name that is empty, . or .. is refused like an id.