@convex-dev/workos-authkit 0.2.4 → 0.2.5
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/README.md +11 -0
- package/dist/client/index.d.ts +1 -0
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +27 -18
- package/dist/client/index.js.map +1 -1
- package/package.json +7 -7
- package/src/client/index.test.ts +109 -0
- package/src/client/index.ts +15 -7
package/README.md
CHANGED
|
@@ -88,6 +88,17 @@ authKit.registerRoutes(http);
|
|
|
88
88
|
export default http;
|
|
89
89
|
```
|
|
90
90
|
|
|
91
|
+
## Custom domain
|
|
92
|
+
|
|
93
|
+
If you've configured a [custom WorkOS authentication API domain](https://workos.com/docs/custom-domains/auth-api), pass it as `apiHostname` when constructing the AuthKit client. This routes the WorkOS SDK through your domain and updates the JWT issuer and JWKS URLs to match.
|
|
94
|
+
|
|
95
|
+
```ts
|
|
96
|
+
// convex/auth.ts
|
|
97
|
+
export const authKit = new AuthKit<DataModel>(components.workOSAuthKit, {
|
|
98
|
+
apiHostname: "auth.example.com",
|
|
99
|
+
});
|
|
100
|
+
```
|
|
101
|
+
|
|
91
102
|
## Usage
|
|
92
103
|
|
|
93
104
|
User create/update/delete in WorkOS will be automatically synced by the
|
package/dist/client/index.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,UAAU,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,UAAU,EAIhB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EACL,MAAM,EACN,KAAK,KAAK,IAAI,WAAW,EACzB,KAAK,aAAa,IAAI,mBAAmB,EACzC,KAAK,kCAAkC,EACvC,KAAK,gCAAgC,EACtC,MAAM,kBAAkB,CAAC;AAI1B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAGzE,KAAK,qBAAqB,GACtB,gCAAgC,GAChC,kCAAkC,CAAC;AAEvC,KAAK,OAAO,GAAG;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAGF,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,CAAC,EAAE,iBAAiB,CAC/B,UAAU,EACV,UAAU,EACV;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,EACnB,qBAAqB,CACtB,CAAC;IACF,YAAY,CAAC,EAAE,iBAAiB,CAC9B,UAAU,EACV,UAAU,EACV;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,EAChC,IAAI,CACL,CAAC;CACH,CAAC;AAYF,qBAAa,OAAO,CAAC,SAAS,SAAS,gBAAgB;IAI5C,SAAS,EAAE,YAAY;IACvB,OAAO,CAAC,EAAE,OAAO;IAJnB,MAAM,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,MAAM,CAAS;gBAEd,SAAS,EAAE,YAAY,EACvB,OAAO,CAAC,EAAE,OAAO,YAAA;IAkC1B,sBAAsB;;;;;;;;;;;;SAiBpB;IAEI,WAAW,CAAC,GAAG,EAAE,WAAW;;;;;;;;;;;;;;IASlC,MAAM,CAAC,CAAC,SAAS,WAAW,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE;SAC1C,GAAG,IAAI,CAAC,GAAG,CACV,CAAC,SAAS,OAAO,CACf,WAAW,EACX;YACE,KAAK,EAAE,GAAG,CAAC;SACZ,CACF,EAED,GAAG,EAAE,kBAAkB,CAAC,SAAS,CAAC,EAClC,KAAK,EAAE,CAAC,KACL,OAAO,CAAC,IAAI,CAAC;KACnB;;;;;;IAiBD,OAAO,CAAC,CAAC,SAAS,gBAAgB,GAAG,kBAAkB,EAAE,IAAI,EAAE;SAC5D,GAAG,IAAI,CAAC,GAAG,CACV,CAAC,SAAS,OAAO,CACf,mBAAmB,EACnB;YACE,MAAM,EAAE,GAAG,SAAS,gBAAgB,GAChC,+BAA+B,GAC/B,kCAAkC,CAAC;SACxC,CACF,EAED,GAAG,EAAE,kBAAkB,CAAC,SAAS,CAAC,EAClC,MAAM,EAAE,CAAC,EACT,EACE,KAAK,EACL,IAAI,GACL,EAAE;YACD,KAAK,EAAE,MAAM,qBAAqB,CAAC;YACnC,IAAI,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,qBAAqB,CAAC;SACvD,KACE,OAAO,CAAC,qBAAqB,CAAC;KACpC;;;;;IAkCD,KAAK;;;IAmBL,cAAc,CAAC,IAAI,EAAE,UAAU;CA4EhC"}
|
package/dist/client/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { createFunctionHandle, httpActionGeneric,
|
|
1
|
+
import { createFunctionHandle, httpActionGeneric, internalMutationGeneric, } from "convex/server";
|
|
2
2
|
import { WorkOS, } from "@workos-inc/node";
|
|
3
3
|
import { v } from "convex/values";
|
|
4
4
|
import { parse } from "convex-helpers/validators";
|
|
@@ -32,23 +32,29 @@ export class AuthKit {
|
|
|
32
32
|
actionSecret: options?.actionSecret ?? process.env.WORKOS_ACTION_SECRET,
|
|
33
33
|
webhookPath: options?.webhookPath ?? "/workos/webhook",
|
|
34
34
|
};
|
|
35
|
-
this.workos = new WorkOS(this.config.apiKey
|
|
35
|
+
this.workos = new WorkOS(this.config.apiKey, {
|
|
36
|
+
clientId: this.config.clientId,
|
|
37
|
+
apiHostname: this.config.apiHostname,
|
|
38
|
+
});
|
|
36
39
|
}
|
|
37
|
-
getAuthConfigProviders = () =>
|
|
38
|
-
{
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
40
|
+
getAuthConfigProviders = () => {
|
|
41
|
+
const apiBaseUrl = `https://${this.config.apiHostname ?? "api.workos.com"}`;
|
|
42
|
+
return [
|
|
43
|
+
{
|
|
44
|
+
type: "customJwt",
|
|
45
|
+
issuer: `${apiBaseUrl}/`,
|
|
46
|
+
algorithm: "RS256",
|
|
47
|
+
jwks: `https://api.workos.com/sso/jwks/${this.config.clientId}`,
|
|
48
|
+
applicationID: this.config.clientId,
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
type: "customJwt",
|
|
52
|
+
issuer: `${apiBaseUrl}/user_management/${this.config.clientId}`,
|
|
53
|
+
algorithm: "RS256",
|
|
54
|
+
jwks: `https://api.workos.com/sso/jwks/${this.config.clientId}`,
|
|
55
|
+
},
|
|
56
|
+
];
|
|
57
|
+
};
|
|
52
58
|
async getAuthUser(ctx) {
|
|
53
59
|
const identity = await ctx.auth.getUserIdentity();
|
|
54
60
|
if (!identity) {
|
|
@@ -67,7 +73,10 @@ export class AuthKit {
|
|
|
67
73
|
},
|
|
68
74
|
returns: v.null(),
|
|
69
75
|
handler: async (ctx, args) => {
|
|
70
|
-
|
|
76
|
+
const handler = opts[args.event];
|
|
77
|
+
if (handler) {
|
|
78
|
+
await handler(ctx, args);
|
|
79
|
+
}
|
|
71
80
|
},
|
|
72
81
|
}),
|
|
73
82
|
};
|
package/dist/client/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,oBAAoB,EACpB,iBAAiB,EACjB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,oBAAoB,EACpB,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,MAAM,GAKP,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAElD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAkC7C,MAAM,aAAa,GAAG,CACpB,GAAuB,EACvB,WAAuB,EACf,EAAE;IACV,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,WAAW,EAAE,CAAC;IAChB,CAAC;IACD,OAAO,GAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,OAAO,OAAO;IAIT;IACA;IAJF,MAAM,CAAS;IACd,MAAM,CAAS;IACvB,YACS,SAAuB,EACvB,OAAiB;QADjB,cAAS,GAAT,SAAS,CAAc;QACvB,YAAO,GAAP,OAAO,CAAU;QAExB,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,aAAa,CAC5B,OAAO,EAAE,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,EACjD,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAC9C,CAAC;QACF,MAAM,MAAM,GAAG,aAAa,CAC1B,OAAO,EAAE,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,EAC7C,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAC5C,CAAC;QACF,MAAM,aAAa,GAAG,aAAa,CACjC,OAAO,EAAE,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAC3D,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,uBAAuB,CAAC,CACnD,CAAC;QACF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,kCAAkC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC9D,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,MAAM,GAAG;YACZ,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;YAClB,QAAQ;YACR,MAAM;YACN,aAAa;YACb,YAAY,EAAE,OAAO,EAAE,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAoB;YACvE,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,iBAAiB;SACvD,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAC3C,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YAC9B,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW;SACrC,CAAC,CAAC;IACL,CAAC;IAED,sBAAsB,GAAG,GAAG,EAAE;QAC5B,MAAM,UAAU,GAAG,WAAW,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,gBAAgB,EAAE,CAAC;QAC5E,OAAO;YACL;gBACE,IAAI,EAAE,WAAW;gBACjB,MAAM,EAAE,GAAG,UAAU,GAAG;gBACxB,SAAS,EAAE,OAAO;gBAClB,IAAI,EAAE,mCAAmC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;gBAC/D,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;aACpC;YACD;gBACE,IAAI,EAAE,WAAW;gBACjB,MAAM,EAAE,GAAG,UAAU,oBAAoB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;gBAC/D,SAAS,EAAE,OAAO;gBAClB,IAAI,EAAE,mCAAmC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;aAChE;SACgC,CAAC;IACtC,CAAC,CAAC;IAEF,KAAK,CAAC,WAAW,CAAC,GAAgB;QAChC,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;QAClD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,EAAE;YAClD,EAAE,EAAE,QAAQ,CAAC,OAAO;SACrB,CAAC,CAAC;IACL,CAAC;IACD,MAAM,CAAiC,IAYtC;QACC,OAAO;YACL,YAAY,EAAE,uBAAuB,CAAC;gBACpC,IAAI,EAAE;oBACJ,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;oBACjB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;iBACpC;gBACD,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;gBACjB,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;oBAC3B,MAAM,OAAO,GAAI,IAA6B,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;oBAChE,IAAI,OAAO,EAAE,CAAC;wBACZ,MAAM,OAAO,CAAC,GAAG,EAAE,IAAa,CAAC,CAAC;oBACpC,CAAC;gBACH,CAAC;aACF,CAAC;SACH,CAAC;IACJ,CAAC;IACD,OAAO,CAAkD,IAqBxD;QACC,OAAO;YACL,aAAa,EAAE,uBAAuB,CAAC;gBACrC,IAAI,EAAE;oBACJ,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;iBACtC;gBACD,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;gBACtC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;oBAC3B,MAAM,IAAI,GAAG;wBACX,IAAI,EACF,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,+BAA+B;4BACpD,CAAC,CAAE,gBAA0B;4BAC7B,CAAC,CAAE,mBAA6B;wBACpC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;qBAChC,CAAC;oBACF,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,OAAgB,EAAE,CAAC,CAAC;oBAC7D,MAAM,IAAI,GAAG,CAAC,YAAoB,EAAE,EAAE,CAAC,CAAC;wBACtC,GAAG,IAAI;wBACP,OAAO,EAAE,MAAe;wBACxB,YAAY;qBACb,CAAC,CAAC;oBACH,MAAM,eAAe,GAAG,MAAM,IAAI,CAChC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,+BAA+B;wBACrD,CAAC,CAAC,gBAAgB;wBAClB,CAAC,CAAC,kBAAkB,CAAM,CAC7B,CAAC,GAAG,EAAE,IAAI,CAAC,MAAe,EAAE;wBAC3B,KAAK;wBACL,IAAI;qBACL,CAAC,CAAC;oBACH,OAAO,eAAe,CAAC;gBACzB,CAAC;aACF,CAAC;SACH,CAAC;IACJ,CAAC;IACD,KAAK;QACH,OAAO;YACL,aAAa,EAAE,uBAAuB,CAAC;gBACrC,IAAI,EAAE,EAAE;gBACR,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;gBACjB,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;oBACrB,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,YAAY;wBAC3D,CAAC,CAAC,MAAM,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;wBACpE,CAAC,CAAC,SAAS,CAAC;oBACd,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE;wBAC3D,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;wBAC1B,aAAa;wBACb,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;qBAC/B,CAAC,CAAC;oBACH,OAAO,IAAI,CAAC;gBACd,CAAC;aACF,CAAC;SACH,CAAC;IACJ,CAAC;IACD,cAAc,CAAC,IAAgB;QAC7B,IAAI,CAAC,KAAK,CAAC;YACT,IAAI,EAAE,iBAAiB;YACvB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,iBAAiB,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;gBAChD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;gBACrC,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;gBAC1D,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;gBACzC,CAAC;gBACD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;gBACzC,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;gBAC/C,CAAC;gBACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC;oBACtD,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;oBAC5B,SAAS,EAAE,SAAS;oBACpB,MAAM;iBACP,CAAC,CAAC;gBACH,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;oBACrC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;gBACvC,CAAC;gBACD,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,EAAE;oBACvD,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;oBAC1B,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC;oBAC3B,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,YAAY;wBACpD,CAAC,CAAC,MAAM,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;wBACpE,CAAC,CAAC,SAAS;oBACb,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,oBAAoB;oBAC5C,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;iBAC/B,CAAC,CAAC;gBACH,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;YAC7C,CAAC,CAAC;SACH,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,CAAC;YACT,IAAI,EAAE,gBAAgB;YACtB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,iBAAiB,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;gBAChD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;gBACrC,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;gBAC1D,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;gBACzC,CAAC;gBACD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;gBACxC,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;gBAC/C,CAAC;gBACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC;oBACvD,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;oBAC5B,SAAS,EAAE,SAAS;oBACpB,MAAM;iBACP,CAAC,CAAC;gBACH,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;oBACrC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;gBACzC,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,aAAa,EAAE,CAAC;oBAC9C,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAC;gBACJ,CAAC;gBACD,MAAM,eAAe,GAA0B,MAAM,GAAG,CAAC,WAAW;gBAClE,kFAAkF;gBAClF,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,aAAc,EACzC;oBACE,MAAM;iBACP,CACF,CAAC;gBACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CACrD,eAAe;gBACf,uCAAuC;gBACvC,IAAI,CAAC,MAAM,CAAC,YAAa,CAC1B,CAAC;gBACF,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;YACjE,CAAC,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
"bugs": {
|
|
7
7
|
"url": "https://github.com/get-convex/workos-authkit/issues"
|
|
8
8
|
},
|
|
9
|
-
"version": "0.2.
|
|
9
|
+
"version": "0.2.5",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"keywords": [
|
|
12
12
|
"convex",
|
|
@@ -71,7 +71,7 @@
|
|
|
71
71
|
"@edge-runtime/vm": "5.0.0",
|
|
72
72
|
"@eslint/eslintrc": "3.3.5",
|
|
73
73
|
"@eslint/js": "9.39.4",
|
|
74
|
-
"@types/node": "
|
|
74
|
+
"@types/node": "24.12.3",
|
|
75
75
|
"@types/react": "19.2.14",
|
|
76
76
|
"@types/react-dom": "19.2.3",
|
|
77
77
|
"@vitejs/plugin-react": "6.0.1",
|
|
@@ -83,13 +83,13 @@
|
|
|
83
83
|
"eslint-plugin-react-hooks": "7.1.1",
|
|
84
84
|
"eslint-plugin-react-refresh": "0.5.2",
|
|
85
85
|
"globals": "17.6.0",
|
|
86
|
-
"pkg-pr-new": "0.0.
|
|
86
|
+
"pkg-pr-new": "0.0.71",
|
|
87
87
|
"prettier": "3.8.3",
|
|
88
|
-
"react": "19.2.
|
|
89
|
-
"react-dom": "19.2.
|
|
88
|
+
"react": "19.2.6",
|
|
89
|
+
"react-dom": "19.2.6",
|
|
90
90
|
"typescript": "5.9.3",
|
|
91
|
-
"typescript-eslint": "8.59.
|
|
92
|
-
"vite": "8.0.
|
|
91
|
+
"typescript-eslint": "8.59.2",
|
|
92
|
+
"vite": "8.0.11",
|
|
93
93
|
"vitest": "4.1.5"
|
|
94
94
|
},
|
|
95
95
|
"types": "./dist/client/index.d.ts",
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
/// <reference types="vite/client" />
|
|
2
|
+
import { describe, test, expect, vi, beforeEach, afterEach } from "vitest";
|
|
3
|
+
import { WorkOS } from "@workos-inc/node";
|
|
4
|
+
import { AuthKit } from "./index.js";
|
|
5
|
+
import type { ComponentApi } from "../component/_generated/component.js";
|
|
6
|
+
|
|
7
|
+
vi.mock("@workos-inc/node", () => {
|
|
8
|
+
return {
|
|
9
|
+
WorkOS: vi.fn().mockImplementation(function () {
|
|
10
|
+
return {};
|
|
11
|
+
}),
|
|
12
|
+
};
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
const requiredEnv = {
|
|
16
|
+
WORKOS_CLIENT_ID: "client_test",
|
|
17
|
+
WORKOS_API_KEY: "sk_test",
|
|
18
|
+
WORKOS_WEBHOOK_SECRET: "whsec_test",
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
const fakeComponent = {} as ComponentApi;
|
|
22
|
+
|
|
23
|
+
describe("AuthKit constructor", () => {
|
|
24
|
+
beforeEach(() => {
|
|
25
|
+
for (const [k, v] of Object.entries(requiredEnv)) {
|
|
26
|
+
process.env[k] = v;
|
|
27
|
+
}
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
afterEach(() => {
|
|
31
|
+
for (const k of Object.keys(requiredEnv)) {
|
|
32
|
+
delete process.env[k];
|
|
33
|
+
}
|
|
34
|
+
vi.clearAllMocks();
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
describe("apiHostname", () => {
|
|
38
|
+
test("forwards apiHostname option to the WorkOS SDK", () => {
|
|
39
|
+
new AuthKit(fakeComponent, { apiHostname: "auth.example.com" });
|
|
40
|
+
expect(vi.mocked(WorkOS)).toHaveBeenCalledWith(
|
|
41
|
+
"sk_test",
|
|
42
|
+
expect.objectContaining({ apiHostname: "auth.example.com" })
|
|
43
|
+
);
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
test("forwards undefined when option is not set", () => {
|
|
47
|
+
new AuthKit(fakeComponent);
|
|
48
|
+
expect(vi.mocked(WorkOS)).toHaveBeenCalledWith(
|
|
49
|
+
"sk_test",
|
|
50
|
+
expect.objectContaining({ apiHostname: undefined })
|
|
51
|
+
);
|
|
52
|
+
});
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
test("clientId is forwarded to the WorkOS SDK", () => {
|
|
56
|
+
new AuthKit(fakeComponent);
|
|
57
|
+
expect(vi.mocked(WorkOS)).toHaveBeenCalledWith(
|
|
58
|
+
"sk_test",
|
|
59
|
+
expect.objectContaining({ clientId: "client_test" })
|
|
60
|
+
);
|
|
61
|
+
});
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
describe("AuthKit.getAuthConfigProviders", () => {
|
|
65
|
+
beforeEach(() => {
|
|
66
|
+
for (const [k, v] of Object.entries(requiredEnv)) {
|
|
67
|
+
process.env[k] = v;
|
|
68
|
+
}
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
afterEach(() => {
|
|
72
|
+
for (const k of Object.keys(requiredEnv)) {
|
|
73
|
+
delete process.env[k];
|
|
74
|
+
}
|
|
75
|
+
vi.clearAllMocks();
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
test("falls back to api.workos.com when no custom hostname is set", () => {
|
|
79
|
+
const authKit = new AuthKit(fakeComponent);
|
|
80
|
+
const providers = authKit.getAuthConfigProviders();
|
|
81
|
+
expect(providers[0].issuer).toBe("https://api.workos.com/");
|
|
82
|
+
expect(providers[0].jwks).toBe(
|
|
83
|
+
"https://api.workos.com/sso/jwks/client_test"
|
|
84
|
+
);
|
|
85
|
+
expect(providers[1].issuer).toBe(
|
|
86
|
+
"https://api.workos.com/user_management/client_test"
|
|
87
|
+
);
|
|
88
|
+
expect(providers[1].jwks).toBe(
|
|
89
|
+
"https://api.workos.com/sso/jwks/client_test"
|
|
90
|
+
);
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
test("custom hostname rewrites issuer but not jwks", () => {
|
|
94
|
+
const authKit = new AuthKit(fakeComponent, {
|
|
95
|
+
apiHostname: "auth.example.com",
|
|
96
|
+
});
|
|
97
|
+
const providers = authKit.getAuthConfigProviders();
|
|
98
|
+
expect(providers[0].issuer).toBe("https://auth.example.com/");
|
|
99
|
+
expect(providers[0].jwks).toBe(
|
|
100
|
+
"https://api.workos.com/sso/jwks/client_test"
|
|
101
|
+
);
|
|
102
|
+
expect(providers[1].issuer).toBe(
|
|
103
|
+
"https://auth.example.com/user_management/client_test"
|
|
104
|
+
);
|
|
105
|
+
expect(providers[1].jwks).toBe(
|
|
106
|
+
"https://api.workos.com/sso/jwks/client_test"
|
|
107
|
+
);
|
|
108
|
+
});
|
|
109
|
+
});
|
package/src/client/index.ts
CHANGED
|
@@ -6,7 +6,6 @@ import {
|
|
|
6
6
|
type HttpRouter,
|
|
7
7
|
createFunctionHandle,
|
|
8
8
|
httpActionGeneric,
|
|
9
|
-
internalActionGeneric,
|
|
10
9
|
internalMutationGeneric,
|
|
11
10
|
} from "convex/server";
|
|
12
11
|
import type { RunQueryCtx } from "./types.js";
|
|
@@ -31,6 +30,7 @@ type Options = {
|
|
|
31
30
|
authFunctions?: AuthFunctions;
|
|
32
31
|
clientId?: string;
|
|
33
32
|
apiKey?: string;
|
|
33
|
+
apiHostname?: string;
|
|
34
34
|
webhookSecret?: string;
|
|
35
35
|
webhookPath?: string;
|
|
36
36
|
additionalEventTypes?: WorkOSEvent["event"][];
|
|
@@ -97,25 +97,30 @@ export class AuthKit<DataModel extends GenericDataModel> {
|
|
|
97
97
|
actionSecret: options?.actionSecret ?? process.env.WORKOS_ACTION_SECRET,
|
|
98
98
|
webhookPath: options?.webhookPath ?? "/workos/webhook",
|
|
99
99
|
};
|
|
100
|
-
this.workos = new WorkOS(this.config.apiKey
|
|
100
|
+
this.workos = new WorkOS(this.config.apiKey, {
|
|
101
|
+
clientId: this.config.clientId,
|
|
102
|
+
apiHostname: this.config.apiHostname,
|
|
103
|
+
});
|
|
101
104
|
}
|
|
102
105
|
|
|
103
|
-
getAuthConfigProviders = () =>
|
|
104
|
-
|
|
106
|
+
getAuthConfigProviders = () => {
|
|
107
|
+
const apiBaseUrl = `https://${this.config.apiHostname ?? "api.workos.com"}`;
|
|
108
|
+
return [
|
|
105
109
|
{
|
|
106
110
|
type: "customJwt",
|
|
107
|
-
issuer:
|
|
111
|
+
issuer: `${apiBaseUrl}/`,
|
|
108
112
|
algorithm: "RS256",
|
|
109
113
|
jwks: `https://api.workos.com/sso/jwks/${this.config.clientId}`,
|
|
110
114
|
applicationID: this.config.clientId,
|
|
111
115
|
},
|
|
112
116
|
{
|
|
113
117
|
type: "customJwt",
|
|
114
|
-
issuer:
|
|
118
|
+
issuer: `${apiBaseUrl}/user_management/${this.config.clientId}`,
|
|
115
119
|
algorithm: "RS256",
|
|
116
120
|
jwks: `https://api.workos.com/sso/jwks/${this.config.clientId}`,
|
|
117
121
|
},
|
|
118
122
|
] satisfies AuthConfig["providers"];
|
|
123
|
+
};
|
|
119
124
|
|
|
120
125
|
async getAuthUser(ctx: RunQueryCtx) {
|
|
121
126
|
const identity = await ctx.auth.getUserIdentity();
|
|
@@ -147,7 +152,10 @@ export class AuthKit<DataModel extends GenericDataModel> {
|
|
|
147
152
|
},
|
|
148
153
|
returns: v.null(),
|
|
149
154
|
handler: async (ctx, args) => {
|
|
150
|
-
|
|
155
|
+
const handler = (opts as Partial<typeof opts>)[args.event as K];
|
|
156
|
+
if (handler) {
|
|
157
|
+
await handler(ctx, args as never);
|
|
158
|
+
}
|
|
151
159
|
},
|
|
152
160
|
}),
|
|
153
161
|
};
|