studiocms 0.2.0 → 0.4.0

package/dist/schemas/plugins/index.js

@@ -1,293 +1,248 @@
-import { z } from "astro/zod";
-import { pluginTranslationsSchema } from "./i18n.js";
+import * as Schema from "effect/Schema";
+import { FunctionSchema, SyncFunctionSchema } from "effectify/schemas";
+import { AstroIntegrationLoggerSchema, AstroIntegrationSchema } from "../external-schemas.js";
+import { PluginTranslationsSchema } from "./i18n.js";
 import {
-  astroIntegrationSchema,
   DashboardPageSchema,
   FrontendNavigationLinksSchema,
+  GridItemInputSchema,
   PageTypesSchema,
   SettingsPageSchema
 } from "./shared.js";
-const ComponentRenderAugmentSchema = z.object({
-  type: z.literal("component"),
-  id: z.string(),
-  components: z.record(z.string())
-});
-const PrefixRenderAugmentSchema = ComponentRenderAugmentSchema.extend({
-  type: z.literal("prefix"),
-  html: z.string()
-});
-const SuffixRenderAugmentSchema = ComponentRenderAugmentSchema.extend({
-  type: z.literal("suffix"),
-  html: z.string()
-});
-const RenderAugmentSchema = z.union([
+class PostProcessorSchema extends Schema.Class("PostProcessorSchema")({
+  id: Schema.String,
+  postProcessor: Schema.String
+}) {
+}
+class RenderAugmentBaseSchema extends Schema.Class(
+  "RenderAugmentBaseSchema"
+)({
+  id: Schema.String,
+  components: Schema.Record({
+    key: Schema.String,
+    value: Schema.String
+  })
+}) {
+}
+class ComponentRenderAugmentSchema extends RenderAugmentBaseSchema.extend(
+  "ComponentRenderAugmentSchema"
+)({
+  type: Schema.Literal("component")
+}) {
+}
+class PrefixRenderAugmentSchema extends RenderAugmentBaseSchema.extend(
+  "PrefixRenderAugmentSchema"
+)({
+  type: Schema.Literal("prefix"),
+  html: Schema.String
+}) {
+}
+class SuffixRenderAugmentSchema extends RenderAugmentBaseSchema.extend(
+  "SuffixRenderAugmentSchema"
+)({
+  type: Schema.Literal("suffix"),
+  html: Schema.String
+}) {
+}
+class PostProcessorAugmentSchema extends PostProcessorSchema.extend(
+  "PostProcessorAugmentSchema"
+)({
+  type: Schema.Literal("post-processor")
+}) {
+}
+const RenderAugmentSchema = Schema.Union(
   ComponentRenderAugmentSchema,
   PrefixRenderAugmentSchema,
-  SuffixRenderAugmentSchema
-]);
-const RenderAugmentsSchema = z.array(RenderAugmentSchema).optional();
-const StudioCMSSanitizeOptionsSchema = z.object({
-  /** An Array of strings indicating elements that the sanitizer should not remove. All elements not in the array will be dropped. */
-  allowElements: z.array(z.string()).optional(),
-  /** An Array of strings indicating elements that the sanitizer should remove. Children will be kept. */
-  blockElements: z.array(z.string()).optional(),
-  /** An Array of strings indicating elements (including nested elements) that the sanitizer should remove. */
-  dropElements: z.array(z.string()).optional(),
-  /** An object where each key is the attribute name and the value is an array of allowed tag names. Matching attributes will not be removed. All attributes that are not in the array will be dropped. */
-  allowAttributes: z.record(z.array(z.string())).optional(),
-  /** An object where each key is the attribute name and the value is an array of dropped tag names. Matching attributes will be removed. */
-  dropAttributes: z.record(z.array(z.string())).optional(),
-  /** A boolean value to remove components and their children. If set to true, components will be subject to built-in and custom configuration checks (and will be retained or dropped based on those checks). Default is `false`. */
-  allowComponents: z.boolean().optional(),
-  /** A boolean value to remove custom elements and their children. If set to true, custom elements will be subject to built-in and custom configuration checks (and will be retained or dropped based on those checks). Default is `false` */
-  allowCustomElements: z.boolean().optional(),
-  /** A boolean value to remove HTML comments. Set to true in order to keep comments. Default is `false`. */
-  allowComments: z.boolean().optional()
-}).optional();
-const dashboardPagesArray = z.array(DashboardPageSchema).optional();
-const astroIntegrationLoggerSchema = z.custom();
-const SafePluginListItemSchema = z.object({
-  /**
-   * Identifier of the plugin from the package.json
-   */
-  identifier: z.string(),
-  /**
-   * Label of the plugin to be displayed in the StudioCMS Dashboard
-   */
-  name: z.string(),
-  /**
-   * If this exists, the plugin will have its own setting page
-   */
-  settingsPage: SettingsPageSchema.optional(),
-  /**
-   * Navigation Links for use with the `@studiocms/frontend` package to display links in the frontend
-   */
-  frontendNavigationLinks: FrontendNavigationLinksSchema.optional(),
-  /**
-   * Page Type definition. If this is present, the plugin wants to be able to modify the page creation process
-   */
-  pageTypes: PageTypesSchema.optional()
+  SuffixRenderAugmentSchema,
+  PostProcessorAugmentSchema
+);
+const RenderAugmentsSchema = Schema.Array(RenderAugmentSchema);
+const dashboardPagesArray = Schema.Array(DashboardPageSchema);
+const SafePluginListItemSchema = Schema.Struct({
+  identifier: Schema.String,
+  name: Schema.String,
+  settingsPage: SettingsPageSchema,
+  frontendNavigationLinks: FrontendNavigationLinksSchema,
+  pageTypes: PageTypesSchema
 });
-const SafePluginListSchema = z.array(SafePluginListItemSchema);
-const SitemapConfigSchema = z.object({
-  /**
-   * If this is true, the plugin will enable the Sitemap
-   */
-  triggerSitemap: z.boolean().optional(),
-  /**
-   * Allows the plugin to add sitemap endpoints
-   */
-  sitemaps: z.array(
-    z.object({
-      /**
-       * The name of the plugin
-       */
-      pluginName: z.string(),
-      /**
-       * The path to the sitemap XML file
-       */
-      sitemapXMLEndpointPath: z.string().or(z.instanceof(URL))
+const SafePluginListSchema = Schema.mutable(Schema.Array(SafePluginListItemSchema));
+const SitemapConfigSchema = Schema.mutable(
+  Schema.Struct({
+    triggerSitemap: Schema.optional(Schema.Boolean),
+    sitemaps: Schema.optional(
+      Schema.Array(
+        Schema.Struct({
+          pluginName: Schema.String,
+          sitemapXMLEndpointPath: Schema.Union(Schema.String, Schema.URL)
+        })
+      )
+    )
+  })
+);
+const DashboardConfigSchema = Schema.mutable(
+  Schema.Struct({
+    translations: PluginTranslationsSchema,
+    dashboardGridItems: Schema.optional(Schema.Array(GridItemInputSchema)),
+    dashboardPages: Schema.optional(
+      Schema.Struct({
+        user: Schema.optional(dashboardPagesArray),
+        admin: Schema.optional(dashboardPagesArray)
+      })
+    ),
+    settingsPage: SettingsPageSchema
+  })
+);
+const DashboardAugmentSchema = Schema.mutable(
+  Schema.Struct({
+    scripts: Schema.optional(Schema.Array(Schema.String)),
+    components: Schema.optional(
+      Schema.Record({
+        key: Schema.String,
+        value: Schema.String
+      })
+    )
+  })
+);
+const FrontendConfigSchema = Schema.mutable(
+  Schema.Struct({
+    frontendNavigationLinks: FrontendNavigationLinksSchema
+  })
+);
+const RenderingConfigSchema = Schema.mutable(
+  Schema.Struct({
+    pageTypes: PageTypesSchema,
+    augments: Schema.optional(RenderAugmentsSchema),
+    postProcessor: Schema.optional(PostProcessorSchema)
+  })
+);
+const ImageServiceConfigSchema = Schema.mutable(
+  Schema.Struct({
+    imageService: Schema.optional(
+      Schema.Struct({
+        identifier: Schema.String,
+        servicePath: Schema.Union(Schema.String, Schema.URL)
+      })
+    )
+  })
+);
+const AuthServiceConfigSchema = Schema.mutable(
+  Schema.Struct({
+    oAuthProvider: Schema.Struct({
+      name: Schema.String,
+      formattedName: Schema.String,
+      svg: Schema.String,
+      endpointPath: Schema.String,
+      requiredEnvVariables: Schema.optional(Schema.Array(Schema.String))
     })
-  ).optional()
-});
-const DashboardConfigSchema = z.object({
-  /**
-   * The translations for the plugin in the following format:
-   *
-   * ```json
-   * {
-   *   "en": {
-   *    "component1": {
-   *      "title": "Title",
-   *      "description": "Description"
-   *    },
-   *    "component2": {
-   *      "title": "Title",
-   *      "description": "Description"
-   *    }
-   *   },
-   *   "fr": {
-   *    "component1": {
-   *      "title": "Titre",
-   *      "description": "Description"
-   *    },
-   *    "component2": {
-   *      "title": "Titre",
-   *      "description": "Description"
-   *    }
-   *   }
-   * }
-   * ```
-   */
-  translations: pluginTranslationsSchema,
-  /**
-   * Allows the plugin to add custom dashboard grid items
-   */
-  dashboardGridItems: z.custom().optional(),
-  /**
-   * Dashboard Pages for the plugin
-   */
-  dashboardPages: z.object({
-    /**
-     * Pages for the user role
-     *
-     * These are shown in the "Dashboard" section of the dashboard sidebar
-     */
-    user: dashboardPagesArray,
-    /**
-     * Pages for the editor role
-     *
-     * These are shown in the "Admin" section of the dashboard sidebar
-     */
-    admin: dashboardPagesArray
-  }).optional(),
-  /**
-   * If this exists, the plugin will have its own setting page
-   */
-  settingsPage: SettingsPageSchema
-});
-const DashboardAugmentSchema = z.object({
-  /**
-   * Scripts to be added to the dashboard
-   *
-   * Scripts should be paths to the client side files that will be loaded in the dashboard
-   *
-   * These files should be able to imported as ambient modules
-   */
-  scripts: z.array(z.string()).optional(),
-  /**
-   * Astro Components to be added to the dashboard
-   *
-   * These components should be self-contained and not rely on any external state
-   *
-   * The key is the component identifier, and the value is the path to the component file
-   */
-  components: z.record(z.string()).optional()
-});
-const FrontendConfigSchema = z.object({
-  /**
-   * Navigation Links for use with the `@studiocms/frontend` package to display links in the frontend
-   */
-  frontendNavigationLinks: FrontendNavigationLinksSchema
-});
-const RenderingConfigSchema = z.object({
-  /**
-   * Page Type definition. If this is present, the plugin wants to be able to modify the page creation process
-   */
-  pageTypes: PageTypesSchema,
-  /**
-   * Augments to modify component rendering
-   *
-   * When adding new augments, please ensure that the `id` field is unique across all augments.
-   *
-   * the `id` field is also used to identify augment translations from the plugin translations
-   * schema, below is an example of how to add augment translations:
-   *
-   * ```json
-   * {
-   *   "en": {
-   *    "augments": {
-   *      "augment-id": "This is the augment text"
-   *    }
-   *   },
-   *   "fr": {
-   *    "augments": {
-   *      "augment-id": "Ceci est le texte d'augmentation"
-   *    }
-   *   }
-   * }
-   * ```
-   */
-  augments: RenderAugmentsSchema
-});
-const ImageServiceConfigSchema = z.object({
-  imageService: z.object({
-    /**
-     * Identifier used for the `preferredImageService` setting on StudioCMS
-     */
-    identifier: z.string(),
-    /**
-     * The Service Path to the file that contains your service, the service must be exported as a default export.
-     *
-     * For an example of a service, checkout `/src/imageServices/cloudinary-js-service.ts` and its plugin `/src/imageServices/cloudinary-js.ts` within the StudioCMS package on GitHub.
-     */
-    servicePath: z.string().or(z.instanceof(URL))
-  }).optional()
-});
-const AuthServiceConfigSchema = z.object({
-  oAuthProvider: z.object({
-    /**
-     * The name of the OAuth provider, e.g., 'google', 'github', etc.
-     */
-    name: z.string(),
-    /**
-     * The formatted name of the OAuth provider, e.g., 'Google', 'GitHub', etc.
-     */
-    formattedName: z.string(),
-    /**
-     * The inline SVG image for the OAuth provider button.
-     * This should be a string containing the SVG markup.
-     *
-     * Note: Please ensure the class `oauth-logo` is included in the SVG for styling purposes.
-     *
-     * @example
-     * `<svg width="24px" height="24px" viewBox="0 0 98 96" xmlns="http://www.w3.org/2000/svg" class="oauth-logo">...</svg>`,
-     */
-    svg: z.string(),
-    /**
-     * The path to the endpoint file that handles the OAuth authentication for this provider.
-     * This should be a string or URL pointing to the endpoint ts file.
-     *
-     * Note: The endpoint should export two functions:
-     * - `initSession`: Initializes the session for the OAuth provider.
-     * - `initCallback`: Handles the callback from the OAuth provider after authentication.
-     *
-     * @example
-     * `/src/auth/providers/google.ts`
-     */
-    endpointPath: z.string(),
-    /**
-     * Required environment variables for the OAuth provider.
-     * This is an optional array of strings that specifies which environment variables are required for the OAuth provider to function correctly.
-     * If specified, these variables must be set in the environment for the OAuth provider to work.
-     */
-    requiredEnvVariables: z.array(z.string()).optional()
   })
+);
+const StorageManagerConfigSchema = Schema.Struct({
+  managerPath: Schema.String
 });
-const StorageManagerConfigSchema = z.object({
-  managerPath: z.string()
-});
-const baseHookSchema = z.object({
-  logger: astroIntegrationLoggerSchema
-});
-const astroConfigHookSchema = baseHookSchema.extend({
-  addIntegrations: z.function(
-    z.tuple([z.union([astroIntegrationSchema, z.array(astroIntegrationSchema)])]),
-    z.void()
+class BaseHookSchema extends Schema.Class("BaseHookSchema")({
+  logger: AstroIntegrationLoggerSchema
+}) {
+}
+class astroConfigHookSchema extends BaseHookSchema.extend(
+  "astroConfigHookSchema"
+)({
+  addIntegrations: FunctionSchema(
+    Schema.Union(AstroIntegrationSchema, Schema.mutable(Schema.Array(AstroIntegrationSchema))),
+    Schema.Void
   )
+}) {
+}
+class SitemapHookSchema extends BaseHookSchema.extend(
+  "SitemapHookSchema"
+)({
+  setSitemap: FunctionSchema(SitemapConfigSchema, Schema.Void)
+}) {
+}
+class DashboardHookSchema extends BaseHookSchema.extend(
+  "DashboardHookSchema"
+)({
+  setDashboard: FunctionSchema(DashboardConfigSchema, Schema.Void),
+  augmentDashboard: FunctionSchema(DashboardAugmentSchema, Schema.Void)
+}) {
+}
+class FrontendHookSchema extends BaseHookSchema.extend(
+  "FrontendHookSchema"
+)({
+  setFrontend: FunctionSchema(FrontendConfigSchema, Schema.Void)
+}) {
+}
+class RenderingHookSchema extends BaseHookSchema.extend(
+  "RenderingHookSchema"
+)({
+  setRendering: FunctionSchema(RenderingConfigSchema, Schema.Void)
+}) {
+}
+class ImageServiceHookSchema extends BaseHookSchema.extend(
+  "ImageServiceHookSchema"
+)({
+  setImageService: FunctionSchema(ImageServiceConfigSchema, Schema.Void)
+}) {
+}
+class AuthServiceHookSchema extends BaseHookSchema.extend(
+  "AuthServiceHookSchema"
+)({
+  setAuthService: FunctionSchema(AuthServiceConfigSchema, Schema.Void)
+}) {
+}
+class StorageManagerHookSchema extends BaseHookSchema.extend(
+  "StorageManagerHookSchema"
+)({
+  setStorageManager: FunctionSchema(StorageManagerConfigSchema, Schema.Void)
+}) {
+}
+const makeHookSchema = (argsSchema) => Schema.optional(
+  Schema.Union(
+    FunctionSchema(argsSchema, Schema.Void),
+    SyncFunctionSchema(argsSchema, Schema.Void)
+  )
+).annotations({
+  description: "A hook schema for validating the structure of hooks that plugins can implement to integrate with various aspects of the StudioCMS system."
 });
-const studiocms_SitemapHookSchema = baseHookSchema.extend({
-  setSitemap: z.function(z.tuple([SitemapConfigSchema]), z.void())
-});
-const studiocms_DashboardHookSchema = baseHookSchema.extend({
-  setDashboard: z.function(z.tuple([DashboardConfigSchema]), z.void()),
-  augmentDashboard: z.function(z.tuple([DashboardAugmentSchema]), z.void())
-});
-const studiocms_FrontendHookSchema = baseHookSchema.extend({
-  setFrontend: z.function(z.tuple([FrontendConfigSchema]), z.void())
-});
-const studiocms_RenderingHookSchema = baseHookSchema.extend({
-  setRendering: z.function(z.tuple([RenderingConfigSchema]), z.void())
-});
-const studiocms_ImageServiceHookSchema = baseHookSchema.extend({
-  setImageService: z.function(z.tuple([ImageServiceConfigSchema]), z.void())
-});
-const studiocms_AuthHookSchema = baseHookSchema.extend({
-  setAuthService: z.function(z.tuple([AuthServiceConfigSchema]), z.void())
-});
-const studiocms_StorageManagerHookSchema = baseHookSchema.extend({
-  setStorageManager: z.function(z.tuple([StorageManagerConfigSchema]), z.void())
+const InternalPluginHooksSchema = Schema.Struct({
+  "studiocms:astro-config": makeHookSchema(astroConfigHookSchema),
+  "studiocms:auth": makeHookSchema(AuthServiceHookSchema),
+  "studiocms:dashboard": makeHookSchema(DashboardHookSchema),
+  "studiocms:frontend": makeHookSchema(FrontendHookSchema),
+  "studiocms:rendering": makeHookSchema(RenderingHookSchema),
+  "studiocms:image-service": makeHookSchema(ImageServiceHookSchema),
+  "studiocms:sitemap": makeHookSchema(SitemapHookSchema)
 });
+const BasePluginHooksSchema = Schema.mutable(InternalPluginHooksSchema);
+const StorageManagerPluginHooksSchema = Schema.mutable(
+  Schema.Struct({
+    ...InternalPluginHooksSchema.fields,
+    "studiocms:storage-manager": makeHookSchema(StorageManagerHookSchema)
+  })
+);
+class StudioCMSPluginBaseSchema extends Schema.Class(
+  "StudioCMSPluginBaseSchema"
+)({
+  identifier: Schema.String,
+  name: Schema.String,
+  /**
+   * @deprecated The `studiocmsMinimumVersion` property is deprecated and will be removed in a future release. Please ensure that your plugin is compatible with the latest version of StudioCMS and remove this property from your plugin configuration. It is recommended to use `peerDependencies` in your plugin's package.json to specify the compatible versions of StudioCMS instead of relying on this property for version compatibility checks.
+   */
+  studiocmsMinimumVersion: Schema.optional(Schema.String),
+  requires: Schema.optional(Schema.Array(Schema.String))
+}) {
+}
+class StudioCMSPluginSchema extends StudioCMSPluginBaseSchema.extend(
+  "StudioCMSPluginSchema"
+)({
+  hooks: BasePluginHooksSchema
+}) {
+}
+class StudioCMSStorageManagerSchema extends StudioCMSPluginBaseSchema.extend(
+  "StudioCMSStorageManagerSchema"
+)({
+  hooks: StorageManagerPluginHooksSchema
+}) {
+}
 function definePlugin(options) {
   return options;
 }
@@ -295,11 +250,40 @@ function defineStorageManager(options) {
   return options;
 }
 export {
+  AuthServiceConfigSchema,
+  AuthServiceHookSchema,
+  BaseHookSchema,
+  BasePluginHooksSchema,
+  ComponentRenderAugmentSchema,
+  DashboardAugmentSchema,
+  DashboardConfigSchema,
+  DashboardHookSchema,
+  FrontendConfigSchema,
+  FrontendHookSchema,
+  ImageServiceConfigSchema,
+  ImageServiceHookSchema,
+  InternalPluginHooksSchema,
+  PostProcessorAugmentSchema,
+  PostProcessorSchema,
+  PrefixRenderAugmentSchema,
+  RenderAugmentBaseSchema,
   RenderAugmentSchema,
   RenderAugmentsSchema,
+  RenderingConfigSchema,
+  RenderingHookSchema,
   SafePluginListItemSchema,
   SafePluginListSchema,
-  StudioCMSSanitizeOptionsSchema,
+  SitemapConfigSchema,
+  SitemapHookSchema,
+  StorageManagerConfigSchema,
+  StorageManagerHookSchema,
+  StorageManagerPluginHooksSchema,
+  StudioCMSPluginBaseSchema,
+  StudioCMSPluginSchema,
+  StudioCMSStorageManagerSchema,
+  SuffixRenderAugmentSchema,
+  astroConfigHookSchema,
+  dashboardPagesArray,
   definePlugin,
   defineStorageManager
 };