@nxgt/shared-graphql 2.0.1 → 3.0.0

package/package.json

@@ -1,12 +1,13 @@
 {
 	"name": "@nxgt/shared-graphql",
-	"version": "2.0.1",
+	"version": "3.0.0",
 	"license": "MIT",
 	"type": "module",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
 	"files": [
 		"dist",
+		"docs",
 		"graphql",
 		"README.md",
 		"package.json",
@@ -48,22 +49,17 @@
 	"dependencies": {
 		"@apollo/server": "^5.5.1",
 		"@apollo/subgraph": "^2.14.3",
-		"@envelop/extended-validation": "^7.1.1",
-		"@envelop/generic-auth": "^11.1.1",
-		"@graphql-hive/gateway": "^2.11.2",
 		"@graphql-tools/load-files": "^7.0.1",
 		"@graphql-tools/merge": "^9.2.3",
 		"@graphql-tools/utils": "^12.0.0",
 		"@graphql-yoga/redis-event-target": "^3.0.3",
-		"@hono/zod-validator": "^0.9.0",
-		"@nxgt/i18n": "^1.0.4",
-		"@nxgt/security": "^4.0.0",
-		"@nxgt/shared": "^1.0.4",
+		"@nxgt/i18n": "^1.1.0",
+		"@nxgt/security": "^4.1.0",
+		"@nxgt/shared": "^1.0.5",
 		"@nxgt/shared-exceptions": "^1.0.4",
 		"@nxgt/shared-logging": "^1.0.4",
 		"@nxgt/shared-mongo": "^1.1.4",
 		"dataloader": "^2.2.3",
-		"graphql": "^16.4.2",
 		"graphql-scalars": "^1.26.0",
 		"graphql-subscriptions": "^3.0.0",
 		"graphql-upload": "^18.0.0",
@@ -72,17 +68,19 @@
 		"hono": "^4.13.4",
 		"ioredis": "^6.0.0",
 		"lodash": "^4.18.1",
-		"ws": "^8.21.3",
-		"zod": "^4.4.3"
+		"ws": "^8.21.3"
 	},
 	"devDependencies": {
+		"@graphql-tools/schema": "^10.1.0",
 		"@types/bun": "^1.4.0",
 		"@types/graphql-upload": "^17.0.0",
 		"@types/lodash": "^4.17.25",
-		"@types/ws": "^8.18.1"
+		"@types/ws": "^8.18.1",
+		"graphql": "^16.9.0"
 	},
 	"peerDependencies": {
-		"@nxgt/ory-sdk": ">=0.1.0",
+		"@nxgt/ory-sdk": ">=0.1.0 <1",
+		"graphql": "^16.9.0 || ^17.0.0",
 		"stx-sdk": ">=1.1.0",
 		"typescript": "^6.0.3"
 	}

package/dist/directives/check.d.ts

@@ -1,40 +0,0 @@
-import { getDirective } from '@graphql-tools/utils';
-import { type PermissionRequirement, type PermissionTerm } from '@nxgt/ory-sdk';
-import type { GraphQLSchema } from 'graphql';
-/**
- * `@check` — the Ory-native counterpart to `@policy`.
- *
- * The declaration itself is SDL, in `graphql/directives/check.graphqls`, so it
- * reaches every consumer of `SHARED_SCHEMA_PATH`. This module only reads it.
- * Keeping the two in one place would mean two copies of the same grammar, and
- * the copy nobody edits is the one that goes wrong.
- */
-export declare const CHECK_DIRECTIVE_NAME = "check";
-export type CheckDenial = 'NOT_FOUND' | 'FORBIDDEN';
-export type CheckArgs = {
-    permissions: PermissionRequirement;
-    onDeny: CheckDenial;
-    /** i18n key; the shared `errors.*` one when the field does not say. */
-    message?: string;
-};
-/**
- * Every `@check` on a field, in declaration order.
- *
- * `@check` is repeatable, so this is a list and the order is load-bearing:
- * `view` then `edit` is what turns a denial into 404 for a stranger and 403
- * for a viewer. `getDirective` reads the arguments against the schema's own
- * definition, which is what applies the `id` and `onDeny` defaults — the AST
- * node carries only what was written.
- */
-export declare function readChecks(schema: GraphQLSchema, node: Parameters<typeof getDirective>[1], where: string): CheckArgs[];
-/**
- * Validated here, when the schema is transformed, and not when a request
- * arrives: a path naming neither root is a wiring mistake, and it should stop
- * the server from booting rather than 500 on the one query nobody tried.
- */
-export declare function assertReadablePath(term: PermissionTerm, where: string): void;
-/** Reads `args.x` / `source.x.y` off a resolver's inputs. */
-export declare function readPath(path: string, source: unknown, args: Record<string, unknown>): unknown;
-/** The ids one term has to clear: one value, or every element of a list. */
-export declare function objectIds(value: unknown): string[];
-//# sourceMappingURL=check.d.ts.map

package/dist/directives/check.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/directives/check.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAEN,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACnB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,UAAU,CAAC;AAE5C,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,WAAW,CAAC;AAEpD,MAAM,MAAM,SAAS,GAAG;IACvB,WAAW,EAAE,qBAAqB,CAAC;IACnC,MAAM,EAAE,WAAW,CAAC;IACpB,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACzB,MAAM,EAAE,aAAa,EACrB,IAAI,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,EACxC,KAAK,EAAE,MAAM,GACX,SAAS,EAAE,CAeb;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,QAMrE;AAED,6DAA6D;AAC7D,wBAAgB,QAAQ,CACvB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,OAAO,EACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC3B,OAAO,CAOT;AAED,4EAA4E;AAC5E,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,EAAE,CAKlD"}

package/dist/utils/errors.utils.d.ts

@@ -1,23 +0,0 @@
-import type { ApolloServerOptions } from '@apollo/server';
-import { type LocaleKey, type TranslationContext } from '@nxgt/i18n';
-import { GraphQLError, type GraphQLErrorOptions } from 'graphql';
-import type { MaskError } from 'graphql-yoga';
-import type { GraphQLBaseContext } from '../types';
-export declare function createGraphQLError(message: string, options?: GraphQLErrorOptions): GraphQLError;
-export declare function createFormatError<K extends LocaleKey, C extends GraphQLBaseContext = GraphQLBaseContext>(translate?: (message: K, context?: TranslationContext) => string, production?: boolean): ApolloServerOptions<C>['formatError'];
-/**
- * Yoga's `maskedErrors.maskError`, taught this repo's exceptions.
- *
- * Yoga masks anything that is not a `GraphQLError` as "Unexpected error." —
- * and `CustomException` extends `Error`, so out of the box a service's
- * `notFound()` or `forbidden()` reaches the client as an opaque 500. This
- * turns one into a `GraphQLError` with the translated message, the
- * exception's `code` in `extensions`, and a matching HTTP status; a Mongoose
- * error goes through `castError` first, as `createFormatError` does for
- * Apollo. `OryUnavailable` (@nxgt/ory-sdk) becomes a 503 `SERVICE_UNAVAILABLE`,
- * never a denial. Everything else is masked exactly as before.
- *
- *     createYoga({ maskedErrors: { maskError: createMaskError(translate) } })
- */
-export declare function createMaskError<K extends LocaleKey>(translate?: (message: K, context?: TranslationContext) => string): MaskError;
-//# sourceMappingURL=errors.utils.d.ts.map

package/dist/utils/errors.utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.utils.d.ts","sourceRoot":"","sources":["../../src/utils/errors.utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAK1D,OAAO,EACN,KAAK,SAAS,EACd,KAAK,kBAAkB,EAEvB,MAAM,YAAY,CAAC;AAIpB,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEnD,wBAAgB,kBAAkB,CACjC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,mBAAmB,GAC3B,YAAY,CAEd;AAED,wBAAgB,iBAAiB,CAChC,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,EAEjD,SAAS,GAAE,CACV,OAAO,EAAE,CAAC,EACV,OAAO,CAAC,EAAE,kBAAkB,KACxB,MAAsB,EAC3B,UAAU,CAAC,EAAE,OAAO,GAClB,mBAAmB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAoDvC;AAYD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,SAAS,EAClD,SAAS,GAAE,CACV,OAAO,EAAE,CAAC,EACV,OAAO,CAAC,EAAE,kBAAkB,KACxB,MAAsB,GACzB,SAAS,CAkDX"}

package/graphql/directives/check.graphqls

@@ -1,86 +0,0 @@
-# The Ory-native counterpart to @policy.
-#
-# @policy asks whether the caller CARRIES an authority. An Ory principal
-# carries none — `toPrincipal` sets `authorities: []` on purpose — because
-# Keto answers per OBJECT: "may this subject `view` `Note:<id>`". @check is how
-# a schema asks that, and `useKetoChecks(ory)` is what answers it.
-#
-# It lives here, in the shipped SDL, rather than in SHARED_TYPE_DEFS, so that
-# every consumer of SHARED_SCHEMA_PATH sees it — the subgraphs built with
-# `buildSubgraphSchema` included, which never load SHARED_TYPE_DEFS.
-
-"""
-One question, with the object left as a path instead of a value.
-"""
-input CheckPermission {
-	"""
-	The Keto namespace, e.g. "Note" — from the stack's OPL document.
-	"""
-	namespace: String!
-
-	"""
-	The permit asked of it, e.g. "view". A plain relation works too; Keto
-	answers `false`, not an error, for a name it does not know.
-	"""
-	permit: String!
-
-	"""
-	Where the object id is read: `args.<path>` or `source.<path>`, dotted paths
-	allowed. A value that turns out to be a LIST requires the permit on every
-	element — that is what a mutation taking `ids: [ID!]!` means.
-	"""
-	id: String = "args.id"
-}
-
-"""
-What a denial looks like from outside.
-"""
-enum CheckDenial {
-	"""
-	The same answer as for an id that never existed, so ids cannot be probed.
-	The default, and the one to keep unless the caller already knows the object
-	is there.
-	"""
-	NOT_FOUND
-
-	"""
-	For a second check on an object the caller can already see: a viewer asked
-	to edit already knows it exists, and "you may not change it" is honest.
-	"""
-	FORBIDDEN
-}
-
-"""
-The permission a field requires, in disjunctive normal form: the OUTER list is
-OR, the INNER list is AND. `[[A, B], [C]]` reads "(A and B) or C" — the same
-shape `@policy(policies: [["ADMIN"]])` uses.
-
-Repeatable, and evaluated in declaration order, each with its own `onDeny`.
-That is how the 404-then-403 ladder is written:
-
-    updateNote(id: ID!, input: UpdateNoteInput!): Note!
-      @check(permissions: [[{ namespace: "Note", permit: "view" }]])
-      @check(permissions: [[{ namespace: "Note", permit: "edit" }]], onDeny: FORBIDDEN)
-
-NOT for a field that answers a LIST the caller is entitled to. "Which notes may
-I see" is not a check, it is a Keto query folded into the database filter
-before the read. A directive there would have to fetch everything and filter
-after, which makes `totalCount` and the cursors lie.
-"""
-directive @check(
-	permissions: [[CheckPermission!]!]!
-	onDeny: CheckDenial! = NOT_FOUND
-
-	"""
-	The i18n key the denial carries, e.g. "notes.errors.not-found". Defaults to
-	`errors.not-found` / `errors.insufficient-permissions`, the shared keys.
-
-	Set it whenever the API's own service layer answers the same refusal with a
-	domain message. Two layers guard these fields — the directive, and the
-	`require<M>Access` the service calls — and if they word the same 404
-	differently, the wording tells a caller WHICH one refused: a generic message
-	means "you may not", a domain one means "it is gone". That is precisely the
-	distinction NOT_FOUND exists to hide.
-	"""
-	message: String
-) repeatable on FIELD_DEFINITION