gt-sanity 0.0.5 → 1.0.0

package/src/serialization/__tests__/__fixtures__/documentLevelArticle.json

@@ -0,0 +1,185 @@
+{
+  "_id": "drafts.d8ffc675-ce86-4f60-9ac8-da164cde3b0a",
+  "_rev": "fxcnqj-uew-gr7-v6r-z965tfm69",
+  "_type": "documentLevelArticle",
+  "_createdAt": "2021-09-01T23:00:13Z",
+  "_updatedAt": "2021-09-01T23:02:05Z",
+  "config": {
+    "_type": "objectField",
+    "nestedArrayField": [
+      {
+        "_key": "4a58adc7c507",
+        "_type": "block",
+        "children": [
+          {
+            "_key": "4f6bc15ae261",
+            "_type": "span",
+            "marks": [],
+            "text": "This is block text 1 level deep"
+          }
+        ],
+        "markDefs": [],
+        "style": "normal"
+      }
+    ],
+    "objectAsField": {
+      "_type": "childObjectField",
+      "content": [
+        {
+          "_key": "1aa228ac848b",
+          "_type": "block",
+          "children": [
+            {
+              "_key": "e2cf67af8e62",
+              "_type": "span",
+              "marks": [],
+              "text": "This is a block text 2 levels deep"
+            }
+          ],
+          "markDefs": [],
+          "style": "normal"
+        }
+      ],
+      "title": "This is one level deeper"
+    },
+    "title": "This is an object nested in a document"
+  },
+  "content": [
+    {
+      "_key": "a4d177e92666",
+      "_type": "block",
+      "children": [
+        {
+          "_key": "a896ea6fcd59",
+          "_type": "span",
+          "marks": [],
+          "text": "This is block text at the top level."
+        }
+      ],
+      "markDefs": [],
+      "style": "normal"
+    },
+    {
+      "_key": "c0313627775e",
+      "_type": "objectField",
+      "objectAsField": {
+        "_type": "childObjectField",
+        "content": [
+          {
+            "_key": "4f24f6fbfae7",
+            "_type": "block",
+            "children": [
+              {
+                "_key": "d68f4288f5b7",
+                "_type": "span",
+                "marks": [],
+                "text": "This is block text in a nested object in an object in top-level block text."
+              }
+            ],
+            "markDefs": [],
+            "style": "normal"
+          }
+        ],
+        "title": "This is a nested object in an object in top-level block text."
+      },
+      "title": "This is an object in top-level block text."
+    },
+    {
+      "_key": "9e2ab13c6d63",
+      "_type": "block",
+      "children": [
+        {
+          "_key": "17e856dc4766",
+          "_type": "span",
+          "marks": [],
+          "text": "This is h1 text"
+        }
+      ],
+      "markDefs": [],
+      "style": "h1"
+    },
+    {
+      "_key": "297142fbaf21",
+      "_type": "block",
+      "children": [
+        {
+          "_key": "0b2f9e94a161",
+          "_type": "span",
+          "marks": [],
+          "text": "This is h2 text"
+        }
+      ],
+      "markDefs": [],
+      "style": "h2"
+    },
+    {
+      "_key": "76e648fc3845",
+      "_type": "block",
+      "children": [
+        {
+          "_key": "49f466bbc78c",
+          "_type": "span",
+          "marks": [],
+          "text": "Bullet 1"
+        }
+      ],
+      "level": 1,
+      "listItem": "bullet",
+      "markDefs": [],
+      "style": "normal"
+    },
+    {
+      "_key": "d090cd8b27d2",
+      "_type": "block",
+      "children": [
+        {
+          "_key": "599c6991018f",
+          "_type": "span",
+          "marks": [],
+          "text": "nested bullet a"
+        }
+      ],
+      "level": 2,
+      "listItem": "bullet",
+      "markDefs": [],
+      "style": "normal"
+    },
+    {
+      "_key": "1cdffa5d50f5",
+      "_type": "block",
+      "children": [
+        {
+          "_key": "c16eb16f01cb",
+          "_type": "span",
+          "marks": [],
+          "text": "Styled bullet 2"
+        }
+      ],
+      "level": 1,
+      "listItem": "bullet",
+      "markDefs": [],
+      "style": "h2"
+    },
+    {
+      "_key": "da29f5063059",
+      "_type": "block",
+      "children": [
+        {
+          "_key": "e3d7e3eaad54",
+          "_type": "span",
+          "marks": [],
+          "text": "Number 1"
+        }
+      ],
+      "level": 1,
+      "listItem": "number",
+      "markDefs": [],
+      "style": "h3"
+    }
+  ],
+  "hidden": true,
+  "meta": "Do not translate this",
+  "snippet": "This is text in my text field.",
+  "tags": ["tag 1", "tag 2", "tag 3"],
+  "title": "My Document-Level Article"
+}

package/src/serialization/__tests__/__fixtures__/fieldLevelArticle.json

@@ -0,0 +1,107 @@
+{
+  "_createdAt": "2021-10-10T23:00:13Z",
+  "_id": "drafts.2947533e-1ea5-4116-955b-339608d3445d",
+  "_rev": "l58oha-n06-1s4-f6i-74g6cuakl",
+  "_type": "fieldLevelArticle",
+  "_updatedAt": "2021-10-10T23:02:05Z",
+  "slug": {
+    "_type": "slug",
+    "current": "happy-kitchen-hamburger"
+  },
+  "config": {
+    "en": {
+      "_type": "objectField",
+      "nestedArrayField": [
+        {
+          "_key": "f49b4d7e3e51",
+          "_type": "block",
+          "children": [
+            {
+              "_key": "a6170f21181c",
+              "_type": "span",
+              "marks": [],
+              "text": "This is block text 1 level deep"
+            }
+          ],
+          "markDefs": [],
+          "style": "normal"
+        }
+      ],
+      "objectAsField": {
+        "_type": "childObjectField",
+        "content": [
+          {
+            "_key": "869168fe3a2a",
+            "_type": "block",
+            "children": [
+              {
+                "_key": "10d423df228a",
+                "_type": "span",
+                "marks": [],
+                "text": "This is block text 2 levels deep"
+              }
+            ],
+            "markDefs": [],
+            "style": "normal"
+          }
+        ],
+        "title": "This is one level deeper"
+      },
+      "title": "This is an object nested in a document"
+    }
+  },
+  "content": {
+    "en": [
+      {
+        "_key": "e2a39d768ff8",
+        "_type": "block",
+        "children": [
+          {
+            "_key": "216e97c5a5cc",
+            "_type": "span",
+            "marks": [],
+            "text": "This is block text at the top level."
+          }
+        ],
+        "markDefs": [],
+        "style": "normal"
+      },
+      {
+        "_key": "271b0c6ee984",
+        "_type": "objectField",
+        "objectAsField": {
+          "_type": "childObjectField",
+          "content": [
+            {
+              "_key": "4f24f6fbfae7",
+              "_type": "block",
+              "children": [
+                {
+                  "_key": "d68f4288f5b7",
+                  "_type": "span",
+                  "marks": [],
+                  "text": "This is block text in a nested object in an object in top-level block text."
+                }
+              ],
+              "markDefs": [],
+              "style": "normal"
+            }
+          ],
+          "title": "This is a nested object in an object in top-level block text."
+        },
+        "title": "This is an object in top-level block text."
+      }
+    ]
+  },
+  "hidden": true,
+  "meta": "Do not translate this",
+  "snippet": {
+    "en": "This is text in my text field"
+  },
+  "tags": {
+    "en": ["tag 1", "tag 2", "tag 3"]
+  },
+  "title": {
+    "en": "My Field-Level Article"
+  }
+}

package/src/serialization/__tests__/__fixtures__/inlineDocumentLevelArticle.json

@@ -0,0 +1,134 @@
+{
+  "_id": "drafts.d8ffc675-ce86-4f60-9ac8-da164cde3b0a",
+  "_rev": "fxcnqj-uew-gr7-v6r-z965tfm69",
+  "_type": "documentLevelArticle",
+  "_createdAt": "2021-09-01T23:00:13Z",
+  "_updatedAt": "2021-09-01T23:02:05Z",
+  "tabs": {
+    "_type": "object",
+    "config": {
+      "_type": "objectField",
+      "nestedArrayField": [
+        {
+          "_key": "4a58adc7c507",
+          "_type": "block",
+          "children": [
+            {
+              "_key": "4f6bc15ae261",
+              "_type": "span",
+              "marks": [],
+              "text": "This is block text 1 level deep"
+            }
+          ],
+          "markDefs": [],
+          "style": "normal"
+        }
+      ],
+      "objectAsField": {
+        "_type": "object",
+        "content": [
+          {
+            "_key": "1aa228ac848b",
+            "_type": "block",
+            "children": [
+              {
+                "_key": "e2cf67af8e62",
+                "_type": "span",
+                "marks": [],
+                "text": "This is a block text 2 levels deep"
+              }
+            ],
+            "markDefs": [],
+            "style": "normal"
+          }
+        ],
+        "title": "This is one level deeper"
+      },
+      "title": "This is an object nested in a document"
+    },
+    "content": [
+      {
+        "_key": "a4d177e92666",
+        "_type": "block",
+        "children": [
+          {
+            "_key": "a896ea6fcd59",
+            "_type": "span",
+            "marks": [],
+            "text": "This is block text at the top level."
+          }
+        ],
+        "markDefs": [],
+        "style": "normal"
+      },
+      {
+        "_key": "c0313627775e",
+        "_type": "objectField",
+        "objectAsField": {
+          "_type": "childObjectField",
+          "content": [
+            {
+              "_key": "4f24f6fbfae7",
+              "_type": "block",
+              "children": [
+                {
+                  "_key": "d68f4288f5b7",
+                  "_type": "span",
+                  "marks": [],
+                  "text": "This is block text in a nested object in an object in top-level block text."
+                }
+              ],
+              "markDefs": [],
+              "style": "normal"
+            }
+          ],
+          "title": "This is a nested object in an object in top-level block text."
+        },
+        "title": "This is an object in top-level block text."
+      },
+      {
+        "_key": "9e2ab13c6d63",
+        "_type": "block",
+        "children": [
+          {
+            "_key": "17e856dc4766",
+            "_type": "span",
+            "marks": [],
+            "text": "This is h1 text"
+          }
+        ],
+        "markDefs": [],
+        "style": "h1"
+      },
+      {
+        "_key": "297142fbaf21",
+        "_type": "block",
+        "children": [
+          {
+            "_key": "0b2f9e94a161",
+            "_type": "span",
+            "marks": [],
+            "text": "This is h2 text"
+          }
+        ],
+        "markDefs": [],
+        "style": "h2"
+      }
+    ],
+    "hidden": true,
+    "meta": "Do not translate this",
+    "snippet": "This is text in my text field.",
+    "tags": ["tag 1", "tag 2", "tag 3"],
+    "title": "My Document-Level Article",
+    "arrayWithAnonymousObjects": [
+      {
+        "_key": "4c146e0ab346",
+        "cells": ["Standard", "Americas", "EMEA"]
+      },
+      {
+        "_key": "038f8c197939",
+        "cells": ["Friends", "Family", "Other"]
+      }
+    ]
+  }
+}

package/src/serialization/__tests__/__fixtures__/inlineSchema.ts

@@ -0,0 +1,270 @@
+import { Schema } from '@sanity/schema';
+
+const arrayField = {
+  name: 'arrayField',
+  title: 'Array Field',
+  type: 'array',
+  of: [
+    { type: 'block' },
+    {
+      type: 'object',
+      fields: [
+        {
+          name: 'title',
+          title: 'Title',
+          type: 'string',
+        },
+        {
+          name: 'objectAsField',
+          title: 'Object As Field',
+          type: 'object',
+          fields: [
+            {
+              name: 'title',
+              title: 'Title',
+              type: 'string',
+            },
+            {
+              name: 'content',
+              title: 'Content',
+              type: 'array',
+              of: [{ type: 'block' }],
+            },
+          ],
+        },
+        {
+          name: 'nestedArrayField',
+          title: 'Nested Array Field',
+          type: 'array',
+          of: [{ type: 'block' }, { type: 'childObjectField' }],
+        },
+      ],
+    },
+  ],
+};
+
+const childObjectField = {
+  name: 'childObjectField',
+  title: 'Child Object Field',
+  type: 'object',
+  fields: [
+    {
+      name: 'title',
+      title: 'Title',
+      type: 'string',
+    },
+    {
+      name: 'content',
+      title: 'Content',
+      type: 'array',
+      of: [{ type: 'block' }],
+    },
+  ],
+};
+
+const objectField = {
+  name: 'objectField',
+  title: 'Object Field',
+  type: 'object',
+  fields: [
+    {
+      name: 'title',
+      title: 'Title',
+      type: 'string',
+    },
+    {
+      name: 'objectAsField',
+      title: 'Object As Field',
+      type: 'object',
+      fields: [
+        {
+          name: 'title',
+          title: 'Title',
+          type: 'string',
+        },
+        {
+          name: 'content',
+          title: 'Content',
+          type: 'array',
+          of: [{ type: 'block' }],
+        },
+      ],
+    },
+    {
+      name: 'nestedArrayField',
+      title: 'Nested Array Field',
+      type: 'array',
+      of: [{ type: 'block' }, { type: 'childObjectField' }],
+    },
+  ],
+};
+
+const documentLevelArticle = {
+  name: 'documentLevelArticle',
+  title: 'Document Level Article',
+  type: 'document',
+  fields: [
+    {
+      name: 'tabs',
+      type: 'object',
+      fields: [
+        {
+          name: 'title',
+          title: 'Title',
+          type: 'string',
+        },
+        {
+          name: 'meta',
+          title: 'Meta',
+          type: 'string',
+          localize: false,
+        },
+        {
+          name: 'snippet',
+          title: 'Snippet',
+          type: 'text',
+        },
+        {
+          name: 'tags',
+          title: 'Tags',
+          type: 'array',
+          of: [{ type: 'string' }],
+        },
+        {
+          name: 'hidden',
+          title: 'Hidden',
+          type: 'boolean',
+        },
+        {
+          name: 'config',
+          title: 'Config',
+          type: 'objectField',
+        },
+        {
+          name: 'content',
+          title: 'Content',
+          type: 'arrayField',
+        },
+      ],
+    },
+  ],
+};
+
+function createLocaleFields(locales: string[], fieldType: Record<string, any>) {
+  return locales.map((locale) => ({
+    ...{ name: locale },
+    ...fieldType,
+  }));
+}
+
+const fieldLevelArticle = {
+  name: 'fieldLevelArticle',
+  title: 'Field Level Article',
+  type: 'document',
+  fields: [
+    {
+      name: 'title',
+      title: 'Title',
+      type: 'localeString',
+    },
+    {
+      name: 'meta',
+      title: 'Meta',
+      type: 'string',
+      localize: false,
+    },
+    {
+      name: 'snippet',
+      title: 'Snippet',
+      type: 'object',
+      fields: createLocaleFields(['en', 'fr', 'de'], { type: 'text' }),
+    },
+    {
+      name: 'tags',
+      title: 'Tags',
+      type: 'object',
+      fields: createLocaleFields(['en', 'fr', 'de'], {
+        type: 'array',
+        of: [{ type: 'string' }],
+      }),
+    },
+    {
+      name: 'hidden',
+      title: 'Hidden',
+      type: 'boolean',
+    },
+    {
+      name: 'config',
+      title: 'Config',
+      type: 'object',
+      fields: createLocaleFields(['en', 'fr', 'de'], { type: 'objectField' }),
+    },
+    {
+      name: 'content',
+      title: 'Content',
+      type: 'object',
+      fields: createLocaleFields(['en', 'fr', 'de'], { type: 'arrayField' }),
+    },
+    {
+      name: 'slices',
+      title: 'Slices',
+      type: 'array',
+      of: [
+        { type: 'localeBlock' },
+        { type: 'reference', to: [{ type: 'marketText' }] },
+      ],
+    },
+    {
+      name: 'pageFields',
+      title: 'Page Fields',
+      type: 'pageFields',
+    },
+  ],
+};
+
+const localeBlock = {
+  name: 'localeBlock',
+  title: 'Locale Block',
+  type: 'object',
+  fields: createLocaleFields(['en', 'fr_FR', 'de_DE'], { type: 'arrayField' }),
+};
+
+const localeString = {
+  name: 'localeString',
+  title: 'Locale String',
+  type: 'object',
+  fields: createLocaleFields(['en', 'fr_FR', 'de_DE'], { type: 'string' }),
+};
+
+const pageFields = {
+  name: 'pageFields',
+  title: 'Page Fields',
+  type: 'object',
+  fields: [
+    {
+      title: 'Page Name',
+      name: 'name',
+      type: 'localeString',
+    },
+    {
+      name: 'slug',
+      type: 'string',
+    },
+  ],
+};
+
+const types = [
+  arrayField,
+  childObjectField,
+  objectField,
+  documentLevelArticle,
+  fieldLevelArticle,
+  pageFields,
+  localeBlock,
+  localeString,
+];
+
+export default new Schema({
+  name: 'test',
+  types,
+});