studiocms 0.1.0-beta.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Astrolicious - StudioCMS - Adam Matthiesen, Jacob Jenkins, Paul Valladares
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,138 @@
+# Introducing AstroStudio CMS: A Community-Driven CMS for Astro Studio
+
+As part of our efforts, we're excited to introduce AstroStudio CMS - a dedicated content management system (CMS) built on top of Astro's latest product, [Astro Studio](https://studio.astro.build). This project was developed by [Adam](https://github.com/Adammatthiesen), [Dreyfus](https://github.com/dreyfus92), and [Jumper](https://github.com/jdtjenkins), three passionate members of the Astro community.
+
+## Why another CMS?
+
+While Astro's content capabilities are powerful, we recognized a need for a more streamlined and user-friendly CMS solution within the Astro ecosystem. Many Astro users, especially those coming from more traditional CMS backgrounds, have expressed a desire for a dedicated CMS that can seamlessly integrate with Astro projects.
+
+AstroStudio CMS was born out of this need, providing a content management platform that is tailor-made for Astro. By building on top of Astro Studio, we're able to offer a CMS experience that feels native to the Astro workflow, making it easier for both developers and content creators to collaborate on Astro-powered projects.
+
+## An Experimental Endeavor
+
+It's important to note that AstroStudio CMS is an experimental project that heavily relies on the @astrojs/db package, which is currently in active development and not yet considered stable. As a result, you should expect a significant number of breaking changes as the project continues to evolve.
+
+We believe that by building on the cutting-edge features of Astro Studio, we can create a powerful and innovative CMS solution. However, this also means that AstroStudio CMS may not be suitable for mission-critical or production-ready projects at this stage. We encourage you to use caution and thoroughly test the CMS in your own projects before deploying it to a live environment.
+
+
+## Leveraging the Power of Astro
+
+AstroStudio CMS is built from the ground up to seamlessly integrate with Astro's robust and efficient framework. By harnessing the power of Astro, we've created a CMS solution that aligns perfectly with the Astro ecosystem, providing a solid foundation for building and scaling Astro-powered applications.
+
+## Key Features
+
+**Astro Foundation:** Astrolicious leverages Astro's robust and efficient framework, providing a solid base for building and scaling applications.
+
+**Enhanced Markdown:** We've incorporated 'Marked' with support for extensions, enriching the markdown experience with greater flexibility and functionality.
+
+**Shiki Syntax Highlighting:** Astrolicious offers Shiki-powered syntax highlighting, ensuring your code is both visually appealing and easy to read. This is especially useful in non-Cloudflare environments due to bundle size considerations.
+
+**Markdoc Integration:** In addition to 'Marked', Astrolicious provides an alternative with Markdoc, offering users a choice for their markdown processing needs.
+
+**Secure Studio Database:** All data is securely housed within the Astro Studio database, ensuring accessibility only to authorized users with studio.astro.build login credentials.
+
+**Built-in Authentication:** Astrolicious features built-in authentication with support for multiple platforms, including Local and Github, enhancing security and user management (currently in development).
+
+**Unpic Image Service:** Astrolicious includes a free and efficient image service, Unpic, which makes managing external URLs straightforward, with support for major CDNs.
+
+## A Community-Driven Effort
+
+At the heart of Astrolicious is a deep commitment to community involvement and collaboration. We believe that the development of AstroStudio CMS should be a collective effort, drawing on the diverse talents and perspectives of the Astro community.
+
+To that end, we've handed the repository Astrolicious as an open organization, welcoming contributors of all skill levels to get involved and help shape the future of this CMS. Whether you're a seasoned Astro developer or new to the ecosystem, we encourage you to join our [Discord server](https://chat.astrolicious.dev/) and explore ways to contribute.
+
+By fostering a sense of shared ownership and investment, we aim to create a CMS that truly reflects the needs and desires of the Astro community. Your feedback, ideas, and code contributions will be invaluable as we work to build a feature-rich and user-friendly content management solution for Astro.
+
+So don't be a stranger - come join us on this journey and help us realize the full potential of AstroStudio CMS!
+
+# Installation
+
+Start from a clean Astro installation with AstroDB
+
+Example with pnpm
+
+```sh
+# create a new project with pnpm
+pnpm create astro@latest
+```
+
+```sh
+# add astrodb
+pnpm astro add db
+```
+
+```sh
+# Add Astro-Studio-CMS
+pnpm astro add @astrolicious/studiocms
+```
+
+## Authentication
+
+Lucia Auth - requires two .env tokens to create the connection between Github and your Auth
+
+```
+# credentials for GitHub OAuth App
+CMS_GITHUB_CLIENT_ID=
+CMS_GITHUB_CLIENT_SECRET=
+
+# OPTIONALS
+## Cloudinary Javascript SDK
+CMS_CLOUDINARY_CLOUDNAME="demo"
+```
+
+When you setup the Github Oauth App for these keys use the following for the setup:
+
+For Local dev to work:
+
+Homepage URL: http://localhost:4321
+Authorization callback URL: http://localhost:4321/dashboard/login/github/callback
+
+For going to Production:
+
+Homepage URL: https://example.com
+Authorization callback URL: https://example.com/dashboard/login/github/callback
+
+## Configuration
+
+Your `astro.config.mjs` should look like the following
+
+> Note: Admins are currently defined by their Github Usernames!
+
+```mjs
+import { defineConfig } from "astro/config";
+import studioCMS from "@astrolicious/studiocms";
+import db from '@astrojs/db';
+import node from "@astrojs/node";
+
+// https://astro.build/config
+export default defineConfig({
+	site: 'https://example.com',
+	output: "server",
+	adapter: node({ mode: 'standalone' }),
+	integrations: [
+	        db(),
+	        studioCMS({
+	            dbStartPage: true // DEFAULT - This injects a start page to setup your DB data.
+	        })
+	],
+});
+```
+
+## First Start and setup
+
+This project is designed to be setup to a new Studio DB, to get started follow the [Link to Astro Studio](https://docs.astro.build/en/recipes/studio/#create-a-new-studio-project)
+
+*Note: `astrojs/db` does not currently maintain all database data without a [seed file](https://docs.astro.build/en/guides/astro-db/#seed-your-database) which would not work with the CMS. Until a local database is persistant between sessions we highly recommend connecting to a remote DB to allow for data to persist*
+
+Commands to run:
+- `astro db link` - Link to Astro Studio and Create a new DB for your CMS Installation
+- `astro db push` - Creates the base tables on the remote database.
+- `astro dev --remote` - Starts the Dev server connected to the linked database
+
+Once that process completes successfuly you are ready to navigate to http://localhost:4321/start and follow the instructions to get started.
+
+It will redirect and ask you to shutdown and change the above mentioned config option `dbStartPage` to `false` at which point that will enable full functionality of the CMS. you can now restart the dev server with `astro dev --remote` to continue viewing your new site!
+
+## Get Involved
+
+As members of [Astrolicious](https://github.com/astrolicious) we are a free and open-source project, and we welcome contributions from the Astro community. If you're interested in getting involved, please visit our [GitHub repository](https://github.com/astrolicious/studiocms) and join our [Discord server](https://chat.astrolicious.dev/). Together, let's build an even stronger and more vibrant Astro ecosystem.

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "studiocms",
+  "version": "0.1.0-beta.5",
+  "description": "A dedicated CMS for Astro Studio. Built from the ground up by the Astro community.",
+  "author": {
+    "name": "Adam Matthiesen | Jacob Jenkins | Paul Valladares",
+    "url": "https://astro-studiocms.xyz"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/astrolicious/studiocms.git"
+  },
+  "contributors": [
+    "Adammatthiesen",
+    "jdtjenkins",
+    "dreyfus92"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "astro",
+    "astrocms",
+    "astrodb",
+    "astrolicious",
+    "astrostudio",
+    "astro-integration",
+    "astro-studio",
+    "astro-studiocms",
+    "cms",
+    "studiocms",
+    "withastro"
+  ],
+  "homepage": "https://astro-studiocms.xyz",
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "files": [
+    "src"
+  ],
+  "exports": {
+    ".": "./src/index.ts",
+    "./blog": "./src/blog/index.ts"
+  },
+  "type": "module",
+  "dependencies": {
+    "@cloudinary/url-gen": "^1.19.0",
+    "@inox-tools/runtime-logger": "^0.3.1",
+    "@matthiesenxyz/astrolace": "^0.3.2",
+    "@matthiesenxyz/integration-utils": "^0.2.0",
+    "@matthiesenxyz/unocss-preset-daisyui": "^0.1.2",
+    "@shikijs/transformers": "^1.14.1",
+    "@noble/hashes": "^1.4.0",
+    "@unpic/astro": "^0.0.46",
+    "micromatch": "^4.0.7",
+    "lucia": "^3.2.0",
+    "arctic": "^1.9.1",
+    "@unocss/astro": "^0.62.3",
+    "@unocss/reset": "^0.62.3",
+    "astro-integration-kit": "^0.16.1",
+    "daisyui": "^4.12.10",
+    "marked": "^13.0.2",
+    "marked-alert": "^2.0.1",
+    "marked-emoji": "^1.4.1",
+    "marked-footnote": "^1.2.2",
+    "marked-shiki": "^1.1.0",
+    "marked-smartypants": "^1.1.7",
+    "mrmime": "^2.0.0",
+    "shiki": "^1.14.1",
+    "semver": "^7.6.3",
+    "package-json": "^10.0.1",
+    "unpic": "^3.18.0",
+    "unocss": "^0.62.3",
+    "@studiocms/assets": "0.1.0-beta.5",
+    "@studiocms/auth": "0.1.0-beta.5",
+    "@studiocms/betaresources": "0.1.0-beta.5",
+    "@studiocms/core": "0.1.0-beta.5",
+    "@studiocms/dashboard": "0.1.0-beta.5",
+    "@studiocms/frontend": "0.1.0-beta.5",
+    "@studiocms/imagehandler": "0.1.0-beta.5",
+    "@studiocms/renderers": "0.1.0-beta.5",
+    "@studiocms/robotstxt": "0.1.0-beta.5"
+  },
+  "peerDependencies": {
+    "@astrojs/db": ">=0.14",
+    "astro": ">=4.15",
+    "@studiocms/blog": "0.1.0-beta.5"
+  },
+  "peerDependenciesMeta": {
+    "@studiocms/blog": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "vite": "^5.4.2",
+    "typescript": "^5.5.4",
+    "@types/micromatch": "^4.0.9",
+    "@types/semver": "^7.5.8"
+  }
+}

package/src/blog/index.ts

@@ -0,0 +1,35 @@
+import studioCMSBlog from '@studiocms/blog';
+
+/**
+ * # StudioCMS Blog Theme(Integration)
+ * *Note: To use this export, you must have `@studiocms/blog` installed in your project dependencies.*
+ * #### Powered by [`astro-theme-provider`](https://github.com/astrolicious/astro-theme-provider) by [Bryce Russell](https://github.com/BryceRussell)
+ *
+ * This theme provides a Blog Index Page and RSS Feed for your StudioCMS Site as well as route handling for Blog Posts.
+ *
+ * @example
+ * import { defineConfig } from 'astro/config';
+ * import db from '@astrojs/db';
+ * import studioCMS from 'studiocms';
+ * import studioCMSBlog from 'studiocms/blog';
+ *
+ * // https://astro.build/config
+ * export default defineConfig({
+ *   site: "https://example.com",
+ *   output: "server",
+ *   adapter: ...
+ *   integrations: [
+ *     db(), // REQUIRED - `@astrojs/db` must be included in the integrations list
+ *     studioCMS(), // REQUIRED - StudioCMS must be included in the integrations list
+ *     studioCMSBlog({
+ *       config: {
+ *         title: "My StudioCMS Blog",
+ *         description: "A Simple Blog build with Astro, Astrojs/DB, and StudioCMS.".
+ *       },
+ *     }),
+ *   ],
+ * });
+ */
+const integration = studioCMSBlog;
+
+export default integration;

package/src/index.ts

@@ -0,0 +1,25 @@
+import { defineStudioCMSConfig, defineStudioCMSPlugin } from '@studiocms/core/lib';
+import type { StudioCMSPluginOptions } from '@studiocms/core/types';
+import integration from './integration';
+
+/**
+ * # Astro Studio CMS Integration
+ *
+ * A CMS built for Astro by the Astro Community for the Astro Community.
+ *
+ * Checkout our [GitHub Repo `@astrolicious/studiocms`](https://github.com/astrolicious/studiocms)
+ *
+ * Check out [Astro-StudioCMS.xyz](https://astro-studiocms.xyz) or the Built-in JSDocs *(Hover Docs like this)* for more information.
+ *
+ * > **Note: Astro SSR adapters that are configured for Image Optimization will automatically take full control of the Image Optimization Service. Making the `imageService` option in this integration not have any effect.**
+ *
+ */
+export const studioCMS = integration;
+
+export default studioCMS;
+
+// Config Utility
+export { defineStudioCMSConfig };
+
+// Plugin System
+export { defineStudioCMSPlugin, type StudioCMSPluginOptions };

package/src/integration.ts

@@ -0,0 +1,94 @@
+import { addIntegrationArray } from '@matthiesenxyz/integration-utils/aikUtils';
+import {
+	integrationLogger,
+	nodeNamespaceBuiltinsAstro,
+} from '@matthiesenxyz/integration-utils/astroUtils';
+import studioCMSAuth from '@studiocms/auth';
+import studioCMSCore from '@studiocms/core';
+import { getStudioConfigFileUrl, studioCMSPluginList } from '@studiocms/core/lib';
+import {
+	type StudioCMSOptions,
+	StudioCMSOptionsSchema as optionsSchema,
+} from '@studiocms/core/schemas';
+import { CoreStrings, robotsTXTPreset } from '@studiocms/core/strings';
+import {
+	addIntegrationArrayWithCheck,
+	checkAstroConfig,
+	configResolver,
+} from '@studiocms/core/utils';
+import studioCMSDashboard from '@studiocms/dashboard';
+import studioCMSFrontend from '@studiocms/frontend';
+import studiocmsImageHandler from '@studiocms/imagehandler';
+import studiocmsRenderers from '@studiocms/renderers';
+import studioCMSRobotsTXT from '@studiocms/robotstxt';
+import { defineIntegration } from 'astro-integration-kit';
+import { name, version } from '../package.json';
+import { updateCheck } from './updateCheck';
+
+// Main Integration
+export default defineIntegration({
+	name,
+	optionsSchema,
+	setup({ name, options }) {
+		// Register StudioCMS into the StudioCMS Plugin List
+		studioCMSPluginList.set(name, { name, label: 'StudioCMS' });
+
+		// Resolve Options
+		let resolvedOptions: StudioCMSOptions;
+
+		return {
+			hooks: {
+				// Configure `@astrojs/db` integration to include the StudioCMS Database Tables
+				'astro:db:setup': ({ extendDb }) => {
+					extendDb({ configEntrypoint: '@studiocms/core/db/config' });
+				},
+				'astro:config:setup': async (params) => {
+					// Destructure Params
+					const { config: astroConfig, addWatchFile, logger } = params;
+
+					// Watch the StudioCMS Config File for changes (including creation/deletion)
+					addWatchFile(getStudioConfigFileUrl(astroConfig.root));
+
+					// Resolve Options
+					resolvedOptions = await configResolver(params, options);
+
+					// Setup Logger
+					integrationLogger(
+						{ logger, logLevel: 'info', verbose: resolvedOptions.verbose },
+						CoreStrings.Start
+					);
+
+					// Check Astro Config for required settings
+					checkAstroConfig(params);
+
+					// Setup Integrations (Internal)
+					addIntegrationArray(params, [
+						{ integration: nodeNamespaceBuiltinsAstro() },
+						{ integration: studioCMSCore(resolvedOptions) },
+						{ integration: studioCMSFrontend(resolvedOptions) },
+						{ integration: studiocmsImageHandler(resolvedOptions) },
+						{ integration: studiocmsRenderers() },
+						{ integration: studioCMSAuth(resolvedOptions) },
+						{ integration: studioCMSDashboard(resolvedOptions) },
+					]);
+
+					// Setup Integrations (External / Optional)
+					addIntegrationArrayWithCheck(params, [
+						{
+							enabled: resolvedOptions.includedIntegrations.useAstroRobots,
+							knownSimilar: ['astro-robots', 'astro-robots-txt'],
+							integration: studioCMSRobotsTXT({
+								...robotsTXTPreset,
+								...resolvedOptions.includedIntegrations.astroRobotsConfig,
+							}),
+						},
+					]);
+				},
+				'astro:server:start': async (params) => {
+					// Check for Updates on Development Server Start
+					updateCheck(params, name, version);
+				},
+			},
+		};
+	},
+});

package/src/updateCheck.ts

@@ -0,0 +1,51 @@
+import { defineUtility } from 'astro-integration-kit';
+import packageJson from 'package-json';
+import * as semver from 'semver';
+
+/**
+ * Fetches the latest version of a package from the npm registry.
+ * @param packageName - The name of the package.
+ * @returns A promise that resolves to the latest version of the package.
+ */
+async function fetchlatestVersion(packageName: string): Promise<string> {
+	const { version } = await packageJson(packageName.toLowerCase());
+	return version;
+}
+
+/**
+ * Checks for updates of a specified package on npm registry.
+ * @param {import("astro").HookParameters<"astro:config:setup">} params - The Astro parameters object.
+ * @param currentVersion - The current version of the package.
+ */
+export const updateCheck = defineUtility('astro:server:start')(
+	async (params, name: string, currentVersion: string): Promise<void> => {
+		const logger = params.logger.fork(`${name}:update-check`);
+
+		try {
+			const latestVersion = await fetchlatestVersion(name);
+
+			const comparison = semver.compare(currentVersion, latestVersion);
+
+			if (comparison === -1) {
+				logger.warn(
+					`A new version of 'studiocms' is available. Please update to ${latestVersion} using your favorite package manager.`
+				);
+			} else if (comparison === 0) {
+				logger.info(`You are using the latest version of '${name}' (${currentVersion})`);
+			} else {
+				logger.info(
+					`You are using a newer version (${currentVersion}) of '${name}' than the latest release (${latestVersion})`
+				);
+			}
+		} catch (error) {
+			if (error instanceof Error) {
+				logger.error(`Error fetching latest version from npm registry: ${error.message}`);
+			} else {
+				// Handle the case where error is not an Error object
+				logger.error(
+					'An unknown error occurred while fetching the latest version from the npm registry.'
+				);
+			}
+		}
+	}
+);