@japikey/cloudflare 0.1.0 → 0.2.2

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 susu-dot-dev
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.
package/dist/d1.d.ts ADDED
@@ -0,0 +1,22 @@
1
+ import type { ApiKeyRow, DatabaseDriver } from '@japikey/shared';
2
+ import { TRUNCATE_TABLE_ONLY_USE_FOR_UNIT_TESTS } from '@japikey/shared';
3
+ import type { D1Database } from '@cloudflare/workers-types';
4
+ export default class D1Driver implements DatabaseDriver {
5
+ private db;
6
+ private _queries?;
7
+ private tableName;
8
+ constructor(db: D1Database, tableName?: string);
9
+ private getQuery;
10
+ private prepareStatements;
11
+ ensureTable(): Promise<void>;
12
+ insertApiKey(apiKey: ApiKeyRow): Promise<void>;
13
+ getApiKey(kid: string): Promise<ApiKeyRow | null>;
14
+ findApiKeys(user_id: string, limit?: number, offset?: number): Promise<ApiKeyRow[]>;
15
+ revokeApiKey(filter: {
16
+ user_id: string;
17
+ kid: string;
18
+ }): Promise<void>;
19
+ close(): Promise<void>;
20
+ [TRUNCATE_TABLE_ONLY_USE_FOR_UNIT_TESTS](): Promise<void>;
21
+ }
22
+ //# sourceMappingURL=d1.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"d1.d.ts","sourceRoot":"","sources":["../src/d1.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAIL,sCAAsC,EACvC,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EACV,UAAU,EAGX,MAAM,2BAA2B,CAAC;AAyCnC,MAAM,CAAC,OAAO,OAAO,QAAS,YAAW,cAAc;IAKnD,OAAO,CAAC,EAAE;IAJZ,OAAO,CAAC,QAAQ,CAAC,CAAU;IAC3B,OAAO,CAAC,SAAS,CAAS;gBAGhB,EAAE,EAAE,UAAU,EACtB,SAAS,GAAE,MAAmB;IAQhC,OAAO,CAAC,QAAQ;IAShB,OAAO,CAAC,iBAAiB;IAqBnB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAmB5B,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAoB9C,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAgBjD,WAAW,CACf,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,SAAS,EAAE,CAAC;IAajB,YAAY,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAWrE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAEtB,CAAC,sCAAsC,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAGhE"}
package/dist/d1.js ADDED
@@ -0,0 +1,143 @@
1
+ import { IncorrectUsageError, DatabaseError, InvalidInputError, TRUNCATE_TABLE_ONLY_USE_FOR_UNIT_TESTS, } from '@japikey/shared';
2
+ function toSqlite(apiKey) {
3
+ try {
4
+ return {
5
+ kid: apiKey.kid,
6
+ user_id: apiKey.user_id,
7
+ revoked: apiKey.revoked ? 1 : 0,
8
+ jwk: JSON.stringify(apiKey.jwk),
9
+ metadata: JSON.stringify(apiKey.metadata),
10
+ };
11
+ }
12
+ catch (err) {
13
+ throw new InvalidInputError('Failed to serialize the metadata', {
14
+ cause: err,
15
+ });
16
+ }
17
+ }
18
+ function fromSqlite(result) {
19
+ try {
20
+ return {
21
+ kid: result.kid,
22
+ user_id: result.user_id,
23
+ revoked: result.revoked === 1,
24
+ jwk: JSON.parse(result.jwk),
25
+ metadata: JSON.parse(result.metadata),
26
+ };
27
+ }
28
+ catch (err) {
29
+ throw new DatabaseError('Failed to deserialize an ApiKeyRow', {
30
+ cause: err,
31
+ });
32
+ }
33
+ }
34
+ export default class D1Driver {
35
+ db;
36
+ _queries;
37
+ tableName;
38
+ constructor(db, tableName = 'japikeys') {
39
+ this.db = db;
40
+ if (!/^[a-zA-Z0-9_]+$/.test(tableName)) {
41
+ throw new IncorrectUsageError('Invalid table name');
42
+ }
43
+ this.tableName = tableName;
44
+ }
45
+ getQuery(name) {
46
+ if (!this._queries) {
47
+ throw new IncorrectUsageError('Database not initialized. Call ensureTable() first.');
48
+ }
49
+ return this._queries[name];
50
+ }
51
+ prepareStatements() {
52
+ try {
53
+ this._queries = {
54
+ insert: this.db.prepare(`INSERT INTO ${this.tableName} (kid, user_id, revoked, jwk, metadata) VALUES (?1, ?2, ?3, ?4, ?5)`),
55
+ get: this.db.prepare(`SELECT * FROM ${this.tableName} WHERE kid = ?1`),
56
+ find: this.db.prepare(`SELECT * FROM ${this.tableName} WHERE user_id = ?1 LIMIT ?2 OFFSET ?3`),
57
+ revoke: this.db.prepare(`UPDATE ${this.tableName} SET revoked = 1 WHERE user_id = ?1 AND kid = ?2`),
58
+ };
59
+ }
60
+ catch (err) {
61
+ throw new DatabaseError('Failed to generate sql prepared statements', {
62
+ cause: err,
63
+ });
64
+ }
65
+ }
66
+ async ensureTable() {
67
+ try {
68
+ await this.db.exec(`
69
+ CREATE TABLE IF NOT EXISTS ${this.tableName} (
70
+ kid TEXT PRIMARY KEY,
71
+ user_id TEXT NOT NULL,
72
+ revoked INTEGER NOT NULL,
73
+ jwk TEXT NOT NULL,
74
+ metadata TEXT NOT NULL
75
+ )
76
+ `);
77
+ }
78
+ catch (err) {
79
+ throw new DatabaseError('Failed to create the table', {
80
+ cause: err,
81
+ });
82
+ }
83
+ this.prepareStatements();
84
+ }
85
+ async insertApiKey(apiKey) {
86
+ const params = toSqlite(apiKey);
87
+ const query = this.getQuery('insert');
88
+ try {
89
+ await query
90
+ .bind(params.kid, params.user_id, params.revoked, params.jwk, params.metadata)
91
+ .run();
92
+ }
93
+ catch (err) {
94
+ throw new DatabaseError('Failed to insert api key', {
95
+ cause: err,
96
+ });
97
+ }
98
+ }
99
+ async getApiKey(kid) {
100
+ let result;
101
+ const query = this.getQuery('get');
102
+ try {
103
+ result = await query.bind(kid).first();
104
+ }
105
+ catch (err) {
106
+ throw new DatabaseError('Failed to query for the api key', {
107
+ cause: err,
108
+ });
109
+ }
110
+ if (!result) {
111
+ return null;
112
+ }
113
+ return fromSqlite(result);
114
+ }
115
+ async findApiKeys(user_id, limit, offset) {
116
+ let response;
117
+ const query = this.getQuery('find');
118
+ try {
119
+ response = await query.bind(user_id, limit ?? -1, offset ?? 0).all();
120
+ }
121
+ catch (err) {
122
+ throw new DatabaseError('Failed to query for the api keys', {
123
+ cause: err,
124
+ });
125
+ }
126
+ return response.results.map(row => fromSqlite(row));
127
+ }
128
+ async revokeApiKey(filter) {
129
+ const query = this.getQuery('revoke');
130
+ try {
131
+ await query.bind(filter.user_id, filter.kid).run();
132
+ }
133
+ catch (err) {
134
+ throw new DatabaseError('Failed to revoke the api key', {
135
+ cause: err,
136
+ });
137
+ }
138
+ }
139
+ async close() { }
140
+ async [TRUNCATE_TABLE_ONLY_USE_FOR_UNIT_TESTS]() {
141
+ await this.db.exec(`DELETE FROM ${this.tableName}`);
142
+ }
143
+ }
@@ -1,12 +1,5 @@
1
1
  import type { CreateApiKeyRouterOptions, CreateApiKeyData } from './router.ts';
2
2
  import { createApiKeyRouter, createJWKSRouter, isJWKSPath } from './router.ts';
3
3
  import D1Driver from './d1.ts';
4
-
5
- export {
6
- createApiKeyRouter,
7
- createJWKSRouter,
8
- isJWKSPath,
9
- D1Driver,
10
- type CreateApiKeyRouterOptions,
11
- type CreateApiKeyData,
12
- };
4
+ export { createApiKeyRouter, createJWKSRouter, isJWKSPath, D1Driver, type CreateApiKeyRouterOptions, type CreateApiKeyData, };
5
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,QAAQ,MAAM,SAAS,CAAC;AAE/B,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,UAAU,EACV,QAAQ,EACR,KAAK,yBAAyB,EAC9B,KAAK,gBAAgB,GACtB,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,3 @@
1
+ import { createApiKeyRouter, createJWKSRouter, isJWKSPath } from "./router.js";
2
+ import D1Driver from "./d1.js";
3
+ export { createApiKeyRouter, createJWKSRouter, isJWKSPath, D1Driver, };
@@ -0,0 +1,19 @@
1
+ import type { DatabaseDriver } from '@japikey/japikey';
2
+ import type { ExportedHandler } from '@cloudflare/workers-types';
3
+ export type CreateApiKeyData = {
4
+ expiresAt: Date;
5
+ claims: Record<string, unknown>;
6
+ databaseMetadata: Record<string, unknown>;
7
+ };
8
+ export type CreateApiKeyRouterOptions<Env> = {
9
+ getUserId: (request: Request, env: Env) => Promise<string>;
10
+ parseCreateApiKeyRequest: (request: Request, env: Env) => Promise<CreateApiKeyData>;
11
+ issuer: URL;
12
+ aud: string;
13
+ db: DatabaseDriver;
14
+ routePrefix: string;
15
+ };
16
+ export declare function createJWKSRouter<Env>(baseIssuer: URL, db: DatabaseDriver): ExportedHandler<Env>;
17
+ export declare function isJWKSPath(request: Request, baseIssuer: URL): boolean;
18
+ export declare function createApiKeyRouter<Env>(options: CreateApiKeyRouterOptions<Env>): ExportedHandler<Env>;
19
+ //# sourceMappingURL=router.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAiB,MAAM,kBAAkB,CAAC;AAGtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAGjE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,EAAE,IAAI,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,yBAAyB,CAAC,GAAG,IAAI;IAC3C,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,wBAAwB,EAAE,CACxB,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,GAAG,KACL,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC/B,MAAM,EAAE,GAAG,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,cAAc,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAwEF,wBAAgB,gBAAgB,CAAC,GAAG,EAClC,UAAU,EAAE,GAAG,EACf,EAAE,EAAE,cAAc,GACjB,eAAe,CAAC,GAAG,CAAC,CAUtB;AAED,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,GAAG,OAAO,CAOrE;AA6HD,wBAAgB,kBAAkB,CAAC,GAAG,EACpC,OAAO,EAAE,yBAAyB,CAAC,GAAG,CAAC,GACtC,eAAe,CAAC,GAAG,CAAC,CAmCtB"}
package/dist/router.js ADDED
@@ -0,0 +1,195 @@
1
+ import { NotFoundError, JapikeyError } from '@japikey/shared';
2
+ import { createApiKey } from '@japikey/japikey';
3
+ import { validate as validateUuid } from 'uuid';
4
+ import { pathToRegexp } from 'path-to-regexp';
5
+ function wrapError(fn) {
6
+ return async (...args) => {
7
+ try {
8
+ return await fn(...args);
9
+ }
10
+ catch (err) {
11
+ if (err instanceof JapikeyError) {
12
+ return new Response(JSON.stringify({
13
+ error: {
14
+ type: err.errorType,
15
+ message: err.message,
16
+ },
17
+ }), {
18
+ status: err.code,
19
+ headers: {
20
+ 'Content-Type': 'application/json',
21
+ },
22
+ });
23
+ }
24
+ throw err;
25
+ }
26
+ };
27
+ }
28
+ async function handleJWKSRequest(kid, db) {
29
+ const row = await db.getApiKey(kid);
30
+ if (!row || row.revoked) {
31
+ throw new NotFoundError('API key not found');
32
+ }
33
+ const jwks = {
34
+ keys: [row.jwk],
35
+ };
36
+ return new Response(JSON.stringify(jwks), {
37
+ headers: {
38
+ 'Content-Type': 'application/json',
39
+ },
40
+ });
41
+ }
42
+ function getWellKnownKid(request, baseIssuer) {
43
+ if (!request.url.startsWith(baseIssuer.toString())) {
44
+ throw new NotFoundError('Invalid JWKS request');
45
+ }
46
+ let partialPath = request.url.slice(baseIssuer.toString().length);
47
+ if (!partialPath.startsWith('/')) {
48
+ partialPath = `/${partialPath}`;
49
+ }
50
+ const parts = partialPath.split('/');
51
+ if (parts.length !== 4 ||
52
+ parts[0] !== '' ||
53
+ parts[2] !== '.well-known' ||
54
+ parts[3] !== 'jwks.json') {
55
+ throw new NotFoundError('Invalid JWKS request');
56
+ }
57
+ const kid = parts[1];
58
+ if (!kid || !validateUuid(kid)) {
59
+ throw new NotFoundError('Invalid JWKS request');
60
+ }
61
+ return kid;
62
+ }
63
+ export function createJWKSRouter(baseIssuer, db) {
64
+ return {
65
+ fetch: wrapError(async function fetch(request, env) {
66
+ const kid = getWellKnownKid(request, baseIssuer);
67
+ return handleJWKSRequest(kid, db);
68
+ }),
69
+ };
70
+ }
71
+ export function isJWKSPath(request, baseIssuer) {
72
+ try {
73
+ getWellKnownKid(request, baseIssuer);
74
+ return true;
75
+ }
76
+ catch (err) {
77
+ return false;
78
+ }
79
+ }
80
+ function matchPath(request, method, routePrefix, pattern) {
81
+ if (request.method !== method) {
82
+ return { valid: false, params: {} };
83
+ }
84
+ const url = new URL(request.url);
85
+ const pathname = url.pathname;
86
+ const normalizedPrefix = routePrefix === ''
87
+ ? ''
88
+ : routePrefix.startsWith('/')
89
+ ? routePrefix
90
+ : `/${routePrefix}`;
91
+ const fullPattern = `${normalizedPrefix}${pattern}`;
92
+ const regexp = pathToRegexp(fullPattern);
93
+ const match = regexp.regexp.exec(pathname);
94
+ if (!match) {
95
+ return { valid: false, params: {} };
96
+ }
97
+ const params = {};
98
+ regexp.keys.forEach((key, index) => {
99
+ params[key.name] = match[index + 1];
100
+ });
101
+ return { valid: true, params };
102
+ }
103
+ function ensureKid(params) {
104
+ const kid = params.kid ?? params.id;
105
+ if (!kid || typeof kid !== 'string' || !validateUuid(kid)) {
106
+ throw new NotFoundError('Invalid API key ID');
107
+ }
108
+ return kid;
109
+ }
110
+ async function handleCreateApiKeyRequest(request, env, options) {
111
+ const userId = await options.getUserId(request, env);
112
+ const { expiresAt, claims, databaseMetadata } = await options.parseCreateApiKeyRequest(request, env);
113
+ const { jwt, jwk } = await createApiKey(claims, {
114
+ sub: userId,
115
+ iss: options.issuer,
116
+ aud: options.aud,
117
+ expiresAt,
118
+ });
119
+ const kid = jwk.kid;
120
+ await options.db.insertApiKey({
121
+ kid,
122
+ user_id: userId,
123
+ revoked: false,
124
+ jwk,
125
+ metadata: databaseMetadata,
126
+ });
127
+ return new Response(JSON.stringify({ api_key: jwt, kid }), {
128
+ headers: {
129
+ 'Content-Type': 'application/json',
130
+ },
131
+ });
132
+ }
133
+ async function handleListApiKeysRequest(request, env, options) {
134
+ const userId = await options.getUserId(request, env);
135
+ const apiKeys = await options.db.findApiKeys(userId);
136
+ return new Response(JSON.stringify(apiKeys), {
137
+ headers: {
138
+ 'Content-Type': 'application/json',
139
+ },
140
+ });
141
+ }
142
+ async function handleGetApiKeyRequest(request, env, options, keyId) {
143
+ const userId = await options.getUserId(request, env);
144
+ const apiKey = await options.db.getApiKey(keyId);
145
+ if (!apiKey || apiKey.user_id !== userId) {
146
+ throw new NotFoundError('API key not found');
147
+ }
148
+ return new Response(JSON.stringify(apiKey), {
149
+ headers: {
150
+ 'Content-Type': 'application/json',
151
+ },
152
+ });
153
+ }
154
+ async function handleRevokeApiKeyRequest(request, env, options, keyId) {
155
+ const userId = await options.getUserId(request, env);
156
+ const apiKey = await options.db.getApiKey(keyId);
157
+ if (!apiKey || apiKey.user_id !== userId) {
158
+ throw new NotFoundError('API key not found');
159
+ }
160
+ await options.db.revokeApiKey({ user_id: userId, kid: keyId });
161
+ return new Response(JSON.stringify({}), {
162
+ headers: {
163
+ 'Content-Type': 'application/json',
164
+ },
165
+ });
166
+ }
167
+ export function createApiKeyRouter(options) {
168
+ return {
169
+ fetch: wrapError(async function fetch(request, env) {
170
+ // POST /api-keys - Create API key
171
+ let matchResult = matchPath(request, 'POST', options.routePrefix, '');
172
+ if (matchResult.valid) {
173
+ return handleCreateApiKeyRequest(request, env, options);
174
+ }
175
+ // GET /api-keys/my - List user's API keys
176
+ matchResult = matchPath(request, 'GET', options.routePrefix, '/my');
177
+ if (matchResult.valid) {
178
+ return handleListApiKeysRequest(request, env, options);
179
+ }
180
+ // GET /api-keys/:id - Get specific API key
181
+ matchResult = matchPath(request, 'GET', options.routePrefix, '/:id');
182
+ if (matchResult.valid) {
183
+ const keyId = ensureKid(matchResult.params);
184
+ return handleGetApiKeyRequest(request, env, options, keyId);
185
+ }
186
+ // DELETE /api-keys/:id - Revoke API key
187
+ matchResult = matchPath(request, 'DELETE', options.routePrefix, '/:id');
188
+ if (matchResult.valid) {
189
+ const keyId = ensureKid(matchResult.params);
190
+ return handleRevokeApiKeyRequest(request, env, options, keyId);
191
+ }
192
+ throw new NotFoundError('Route not found');
193
+ }),
194
+ };
195
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@japikey/cloudflare",
3
- "version": "0.1.0",
3
+ "version": "0.2.2",
4
4
  "description": "Cloudflare worker-based endpoints for japikey",
5
5
  "engines": {
6
6
  "node": ">=22.5.0"
@@ -28,6 +28,11 @@
28
28
  "types": "./dist/index.d.ts"
29
29
  }
30
30
  },
31
+ "files": [
32
+ "dist",
33
+ "README.md",
34
+ "LICENSE"
35
+ ],
31
36
  "scripts": {
32
37
  "test": "vitest",
33
38
  "test:coverage": "vitest --coverage",
@@ -39,7 +44,7 @@
39
44
  "format:check": "prettier --check src/**/*.ts"
40
45
  },
41
46
  "dependencies": {
42
- "@japikey/japikey": "0.1.0",
47
+ "@japikey/japikey": "0.2.2",
43
48
  "path-to-regexp": "^8.2.0"
44
49
  },
45
50
  "devDependencies": {
package/eslint.config.js DELETED
@@ -1,3 +0,0 @@
1
- import { browserConfig } from '../../eslint.config.js';
2
-
3
- export default browserConfig;
package/src/d1.ts DELETED
@@ -1,185 +0,0 @@
1
- import type { ApiKeyRow, DatabaseDriver } from '@japikey/shared';
2
- import {
3
- IncorrectUsageError,
4
- DatabaseError,
5
- InvalidInputError,
6
- TRUNCATE_TABLE_ONLY_USE_FOR_UNIT_TESTS,
7
- } from '@japikey/shared';
8
- import type {
9
- D1Database,
10
- D1PreparedStatement,
11
- D1Result,
12
- } from '@cloudflare/workers-types';
13
-
14
- type Queries = {
15
- insert: D1PreparedStatement;
16
- get: D1PreparedStatement;
17
- find: D1PreparedStatement;
18
- revoke: D1PreparedStatement;
19
- };
20
-
21
- function toSqlite(apiKey: ApiKeyRow): Record<keyof ApiKeyRow, unknown> {
22
- try {
23
- return {
24
- kid: apiKey.kid,
25
- user_id: apiKey.user_id,
26
- revoked: apiKey.revoked ? 1 : 0,
27
- jwk: JSON.stringify(apiKey.jwk),
28
- metadata: JSON.stringify(apiKey.metadata),
29
- };
30
- } catch (err) {
31
- throw new InvalidInputError('Failed to serialize the metadata', {
32
- cause: err,
33
- });
34
- }
35
- }
36
-
37
- function fromSqlite(result: Record<keyof ApiKeyRow, unknown>): ApiKeyRow {
38
- try {
39
- return {
40
- kid: result.kid as string,
41
- user_id: result.user_id as string,
42
- revoked: result.revoked === 1,
43
- jwk: JSON.parse(result.jwk as string),
44
- metadata: JSON.parse(result.metadata as string),
45
- };
46
- } catch (err) {
47
- throw new DatabaseError('Failed to deserialize an ApiKeyRow', {
48
- cause: err,
49
- });
50
- }
51
- }
52
-
53
- export default class D1Driver implements DatabaseDriver {
54
- private _queries?: Queries;
55
- private tableName: string;
56
-
57
- constructor(
58
- private db: D1Database,
59
- tableName: string = 'japikeys'
60
- ) {
61
- if (!/^[a-zA-Z0-9_]+$/.test(tableName)) {
62
- throw new IncorrectUsageError('Invalid table name');
63
- }
64
- this.tableName = tableName;
65
- }
66
-
67
- private getQuery(name: keyof Queries): D1PreparedStatement {
68
- if (!this._queries) {
69
- throw new IncorrectUsageError(
70
- 'Database not initialized. Call ensureTable() first.'
71
- );
72
- }
73
- return this._queries[name];
74
- }
75
-
76
- private prepareStatements(): void {
77
- try {
78
- this._queries = {
79
- insert: this.db.prepare(
80
- `INSERT INTO ${this.tableName} (kid, user_id, revoked, jwk, metadata) VALUES (?1, ?2, ?3, ?4, ?5)`
81
- ),
82
- get: this.db.prepare(`SELECT * FROM ${this.tableName} WHERE kid = ?1`),
83
- find: this.db.prepare(
84
- `SELECT * FROM ${this.tableName} WHERE user_id = ?1 LIMIT ?2 OFFSET ?3`
85
- ),
86
- revoke: this.db.prepare(
87
- `UPDATE ${this.tableName} SET revoked = 1 WHERE user_id = ?1 AND kid = ?2`
88
- ),
89
- };
90
- } catch (err) {
91
- throw new DatabaseError('Failed to generate sql prepared statements', {
92
- cause: err,
93
- });
94
- }
95
- }
96
-
97
- async ensureTable(): Promise<void> {
98
- try {
99
- await this.db.exec(`
100
- CREATE TABLE IF NOT EXISTS ${this.tableName} (
101
- kid TEXT PRIMARY KEY,
102
- user_id TEXT NOT NULL,
103
- revoked INTEGER NOT NULL,
104
- jwk TEXT NOT NULL,
105
- metadata TEXT NOT NULL
106
- )
107
- `);
108
- } catch (err) {
109
- throw new DatabaseError('Failed to create the table', {
110
- cause: err,
111
- });
112
- }
113
- this.prepareStatements();
114
- }
115
-
116
- async insertApiKey(apiKey: ApiKeyRow): Promise<void> {
117
- const params = toSqlite(apiKey);
118
- const query = this.getQuery('insert');
119
- try {
120
- await query
121
- .bind(
122
- params.kid,
123
- params.user_id,
124
- params.revoked,
125
- params.jwk,
126
- params.metadata
127
- )
128
- .run();
129
- } catch (err) {
130
- throw new DatabaseError('Failed to insert api key', {
131
- cause: err,
132
- });
133
- }
134
- }
135
-
136
- async getApiKey(kid: string): Promise<ApiKeyRow | null> {
137
- let result: Record<string, unknown> | undefined | null;
138
- const query = this.getQuery('get');
139
- try {
140
- result = await query.bind(kid).first();
141
- } catch (err) {
142
- throw new DatabaseError('Failed to query for the api key', {
143
- cause: err,
144
- });
145
- }
146
- if (!result) {
147
- return null;
148
- }
149
- return fromSqlite(result);
150
- }
151
-
152
- async findApiKeys(
153
- user_id: string,
154
- limit?: number,
155
- offset?: number
156
- ): Promise<ApiKeyRow[]> {
157
- let response: D1Result<Record<string, unknown>>;
158
- const query = this.getQuery('find');
159
- try {
160
- response = await query.bind(user_id, limit ?? -1, offset ?? 0).all();
161
- } catch (err) {
162
- throw new DatabaseError('Failed to query for the api keys', {
163
- cause: err,
164
- });
165
- }
166
- return response.results.map(row => fromSqlite(row));
167
- }
168
-
169
- async revokeApiKey(filter: { user_id: string; kid: string }): Promise<void> {
170
- const query = this.getQuery('revoke');
171
- try {
172
- await query.bind(filter.user_id, filter.kid).run();
173
- } catch (err) {
174
- throw new DatabaseError('Failed to revoke the api key', {
175
- cause: err,
176
- });
177
- }
178
- }
179
-
180
- async close(): Promise<void> {}
181
-
182
- async [TRUNCATE_TABLE_ONLY_USE_FOR_UNIT_TESTS](): Promise<void> {
183
- await this.db.exec(`DELETE FROM ${this.tableName}`);
184
- }
185
- }