studiocms 0.1.0-beta.10

package/dist/schemas/config/dashboard.d.ts

@@ -0,0 +1,154 @@
+import { z } from 'astro/zod';
+export declare const dashboardConfigSchema: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+    /**
+     * OPTIONAL - This allows the user to enable or disable the Astro StudioCMS dashboard but still provide all the helper's and utilities to those who are customizing their setup, doing so will disable the dashboard and you will need to manage your content via your database
+     *
+     * @default true
+     */
+    dashboardEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    /**
+     * OPTIONAL - This allows the user to enable or disable the default 404 route for the dashboard
+     *
+     * @default true
+     */
+    inject404Route: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    /**
+     * OPTIONAL - This allows the user to override the default Favicon URL to a custom URL
+     */
+    faviconURL: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    /**
+     * OPTIONAL - This allows the user to override the default dashboard route to a custom route
+     *
+     * **Note: Use with caution, this is an advanced feature**
+     *
+     * @usage - The default route is `dashboard` without any `/` or `\` characters. If you want to override the route to `/admin` you would set this value to `admin`
+     *
+     * @default "dashboard"
+     */
+    dashboardRouteOverride: z.ZodOptional<z.ZodString>;
+    /**
+     * Auth Configuration - Allows customization of the Authentication Configuration
+     */
+    AuthConfig: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        providers: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            github: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            discord: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            google: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            auth0: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            usernameAndPassword: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            usernameAndPasswordConfig: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+                allowUserRegistration: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            }, "strip", z.ZodTypeAny, {
+                allowUserRegistration: boolean;
+            }, {
+                allowUserRegistration?: boolean | undefined;
+            }>>>;
+        }, "strip", z.ZodTypeAny, {
+            github: boolean;
+            discord: boolean;
+            google: boolean;
+            auth0: boolean;
+            usernameAndPassword: boolean;
+            usernameAndPasswordConfig: {
+                allowUserRegistration: boolean;
+            };
+        }, {
+            github?: boolean | undefined;
+            discord?: boolean | undefined;
+            google?: boolean | undefined;
+            auth0?: boolean | undefined;
+            usernameAndPassword?: boolean | undefined;
+            usernameAndPasswordConfig?: {
+                allowUserRegistration?: boolean | undefined;
+            } | undefined;
+        }>>>;
+        enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        providers: {
+            github: boolean;
+            discord: boolean;
+            google: boolean;
+            auth0: boolean;
+            usernameAndPassword: boolean;
+            usernameAndPasswordConfig: {
+                allowUserRegistration: boolean;
+            };
+        };
+        enabled: boolean;
+    }, {
+        providers?: {
+            github?: boolean | undefined;
+            discord?: boolean | undefined;
+            google?: boolean | undefined;
+            auth0?: boolean | undefined;
+            usernameAndPassword?: boolean | undefined;
+            usernameAndPasswordConfig?: {
+                allowUserRegistration?: boolean | undefined;
+            } | undefined;
+        } | undefined;
+        enabled?: boolean | undefined;
+    }>>>;
+    /**
+     * Developer Options/Configuration
+     */
+    developerConfig: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        testingAndDemoMode: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        testingAndDemoMode: boolean;
+    }, {
+        testingAndDemoMode?: boolean | undefined;
+    }>>>;
+    /**
+     * OPTIONAL - This allows the user to enable or disable the version check for the dashboard
+     *
+     * This will check for the latest version of StudioCMS and notify the user
+     * if there is a new version available.
+     *
+     * @default true
+     */
+    versionCheck: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    dashboardEnabled: boolean;
+    inject404Route: boolean;
+    faviconURL: string;
+    AuthConfig: {
+        providers: {
+            github: boolean;
+            discord: boolean;
+            google: boolean;
+            auth0: boolean;
+            usernameAndPassword: boolean;
+            usernameAndPasswordConfig: {
+                allowUserRegistration: boolean;
+            };
+        };
+        enabled: boolean;
+    };
+    developerConfig: {
+        testingAndDemoMode: boolean;
+    };
+    versionCheck: boolean;
+    dashboardRouteOverride?: string | undefined;
+}, {
+    dashboardEnabled?: boolean | undefined;
+    inject404Route?: boolean | undefined;
+    faviconURL?: string | undefined;
+    dashboardRouteOverride?: string | undefined;
+    AuthConfig?: {
+        providers?: {
+            github?: boolean | undefined;
+            discord?: boolean | undefined;
+            google?: boolean | undefined;
+            auth0?: boolean | undefined;
+            usernameAndPassword?: boolean | undefined;
+            usernameAndPasswordConfig?: {
+                allowUserRegistration?: boolean | undefined;
+            } | undefined;
+        } | undefined;
+        enabled?: boolean | undefined;
+    } | undefined;
+    developerConfig?: {
+        testingAndDemoMode?: boolean | undefined;
+    } | undefined;
+    versionCheck?: boolean | undefined;
+}>>>;

package/dist/schemas/config/dashboard.js

@@ -0,0 +1,59 @@
+import { z } from "astro/zod";
+import { authConfigSchema } from "./auth.js";
+import { developerConfigSchema } from "./developer.js";
+const dashboardConfigSchema = z.object({
+  /**
+   * OPTIONAL - This allows the user to enable or disable the Astro StudioCMS dashboard but still provide all the helper's and utilities to those who are customizing their setup, doing so will disable the dashboard and you will need to manage your content via your database
+   *
+   * @default true
+   */
+  dashboardEnabled: z.boolean().optional().default(true),
+  // /**
+  //  * This allows the user when in `output: "server"` mode with Astro to enable or disable the prerendering of the dashboard
+  //  *
+  //  * **Note: This is only applicable when using Astro in server mode in static(hybrid) mode, this will be `true`**
+  //  *
+  //  * @default true
+  //  */
+  // prerender: z.boolean().optional().default(true),
+  /**
+   * OPTIONAL - This allows the user to enable or disable the default 404 route for the dashboard
+   *
+   * @default true
+   */
+  inject404Route: z.boolean().optional().default(true),
+  /**
+   * OPTIONAL - This allows the user to override the default Favicon URL to a custom URL
+   */
+  faviconURL: z.string().optional().default("/favicon.svg"),
+  /**
+   * OPTIONAL - This allows the user to override the default dashboard route to a custom route
+   *
+   * **Note: Use with caution, this is an advanced feature**
+   *
+   * @usage - The default route is `dashboard` without any `/` or `\` characters. If you want to override the route to `/admin` you would set this value to `admin`
+   *
+   * @default "dashboard"
+   */
+  dashboardRouteOverride: z.string().optional(),
+  /**
+   * Auth Configuration - Allows customization of the Authentication Configuration
+   */
+  AuthConfig: authConfigSchema,
+  /**
+   * Developer Options/Configuration
+   */
+  developerConfig: developerConfigSchema,
+  /**
+   * OPTIONAL - This allows the user to enable or disable the version check for the dashboard
+   *
+   * This will check for the latest version of StudioCMS and notify the user
+   * if there is a new version available.
+   *
+   * @default true
+   */
+  versionCheck: z.boolean().optional().default(true)
+}).optional().default({});
+export {
+  dashboardConfigSchema
+};

package/dist/schemas/config/defaultFrontend.d.ts

@@ -0,0 +1,125 @@
+import { z } from 'astro/zod';
+export declare const HeadConfigSchema: () => z.ZodDefault<z.ZodArray<z.ZodObject<{
+    /** Name of the HTML tag to add to `<head>`, e.g. `'meta'`, `'link'`, or `'script'`. */
+    tag: z.ZodEnum<["title", "base", "link", "style", "meta", "script", "noscript", "template"]>;
+    /** Attributes to set on the tag, e.g. `{ rel: 'stylesheet', href: '/custom.css' }`. */
+    attrs: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodUndefined]>>>;
+    /** Content to place inside the tag (optional). */
+    content: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    content: string;
+    tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+    attrs: Record<string, string | boolean | undefined>;
+}, {
+    tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+    content?: string | undefined;
+    attrs?: Record<string, string | boolean | undefined> | undefined;
+}>, "many">>;
+export type HeadUserConfig = z.input<ReturnType<typeof HeadConfigSchema>>;
+export type HeadConfig = z.output<ReturnType<typeof HeadConfigSchema>>;
+export declare const FrontEndConfigSchema: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+    /**
+     * HTML Default Language - The default language for the HTML tag
+     * @default 'en'
+     */
+    htmlDefaultLanguage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    /**
+     * HTML Default Header - The default head configuration for the Frontend
+     */
+    htmlDefaultHead: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        /** Name of the HTML tag to add to `<head>`, e.g. `'meta'`, `'link'`, or `'script'`. */
+        tag: z.ZodEnum<["title", "base", "link", "style", "meta", "script", "noscript", "template"]>;
+        /** Attributes to set on the tag, e.g. `{ rel: 'stylesheet', href: '/custom.css' }`. */
+        attrs: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodUndefined]>>>;
+        /** Content to place inside the tag (optional). */
+        content: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        content: string;
+        tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+        attrs: Record<string, string | boolean | undefined>;
+    }, {
+        tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+        content?: string | undefined;
+        attrs?: Record<string, string | boolean | undefined> | undefined;
+    }>, "many">>;
+    /**
+     * Favicon Configuration - The default favicon configuration for the Frontend
+     */
+    favicon: z.ZodDefault<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+    /**
+     * Enable Quick Actions Menu - Whether to enable the quick actions menu
+     * @default true
+     */
+    injectQuickActionsMenu: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    htmlDefaultLanguage: string;
+    htmlDefaultHead: {
+        content: string;
+        tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+        attrs: Record<string, string | boolean | undefined>;
+    }[];
+    favicon: string;
+    injectQuickActionsMenu: boolean;
+}, {
+    htmlDefaultLanguage?: string | undefined;
+    htmlDefaultHead?: {
+        tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+        content?: string | undefined;
+        attrs?: Record<string, string | boolean | undefined> | undefined;
+    }[] | undefined;
+    favicon?: string | undefined;
+    injectQuickActionsMenu?: boolean | undefined;
+}>>>;
+export declare const DefaultFrontEndConfigSchema: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodDefault<z.ZodOptional<z.ZodObject<{
+    /**
+     * HTML Default Language - The default language for the HTML tag
+     * @default 'en'
+     */
+    htmlDefaultLanguage: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    /**
+     * HTML Default Header - The default head configuration for the Frontend
+     */
+    htmlDefaultHead: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        /** Name of the HTML tag to add to `<head>`, e.g. `'meta'`, `'link'`, or `'script'`. */
+        tag: z.ZodEnum<["title", "base", "link", "style", "meta", "script", "noscript", "template"]>;
+        /** Attributes to set on the tag, e.g. `{ rel: 'stylesheet', href: '/custom.css' }`. */
+        attrs: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodUndefined]>>>;
+        /** Content to place inside the tag (optional). */
+        content: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        content: string;
+        tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+        attrs: Record<string, string | boolean | undefined>;
+    }, {
+        tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+        content?: string | undefined;
+        attrs?: Record<string, string | boolean | undefined> | undefined;
+    }>, "many">>;
+    /**
+     * Favicon Configuration - The default favicon configuration for the Frontend
+     */
+    favicon: z.ZodDefault<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+    /**
+     * Enable Quick Actions Menu - Whether to enable the quick actions menu
+     * @default true
+     */
+    injectQuickActionsMenu: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    htmlDefaultLanguage: string;
+    htmlDefaultHead: {
+        content: string;
+        tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+        attrs: Record<string, string | boolean | undefined>;
+    }[];
+    favicon: string;
+    injectQuickActionsMenu: boolean;
+}, {
+    htmlDefaultLanguage?: string | undefined;
+    htmlDefaultHead?: {
+        tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+        content?: string | undefined;
+        attrs?: Record<string, string | boolean | undefined> | undefined;
+    }[] | undefined;
+    favicon?: string | undefined;
+    injectQuickActionsMenu?: boolean | undefined;
+}>>>, z.ZodBoolean]>>>;

package/dist/schemas/config/defaultFrontend.js

@@ -0,0 +1,57 @@
+import { extname } from "node:path";
+import { z } from "astro/zod";
+const HeadConfigSchema = () => z.array(
+  z.object({
+    /** Name of the HTML tag to add to `<head>`, e.g. `'meta'`, `'link'`, or `'script'`. */
+    tag: z.enum(["title", "base", "link", "style", "meta", "script", "noscript", "template"]),
+    /** Attributes to set on the tag, e.g. `{ rel: 'stylesheet', href: '/custom.css' }`. */
+    attrs: z.record(z.union([z.string(), z.boolean(), z.undefined()])).default({}),
+    /** Content to place inside the tag (optional). */
+    content: z.string().default("")
+  })
+).default([]);
+const faviconTypeMap = {
+  ".ico": "image/x-icon",
+  ".gif": "image/gif",
+  ".jpeg": "image/jpeg",
+  ".jpg": "image/jpeg",
+  ".png": "image/png",
+  ".svg": "image/svg+xml"
+};
+function isFaviconExt(ext) {
+  return ext in faviconTypeMap;
+}
+const FrontEndConfigSchema = z.object({
+  /**
+   * HTML Default Language - The default language for the HTML tag
+   * @default 'en'
+   */
+  htmlDefaultLanguage: z.string().optional().default("en"),
+  /**
+   * HTML Default Header - The default head configuration for the Frontend
+   */
+  htmlDefaultHead: HeadConfigSchema(),
+  /**
+   * Favicon Configuration - The default favicon configuration for the Frontend
+   */
+  favicon: z.string().refine(
+    (fav) => {
+      const ext = extname(fav);
+      return isFaviconExt(ext);
+    },
+    {
+      message: "favicon must be a .ico, .gif, .jpg, .png, or .svg file"
+    }
+  ).optional().default("/favicon.svg"),
+  /**
+   * Enable Quick Actions Menu - Whether to enable the quick actions menu
+   * @default true
+   */
+  injectQuickActionsMenu: z.boolean().optional().default(true)
+}).optional().default({});
+const DefaultFrontEndConfigSchema = z.union([FrontEndConfigSchema, z.boolean()]).optional().default({});
+export {
+  DefaultFrontEndConfigSchema,
+  FrontEndConfigSchema,
+  HeadConfigSchema
+};

package/dist/schemas/config/developer.d.ts

@@ -0,0 +1,15 @@
+import { z } from 'astro/zod';
+export declare const developerConfigSchema: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+    /**
+     * Enable Testing and Demo Mode
+     *
+     * This will enable the testing and demo mode for the Astro StudioCMS dashboard, this will allow you to test the dashboard without having to authenticate. This is useful for testing and demo purposes as it will allow you to see how the dashboard works and looks but disable any changes to the database.
+     *
+     * @default false
+     */
+    testingAndDemoMode: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    testingAndDemoMode: boolean;
+}, {
+    testingAndDemoMode?: boolean | undefined;
+}>>>;

package/dist/schemas/config/developer.js

@@ -0,0 +1,14 @@
+import { z } from "astro/zod";
+const developerConfigSchema = z.object({
+  /**
+   * Enable Testing and Demo Mode
+   *
+   * This will enable the testing and demo mode for the Astro StudioCMS dashboard, this will allow you to test the dashboard without having to authenticate. This is useful for testing and demo purposes as it will allow you to see how the dashboard works and looks but disable any changes to the database.
+   *
+   * @default false
+   */
+  testingAndDemoMode: z.boolean().optional().default(false)
+}).optional().default({});
+export {
+  developerConfigSchema
+};

package/dist/schemas/config/imageService.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'astro/zod';
+export declare const imageServiceSchema: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+    /**
+     * If the user wants to use a custom Supported CDN Plugin, they can specify it here.
+     *
+     * Currently Supported CDN Plugins: **cloudinary-js**
+     */
+    cdnPlugin: z.ZodOptional<z.ZodEnum<["cloudinary-js"]>>;
+}, "strip", z.ZodTypeAny, {
+    cdnPlugin?: "cloudinary-js" | undefined;
+}, {
+    cdnPlugin?: "cloudinary-js" | undefined;
+}>>>;

package/dist/schemas/config/imageService.js

@@ -0,0 +1,12 @@
+import { z } from "astro/zod";
+const imageServiceSchema = z.object({
+  /**
+   * If the user wants to use a custom Supported CDN Plugin, they can specify it here.
+   *
+   * Currently Supported CDN Plugins: **cloudinary-js**
+   */
+  cdnPlugin: z.enum(["cloudinary-js"]).optional()
+}).optional().default({});
+export {
+  imageServiceSchema
+};