chore: Deprecate ClerkLayout Astro component (#175)

.changeset/red-parrots-beam.md

@@ -0,0 +1,5 @@
+---
+"astro-clerk-auth": minor
+---
+
+Deprecate `ClerkLayout` Astro component. It's usage it is no longer needed as this is now handled my `clerkMiiddleware`.

apps/playground-with-package/src/pages/index.astro

@@ -10,16 +10,16 @@ import Install from "../components/Install.astro";
 
 <Layout title="Welcome to Astro.">
   <h1>Welcome to <span class="text-gradient">Astro</span></h1>
-    <SignedIn>
-      <OrganizationSwitcher
-        appearance={{
-          elements: {
-            organizationPreview__organizationSwitcherTrigger: "text-white",
-            organizationSwitcherTriggerIcon: "text-white",
-          },
-        }}
-        afterSelectOrganizationUrl="/organization"
-      />
+  <SignedIn>
+    <OrganizationSwitcher
+      appearance={{
+        elements: {
+          organizationPreview__organizationSwitcherTrigger: "text-white",
+          organizationSwitcherTriggerIcon: "text-white",
+        },
+      }}
+      afterSelectOrganizationUrl="/organization"
+    />
     <SignOutButton />
   </SignedIn>
 

packages/astro-clerk-auth/README.md

@@ -131,25 +131,6 @@ export const onRequest = clerkMiddleware((auth, context, next) => {
 });
 ```
 
-## Wrap each page with `ClerkLayout` (Only required for SSR with React)
-In order to properly support SSR, you need to wrap each page in your app with the `ClerkLayout` Astro component.
-
-Example Page  `my-page.astro`
-```astro
----
-import Layout from "../layouts/Layout.astro";
-import { OrganizationList } from "astro-clerk-auth/components/interactive";
-import { ClerkLayout } from "astro-clerk-auth/components/control";
----
-
-<ClerkLayout>
-  <Layout title="Welcome to Astro.">
-    ...
-  </Layout>
-</ClerkLayout>
-
-```
-
 ## Use Clerk UI Components
 Supported components
 - [SignIn](https://clerk.com/docs/components/authentication/sign-in)

packages/astro-clerk-auth/src/astro-components/control/index.ts

@@ -1,11 +1,18 @@
 // The `ts-ignore` comments here are necessary because we're importing this file inside the `astro:components`
 // virtual module's types, which means that `tsc` will try to resolve these imports. Don't mind the editor errors.
+
 // @ts-ignore
-export { default as ClerkLayout } from './ClerkLayout.astro';
+import { default as ClerkLayoutDeprecated } from './ClerkLayout.astro';
+
+/**
+ * @deprecated It's usage is no longer necessary, it can be safely removed.
+ */
+const ClerkLayout = ClerkLayoutDeprecated;
+
+export { ClerkLayout };
 // @ts-ignore
 export { default as SignedIn } from './SignedIn.astro';
 // @ts-ignore
 export { default as SignedOut } from './SignedOut.astro';
 // @ts-ignore
 export { default as Protect } from './Protect.astro';
-