change export to backend

.changeset/fast-knives-peel.md

@@ -1,12 +1,9 @@
 ---
-"@clerk/astro": patch
 "@clerk/backend": patch
-"@clerk/express": patch
-"@clerk/fastify": patch
-"@clerk/nextjs": patch
-"@clerk/remix": patch
-"@clerk/clerk-sdk-node": patch
-"@clerk/types": patch
 ---
 
-Move `AuthObject` and its related types to `@clerk/types`. You will now be able to import it from there.
+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,9 +1,8 @@
-import type { ClerkClient } from '@clerk/backend';
+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';
-import type { AuthObject } from '@clerk/types';
 import type { APIContext } from 'astro';
 
 // @ts-ignore

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

@@ -1,6 +1,6 @@
+import type { AuthObject } from '@clerk/backend';
 import { AuthStatus, signedInAuthObject, signedOutAuthObject } from '@clerk/backend/internal';
 import { decodeJwt } from '@clerk/backend/jwt';
-import type { AuthObject } from '@clerk/types';
 import type { APIContext } from 'astro';
 
 import { getSafeEnv } from './get-safe-env';

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,7 +9,7 @@ export { debugRequestState } from './tokens/request';
 
 export type { AuthenticateRequestOptions } from './tokens/types';
 
-export type { SignedInAuthObjectOptions } from './tokens/authObjects';
+export type { SignedInAuthObjectOptions, SignedInAuthObject, SignedOutAuthObject } from './tokens/authObjects';
 export { makeAuthObjectSerializable, signedOutAuthObject, signedInAuthObject } from './tokens/authObjects';
 
 export { AuthStatus } from './tokens/authStatus';

packages/backend/src/tokens/authObjects.ts

@@ -1,25 +1,66 @@
 import type {
-  AuthObject,
-  AuthObjectDebugData,
+  ActClaim,
   CheckAuthorizationWithCustomPermissions,
   JwtPayload,
+  OrganizationCustomPermissionKey,
+  OrganizationCustomRoleKey,
   ServerGetToken,
   ServerGetTokenOptions,
-  SignedInAuthObject,
-  SignedOutAuthObject,
 } from '@clerk/types';
 
 import type { CreateBackendApiOptions } from '../api';
 import { createBackendApiClient } from '../api';
 import type { AuthenticateContext } from './authenticateContext';
 
+type AuthObjectDebugData = Record<string, any>;
+type AuthObjectDebug = () => AuthObjectDebugData;
+
 /**
  * @internal
  */
 export type SignedInAuthObjectOptions = CreateBackendApiOptions & {
   token: string;
 };
 
+/**
+ * @internal
+ */
+export type SignedInAuthObject = {
+  sessionClaims: JwtPayload;
+  sessionId: string;
+  actor: ActClaim | undefined;
+  userId: string;
+  orgId: string | undefined;
+  orgRole: OrganizationCustomRoleKey | undefined;
+  orgSlug: string | undefined;
+  orgPermissions: OrganizationCustomPermissionKey[] | undefined;
+  getToken: ServerGetToken;
+  has: CheckAuthorizationWithCustomPermissions;
+  debug: AuthObjectDebug;
+};
+
+/**
+ * @internal
+ */
+export type SignedOutAuthObject = {
+  sessionClaims: null;
+  sessionId: null;
+  actor: null;
+  userId: null;
+  orgId: null;
+  orgRole: null;
+  orgSlug: null;
+  orgPermissions: null;
+  getToken: ServerGetToken;
+  has: CheckAuthorizationWithCustomPermissions;
+  debug: AuthObjectDebug;
+};
+
+/**
+ * @internal
+ */
+export type AuthObject = SignedInAuthObject | SignedOutAuthObject;
+
 const createDebug = (data: AuthObjectDebugData | undefined) => {
   return () => {
     const res = { ...data };

packages/backend/src/tokens/authStatus.ts

@@ -1,8 +1,9 @@
-import type { JwtPayload, SignedInAuthObject, SignedOutAuthObject } from '@clerk/types';
+import type { JwtPayload } from '@clerk/types';
 
 import { constants } from '../constants';
 import type { TokenVerificationErrorReason } from '../errors';
 import type { AuthenticateContext } from './authenticateContext';
+import type { SignedInAuthObject, SignedOutAuthObject } from './authObjects';
 import { signedInAuthObject, signedOutAuthObject } from './authObjects';
 
 export const AuthStatus = {

packages/backend/src/util/decorateObjectWithResources.ts

@@ -1,7 +1,6 @@
-import type { AuthObject } from '@clerk/types';
-
 import type { CreateBackendApiOptions, Organization, Session, User } from '../api';
 import { createBackendApiClient } from '../api';
+import type { AuthObject } from '../tokens/authObjects';
 
 type DecorateAuthWithResourcesOptions = {
   loadSession?: boolean;

packages/express/src/__tests__/helpers.ts

@@ -1,4 +1,4 @@
-import type { AuthObject } from '@clerk/types';
+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/types';
+import type { AuthObject } from '@clerk/backend';
 import type { Request as ExpressRequest } from 'express';
 
 import { middlewareRequired } from './errors';

packages/express/src/types.ts

@@ -1,7 +1,5 @@
-// eslint-disable-next-line @typescript-eslint/consistent-type-imports
-import { createClerkClient } from '@clerk/backend';
+import type { AuthObject, createClerkClient } from '@clerk/backend';
 import type { AuthenticateRequestOptions } from '@clerk/backend/internal';
-import type { AuthObject } from '@clerk/types';
 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/types';
+import type { AuthObject } from '@clerk/backend';
 import type { FastifyRequest } from 'fastify';
 
 import { pluginRegistrationRequired } from './errors';

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

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

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

@@ -1,6 +1,6 @@
+import type { AuthObject } from '@clerk/backend';
 import type { RedirectFun } from '@clerk/backend/internal';
 import { constants, createClerkRequest, createRedirect } from '@clerk/backend/internal';
-import type { AuthObject } from '@clerk/types';
 import { notFound, redirect } from 'next/navigation';
 
 import { buildClerkProps } from '../../server/buildClerkProps';

packages/nextjs/src/server/authMiddleware.ts

@@ -1,8 +1,8 @@
+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';
-import type { AuthObject } from '@clerk/types';
 import type { NextFetchEvent, NextMiddleware, NextRequest } from 'next/server';
 import { NextResponse } from 'next/server';
 

packages/nextjs/src/server/clerkMiddleware.ts

@@ -1,9 +1,9 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
 
+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 { AuthObject } from '@clerk/types';
 import type { NextMiddleware } from 'next/server';
 import { NextResponse } from 'next/server';
 

packages/nextjs/src/server/createGetAuth.ts

@@ -1,6 +1,6 @@
+import type { AuthObject } from '@clerk/backend';
 import { AuthStatus, constants, signedInAuthObject, signedOutAuthObject } from '@clerk/backend/internal';
 import { decodeJwt } from '@clerk/backend/jwt';
-import type { AuthObject } from '@clerk/types';
 
 import { withLogger } from '../utils/debugLogger';
 import { API_URL, API_VERSION, SECRET_KEY } from './constants';

packages/nextjs/src/server/protect.ts

@@ -1,10 +1,9 @@
-import type { RedirectFun } 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 {
-  AuthObject,
   CheckAuthorizationParamsWithCustomPermissions,
   CheckAuthorizationWithCustomPermissions,
-  SignedInAuthObject,
 } from '@clerk/types';
 
 import { constants as nextConstants } from '../constants';

packages/remix/src/ssr/types.ts

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

packages/sdk-node/src/types.ts

@@ -1,6 +1,6 @@
-import type { createClerkClient } from '@clerk/backend';
-import type { AuthenticateRequestOptions } from '@clerk/backend/internal';
-import type { AuthObject, MultiDomainAndOrProxy, SignedInAuthObject } from '@clerk/types';
+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';
 

packages/types/src/token.ts

@@ -1,56 +1,7 @@
-import type { ActClaim, JwtPayload } from 'jwtv2';
-import type { OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from 'organizationMembership';
-import type { CheckAuthorizationWithCustomPermissions } from 'session';
-import type { ServerGetToken } from 'ssr';
-
 import type { JWT } from './jwt';
 import type { ClerkResource } from './resource';
 
 export interface TokenResource extends ClerkResource {
   jwt?: JWT;
   getRawString: () => string;
 }
-/**
- * @internal
- */
-export type AuthObjectDebugData = Record<string, any>;
-/**
- * @internal
- */
-export type AuthObjectDebug = () => AuthObjectDebugData;
-
-/**
- * @internal
- */
-export type SignedInAuthObject = {
-  sessionClaims: JwtPayload;
-  sessionId: string;
-  actor: ActClaim | undefined;
-  userId: string;
-  orgId: string | undefined;
-  orgRole: OrganizationCustomRoleKey | undefined;
-  orgSlug: string | undefined;
-  orgPermissions: OrganizationCustomPermissionKey[] | undefined;
-  getToken: ServerGetToken;
-  has: CheckAuthorizationWithCustomPermissions;
-  debug: AuthObjectDebug;
-};
-
-/**
- * @internal
- */
-export type SignedOutAuthObject = {
-  sessionClaims: null;
-  sessionId: null;
-  actor: null;
-  userId: null;
-  orgId: null;
-  orgRole: null;
-  orgSlug: null;
-  orgPermissions: null;
-  getToken: ServerGetToken;
-  has: CheckAuthorizationWithCustomPermissions;
-  debug: AuthObjectDebug;
-};
-
-export type AuthObject = SignedInAuthObject | SignedOutAuthObject;