viyv-db-auth 0.1.0 → 0.2.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/index.d.ts CHANGED
@@ -1,5 +1,7 @@
1
1
  export { FileCredentialStore } from './credential-store.js';
2
2
  export { DeviceCodeAuth } from './device-code-auth.js';
3
+ export { JwtAuthProvider } from './jwt-auth.js';
4
+ export type { JwtAuthConfig } from './jwt-auth.js';
3
5
  export { getValidToken, isTokenExpired, refreshTokens } from './token-refresh.js';
4
6
  export type { ICredentialStore, StoredCredentials, TokenSet, UserInfo, DeviceCodeResponse, TokenResponse, UserInfoResponse, } from './types.js';
5
7
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAClF,YAAY,EACX,gBAAgB,EAChB,iBAAiB,EACjB,QAAQ,EACR,QAAQ,EACR,kBAAkB,EAClB,aAAa,EACb,gBAAgB,GAChB,MAAM,YAAY,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAClF,YAAY,EACX,gBAAgB,EAChB,iBAAiB,EACjB,QAAQ,EACR,QAAQ,EACR,kBAAkB,EAClB,aAAa,EACb,gBAAgB,GAChB,MAAM,YAAY,CAAC"}
package/dist/index.js CHANGED
@@ -1,4 +1,5 @@
1
1
  export { FileCredentialStore } from './credential-store.js';
2
2
  export { DeviceCodeAuth } from './device-code-auth.js';
3
+ export { JwtAuthProvider } from './jwt-auth.js';
3
4
  export { getValidToken, isTokenExpired, refreshTokens } from './token-refresh.js';
4
5
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC"}
@@ -0,0 +1,33 @@
1
+ /**
2
+ * JWT-based IAuthProvider implementation using jose library.
3
+ * Supports both JWKS URL (asymmetric, production) and symmetric secret (testing).
4
+ */
5
+ import type { AuthContext, AuthCredentials, IAuthProvider } from 'viyv-db-core';
6
+ export interface JwtAuthConfig {
7
+ /** JWKS endpoint URL for asymmetric key verification (RS256 etc.) */
8
+ jwksUrl?: string;
9
+ /** Symmetric secret for HS256 (testing / simple setups) */
10
+ secret?: string;
11
+ /** Expected issuer (iss claim) */
12
+ issuer?: string;
13
+ /** Expected audience (aud claim) */
14
+ audience?: string;
15
+ /** JWT claim → AuthContext field mapping */
16
+ claimsMapping?: {
17
+ userId?: string;
18
+ orgId?: string;
19
+ teamId?: string;
20
+ roles?: string;
21
+ accessLevel?: string;
22
+ };
23
+ }
24
+ export declare class JwtAuthProvider implements IAuthProvider {
25
+ private readonly config;
26
+ private readonly symmetricKey;
27
+ private readonly jwksGetKey;
28
+ private readonly mapping;
29
+ constructor(config: JwtAuthConfig);
30
+ private verify;
31
+ authenticate(credentials: AuthCredentials): Promise<AuthContext>;
32
+ }
33
+ //# sourceMappingURL=jwt-auth.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"jwt-auth.d.ts","sourceRoot":"","sources":["../src/jwt-auth.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAGhF,MAAM,WAAW,aAAa;IAC7B,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,aAAa,CAAC,EAAE;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACF;AAgBD,qBAAa,eAAgB,YAAW,aAAa;IAKxC,OAAO,CAAC,QAAQ,CAAC,MAAM;IAJnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAoB;IACjD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyB;IACpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwD;gBAEnD,MAAM,EAAE,aAAa;YA0BpC,MAAM;IAcd,YAAY,CAAC,WAAW,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;CAoCtE"}
@@ -0,0 +1,95 @@
1
+ /**
2
+ * JWT-based IAuthProvider implementation using jose library.
3
+ * Supports both JWKS URL (asymmetric, production) and symmetric secret (testing).
4
+ */
5
+ import { createRemoteJWKSet, jwtVerify } from 'jose';
6
+ import { AuthenticationError } from 'viyv-db-core';
7
+ const VALID_ACCESS_LEVELS = new Set(['read', 'data', 'schema']);
8
+ function isValidAccessLevel(value) {
9
+ return typeof value === 'string' && VALID_ACCESS_LEVELS.has(value);
10
+ }
11
+ const DEFAULT_MAPPING = {
12
+ userId: 'sub',
13
+ orgId: 'org_id',
14
+ teamId: 'team_id',
15
+ roles: 'roles',
16
+ accessLevel: 'access_level',
17
+ };
18
+ export class JwtAuthProvider {
19
+ config;
20
+ symmetricKey;
21
+ jwksGetKey;
22
+ mapping;
23
+ constructor(config) {
24
+ this.config = config;
25
+ if (config.jwksUrl && config.secret) {
26
+ throw new Error('JwtAuthConfig: jwksUrl and secret are mutually exclusive');
27
+ }
28
+ if (!config.jwksUrl && !config.secret) {
29
+ throw new Error('JwtAuthConfig: either jwksUrl or secret is required');
30
+ }
31
+ if (config.jwksUrl) {
32
+ this.symmetricKey = null;
33
+ this.jwksGetKey = createRemoteJWKSet(new URL(config.jwksUrl));
34
+ }
35
+ else {
36
+ // config.secret is guaranteed non-null by the validation above
37
+ this.symmetricKey = new TextEncoder().encode(config.secret);
38
+ this.jwksGetKey = null;
39
+ }
40
+ this.mapping = {
41
+ userId: config.claimsMapping?.userId ?? DEFAULT_MAPPING.userId,
42
+ orgId: config.claimsMapping?.orgId ?? DEFAULT_MAPPING.orgId,
43
+ teamId: config.claimsMapping?.teamId ?? DEFAULT_MAPPING.teamId,
44
+ roles: config.claimsMapping?.roles ?? DEFAULT_MAPPING.roles,
45
+ accessLevel: config.claimsMapping?.accessLevel ?? DEFAULT_MAPPING.accessLevel,
46
+ };
47
+ }
48
+ async verify(token) {
49
+ const opts = {
50
+ issuer: this.config.issuer,
51
+ audience: this.config.audience,
52
+ };
53
+ if (this.symmetricKey) {
54
+ const { payload } = await jwtVerify(token, this.symmetricKey, opts);
55
+ return payload;
56
+ }
57
+ // jwksGetKey is guaranteed non-null when symmetricKey is null
58
+ const { payload } = await jwtVerify(token, this.jwksGetKey, opts);
59
+ return payload;
60
+ }
61
+ async authenticate(credentials) {
62
+ if (credentials.type !== 'bearer') {
63
+ throw new AuthenticationError(`Bearer token required, got '${credentials.type}'`);
64
+ }
65
+ try {
66
+ const payload = await this.verify(credentials.token);
67
+ const userId = payload[this.mapping.userId];
68
+ if (typeof userId !== 'string' || !userId) {
69
+ throw new AuthenticationError(`Missing or invalid '${this.mapping.userId}' claim in JWT`);
70
+ }
71
+ return {
72
+ userId,
73
+ orgId: typeof payload[this.mapping.orgId] === 'string'
74
+ ? payload[this.mapping.orgId]
75
+ : undefined,
76
+ teamId: typeof payload[this.mapping.teamId] === 'string'
77
+ ? payload[this.mapping.teamId]
78
+ : undefined,
79
+ roles: Array.isArray(payload[this.mapping.roles])
80
+ ? payload[this.mapping.roles]
81
+ : [],
82
+ accessLevel: isValidAccessLevel(payload[this.mapping.accessLevel])
83
+ ? payload[this.mapping.accessLevel]
84
+ : undefined,
85
+ claims: payload,
86
+ };
87
+ }
88
+ catch (error) {
89
+ if (error instanceof AuthenticationError)
90
+ throw error;
91
+ throw new AuthenticationError(`JWT verification failed: ${error.message}`);
92
+ }
93
+ }
94
+ }
95
+ //# sourceMappingURL=jwt-auth.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"jwt-auth.js","sourceRoot":"","sources":["../src/jwt-auth.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAGrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAqBnD,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEhE,SAAS,kBAAkB,CAAC,KAAc;IACzC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACpE,CAAC;AAED,MAAM,eAAe,GAAG;IACvB,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,SAAS;IACjB,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,cAAc;CAClB,CAAC;AAEX,MAAM,OAAO,eAAe;IAKE;IAJZ,YAAY,CAAoB;IAChC,UAAU,CAAyB;IACnC,OAAO,CAAwD;IAEhF,YAA6B,MAAqB;QAArB,WAAM,GAAN,MAAM,CAAe;QACjD,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAC7E,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;YACzB,IAAI,CAAC,UAAU,GAAG,kBAAkB,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAC/D,CAAC;aAAM,CAAC;YACP,+DAA+D;YAC/D,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAC;YACtE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACxB,CAAC;QAED,IAAI,CAAC,OAAO,GAAG;YACd,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE,MAAM,IAAI,eAAe,CAAC,MAAM;YAC9D,KAAK,EAAE,MAAM,CAAC,aAAa,EAAE,KAAK,IAAI,eAAe,CAAC,KAAK;YAC3D,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE,MAAM,IAAI,eAAe,CAAC,MAAM;YAC9D,KAAK,EAAE,MAAM,CAAC,aAAa,EAAE,KAAK,IAAI,eAAe,CAAC,KAAK;YAC3D,WAAW,EAAE,MAAM,CAAC,aAAa,EAAE,WAAW,IAAI,eAAe,CAAC,WAAW;SAC7E,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,MAAM,CAAC,KAAa;QACjC,MAAM,IAAI,GAAG;YACZ,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YAC1B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;SAC9B,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;YACpE,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,8DAA8D;QAC9D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,UAA6B,EAAE,IAAI,CAAC,CAAC;QACrF,OAAO,OAAO,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,WAA4B;QAC9C,IAAI,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACnC,MAAM,IAAI,mBAAmB,CAAC,+BAA+B,WAAW,CAAC,IAAI,GAAG,CAAC,CAAC;QACnF,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YAErD,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC3C,MAAM,IAAI,mBAAmB,CAAC,uBAAuB,IAAI,CAAC,OAAO,CAAC,MAAM,gBAAgB,CAAC,CAAC;YAC3F,CAAC;YAED,OAAO;gBACN,MAAM;gBACN,KAAK,EACJ,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ;oBAC9C,CAAC,CAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAY;oBACzC,CAAC,CAAC,SAAS;gBACb,MAAM,EACL,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ;oBAC/C,CAAC,CAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAY;oBAC1C,CAAC,CAAC,SAAS;gBACb,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;oBAChD,CAAC,CAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAc;oBAC3C,CAAC,CAAC,EAAE;gBACL,WAAW,EAAE,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;oBACjE,CAAC,CAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAgC;oBACnE,CAAC,CAAC,SAAS;gBACZ,MAAM,EAAE,OAAkC;aAC1C,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,KAAK,YAAY,mBAAmB;gBAAE,MAAM,KAAK,CAAC;YACtD,MAAM,IAAI,mBAAmB,CAAC,4BAA6B,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QACvF,CAAC;IACF,CAAC;CACD"}
package/package.json CHANGED
@@ -1,36 +1,40 @@
1
1
  {
2
- "name": "viyv-db-auth",
3
- "version": "0.1.0",
4
- "type": "module",
5
- "description": "Authentication implementation for viyv-db",
6
- "license": "MIT",
7
- "author": "viyv",
8
- "engines": {
9
- "node": ">=20"
10
- },
11
- "main": "dist/index.js",
12
- "types": "dist/index.d.ts",
13
- "exports": {
14
- ".": {
15
- "types": "./dist/index.d.ts",
16
- "default": "./dist/index.js"
17
- }
18
- },
19
- "files": [
20
- "dist",
21
- "!dist/__tests__"
22
- ],
23
- "dependencies": {
24
- "viyv-db-core": "0.1.0"
25
- },
26
- "devDependencies": {
27
- "typescript": "^5.7.0",
28
- "vitest": "^2.1.0"
29
- },
30
- "scripts": {
31
- "build": "tsc",
32
- "typecheck": "tsc --noEmit",
33
- "test": "vitest run",
34
- "clean": "rm -rf dist"
35
- }
36
- }
2
+ "name": "viyv-db-auth",
3
+ "version": "0.2.0",
4
+ "type": "module",
5
+ "description": "Authentication implementation for viyv-db",
6
+ "license": "MIT",
7
+ "author": "viyv",
8
+ "engines": { "node": ">=20" },
9
+ "main": "dist/index.js",
10
+ "types": "dist/index.d.ts",
11
+ "exports": {
12
+ ".": {
13
+ "development": "./src/index.ts",
14
+ "default": "./dist/index.js"
15
+ }
16
+ },
17
+ "publishConfig": {
18
+ "exports": {
19
+ ".": {
20
+ "types": "./dist/index.d.ts",
21
+ "default": "./dist/index.js"
22
+ }
23
+ }
24
+ },
25
+ "files": ["dist", "!dist/__tests__"],
26
+ "scripts": {
27
+ "build": "tsc",
28
+ "typecheck": "tsc --noEmit",
29
+ "test": "vitest run",
30
+ "clean": "rm -rf dist"
31
+ },
32
+ "dependencies": {
33
+ "jose": "^6.0.0",
34
+ "viyv-db-core": "workspace:*"
35
+ },
36
+ "devDependencies": {
37
+ "typescript": "^5.7.0",
38
+ "vitest": "^2.1.0"
39
+ }
40
+ }
package/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2025 viyv
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.