@appxdigital/appx-core 0.1.127-beta.0 → 0.1.128-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/CHANGELOG.md +30 -0
- package/README.md +1 -1
- package/dist/common/guards/user-population.guard.d.ts.map +1 -1
- package/dist/common/guards/user-population.guard.js +5 -1
- package/dist/config/generate-all.js +5 -1
- package/dist/config/generate-graphql.d.ts +10 -0
- package/dist/config/generate-graphql.d.ts.map +1 -0
- package/dist/config/generate-graphql.js +76 -0
- package/dist/config/generate-models.js +0 -2
- package/dist/config/generate-modules.d.ts.map +1 -1
- package/dist/config/generate-modules.js +12 -3
- package/dist/graphql/generic.resolver.d.ts +49 -13
- package/dist/graphql/generic.resolver.d.ts.map +1 -1
- package/dist/graphql/generic.resolver.js +72 -64
- package/dist/graphql/graphql.module.d.ts +9 -0
- package/dist/graphql/graphql.module.d.ts.map +1 -1
- package/dist/graphql/graphql.module.js +32 -3
- package/docs/graphql.md +96 -34
- package/package.json +1 -1
- package/dist/config/generate-resolvers.d.ts +0 -8
- package/dist/config/generate-resolvers.d.ts.map +0 -1
- package/dist/config/generate-resolvers.js +0 -80
package/CHANGELOG.md
CHANGED
|
@@ -14,6 +14,36 @@ This project follows the `MAJOR.MINOR.PATCH` scheme in `package.json`.
|
|
|
14
14
|
|
|
15
15
|
---
|
|
16
16
|
|
|
17
|
+
## [0.1.128] — 2026-08-04
|
|
18
|
+
|
|
19
|
+
Read-only GraphQL, reworked into a **namespaced, opt-in-per-module** API.
|
|
20
|
+
|
|
21
|
+
### Added
|
|
22
|
+
|
|
23
|
+
- **Namespaced read API.** Each exposed model gets one root query field (its camelCase name) with three operations: `find` (→ list), `get` (→ first match or null), `count` (→ Int). Example: `query { project { find(where:{…}){ id } get(where:{…}){ id } count } }`. Short names live on the per-model namespace, so they never collide, aliases work (`recent: find(...)`), and several models can be queried in one request.
|
|
24
|
+
- **Opt-in per module — one line, no resolver file.** Expose a model by adding `CoreGraphqlResolver(<Model>Graphql)` to its module `providers` (the generated module ships this commented, copy-paste-ready). `<Model>Graphql` is a generated bundle at `src/generated/<model>/graphql.ts` (deploy-safe pass). Remove the line to un-expose.
|
|
25
|
+
- **`/graphql` mounted by default** in new projects (Apollo; Sandbox on `GET /graphql`). The schema stays valid before any model opts in.
|
|
26
|
+
- **Same ABAC as REST, verified end-to-end** (`test/http/graphql-abac.spec.ts`): unauthorized rows aren't returned (incl. `count`, which is filtered — no total leak), restricted fields come back null at top level and nested (`@Role`), and an inaccessible nested **record** is filtered while the parent stays accessible. GraphQL requests now populate the user across transports (`UserPopulationGuard` uses `transformContext`).
|
|
27
|
+
|
|
28
|
+
### Changed / Removed
|
|
29
|
+
|
|
30
|
+
- The old root-level `findAll<Model>s` / `findOne<Model>` / `findFirst<Model>` queries and the `GenericResolverFactory` export are **removed**, replaced by `CoreGraphqlResolver`.
|
|
31
|
+
- `appx-core generate models` **no longer scaffolds a per-module `*.resolver.ts` file**; GraphQL is opt-in via the one-liner above.
|
|
32
|
+
|
|
33
|
+
### Migration
|
|
34
|
+
|
|
35
|
+
> **Behaviour change — the GraphQL resolver API changed and per-module resolver files are no longer generated.** Only relevant if you use GraphQL.
|
|
36
|
+
|
|
37
|
+
1. **Delete the generated `src/modules/<model>/<model>.resolver.ts` files** — they import the removed `GenericResolverFactory` and will not compile. Remove `<Model>Resolver` from each module's `providers`.
|
|
38
|
+
2. Run **`appx-core generate`** to emit the new `src/generated/<model>/graphql.ts` bundles.
|
|
39
|
+
3. Add **`GraphqlModule`** to your `app.module` imports (new projects already have it): `import { GraphqlModule } from '@appxdigital/appx-core';`.
|
|
40
|
+
4. **Expose each model** you want in GraphQL by adding one provider line to its module: `CoreGraphqlResolver(<Model>Graphql)` (import `<Model>Graphql` from `../../generated/<model>/graphql`). See [docs/graphql.md](./docs/graphql.md).
|
|
41
|
+
5. **Update clients:** `findAllProjects(...)` → `project { find(...) }`, `findFirstProject` / `findOneProject` → `project { get(...) }`. Mutations remain REST-only.
|
|
42
|
+
|
|
43
|
+
> **Security caveat (unchanged, still open):** generated `where`/`orderBy` inputs include `@Role`/`@NoWrite` columns (a filter-oracle; output values are omitted). Don't expose models with sensitive filterable columns to untrusted roles until the input scrub lands.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
17
47
|
## [0.1.127] — 2026-08-03
|
|
18
48
|
|
|
19
49
|
### Changed
|
package/README.md
CHANGED
|
@@ -614,7 +614,7 @@ Operational guidance:
|
|
|
614
614
|
|
|
615
615
|
### GraphQL status
|
|
616
616
|
|
|
617
|
-
GraphQL
|
|
617
|
+
GraphQL exposes a **read-only** API — `find` / `get` / `count`, namespaced per model and **opt-in per module** (one line) — that runs through the same ABAC proxy as REST, so row filtering, field omission, and nested-relation filtering all apply. See **[docs/graphql.md](./docs/graphql.md)**. Not yet: mutations and full aggregates. One caveat before exposing sensitive models to untrusted roles — the generated `where`/`orderBy` inputs still include restricted columns (a filter-oracle; output values are omitted). REST CRUD + AdminJS remain the primary write surfaces.
|
|
618
618
|
|
|
619
619
|
---
|
|
620
620
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"user-population.guard.d.ts","sourceRoot":"","sources":["../../../src/common/guards/user-population.guard.ts"],"names":[],"mappings":"AACA,OAAO,EAAc,WAAW,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;
|
|
1
|
+
{"version":3,"file":"user-population.guard.d.ts","sourceRoot":"","sources":["../../../src/common/guards/user-population.guard.ts"],"names":[],"mappings":"AACA,OAAO,EAAc,WAAW,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAG9D,qBACa,mBAAoB,YAAW,WAAW;IAE/C,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,aAAa;gBAFb,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa;IAG3C,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;CA4BjE"}
|
|
@@ -14,6 +14,7 @@ const common_1 = require("@nestjs/common");
|
|
|
14
14
|
const jwt_1 = require("@nestjs/jwt");
|
|
15
15
|
const config_1 = require("@nestjs/config");
|
|
16
16
|
const auth_service_1 = require("../../modules/auth/auth.service");
|
|
17
|
+
const context_transformer_util_1 = require("../utils/context-transformer.util");
|
|
17
18
|
let UserPopulationGuard = exports.UserPopulationGuard = class UserPopulationGuard {
|
|
18
19
|
constructor(jwtService, authService, configService) {
|
|
19
20
|
this.jwtService = jwtService;
|
|
@@ -21,7 +22,10 @@ let UserPopulationGuard = exports.UserPopulationGuard = class UserPopulationGuar
|
|
|
21
22
|
this.configService = configService;
|
|
22
23
|
}
|
|
23
24
|
async canActivate(context) {
|
|
24
|
-
|
|
25
|
+
// Resolve the request across transports (HTTP and GraphQL) so JWT/session
|
|
26
|
+
// population also applies to GraphQL requests — otherwise a GraphQL query
|
|
27
|
+
// would reach the ABAC proxy with no user and be treated as a GUEST.
|
|
28
|
+
const { req: request } = (0, context_transformer_util_1.transformContext)(context);
|
|
25
29
|
if (request.isAuthenticated && request.isAuthenticated()) {
|
|
26
30
|
return true;
|
|
27
31
|
}
|
|
@@ -17,9 +17,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
*/
|
|
18
18
|
const utils_1 = require("./utils");
|
|
19
19
|
const generate_dtos_1 = require("./generate-dtos");
|
|
20
|
+
const generate_graphql_1 = require("./generate-graphql");
|
|
20
21
|
console.log('Running Prisma Generate (client + GraphQL artifacts)...');
|
|
21
22
|
// Project-local prisma: the CLI is usually global, so PATH has no project .bin.
|
|
22
23
|
(0, utils_1.runProjectBin)('prisma', 'generate');
|
|
24
|
+
const allModels = (0, utils_1.loadAllModels)();
|
|
23
25
|
console.log('Generating DTO base classes...');
|
|
24
|
-
(0, generate_dtos_1.generateDtoBases)(
|
|
26
|
+
(0, generate_dtos_1.generateDtoBases)(allModels);
|
|
27
|
+
console.log('Generating GraphQL bundles...');
|
|
28
|
+
(0, generate_graphql_1.generateGraphqlBundles)(allModels);
|
|
25
29
|
console.log('Deploy-safe generation complete — src/generated only, no code changes.');
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Emit the GraphQL bundle for every model. Part of the deploy-safe pass — it
|
|
3
|
+
* only writes under `src/generated/**`, overwriting each time so the bundle
|
|
4
|
+
* tracks the schema. Requires `prisma generate` (the GraphQL artifacts) to have
|
|
5
|
+
* run first; a model whose generated folder is missing is skipped with a note.
|
|
6
|
+
*/
|
|
7
|
+
export declare function generateGraphqlBundles(allModels: {
|
|
8
|
+
name: string;
|
|
9
|
+
}[]): void;
|
|
10
|
+
//# sourceMappingURL=generate-graphql.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate-graphql.d.ts","sourceRoot":"","sources":["../../src/config/generate-graphql.ts"],"names":[],"mappings":"AAmCA;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,EAAE,GAAG,IAAI,CAUxE"}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
25
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
+
exports.generateGraphqlBundles = void 0;
|
|
27
|
+
const fs = __importStar(require("fs"));
|
|
28
|
+
const path = __importStar(require("path"));
|
|
29
|
+
const utils_1 = require("./utils");
|
|
30
|
+
const generatedRoot = path.join(process.cwd(), 'src/generated');
|
|
31
|
+
/**
|
|
32
|
+
* The per-model GraphQL bundle: re-exports the `prisma-nestjs-graphql` types
|
|
33
|
+
* `CoreGraphqlResolver` needs (model + find/get/count inputs), as one import.
|
|
34
|
+
*
|
|
35
|
+
* Emitted for every model into `src/generated/<folder>/graphql.ts` (gitignored,
|
|
36
|
+
* overwrite-safe) so opting a module into GraphQL is a single import + a single
|
|
37
|
+
* provider line — no hand-written resolver file:
|
|
38
|
+
*
|
|
39
|
+
* import { <Model>Graphql } from '../../generated/<folder>/graphql';
|
|
40
|
+
* providers: [<Model>Service, CoreGraphqlResolver(<Model>Graphql)]
|
|
41
|
+
*/
|
|
42
|
+
const bundleTemplate = (model, folder) => {
|
|
43
|
+
const camel = model.charAt(0).toLowerCase() + model.slice(1);
|
|
44
|
+
return `import { ${model} } from './${folder}.model';
|
|
45
|
+
import { FindMany${model}Args } from './find-many-${folder}.args';
|
|
46
|
+
import { FindFirst${model}Args } from './find-first-${folder}.args';
|
|
47
|
+
import { ${model}WhereInput } from './${folder}-where.input';
|
|
48
|
+
import type { GraphqlModelBundle } from '@appxdigital/appx-core';
|
|
49
|
+
|
|
50
|
+
export const ${model}Graphql: GraphqlModelBundle<${model}> = {
|
|
51
|
+
model: ${model},
|
|
52
|
+
name: '${camel}',
|
|
53
|
+
findManyArgs: FindMany${model}Args,
|
|
54
|
+
findFirstArgs: FindFirst${model}Args,
|
|
55
|
+
whereInput: ${model}WhereInput,
|
|
56
|
+
};
|
|
57
|
+
`;
|
|
58
|
+
};
|
|
59
|
+
/**
|
|
60
|
+
* Emit the GraphQL bundle for every model. Part of the deploy-safe pass — it
|
|
61
|
+
* only writes under `src/generated/**`, overwriting each time so the bundle
|
|
62
|
+
* tracks the schema. Requires `prisma generate` (the GraphQL artifacts) to have
|
|
63
|
+
* run first; a model whose generated folder is missing is skipped with a note.
|
|
64
|
+
*/
|
|
65
|
+
function generateGraphqlBundles(allModels) {
|
|
66
|
+
for (const { name } of allModels) {
|
|
67
|
+
const folder = (0, utils_1.modelFolder)(name);
|
|
68
|
+
const dir = path.join(generatedRoot, folder);
|
|
69
|
+
if (!fs.existsSync(dir)) {
|
|
70
|
+
console.warn(`Skipping GraphQL bundle for ${name}: ${dir} not found (run prisma generate first).`);
|
|
71
|
+
continue;
|
|
72
|
+
}
|
|
73
|
+
fs.writeFileSync(path.join(dir, 'graphql.ts'), bundleTemplate(name, folder));
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
exports.generateGraphqlBundles = generateGraphqlBundles;
|
|
@@ -27,7 +27,6 @@ const generate_dtos_1 = require("./generate-dtos");
|
|
|
27
27
|
const generate_modules_1 = require("./generate-modules");
|
|
28
28
|
const generate_services_1 = require("./generate-services");
|
|
29
29
|
const generate_controllers_1 = require("./generate-controllers");
|
|
30
|
-
const generate_resolvers_1 = require("./generate-resolvers");
|
|
31
30
|
// inquirer is ESM-only; this file compiles to CommonJS, where tsc would
|
|
32
31
|
// down-level a normal `import('inquirer')` into `require()` (ERR_REQUIRE_ESM at
|
|
33
32
|
// runtime). Wrapping in `new Function` keeps a genuine dynamic `import()` that
|
|
@@ -95,7 +94,6 @@ async function main() {
|
|
|
95
94
|
(0, generate_modules_1.scaffoldModule)(name);
|
|
96
95
|
(0, generate_services_1.scaffoldService)(name);
|
|
97
96
|
(0, generate_controllers_1.scaffoldController)(name);
|
|
98
|
-
(0, generate_resolvers_1.scaffoldResolver)(name);
|
|
99
97
|
(0, generate_dtos_1.scaffoldDtoSubclass)(name);
|
|
100
98
|
}
|
|
101
99
|
(0, generate_modules_1.registerModulesInAppModule)(selected);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate-modules.d.ts","sourceRoot":"","sources":["../../src/config/generate-modules.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"generate-modules.d.ts","sourceRoot":"","sources":["../../src/config/generate-modules.ts"],"names":[],"mappings":"AAoCA,6EAA6E;AAC7E,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAItD;AAyCD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,2BAA2B,CACvC,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAAE,GACrB;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAC,CAkDpC;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CASrE"}
|
|
@@ -34,20 +34,29 @@ const appModulePath = path.join(process.cwd(), 'src/app.module.ts');
|
|
|
34
34
|
* @param model
|
|
35
35
|
* @param folder
|
|
36
36
|
*/
|
|
37
|
-
const moduleTemplate = (model, folder) =>
|
|
37
|
+
const moduleTemplate = (model, folder) => {
|
|
38
|
+
const camel = model.charAt(0).toLowerCase() + model.slice(1);
|
|
39
|
+
return `
|
|
38
40
|
import { Module } from '@nestjs/common';
|
|
39
41
|
import { PrismaModule } from '../../prisma/prisma.module';
|
|
40
42
|
import { ${model}Controller } from './${folder}.controller';
|
|
41
43
|
import { ${model}Service } from './${folder}.service';
|
|
42
|
-
|
|
44
|
+
// To expose this model over GraphQL (read-only: \`${camel} { find get count }\`),
|
|
45
|
+
// uncomment the two imports and the provider line below. See docs/graphql.md.
|
|
46
|
+
// import { CoreGraphqlResolver } from '@appxdigital/appx-core';
|
|
47
|
+
// import { ${model}Graphql } from '../../generated/${folder}/graphql';
|
|
43
48
|
|
|
44
49
|
@Module({
|
|
45
50
|
imports: [PrismaModule],
|
|
46
51
|
controllers: [${model}Controller],
|
|
47
|
-
providers: [
|
|
52
|
+
providers: [
|
|
53
|
+
${model}Service,
|
|
54
|
+
// CoreGraphqlResolver(${model}Graphql),
|
|
55
|
+
],
|
|
48
56
|
})
|
|
49
57
|
export class ${model}Module {}
|
|
50
58
|
`;
|
|
59
|
+
};
|
|
51
60
|
/** Scaffold the module file for a single model (once; never overwritten). */
|
|
52
61
|
function scaffoldModule(modelName) {
|
|
53
62
|
const folder = (0, utils_1.modelFolder)(modelName);
|
|
@@ -1,15 +1,51 @@
|
|
|
1
1
|
import { Type } from '../common/types';
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
2
|
+
/**
|
|
3
|
+
* The generated `prisma-nestjs-graphql` types a model needs to expose its
|
|
4
|
+
* read API. Produced per model by the deploy-safe generator as
|
|
5
|
+
* `src/generated/<model>/graphql.ts` (see `generate-graphql.ts`).
|
|
6
|
+
*/
|
|
7
|
+
export interface GraphqlModelBundle<ModelType = any> {
|
|
8
|
+
/** The `@ObjectType()` model class (also used to derive the root field name). */
|
|
9
|
+
model: Type<ModelType>;
|
|
10
|
+
/** Root query field name. Defaults to camelCase(model name), e.g. `project`. */
|
|
11
|
+
name?: string;
|
|
12
|
+
/** `FindMany<Model>Args` — arguments for `find`. */
|
|
13
|
+
findManyArgs: Type<any>;
|
|
14
|
+
/** `FindFirst<Model>Args` — arguments for `get`. */
|
|
15
|
+
findFirstArgs: Type<any>;
|
|
16
|
+
/** `<Model>WhereInput` — the `where` argument for `count`. */
|
|
17
|
+
whereInput: Type<any>;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Build a **namespaced, read-only** GraphQL resolver for one model.
|
|
21
|
+
*
|
|
22
|
+
* Every model contributes a single root query field (its camelCase name) that
|
|
23
|
+
* returns a per-model namespace type exposing three operations:
|
|
24
|
+
*
|
|
25
|
+
* query {
|
|
26
|
+
* project { # one root field per model — collision-free
|
|
27
|
+
* find(where, orderBy, take, …) # → [Project] (Prisma findMany)
|
|
28
|
+
* get(where, …) # → Project|null (Prisma findFirst)
|
|
29
|
+
* count(where) # → Int (Prisma count)
|
|
30
|
+
* }
|
|
31
|
+
* }
|
|
32
|
+
*
|
|
33
|
+
* Because the operation names (`find`/`get`/`count`) live on the namespace type
|
|
34
|
+
* rather than the root, they repeat freely across models and aliases work as
|
|
35
|
+
* expected (`recent: find(...)`, plus multiple models in one request).
|
|
36
|
+
*
|
|
37
|
+
* Every operation routes through `PrismaService.getModelDelegate`, so the exact
|
|
38
|
+
* same ABAC applies as for REST: row-level filtering, field omission (`@Role`),
|
|
39
|
+
* and nested-relation filtering. `PrismaSelect` turns the GraphQL selection set
|
|
40
|
+
* (including nested relations/children) into a Prisma `select`, so a single
|
|
41
|
+
* query resolves relations in one authorized round-trip.
|
|
42
|
+
*
|
|
43
|
+
* Returned value is a NestJS provider — add it to a module's `providers` to
|
|
44
|
+
* opt that model into GraphQL:
|
|
45
|
+
*
|
|
46
|
+
* import { CoreGraphqlResolver } from '@appxdigital/appx-core';
|
|
47
|
+
* import { ProjectGraphql } from '../../generated/project/graphql';
|
|
48
|
+
* providers: [ProjectService, CoreGraphqlResolver(ProjectGraphql)]
|
|
49
|
+
*/
|
|
50
|
+
export declare function CoreGraphqlResolver<ModelType>(bundle: GraphqlModelBundle<ModelType>): Type<any>;
|
|
15
51
|
//# sourceMappingURL=generic.resolver.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generic.resolver.d.ts","sourceRoot":"","sources":["../../src/graphql/generic.resolver.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,IAAI,EAAC,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"generic.resolver.d.ts","sourceRoot":"","sources":["../../src/graphql/generic.resolver.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAKrC;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,SAAS,GAAG,GAAG;IAC/C,iFAAiF;IACjF,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACvB,gFAAgF;IAChF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACxB,oDAAoD;IACpD,aAAa,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,8DAA8D;IAC9D,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,kBAAkB,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CA+C/F"}
|
|
@@ -12,97 +12,105 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
|
|
|
12
12
|
return function (target, key) { decorator(target, key, paramIndex); }
|
|
13
13
|
};
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.
|
|
15
|
+
exports.CoreGraphqlResolver = void 0;
|
|
16
16
|
const graphql_1 = require("@nestjs/graphql");
|
|
17
17
|
const plugins_1 = require("@paljs/plugins");
|
|
18
|
-
const guard_decorator_1 = require("../common/decorators/guard.decorator");
|
|
19
18
|
const prisma_service_1 = require("../prisma/prisma.service");
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
19
|
+
/**
|
|
20
|
+
* Build a **namespaced, read-only** GraphQL resolver for one model.
|
|
21
|
+
*
|
|
22
|
+
* Every model contributes a single root query field (its camelCase name) that
|
|
23
|
+
* returns a per-model namespace type exposing three operations:
|
|
24
|
+
*
|
|
25
|
+
* query {
|
|
26
|
+
* project { # one root field per model — collision-free
|
|
27
|
+
* find(where, orderBy, take, …) # → [Project] (Prisma findMany)
|
|
28
|
+
* get(where, …) # → Project|null (Prisma findFirst)
|
|
29
|
+
* count(where) # → Int (Prisma count)
|
|
30
|
+
* }
|
|
31
|
+
* }
|
|
32
|
+
*
|
|
33
|
+
* Because the operation names (`find`/`get`/`count`) live on the namespace type
|
|
34
|
+
* rather than the root, they repeat freely across models and aliases work as
|
|
35
|
+
* expected (`recent: find(...)`, plus multiple models in one request).
|
|
36
|
+
*
|
|
37
|
+
* Every operation routes through `PrismaService.getModelDelegate`, so the exact
|
|
38
|
+
* same ABAC applies as for REST: row-level filtering, field omission (`@Role`),
|
|
39
|
+
* and nested-relation filtering. `PrismaSelect` turns the GraphQL selection set
|
|
40
|
+
* (including nested relations/children) into a Prisma `select`, so a single
|
|
41
|
+
* query resolves relations in one authorized round-trip.
|
|
42
|
+
*
|
|
43
|
+
* Returned value is a NestJS provider — add it to a module's `providers` to
|
|
44
|
+
* opt that model into GraphQL:
|
|
45
|
+
*
|
|
46
|
+
* import { CoreGraphqlResolver } from '@appxdigital/appx-core';
|
|
47
|
+
* import { ProjectGraphql } from '../../generated/project/graphql';
|
|
48
|
+
* providers: [ProjectService, CoreGraphqlResolver(ProjectGraphql)]
|
|
49
|
+
*/
|
|
50
|
+
function CoreGraphqlResolver(bundle) {
|
|
51
|
+
const { model, findManyArgs, findFirstArgs, whereInput } = bundle;
|
|
52
|
+
const modelName = model.name; // Pascal, e.g. 'Project'
|
|
53
|
+
const rootName = bundle.name ?? modelName.charAt(0).toLowerCase() + modelName.slice(1);
|
|
54
|
+
let ModelQueries = class ModelQueries {
|
|
55
|
+
};
|
|
56
|
+
ModelQueries = __decorate([
|
|
57
|
+
(0, graphql_1.ObjectType)(`${modelName}Queries`)
|
|
58
|
+
], ModelQueries);
|
|
59
|
+
let ModelQueriesResolver = class ModelQueriesResolver {
|
|
23
60
|
constructor(prisma) {
|
|
24
61
|
this.prisma = prisma;
|
|
25
|
-
if (guardedMethods) {
|
|
26
|
-
(0, guard_decorator_1.applyMethodGuards)(GenericResolverClass_1, guardedMethods);
|
|
27
|
-
}
|
|
28
62
|
}
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
...select,
|
|
35
|
-
});
|
|
63
|
+
// The root field. Returns an empty object; the operations below are
|
|
64
|
+
// resolved lazily as fields of the namespace, so `project { count }`
|
|
65
|
+
// never runs `find`/`get`.
|
|
66
|
+
namespace() {
|
|
67
|
+
return {};
|
|
36
68
|
}
|
|
37
|
-
async
|
|
69
|
+
async find(args, info) {
|
|
38
70
|
const select = new plugins_1.PrismaSelect(info).value;
|
|
39
|
-
|
|
40
|
-
return modelDelegate.findFirst({
|
|
41
|
-
where,
|
|
42
|
-
...select,
|
|
43
|
-
});
|
|
71
|
+
return this.prisma.getModelDelegate(modelName).findMany({ ...args, ...select });
|
|
44
72
|
}
|
|
45
|
-
async
|
|
73
|
+
async get(args, info) {
|
|
46
74
|
const select = new plugins_1.PrismaSelect(info).value;
|
|
47
|
-
|
|
48
|
-
return modelDelegate.findFirst({
|
|
49
|
-
...args,
|
|
50
|
-
...select,
|
|
51
|
-
});
|
|
75
|
+
return this.prisma.getModelDelegate(modelName).findFirst({ ...args, ...select });
|
|
52
76
|
}
|
|
53
|
-
async
|
|
54
|
-
|
|
55
|
-
const modelDelegate = this.prisma.getModelDelegate(model);
|
|
56
|
-
return modelDelegate.aggregate({
|
|
57
|
-
...args,
|
|
58
|
-
...select,
|
|
59
|
-
});
|
|
77
|
+
async count(where) {
|
|
78
|
+
return this.prisma.getModelDelegate(modelName).count({ where });
|
|
60
79
|
}
|
|
61
80
|
};
|
|
62
81
|
__decorate([
|
|
63
|
-
(0, graphql_1.Query)(() =>
|
|
64
|
-
name: `findAll${model.charAt(0).toUpperCase() + model.slice(1)}s`,
|
|
65
|
-
}),
|
|
66
|
-
__param(0, (0, graphql_1.Args)({ type: () => findManyArgsType, nullable: true })),
|
|
67
|
-
__param(1, (0, graphql_1.Info)()),
|
|
82
|
+
(0, graphql_1.Query)(() => ModelQueries, { name: rootName }),
|
|
68
83
|
__metadata("design:type", Function),
|
|
69
|
-
__metadata("design:paramtypes", [
|
|
70
|
-
__metadata("design:returntype",
|
|
71
|
-
],
|
|
84
|
+
__metadata("design:paramtypes", []),
|
|
85
|
+
__metadata("design:returntype", ModelQueries)
|
|
86
|
+
], ModelQueriesResolver.prototype, "namespace", null);
|
|
72
87
|
__decorate([
|
|
73
|
-
(0, graphql_1.
|
|
74
|
-
|
|
75
|
-
}),
|
|
76
|
-
__param(0, (0, graphql_1.Args)('where', { type: () => whereUniqueInputType, nullable: false })),
|
|
88
|
+
(0, graphql_1.ResolveField)(() => [model], { name: 'find' }),
|
|
89
|
+
__param(0, (0, graphql_1.Args)({ type: () => findManyArgs, nullable: true })),
|
|
77
90
|
__param(1, (0, graphql_1.Info)()),
|
|
78
91
|
__metadata("design:type", Function),
|
|
79
92
|
__metadata("design:paramtypes", [Object, Object]),
|
|
80
93
|
__metadata("design:returntype", Promise)
|
|
81
|
-
],
|
|
94
|
+
], ModelQueriesResolver.prototype, "find", null);
|
|
82
95
|
__decorate([
|
|
83
|
-
(0, graphql_1.
|
|
84
|
-
|
|
85
|
-
}),
|
|
86
|
-
__param(0, (0, graphql_1.Args)({ type: () => findManyArgsType, nullable: true })),
|
|
96
|
+
(0, graphql_1.ResolveField)(() => model, { name: 'get', nullable: true }),
|
|
97
|
+
__param(0, (0, graphql_1.Args)({ type: () => findFirstArgs, nullable: true })),
|
|
87
98
|
__param(1, (0, graphql_1.Info)()),
|
|
88
99
|
__metadata("design:type", Function),
|
|
89
100
|
__metadata("design:paramtypes", [Object, Object]),
|
|
90
101
|
__metadata("design:returntype", Promise)
|
|
91
|
-
],
|
|
102
|
+
], ModelQueriesResolver.prototype, "get", null);
|
|
92
103
|
__decorate([
|
|
93
|
-
(0, graphql_1.
|
|
94
|
-
|
|
95
|
-
}),
|
|
96
|
-
__param(0, (0, graphql_1.Args)({ type: () => aggregateArgsType, nullable: true })),
|
|
97
|
-
__param(1, (0, graphql_1.Info)()),
|
|
104
|
+
(0, graphql_1.ResolveField)(() => graphql_1.Int, { name: 'count' }),
|
|
105
|
+
__param(0, (0, graphql_1.Args)('where', { type: () => whereInput, nullable: true })),
|
|
98
106
|
__metadata("design:type", Function),
|
|
99
|
-
__metadata("design:paramtypes", [Object
|
|
107
|
+
__metadata("design:paramtypes", [Object]),
|
|
100
108
|
__metadata("design:returntype", Promise)
|
|
101
|
-
],
|
|
102
|
-
|
|
103
|
-
(0, graphql_1.Resolver)(
|
|
109
|
+
], ModelQueriesResolver.prototype, "count", null);
|
|
110
|
+
ModelQueriesResolver = __decorate([
|
|
111
|
+
(0, graphql_1.Resolver)(() => ModelQueries),
|
|
104
112
|
__metadata("design:paramtypes", [prisma_service_1.PrismaService])
|
|
105
|
-
],
|
|
106
|
-
return
|
|
113
|
+
], ModelQueriesResolver);
|
|
114
|
+
return ModelQueriesResolver;
|
|
107
115
|
}
|
|
108
|
-
exports.
|
|
116
|
+
exports.CoreGraphqlResolver = CoreGraphqlResolver;
|
|
@@ -1,3 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Always-present root query. GraphQL requires a non-empty `Query` type, but a
|
|
3
|
+
* project may register `GraphqlModule` before any model has opted in (models
|
|
4
|
+
* opt in per-module via `CoreGraphqlResolver`). This trivial field keeps the
|
|
5
|
+
* schema valid in that state so `/graphql` is live from the start.
|
|
6
|
+
*/
|
|
7
|
+
export declare class AppxCoreRootResolver {
|
|
8
|
+
appxCore(): string;
|
|
9
|
+
}
|
|
1
10
|
export declare class GraphqlModule {
|
|
2
11
|
}
|
|
3
12
|
//# sourceMappingURL=graphql.module.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"graphql.module.d.ts","sourceRoot":"","sources":["../../src/graphql/graphql.module.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"graphql.module.d.ts","sourceRoot":"","sources":["../../src/graphql/graphql.module.ts"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH,qBACa,oBAAoB;IAK7B,QAAQ,IAAI,MAAM;CAGrB;AAED,qBAca,aAAa;CAAG"}
|
|
@@ -5,12 +5,37 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
|
|
|
5
5
|
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
6
|
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
7
|
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
8
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.GraphqlModule = void 0;
|
|
12
|
+
exports.GraphqlModule = exports.AppxCoreRootResolver = void 0;
|
|
10
13
|
const common_1 = require("@nestjs/common");
|
|
11
14
|
const graphql_1 = require("@nestjs/graphql");
|
|
12
|
-
const path_1 = require("path");
|
|
13
15
|
const apollo_1 = require("@nestjs/apollo");
|
|
16
|
+
/**
|
|
17
|
+
* Always-present root query. GraphQL requires a non-empty `Query` type, but a
|
|
18
|
+
* project may register `GraphqlModule` before any model has opted in (models
|
|
19
|
+
* opt in per-module via `CoreGraphqlResolver`). This trivial field keeps the
|
|
20
|
+
* schema valid in that state so `/graphql` is live from the start.
|
|
21
|
+
*/
|
|
22
|
+
let AppxCoreRootResolver = exports.AppxCoreRootResolver = class AppxCoreRootResolver {
|
|
23
|
+
appxCore() {
|
|
24
|
+
return '@appxdigital/appx-core';
|
|
25
|
+
}
|
|
26
|
+
};
|
|
27
|
+
__decorate([
|
|
28
|
+
(0, graphql_1.Query)(() => String, {
|
|
29
|
+
name: '_appxCore',
|
|
30
|
+
description: 'Liveness field. Ensures a valid GraphQL schema even before any model opts in.',
|
|
31
|
+
}),
|
|
32
|
+
__metadata("design:type", Function),
|
|
33
|
+
__metadata("design:paramtypes", []),
|
|
34
|
+
__metadata("design:returntype", String)
|
|
35
|
+
], AppxCoreRootResolver.prototype, "appxCore", null);
|
|
36
|
+
exports.AppxCoreRootResolver = AppxCoreRootResolver = __decorate([
|
|
37
|
+
(0, graphql_1.Resolver)()
|
|
38
|
+
], AppxCoreRootResolver);
|
|
14
39
|
let GraphqlModule = exports.GraphqlModule = class GraphqlModule {
|
|
15
40
|
};
|
|
16
41
|
exports.GraphqlModule = GraphqlModule = __decorate([
|
|
@@ -19,9 +44,13 @@ exports.GraphqlModule = GraphqlModule = __decorate([
|
|
|
19
44
|
graphql_1.GraphQLModule.forRoot({
|
|
20
45
|
driver: apollo_1.ApolloDriver,
|
|
21
46
|
context: ({ req, res }) => ({ req, res }),
|
|
22
|
-
|
|
47
|
+
// Build the schema in memory (code-first). Nothing consumes the SDL
|
|
48
|
+
// file, and an in-memory schema avoids depending on a writable
|
|
49
|
+
// `src/generated/` path at boot (CI, read-only deploys, tests).
|
|
50
|
+
autoSchemaFile: true,
|
|
23
51
|
sortSchema: true,
|
|
24
52
|
}),
|
|
25
53
|
],
|
|
54
|
+
providers: [AppxCoreRootResolver],
|
|
26
55
|
})
|
|
27
56
|
], GraphqlModule);
|
package/docs/graphql.md
CHANGED
|
@@ -1,72 +1,134 @@
|
|
|
1
1
|
# GraphQL (read API)
|
|
2
2
|
|
|
3
|
-
AppX Core
|
|
3
|
+
AppX Core exposes a **read-only GraphQL API** generated from your Prisma schema. Every query runs through the same ABAC proxy as REST, so row-level filtering, field omission, and nested-relation filtering all apply automatically — a caller only ever receives rows and fields their role is permitted to read.
|
|
4
4
|
|
|
5
|
-
> **Scope:**
|
|
5
|
+
> **Scope:** **read only** — `find`, `get`, `count`. Writes (create/update/delete) are **not** exposed; use the REST CRUD endpoints. See [limitations.md](./limitations.md).
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## The endpoint
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
The GraphQL server is mounted at **`POST /graphql`** (Apollo; open `GET /graphql` in a browser for the Apollo Sandbox). New projects (`appx-core create`) get it wired in `app.module` by default. To add it to an existing project, register the module once:
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
13
|
+
```ts
|
|
14
|
+
import { GraphqlModule } from '@appxdigital/appx-core';
|
|
15
|
+
|
|
16
|
+
@Module({ imports: [ /* … */ GraphqlModule ] })
|
|
17
|
+
export class AppModule {}
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
The server is always valid even before any model is exposed (it ships a trivial `_appxCore` root field), so `/graphql` is live from the start.
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Exposing a model (opt-in, per module — one line)
|
|
25
|
+
|
|
26
|
+
GraphQL is **off per model** until you opt in. Every generated module ships a commented, copy-paste-ready opt-in; enabling a model is one import + one provider line, with **no resolver file to write or maintain**:
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import { Module } from '@nestjs/common';
|
|
30
|
+
import { PrismaModule } from '../../prisma/prisma.module';
|
|
31
|
+
import { AlbumController } from './album.controller';
|
|
32
|
+
import { AlbumService } from './album.service';
|
|
33
|
+
import { CoreGraphqlResolver } from '@appxdigital/appx-core';
|
|
34
|
+
import { AlbumGraphql } from '../../generated/album/graphql'; // generated by `appx-core generate`
|
|
35
|
+
|
|
36
|
+
@Module({
|
|
37
|
+
imports: [PrismaModule],
|
|
38
|
+
controllers: [AlbumController],
|
|
39
|
+
providers: [
|
|
40
|
+
AlbumService,
|
|
41
|
+
CoreGraphqlResolver(AlbumGraphql), // ← add = exposed; remove = not exposed
|
|
42
|
+
],
|
|
43
|
+
})
|
|
44
|
+
export class AlbumModule {}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
`AlbumGraphql` is a small bundle of generated types emitted by the deploy-safe pass (`appx-core generate`) at `src/generated/album/graphql.ts` — regenerated from the schema, never hand-edited.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## Queries — `find` / `get` / `count`
|
|
52
|
+
|
|
53
|
+
Each exposed model contributes **one root field** (its camelCase name) whose fields are the three read operations. Naming is uniform across every model, so it's predictable:
|
|
54
|
+
|
|
55
|
+
| Field | Prisma | Returns |
|
|
56
|
+
|---|---|---|
|
|
57
|
+
| `find(where, orderBy, take, skip, …)` | `findMany` | a list |
|
|
58
|
+
| `get(where, …)` | `findFirst` | a single record, or `null` |
|
|
59
|
+
| `count(where)` | `count` | `Int` |
|
|
18
60
|
|
|
19
61
|
```graphql
|
|
20
62
|
query {
|
|
21
|
-
|
|
22
|
-
id
|
|
23
|
-
|
|
63
|
+
album {
|
|
64
|
+
find(where: { year: { equals: 2024 } }, take: 20) { id title }
|
|
65
|
+
get(where: { id: { equals: 1 } }) { id title }
|
|
66
|
+
count(where: { year: { equals: 2024 } })
|
|
24
67
|
}
|
|
25
68
|
}
|
|
26
69
|
```
|
|
27
70
|
|
|
28
|
-
|
|
71
|
+
Because `find`/`get`/`count` live on the per-model namespace (not the root), the names repeat freely across models and never collide.
|
|
29
72
|
|
|
30
|
-
|
|
73
|
+
### Multiple things in one request + aliases
|
|
31
74
|
|
|
32
|
-
|
|
75
|
+
A single query can select many models at once, and aliases let you repeat an operation with different arguments — all in one round-trip:
|
|
33
76
|
|
|
34
|
-
|
|
77
|
+
```graphql
|
|
78
|
+
query {
|
|
79
|
+
album {
|
|
80
|
+
recent: find(where: { year: { equals: 2024 } }) { id title }
|
|
81
|
+
classics: find(where: { year: { lt: 1990 } }) { id title }
|
|
82
|
+
total: count
|
|
83
|
+
}
|
|
84
|
+
artist { get(where: { id: { equals: 7 } }) { name } }
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Each selected field resolves independently through the proxy (its own authorized query), so multiplexing never weakens enforcement. `count` is filtered too — it counts only the rows the caller may read, never the table total.
|
|
89
|
+
|
|
90
|
+
### Nested relations & children
|
|
91
|
+
|
|
92
|
+
Select related models inline, to any depth. The GraphQL selection is compiled into a single Prisma `select`, so relations come back in the same authorized query (no N+1):
|
|
35
93
|
|
|
36
94
|
```graphql
|
|
37
95
|
query {
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
name
|
|
41
|
-
tasks {
|
|
96
|
+
album {
|
|
97
|
+
find {
|
|
42
98
|
title
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
}
|
|
99
|
+
tracks { title } # to-many child
|
|
100
|
+
artist { name } # to-one relation
|
|
46
101
|
}
|
|
47
102
|
}
|
|
48
103
|
}
|
|
49
104
|
```
|
|
50
105
|
|
|
51
|
-
|
|
106
|
+
---
|
|
52
107
|
|
|
53
|
-
|
|
54
|
-
> - a **to-many** relation (`tasks`, `members`, …) returns an **empty list** for the parts the user can't see;
|
|
55
|
-
> - an **inaccessible to-one** relation causes the **parent row to be omitted** from the result (you can't see a row whose related record you aren't allowed to read).
|
|
56
|
-
>
|
|
57
|
-
> No exception is thrown — the data you're not entitled to just isn't there. Design your queries and UI to treat "empty" as "not visible to you", not "does not exist".
|
|
108
|
+
## What the caller can and cannot see (ABAC)
|
|
58
109
|
|
|
59
|
-
|
|
110
|
+
All three operations route through `PrismaService.getModelDelegate`, so the rules in `permissions.config.ts` apply exactly as they do for REST reads (see [permissions.md](./permissions.md)). Concretely:
|
|
60
111
|
|
|
61
|
-
|
|
112
|
+
- **Unauthorized rows are not returned.** `find` returns only rows the role may read; `get` returns `null` for a row the caller can't access even if asked for by unique field; `count` counts only accessible rows.
|
|
113
|
+
- **Restricted fields are omitted.** A column the role can't read (`/// @Role(...)`) comes back **`null`** even though the GraphQL type exposes it — at the top level *and* nested. (`prisma-nestjs-graphql` types every scalar; the proxy is what strips the values.)
|
|
114
|
+
- **Inaccessible nested records are filtered.** If a nested relation points at a record the caller can't read, that relation is filtered out — a to-many yields only the visible rows; an inaccessible to-one drops the parent row. You can hold access to a record while a record it links to is withheld.
|
|
115
|
+
- **Anonymous callers are `GUEST`.** With no valid `Authorization: Bearer <jwt>` (or session), the request is a GUEST; a model with no GUEST rule is denied.
|
|
62
116
|
|
|
63
|
-
|
|
117
|
+
> Because relation records and fields are filtered by ABAC, "empty / null" means "not visible to you", not "does not exist". Design queries and UI accordingly.
|
|
118
|
+
|
|
119
|
+
Always let the generated resolver serve the data — a custom resolver that reaches the **raw** Prisma client bypasses ABAC.
|
|
64
120
|
|
|
65
121
|
---
|
|
66
122
|
|
|
67
123
|
## Not available yet
|
|
68
124
|
|
|
69
125
|
- **Mutations** (create/update/delete) — use REST.
|
|
70
|
-
-
|
|
126
|
+
- **Full `aggregate`** (sum/avg/min/max/groupBy) — only `count` is exposed today.
|
|
127
|
+
|
|
128
|
+
> **Security note (before exposing sensitive models widely).** `prisma-nestjs-graphql` generates `where` / `orderBy` inputs that include *every* scalar, ignoring `/// @Role` / `/// @NoWrite`. Field **values** are omitted on output, but a `where`/`orderBy` over a restricted column (e.g. filtering by a password hash prefix) can still act as an oracle. Scrubbing restricted columns from the generated inputs is tracked as a follow-up; until then, avoid exposing models with sensitive filterable columns to untrusted roles.
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## After changing the schema
|
|
71
133
|
|
|
72
|
-
|
|
134
|
+
Re-run `appx-core generate`. It refreshes the Prisma client, GraphQL types, DTO bases, and the per-model `graphql.ts` bundles under `src/generated/**`. Your module opt-in lines are untouched.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@appxdigital/appx-core",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.128-beta.0",
|
|
4
4
|
"description": "Appx Core is a library that provides a set of tools to help you build your application faster.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Scaffold the (read-only) GraphQL resolver file for a single model (once;
|
|
3
|
-
* never overwritten). Imports the prisma-nestjs-graphql artifacts under
|
|
4
|
-
* `src/generated/<folder>/`, so the deploy-safe pass (`prisma generate`) must
|
|
5
|
-
* have produced them first.
|
|
6
|
-
*/
|
|
7
|
-
export declare function scaffoldResolver(modelName: string): void;
|
|
8
|
-
//# sourceMappingURL=generate-resolvers.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"generate-resolvers.d.ts","sourceRoot":"","sources":["../../src/config/generate-resolvers.ts"],"names":[],"mappings":"AA8CA;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAIxD"}
|
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
-
if (mod && mod.__esModule) return mod;
|
|
20
|
-
var result = {};
|
|
21
|
-
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
-
__setModuleDefault(result, mod);
|
|
23
|
-
return result;
|
|
24
|
-
};
|
|
25
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
-
exports.scaffoldResolver = void 0;
|
|
27
|
-
const path = __importStar(require("path"));
|
|
28
|
-
const utils_1 = require("./utils");
|
|
29
|
-
const outputPath = path.join(process.cwd(), 'src/modules');
|
|
30
|
-
/**
|
|
31
|
-
* Generic resolver template for a given model
|
|
32
|
-
* @param model
|
|
33
|
-
* @param folder
|
|
34
|
-
*/
|
|
35
|
-
const genericResolverTemplate = (model, folder) => `import { Resolver } from '@nestjs/graphql';
|
|
36
|
-
import { GenericResolverFactory, PrismaService } from '@appxdigital/appx-core';
|
|
37
|
-
import { ${model} } from '../../generated/${folder}/${folder}.model';
|
|
38
|
-
import { ${model}CreateInput } from '../../generated/${folder}/${folder}-create.input';
|
|
39
|
-
import { ${model}UpdateInput } from '../../generated/${folder}/${folder}-update.input';
|
|
40
|
-
import { ${model}WhereInput } from '../../generated/${folder}/${folder}-where.input';
|
|
41
|
-
import { ${model}WhereUniqueInput } from '../../generated/${folder}/${folder}-where-unique.input';
|
|
42
|
-
import { FindMany${model}Args } from '../../generated/${folder}/find-many-${folder}.args';
|
|
43
|
-
import { ${model}AggregateArgs } from '../../generated/${folder}/${folder}-aggregate.args';
|
|
44
|
-
import { Aggregate${model} } from '../../generated/${folder}/aggregate-${folder}.output';
|
|
45
|
-
import { CreateMany${model}Args } from '../../generated/${folder}/create-many-${folder}.args';
|
|
46
|
-
import { ${model}CreateManyInput } from '../../generated/${folder}/${folder}-create-many.input';
|
|
47
|
-
|
|
48
|
-
const ${model}GenericResolver = GenericResolverFactory(
|
|
49
|
-
'${model}',
|
|
50
|
-
${model},
|
|
51
|
-
${model}CreateInput,
|
|
52
|
-
${model}UpdateInput,
|
|
53
|
-
${model}WhereInput,
|
|
54
|
-
${model}WhereUniqueInput,
|
|
55
|
-
FindMany${model}Args,
|
|
56
|
-
${model}AggregateArgs,
|
|
57
|
-
Aggregate${model},
|
|
58
|
-
CreateMany${model}Args,
|
|
59
|
-
${model}CreateManyInput,
|
|
60
|
-
);
|
|
61
|
-
|
|
62
|
-
@Resolver(() => ${model})
|
|
63
|
-
export class ${model}Resolver extends ${model}GenericResolver {
|
|
64
|
-
constructor(prisma: PrismaService) {
|
|
65
|
-
super(prisma);
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
`;
|
|
69
|
-
/**
|
|
70
|
-
* Scaffold the (read-only) GraphQL resolver file for a single model (once;
|
|
71
|
-
* never overwritten). Imports the prisma-nestjs-graphql artifacts under
|
|
72
|
-
* `src/generated/<folder>/`, so the deploy-safe pass (`prisma generate`) must
|
|
73
|
-
* have produced them first.
|
|
74
|
-
*/
|
|
75
|
-
function scaffoldResolver(modelName) {
|
|
76
|
-
const folder = (0, utils_1.modelFolder)(modelName);
|
|
77
|
-
const resolverPath = path.join(outputPath, folder, `${folder}.resolver.ts`);
|
|
78
|
-
(0, utils_1.createFileIfNotExists)(resolverPath, genericResolverTemplate(modelName, folder));
|
|
79
|
-
}
|
|
80
|
-
exports.scaffoldResolver = scaffoldResolver;
|