@authfn/api-keys 0.1.1

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.
@@ -0,0 +1,5 @@
1
+ import type { ApiKeyPluginConfig, ApiKeyPluginRuntimeConfig } from 'authfn/plugin-types';
2
+ import type { AuthFnPlugin } from 'authfn';
3
+ export type { ApiKeyPluginConfig, ApiKeyPluginRuntimeConfig } from 'authfn/plugin-types';
4
+ export declare function authFnApiKeyPlugin(config?: ApiKeyPluginConfig): AuthFnPlugin<'apiKey', ApiKeyPluginRuntimeConfig, false>;
5
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,YAAY,EAAsD,MAAM,QAAQ,CAAC;AAQ/F,YAAY,EACV,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,qBAAqB,CAAC;AAE7B,wBAAgB,kBAAkB,CAChC,MAAM,GAAE,kBAAuB,GAC9B,YAAY,CAAC,QAAQ,EAAE,yBAAyB,EAAE,KAAK,CAAC,CAM1D"}
package/dist/index.js ADDED
@@ -0,0 +1,135 @@
1
+ import { createApiKey, listApiKeysForUser, revokeApiKeyById } from 'authfn/core/api-keys';
2
+ import { assertValidCsrf, requireCookieSession } from 'authfn/core/sessions';
3
+ import { createAuthFnRouteMeta } from 'authfn/http/router';
4
+ import { jsonSuccess } from 'authfn/http/envelopes';
5
+ import { emitAuthEvent, eventRequestId } from 'authfn/core/observability';
6
+ import { readPluginRuntimeConfig } from 'authfn/core/plugin-runtime';
7
+ export function authFnApiKeyPlugin(config = {}) {
8
+ return {
9
+ name: 'apiKey',
10
+ schema: () => config.schema ?? createApiKeySchema(),
11
+ routes: (ctx) => createApiKeyRoutes(ctx, config)
12
+ };
13
+ }
14
+ function createApiKeySchema() {
15
+ return [
16
+ {
17
+ modelName: 'api_keys',
18
+ fields: {
19
+ id: { type: 'string', required: true, fieldName: 'id' },
20
+ userId: { type: 'string', required: false, fieldName: 'user_id' },
21
+ name: { type: 'string', required: false, fieldName: 'name' },
22
+ secretHash: { type: 'string', required: true, fieldName: 'secret_hash' },
23
+ scopes: { type: 'json', required: false, fieldName: 'scopes' },
24
+ metadata: { type: 'json', required: false, fieldName: 'metadata' },
25
+ expiresAt: { type: 'date', required: false, fieldName: 'expires_at' },
26
+ revokedAt: { type: 'date', required: false, fieldName: 'revoked_at' },
27
+ lastUsedAt: { type: 'date', required: false, fieldName: 'last_used_at' },
28
+ createdAt: { type: 'date', required: true, fieldName: 'created_at' },
29
+ updatedAt: { type: 'date', required: true, fieldName: 'updated_at' }
30
+ },
31
+ indexes: [
32
+ {
33
+ name: 'idx_authfn_api_keys_secret_hash',
34
+ fields: ['secretHash'],
35
+ unique: true
36
+ },
37
+ {
38
+ name: 'idx_authfn_api_keys_user_id_created_at',
39
+ fields: ['userId', 'createdAt']
40
+ }
41
+ ]
42
+ }
43
+ ];
44
+ }
45
+ function createApiKeyRoutes(ctx, config) {
46
+ const runtimeConfig = readPluginRuntimeConfig(ctx, 'apiKey');
47
+ return [
48
+ {
49
+ method: 'POST',
50
+ path: '/api-keys',
51
+ meta: createAuthFnRouteMeta('createApiKey', 'Create a new API key for the current user', {
52
+ mode: 'cookie-session',
53
+ csrf: true
54
+ }),
55
+ handler: async (request) => {
56
+ const state = await requireCookieSession(ctx.config, request);
57
+ assertValidCsrf(request, state);
58
+ const body = await request.json();
59
+ const created = await createApiKey(ctx.config, {
60
+ userId: state.user.id,
61
+ name: body.name ?? 'api-key',
62
+ scopes: body.scopes,
63
+ metadata: body.metadata,
64
+ expiresAt: body.expiresAt ? new Date(body.expiresAt) : undefined
65
+ }, {
66
+ now: runtimeConfig.now,
67
+ secretPrefix: config.secretPrefix
68
+ });
69
+ await emitAuthEvent(ctx.config, {
70
+ type: 'authfn.api_key.created',
71
+ requestId: eventRequestId(request),
72
+ actorId: state.user.id,
73
+ userId: state.user.id,
74
+ outcome: 'created',
75
+ metadata: {
76
+ keyId: created.keyId,
77
+ scopes: body.scopes ?? []
78
+ }
79
+ });
80
+ return jsonSuccess(request, {
81
+ keyId: created.keyId,
82
+ secret: created.secret,
83
+ secretReturnedOnce: true
84
+ }, {
85
+ status: 201
86
+ });
87
+ }
88
+ },
89
+ {
90
+ method: 'GET',
91
+ path: '/api-keys',
92
+ meta: createAuthFnRouteMeta('listApiKeys', 'List API keys for the current user', {
93
+ mode: 'cookie-session'
94
+ }),
95
+ handler: async (request) => {
96
+ const state = await requireCookieSession(ctx.config, request);
97
+ const keys = await listApiKeysForUser(ctx.config, state.user.id);
98
+ return jsonSuccess(request, {
99
+ keys
100
+ });
101
+ }
102
+ },
103
+ {
104
+ method: 'DELETE',
105
+ path: '/api-keys/:keyId',
106
+ meta: createAuthFnRouteMeta('revokeApiKey', 'Revoke an API key for the current user', {
107
+ mode: 'cookie-session',
108
+ csrf: true
109
+ }),
110
+ handler: async (request, context) => {
111
+ const state = await requireCookieSession(ctx.config, request);
112
+ assertValidCsrf(request, state);
113
+ await revokeApiKeyById(ctx.config, context.params.keyId, {
114
+ userId: state.user.id,
115
+ now: runtimeConfig.now
116
+ });
117
+ await emitAuthEvent(ctx.config, {
118
+ type: 'authfn.api_key.revoked',
119
+ requestId: eventRequestId(request),
120
+ actorId: state.user.id,
121
+ userId: state.user.id,
122
+ outcome: 'revoked',
123
+ metadata: {
124
+ keyId: context.params.keyId
125
+ }
126
+ });
127
+ return jsonSuccess(request, {
128
+ revoked: true,
129
+ keyId: context.params.keyId
130
+ });
131
+ }
132
+ }
133
+ ];
134
+ }
135
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAOrE,MAAM,UAAU,kBAAkB,CAChC,SAA6B,EAAE;IAE/B,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,kBAAkB,EAAE;QACnD,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,CAAC;KACjD,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB;IACzB,OAAO;QACL;YACE,SAAS,EAAE,UAAU;YACrB,MAAM,EAAE;gBACN,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;gBACvD,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE;gBACjE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE;gBAC5D,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE;gBACxE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE;gBAC9D,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE;gBAClE,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE;gBACrE,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE;gBACrE,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE;gBACxE,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE;gBACpE,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE;aACrE;YACD,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,iCAAiC;oBACvC,MAAM,EAAE,CAAC,YAAY,CAAC;oBACtB,MAAM,EAAE,IAAI;iBACb;gBACD;oBACE,IAAI,EAAE,wCAAwC;oBAC9C,MAAM,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC;iBAChC;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CACzB,GAA+B,EAC/B,MAA0B;IAE1B,MAAM,aAAa,GAAG,uBAAuB,CAA4B,GAAG,EAAE,QAAQ,CAAC,CAAC;IAExF,OAAO;QACL;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,qBAAqB,CAAC,cAAc,EAAE,2CAA2C,EAAE;gBACvF,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,IAAI;aACX,CAAC;YACF,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBACzB,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAC9D,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAChC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,EAK9B,CAAC;gBACF,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE;oBAC7C,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE;oBACrB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,SAAS;oBAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;iBACjE,EAAE;oBACD,GAAG,EAAE,aAAa,CAAC,GAAG;oBACtB,YAAY,EAAE,MAAM,CAAC,YAAY;iBAClC,CAAC,CAAC;gBAEH,MAAM,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE;oBAC9B,IAAI,EAAE,wBAAwB;oBAC9B,SAAS,EAAE,cAAc,CAAC,OAAO,CAAC;oBAClC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE;oBACtB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE;oBACrB,OAAO,EAAE,SAAS;oBAClB,QAAQ,EAAE;wBACR,KAAK,EAAE,OAAO,CAAC,KAAK;wBACpB,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,EAAE;qBAC1B;iBACF,CAAC,CAAC;gBAEH,OAAO,WAAW,CAAC,OAAO,EAAE;oBAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,kBAAkB,EAAE,IAAI;iBACzB,EAAE;oBACD,MAAM,EAAE,GAAG;iBACZ,CAAC,CAAC;YACL,CAAC;SACF;QACD;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,qBAAqB,CAAC,aAAa,EAAE,oCAAoC,EAAE;gBAC/E,IAAI,EAAE,gBAAgB;aACvB,CAAC;YACF,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBACzB,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAC9D,MAAM,IAAI,GAAG,MAAM,kBAAkB,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACjE,OAAO,WAAW,CAAC,OAAO,EAAE;oBAC1B,IAAI;iBACL,CAAC,CAAC;YACL,CAAC;SACF;QACD;YACE,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE,qBAAqB,CAAC,cAAc,EAAE,wCAAwC,EAAE;gBACpF,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,IAAI;aACX,CAAC;YACF,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;gBAClC,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAC9D,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAChC,MAAM,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE;oBACvD,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE;oBACrB,GAAG,EAAE,aAAa,CAAC,GAAG;iBACvB,CAAC,CAAC;gBACH,MAAM,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE;oBAC9B,IAAI,EAAE,wBAAwB;oBAC9B,SAAS,EAAE,cAAc,CAAC,OAAO,CAAC;oBAClC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE;oBACtB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE;oBACrB,OAAO,EAAE,SAAS;oBAClB,QAAQ,EAAE;wBACR,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK;qBAC5B;iBACF,CAAC,CAAC;gBACH,OAAO,WAAW,CAAC,OAAO,EAAE;oBAC1B,OAAO,EAAE,IAAI;oBACb,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK;iBAC5B,CAAC,CAAC;YACL,CAAC;SACF;KACF,CAAC;AACJ,CAAC"}
package/package.json ADDED
@@ -0,0 +1,32 @@
1
+ {
2
+ "name": "@authfn/api-keys",
3
+ "version": "0.1.1",
4
+ "description": "API key plugin for AuthFn",
5
+ "type": "module",
6
+ "main": "./dist/index.js",
7
+ "types": "./dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "types": "./dist/index.d.ts",
11
+ "default": "./dist/index.js"
12
+ }
13
+ },
14
+ "files": [
15
+ "dist"
16
+ ],
17
+ "scripts": {
18
+ "build": "tsc",
19
+ "test": "vitest run --passWithNoTests",
20
+ "typecheck": "tsc --noEmit",
21
+ "clean": "rm -rf dist"
22
+ },
23
+ "dependencies": {
24
+ "authfn": "0.2.0",
25
+ "@superfunctions/http": "0.2.0"
26
+ },
27
+ "devDependencies": {
28
+ "@types/node": "^22.0.0",
29
+ "typescript": "^5.6.0",
30
+ "vitest": "^3.2.4"
31
+ }
32
+ }