Expose WorkOS client for advanced use cases (#204)

* expose the getWorkOS function in the module exports

Allow users direct access to the WorkOS instance

* add a section about exposing the WorkOS SDK to the README

Author: nicknisi

README.md

@@ -401,6 +401,22 @@ export default authkitMiddleware({
 });
 ```
 
+### Advanced: Direct access to the WorkOS client
+
+For advanced use cases or functionality not covered by the helper methods, you can access the underlying WorkOS client directly:
+
+```typescript
+import { getWorkOS } from '@workos-inc/authkit-nextjs';
+
+// Get the configured WorkOS client instance
+const workos = getWorkOS();
+
+// Use any WorkOS SDK method
+const organizations = await workos.organizations.listOrganizations({
+  limit: 10,
+});
+````
+
 ### Debugging
 
 To enable debug logs, initialize the middleware with the debug flag enabled.

src/index.ts

@@ -2,10 +2,12 @@ import { handleAuth } from './authkit-callback-route.js';
 import { authkit, authkitMiddleware } from './middleware.js';
 import { withAuth, refreshSession } from './session.js';
 import { getSignInUrl, getSignUpUrl, signOut } from './auth.js';
+import { getWorkOS } from './workos.js';
 
 export * from './interfaces.js';
 
 export {
+  getWorkOS,
   handleAuth,
   //
   authkitMiddleware,