9 Commits

Author SHA1 Message Date
88bf5a84d8 added into generated client response handlers 2026-05-26 13:45:15 +02:00
808fd747fe fixed empty docblock 2026-04-14 12:33:33 +02:00
70701bb8f1 allowed header Authorization 2026-04-02 08:23:39 +02:00
8f9c744134 added documentation for return 2026-04-01 07:26:06 +02:00
c758dc9317 extended JS and TS template with Bearer token 2026-03-30 23:32:38 +02:00
394a85ef45 added TryIt buttom for HTML help,
added Bearer token for testing API
2026-03-29 21:51:42 +02:00
1f32935a29 added return structure 2026-03-29 13:37:14 +02:00
951fe36da3 fixed parames of interface for type-check 2026-02-14 06:28:03 +01:00
d258bcc919 separated JavaScript and TypeScript export,
added AGENTS.md for AI bot
2026-02-13 09:54:08 +01:00
8 changed files with 1748 additions and 332 deletions

48
AGENTS.md Normal file
View File

@ -0,0 +1,48 @@
# AGENTS.md
## Project overview
APIlite is a lightweight PHP library. A class extends `TPsoft\APIlite\APIlite`, public methods become API actions, requests are processed automatically, and responses are returned as JSON.
The project also generates frontend clients:
- JavaScript client: `format=javascript` (`.js`, includes `bearerSet()` helper backed by `localStorage`)
- TypeScript client: `format=typescript` (`.ts`, real typed output, includes `bearerSet()` helper backed by `localStorage`)
The HTML help page is also interactive:
- HTML help: `format=html` includes endpoint docs, a built-in request tester, and optional Bearer token support stored in browser `localStorage`
## Core files
- `src/APIlite.php`: runtime, routing, docs JSON/HTML/client generation
- `src/help.tpl.php`: HTML documentation template
- `src/javascript.tpl.php`: JavaScript client template
- `src/typescript.tpl.php`: TypeScript client template
- `bin/apilite-files`: helper script for bootstrapping files in consumer projects
## Working rules
- Keep API behavior backward compatible unless explicitly requested.
- Maintain both generated clients:
- JavaScript stays plain JS.
- TypeScript stays typed (interfaces + typed method signatures).
- Bearer token behavior stays aligned between JavaScript and TypeScript clients (`bearerSet()`, `apilite_bearer_token`, automatic `Authorization: Bearer ...` header).
- Response/error handler behavior stays aligned between JavaScript and TypeScript clients (`addResponseHandler()`, `addErrorHandler()`, unsubscribe return value, `(response, context)` arguments, ignored handler exceptions).
- Keep the HTML help page usable both as documentation and as a lightweight in-browser tester.
- If you change output field names in JSON help, update README and templates consistently.
- If you change request metadata or tester behavior, update `README.md` and keep `src/help.tpl.php` aligned with the actual runtime request model.
- Prefer small, focused changes over broad rewrites.
## Verification checklist
- Run syntax checks on edited PHP files:
- `php -l src/APIlite.php`
- `php -l src/help.tpl.php`
- `php -l src/javascript.tpl.php`
- `php -l src/typescript.tpl.php`
- `php -l bin/apilite-files`
- If HTML help changes, also render it once:
- `php test/APIcalculator.php --html`
- If client generation changes, test with:
- `php test/APIcalculator.php --javascript`
- `php test/APIcalculator.php --typescript`
## Documentation rule
When output format names/flags/URLs change, update `README.md` in the same change set.
When Bearer token helper/storage behavior changes, update `README.md` and keep JS/TS client docs aligned with the actual generated templates.
When generated client handler behavior changes, update `README.md` and keep JS/TS client docs aligned with the actual generated templates.

125
README.md
View File

@ -132,6 +132,7 @@ When you run this subfile through the webserver, you will see the JSON documenta
{ {
"name": "APIcalculator", "name": "APIcalculator",
"html_version": "http://localhost/APIlite/test/APIcalculator.php?format=html", "html_version": "http://localhost/APIlite/test/APIcalculator.php?format=html",
"javascript_version": "http://localhost/APIlite/test/APIcalculator.php?format=javascript",
"typescript_version": "http://localhost/APIlite/test/APIcalculator.php?format=typescript", "typescript_version": "http://localhost/APIlite/test/APIcalculator.php?format=typescript",
"actions": [ "actions": [
{ {
@ -230,84 +231,72 @@ and there is also an HTML version available
<img src="test/Example.APIcalculator.png" /> <img src="test/Example.APIcalculator.png" />
To connect to the API from TypeScript (e.g. Vue application) it is possible to download the backend script The HTML documentation page also includes a built-in interactive tester. Each endpoint can be expanded with `Try it`, filled directly in the browser, and executed against the current API endpoint. If needed, you can set a shared Bearer token at the top of the page. The token is stored in `localStorage` and is sent as `Authorization: Bearer ...` for test requests made from that page.
```ts You can also download generated frontend clients:
/**
* Generated by APIlite
* https://gitea.tpsoft.org/TPsoft.org/APIlite
*
* 2025-06-12 06:24:33 */
class APIcalculator { * JavaScript: `?format=javascript`
endpont = "http://"; * TypeScript (typed for Vue/TS projects): `?format=typescript`
/* ---------------------------------------------------- Both generated clients support a shared Bearer token helper. Call `bearerSet(token)` once, the token is stored in `localStorage` under `apilite_bearer_token`, and subsequent requests automatically send `Authorization: Bearer ...`.
* General API call
*/
call(method, data, callback) {
var xhttp = new XMLHttpRequest();
xhttp.withCredentials = true;
xhttp.onreadystatechange = function() {
if (this.readyState == 4) {
if (this.status == 200) {
if (callback != null) callback(JSON.parse(this.responseText));
} else {
if (callback != null) callback({'status': 'ERROR', 'message': 'HTTP STATUS ' + this.status});
}
}
}
var form_data = new FormData();
Object.keys(data).forEach(key => {
let val = data[key];
if (typeof val == 'object') val = JSON.stringify(val);
form_data.append(key, val);
});
xhttp.open('POST', this.endpont + '?action=' + method);
xhttp.send(form_data);
}
callPromise(method, data) { Both generated clients also support response hooks:
return new Promise((resolve, reject) => {
this.call(method, data, function(response) {
if (response.status == 'OK') {
resolve(response.data);
} else {
reject(response.msg);
}
});
})
}
/* ---------------------------------------------------- * `addResponseHandler(handler)` registers a handler called for every API response.
* API actions * `addErrorHandler(handler)` registers a handler called only when the API response has `status === 'ERROR'`.
*/ * Both methods return an unsubscribe function.
help() { * Handlers receive `(response, context)`, where `context` contains `method`, `data`, and `httpStatus`.
return this.callPromise('__HELP__', {}); * Handler exceptions are ignored, so they do not change the original API callback or promise result.
}
add(a, b) { JavaScript usage example:
return this.callPromise('add', {a: a, b: b});
}
subtract(a, b) { ```js
return this.callPromise('subtract', {a: a, b: b}); import backend from './backend.js';
}
multiply(a, b) { backend.bearerSet('your-access-token');
return this.callPromise('multiply', {a: a, b: b}); const removeErrorHandler = backend.addErrorHandler((response, context) => {
} console.error(context.method, response.msg);
});
divide(a, b) { backend.add(1, 2).then((response) => {
return this.callPromise('divide', {a: a, b: b}); console.log(response.data);
} });
}; // removeErrorHandler();
export default new BackendAPI();
``` ```
These outputs can also be generated in the command line as follows TypeScript usage example (Vue + TS):
* for HTML`$> php APIcalculator.php --html` ```ts
* for TypeScript`$> php APIcalculator.php --typescript` import backend from './backend';
backend.bearerSet('your-access-token');
const removeResponseHandler = backend.addResponseHandler((response, context) => {
console.log(context.httpStatus, response.status);
});
backend.add(1, 2).then((response) => {
console.log(response.data); // typed value based on PHP return type
});
// removeResponseHandler();
```
If a method return type is a PHP class with public properties, JSON help now also includes `return_structure`, and the generated TypeScript client maps that class to an object shape based on those public properties.
These outputs can also be generated in command line:
* HTML: `$> php APIcalculator.php --html`
* JavaScript: `$> php APIcalculator.php --javascript > backend.js` (`--js` alias is available)
* TypeScript: `$> php APIcalculator.php --typescript > backend.ts`
## HTML help tester notes
The built-in HTML tester currently follows the default APIlite request model:
* request method is `POST`
* endpoint action is sent as query parameter `action`
* request fields are sent as top-level form fields
* object and array field values are serialized as JSON strings
Because the current metadata does not explicitly distinguish path params, query params and request body schemas, the HTML tester renders the parts that are reliably available today and keeps the rest minimal.

View File

@ -55,7 +55,7 @@ $backend_api = new TPsoft\BugreportBackend\API(\'typescript\', \'import.meta.env
$output = ob_get_contents(); $output = ob_get_contents();
ob_end_clean(); ob_end_clean();
$ts_path = realpath(__DIR__ . \'/../../frontend/src\').\'/backend.js\'; $ts_path = realpath(__DIR__ . \'/../../frontend/src\').\'/backend.ts\';
$suc = file_put_contents($ts_path, $output); $suc = file_put_contents($ts_path, $output);
if ($suc === false) { if ($suc === false) {
echo "✗ TypeScript store into file failed\n"; echo "✗ TypeScript store into file failed\n";

View File

@ -9,6 +9,7 @@
"rest", "rest",
"json", "json",
"php", "php",
"javascript",
"typescript" "typescript"
], ],
"authors": [ "authors": [

View File

@ -39,6 +39,9 @@ class APIlite
if (in_array('--html', $switches)) { if (in_array('--html', $switches)) {
$format = 'html'; $format = 'html';
} }
if (in_array('--javascript', $switches) || in_array('--js', $switches)) {
$format = 'javascript';
}
if (in_array('--typescript', $switches)) { if (in_array('--typescript', $switches)) {
$format = 'typescript'; $format = 'typescript';
} }
@ -47,6 +50,10 @@ class APIlite
case 'html': case 'html':
$this->printHelpHTML(); $this->printHelpHTML();
break; break;
case 'javascript':
case 'js':
$this->printHelpJavascript();
break;
case 'typescript': case 'typescript':
$this->printHelpTypescript(); $this->printHelpTypescript();
break; break;
@ -80,7 +87,8 @@ class APIlite
'doc' => null, 'doc' => null,
'description' => null, 'description' => null,
'params' => array(), 'params' => array(),
'return' => null 'return' => null,
'return_structure' => null
); );
$docComment = $ref_method->getDocComment(); $docComment = $ref_method->getDocComment();
if ($docComment) { if ($docComment) {
@ -108,27 +116,130 @@ class APIlite
} }
if ($ref_method->hasReturnType()) { if ($ref_method->hasReturnType()) {
$ref_type = $ref_method->getReturnType(); $ref_type = $ref_method->getReturnType();
if ($ref_type instanceof \ReflectionNamedType) { $method['return'] = $this->reflectionTypeToNames($ref_type, $ref_method->getDeclaringClass());
$method['return'] = $ref_type->getName(); $method['return_structure'] = $this->reflectionTypeToStructure($ref_type, $ref_method->getDeclaringClass());
} $method['return_doc'] = $this->parseReturnDoc($method['doc']);
if ($ref_type instanceof \ReflectionUnionType
|| $ref_type instanceof \ReflectionIntersectionType )
{
$types = $ref_type->getTypes();
$method['return'] = [];
foreach ($types as $type) {
if ($type instanceof \ReflectionNamedType) {
$method['return'][] = $type->getName();
}
}
}
} }
$this->methods[] = $method; $this->methods[] = $method;
} }
return true; return true;
} }
private function reflectionTypeToNames(?\ReflectionType $ref_type, ?\ReflectionClass $context_class = null): string|array|null
{
if ($ref_type instanceof \ReflectionNamedType) {
$type_name = $this->resolveTypeName($ref_type->getName(), $context_class);
if ($ref_type->allowsNull() && strtolower($type_name) !== 'null' && strtolower($type_name) !== 'mixed') {
return array($type_name, 'null');
}
return $type_name;
}
if ($ref_type instanceof \ReflectionUnionType || $ref_type instanceof \ReflectionIntersectionType) {
$types = array();
foreach ($ref_type->getTypes() as $type) {
if (!$type instanceof \ReflectionNamedType) {
continue;
}
$one_type = $this->reflectionTypeToNames($type, $context_class);
if (is_array($one_type)) {
$types = array_merge($types, $one_type);
} else if (is_string($one_type)) {
$types[] = $one_type;
}
}
$types = array_values(array_unique($types));
return empty($types) ? null : $types;
}
return null;
}
private function reflectionTypeToStructure(?\ReflectionType $ref_type, ?\ReflectionClass $context_class = null, array $visited = array()): array|null
{
if ($ref_type instanceof \ReflectionNamedType) {
return $this->classTypeStructure(
$this->resolveTypeName($ref_type->getName(), $context_class),
$visited
);
}
if ($ref_type instanceof \ReflectionUnionType || $ref_type instanceof \ReflectionIntersectionType) {
$structures = array();
foreach ($ref_type->getTypes() as $type) {
if (!$type instanceof \ReflectionNamedType) {
continue;
}
$structure = $this->reflectionTypeToStructure($type, $context_class, $visited);
if (!is_null($structure)) {
$structures[] = $structure;
}
}
return count($structures) > 0 ? $structures : null;
}
return null;
}
private function classTypeStructure(string $type_name, array $visited = array()): array|null
{
$type_name = ltrim($type_name, '\\');
if ($this->isBuiltinTypeName($type_name) || !class_exists($type_name)) {
return null;
}
if (in_array($type_name, $visited, true)) {
return array(
'type' => $type_name,
'recursive' => true,
'properties' => array()
);
}
$visited[] = $type_name;
$refClass = new \ReflectionClass($type_name);
$properties = array();
foreach ($refClass->getProperties(\ReflectionProperty::IS_PUBLIC) as $ref_property) {
if ($ref_property->isStatic()) {
continue;
}
$property_type = $ref_property->getType();
$properties[] = array(
'name' => $ref_property->getName(),
'type' => $this->reflectionTypeToNames($property_type, $refClass),
'nullable' => is_null($property_type) ? true : $property_type->allowsNull(),
'type_structure' => $this->reflectionTypeToStructure($property_type, $refClass, $visited)
);
}
return array(
'type' => $type_name,
'properties' => $properties
);
}
private function resolveTypeName(string $type_name, ?\ReflectionClass $context_class = null): string
{
$type_name = ltrim($type_name, '\\');
if (is_null($context_class)) {
return $type_name;
}
switch (strtolower($type_name)) {
case 'self':
case 'static':
return $context_class->getName();
case 'parent':
$parent = $context_class->getParentClass();
return $parent ? $parent->getName() : $type_name;
default:
return $type_name;
}
}
private function isBuiltinTypeName(string $type_name): bool
{
return in_array(strtolower(ltrim($type_name, '\\')), array(
'array', 'bool', 'boolean', 'callable', 'closure', 'false', 'float', 'int', 'integer',
'iterable', 'mixed', 'never', 'null', 'object', 'resource', 'scalar', 'string',
'true', 'void'
), true);
}
private function parseDescription(string $doc): string private function parseDescription(string $doc): string
{ {
$lines = explode("\n", $doc); $lines = explode("\n", $doc);
@ -161,6 +272,22 @@ class APIlite
return null; return null;
} }
private function parseReturnDoc(?string $doc): string|null
{
if (is_null($doc) || $doc === '') {
return null;
}
$lines = explode("\n", $doc);
foreach ($lines as $line) {
if (strpos($line, '@return') !== false) {
$ret = trim(substr($line, strpos($line, '@return') + strlen('@return')));
if (strlen($ret) <= 0) return null;
return trim(stristr($ret, ' '));
}
}
return null;
}
private function response(array $arr): void private function response(array $arr): void
{ {
ob_clean(); ob_clean();
@ -169,7 +296,7 @@ class APIlite
header('Access-Control-Allow-Origin: ' . $origin); header('Access-Control-Allow-Origin: ' . $origin);
header('Access-Control-Allow-Credentials: true'); header('Access-Control-Allow-Credentials: true');
header('Access-Control-Allow-Methods: GET, POST, OPTIONS'); header('Access-Control-Allow-Methods: GET, POST, OPTIONS');
header('Access-Control-Allow-Headers: Origin, Content-Type, Accept'); header('Access-Control-Allow-Headers: Origin, Content-Type, Accept, Authorization');
echo json_encode($arr); echo json_encode($arr);
exit; exit;
} }
@ -189,6 +316,7 @@ class APIlite
$this->response(array( $this->response(array(
'name' => $this->apiName, 'name' => $this->apiName,
'html_version' => $this->getCurrentUrl().'?format=html', 'html_version' => $this->getCurrentUrl().'?format=html',
'javascript_version' => $this->getCurrentUrl().'?format=javascript',
'typescript_version' => $this->getCurrentUrl().'?format=typescript', 'typescript_version' => $this->getCurrentUrl().'?format=typescript',
'actions' => $this->methods 'actions' => $this->methods
)); ));
@ -199,20 +327,36 @@ class APIlite
include __DIR__ . '/help.tpl.php'; include __DIR__ . '/help.tpl.php';
} }
private function printHelpTypescript(): void private function printHelpJavascript(): void
{ {
ob_clean(); ob_clean();
header('Content-Type: application/javascript'); header('Content-Type: application/javascript');
header('Content-Disposition: attachment; filename="' . $this->apiName . '.js"'); header('Content-Disposition: attachment; filename="' . $this->apiName . '.js"');
include __DIR__ . '/javascript.tpl.php';
}
private function printHelpTypescript(): void
{
ob_clean();
header('Content-Type: application/typescript');
header('Content-Disposition: attachment; filename="' . $this->apiName . '.ts"');
include __DIR__ . '/typescript.tpl.php'; include __DIR__ . '/typescript.tpl.php';
} }
private function getCurrentUrl(): string { private function getCurrentUrl(): string {
$protocol = (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off' || $https = !empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off';
$_SERVER['SERVER_PORT'] == 443) ? "https://" : "http://"; $serverPort = isset($_SERVER['SERVER_PORT']) ? (int) $_SERVER['SERVER_PORT'] : null;
$host = $_SERVER['HTTP_HOST']; $protocol = ($https || $serverPort === 443) ? 'https://' : 'http://';
$uri = $_SERVER['REQUEST_URI']; $host = $_SERVER['HTTP_HOST'] ?? 'localhost';
$uri = $_SERVER['REQUEST_URI'] ?? ($_SERVER['SCRIPT_NAME'] ?? '/');
$path = parse_url($uri, PHP_URL_PATH); $path = parse_url($uri, PHP_URL_PATH);
if (!is_string($path) || $path === '') {
$path = '/';
}
$path = str_replace('\\', '/', $path);
if (substr($path, 0, 1) !== '/') {
$path = '/' . ltrim($path, '/');
}
return $protocol . $host . $path; return $protocol . $host . $path;
} }

File diff suppressed because it is too large Load Diff

167
src/javascript.tpl.php Normal file
View File

@ -0,0 +1,167 @@
/**
* Generated by APIlite
* https://gitea.tpsoft.org/TPsoft.org/APIlite
*
* <?php echo date('Y-m-d H:i:s'); ?>
*/
class <?php echo $this->apiName; ?> {
endpoint = <?php echo sprintf(substr($this->endpoint, 0, 4) == 'http' ? '"%s"' : '%s', $this->endpoint); ?>;
bearerStorageKey = 'apilite_bearer_token';
responseHandlers = [];
errorHandlers = [];
normalizeBearerToken(token) {
if (typeof token !== 'string') return null;
token = token.trim();
return token === '' ? null : token;
}
getStorage() {
try {
if (typeof window !== 'undefined' && window.localStorage) return window.localStorage;
} catch (error) {
return null;
}
return null;
}
getBearerToken() {
var storage = this.getStorage();
if (storage == null) return null;
return this.normalizeBearerToken(storage.getItem(this.bearerStorageKey));
}
getRequestHeaders(headers = {}) {
var requestHeaders = Object.assign({}, headers);
if (typeof requestHeaders.Authorization === 'undefined') {
var token = this.getBearerToken();
if (token != null) requestHeaders.Authorization = 'Bearer ' + token;
}
return requestHeaders;
}
applyHeaders(xhttp, headers) {
Object.keys(headers).forEach(key => {
var value = headers[key];
if (typeof value === 'undefined' || value === null) return;
xhttp.setRequestHeader(key, value);
});
}
bearerSet(token) {
var storage = this.getStorage();
if (storage == null) return;
token = this.normalizeBearerToken(token);
if (token == null) {
storage.removeItem(this.bearerStorageKey);
return;
}
storage.setItem(this.bearerStorageKey, token);
}
addResponseHandler(handler) {
this.responseHandlers.push(handler);
return () => {
this.responseHandlers = this.responseHandlers.filter(registeredHandler => registeredHandler !== handler);
};
}
addErrorHandler(handler) {
this.errorHandlers.push(handler);
return () => {
this.errorHandlers = this.errorHandlers.filter(registeredHandler => registeredHandler !== handler);
};
}
emitResponseHandlers(response, context) {
this.responseHandlers.forEach(handler => {
try {
handler(response, context);
} catch (error) {
// Response handlers must not change the API request result.
}
});
}
emitErrorHandlers(response, context) {
this.errorHandlers.forEach(handler => {
try {
handler(response, context);
} catch (error) {
// Error handlers must not change the API request result.
}
});
}
emitHandlers(response, context) {
this.emitResponseHandlers(response, context);
if (response.status === 'ERROR') this.emitErrorHandlers(response, context);
}
/* ----------------------------------------------------
* General API call
*/
call(method, data, callback) {
var xhttp = new XMLHttpRequest();
var headers = this.getRequestHeaders();
var api = this;
xhttp.withCredentials = true;
xhttp.onreadystatechange = function() {
if (this.readyState === 4) {
var response;
if (this.status === 200) {
response = JSON.parse(this.responseText);
} else {
response = {'status': 'ERROR', 'msg': 'HTTP STATUS ' + this.status};
}
var context = {method: method, data: data, httpStatus: this.status};
api.emitHandlers(response, context);
if (callback != null) callback(response);
}
}
var form_data = new FormData();
Object.keys(data).forEach(key => {
let val = data[key];
if (typeof val === 'undefined') return;
if (typeof val == 'object') val = JSON.stringify(val);
form_data.append(key, val);
});
xhttp.open('POST', this.endpoint + '?action=' + method);
this.applyHeaders(xhttp, headers);
xhttp.send(form_data);
}
callPromise(method, data) {
return new Promise((resolve, reject) => {
this.call(method, data, function(response) {
if (method === '__HELP__') {
resolve(response);
return;
}
if (response.status === 'OK') {
resolve(response.data);
} else {
reject(response.msg);
}
});
})
}
/* ----------------------------------------------------
* API actions
*/
help() {
return this.callPromise('__HELP__', {});
}
<?php if (is_array($this->methods)) foreach ($this->methods as $method) {
echo "\t".$method['name'].'('.implode(', ', array_map(function($param) { return $param['name']; }, $method['params'])).') {';
echo "\n\t\treturn this.callPromise('".$method['name']."', {".implode(', ', array_map(function($param) { return $param['name'].': '.$param['name']; }, $method['params']))."});";
echo "\n\t}\n\n";
}
?>
};
export default new <?php echo $this->apiName; ?>();

View File

@ -1,3 +1,98 @@
<?php
$mapType = function (?string $type): string {
if (!is_string($type) || $type === '') {
return 'unknown';
}
$type = strtolower(ltrim($type, '\\'));
return match ($type) {
'int', 'integer', 'float', 'double' => 'number',
'string' => 'string',
'bool', 'boolean' => 'boolean',
'array', 'iterable' => 'unknown[]',
'object', 'stdclass' => 'Record<string, unknown>',
'mixed', 'resource' => 'unknown',
'null', 'void' => 'null',
'scalar' => 'string | number | boolean',
'callable', 'closure' => '(...args: unknown[]) => unknown',
'never' => 'never',
default => 'unknown',
};
};
$mapUnionType = function (mixed $type) use ($mapType): string {
if (is_array($type)) {
$parts = array();
foreach ($type as $singleType) {
$parts[] = $mapType(is_string($singleType) ? $singleType : null);
}
$parts = array_values(array_unique($parts));
return empty($parts) ? 'unknown' : implode(' | ', $parts);
}
return $mapType(is_string($type) ? $type : null);
};
$normalizeTypeStructures = function (mixed $structure): array {
if (!is_array($structure)) {
return array();
}
if (array_key_exists('type', $structure) && array_key_exists('properties', $structure)) {
return array($structure);
}
return array_values(array_filter($structure, 'is_array'));
};
$findTypeStructure = function (?string $type, mixed $structure) use ($normalizeTypeStructures): array|null {
if (!is_string($type) || $type === '') {
return null;
}
$type = ltrim($type, '\\');
foreach ($normalizeTypeStructures($structure) as $one_structure) {
if (($one_structure['type'] ?? null) === $type) {
return $one_structure;
}
}
return null;
};
$mapTypeWithStructure = null;
$mapUnionTypeWithStructure = null;
$mapTypeWithStructure = function (?string $type, mixed $structure) use ($mapType, &$mapUnionTypeWithStructure): string {
if (is_array($structure) && array_key_exists('type', $structure) && array_key_exists('properties', $structure)) {
$properties = array();
foreach (($structure['properties'] ?? array()) as $property) {
if (!is_array($property) || !isset($property['name'])) {
continue;
}
$propertyType = $mapUnionTypeWithStructure($property['type'] ?? null, $property['type_structure'] ?? null);
if (!empty($property['nullable']) && strpos($propertyType, 'null') === false) {
$propertyType .= ' | null';
}
$properties[] = $property['name'] . ': ' . $propertyType;
}
return empty($properties) ? 'Record<string, unknown>' : '{ ' . implode('; ', $properties) . ' }';
}
return $mapType($type);
};
$mapUnionTypeWithStructure = function (mixed $type, mixed $structure) use ($mapType, $findTypeStructure, &$mapTypeWithStructure): string {
if (is_array($type)) {
$parts = array();
foreach ($type as $singleType) {
$typeName = is_string($singleType) ? $singleType : null;
$parts[] = $mapTypeWithStructure($typeName, $findTypeStructure($typeName, $structure));
}
$parts = array_values(array_unique($parts));
return empty($parts) ? 'unknown' : implode(' | ', $parts);
}
return $mapTypeWithStructure(is_string($type) ? $type : null, $structure);
};
?>
/** /**
* Generated by APIlite * Generated by APIlite
* https://gitea.tpsoft.org/TPsoft.org/APIlite * https://gitea.tpsoft.org/TPsoft.org/APIlite
@ -5,64 +100,262 @@
* <?php echo date('Y-m-d H:i:s'); ?> * <?php echo date('Y-m-d H:i:s'); ?>
*/ */
export interface APIliteActionResponse<T> {
status: 'OK';
data: T;
msg: string;
}
export interface APIliteErrorResponse {
status: 'ERROR';
msg: string;
}
export interface APIliteMethodParam {
name: string;
type: string | null;
optional: boolean;
default: unknown;
doc: string | null;
}
export interface APIliteMethodDoc {
name: string;
doc: string | null;
description: string | null;
params: APIliteMethodParam[];
return: string | string[] | null;
return_structure: APIliteTypeStructure | APIliteTypeStructure[] | null;
}
export interface APIliteTypeStructureProperty {
name: string;
type: string | string[] | null;
nullable: boolean;
type_structure: APIliteTypeStructure | APIliteTypeStructure[] | null;
}
export interface APIliteTypeStructure {
type: string;
recursive?: boolean;
properties: APIliteTypeStructureProperty[];
}
export interface APIliteHelpResponse {
name: string;
html_version: string;
javascript_version: string;
typescript_version: string;
actions: APIliteMethodDoc[];
status: string;
data: string;
msg: string;
}
export type APIliteResponse = APIliteHelpResponse | APIliteActionResponse<unknown> | APIliteErrorResponse;
export interface APIliteResponseContext {
method: string;
data: Record<string, unknown>;
httpStatus: number;
}
type APIliteRequestHeaders = Partial<Record<string, string>>;
type APIliteResponseHandler = (response: APIliteResponse, context: APIliteResponseContext) => void;
type APIliteErrorHandler = (response: APIliteErrorResponse, context: APIliteResponseContext) => void;
class <?php echo $this->apiName; ?> { class <?php echo $this->apiName; ?> {
endpoint = <?php echo sprintf(substr($this->endpoint, 0, 4) == 'http' ? '"%s"' : '%s', $this->endpoint); ?>; endpoint: string = <?php echo sprintf(substr($this->endpoint, 0, 4) == 'http' ? '"%s"' : '%s', $this->endpoint); ?>;
private readonly bearerStorageKey: string = 'apilite_bearer_token';
private responseHandlers: APIliteResponseHandler[] = [];
private errorHandlers: APIliteErrorHandler[] = [];
/* ---------------------------------------------------- private normalizeBearerToken(token: string | null | undefined): string | null {
* General API call if (typeof token !== 'string') {
*/ return null;
call(method, data, callback) {
var xhttp = new XMLHttpRequest();
xhttp.withCredentials = true;
xhttp.onreadystatechange = function() {
if (this.readyState == 4) {
if (this.status == 200) {
if (callback != null) callback(JSON.parse(this.responseText));
} else {
if (callback != null) callback({'status': 'ERROR', 'message': 'HTTP STATUS ' + this.status});
} }
} const normalizedToken = token.trim();
} return normalizedToken === '' ? null : normalizedToken;
var form_data = new FormData();
Object.keys(data).forEach(key => {
let val = data[key];
if (typeof val == 'object') val = JSON.stringify(val);
form_data.append(key, val);
});
xhttp.open('POST', this.endpoint + '?action=' + method);
xhttp.send(form_data);
} }
callPromise(method, data) { private getStorage(): Storage | null {
return new Promise((resolve, reject) => { try {
this.call(method, data, function(response) { if (typeof window !== 'undefined' && typeof window.localStorage !== 'undefined') {
if (method == '__HELP__') { return window.localStorage;
resolve(response); }
} catch {
return null;
}
return null;
}
private getBearerToken(): string | null {
const storage = this.getStorage();
if (storage === null) {
return null;
}
return this.normalizeBearerToken(storage.getItem(this.bearerStorageKey));
}
private getRequestHeaders(headers: APIliteRequestHeaders = {}): APIliteRequestHeaders {
const requestHeaders: APIliteRequestHeaders = { ...headers };
if (typeof requestHeaders.Authorization === 'undefined') {
const token = this.getBearerToken();
if (token !== null) {
requestHeaders.Authorization = `Bearer ${token}`;
}
}
return requestHeaders;
}
private applyHeaders(xhttp: XMLHttpRequest, headers: APIliteRequestHeaders): void {
Object.keys(headers).forEach((key) => {
const value = headers[key];
if (typeof value === 'undefined' || value === null) {
return; return;
} }
if (response.status == 'OK') { xhttp.setRequestHeader(key, value);
resolve(response.data);
} else {
reject(response.msg);
}
}); });
})
} }
/* ---------------------------------------------------- bearerSet(token: string | null): void {
* API actions const storage = this.getStorage();
*/ if (storage === null) {
help() { return;
return this.callPromise('__HELP__', {}); }
const normalizedToken = this.normalizeBearerToken(token);
if (normalizedToken === null) {
storage.removeItem(this.bearerStorageKey);
return;
}
storage.setItem(this.bearerStorageKey, normalizedToken);
}
addResponseHandler(handler: APIliteResponseHandler): () => void {
this.responseHandlers.push(handler);
return () => {
this.responseHandlers = this.responseHandlers.filter((registeredHandler) => registeredHandler !== handler);
};
}
addErrorHandler(handler: APIliteErrorHandler): () => void {
this.errorHandlers.push(handler);
return () => {
this.errorHandlers = this.errorHandlers.filter((registeredHandler) => registeredHandler !== handler);
};
}
private emitResponseHandlers(response: APIliteResponse, context: APIliteResponseContext): void {
this.responseHandlers.forEach((handler) => {
try {
handler(response, context);
} catch {
// Response handlers must not change the API request result.
}
});
}
private emitErrorHandlers(response: APIliteErrorResponse, context: APIliteResponseContext): void {
this.errorHandlers.forEach((handler) => {
try {
handler(response, context);
} catch {
// Error handlers must not change the API request result.
}
});
}
private isErrorResponse(response: APIliteResponse): response is APIliteErrorResponse {
return response.status === 'ERROR';
}
private emitHandlers(response: APIliteResponse, context: APIliteResponseContext): void {
this.emitResponseHandlers(response, context);
if (this.isErrorResponse(response)) {
this.emitErrorHandlers(response, context);
}
}
private call(
method: string,
data: Record<string, unknown>,
callback: (response: APIliteResponse) => void
): void {
const xhttp = new XMLHttpRequest();
const headers = this.getRequestHeaders();
const api = this;
xhttp.withCredentials = true;
xhttp.onreadystatechange = function() {
if (this.readyState === 4) {
let response: APIliteResponse;
if (this.status === 200) {
response = JSON.parse(this.responseText) as APIliteResponse;
} else {
response = { status: 'ERROR', msg: 'HTTP STATUS ' + this.status };
}
const context: APIliteResponseContext = { method, data, httpStatus: this.status };
api.emitHandlers(response, context);
callback(response);
}
};
const formData = new FormData();
Object.keys(data).forEach((key) => {
const rawValue = data[key];
if (typeof rawValue === 'undefined') {
return;
}
let value: string | Blob;
if (rawValue instanceof Blob) {
value = rawValue;
} else if (typeof rawValue === 'object' && rawValue !== null) {
value = JSON.stringify(rawValue);
} else {
value = String(rawValue);
}
formData.append(key, value);
});
xhttp.open('POST', this.endpoint + '?action=' + method);
this.applyHeaders(xhttp, headers);
xhttp.send(formData);
}
private callPromise<T>(method: string, data: Record<string, unknown>): Promise<T> {
return new Promise<T>((resolve, reject) => {
this.call(method, data, (response) => {
if (method === '__HELP__') {
resolve(response as T);
return;
}
if (response.status === 'OK') {
resolve(response.data as T);
return;
}
reject(response.msg);
});
});
}
help(): Promise<APIliteHelpResponse> {
return this.callPromise<APIliteHelpResponse>('__HELP__', {});
} }
<?php if (is_array($this->methods)) foreach ($this->methods as $method) { <?php if (is_array($this->methods)) foreach ($this->methods as $method) {
echo "\t".$method['name'].'('.implode(', ', array_map(function($param) { return $param['name']; }, $method['params'])).') {'; $paramsSignature = array();
echo "\n\t\treturn this.callPromise('".$method['name']."', {".implode(', ', array_map(function($param) { return $param['name'].': '.$param['name']; }, $method['params']))."});"; $paramsPayload = array();
echo "\n\t}\n\n"; foreach ($method['params'] as $param) {
$paramType = $mapType($param['type']);
$paramsSignature[] = $param['name'] . ($param['optional'] ? '?' : '') . ': ' . $paramType;
$paramsPayload[] = $param['name'];
} }
$returnType = $mapUnionTypeWithStructure($method['return'], $method['return_structure'] ?? null);
?> ?>
<?php echo $method['name']; ?>(<?php echo implode(', ', $paramsSignature); ?>): Promise<APIliteActionResponse<<?php echo $returnType; ?>>> {
return this.callPromise<APIliteActionResponse<<?php echo $returnType; ?>>>('<?php echo $method['name']; ?>', { <?php echo implode(', ', $paramsPayload); ?> });
}
}; <?php } ?>
}
export default new <?php echo $this->apiName; ?>(); export default new <?php echo $this->apiName; ?>();