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

package/templates/shopify-online-storefront/schemaTypes/blocks/blockContent.ts

@@ -0,0 +1,32 @@
+import {defineField, defineArrayMember} from 'sanity'
+
+/**
+ * This is the schema definition for the rich text fields used for
+ * for this blog studio. When you import it in schemas.js it can be
+ * reused in other parts of the studio with:
+ *  {
+ *    name: 'someName',
+ *    title: 'Some title',
+ *    type: 'blockContent'
+ *  }
+ */
+export default defineField({
+  title: 'Block Content',
+  name: 'blockContent',
+  type: 'array',
+  of: [
+    defineArrayMember({
+      title: 'Block',
+      type: 'block',
+    }),
+    // You can add additional types here. Note that you can't use
+    // primitive types such as 'string' and 'number' in the same array
+    // as a block type.
+    defineArrayMember({
+      type: 'callout',
+    }),
+    defineArrayMember({
+      type: 'accordion',
+    }),
+  ],
+})

package/templates/shopify-online-storefront/schemaTypes/documents/collection.tsx

@@ -0,0 +1,83 @@
+import React from 'react'
+import {defineField, defineType} from 'sanity'
+import {PackageIcon} from '@sanity/icons'
+import pluralize from 'pluralize-esm'
+import CollectionHiddenInput from '../../components/inputs/CollectionHidden'
+import ShopifyIcon from '../../components/icons/Shopify'
+import ShopifyDocumentStatus from '../../components/media/ShopifyDocumentStatus'
+
+const GROUPS = [
+  {
+    name: 'theme',
+    title: 'Theme',
+  },
+  {
+    default: true,
+    name: 'editorial',
+    title: 'Editorial',
+  },
+  {
+    name: 'shopifySync',
+    title: 'Shopify sync',
+    icon: ShopifyIcon,
+  },
+  {
+    name: 'seo',
+    title: 'SEO',
+  },
+]
+
+export default defineType({
+  name: 'collection',
+  title: 'Collection',
+  type: 'document',
+  icon: PackageIcon,
+  groups: GROUPS,
+  fields: [
+    // Product hidden status
+    defineField({
+      name: 'hidden',
+      type: 'string',
+      components: {
+        field: CollectionHiddenInput,
+      },
+      hidden: ({parent}) => {
+        const isDeleted = parent?.store?.isDeleted
+        return !isDeleted
+      },
+    }),
+    // Shopify collection
+    defineField({
+      name: 'store',
+      title: 'Shopify',
+      type: 'shopifyCollection',
+      description: 'Collection data from Shopify (read-only)',
+      group: 'shopifySync',
+    }),
+  ],
+  preview: {
+    select: {
+      imageUrl: 'store.imageUrl',
+      isDeleted: 'store.isDeleted',
+      rules: 'store.rules',
+      title: 'store.title',
+    },
+    prepare(selection) {
+      const {imageUrl, isDeleted, rules, title} = selection
+      const ruleCount = rules?.length || 0
+
+      return {
+        media: (
+          <ShopifyDocumentStatus
+            isDeleted={isDeleted}
+            type="collection"
+            url={imageUrl}
+            title={title}
+          />
+        ),
+        subtitle: ruleCount > 0 ? `Automated (${pluralize('rule', ruleCount, true)})` : 'Manual',
+        title,
+      }
+    },
+  },
+})

package/templates/shopify-online-storefront/schemaTypes/documents/product.tsx

@@ -0,0 +1,102 @@
+import React from 'react'
+import {TagIcon} from '@sanity/icons'
+import {defineField, defineType} from 'sanity'
+import pluralize from 'pluralize-esm'
+import ShopifyIcon from '../../components/icons/Shopify'
+import ProductHiddenInput from '../../components/inputs/ProductHidden'
+import ShopifyDocumentStatus from '../../components/media/ShopifyDocumentStatus'
+import {getPriceRange} from '../../utils/getPriceRange'
+
+const GROUPS = [
+  {
+    name: 'editorial',
+    title: 'Editorial',
+    default: true,
+  },
+  {
+    name: 'shopifySync',
+    title: 'Shopify sync',
+    icon: ShopifyIcon,
+  },
+]
+
+export default defineType({
+  name: 'product',
+  title: 'Product',
+  type: 'document',
+  icon: TagIcon,
+  groups: GROUPS,
+  fields: [
+    defineField({
+      name: 'hidden',
+      type: 'string',
+      components: {
+        field: ProductHiddenInput,
+      },
+      group: GROUPS.map((group) => group.name),
+      hidden: ({parent}) => {
+        const isActive = parent?.store?.status === 'active'
+        const isDeleted = parent?.store?.isDeleted
+        return !parent?.store || (isActive && !isDeleted) || (isActive && !isDeleted)
+      },
+    }),
+    defineField({
+      name: 'body',
+      type: 'blockContent',
+      group: 'editorial',
+    }),
+    defineField({
+      name: 'store',
+      title: 'Shopify',
+      type: 'shopifyProduct',
+      description: 'Product data from Shopify (read-only)',
+      group: 'shopifySync',
+    }),
+  ],
+  preview: {
+    select: {
+      isDeleted: 'store.isDeleted',
+      options: 'store.options',
+      previewImageUrl: 'store.previewImageUrl',
+      priceRange: 'store.priceRange',
+      status: 'store.status',
+      title: 'store.title',
+      variants: 'store.variants',
+      sanityTitle: 'title',
+    },
+    prepare(selection) {
+      const {isDeleted, options, previewImageUrl, priceRange, status, title, variants} = selection
+
+      const optionCount = options?.length
+      const variantCount = variants?.length
+
+      const description = [
+        variantCount ? pluralize('variant', variantCount, true) : 'No variants',
+        optionCount ? pluralize('option', optionCount, true) : 'No options',
+      ]
+
+      let subtitle = getPriceRange(priceRange)
+      if (status !== 'active') {
+        subtitle = '(Unavailable in Shopify)'
+      }
+      if (isDeleted) {
+        subtitle = '(Deleted from Shopify)'
+      }
+
+      return {
+        description: description.join(' / '),
+        subtitle,
+        title,
+        media: (
+          <ShopifyDocumentStatus
+            isActive={status === 'active'}
+            isDeleted={isDeleted}
+            type="product"
+            url={previewImageUrl}
+            title={title}
+          />
+        ),
+      }
+    },
+  },
+})

package/templates/shopify-online-storefront/schemaTypes/documents/productVariant.tsx

@@ -0,0 +1,82 @@
+import {CopyIcon} from '@sanity/icons'
+import {defineField, defineType} from 'sanity'
+import ShopifyIcon from '../../components/icons/Shopify'
+import ProductVariantHiddenInput from '../../components/inputs/ProductVariantHidden'
+import ShopifyDocumentStatus from '../../components/media/ShopifyDocumentStatus'
+
+const GROUPS = [
+  {
+    name: 'editorial',
+    title: 'Editorial',
+    default: true,
+  },
+  {
+    name: 'shopifySync',
+    title: 'Shopify sync',
+    icon: ShopifyIcon,
+  },
+]
+
+export default defineType({
+  name: 'productVariant',
+  title: 'Product variant',
+  type: 'document',
+  icon: CopyIcon,
+  groups: GROUPS,
+  fields: [
+    // Product variant hidden status
+    defineField({
+      name: 'hidden',
+      type: 'string',
+      components: {
+        field: ProductVariantHiddenInput,
+      },
+      hidden: ({parent}) => {
+        const isDeleted = parent?.store?.isDeleted
+
+        return !isDeleted
+      },
+    }),
+    // Title (proxy)
+    defineField({
+      title: 'Title',
+      name: 'titleProxy',
+      type: 'proxyString',
+      options: {field: 'store.title'},
+    }),
+    // Shopify product variant
+    defineField({
+      name: 'store',
+      title: 'Shopify',
+      description: 'Variant data from Shopify (read-only)',
+      type: 'shopifyProductVariant',
+      group: 'shopifySync',
+    }),
+  ],
+  preview: {
+    select: {
+      isDeleted: 'store.isDeleted',
+      previewImageUrl: 'store.previewImageUrl',
+      sku: 'store.sku',
+      status: 'store.status',
+      title: 'store.title',
+    },
+    prepare(selection) {
+      const {isDeleted, previewImageUrl, sku, status, title} = selection
+
+      return {
+        media: (
+          <ShopifyDocumentStatus
+            isActive={status === 'active'}
+            isDeleted={isDeleted}
+            type="productVariant"
+            url={previewImageUrl}
+            title={title}
+          />
+        ),
+        subtitle: sku,
+        title,
+      }
+    },
+  },
+})

package/templates/shopify-online-storefront/schemaTypes/index.ts

@@ -0,0 +1,43 @@
+// document types
+import collection from './documents/collection'
+import product from './documents/product'
+import productVariant from './documents/productVariant'
+
+// objects
+import accordion from './objects/accordion'
+import accordionGroup from './objects/accordionGroup'
+import callout from './objects/callout'
+import inventory from './objects/inventory'
+import option from './objects/option'
+import priceRange from './objects/priceRange'
+import proxyString from './objects/proxyString'
+import shopifyCollection from './objects/shopifyCollection'
+import shopifyCollectionRule from './objects/shopifyCollectionRule'
+import shopifyProduct from './objects/shopifyProduct'
+import shopifyProductVariant from './objects/shopifyProductVariant'
+
+// block content
+import blockContent from './blocks/blockContent'
+
+export const schemaTypes = [
+  // document types
+  collection,
+  product,
+  productVariant,
+
+  // objects
+  accordion,
+  accordionGroup,
+  callout,
+  inventory,
+  option,
+  priceRange,
+  proxyString,
+  shopifyCollection,
+  shopifyCollectionRule,
+  shopifyProduct,
+  shopifyProductVariant,
+
+  // block content
+  blockContent,
+]

package/templates/shopify-online-storefront/schemaTypes/objects/accordion.ts

@@ -0,0 +1,31 @@
+import {StackCompactIcon} from '@sanity/icons'
+import pluralize from 'pluralize-esm'
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'accordion',
+  title: 'Accordion',
+  type: 'object',
+  icon: StackCompactIcon,
+  fields: [
+    // Groups
+    defineField({
+      name: 'groups',
+      title: 'Groups',
+      type: 'array',
+      of: [{type: 'accordionGroup'}],
+    }),
+  ],
+  preview: {
+    select: {
+      groups: 'groups',
+    },
+    prepare({groups = []}) {
+      return {
+        subtitle: 'Accordion',
+        title: groups.length > 0 ? pluralize('group', groups.length, true) : 'No groups',
+        media: StackCompactIcon,
+      }
+    },
+  },
+})

package/templates/shopify-online-storefront/schemaTypes/objects/accordionGroup.ts

@@ -0,0 +1,35 @@
+import {defineField, defineType} from 'sanity'
+import {toPlainText} from '@portabletext/toolkit'
+
+export default defineType({
+  name: 'accordionGroup',
+  title: 'Group',
+  type: 'object',
+  icon: false,
+  fields: [
+    defineField({
+      name: 'title',
+      title: 'Title',
+      type: 'string',
+      validation: (Rule) => Rule.required(),
+    }),
+    defineField({
+      name: 'body',
+      title: 'Body',
+      type: 'blockContent',
+    }),
+  ],
+  preview: {
+    select: {
+      body: 'body',
+      title: 'title',
+    },
+    prepare(selection) {
+      const {body, title} = selection
+      return {
+        subtitle: body && toPlainText(body),
+        title,
+      }
+    },
+  },
+})

package/templates/shopify-online-storefront/schemaTypes/objects/callout.ts

@@ -0,0 +1,40 @@
+import {BulbOutlineIcon} from '@sanity/icons'
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'callout',
+  title: 'Callout',
+  type: 'object',
+  icon: BulbOutlineIcon,
+  fields: [
+    // Text
+    defineField({
+      name: 'text',
+      title: 'Text',
+      type: 'text',
+      rows: 2,
+      validation: (Rule) => [
+        Rule.required(),
+        Rule.max(70).warning(`Callout length shouldn't be more than 70 characters.`),
+      ],
+    }),
+    // Link
+    defineField({
+      name: 'links',
+      title: 'Link',
+      type: 'url',
+    }),
+  ],
+  preview: {
+    select: {
+      text: 'text',
+    },
+    prepare({text}) {
+      return {
+        subtitle: 'Callout',
+        title: text,
+        media: BulbOutlineIcon,
+      }
+    },
+  },
+})

package/templates/shopify-online-storefront/schemaTypes/objects/inventory.ts

@@ -0,0 +1,30 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'inventory',
+  title: 'Inventory',
+  type: 'object',
+  options: {
+    columns: 3,
+  },
+  fields: [
+    // Available
+    defineField({
+      name: 'isAvailable',
+      title: 'Available',
+      type: 'boolean',
+    }),
+    // Management
+    defineField({
+      name: 'management',
+      title: 'Management',
+      type: 'string',
+    }),
+    // Policy
+    defineField({
+      name: 'policy',
+      title: 'Policy',
+      type: 'string',
+    }),
+  ],
+})

package/templates/shopify-online-storefront/schemaTypes/objects/option.ts

@@ -0,0 +1,30 @@
+import {SunIcon} from '@sanity/icons'
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  title: 'Product option',
+  name: 'option',
+  type: 'object',
+  icon: SunIcon,
+  readOnly: true,
+  fields: [
+    // Name
+    defineField({
+      title: 'Name',
+      name: 'name',
+      type: 'string',
+    }),
+    // Values
+    defineField({
+      title: 'Values',
+      name: 'values',
+      type: 'array',
+      of: [{type: 'string'}],
+    }),
+  ],
+  preview: {
+    select: {
+      title: 'name',
+    },
+  },
+})

package/templates/shopify-online-storefront/schemaTypes/objects/priceRange.ts

@@ -0,0 +1,22 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'priceRange',
+  title: 'Price range',
+  type: 'object',
+  options: {
+    columns: 2,
+  },
+  fields: [
+    defineField({
+      name: 'minVariantPrice',
+      title: 'Min variant price',
+      type: 'number',
+    }),
+    defineField({
+      name: 'maxVariantPrice',
+      title: 'Max variant price',
+      type: 'number',
+    }),
+  ],
+})

package/templates/shopify-online-storefront/schemaTypes/objects/proxyString.ts

@@ -0,0 +1,11 @@
+import {defineType} from 'sanity'
+import ProxyStringInput from '../../components/inputs/ProxyString'
+
+export default defineType({
+  name: 'proxyString',
+  title: 'Title',
+  type: 'string',
+  components: {
+    input: ProxyStringInput,
+  },
+})

package/templates/shopify-online-storefront/schemaTypes/objects/shopifyCollection.ts

@@ -0,0 +1,109 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'shopifyCollection',
+  title: 'Shopify',
+  type: 'object',
+  options: {
+    collapsed: false,
+    collapsible: true,
+  },
+  readOnly: true,
+  fieldsets: [
+    {
+      name: 'status',
+      title: 'Status',
+    },
+  ],
+  fields: [
+    // Created at
+    defineField({
+      fieldset: 'status',
+      name: 'createdAt',
+      title: 'Created at',
+      type: 'string',
+    }),
+    // Updated at
+    defineField({
+      fieldset: 'status',
+      name: 'updatedAt',
+      title: 'Updated at',
+      type: 'string',
+    }),
+    // Deleted
+    defineField({
+      fieldset: 'status',
+      name: 'isDeleted',
+      title: 'Deleted from Shopify?',
+      type: 'boolean',
+    }),
+    // Title
+    defineField({
+      name: 'title',
+      title: 'Title',
+      type: 'string',
+    }),
+    // Collection ID
+    defineField({
+      name: 'id',
+      title: 'ID',
+      type: 'number',
+      description: 'Shopify Collection ID',
+    }),
+    // GID
+    defineField({
+      name: 'gid',
+      title: 'GID',
+      type: 'string',
+      description: 'Shopify Collection GID',
+    }),
+    // Slug
+    defineField({
+      name: 'slug',
+      title: 'Slug',
+      description: 'Shopify Collection handle',
+      type: 'slug',
+    }),
+    // Description
+    defineField({
+      name: 'descriptionHtml',
+      title: 'HTML Description',
+      type: 'text',
+      rows: 5,
+    }),
+    // Image URL
+    defineField({
+      name: 'imageUrl',
+      title: 'Image URL',
+      type: 'string',
+    }),
+    // Rules
+    defineField({
+      name: 'rules',
+      title: 'Rules',
+      type: 'array',
+      description: 'Include Shopify products that satisfy these conditions',
+      of: [{type: 'collectionRule'}],
+    }),
+    // Disjunctive rules
+    defineField({
+      name: 'disjunctive',
+      title: 'Disjunctive rules?',
+      description: 'Require any condition if true, otherwise require all conditions',
+      type: 'boolean',
+    }),
+    // Sort order
+    defineField({
+      name: 'sortOrder',
+      title: 'Sort order',
+      type: 'string',
+    }),
+    // Shop details
+    defineField({
+      name: 'shop',
+      title: 'Shop',
+      type: 'shop',
+      description: 'Shopify Shop details',
+    }),
+  ],
+})