@terreno/admin-backend 0.31.0 → 56.0.0-beta.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 +2 -57
- package/dist/adminApp.d.ts +0 -2
- package/dist/adminApp.js +12 -19
- package/dist/tests/bunSetup.d.ts +1 -0
- package/dist/tests/bunSetup.js +9 -0
- package/package.json +6 -6
- package/src/adminApp.models.test.ts +1 -34
- package/src/adminApp.ts +15 -25
- package/tsconfig.json +3 -1
- package/LICENSE +0 -21
package/README.md
CHANGED
|
@@ -1,60 +1,5 @@
|
|
|
1
1
|
# @terreno/admin-backend
|
|
2
2
|
|
|
3
|
-
Admin panel backend plugin for `@terreno/api` that auto-generates admin CRUD endpoints
|
|
3
|
+
Admin panel backend plugin for `@terreno/api` that auto-generates admin CRUD endpoints for Mongoose models.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
bun add @terreno/admin-backend @terreno/api mongoose
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Quick start
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import {TerrenoApp} from "@terreno/api";
|
|
15
|
-
import {AdminApp} from "@terreno/admin-backend";
|
|
16
|
-
import {User, Todo} from "./models";
|
|
17
|
-
|
|
18
|
-
new TerrenoApp({userModel: User})
|
|
19
|
-
.register(
|
|
20
|
-
new AdminApp({
|
|
21
|
-
basePath: "/admin",
|
|
22
|
-
models: [
|
|
23
|
-
{
|
|
24
|
-
model: User,
|
|
25
|
-
routePath: "/users",
|
|
26
|
-
displayName: "Users",
|
|
27
|
-
listFields: ["email", "name", "admin"],
|
|
28
|
-
defaultSort: "-created",
|
|
29
|
-
},
|
|
30
|
-
{
|
|
31
|
-
model: Todo,
|
|
32
|
-
routePath: "/todos",
|
|
33
|
-
displayName: "Todos",
|
|
34
|
-
listFields: ["title", "completed", "ownerId"],
|
|
35
|
-
},
|
|
36
|
-
],
|
|
37
|
-
})
|
|
38
|
-
)
|
|
39
|
-
.start();
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
This creates `GET /admin/config` plus full CRUD at `/admin/users` and `/admin/todos`, all protected with `Permissions.IsAdmin`.
|
|
43
|
-
|
|
44
|
-
## What's included
|
|
45
|
-
|
|
46
|
-
- `AdminApp` — registers admin routes and the config metadata endpoint
|
|
47
|
-
- `DocumentStorageApp` — optional GCS document browser routes for admins
|
|
48
|
-
- `runScriptCli` — CLI helper for admin script execution
|
|
49
|
-
- Auto-generated CRUD via `modelRouter` with `IsAdmin` on every route
|
|
50
|
-
- `GET /admin/config` — field metadata extracted from Mongoose schemas and OpenAPI
|
|
51
|
-
- Admin UI v2 route helpers (`adminUiV2` exports)
|
|
52
|
-
- TypeScript types: `AdminModelConfig`, `AdminOptions`, `AdminFieldOverride`, and more
|
|
53
|
-
|
|
54
|
-
## Documentation
|
|
55
|
-
|
|
56
|
-
Full API reference: [docs/reference/admin-backend.md](https://github.com/flourishhealth/terreno/blob/master/docs/reference/admin-backend.md)
|
|
57
|
-
|
|
58
|
-
## License and Contributing
|
|
59
|
-
|
|
60
|
-
Licensed under the [MIT License](https://github.com/flourishhealth/terreno/blob/master/LICENSE). See [CONTRIBUTING.md](https://github.com/flourishhealth/terreno/blob/master/CONTRIBUTING.md) for contribution guidelines.
|
|
5
|
+
See the [full documentation](../.claude/rules/admin-backend/00-admin-backend.md) for usage, configuration, and integration details.
|
package/dist/adminApp.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { type PopulatePath, type ScriptArgDef, type ScriptRunner, type User } from "@terreno/api";
|
|
2
2
|
import express from "express";
|
|
3
3
|
import type { Model } from "mongoose";
|
|
4
|
-
import mongoose from "mongoose";
|
|
5
4
|
import { type AdminActionInput, type AdminFieldsetInput, type AdminHomeInput, type AdminListFilter, type AdminModelPermissionsInput } from "./adminUiV2";
|
|
6
5
|
/**
|
|
7
6
|
* Configuration for a single model in the admin panel.
|
|
@@ -128,7 +127,6 @@ export interface AdminOptions {
|
|
|
128
127
|
*/
|
|
129
128
|
onAdminAudit?: (event: AdminAuditEvent, req: express.Request) => void | Promise<void>;
|
|
130
129
|
}
|
|
131
|
-
export declare const getArrayEmbeddedSchemaType: (schemaPath: mongoose.SchemaType) => mongoose.SchemaType | undefined;
|
|
132
130
|
/**
|
|
133
131
|
* TerrenoPlugin that auto-generates admin CRUD endpoints for Mongoose models.
|
|
134
132
|
*
|
package/dist/adminApp.js
CHANGED
|
@@ -86,7 +86,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
86
86
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
87
87
|
};
|
|
88
88
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
89
|
-
exports.AdminApp =
|
|
89
|
+
exports.AdminApp = void 0;
|
|
90
90
|
var api_1 = require("@terreno/api");
|
|
91
91
|
var express_1 = __importDefault(require("express"));
|
|
92
92
|
var luxon_1 = require("luxon");
|
|
@@ -167,14 +167,6 @@ var auditActorId = function (request) {
|
|
|
167
167
|
}
|
|
168
168
|
return String(user._id);
|
|
169
169
|
};
|
|
170
|
-
var getArrayEmbeddedSchemaType = function (schemaPath) {
|
|
171
|
-
var compatiblePath = schemaPath;
|
|
172
|
-
if (typeof compatiblePath.getEmbeddedSchemaType === "function") {
|
|
173
|
-
return compatiblePath.getEmbeddedSchemaType();
|
|
174
|
-
}
|
|
175
|
-
return compatiblePath.caster;
|
|
176
|
-
};
|
|
177
|
-
exports.getArrayEmbeddedSchemaType = getArrayEmbeddedSchemaType;
|
|
178
170
|
var extractFieldMeta = function (properties, required) {
|
|
179
171
|
var e_3, _a;
|
|
180
172
|
var _b, _c, _d;
|
|
@@ -357,10 +349,11 @@ var AdminApp = /** @class */ (function () {
|
|
|
357
349
|
if (Array.isArray(pathOptions === null || pathOptions === void 0 ? void 0 : pathOptions.type) && ((_d = pathOptions.type[0]) === null || _d === void 0 ? void 0 : _d.ref)) {
|
|
358
350
|
field.ref = pathOptions.type[0].ref;
|
|
359
351
|
}
|
|
360
|
-
// For arrays, use the
|
|
352
|
+
// For arrays, use the caster to infer the primitive item type/ref.
|
|
353
|
+
// Mongoose caster.instance is "String" | "Number" | "Boolean" | "ObjectID".
|
|
361
354
|
if (schemaPath.instance === "Array") {
|
|
362
|
-
var
|
|
363
|
-
if ((
|
|
355
|
+
var caster = schemaPath.caster;
|
|
356
|
+
if ((caster === null || caster === void 0 ? void 0 : caster.instance) && !field.items) {
|
|
364
357
|
var instanceToType = {
|
|
365
358
|
Boolean: "boolean",
|
|
366
359
|
Number: "number",
|
|
@@ -369,15 +362,15 @@ var AdminApp = /** @class */ (function () {
|
|
|
369
362
|
SchemaObjectId: "objectid",
|
|
370
363
|
String: "string",
|
|
371
364
|
};
|
|
372
|
-
var mapped = instanceToType[
|
|
365
|
+
var mapped = instanceToType[caster.instance];
|
|
373
366
|
if (mapped) {
|
|
374
367
|
field.itemType = mapped;
|
|
375
368
|
}
|
|
376
|
-
if ((_e =
|
|
377
|
-
field.itemRef =
|
|
369
|
+
if ((_e = caster.options) === null || _e === void 0 ? void 0 : _e.ref) {
|
|
370
|
+
field.itemRef = caster.options.ref;
|
|
378
371
|
}
|
|
379
|
-
if (
|
|
380
|
-
field.itemEnum =
|
|
372
|
+
if ((_f = caster.options) === null || _f === void 0 ? void 0 : _f.enum) {
|
|
373
|
+
field.itemEnum = caster.options.enum;
|
|
381
374
|
}
|
|
382
375
|
}
|
|
383
376
|
}
|
|
@@ -671,7 +664,7 @@ var AdminApp = /** @class */ (function () {
|
|
|
671
664
|
updateOp.$unset = unsetFields;
|
|
672
665
|
}
|
|
673
666
|
return [4 /*yield*/, api_1.VersionConfig.findOneAndUpdate({ _singleton: "config" }, updateOp, {
|
|
674
|
-
|
|
667
|
+
new: true,
|
|
675
668
|
runValidators: true,
|
|
676
669
|
setDefaultsOnInsert: true,
|
|
677
670
|
upsert: true,
|
|
@@ -1420,7 +1413,7 @@ var AdminApp = /** @class */ (function () {
|
|
|
1420
1413
|
completedAt: luxon_1.DateTime.now().toJSDate(),
|
|
1421
1414
|
status: "cancelled",
|
|
1422
1415
|
},
|
|
1423
|
-
}, {
|
|
1416
|
+
}, { new: true })];
|
|
1424
1417
|
case 5:
|
|
1425
1418
|
cancelled = _b.sent();
|
|
1426
1419
|
if (!cancelled) {
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
var test_1 = require("@terreno/test");
|
|
4
|
+
process.env.TERRENO_TEST_USE_MEMORY_MONGO = "true";
|
|
5
|
+
(0, test_1.registerSimpleMongoPreload)({
|
|
6
|
+
testEnv: {
|
|
7
|
+
tokenIssuer: "terreno-admin-backend.test",
|
|
8
|
+
},
|
|
9
|
+
});
|
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
},
|
|
6
6
|
"dependencies": {
|
|
7
7
|
"@google-cloud/storage": "^7.15.0",
|
|
8
|
-
"@terreno/api": "0.
|
|
8
|
+
"@terreno/api": "56.0.0-beta.0",
|
|
9
9
|
"express": "^5.2.1",
|
|
10
10
|
"luxon": "^3.7.2",
|
|
11
11
|
"multer": "2.2.0"
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"description": "Admin panel backend plugin for @terreno/api",
|
|
14
14
|
"devDependencies": {
|
|
15
15
|
"@biomejs/biome": "^2.3.6",
|
|
16
|
-
"@terreno/test": "0.
|
|
16
|
+
"@terreno/test": "56.0.0-beta.0",
|
|
17
17
|
"@types/bun": "^1.3.8",
|
|
18
18
|
"@types/express": "^5.0.6",
|
|
19
19
|
"@types/luxon": "^3.7.1",
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"@types/supertest": "^7.2.0",
|
|
22
22
|
"passport-local-mongoose": "^9.0.1",
|
|
23
23
|
"supertest": "^7.2.2",
|
|
24
|
-
"typescript": "~
|
|
24
|
+
"typescript": "~6.0.3"
|
|
25
25
|
},
|
|
26
26
|
"homepage": "https://github.com/FlourishHealth/terreno#readme",
|
|
27
27
|
"keywords": [
|
|
@@ -30,9 +30,9 @@
|
|
|
30
30
|
"express",
|
|
31
31
|
"terreno"
|
|
32
32
|
],
|
|
33
|
-
"license": "
|
|
33
|
+
"license": "Apache-2.0",
|
|
34
34
|
"peerDependencies": {
|
|
35
|
-
"mongoose": "
|
|
35
|
+
"mongoose": ">=8.0.0"
|
|
36
36
|
},
|
|
37
37
|
"main": "dist/index.js",
|
|
38
38
|
"name": "@terreno/admin-backend",
|
|
@@ -54,5 +54,5 @@
|
|
|
54
54
|
"test:coverage": "bun run ../scripts/check-coverage.ts"
|
|
55
55
|
},
|
|
56
56
|
"types": "dist/index.d.ts",
|
|
57
|
-
"version": "0.
|
|
57
|
+
"version": "56.0.0-beta.0"
|
|
58
58
|
}
|
|
@@ -17,12 +17,11 @@ import {
|
|
|
17
17
|
UserModel,
|
|
18
18
|
} from "@terreno/api/testing";
|
|
19
19
|
import type express from "express";
|
|
20
|
-
import mongoose from "mongoose";
|
|
21
20
|
import supertest from "supertest";
|
|
22
21
|
import type TestAgent from "supertest/lib/agent";
|
|
23
22
|
|
|
24
23
|
import type {AdminAuditEvent, AdminModelConfig, AdminOptions} from "./adminApp";
|
|
25
|
-
import {AdminApp
|
|
24
|
+
import {AdminApp} from "./adminApp";
|
|
26
25
|
|
|
27
26
|
const buildApp = (
|
|
28
27
|
models: AdminModelConfig[] = [],
|
|
@@ -52,24 +51,6 @@ const foodModelConfig: AdminModelConfig = {
|
|
|
52
51
|
routePath: "/foods",
|
|
53
52
|
};
|
|
54
53
|
|
|
55
|
-
const enumArraySchema = new mongoose.Schema({
|
|
56
|
-
values: {
|
|
57
|
-
description: "Allowed enum values",
|
|
58
|
-
type: [{enum: ["alpha", "beta"], type: String}],
|
|
59
|
-
},
|
|
60
|
-
});
|
|
61
|
-
const EnumArrayModel =
|
|
62
|
-
mongoose.models.AdminEnumArray ?? mongoose.model("AdminEnumArray", enumArraySchema);
|
|
63
|
-
|
|
64
|
-
describe("getArrayEmbeddedSchemaType", () => {
|
|
65
|
-
it("supports the legacy Mongoose 8 caster property", () => {
|
|
66
|
-
const embeddedSchemaType = new mongoose.Schema({value: String}).path("value");
|
|
67
|
-
const legacyArrayPath = {caster: embeddedSchemaType} as unknown as mongoose.SchemaType;
|
|
68
|
-
|
|
69
|
-
expect(getArrayEmbeddedSchemaType(legacyArrayPath)).toBe(embeddedSchemaType);
|
|
70
|
-
});
|
|
71
|
-
});
|
|
72
|
-
|
|
73
54
|
describe("AdminApp /admin/config", () => {
|
|
74
55
|
let app: express.Application;
|
|
75
56
|
let adminAgent: TestAgent;
|
|
@@ -169,20 +150,6 @@ describe("AdminApp /admin/config", () => {
|
|
|
169
150
|
expect(foodMeta.fields.tags.items).toBeUndefined();
|
|
170
151
|
});
|
|
171
152
|
|
|
172
|
-
it("extracts itemEnum for enum arrays", async () => {
|
|
173
|
-
const enumApp = buildApp([
|
|
174
|
-
{
|
|
175
|
-
displayName: "Enum arrays",
|
|
176
|
-
listFields: ["values"],
|
|
177
|
-
model: EnumArrayModel,
|
|
178
|
-
routePath: "/enum-arrays",
|
|
179
|
-
},
|
|
180
|
-
]);
|
|
181
|
-
const enumAgent = await authAsUser(enumApp, "admin");
|
|
182
|
-
const res = await enumAgent.get("/admin/config").expect(200);
|
|
183
|
-
expect(res.body.models[0].fields.values.itemEnum).toEqual(["alpha", "beta"]);
|
|
184
|
-
});
|
|
185
|
-
|
|
186
153
|
it("extracts itemType and itemRef for arrays of ObjectId references", async () => {
|
|
187
154
|
const res = await adminAgent.get("/admin/config").expect(200);
|
|
188
155
|
const [foodMeta] = res.body.models;
|
package/src/adminApp.ts
CHANGED
|
@@ -319,21 +319,6 @@ interface OpenApiProperty {
|
|
|
319
319
|
};
|
|
320
320
|
}
|
|
321
321
|
|
|
322
|
-
interface ArraySchemaTypeCompatibility {
|
|
323
|
-
caster?: mongoose.SchemaType;
|
|
324
|
-
getEmbeddedSchemaType?: () => mongoose.SchemaType | undefined;
|
|
325
|
-
}
|
|
326
|
-
|
|
327
|
-
export const getArrayEmbeddedSchemaType = (
|
|
328
|
-
schemaPath: mongoose.SchemaType
|
|
329
|
-
): mongoose.SchemaType | undefined => {
|
|
330
|
-
const compatiblePath = schemaPath as mongoose.SchemaType & ArraySchemaTypeCompatibility;
|
|
331
|
-
if (typeof compatiblePath.getEmbeddedSchemaType === "function") {
|
|
332
|
-
return compatiblePath.getEmbeddedSchemaType();
|
|
333
|
-
}
|
|
334
|
-
return compatiblePath.caster;
|
|
335
|
-
};
|
|
336
|
-
|
|
337
322
|
const extractFieldMeta = (
|
|
338
323
|
properties: Record<string, OpenApiProperty>,
|
|
339
324
|
required: string[]
|
|
@@ -508,10 +493,15 @@ export class AdminApp {
|
|
|
508
493
|
if (Array.isArray(pathOptions?.type) && pathOptions.type[0]?.ref) {
|
|
509
494
|
field.ref = pathOptions.type[0].ref;
|
|
510
495
|
}
|
|
511
|
-
// For arrays, use the
|
|
496
|
+
// For arrays, use the caster to infer the primitive item type/ref.
|
|
497
|
+
// Mongoose caster.instance is "String" | "Number" | "Boolean" | "ObjectID".
|
|
512
498
|
if (schemaPath.instance === "Array") {
|
|
513
|
-
const
|
|
514
|
-
|
|
499
|
+
const caster = (
|
|
500
|
+
schemaPath as unknown as {
|
|
501
|
+
caster?: {instance?: string; options?: {ref?: string; enum?: string[]}};
|
|
502
|
+
}
|
|
503
|
+
).caster;
|
|
504
|
+
if (caster?.instance && !field.items) {
|
|
515
505
|
const instanceToType: Record<string, string> = {
|
|
516
506
|
Boolean: "boolean",
|
|
517
507
|
Number: "number",
|
|
@@ -520,15 +510,15 @@ export class AdminApp {
|
|
|
520
510
|
SchemaObjectId: "objectid",
|
|
521
511
|
String: "string",
|
|
522
512
|
};
|
|
523
|
-
const mapped = instanceToType[
|
|
513
|
+
const mapped = instanceToType[caster.instance];
|
|
524
514
|
if (mapped) {
|
|
525
515
|
field.itemType = mapped;
|
|
526
516
|
}
|
|
527
|
-
if (
|
|
528
|
-
field.itemRef =
|
|
517
|
+
if (caster.options?.ref) {
|
|
518
|
+
field.itemRef = caster.options.ref;
|
|
529
519
|
}
|
|
530
|
-
if (
|
|
531
|
-
field.itemEnum =
|
|
520
|
+
if (caster.options?.enum) {
|
|
521
|
+
field.itemEnum = caster.options.enum;
|
|
532
522
|
}
|
|
533
523
|
}
|
|
534
524
|
}
|
|
@@ -807,7 +797,7 @@ export class AdminApp {
|
|
|
807
797
|
updateOp.$unset = unsetFields;
|
|
808
798
|
}
|
|
809
799
|
const doc = await VersionConfig.findOneAndUpdate({_singleton: "config"}, updateOp, {
|
|
810
|
-
|
|
800
|
+
new: true,
|
|
811
801
|
runValidators: true,
|
|
812
802
|
setDefaultsOnInsert: true,
|
|
813
803
|
upsert: true,
|
|
@@ -1393,7 +1383,7 @@ export class AdminApp {
|
|
|
1393
1383
|
status: "cancelled",
|
|
1394
1384
|
},
|
|
1395
1385
|
},
|
|
1396
|
-
{
|
|
1386
|
+
{new: true}
|
|
1397
1387
|
);
|
|
1398
1388
|
|
|
1399
1389
|
if (!cancelled) {
|
package/tsconfig.json
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
"downlevelIteration": true,
|
|
8
8
|
"esModuleInterop": true,
|
|
9
9
|
"forceConsistentCasingInFileNames": true,
|
|
10
|
+
"ignoreDeprecations": "6.0",
|
|
10
11
|
"jsx": "react",
|
|
11
12
|
"lib": ["es2017", "dom", "es2017.object"],
|
|
12
13
|
"module": "commonjs",
|
|
@@ -18,6 +19,7 @@
|
|
|
18
19
|
"noUnusedLocals": false,
|
|
19
20
|
"noUnusedParameters": false,
|
|
20
21
|
"outDir": "./dist",
|
|
22
|
+
"rootDir": "./src",
|
|
21
23
|
"preserveConstEnums": true,
|
|
22
24
|
"removeComments": false,
|
|
23
25
|
"skipLibCheck": true,
|
|
@@ -26,6 +28,6 @@
|
|
|
26
28
|
"strictNullChecks": true,
|
|
27
29
|
"target": "es5"
|
|
28
30
|
},
|
|
29
|
-
"exclude": ["node_modules", "
|
|
31
|
+
"exclude": ["node_modules", "**/*.test.ts"],
|
|
30
32
|
"include": ["src/**/*.ts*", "src/*.ts"]
|
|
31
33
|
}
|
package/LICENSE
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2026 Flourish Health, Inc.
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|