JS-CRUD-API

v0.4.2 — JavaScript client library for PHP-CRUD-API

Zero runtime dependency. Uses native fetch. 68 lines of source code.

Installation

npm i js-crud-api

import jscrudapi from 'js-crud-api';
const jca = jscrudapi('http://localhost/api.php');

Or via HTML:

<script src="min.js"></script>
<script>
  const jca = jscrudapi('http://localhost/api.php');
</script>

Quick example

// List
jca.list('posts', { filter: 'id,gt,5', order: 'id,desc' });

// CRUD
jca.read('posts', 1);
jca.create('posts', { title: 'Hello' });
jca.update('posts', 1, { title: 'Updated' });
jca.delete('posts', 1);

// Auth (DBAuth)
jca.login('user', 'pass');

All functions are Promise-based. Errors return { code, message }.

Limitations

• Endpoints not implemented: /openapi, /geojson, /columns, /status/ping
• Only DBAuth (not JWT/Basic Auth)

Companion

JCA-FILTER — facilitates filter creation for JS-CRUD-API

Documentation

Detailed documentation (in French) is available in docs/:

• API Reference — full API documentation
• Architecture — project structure and internals
• Changelog — version history
• Roadmap 0.5 — upcoming features

Tests

Built on PHP-CRUD-API v2.14.25, SQLite v3.43.2.

npm run test:unit    # Unit tests (parameter formats)
npm run test:rest    # REST integration tests
npm run test:jca     # JCA adapter tests

License

MIT — Thierry PAGES