@revenexx/app-sdk 1.6.0 → 2.1.0
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/README.md +91 -3
- package/dist/{chunk-FMHCS3ZH.js → chunk-TLWWVUJ4.js} +172 -35
- package/dist/chunk-TLWWVUJ4.js.map +1 -0
- package/dist/{errors-CWT-wc8L.d.cts → errors-CkBo_7bc.d.cts} +21 -3
- package/dist/{errors-CWT-wc8L.d.ts → errors-CkBo_7bc.d.ts} +21 -3
- package/dist/index.cjs +217 -38
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +11 -2
- package/dist/index.d.ts +11 -2
- package/dist/index.js +92 -5
- package/dist/index.js.map +1 -1
- package/dist/router/index.cjs +96 -30
- package/dist/router/index.cjs.map +1 -1
- package/dist/router/index.d.cts +19 -3
- package/dist/router/index.d.ts +19 -3
- package/dist/router/index.js +31 -15
- package/dist/router/index.js.map +1 -1
- package/package.json +1 -1
- package/dist/chunk-FMHCS3ZH.js.map +0 -1
package/dist/router/index.cjs
CHANGED
|
@@ -451,6 +451,65 @@ function refusalOf(err) {
|
|
|
451
451
|
};
|
|
452
452
|
}
|
|
453
453
|
|
|
454
|
+
// src/patch.ts
|
|
455
|
+
var EMPTY_UPDATE_MESSAGE = "request body must contain at least one field to update";
|
|
456
|
+
function updateFields(patch) {
|
|
457
|
+
if (!patch || typeof patch !== "object" || Array.isArray(patch)) return [];
|
|
458
|
+
return Object.keys(patch).filter(
|
|
459
|
+
(key) => patch[key] !== void 0
|
|
460
|
+
);
|
|
461
|
+
}
|
|
462
|
+
var TRASH_FLAG_COLUMNS = [
|
|
463
|
+
"deleted_at",
|
|
464
|
+
"deleted_by",
|
|
465
|
+
"deleted_by_id",
|
|
466
|
+
"trash_batch",
|
|
467
|
+
"purge_blocked_reason"
|
|
468
|
+
];
|
|
469
|
+
var EXTERNAL_ID_FLAG_COLUMNS = ["external_id"];
|
|
470
|
+
function flagColumns(entity) {
|
|
471
|
+
return [
|
|
472
|
+
...entity.trash === true ? TRASH_FLAG_COLUMNS : [],
|
|
473
|
+
...entity.external_id === true ? EXTERNAL_ID_FLAG_COLUMNS : []
|
|
474
|
+
];
|
|
475
|
+
}
|
|
476
|
+
var ONE_RECORD_MESSAGE = "a write takes one record, as a JSON object \u2014 not a list";
|
|
477
|
+
var INDEX = /^(?:0|[1-9]\d*)$/;
|
|
478
|
+
function isList(data) {
|
|
479
|
+
if (!data || typeof data !== "object") return false;
|
|
480
|
+
if (Array.isArray(data)) return data.length > 0;
|
|
481
|
+
const keys = Object.keys(data);
|
|
482
|
+
return keys.length > 0 && keys.every((k) => INDEX.test(k) && Number(k) < keys.length);
|
|
483
|
+
}
|
|
484
|
+
function trashFieldsIn(entity, body) {
|
|
485
|
+
if (entity.trash !== true || !body || typeof body !== "object") return [];
|
|
486
|
+
const row = body;
|
|
487
|
+
return TRASH_FLAG_COLUMNS.filter((k) => Object.prototype.hasOwnProperty.call(row, k) && row[k] !== void 0).sort();
|
|
488
|
+
}
|
|
489
|
+
function assertNoTrashFields(entity, body) {
|
|
490
|
+
const fields = trashFieldsIn(entity, body);
|
|
491
|
+
if (fields.length === 0) return;
|
|
492
|
+
const quoted = fields.map((k) => `'${k}'`).join(", ");
|
|
493
|
+
throw badRequest(
|
|
494
|
+
`field${fields.length > 1 ? "s" : ""} ${quoted} ${fields.length > 1 ? "are" : "is"} kept by the trash \u2014 put a record into the trash, restore or purge it through the trash routes.`,
|
|
495
|
+
{ fields },
|
|
496
|
+
{ code: "read_only_field" }
|
|
497
|
+
);
|
|
498
|
+
}
|
|
499
|
+
var ENTITY_DESCRIPTOR = /* @__PURE__ */ Symbol.for("revenexx.app-sdk.entity");
|
|
500
|
+
function guardsTrash(stated, described, columns) {
|
|
501
|
+
if (stated === true || described === true) return true;
|
|
502
|
+
if (stated === void 0 && described === void 0) return !!columns && Object.prototype.hasOwnProperty.call(columns, "trash_batch");
|
|
503
|
+
return false;
|
|
504
|
+
}
|
|
505
|
+
function describedEntity(repo) {
|
|
506
|
+
if (!repo || typeof repo !== "object") return void 0;
|
|
507
|
+
return repo[ENTITY_DESCRIPTOR];
|
|
508
|
+
}
|
|
509
|
+
function oneRecordRefusal() {
|
|
510
|
+
return badRequest(ONE_RECORD_MESSAGE, void 0, { code: "bad_request" });
|
|
511
|
+
}
|
|
512
|
+
|
|
454
513
|
// src/backdating.ts
|
|
455
514
|
var MAX_MONTHS_BACK = 24;
|
|
456
515
|
var BACKDATING_SETTING = "allow_backdating";
|
|
@@ -550,17 +609,23 @@ function backdatingDb(db, entities) {
|
|
|
550
609
|
new Proxy(repo, {
|
|
551
610
|
get(r, key, rr) {
|
|
552
611
|
const member = Reflect.get(r, key, rr);
|
|
553
|
-
if (key !== "create" || typeof member !== "function") return member;
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
}
|
|
558
|
-
const at = now();
|
|
612
|
+
if (key !== "create" && key !== "createMany" || typeof member !== "function") return member;
|
|
613
|
+
const call = (data, rest) => member.call(r, data, ...rest);
|
|
614
|
+
const stamp = (data, at) => {
|
|
615
|
+
if (!data || typeof data !== "object" || Array.isArray(data) || isList(data)) return data;
|
|
559
616
|
const row = { ...data };
|
|
560
617
|
if (row.created_at === void 0) row.created_at = at;
|
|
561
618
|
if ("updated_at" in columns && row.updated_at === void 0) row.updated_at = at;
|
|
562
|
-
return
|
|
619
|
+
return row;
|
|
563
620
|
};
|
|
621
|
+
if (key === "createMany") {
|
|
622
|
+
return (data, ...rest) => {
|
|
623
|
+
if (!backdated() || !Array.isArray(data)) return call(data, rest);
|
|
624
|
+
const at = now();
|
|
625
|
+
return call(data.map((record) => stamp(record, at)), rest);
|
|
626
|
+
};
|
|
627
|
+
}
|
|
628
|
+
return (data, ...rest) => backdated() ? call(stamp(data, now()), rest) : call(data, rest);
|
|
564
629
|
}
|
|
565
630
|
})
|
|
566
631
|
);
|
|
@@ -767,13 +832,11 @@ function createApp(options = {}) {
|
|
|
767
832
|
const fields = matched.route.backdating;
|
|
768
833
|
if (!fields) return await matched.route.handler(c);
|
|
769
834
|
const at = await requestedMoment(c, fields);
|
|
770
|
-
if (at)
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
c.body = body;
|
|
776
|
-
}
|
|
835
|
+
if (at) span.setAttribute("revenexx.backdated_at", at);
|
|
836
|
+
if (strip && fields.some((field) => Object.prototype.hasOwnProperty.call(c.body ?? {}, field))) {
|
|
837
|
+
const body = { ...c.body };
|
|
838
|
+
for (const field of fields) delete body[field];
|
|
839
|
+
c.body = body;
|
|
777
840
|
}
|
|
778
841
|
const route = matched.route;
|
|
779
842
|
return await runAt(at, () => route.handler(c));
|
|
@@ -807,15 +870,6 @@ function createApp(options = {}) {
|
|
|
807
870
|
return app;
|
|
808
871
|
}
|
|
809
872
|
|
|
810
|
-
// src/patch.ts
|
|
811
|
-
var EMPTY_UPDATE_MESSAGE = "request body must contain at least one field to update";
|
|
812
|
-
function updateFields(patch) {
|
|
813
|
-
if (!patch || typeof patch !== "object" || Array.isArray(patch)) return [];
|
|
814
|
-
return Object.keys(patch).filter(
|
|
815
|
-
(key) => patch[key] !== void 0
|
|
816
|
-
);
|
|
817
|
-
}
|
|
818
|
-
|
|
819
873
|
// src/query.ts
|
|
820
874
|
var OPS = /* @__PURE__ */ new Set(["eq", "neq", "gt", "gte", "lt", "lte", "like", "ilike", "in", "is"]);
|
|
821
875
|
|
|
@@ -838,13 +892,12 @@ function assertJsonFilter(column, value) {
|
|
|
838
892
|
);
|
|
839
893
|
}
|
|
840
894
|
}
|
|
841
|
-
function assertKnownKeys(query, opts) {
|
|
842
|
-
const columns = opts.columns ?? {};
|
|
895
|
+
function assertKnownKeys(query, opts, flags) {
|
|
843
896
|
const extra = opts.queryParams ?? [];
|
|
844
|
-
const known = (k) =>
|
|
897
|
+
const known = (k) => isFilterColumn(opts, flags, k) || RESERVED_LIST_QUERY_KEYS.includes(k) || extra.includes(k);
|
|
845
898
|
const unknown = Object.keys(query).filter((k) => !known(k));
|
|
846
899
|
if (unknown.length === 0) return;
|
|
847
|
-
const allowed = [.../* @__PURE__ */ new Set([...Object.keys(columns), ...RESERVED_LIST_QUERY_KEYS, ...extra])].sort();
|
|
900
|
+
const allowed = [.../* @__PURE__ */ new Set([...Object.keys(opts.columns ?? {}), ...flagColumns(flags), ...RESERVED_LIST_QUERY_KEYS, ...extra])].sort();
|
|
848
901
|
const quoted = unknown.map((k) => `'${k}'`).join(", ");
|
|
849
902
|
throw new HttpError(
|
|
850
903
|
400,
|
|
@@ -853,6 +906,10 @@ function assertKnownKeys(query, opts) {
|
|
|
853
906
|
{ code: "unknown_filter" }
|
|
854
907
|
);
|
|
855
908
|
}
|
|
909
|
+
function isFilterColumn(opts, flags, k) {
|
|
910
|
+
if (opts.columns && Object.prototype.hasOwnProperty.call(opts.columns, k)) return true;
|
|
911
|
+
return !(opts.queryParams ?? []).includes(k) && flagColumns(flags).includes(k);
|
|
912
|
+
}
|
|
856
913
|
var OPERATOR_PREFIX = new RegExp(`^(?:not|${[...OPS].join("|")})\\.`);
|
|
857
914
|
function assertNoOperator(column, value) {
|
|
858
915
|
if (!OPERATOR_PREFIX.test(value)) return;
|
|
@@ -892,14 +949,19 @@ function mountCrud(app, repo, opts) {
|
|
|
892
949
|
const enabled = new Set(opts.only ?? ["list", "get", "create", "update", "delete"]);
|
|
893
950
|
const defaultLimit = opts.defaultLimit ?? 50;
|
|
894
951
|
const maxLimit = opts.maxLimit ?? 200;
|
|
952
|
+
const described = describedEntity(repo);
|
|
953
|
+
const flags = {
|
|
954
|
+
trash: guardsTrash(opts.trash, described?.trash, opts.columns),
|
|
955
|
+
external_id: opts.external_id === true || described?.external_id === true
|
|
956
|
+
};
|
|
895
957
|
if (enabled.has("list")) {
|
|
896
958
|
app.get(base, async (c) => {
|
|
897
|
-
assertKnownKeys(c.query, opts);
|
|
959
|
+
assertKnownKeys(c.query, opts, flags);
|
|
898
960
|
const where = {};
|
|
899
961
|
for (const [k, v] of Object.entries(c.query)) {
|
|
900
|
-
if (!
|
|
962
|
+
if (!isFilterColumn(opts, flags, k)) continue;
|
|
901
963
|
assertNoOperator(k, v);
|
|
902
|
-
if (isJsonColumn(opts.columns[k])) assertJsonFilter(k, v);
|
|
964
|
+
if (isJsonColumn(opts.columns?.[k])) assertJsonFilter(k, v);
|
|
903
965
|
where[k] = v;
|
|
904
966
|
}
|
|
905
967
|
await assertParentExists(c, opts.parent);
|
|
@@ -922,6 +984,8 @@ function mountCrud(app, repo, opts) {
|
|
|
922
984
|
}
|
|
923
985
|
if (enabled.has("create")) {
|
|
924
986
|
app.post(base, async (c) => {
|
|
987
|
+
if (isList(c.body)) throw oneRecordRefusal();
|
|
988
|
+
assertNoTrashFields(flags, c.body);
|
|
925
989
|
await assertParentExists(c, opts.parent);
|
|
926
990
|
const data = { ...c.body, ...parentWhere(c, opts.parent) };
|
|
927
991
|
return c.json(await repo.create(data), 201);
|
|
@@ -935,6 +999,8 @@ function mountCrud(app, repo, opts) {
|
|
|
935
999
|
}
|
|
936
1000
|
if (enabled.has("update")) {
|
|
937
1001
|
app.put(idTemplate, async (c) => {
|
|
1002
|
+
if (isList(c.body)) throw oneRecordRefusal();
|
|
1003
|
+
assertNoTrashFields(flags, c.body);
|
|
938
1004
|
const { id } = await fetchOwned(repo, c, opts);
|
|
939
1005
|
if (updateFields(c.body).length === 0) throw new HttpError(400, EMPTY_UPDATE_MESSAGE, void 0, { code: "empty_update" });
|
|
940
1006
|
const patch = { ...c.body, ...parentWhere(c, opts.parent) };
|