✨ Separation of logic: migrating to Astro Theme Provider #77

create-issue-branch · 2024-05-11T08:46:44Z

Original issue description

Is your feature request related to a problem? Please describe.

The blog route is included with StudioCMS. What if a user wants to use StudioCMS independently of the theming/styling it provides? For example, using StudioCMS as a CMS on an existing website. I imagine most user's of StudioCMS will want to use StudioCMS as a backend for content without extra routes like the blog

Describe the solution you'd like

I would like to see StudioCMS be split into separate packages

A core package that provides the core functionality and a dashboard for StudioCMS
Official themes (blog, docs, etc) that use the core package as a backend for editing content

This would allow users to use the core package if they want a CMS for their own routes (like a traditional CMS), and use themes if they want to use pre-built routes for a blog, docs, etc.

This separation of packages is a perfect opportunity to migrate towards Astro Theme provider. Astro Theme Provider already has the APIs that StudioCMS needs to facilitate this migration, and it would simplify the integration code.

Describe alternatives you've considered

One alternative is to not use Astro Theme Provider, but continuing with the current structure has some problems:

The problems I have already mentioned in previous sections
No reason to re-design and engineer APIs that already exist inside of Astro Theme Provider

Additional context

I am willing to take ownership of this issue. I am looking for opinions/permission before tackling such a large change, I am available to chat if anyone has questions or wants a more detailed explanation than what I can do in text.

closes #50

[skip ci]

…nd function helpers) (#79) * Create draft PR for #78 [skip ci] * add new workflows to send messages for first time contributors * Update firsttimepr.yml * ♻️ Chore: Update Database Start page to reflect new theme and utilize batch transactions (#76) * Create draft PR for #71 [skip ci] * Update - New setup page and done page implemented. as well as some OptionsSchema cleanup * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/done.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/setup.ts Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/setup.ts Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/setup.ts Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/setup.ts Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/setup.ts Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * update as per dreyfus's comment * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Jacob Jenkins <jacob_jenkins@live.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/main.astro Co-authored-by: Jacob Jenkins <jacob_jenkins@live.com> --------- Co-authored-by: create-issue-branch[bot] <53036503+create-issue-branch[bot]@users.noreply.github.com> Co-authored-by: Adam Matthiesen <amatthiesen@outlook.com> Co-authored-by: Adam Matthiesen <30383579+Adammatthiesen@users.noreply.github.com> Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> Co-authored-by: Jacob Jenkins <jacob_jenkins@live.com> * Update firsttimepr.yml * Create draft PR for #78 [skip ci] * Chore: Update Security implementation for local username/password auth and start the process of converting the dashboad edit pages to utilitze HTMX based server rendering * new schema is working! Woo! This will give tons of future options! * more progress updates * dashboard update progress checkpoint * another progress checkpoint... dashboard is coming along nicely * fix old reference about page being a post * new helper function to get content * update so frontend doesn't cry about new schema * progress update - updated frontend to use new content helper and removed old page schema * chore: Update astro:db:setup hook in studioCMS.ts * I think everything is updated and working properly. just running tests now * Add getUserById and getUserList helper functions to the contentHelper module for retrieving user data from the Astro Studio's Database. * chore: Update registration API to validate email address before creating a new user and use it to generate a gravatar avatar for local users without oAuth * more cleanup * chore: Update StudioCMS config handling and error messages * update config and admin pages to reflect new UI changes * Update types and fix typos created from that * new navbar component working and can be customized * update navigation * Update .github/workflows/firsttimepr.yml Co-authored-by: Jacob Jenkins <jacob_jenkins@live.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/index.ts Co-authored-by: Jacob Jenkins <jacob_jenkins@live.com> * Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/databaseSetup/done.astro Co-authored-by: Jacob Jenkins <jacob_jenkins@live.com> * Update packages/studioCMS/src/components/exports/Navigation.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update packages/studioCMS/src/components/exports/Navigation.astro Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * update helptext on admins page * Update close button ID in Header component * chore: Update optionsSchema in studioCMS.ts --------- Co-authored-by: create-issue-branch[bot] <53036503+create-issue-branch[bot]@users.noreply.github.com> Co-authored-by: Adam Matthiesen <amatthiesen@outlook.com> Co-authored-by: Bryce Russell <brycetrussell@gmail.com> Co-authored-by: Adam Matthiesen <30383579+Adammatthiesen@users.noreply.github.com> Co-authored-by: Jacob Jenkins <7649031+jdtjenkins@users.noreply.github.com> Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>

…... please?

…es getting put on pages they werent supposed to be getting put on

…s instead of local file

…nternal things on the dashboard... this will make things way easier)

…custom version for now due to lack of updates)

README.md

...oCMS/src/integrations/studioCMSDashboard/routes/dashboard/pages/delete/pages/[...slug].astro

jdtjenkins · 2024-06-22T16:20:52Z

...oCMS/src/integrations/studioCMSDashboard/routes/dashboard/pages/delete/pages/[...slug].astro

+                    showSuccessToast = true;
+                })
+                // biome-ignore lint/suspicious/noExplicitAny: <explanation>
+                .catch((e: any) => {


Eventually it's probably worth thinking of some global error catching/handling/displaying mechanism, but this is fine for now.

Logic handling for these pages in regards to editing the database is to be moved to an API Endpoint for better response handling and toasting (see the start of this in the other pages, such as auth routes)

We could use the effect pattern

We could use the effect pattern

interesting... never seen that, but honestly, with Astro's API endpoints, i think those should be enough being able to return proper responses. (the current plan that I've been building towards since i have to move all the logic anyway so that its easier to interact from different dashboard pages)

...oCMS/src/integrations/studioCMSDashboard/routes/dashboard/pages/delete/pages/[...slug].astro

...dioCMS/src/integrations/studioCMSDashboard/routes/dashboard/pages/edit/pages/[...slug].astro

jdtjenkins · 2024-06-22T16:52:54Z

packages/studioCMS/src/integrations/studioCMSDashboard/routes/dashboard/pages/new/page.astro

-                        id="slug" 
-                        name="slug" 
-                        class="border-solid border-2 border-gray-300 rounded-lg p-2 w-96"
+    <div class="container">


tbh with ya, I'd like new and edit to just be the same component but just given different default values. So thatthe view, new and edit psges dont repeat the same stuff

There will be a few changes and updates with the planned API endpoint system (including trying to componentize as many of the pages that are duplicating info as possible! (and moving to astrolace now that i have that working)

Co-authored-by: Jacob Jenkins <jacob_jenkins@live.com>

…dashboard/pages/delete/pages/[...slug].astro Co-authored-by: Jacob Jenkins <jacob_jenkins@live.com>

dreyfus92

So far looking good, just a couple of comments. 😁

dreyfus92 · 2024-06-23T00:02:42Z

...oCMS/src/integrations/studioCMSDashboard/routes/dashboard/pages/delete/pages/[...slug].astro

+                    showSuccessToast = true;
+                })
+                // biome-ignore lint/suspicious/noExplicitAny: <explanation>
+                .catch((e: any) => {


We could use the effect pattern

...es/studioCMS/src/integrations/studioCMSDashboard/routes/dashboard/partials/LivePreview.astro

dreyfus92

LGTM, but i think you still gotta resolve conflicts on your branch 😁

jdtjenkins

Approving for now! Let's get it out, anything else can be fixed later!

Looks really good @Adammatthiesen , incredible work

Adammatthiesen · 2024-06-26T11:10:50Z

!coauthors

Adammatthiesen · 2024-06-26T11:11:50Z

!coauthor

github-actions · 2024-06-26T11:12:02Z

Co-authored-by: Adam Matthiesen <30383579+Adammatthiesen@users.noreply.github.com>
Co-authored-by: Jacob Jenkins <7649031+jdtjenkins@users.noreply.github.com>
Co-authored-by: Luiz Ferraz <luiz@lferraz.com>
Co-authored-by: Bryce Russell <brycetrussell@gmail.com>
Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>

Create draft PR for #50

cca3823

[skip ci]

create-issue-branch bot added enhancement New feature or request feat refactor labels May 11, 2024

create-issue-branch bot assigned BryceRussell May 11, 2024

create-issue-branch bot changed the title ~~Separation of logic: migrating to Astro Theme Provider~~ ✨ Separation of logic: migrating to Astro Theme Provider May 11, 2024

Adammatthiesen self-assigned this May 11, 2024

Adammatthiesen mentioned this pull request May 11, 2024

Chore: Setup new Table Schemas, and Implement Helpers (component and function helpers) #78

Closed

create-issue-branch bot mentioned this pull request May 11, 2024

♻️ Chore: Setup new Table Schemas, and Implement Helpers (component and function helpers) #79

Merged

Adammatthiesen linked an issue May 11, 2024 that may be closed by this pull request

Chore: Setup new Table Schemas, and Implement Helpers (component and function helpers) #78

Closed

Adammatthiesen removed a link to an issue May 11, 2024

Chore: Setup new Table Schemas, and Implement Helpers (component and function helpers) #78

Closed

Adammatthiesen added this to the ATP Migration milestone May 11, 2024

Adammatthiesen and others added 18 commits May 18, 2024 08:10

Merge branch 'main' into issue-0050

42bcf93

progress checkpoint... frontend moved, blog package created

94bf9c7

chore: Update dependencies and paths in tsconfig files

e68eb7c

chore: Update dependencies and paths in tsconfig files

a176dd4

Progress checkpoint.... its working.... someone tell me im not crazy.…

a23eea7

…... please?

ASTROENV!!!!!

8243eef

Some more Astro:ENV

eff9989

Some more cleanup

315aa69

Some more work and cleanup

07315c2

progress checkpoint

d31bdba

Buahahaha i fixed the typing stuffs

a1129f8

cleanup, and some new helpers as well as fixes to some weird CSS styl…

3be989d

…es getting put on pages they werent supposed to be getting put on

update, and progress checkpoint

c2a2a9b

new header system

6adcb9d

fix tsconfig

8ad5b16

cleanup dts file

f7486b8

AIK Utilities... makes things cleaner

4d73158

Adammatthiesen added 3 commits June 20, 2024 01:36

update icons - i found a better source for MOST of our dashboard icon…

950eab9

…s instead of local file

unocss cleanup and fix darkmode selector (used by only a few of the i…

aa377a3

…nternal things on the dashboard... this will make things way easier)

update deps, and fix auth tables to align with lucia-astrodb-adapter(…

072daa5

…custom version for now due to lack of updates)

Adammatthiesen requested review from dreyfus92 and jdtjenkins June 21, 2024 02:11

jdtjenkins reviewed Jun 22, 2024

View reviewed changes

Adammatthiesen and others added 4 commits June 22, 2024 15:05

Update README.md

884b7c9

Co-authored-by: Jacob Jenkins <jacob_jenkins@live.com>

Update packages/studioCMS/src/integrations/studioCMSDashboard/routes/…

bdeb532

…dashboard/pages/delete/pages/[...slug].astro Co-authored-by: Jacob Jenkins <jacob_jenkins@live.com>

update as per jumper requests

856bc18

use container API to render post content for RSS feed

2748a92

dreyfus92 reviewed Jun 23, 2024

View reviewed changes

Adammatthiesen added 2 commits June 22, 2024 17:34

page partial bug resolved

e146d7e

cleanup names on rssfeed, rss feed is much simplier now

68010d2

Adammatthiesen requested review from dreyfus92 and jdtjenkins June 23, 2024 13:29

dreyfus92 approved these changes Jun 24, 2024

View reviewed changes

Adammatthiesen added 2 commits June 24, 2024 01:09

new const var for SiteConfigId as per jumper request

3810634

do not show delete button as jumper request

b8f4d1a

jdtjenkins approved these changes Jun 26, 2024

View reviewed changes

Adammatthiesen and others added 4 commits June 26, 2024 02:50

Merge branch 'main' into issue-0050

368a206

fix lockfile and dupped package.json

6350937

remove exclusion

c796b7a

disable studioCMSBlog due to weird fserror

8a97f2d

Adammatthiesen merged commit f006a0d into main Jun 26, 2024
1 check passed

Adammatthiesen removed this from the ATP Migration milestone Jun 30, 2024

Adammatthiesen deleted the issue-0050 branch July 3, 2024 13:21

create-issue-branch bot mentioned this pull request Jul 23, 2024

📝 First beta #189

Merged

17 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Separation of logic: migrating to Astro Theme Provider #77

✨ Separation of logic: migrating to Astro Theme Provider #77

create-issue-branch bot commented May 11, 2024

jdtjenkins Jun 22, 2024

Adammatthiesen Jun 22, 2024

dreyfus92 Jun 23, 2024

Adammatthiesen Jun 23, 2024

jdtjenkins Jun 22, 2024

Adammatthiesen Jun 22, 2024

dreyfus92 left a comment

dreyfus92 Jun 23, 2024

dreyfus92 left a comment

jdtjenkins left a comment

Adammatthiesen commented Jun 26, 2024

Adammatthiesen commented Jun 26, 2024

github-actions bot commented Jun 26, 2024

✨ Separation of logic: migrating to Astro Theme Provider #77

✨ Separation of logic: migrating to Astro Theme Provider #77

Conversation

create-issue-branch bot commented May 11, 2024

jdtjenkins Jun 22, 2024

Choose a reason for hiding this comment

Adammatthiesen Jun 22, 2024

Choose a reason for hiding this comment

dreyfus92 Jun 23, 2024

Choose a reason for hiding this comment

Adammatthiesen Jun 23, 2024

Choose a reason for hiding this comment

jdtjenkins Jun 22, 2024

Choose a reason for hiding this comment

Adammatthiesen Jun 22, 2024

Choose a reason for hiding this comment

dreyfus92 left a comment

Choose a reason for hiding this comment

dreyfus92 Jun 23, 2024

Choose a reason for hiding this comment

dreyfus92 left a comment

Choose a reason for hiding this comment

jdtjenkins left a comment

Choose a reason for hiding this comment

Adammatthiesen commented Jun 26, 2024

Adammatthiesen commented Jun 26, 2024

github-actions bot commented Jun 26, 2024