studiocms 0.3.0 → 0.4.0

package/dist/schemas/external-schemas.js

@@ -0,0 +1,179 @@
+import { ParseResult } from "effect";
+import * as Schema from "effect/Schema";
+import { SyncFunctionSchema } from "effectify/schemas";
+import { availableTranslationFileKeys } from "../virtuals/i18n/v-files.js";
+const expectedIconPrefixes = ["heroicons", "simpleicons", "lang-flags"];
+const UIIconListSchema = Schema.declare(
+  (input) => {
+    if (typeof input !== "string") {
+      return false;
+    }
+    const [prefix] = input.split(":");
+    if (!expectedIconPrefixes.includes(prefix)) {
+      return false;
+    }
+    return true;
+  },
+  {
+    title: "UIIconListSchema",
+    identifier: "UIIconListSchema",
+    description: "Schema for validating UI icon names against the list of available icons in StudioCMS."
+  }
+);
+const SanitizeOptionsSchema = Schema.declare(
+  (input) => {
+    if (typeof input !== "object" || input === null) {
+      return false;
+    }
+    return true;
+  },
+  {
+    title: "SanitizeOptionsSchema",
+    identifier: "SanitizeOptionsSchema",
+    description: "Schema for validating SanitizeOptions objects used in plugin configurations."
+  }
+);
+const AstroComponentSchema = SyncFunctionSchema(Schema.Any, Schema.Any);
+const AstroIntegrationSchema = Schema.declare(
+  (input) => {
+    if (typeof input !== "object" || input === null) {
+      return false;
+    }
+    if ("name" in input && typeof input.name === "string") {
+      return true;
+    }
+    return false;
+  },
+  {
+    title: "AstroIntegrationSchema",
+    identifier: "AstroIntegrationSchema",
+    description: "Schema for validating Astro integrations used in plugin configurations."
+  }
+);
+const AstroIntegrationLoggerSchema = Schema.declare(
+  (input) => {
+    if (typeof input !== "object" || input === null) {
+      return false;
+    }
+    if ("info" in input && typeof input.info === "function" && "warn" in input && typeof input.warn === "function" && "error" in input && typeof input.error === "function" && "debug" in input && typeof input.debug === "function") {
+      return true;
+    }
+    return false;
+  },
+  {
+    title: "AstroIntegrationLoggerSchema",
+    identifier: "AstroIntegrationLoggerSchema",
+    description: "Schema for validating Astro integration loggers used in plugin configurations."
+  }
+);
+const I18nKeySchema = Schema.transformOrFail(Schema.String, Schema.String, {
+  strict: true,
+  decode: (input, _options, ast) => {
+    if (typeof input !== "string") {
+      return ParseResult.fail(
+        new ParseResult.Type(ast, input, "Expected a string for I18nKeySchema")
+      );
+    }
+    if (!availableTranslationFileKeys.includes(input)) {
+      return ParseResult.fail(
+        new ParseResult.Type(
+          ast,
+          input,
+          `Invalid translation key. Expected one of: ${availableTranslationFileKeys.join(", ")}`
+        )
+      );
+    }
+    return ParseResult.succeed(input);
+  },
+  encode: (output) => ParseResult.succeed(output)
+}).annotations({
+  title: "I18nKeySchema",
+  identifier: "I18nKeySchema",
+  description: "Schema for validating translation keys used in plugin configurations, ensuring that only valid translation keys from the available translation file keys are accepted."
+});
+const LongShortUndefined = Schema.Union(Schema.Literal("long", "short"), Schema.Undefined);
+const LongShortNarrowUndefined = Schema.Union(LongShortUndefined, Schema.Literal("narrow"));
+const Numeric2Digit = Schema.Literal("numeric", "2-digit");
+const Numeric2DigitUndefined = Schema.Union(Numeric2Digit, Schema.Undefined);
+const TZOffsets = Schema.Literal("shortOffset", "longOffset");
+const TZGenerics = Schema.Literal("shortGeneric", "longGeneric");
+const TZName = Schema.Union(LongShortUndefined, TZOffsets, TZGenerics);
+const BestFitUndefined = Schema.Union(Schema.Literal("best fit"), Schema.Undefined);
+class DateTimeFormatOptions extends Schema.Class(
+  "DateTimeFormatOptions"
+)(
+  {
+    localeMatcher: Schema.optional(Schema.Union(BestFitUndefined, Schema.Literal("lookup"))),
+    weekday: Schema.optional(LongShortNarrowUndefined),
+    era: Schema.optional(LongShortNarrowUndefined),
+    year: Schema.optional(Numeric2DigitUndefined),
+    month: Schema.optional(Schema.Union(Numeric2Digit, LongShortNarrowUndefined)),
+    day: Schema.optional(Numeric2DigitUndefined),
+    hour: Schema.optional(Numeric2DigitUndefined),
+    minute: Schema.optional(Numeric2DigitUndefined),
+    second: Schema.optional(Numeric2DigitUndefined),
+    timeZoneName: Schema.optional(TZName),
+    formatMatcher: Schema.optional(Schema.Union(BestFitUndefined, Schema.Literal("basic"))),
+    hour12: Schema.optional(Schema.Union(Schema.Boolean, Schema.Undefined)),
+    timeZone: Schema.optional(Schema.Union(Schema.String, Schema.Undefined))
+  },
+  {
+    title: "DateTimeFormatOptions",
+    description: "JavaScript Intl.DateTimeFormatOptions options for formatting dates and times in the dashboard.",
+    identifier: "DateTimeFormatOptions"
+  }
+) {
+}
+const ValidEmailSchema = Schema.transformOrFail(Schema.String, Schema.String, {
+  strict: true,
+  decode: (input, _options, ast) => {
+    const emailRegex = /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/;
+    if (!emailRegex.test(input)) {
+      return ParseResult.fail(
+        new ParseResult.Type(
+          ast,
+          input,
+          "Invalid email format, expected a valid email address. (e.g., example@example.com)"
+        )
+      );
+    }
+    return ParseResult.succeed(input);
+  },
+  encode: (output) => ParseResult.succeed(output)
+}).annotations({
+  title: "ValidEmailSchema",
+  identifier: "ValidEmailSchema",
+  description: "A schema for validating email addresses in StudioCMS, ensuring that any provided email addresses adhere to standard email formatting rules.",
+  examples: ["example@example.com", "john@doe.com"],
+  documentation: "This schema uses a regular expression to validate that the input string is in a valid email format, making it suitable for validating email addresses in plugin configurations or other parts of StudioCMS.",
+  jsonSchema: {
+    type: "string",
+    format: "email"
+  }
+});
+const isValidEmail = (email) => {
+  const result = Schema.decodeEither(ValidEmailSchema)(email);
+  if (result._tag === "Left") {
+    return { success: false, error: result.left };
+  }
+  return { success: true, data: email };
+};
+export {
+  AstroComponentSchema,
+  AstroIntegrationLoggerSchema,
+  AstroIntegrationSchema,
+  BestFitUndefined,
+  DateTimeFormatOptions,
+  I18nKeySchema,
+  LongShortNarrowUndefined,
+  LongShortUndefined,
+  Numeric2Digit,
+  Numeric2DigitUndefined,
+  SanitizeOptionsSchema,
+  TZGenerics,
+  TZName,
+  TZOffsets,
+  UIIconListSchema,
+  ValidEmailSchema,
+  isValidEmail
+};

package/dist/schemas/index.d.ts

@@ -1,2 +1,4 @@
 export * from './config/index.js';
+export * from './custom.js';
+export * from './external-schemas.js';
 export * from './plugins/index.js';

package/dist/schemas/index.js

@@ -1,2 +1,4 @@
 export * from "./config/index.js";
+export * from "./custom.js";
+export * from "./external-schemas.js";
 export * from "./plugins/index.js";

package/dist/schemas/plugins/i18n.d.ts

@@ -1,40 +1,67 @@
-import { z } from 'astro/zod';
-export interface TranslationsJSON {
-    [key: string]: string;
-}
-export interface ComponentsJSON {
-    [component: string]: TranslationsJSON;
-}
-export interface PluginTranslations {
-    [language: string]: ComponentsJSON;
-}
-/**
- * Plugin Translation PluginTranslationCollection
+import * as Schema from 'effect/Schema';
+/**
+ * Plugin Translations Schema
+ */
+export declare const TranslationsJSONSchema: Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.String>>;
+/**
+ * Type for the plugin translations JSON object.
+ */
+export type TranslationsJSON = typeof TranslationsJSONSchema.Type;
+/**
+ * Schema for the components translations JSON object.
+ */
+export declare const ComponentsJSONSchema: Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.String>>>>;
+/**
+ * Type for the components translations JSON object.
+ */
+export type ComponentsJSON = typeof ComponentsJSONSchema.Type;
+/**
+ * Schema for the plugin translations collection.
+ */
+export declare const PluginTranslationsSchema: Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.String>>>>>>;
+/**
+ * Type for the plugin translations collection.
+ */
+export type PluginTranslations = typeof PluginTranslationsSchema.Type;
+/**
+ * Schema for a collection of plugin translations.
+ */
+export declare const PluginTranslationCollectionSchema: Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.String>>>>>>>>;
+/**
+ * Type for a collection of plugin translations.
+ */
+export type PluginTranslationCollection = typeof PluginTranslationCollectionSchema.Type;
+/**
+ * Schema for the plugin augments translations JSON object.
+ */
+export declare const AugmentsJSONSchema: Schema.mutable<Schema.Struct<{
+    augments: Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.String>>;
+}>>;
+/**
+ * Type for the plugin augments translations JSON object.
+ */
+export type AugmentsJSON = typeof AugmentsJSONSchema.Type;
+/**
+ * Schema for a collection of plugin augments translations.
  *
  * @example
  * {
- *   'plugin1': {
- *     en: {
- *       comp1: {
- *         title: 'Comp Title',
- *         'another-key': 'Hello!'
- *       },
- *     },
- *     fr: {
- *       comp1: { ... }
- *     },
- *   },
- *   'plugin2': { ... }
+ *  en: {
+ *   augments: {
+ *    'augment-key': 'Augment Text',
+ *    'another-augment': 'More augment text'
+ *   }
+ *  },
+ *  fr: {
+ *   augments: { ... }
+ *  }
  * }
  */
-export interface PluginTranslationCollection {
-    [plugin: string]: PluginTranslations;
-}
-export interface AugmentsJSON {
-    augments: TranslationsJSON;
-}
+export declare const PluginAugmentsTranslationCollectionSchema: Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
+    augments: Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.String>>;
+}>>>>;
 /**
- * Plugin Augments Translation Collection
+ * Type for a collection of plugin augments translations.
  *
  * @example
  * {
@@ -49,11 +76,4 @@ export interface AugmentsJSON {
  *  }
  * }
  */
-export interface PluginAugmentsTranslationCollection {
-    [language: string]: AugmentsJSON;
-}
-export declare const pluginTranslationsSchema: z.ZodType<PluginTranslations, z.ZodTypeDef, PluginTranslations>;
-/**
- * Schema for a collection of plugin translations.
- */
-export declare const pluginTranslationCollectionSchema: z.ZodType<PluginTranslationCollection, z.ZodTypeDef, PluginTranslationCollection>;
+export type PluginAugmentsTranslationCollection = typeof PluginAugmentsTranslationCollectionSchema.Type;

package/dist/schemas/plugins/i18n.js

@@ -1,7 +1,44 @@
-import { z } from "astro/zod";
-const pluginTranslationsSchema = z.custom();
-const pluginTranslationCollectionSchema = z.custom();
+import * as Schema from "effect/Schema";
+const TranslationsJSONSchema = Schema.mutable(
+  Schema.Record({
+    key: Schema.String,
+    value: Schema.String
+  })
+);
+const ComponentsJSONSchema = Schema.mutable(
+  Schema.Record({
+    key: Schema.String,
+    value: TranslationsJSONSchema
+  })
+);
+const PluginTranslationsSchema = Schema.mutable(
+  Schema.Record({
+    key: Schema.String,
+    value: ComponentsJSONSchema
+  })
+);
+const PluginTranslationCollectionSchema = Schema.mutable(
+  Schema.Record({
+    key: Schema.String,
+    value: PluginTranslationsSchema
+  })
+);
+const AugmentsJSONSchema = Schema.mutable(
+  Schema.Struct({
+    augments: TranslationsJSONSchema
+  })
+);
+const PluginAugmentsTranslationCollectionSchema = Schema.mutable(
+  Schema.Record({
+    key: Schema.String,
+    value: AugmentsJSONSchema
+  })
+);
 export {
-  pluginTranslationCollectionSchema,
-  pluginTranslationsSchema
+  AugmentsJSONSchema,
+  ComponentsJSONSchema,
+  PluginAugmentsTranslationCollectionSchema,
+  PluginTranslationCollectionSchema,
+  PluginTranslationsSchema,
+  TranslationsJSONSchema
 };