chore(backend): Expose AuthObject type (#3844)

Co-authored-by: Lennart <lekoarts@gmail.com>

.changeset/fast-knives-peel.md

@@ -0,0 +1,9 @@
+---
+"@clerk/backend": patch
+---
+
+Export the type `AuthObject`. You can now use it like so:
+
+```ts
+import type { AuthObject } from "@clerk/backend"
+```

.changeset/itchy-ravens-protect.md

@@ -0,0 +1,10 @@
+---
+"@clerk/clerk-sdk-node": patch
+"@clerk/express": patch
+"@clerk/fastify": patch
+"@clerk/nextjs": patch
+"@clerk/astro": patch
+"@clerk/remix": patch
+---
+
+Internal change: Use `AuthObject` type import from `@clerk/backend`.

packages/astro/src/server/clerk-middleware.ts

@@ -1,11 +1,5 @@
-import type { ClerkClient } from '@clerk/backend';
-import type {
-  AuthenticateRequestOptions,
-  AuthObject,
-  ClerkRequest,
-  RedirectFun,
-  RequestState,
-} from '@clerk/backend/internal';
+import type { AuthObject, ClerkClient } from '@clerk/backend';
+import type { AuthenticateRequestOptions, ClerkRequest, RedirectFun, RequestState } from '@clerk/backend/internal';
 import { AuthStatus, constants, createClerkRequest, createRedirect } from '@clerk/backend/internal';
 import { handleValueOrFn, isDevelopmentFromSecretKey, isHttpOrHttps } from '@clerk/shared';
 import { eventMethodCalled } from '@clerk/shared/telemetry';

packages/astro/src/server/get-auth.ts

@@ -1,4 +1,5 @@
-import { type AuthObject, AuthStatus, signedInAuthObject, signedOutAuthObject } from '@clerk/backend/internal';
+import type { AuthObject } from '@clerk/backend';
+import { AuthStatus, signedInAuthObject, signedOutAuthObject } from '@clerk/backend/internal';
 import { decodeJwt } from '@clerk/backend/jwt';
 import type { APIContext } from 'astro';
 

packages/backend/src/index.ts

@@ -120,3 +120,8 @@ export type {
   WebhookEvent,
   WebhookEventType,
 } from './api/resources/Webhooks';
+
+/**
+ * Auth objects
+ */
+export type { AuthObject } from './tokens/authObjects';

packages/backend/src/internal.ts

@@ -9,12 +9,7 @@ export { debugRequestState } from './tokens/request';
 
 export type { AuthenticateRequestOptions } from './tokens/types';
 
-export type {
-  SignedInAuthObjectOptions,
-  SignedInAuthObject,
-  SignedOutAuthObject,
-  AuthObject,
-} from './tokens/authObjects';
+export type { SignedInAuthObjectOptions, SignedInAuthObject, SignedOutAuthObject } from './tokens/authObjects';
 export { makeAuthObjectSerializable, signedOutAuthObject, signedInAuthObject } from './tokens/authObjects';
 
 export { AuthStatus } from './tokens/authStatus';

packages/express/src/__tests__/helpers.ts

@@ -1,4 +1,4 @@
-import type { AuthObject } from '@clerk/backend/internal';
+import type { AuthObject } from '@clerk/backend';
 import type { Application, Request as ExpressRequest, RequestHandler, Response as ExpressResponse } from 'express';
 import express from 'express';
 import supertest from 'supertest';

packages/express/src/getAuth.ts

@@ -1,4 +1,4 @@
-import type { AuthObject } from '@clerk/backend/internal';
+import type { AuthObject } from '@clerk/backend';
 import type { Request as ExpressRequest } from 'express';
 
 import { middlewareRequired } from './errors';

packages/express/src/types.ts

@@ -1,6 +1,5 @@
-// eslint-disable-next-line @typescript-eslint/consistent-type-imports
-import { createClerkClient } from '@clerk/backend';
-import type { AuthenticateRequestOptions, AuthObject } from '@clerk/backend/internal';
+import type { AuthObject, createClerkClient } from '@clerk/backend';
+import type { AuthenticateRequestOptions } from '@clerk/backend/internal';
 import type { Request as ExpressRequest, RequestHandler } from 'express';
 
 export type ExpressRequestWithAuth = ExpressRequest & { auth: AuthObject };

packages/fastify/src/getAuth.ts

@@ -1,4 +1,4 @@
-import type { AuthObject } from '@clerk/backend/internal';
+import type { AuthObject } from '@clerk/backend';
 import type { FastifyRequest } from 'fastify';
 
 import { pluginRegistrationRequired } from './errors';

packages/gatsby-plugin-clerk/src/ssr/types.ts

@@ -1,5 +1,5 @@
-import type { Organization, Session, User } from '@clerk/backend';
-import type { AuthenticateRequestOptions, AuthObject } from '@clerk/backend/internal';
+import type { AuthObject, Organization, Session, User } from '@clerk/backend';
+import type { AuthenticateRequestOptions } from '@clerk/backend/internal';
 import type { GetServerDataProps } from 'gatsby';
 
 export type WithServerAuthResult<CallbackReturn> = (props: GetServerDataProps) => Promise<Awaited<CallbackReturn>>;

packages/nextjs/src/app-router/server/auth.ts

@@ -1,4 +1,5 @@
-import type { AuthObject, RedirectFun } from '@clerk/backend/internal';
+import type { AuthObject } from '@clerk/backend';
+import type { RedirectFun } from '@clerk/backend/internal';
 import { constants, createClerkRequest, createRedirect } from '@clerk/backend/internal';
 import { notFound, redirect } from 'next/navigation';
 

packages/nextjs/src/server/authMiddleware.ts

@@ -1,4 +1,5 @@
-import type { AuthenticateRequestOptions, AuthObject, ClerkRequest } from '@clerk/backend/internal';
+import type { AuthObject } from '@clerk/backend';
+import type { AuthenticateRequestOptions, ClerkRequest } from '@clerk/backend/internal';
 import { AuthStatus, constants, createClerkRequest, createRedirect } from '@clerk/backend/internal';
 import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
 import { eventMethodCalled } from '@clerk/shared/telemetry';

packages/nextjs/src/server/clerkMiddleware.ts

@@ -1,12 +1,7 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
 
-import type {
-  AuthenticateRequestOptions,
-  AuthObject,
-  ClerkRequest,
-  RedirectFun,
-  RequestState,
-} from '@clerk/backend/internal';
+import type { AuthObject } from '@clerk/backend';
+import type { AuthenticateRequestOptions, ClerkRequest, RedirectFun, RequestState } from '@clerk/backend/internal';
 import { AuthStatus, constants, createClerkRequest, createRedirect } from '@clerk/backend/internal';
 import { eventMethodCalled } from '@clerk/shared/telemetry';
 import type { NextMiddleware } from 'next/server';

packages/nextjs/src/server/createGetAuth.ts

@@ -1,4 +1,4 @@
-import type { AuthObject } from '@clerk/backend/internal';
+import type { AuthObject } from '@clerk/backend';
 import { AuthStatus, constants, signedInAuthObject, signedOutAuthObject } from '@clerk/backend/internal';
 import { decodeJwt } from '@clerk/backend/jwt';
 

packages/nextjs/src/server/protect.ts

@@ -1,4 +1,5 @@
-import type { AuthObject, RedirectFun, SignedInAuthObject } from '@clerk/backend/internal';
+import type { AuthObject } from '@clerk/backend';
+import type { RedirectFun, SignedInAuthObject } from '@clerk/backend/internal';
 import { constants } from '@clerk/backend/internal';
 import type {
   CheckAuthorizationParamsWithCustomPermissions,

packages/remix/src/ssr/types.ts

@@ -1,5 +1,5 @@
-import type { Organization, Session, User, VerifyTokenOptions } from '@clerk/backend';
-import type { AuthObject, RequestState } from '@clerk/backend/internal';
+import type { AuthObject, Organization, Session, User, VerifyTokenOptions } from '@clerk/backend';
+import type { RequestState } from '@clerk/backend/internal';
 import type {
   LegacyRedirectProps,
   MultiDomainAndOrProxy,

packages/sdk-node/src/types.ts

@@ -1,5 +1,5 @@
-import type { createClerkClient } from '@clerk/backend';
-import type { AuthenticateRequestOptions, AuthObject, SignedInAuthObject } from '@clerk/backend/internal';
+import type { AuthObject, createClerkClient } from '@clerk/backend';
+import type { AuthenticateRequestOptions, SignedInAuthObject } from '@clerk/backend/internal';
 import type { MultiDomainAndOrProxy } from '@clerk/types';
 import type { NextFunction, Request, Response } from 'express';
 import type { IncomingMessage } from 'http';