json-rest-api 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/settings.local.json +16 -0
- package/LICENSE +674 -0
- package/README.md +655 -309
- package/RELATIONSHIPS.md +1013 -0
- package/TODO_rest-api-plugin-extras.js +142 -0
- package/connectors_ideas/express-plugin.js +120 -0
- package/connectors_ideas/fastify.js +219 -0
- package/connectors_ideas/http-plugin.js +138 -0
- package/connectors_ideas/koa-plugin.js +113 -0
- package/docs/fileUploads.md +722 -0
- package/docs/mini-guides/file-uploads-complete.md +159 -0
- package/examples/.gitkeep +0 -0
- package/examples/express-example.js +262 -0
- package/examples/express-plugin.js +366 -0
- package/examples/file-upload-example.js +205 -0
- package/examples/filename-strategies.js +140 -0
- package/examples/knex-basic.js +66 -0
- package/index.js +31 -56
- package/lib/payload-validators.js +685 -0
- package/lib/rest-api-errors.js +58 -0
- package/package.json +41 -14
- package/payloadValdators.js +686 -0
- package/plugins/core/connectors/express-plugin.js +449 -0
- package/plugins/core/connectors/http-plugin.js +450 -0
- package/plugins/core/file-handling-plugin.js +338 -0
- package/plugins/core/lib/busboy-detector.js +167 -0
- package/plugins/core/lib/formidable-detector.js +130 -0
- package/plugins/core/rest-api-knex-plugin.js +200 -0
- package/plugins/core/rest-api-plugin.js +1419 -0
- package/plugins/storage/local-storage.js +218 -0
- package/plugins/storage/s3-storage.js +125 -0
- package/test-examples/package-lock.json +906 -0
- package/test-examples/package.json +15 -0
- package/test-examples/test-basic-api.js +11 -0
- package/test-examples/test-books-resource.js +116 -0
- package/test-examples/test-complete-file-upload.js +140 -0
- package/test-examples/test-debug.js +28 -0
- package/test-examples/test-express-plugin.js +177 -0
- package/test-examples/test-express-simple.js +28 -0
- package/test-examples/test-express-with-import.js +71 -0
- package/test-examples/test-file-upload.js +132 -0
- package/test-examples/test-http-plugin.js +159 -0
- package/test-examples/test-programmatic-api.js +188 -0
- package/test-examples/test-rest-api-plugin.js +13 -0
- package/TODO.todo +0 -113
- package/api.js +0 -628
- package/docs/API.md +0 -1306
- package/docs/FIXES_APPLIED.md +0 -59
- package/docs/GUIDES.md +0 -1792
- package/docs/RESOURCES_IN_EXPRESS.md +0 -456
- package/docs/example-versioning.js +0 -168
- package/docs/example.js +0 -195
- package/plugins/API guide.md +0 -364
- package/plugins/api-registry.js +0 -142
- package/plugins/api-versioning.md +0 -135
- package/plugins/http.js +0 -273
- package/plugins/logging.js +0 -255
- package/plugins/memory.js +0 -182
- package/plugins/mysql.js +0 -753
- package/plugins/openapi.js +0 -401
- package/plugins/positioning.js +0 -220
- package/plugins/security.js +0 -261
- package/plugins/validation.js +0 -173
- package/plugins/versioning.js +0 -288
- package/resource-helper.js +0 -79
- package/schema.js +0 -481
- package/test-basic.js +0 -107
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { HookedApiError } from 'hooked-api';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* REST API specific error classes that can be mapped to HTTP status codes
|
|
5
|
+
* by the HTTP plugin or other protocol plugins
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Validation error for invalid payloads, schema violations, etc.
|
|
10
|
+
* HTTP plugin should map this to 422 Unprocessable Entity
|
|
11
|
+
*/
|
|
12
|
+
export class RestApiValidationError extends HookedApiError {
|
|
13
|
+
constructor(message, { fields = [], violations = [] } = {}) {
|
|
14
|
+
super(message, 'REST_API_VALIDATION_ERROR');
|
|
15
|
+
this.code = 'REST_API_VALIDATION';
|
|
16
|
+
this.type = 'rest_api_validation';
|
|
17
|
+
this.details = {
|
|
18
|
+
fields,
|
|
19
|
+
violations
|
|
20
|
+
};
|
|
21
|
+
this.violations = violations;
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Resource-related errors (not found, conflicts, forbidden access)
|
|
27
|
+
* HTTP plugin should map based on subtype
|
|
28
|
+
*/
|
|
29
|
+
export class RestApiResourceError extends HookedApiError {
|
|
30
|
+
constructor(message, { subtype, resourceType, resourceId } = {}) {
|
|
31
|
+
super(message, 'REST_API_RESOURCE_ERROR');
|
|
32
|
+
this.code = 'REST_API_RESOURCE';
|
|
33
|
+
this.type = 'rest_api_resource';
|
|
34
|
+
this.subtype = subtype; // 'not_found', 'conflict', 'forbidden'
|
|
35
|
+
this.details = {
|
|
36
|
+
resourceType,
|
|
37
|
+
resourceId
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Payload structure errors (malformed JSON:API documents)
|
|
44
|
+
* HTTP plugin should map this to 400 Bad Request
|
|
45
|
+
*/
|
|
46
|
+
export class RestApiPayloadError extends HookedApiError {
|
|
47
|
+
constructor(message, { path, expected, received } = {}) {
|
|
48
|
+
super(message, 'REST_API_PAYLOAD_ERROR');
|
|
49
|
+
this.code = 'REST_API_PAYLOAD';
|
|
50
|
+
this.type = 'rest_api_payload';
|
|
51
|
+
this.path = path;
|
|
52
|
+
this.details = {
|
|
53
|
+
path,
|
|
54
|
+
expected,
|
|
55
|
+
received
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
}
|
package/package.json
CHANGED
|
@@ -1,25 +1,52 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "json-rest-api",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "A simple, extensible RESTful JSON API library with schema validation and positioning",
|
|
3
|
+
"version": "1.0.2",
|
|
5
4
|
"main": "index.js",
|
|
6
5
|
"type": "module",
|
|
7
|
-
"
|
|
8
|
-
|
|
9
|
-
|
|
6
|
+
"scripts": {
|
|
7
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
8
|
+
},
|
|
10
9
|
"repository": {
|
|
11
10
|
"type": "git",
|
|
12
|
-
"url": "https://github.com/mobily-enterprises/jsonrestapi.git"
|
|
11
|
+
"url": "git+https://github.com/mobily-enterprises/jsonrestapi.git"
|
|
12
|
+
},
|
|
13
|
+
"author": "Tony Mobily",
|
|
14
|
+
"license": "GPL-3.0-or-later",
|
|
15
|
+
"bugs": {
|
|
16
|
+
"url": "https://github.com/mobily-enterprises/jsonrestapi/issues"
|
|
13
17
|
},
|
|
18
|
+
"homepage": "https://github.com/mobily-enterprises/jsonrestapi#readme",
|
|
19
|
+
"description": "REST API plugin for hooked-api with JSON:API compliance",
|
|
14
20
|
"dependencies": {
|
|
15
|
-
"
|
|
16
|
-
"
|
|
17
|
-
"
|
|
18
|
-
|
|
19
|
-
|
|
21
|
+
"hooked-api": "^1.0.0",
|
|
22
|
+
"jsonrestapi-schema": "^1.0.0",
|
|
23
|
+
"qs": "^6.0.0"
|
|
24
|
+
},
|
|
25
|
+
"peerDependencies": {
|
|
26
|
+
"busboy": "^1.0.0",
|
|
27
|
+
"content-type": "^1.0.0",
|
|
28
|
+
"express": "^4.0.0",
|
|
29
|
+
"formidable": "^3.0.0",
|
|
30
|
+
"raw-body": "^2.0.0"
|
|
31
|
+
},
|
|
32
|
+
"peerDependenciesMeta": {
|
|
33
|
+
"express": {
|
|
34
|
+
"optional": true
|
|
35
|
+
},
|
|
36
|
+
"content-type": {
|
|
37
|
+
"optional": true
|
|
38
|
+
},
|
|
39
|
+
"raw-body": {
|
|
40
|
+
"optional": true
|
|
41
|
+
},
|
|
42
|
+
"busboy": {
|
|
43
|
+
"optional": true
|
|
44
|
+
},
|
|
45
|
+
"formidable": {
|
|
46
|
+
"optional": true
|
|
47
|
+
}
|
|
20
48
|
},
|
|
21
|
-
"devDependencies": {
|
|
22
|
-
|
|
23
|
-
"node": ">=18"
|
|
49
|
+
"devDependencies": {
|
|
50
|
+
"express": "^5.1.0"
|
|
24
51
|
}
|
|
25
52
|
}
|