@softistx/janus-graphql 0.32.1 → 0.33.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/dist/plugin.d.ts CHANGED
@@ -50,7 +50,7 @@ import type { Auth, JanusContext, JanusOptions, UserOfAuth } from './types';
50
50
  export declare function useJanus<A extends Auth<{
51
51
  readonly type: string;
52
52
  readonly id: string;
53
- }>, P extends object | undefined = undefined, const T extends UserOfAuth<A>['type'] = UserOfAuth<A>['type'], const K extends boolean = false>(options: JanusOptions<A, P, T, K>): Plugin<JanusContext<A, P, T, K>> & {
53
+ }>, P extends object | undefined = undefined, const T extends UserOfAuth<A>['type'] = UserOfAuth<A>['type'], const K extends boolean | 'service' = false>(options: JanusOptions<A, P, T, K>): Plugin<JanusContext<A, P, T, K>> & {
54
54
  readonly onResponse: (payload: {
55
55
  readonly request: Request;
56
56
  readonly response: Response;
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAQ5C,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,QAAQ,CACvB,CAAC,SAAS,IAAI,CAAC;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC,EAC9D,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAC7D,KAAK,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EAE/B,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAC/B,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG;IACrC,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE;QAC9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;QAC1B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;KAC5B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CA4CA"}
1
+ {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAQ5C,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,QAAQ,CACvB,CAAC,SAAS,IAAI,CAAC;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC,EAC9D,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAC7D,KAAK,CAAC,CAAC,SAAS,OAAO,GAAG,SAAS,GAAG,KAAK,EAE3C,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAC/B,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG;IACrC,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE;QAC9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;QAC1B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;KAC5B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CA4CA"}
package/dist/types.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * The public types: what `useJanus()` takes, and what it puts on the
3
3
  * GraphQL context. Nothing here runs.
4
4
  */
5
- import type { ApiKey, Clock, Principal, Session, SharedApi } from '@softistx/janus';
5
+ import type { ApiKey, Clock, Principal, ServiceKeyAuthenticated, Session, SharedApi } from '@softistx/janus';
6
6
  import type { PermissionWiringOf } from './wiring';
7
7
  /**
8
8
  * Anything `janus()` answered: the part of it this package calls. `cookie`
@@ -34,7 +34,7 @@ export type AuthSource<A, Ctx = AuthContext> = A | ((ctx: Ctx) => A | null | und
34
34
  * needs beside `access`, typed from its model — see `Loaders` and
35
35
  * `Conditions`.
36
36
  */
37
- export type JanusOptions<A, P, T extends string, K extends boolean = false> = {
37
+ export type JanusOptions<A, P, T extends string, K extends boolean | 'service' = false> = {
38
38
  /**
39
39
  * What `janus()` answered — or a function of the request's context
40
40
  * answering the instance that serves it, to serve several issuers from one
@@ -69,6 +69,12 @@ export type JanusOptions<A, P, T extends string, K extends boolean = false> = {
69
69
  *
70
70
  * With it on, `session()` is `null` for a key, so a resolver that reads
71
71
  * `session()` must expect it; `@fresh` refuses a key.
72
+ *
73
+ * `'service'` does the same and also accepts an object's **service key**
74
+ * (`authenticate(request, { apiKey: true, service: true })`; needs
75
+ * `janus({ apiKeys: { service } })`): `principal()` then may answer
76
+ * `via: 'serviceKey'`, with no user (`user()` is `null`) and its owner in
77
+ * `bound`. Without `'service'` a service key is anonymous.
72
78
  */
73
79
  readonly apiKey?: K;
74
80
  } & PermissionWiringOf<P, {
@@ -83,7 +89,7 @@ export type JanusOptions<A, P, T extends string, K extends boolean = false> = {
83
89
  * time either is asked, and never when neither is: a query that reads no
84
90
  * guarded field costs no store call. Both share that one answer.
85
91
  */
86
- export type JanusOnContext<U, P, K extends boolean = false> = {
92
+ export type JanusOnContext<U, P, K extends boolean | 'service' = false> = {
87
93
  /**
88
94
  * Who the request belongs to, or `null` for an anonymous one. **An outage
89
95
  * is not anonymous**: a store that cannot answer rejects with
@@ -92,7 +98,16 @@ export type JanusOnContext<U, P, K extends boolean = false> = {
92
98
  user(): Promise<U | null>;
93
99
  /** The session the request presented, or `null` for an anonymous one. */
94
100
  session(): Promise<Session | null>;
95
- } & ([K] extends [true] ? {
101
+ } & ([K] extends ['service'] ? {
102
+ /**
103
+ * Whoever the request belongs to — a session, a user's key or a
104
+ * service key, narrowed on `via` — or `null` for an anonymous one.
105
+ * Shares `user()`'s answer.
106
+ */
107
+ principal(): Promise<Principal<U> | ServiceKeyAuthenticated | null>;
108
+ /** The key the request presented, a service key's included, or `null`. */
109
+ apiKey(): Promise<ApiKey | null>;
110
+ } : [K] extends [true] ? {
96
111
  /**
97
112
  * Whoever the request belongs to — a session or an API key, narrowed
98
113
  * on `via` — or `null` for an anonymous one. Shares `user()`'s answer.
@@ -109,7 +124,7 @@ export type JanusOnContext<U, P, K extends boolean = false> = {
109
124
  *
110
125
  * `T` narrows the user to the types `useJanus({ type })` was given.
111
126
  */
112
- export type JanusContext<A, P = undefined, T extends UserOfAuth<A>['type'] = UserOfAuth<A>['type'], K extends boolean = false> = {
127
+ export type JanusContext<A, P = undefined, T extends UserOfAuth<A>['type'] = UserOfAuth<A>['type'], K extends boolean | 'service' = false> = {
113
128
  readonly janus: JanusOnContext<Extract<UserOfAuth<A>, {
114
129
  readonly type: T;
115
130
  }>, P, K>;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,MAAM,EACN,KAAK,EACL,SAAS,EACT,OAAO,EACP,SAAS,EACT,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEnD;;;;GAIG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,IAAI,IAAI,CAC3D,SAAS,CAAC,CAAC,CAAC,EACZ,cAAc,GAAG,OAAO,CACxB,GACA,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEvC,8EAA8E;AAC9E,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,QAAQ,CAClE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACvB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,GAAG,GAAG,WAAW,IACxC,CAAC,GACD,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,OAAO,GAAG,KAAK,IAAI;IAC7E;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAC7B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;IAClD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACpB,8EAA8E;IAC9E,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB;;;;;;;;OAQG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;CACpB,GAAG,kBAAkB,CACrB,CAAC,EACD;IACC,QAAQ,CAAC,KAAK,EAAE,cAAc,CAC7B,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,EAC5C,CAAC,EACD,CAAC,CACD,CAAC;CACF,CACD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,OAAO,GAAG,KAAK,IAAI;IAC7D;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1B,yEAAyE;IACzE,OAAO,IAAI,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;CACnC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACpB;IACA;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,wEAAwE;IACxE,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACjC,GACA,OAAO,CAAC,GACV,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,OAAO,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CACvB,CAAC,EACD,CAAC,GAAG,SAAS,EACb,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EACvD,CAAC,SAAS,OAAO,GAAG,KAAK,IACtB;IACH,QAAQ,CAAC,KAAK,EAAE,cAAc,CAC7B,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,EAC5C,CAAC,EACD,CAAC,CACD,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,MAAM,EACN,KAAK,EACL,SAAS,EACT,uBAAuB,EACvB,OAAO,EACP,SAAS,EACT,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEnD;;;;GAIG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,IAAI,IAAI,CAC3D,SAAS,CAAC,CAAC,CAAC,EACZ,cAAc,GAAG,OAAO,CACxB,GACA,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEvC,8EAA8E;AAC9E,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,QAAQ,CAClE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACvB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,GAAG,GAAG,WAAW,IACxC,CAAC,GACD,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,YAAY,CACvB,CAAC,EACD,CAAC,EACD,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,OAAO,GAAG,SAAS,GAAG,KAAK,IAClC;IACH;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAC7B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;IAClD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACpB,8EAA8E;IAC9E,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;CACpB,GAAG,kBAAkB,CACrB,CAAC,EACD;IACC,QAAQ,CAAC,KAAK,EAAE,cAAc,CAC7B,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,EAC5C,CAAC,EACD,CAAC,CACD,CAAC;CACF,CACD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,OAAO,GAAG,SAAS,GAAG,KAAK,IAAI;IACzE;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1B,yEAAyE;IACzE,OAAO,IAAI,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;CACnC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,GACzB;IACA;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,uBAAuB,GAAG,IAAI,CAAC,CAAC;IACpE,0EAA0E;IAC1E,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACjC,GACA,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GACjB;IACA;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,wEAAwE;IACxE,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACjC,GACA,OAAO,CAAC,GACX,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,OAAO,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CACvB,CAAC,EACD,CAAC,GAAG,SAAS,EACb,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EACvD,CAAC,SAAS,OAAO,GAAG,SAAS,GAAG,KAAK,IAClC;IACH,QAAQ,CAAC,KAAK,EAAE,cAAc,CAC7B,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,EAC5C,CAAC,EACD,CAAC,CACD,CAAC;CACF,CAAC"}
@@ -179,6 +179,8 @@ const yoga = createYoga({
179
179
 
180
180
  ## API keys: `useJanus({ apiKey: true })`
181
181
 
182
+ > **Service keys.** `useJanus({ apiKey: 'service' })` also accepts an object's service key (`janus({ apiKeys: { service } })`): `principal()` may then answer `via: 'serviceKey'` with `user: null`, `scopes` and the owner in `bound`; `user()` is `null`, `session()` is `null`, `apiKey()` answers its key, and the guard directives (`@authenticated`, `@fresh`, `@permission`) answer `FORBIDDEN` (403, `extensions.reason: "serviceKey"`), since they need a user: a service key's resolvers read `principal()`. With `useJanus({ type, apiKey: 'service' })` a service key is anonymous: `type` narrows the server to users of that type. Without `'service'` a service key is anonymous. See [Service keys](https://github.com/softistx/nxgt-janus/blob/develop/packages/janus/docs/guide/api-keys.md#service-keys).
183
+
182
184
  Opt-in, and off by default. A key is read from `Authorization: Bearer` only, never from the cookie or `X-Session-Token`. With `janus({ apiKeys })` wired on `auth`, pass
183
185
  `apiKey: true` and a request that presents a key (`Authorization: Bearer
184
186
  sl_…`) is accepted as its owner:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@softistx/janus-graphql",
3
- "version": "0.32.1",
3
+ "version": "0.33.0",
4
4
  "description": "GraphQL for @softistx/janus: an envelop plugin with the signed-in user on the context, fields guarded by @authenticated, @fresh and @permission, and every error with the status it deserves",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -56,7 +56,7 @@
56
56
  "devDependencies": {
57
57
  "@envelop/core": "^6.0.1",
58
58
  "@graphql-tools/utils": "^13.2.2",
59
- "@softistx/janus": "^0.77.0",
59
+ "@softistx/janus": "^0.78.0",
60
60
  "@types/bun": "^1.4.4",
61
61
  "@types/ws": "^8.18.2",
62
62
  "graphql": "^17.1.0",
@@ -68,7 +68,7 @@
68
68
  "peerDependencies": {
69
69
  "@envelop/core": "^5.0.0 || ^6.0.0",
70
70
  "@graphql-tools/utils": ">=10.0.0 <14",
71
- "@softistx/janus": "^0.77.0",
71
+ "@softistx/janus": "^0.78.0",
72
72
  "graphql": "^16.9.0 || ^17.0.0",
73
73
  "graphql-ws": "^6.0.0",
74
74
  "typescript": "^6.0.3 || ^7.0.0"