@nxgt/janus-graphql 0.1.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/directives/validate.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACN,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,gBAAgB,EAErB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAoB,eAAe,EAAE,MAAM,QAAQ,CAAC;AAGhE,sDAAsD;AACtD,MAAM,WAAW,WAAW;IAC3B,sCAAsC;IACtC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAC3C,uEAAuE;IACvE,QAAQ,CAAC,WAAW,EAAE,SAAS,eAAe,EAAE,CAAC;CACjD;AAED,6FAA6F;AAC7F,MAAM,WAAW,KAAK;IACrB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CAClC;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC5B,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,eAAe,EAC3B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,gBAAgB,GACtB,WAAW,GAAG,IAAI,CAWpB"}

package/dist/directives/words.d.ts

@@ -0,0 +1,7 @@
+/** The phrases the schema-time refusals share. */
+export declare const PREFIX = "applyJanusDirectives()";
+/** `Query.me`, or `Record (read by Record.title)` for a type's directive. */
+export declare function on(where: string, field: string): string;
+/** `'a', 'b'`. */
+export declare function list(names: readonly string[]): string;
+//# sourceMappingURL=words.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"words.d.ts","sourceRoot":"","sources":["../../src/directives/words.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAElD,eAAO,MAAM,MAAM,2BAA2B,CAAC;AAE/C,6EAA6E;AAC7E,wBAAgB,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED,kBAAkB;AAClB,wBAAgB,IAAI,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAErD"}

package/dist/errors.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Every refusal as a `GraphQLError` whose `extensions` carry a `code` and the
+ * HTTP status Yoga answers with: `{ code, http: { status } }`. This package
+ * defines no error class of its own — a denial is a `GraphQLError`, and what
+ * `@nxgt/janus` throws stays its own until `janusMaskError()` reads it.
+ */
+import { JanusError } from '@nxgt/janus';
+import { GraphQLError } from 'graphql';
+/** What a guard answers without asking `@nxgt/janus`: no user, or not this one. */
+export type DenialCode = 'UNAUTHENTICATED' | 'FORBIDDEN' | 'NOT_FOUND';
+/** A denial: `UNAUTHENTICATED` 401, `FORBIDDEN` 403 or `NOT_FOUND` 404. */
+export declare function denial(code: DenialCode, message?: string): GraphQLError;
+/**
+ * A `JanusError` as the client may read it: its code and status, and only
+ * what the client can act on — `issues`, `minLength`, `attemptsLeft`. Never
+ * `reason`, `login`, `slot` or a cause: those are for your logs.
+ *
+ * `STORE_FAILED` is `SERVICE_UNAVAILABLE` 503 — **an outage is never a
+ * denial** — and no message of the core's reaches the client.
+ */
+export declare function janusGraphQLError(error: JanusError): GraphQLError;
+/**
+ * A rejection handler: a `JanusError` becomes its `GraphQLError`, anything
+ * else goes on as it is. `.then(undefined, rethrown)`.
+ */
+export declare function rethrown(error: unknown): never;
+/** Yoga's and envelop's `maskError` signature. */
+export type MaskError = (error: unknown, message: string, isDev?: boolean) => Error;
+/**
+ * Yoga's `maskedErrors.maskError`: a `JanusError` a resolver let through is
+ * answered with its code and status — `STORE_FAILED` as 503, never masked
+ * into a 500 and never a denial — and every other error goes to `fallback`.
+ *
+ * Without a `fallback`, a `GraphQLError` is kept and anything else becomes
+ * `message`, with no detail. Pass Yoga's own `maskError` to keep its
+ * development-mode details:
+ *
+ * ```ts
+ * import { createYoga, maskError } from 'graphql-yoga';
+ * createYoga({ schema, plugins, maskedErrors: { maskError: janusMaskError(maskError) } });
+ * ```
+ */
+export declare function janusMaskError(fallback?: MaskError): MaskError;
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,UAAU,EAAmC,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,mFAAmF;AACnF,MAAM,MAAM,UAAU,GAAG,iBAAiB,GAAG,WAAW,GAAG,WAAW,CAAC;AAEvE,2EAA2E;AAC3E,wBAAgB,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,CAKvE;AAaD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,YAAY,CAQjE;AA4CD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAE9C;AAED,kDAAkD;AAClD,MAAM,MAAM,SAAS,GAAG,CACvB,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,OAAO,KACX,KAAK,CAAC;AAEX;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,QAAQ,GAAE,SAAkB,GAAG,SAAS,CAiBtE"}

package/dist/helpers.d.ts

@@ -0,0 +1,56 @@
+/**
+ * The two calls a resolver makes itself: `requireUser` where a directive
+ * would not do, and `can` for a check the schema cannot express.
+ */
+import type { CheckArgs, CheckableOf, ModelConfig, ObjectRef, ObjectTypeOf, Permissions } from '@nxgt/janus/permissions';
+/** What `requireUser()` takes. */
+export interface RequireUserOptions<T extends string> {
+    /**
+     * Only a user of this type, or of one of these — never an empty list,
+     * which no user could pass: any other is `FORBIDDEN`.
+     */
+    readonly type?: T | readonly [T, ...T[]];
+}
+/**
+ * The signed-in user, narrowed to `type` when it is given — or a denial:
+ * `UNAUTHENTICATED` 401 for an anonymous request, `FORBIDDEN` 403 for a user
+ * of another type. A store that cannot answer is `SERVICE_UNAVAILABLE` 503,
+ * never either of them.
+ *
+ * ```ts
+ * const staff = await requireUser(ctx, { type: 'staff' });
+ * staff.username; // typed: a staff member
+ * ```
+ */
+export declare function requireUser<U extends {
+    readonly type: string;
+}, const T extends U['type'] = U['type']>(ctx: {
+    readonly janus: {
+        user(): Promise<U | null>;
+    };
+}, options?: RequireUserOptions<T>): Promise<Extract<U, {
+    readonly type: T;
+}>>;
+/**
+ * Whether the request's user holds `permission` on `object`, typed as
+ * `access.can` is: the permission must be one the object's type declares,
+ * the object must carry every field its `fromField`s read, and `{ ctx }` is
+ * required exactly when a condition is reachable. Anonymous answers `false`.
+ *
+ * **A failure throws**: a store that cannot answer is `SERVICE_UNAVAILABLE`
+ * 503, never `false`.
+ *
+ * ```ts
+ * if (!(await can(ctx, 'edit', { type: 'record', ...record }))) return null;
+ * ```
+ */
+export declare function can<C extends ModelConfig, const T extends ObjectTypeOf<C>, const P extends CheckableOf<C, T>>(ctx: {
+    readonly janus: {
+        user(): Promise<{
+            readonly type: string;
+            readonly id: string;
+        } | null>;
+        readonly access: Pick<Permissions<C>, 'can'>;
+    };
+}, permission: P, object: ObjectRef<C, T>, ...options: CheckArgs<C, T, P>): Promise<boolean>;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,SAAS,EACT,WAAW,EACX,WAAW,EACX,SAAS,EACT,YAAY,EACZ,WAAW,EACX,MAAM,yBAAyB,CAAC;AAIjC,kCAAkC;AAClC,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,MAAM;IACnD;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;CACzC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,WAAW,CAChC,CAAC,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EACnC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,EAErC,GAAG,EAAE;IAAE,QAAQ,CAAC,KAAK,EAAE;QAAE,IAAI,IAAI,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;KAAE,CAAA;CAAE,EACtD,OAAO,GAAE,kBAAkB,CAAC,CAAC,CAAM,GACjC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC,CAiB3C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,GAAG,CACxB,CAAC,SAAS,WAAW,EACrB,KAAK,CAAC,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EAC/B,KAAK,CAAC,CAAC,SAAS,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EAEjC,GAAG,EAAE;IACJ,QAAQ,CAAC,KAAK,EAAE;QACf,IAAI,IAAI,OAAO,CAAC;YAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;YAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC,CAAC;QACvE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;KAC7C,CAAC;CACF,EACD,UAAU,EAAE,CAAC,EACb,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EACvB,GAAG,OAAO,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAC5B,OAAO,CAAC,OAAO,CAAC,CAalB"}

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * `@nxgt/janus-graphql` — `@nxgt/janus` in a GraphQL server.
+ *
+ * - `useJanus({ auth, access?, type?, loaders?, conditions? })` — the
+ *   envelop plugin: `ctx.janus` on every request, and the directives —
+ *   `@authenticated`, `@permission` — applied to the schema;
+ * - `janusTypeDefs` — the directives' SDL, also shipped as
+ *   `graphql/janus.graphqls`;
+ * - `applyJanusDirectives(schema, { auth })` — the schema transform alone;
+ * - `requireUser(ctx, { type? })` and `can(ctx, permission, object)` — the
+ *   calls a resolver makes itself;
+ * - `janusMaskError(fallback?)` — Yoga's `maskError`: a `JanusError` as its
+ *   code and status, `STORE_FAILED` as 503 and never as 401 or 403.
+ * - `janusGraphQLError(error)` — a `JanusError` as the `GraphQLError` the
+ *   client reads, and `denial(code, message?)` — a denial of your own.
+ *
+ * It defines no error class: a denial is a `GraphQLError`, and what it lets
+ * through is `@nxgt/janus`'s own.
+ */
+export { applyJanusDirectives, type JanusDirectivesOptions, } from './directives/apply';
+export { type DenialCode, denial, janusGraphQLError, janusMaskError, type MaskError, } from './errors';
+export { can, type RequireUserOptions, requireUser } from './helpers';
+export { useJanus } from './plugin';
+export { janusTypeDefs } from './sdl';
+export type { Auth, JanusContext, JanusOnContext, JanusOptions, UserOfAuth, } from './types';
+export type { Conditions, LoadedObject, Loaders } from './wiring';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EACN,oBAAoB,EACpB,KAAK,sBAAsB,GAC3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,KAAK,UAAU,EACf,MAAM,EACN,iBAAiB,EACjB,cAAc,EACd,KAAK,SAAS,GACd,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,GAAG,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,YAAY,EACX,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,UAAU,GACV,MAAM,SAAS,CAAC;AACjB,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC"}