@plainbrew/microcms-api-schema-schema 0.0.0 → 0.0.1-alpha.0

package/src/index.ts

@@ -0,0 +1 @@
+export { apiSchemaSchema, ApiSchemaSchema } from "./schema.js";

package/src/schema-examples.test.ts

@@ -0,0 +1,32 @@
+import { readFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { describe, expect, test } from "vitest";
+import { apiSchemaSchema } from "./schema.js";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const SCHEMA_EXAMPLES_DIR = join(__dirname, "../../../schema-examples");
+
+const schemaFiles = [
+  "official-categories.json",
+  "official-news.json",
+  "official-blogs.json",
+  "official-banner.json",
+  "min-max.json",
+];
+
+describe("schema-examples のファイルをバリデーション", () => {
+  test.each(schemaFiles)("%s", (filename) => {
+    const filePath = join(SCHEMA_EXAMPLES_DIR, filename);
+    const content = readFileSync(filePath, "utf-8");
+    const schema = JSON.parse(content);
+
+    const result = apiSchemaSchema.safeParse(schema);
+    if (!result.success) {
+      console.error(result.error);
+    }
+    expect(result.success).toBe(true);
+  });
+});

package/src/schema.test.ts

@@ -0,0 +1,200 @@
+import { describe, expect, test } from "vitest";
+import { apiSchemaSchema } from "./schema.js";
+
+describe("apiSchemaSchema", () => {
+  test("official-categories.json のスキーマをバリデーションできる", () => {
+    const schema = {
+      apiFields: [
+        {
+          fieldId: "name",
+          name: "カテゴリ名",
+          kind: "text",
+          required: false,
+          isUnique: false,
+        },
+      ],
+      customFields: [],
+    };
+
+    const result = apiSchemaSchema.safeParse(schema);
+    expect(result.success).toBe(true);
+  });
+
+  test("official-news.json のスキーマをバリデーションできる", () => {
+    const schema = {
+      apiFields: [
+        {
+          fieldId: "title",
+          name: "タイトル",
+          kind: "text",
+          required: false,
+          isUnique: false,
+        },
+        {
+          fieldId: "content",
+          name: "内容",
+          kind: "richEditorV2",
+          required: false,
+        },
+        {
+          fieldId: "category",
+          name: "カテゴリ",
+          kind: "relation",
+          required: false,
+        },
+      ],
+      customFields: [],
+    };
+
+    const result = apiSchemaSchema.safeParse(schema);
+    expect(result.success).toBe(true);
+  });
+
+  test("official-blogs.json のスキーマをバリデーションできる", () => {
+    const schema = {
+      apiFields: [
+        {
+          fieldId: "title",
+          name: "タイトル",
+          kind: "text",
+          required: false,
+          isUnique: false,
+        },
+        {
+          fieldId: "content",
+          name: "内容",
+          kind: "richEditorV2",
+          required: false,
+        },
+        {
+          fieldId: "eyecatch",
+          name: "アイキャッチ",
+          kind: "media",
+          required: false,
+        },
+        {
+          fieldId: "category",
+          name: "カテゴリ",
+          kind: "relation",
+          required: false,
+        },
+      ],
+      customFields: [],
+    };
+
+    const result = apiSchemaSchema.safeParse(schema);
+    expect(result.success).toBe(true);
+  });
+
+  test("複雑なスキーマをバリデーションできる", () => {
+    const schema = {
+      apiFields: [
+        {
+          fieldId: "text_max",
+          name: "テキストフィールド 最大",
+          kind: "text",
+          description: "説明文",
+          required: true,
+          selectItems: [],
+          selectInitialValue: [],
+          multipleSelect: false,
+          textSizeLimitValidation: { textSize: { min: 1, max: 30 } },
+          patternMatchValidation: { regexp: { pattern: "\\d", flags: "gi" } },
+          isUnique: true,
+        },
+        {
+          fieldId: "rich_max",
+          name: "リッチエディタ 最大",
+          kind: "richEditorV2",
+          description: "説明文",
+          required: true,
+          richEditorV2Options: ["undo", "redo", "bold", "italic", "underline", "code"],
+          richEditorV2ColorList: [
+            { id: "KDKsIv0jXZ", value: "rgb(255, 255, 255)" },
+            { id: "vHyfNOIY51", value: "rgb(156, 102, 102)" },
+          ],
+          richEditorV2HideColorPicker: true,
+          richEditorV2FontSizeList: [{ id: "Sp9MppHN43", name: "表示名", value: "120" }],
+          customClassList: [{ id: "nL3_cmKOxf", name: "表示名", value: "class名" }],
+        },
+        {
+          fieldId: "image_max",
+          name: "画像 最大",
+          kind: "media",
+          description: "説明文",
+          required: true,
+          imageSizeValidation: { imageSize: { width: 100, height: 100 } },
+        },
+        {
+          fieldId: "select_max",
+          name: "セレクトフィールド 最大",
+          kind: "select",
+          required: true,
+          selectItems: [
+            { id: "viO1_AW73E", value: "item1" },
+            { id: "6bnahbE--K", value: "item2" },
+          ],
+          selectInitialValue: ["viO1_AW73E"],
+          multipleSelect: true,
+        },
+        {
+          fieldId: "relation_multi_max",
+          name: "複数参照 最大",
+          kind: "relationList",
+          description: "説明文",
+          required: true,
+          referenceDisplayItem: "eO9ST_qUoe",
+          relationListCountLimitValidation: {
+            relationListCount: { min: 1, max: 3 },
+          },
+        },
+        {
+          fieldId: "number_max",
+          name: "数字 最大",
+          kind: "number",
+          description: "説明文",
+          required: true,
+          numberSizeLimitValidation: { numberSize: { min: 1, max: 300 } },
+        },
+      ],
+      customFields: [],
+    };
+
+    const result = apiSchemaSchema.safeParse(schema);
+    expect(result.success).toBe(true);
+  });
+
+  test("不正なスキーマはバリデーションエラーになる", () => {
+    const invalidSchema = {
+      apiFields: [
+        {
+          fieldId: "test",
+          // name が欠けている
+          kind: "text",
+          required: false,
+        },
+      ],
+      customFields: [],
+    };
+
+    const result = apiSchemaSchema.safeParse(invalidSchema);
+    expect(result.success).toBe(false);
+  });
+
+  test("不正な kind はバリデーションエラーになる", () => {
+    const invalidSchema = {
+      apiFields: [
+        {
+          fieldId: "test",
+          name: "テスト",
+          kind: "invalid_kind",
+          required: false,
+        },
+      ],
+      customFields: [],
+    };
+
+    const result = apiSchemaSchema.safeParse(invalidSchema);
+    expect(result.success).toBe(false);
+  });
+});

package/src/schema.ts

@@ -0,0 +1,247 @@
+import * as z from "zod/v4";
+
+const textSizeLimitValidationSchema = z.object({
+  textSize: z.object({
+    min: z.number().optional(),
+    max: z.number().optional(),
+  }),
+});
+
+const patternMatchValidationSchema = z.object({
+  regexp: z.object({
+    pattern: z.string(),
+    flags: z.string().optional(),
+  }),
+});
+
+const imageSizeValidationSchema = z.object({
+  imageSize: z.object({
+    width: z.number(),
+    height: z.number(),
+  }),
+});
+
+const numberSizeLimitValidationSchema = z.object({
+  numberSize: z.object({
+    min: z.number().optional(),
+    max: z.number().optional(),
+  }),
+});
+
+const relationListCountLimitValidationSchema = z.object({
+  relationListCount: z.object({
+    min: z.number().optional(),
+    max: z.number().optional(),
+  }),
+});
+
+const richEditorOptionSchema = z.enum([
+  "headerOne",
+  "headerTwo",
+  "headerThree",
+  "headerFour",
+  "headerFive",
+  "paragraph",
+  "sizeSmall",
+  "sizeNormal",
+  "sizeLarge",
+  "sizeHuge",
+  "bold",
+  "italic",
+  "underline",
+  "strike",
+  "code",
+  "background",
+  "color",
+  "align",
+  "blockquote",
+  "codeBlock",
+  "listOrdered",
+  "listBullet",
+  "indentRemove",
+  "indentAdd",
+  "scriptSub",
+  "scriptSuper",
+  "link",
+  "image",
+  "oembedly",
+  "clean",
+]);
+
+const richEditorV2OptionSchema = z.enum([
+  "undo",
+  "redo",
+  "bold",
+  "italic",
+  "underline",
+  "strike",
+  "code",
+  "listBullet",
+  "listOrdered",
+  "link",
+  "file",
+  "image",
+  "table",
+  "horizontalRule",
+  "textAlign",
+  "oembedly",
+  "clean",
+  "color",
+  "size",
+  "customClass",
+  "headerOne",
+  "headerTwo",
+  "headerThree",
+  "headerFour",
+  "headerFive",
+  "paragraph",
+  "blockquote",
+  "codeBlock",
+]);
+
+const mediaListLayoutSchema = z.enum(["HORIZONTAL_SCROLL", "GRID_2", "GRID_3", "GRID_4"]);
+
+const selectItemSchema = z.object({
+  id: z.string(),
+  value: z.string(),
+});
+
+const richEditorV2ColorListItemSchema = z.object({
+  id: z.string(),
+  value: z.string(),
+});
+
+const richEditorV2FontSizeListItemSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  value: z.string(),
+});
+
+const customClassListItemSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  value: z.string(),
+});
+
+const baseFieldSchema = z.object({
+  fieldId: z.string(),
+  name: z.string(),
+  description: z.string().optional(),
+  required: z.boolean(),
+});
+
+// テキストフィールド (text)
+const textFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("text"),
+  isUnique: z.boolean().optional(),
+  textSizeLimitValidation: textSizeLimitValidationSchema.optional(),
+  patternMatchValidation: patternMatchValidationSchema.optional(),
+  selectItems: z.array(selectItemSchema).optional(),
+  selectInitialValue: z.array(z.string()).optional(),
+  multipleSelect: z.boolean().optional(),
+});
+
+// テキストエリア (textArea)
+const textAreaFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("textArea"),
+  textSizeLimitValidation: textSizeLimitValidationSchema.optional(),
+  patternMatchValidation: patternMatchValidationSchema.optional(),
+});
+
+// リッチエディタ (richEditorV2)
+const richEditorV2FieldSchema = baseFieldSchema.extend({
+  kind: z.literal("richEditorV2"),
+  richEditorV2Options: z.array(richEditorV2OptionSchema).optional(),
+  richEditorV2ColorList: z.array(richEditorV2ColorListItemSchema).optional(),
+  richEditorV2HideColorPicker: z.boolean().optional(),
+  richEditorV2FontSizeList: z.array(richEditorV2FontSizeListItemSchema).optional(),
+  customClassList: z.array(customClassListItemSchema).optional(),
+});
+
+// 旧リッチエディタ (richEditor)
+const richEditorFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("richEditor"),
+  richEditorImageSize: z.boolean().optional(),
+  richEditorOptions: z.array(richEditorOptionSchema).optional(),
+});
+
+// 画像 (media)
+const mediaFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("media"),
+  imageSizeValidation: imageSizeValidationSchema.optional(),
+});
+
+// 複数画像 (mediaList)
+const mediaListFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("mediaList"),
+  imageSizeValidation: imageSizeValidationSchema.optional(),
+  mediaListLayout: mediaListLayoutSchema.optional(),
+});
+
+// 日時 (date)
+const dateFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("date"),
+  dateFormat: z.boolean().optional(),
+});
+
+// 真偽値 (boolean)
+const booleanFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("boolean"),
+  booleanInitialValue: z.boolean().optional(),
+});
+
+// セレクトフィールド (select)
+const selectFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("select"),
+  selectItems: z.array(selectItemSchema),
+  selectInitialValue: z.array(z.string()),
+  multipleSelect: z.boolean(),
+});
+
+// コンテンツ参照 (relation)
+const relationFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("relation"),
+  referenceDisplayItem: z.string().optional(),
+});
+
+// 複数コンテンツ参照 (relationList)
+const relationListFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("relationList"),
+  referenceDisplayItem: z.string().optional(),
+  relationListCountLimitValidation: relationListCountLimitValidationSchema.optional(),
+});
+
+// 数字 (number)
+const numberFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("number"),
+  numberSizeLimitValidation: numberSizeLimitValidationSchema.optional(),
+});
+
+// 拡張フィールド (iframe)
+const iframeFieldSchema = baseFieldSchema.extend({
+  kind: z.literal("iframe"),
+  iframeUrl: z.string(),
+});
+
+const apiFieldSchema = z.discriminatedUnion("kind", [
+  textFieldSchema,
+  textAreaFieldSchema,
+  richEditorFieldSchema,
+  richEditorV2FieldSchema,
+  mediaFieldSchema,
+  mediaListFieldSchema,
+  dateFieldSchema,
+  booleanFieldSchema,
+  selectFieldSchema,
+  relationFieldSchema,
+  relationListFieldSchema,
+  numberFieldSchema,
+  iframeFieldSchema,
+]);
+
+export const apiSchemaSchema = z.object({
+  apiFields: z.array(apiFieldSchema),
+  customFields: z.array(z.unknown()),
+});
+
+export type ApiSchemaSchema = z.infer<typeof apiSchemaSchema>;