@sanity/cli 6.0.0-alpha.5 → 6.0.0-alpha.6

package/templates/shopify/schemaTypes/objects/shopify/shopifyProductType.ts

@@ -0,0 +1,131 @@
+import {defineArrayMember, defineField} from 'sanity'
+
+export const shopifyProductType = defineField({
+  name: 'shopifyProduct',
+  title: 'Shopify',
+  type: 'object',
+  options: {
+    collapsed: false,
+    collapsible: true,
+  },
+  readOnly: true,
+  fieldsets: [
+    {
+      name: 'status',
+      title: 'Status',
+    },
+    {
+      name: 'organization',
+      title: 'Organization',
+      options: {
+        columns: 2,
+      },
+    },
+    {
+      name: 'variants',
+      title: 'Variants',
+      options: {
+        collapsed: true,
+        collapsible: true,
+      },
+    },
+  ],
+  fields: [
+    defineField({
+      fieldset: 'status',
+      name: 'createdAt',
+      type: 'string',
+    }),
+    defineField({
+      fieldset: 'status',
+      name: 'updatedAt',
+      type: 'string',
+    }),
+    defineField({
+      fieldset: 'status',
+      name: 'status',
+      type: 'string',
+      options: {
+        layout: 'dropdown',
+        list: ['active', 'archived', 'draft'],
+      },
+    }),
+    defineField({
+      fieldset: 'status',
+      name: 'isDeleted',
+      title: 'Deleted from Shopify?',
+      type: 'boolean',
+    }),
+    defineField({
+      name: 'title',
+      type: 'string',
+      description: 'Title displayed in both cart and checkout',
+    }),
+    defineField({
+      name: 'id',
+      title: 'ID',
+      type: 'number',
+      description: 'Shopify Product ID',
+    }),
+    defineField({
+      name: 'gid',
+      title: 'GID',
+      type: 'string',
+      description: 'Shopify Product GID',
+    }),
+    defineField({
+      name: 'slug',
+      type: 'slug',
+      description: 'Shopify Product handle',
+    }),
+    defineField({
+      name: 'descriptionHtml',
+      title: 'HTML Description',
+      type: 'text',
+      rows: 5,
+    }),
+    defineField({
+      fieldset: 'organization',
+      name: 'productType',
+      type: 'string',
+    }),
+    defineField({
+      fieldset: 'organization',
+      name: 'vendor',
+      type: 'string',
+    }),
+    defineField({
+      fieldset: 'organization',
+      name: 'tags',
+      type: 'string',
+    }),
+    defineField({
+      name: 'priceRange',
+      type: 'priceRange',
+    }),
+    defineField({
+      name: 'previewImageUrl',
+      title: 'Preview Image URL',
+      type: 'string',
+      description: 'Image displayed in both cart and checkout',
+    }),
+    defineField({
+      name: 'options',
+      type: 'array',
+      of: [{type: 'option'}],
+    }),
+    defineField({
+      fieldset: 'variants',
+      name: 'variants',
+      type: 'array',
+      of: [
+        defineArrayMember({
+          title: 'Variant',
+          type: 'reference',
+          weak: true,
+          to: [{type: 'productVariant'}],
+        }),
+      ],
+    }),
+  ],
+})

package/templates/shopify/schemaTypes/objects/shopify/shopifyProductVariantType.ts

@@ -0,0 +1,121 @@
+import {defineField} from 'sanity'
+
+export const shopifyProductVariantType = defineField({
+  name: 'shopifyProductVariant',
+  title: 'Shopify',
+  type: 'object',
+  options: {
+    collapsed: false,
+    collapsible: true,
+  },
+  fieldsets: [
+    {
+      name: 'options',
+      title: 'Options',
+      options: {
+        columns: 3,
+      },
+    },
+    {
+      name: 'status',
+      title: 'Status',
+    },
+  ],
+  fields: [
+    defineField({
+      fieldset: 'status',
+      name: 'createdAt',
+      type: 'string',
+    }),
+    defineField({
+      fieldset: 'status',
+      name: 'updatedAt',
+      type: 'string',
+    }),
+    defineField({
+      fieldset: 'status',
+      name: 'status',
+      type: 'string',
+      options: {
+        layout: 'dropdown',
+        list: ['active', 'archived', 'draft'],
+      },
+      validation: (Rule) => Rule.required(),
+    }),
+    defineField({
+      fieldset: 'status',
+      name: 'isDeleted',
+      title: 'Deleted from Shopify?',
+      type: 'boolean',
+    }),
+    defineField({
+      name: 'title',
+      type: 'string',
+    }),
+    defineField({
+      name: 'sku',
+      title: 'SKU',
+      type: 'string',
+    }),
+    defineField({
+      name: 'id',
+      title: 'ID',
+      type: 'number',
+      description: 'Shopify Product Variant ID',
+    }),
+    defineField({
+      name: 'gid',
+      title: 'GID',
+      type: 'string',
+      description: 'Shopify Product Variant GID',
+    }),
+    defineField({
+      name: 'productId',
+      title: 'Product ID',
+      type: 'number',
+    }),
+    defineField({
+      name: 'productGid',
+      title: 'Product GID',
+      type: 'string',
+    }),
+    defineField({
+      name: 'price',
+      type: 'number',
+    }),
+    defineField({
+      name: 'compareAtPrice',
+      type: 'number',
+    }),
+    defineField({
+      name: 'inventory',
+      type: 'inventory',
+      options: {
+        columns: 3,
+      },
+    }),
+    defineField({
+      fieldset: 'options',
+      name: 'option1',
+      type: 'string',
+    }),
+    defineField({
+      fieldset: 'options',
+      name: 'option2',
+      type: 'string',
+    }),
+    defineField({
+      fieldset: 'options',
+      name: 'option3',
+      type: 'string',
+    }),
+    // Preview Image URL
+    defineField({
+      name: 'previewImageUrl',
+      title: 'Preview Image URL',
+      type: 'string',
+      description: 'Image displayed in both cart and checkout',
+    }),
+  ],
+  readOnly: true,
+})

package/templates/shopify/schemaTypes/portableText/portableTextSimpleType.tsx

@@ -0,0 +1,45 @@
+import {defineArrayMember, defineField} from 'sanity'
+
+export const portableTextSimpleType = defineField({
+  name: 'portableTextSimple',
+  type: 'array',
+  of: [
+    defineArrayMember({
+      lists: [
+        {title: 'Bullet', value: 'bullet'},
+        {title: 'Numbered', value: 'number'},
+      ],
+      marks: {
+        decorators: [
+          {
+            title: 'Italic',
+            value: 'em',
+          },
+          {
+            title: 'Strong',
+            value: 'strong',
+          },
+        ],
+        annotations: [
+          {
+            name: 'linkProduct',
+            type: 'linkProduct',
+          },
+          {
+            name: 'linkEmail',
+            type: 'linkEmail',
+          },
+          {
+            name: 'linkInternal',
+            type: 'linkInternal',
+          },
+          {
+            name: 'linkExternal',
+            type: 'linkExternal',
+          },
+        ],
+      },
+      type: 'block',
+    }),
+  ],
+})

package/templates/shopify/schemaTypes/portableText/portableTextType.tsx

@@ -0,0 +1,52 @@
+import {defineArrayMember, defineField} from 'sanity'
+
+export const portableTextType = defineField({
+  name: 'portableText',
+  type: 'array',
+  of: [
+    defineArrayMember({
+      lists: [
+        {title: 'Bullet', value: 'bullet'},
+        {title: 'Numbered', value: 'number'},
+      ],
+      marks: {
+        decorators: [
+          {
+            title: 'Italic',
+            value: 'em',
+          },
+          {
+            title: 'Strong',
+            value: 'strong',
+          },
+        ],
+        annotations: [
+          {
+            name: 'linkProduct',
+            type: 'linkProduct',
+          },
+          {
+            name: 'linkEmail',
+            type: 'linkEmail',
+          },
+          {
+            name: 'linkInternal',
+            type: 'linkInternal',
+          },
+          {
+            name: 'linkExternal',
+            type: 'linkExternal',
+          },
+        ],
+      },
+      type: 'block',
+    }),
+    defineArrayMember({type: 'accordion'}),
+    defineArrayMember({type: 'callout'}),
+    defineArrayMember({type: 'grid'}),
+    defineArrayMember({type: 'images'}),
+    defineArrayMember({type: 'imageWithProductHotspots', title: 'Image with Hotspots'}),
+    defineArrayMember({type: 'instagram'}),
+    defineArrayMember({type: 'products'}),
+  ],
+})

package/templates/shopify/schemaTypes/singletons/homeType.ts

@@ -0,0 +1,49 @@
+import {HomeIcon} from '@sanity/icons'
+import {defineArrayMember, defineField} from 'sanity'
+import {GROUPS} from '../../constants'
+
+const TITLE = 'Home'
+
+export const homeType = defineField({
+  name: 'home',
+  title: TITLE,
+  type: 'document',
+  icon: HomeIcon,
+  groups: GROUPS,
+  fields: [
+    defineField({
+      name: 'hero',
+      type: 'hero',
+      group: 'editorial',
+    }),
+    defineField({
+      name: 'modules',
+      type: 'array',
+      of: [
+        defineArrayMember({type: 'accordion'}),
+        defineArrayMember({type: 'callout'}),
+        defineArrayMember({type: 'grid'}),
+        defineArrayMember({type: 'images'}),
+        defineArrayMember({type: 'imageWithProductHotspots', title: 'Image with Hotspots'}),
+        defineArrayMember({type: 'instagram'}),
+        defineArrayMember({type: 'products'}),
+      ],
+      group: 'editorial',
+    }),
+    defineField({
+      name: 'seo',
+      title: 'SEO',
+      type: 'seo',
+      group: 'seo',
+    }),
+  ],
+  preview: {
+    prepare() {
+      return {
+        media: HomeIcon,
+        subtitle: 'Index',
+        title: TITLE,
+      }
+    },
+  },
+})

package/templates/shopify/schemaTypes/singletons/settingsType.ts

@@ -0,0 +1,96 @@
+import {CogIcon, ControlsIcon, ErrorOutlineIcon, MenuIcon, SearchIcon} from '@sanity/icons'
+import {defineType, defineField} from 'sanity'
+
+const TITLE = 'Settings'
+interface ProductOptions {
+  title: string
+}
+
+export const settingsType = defineType({
+  name: 'settings',
+  title: TITLE,
+  type: 'document',
+  icon: CogIcon,
+  groups: [
+    {
+      default: true,
+      name: 'navigation',
+      title: 'Navigation',
+      icon: MenuIcon,
+    },
+    {
+      name: 'productOptions',
+      title: 'Product options',
+      icon: ControlsIcon,
+    },
+    {
+      name: 'notFoundPage',
+      title: '404 page',
+      icon: ErrorOutlineIcon,
+    },
+    {
+      name: 'seo',
+      title: 'SEO',
+      icon: SearchIcon,
+    },
+  ],
+  fields: [
+    defineField({
+      name: 'menu',
+      type: 'menu',
+      group: 'navigation',
+    }),
+    defineField({
+      name: 'footer',
+      type: 'footerSettings',
+      group: 'navigation',
+    }),
+    defineField({
+      name: 'customProductOptions',
+      type: 'array',
+      group: 'productOptions',
+      of: [
+        {
+          name: 'customProductOption.color',
+          type: 'customProductOption.color',
+        },
+        {
+          name: 'customProductOption.size',
+          type: 'customProductOption.size',
+        },
+      ],
+      validation: (Rule) =>
+        Rule.custom((options: ProductOptions[] | undefined) => {
+          // Each product option type must have a unique title
+          if (options) {
+            const uniqueTitles = new Set(options.map((option) => option.title))
+            if (options.length > uniqueTitles.size) {
+              return 'Each product option type must have a unique title'
+            }
+          }
+          return true
+        }),
+    }),
+    // Not found page
+    defineField({
+      name: 'notFoundPage',
+      title: '404 page',
+      type: 'notFoundPage',
+      group: 'notFoundPage',
+    }),
+    // SEO
+    defineField({
+      name: 'seo',
+      title: 'SEO',
+      type: 'seo',
+      group: 'seo',
+    }),
+  ],
+  preview: {
+    prepare() {
+      return {
+        title: TITLE,
+      }
+    },
+  },
+})

package/templates/shopify/static/.gitkeep

@@ -0,0 +1 @@
+Files placed here will be served by the Sanity server under the `/static`-prefix

package/templates/shopify/structure/collectionStructure.ts

@@ -0,0 +1,9 @@
+import {ListItemBuilder} from 'sanity/structure'
+import defineStructure from '../utils/defineStructure'
+
+export default defineStructure<ListItemBuilder>((S) =>
+  S.listItem()
+    .title('Collections')
+    .schemaType('collection')
+    .child(S.documentTypeList('collection')),
+)

package/templates/shopify/structure/colorThemeStructure.ts

@@ -0,0 +1,9 @@
+import {ListItemBuilder} from 'sanity/structure'
+import defineStructure from '../utils/defineStructure'
+
+export default defineStructure<ListItemBuilder>((S) =>
+  S.listItem()
+    .title('Color themes')
+    .schemaType('colorTheme')
+    .child(S.documentTypeList('colorTheme')),
+)

package/templates/shopify/structure/homeStructure.ts

@@ -0,0 +1,9 @@
+import {ListItemBuilder} from 'sanity/structure'
+import defineStructure from '../utils/defineStructure'
+
+export default defineStructure<ListItemBuilder>((S) =>
+  S.listItem()
+    .title('Home')
+    .schemaType('home')
+    .child(S.editor().title('Home').schemaType('home').documentId('home')),
+)

package/templates/shopify/structure/index.ts

@@ -0,0 +1,57 @@
+import {ListItemBuilder, StructureResolver} from 'sanity/structure'
+import collections from './collectionStructure'
+import colorThemes from './colorThemeStructure'
+import home from './homeStructure'
+import pages from './pageStructure'
+import products from './productStructure'
+import settings from './settingStructure'
+
+/**
+ * Structure overrides
+ *
+ * Sanity Studio automatically lists document types out of the box.
+ * With this custom structure we achieve things like showing the `home`
+ * and `settings` document types as singletons, and grouping product details
+ * and variants for easy editorial access.
+ *
+ * You can customize this even further as your schema types progress.
+ * To learn more about structure builder, visit our docs:
+ * https://www.sanity.io/docs/overview-structure-builder
+ */
+
+// If you add document types to structure manually, you can add them to this function to prevent duplicates in the root pane
+const hiddenDocTypes = (listItem: ListItemBuilder) => {
+  const id = listItem.getId()
+
+  if (!id) {
+    return false
+  }
+
+  return ![
+    'collection',
+    'colorTheme',
+    'home',
+    'media.tag',
+    'page',
+    'product',
+    'productVariant',
+    'settings',
+  ].includes(id)
+}
+
+export const structure: StructureResolver = (S, context) =>
+  S.list()
+    .title('Content')
+    .items([
+      home(S, context),
+      pages(S, context),
+      S.divider(),
+      collections(S, context),
+      products(S, context),
+      S.divider(),
+      colorThemes(S, context),
+      S.divider(),
+      settings(S, context),
+      S.divider(),
+      ...S.documentTypeListItems().filter(hiddenDocTypes),
+    ])

package/templates/shopify/structure/pageStructure.ts

@@ -0,0 +1,11 @@
+import {DocumentsIcon} from '@sanity/icons'
+import {ListItemBuilder} from 'sanity/structure'
+import defineStructure from '../utils/defineStructure'
+
+export default defineStructure<ListItemBuilder>((S) =>
+  S.listItem()
+    .title('Pages')
+    .icon(DocumentsIcon)
+    .schemaType('page')
+    .child(S.documentTypeList('page')),
+)

package/templates/shopify/structure/productStructure.ts

@@ -0,0 +1,51 @@
+import {InfoOutlineIcon} from '@sanity/icons'
+import {ListItemBuilder} from 'sanity/structure'
+import defineStructure from '../utils/defineStructure'
+
+export default defineStructure<ListItemBuilder>((S) =>
+  S.listItem()
+    .title('Products')
+    .schemaType('product')
+    .child(
+      S.documentTypeList('product')
+        // .defaultLayout('detail')
+        .child(async (id) =>
+          S.list()
+            .title('Product')
+            .canHandleIntent(
+              (intentName, params) => intentName === 'edit' && params.type === 'product',
+            )
+            .items([
+              // Details
+              S.listItem()
+                .title('Details')
+                .icon(InfoOutlineIcon)
+                .schemaType('product')
+                .id(id)
+                .child(S.document().schemaType('product').documentId(id)),
+              // Product variants
+              S.listItem()
+                .title('Variants')
+                .schemaType('productVariant')
+                .child(
+                  S.documentList()
+                    .title('Variants')
+                    .schemaType('productVariant')
+                    .filter(
+                      `
+                      _type == "productVariant"
+                      && store.productId == $productId
+                    `,
+                    )
+                    .params({
+                      productId: Number(id.replace('shopifyProduct-', '')),
+                    })
+                    .canHandleIntent(
+                      (intentName, params) =>
+                        intentName === 'edit' && params.type === 'productVariant',
+                    ),
+                ),
+            ]),
+        ),
+    ),
+)

package/templates/shopify/structure/settingStructure.ts

@@ -0,0 +1,9 @@
+import {ListItemBuilder} from 'sanity/structure'
+import defineStructure from '../utils/defineStructure'
+
+export default defineStructure<ListItemBuilder>((S) =>
+  S.listItem()
+    .title('Settings')
+    .schemaType('settings')
+    .child(S.editor().title('Settings').schemaType('settings').documentId('settings')),
+)

package/templates/shopify/utils/blocksToText.ts

@@ -0,0 +1,20 @@
+import type {PortableTextBlock} from '@portabletext/types'
+
+const defaults = {nonTextBehavior: 'remove'}
+
+export default function (blocks: PortableTextBlock[] = [], opts = {}) {
+  if (typeof blocks === 'string') {
+    return blocks
+  }
+
+  const options = Object.assign({}, defaults, opts)
+  return blocks
+    .map((block) => {
+      if (block._type !== 'block' || !block.children) {
+        return options.nonTextBehavior === 'remove' ? '' : `[${block._type} block]`
+      }
+
+      return block.children.map((child) => child.text).join('')
+    })
+    .join('\n\n')
+}

package/templates/shopify/utils/defineStructure.ts

@@ -0,0 +1,11 @@
+import {ConfigContext} from 'sanity'
+import {StructureBuilder} from 'sanity/structure'
+
+/**
+ * Helper for creating and typing composable structure parts.
+ */
+export default function defineStructure<StructureType>(
+  factory: (S: StructureBuilder, context: ConfigContext) => StructureType,
+) {
+  return factory
+}