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

package/templates/shopify-online-storefront/schemaTypes/objects/shopifyCollectionRule.tsx

@@ -0,0 +1,45 @@
+import {FilterIcon} from '@sanity/icons'
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  title: 'Collection rule',
+  name: 'collectionRule',
+  type: 'object',
+  icon: FilterIcon,
+  readOnly: true,
+  fields: [
+    // Column
+    defineField({
+      title: 'Column',
+      name: 'column',
+      type: 'string',
+    }),
+    // Values
+    defineField({
+      title: 'Relation',
+      name: 'relation',
+      type: 'string',
+    }),
+    // Condition
+    defineField({
+      title: 'Condition',
+      name: 'condition',
+      type: 'string',
+    }),
+  ],
+  preview: {
+    select: {
+      condition: 'condition',
+      name: 'column',
+      relation: 'relation',
+    },
+    prepare(selection) {
+      const {condition, name, relation} = selection
+
+      return {
+        subtitle: `${relation} ${condition}`,
+        title: name,
+      }
+    },
+  },
+})

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

@@ -0,0 +1,165 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  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: [
+    // Created at
+    defineField({
+      fieldset: 'status',
+      name: 'createdAt',
+      title: 'Created at',
+      type: 'string',
+    }),
+    // Updated at
+    defineField({
+      fieldset: 'status',
+      name: 'updatedAt',
+      title: 'Updated at',
+      type: 'string',
+    }),
+    // Product status
+    defineField({
+      fieldset: 'status',
+      name: 'status',
+      title: 'Product status',
+      type: 'string',
+      options: {
+        layout: 'dropdown',
+        list: ['active', 'archived', 'draft'],
+      },
+    }),
+    // Deleted
+    defineField({
+      fieldset: 'status',
+      name: 'isDeleted',
+      title: 'Deleted from Shopify?',
+      type: 'boolean',
+    }),
+    // Title
+    defineField({
+      name: 'title',
+      title: 'Title',
+      type: 'string',
+      description: 'Title displayed in both cart and checkout',
+    }),
+    // Product ID
+    defineField({
+      name: 'id',
+      title: 'ID',
+      type: 'number',
+      description: 'Shopify Product ID',
+    }),
+    // Product ID
+    defineField({
+      name: 'gid',
+      title: 'GID',
+      type: 'string',
+      description: 'Shopify Product GID',
+    }),
+    // Slug
+    defineField({
+      name: 'slug',
+      title: 'Slug',
+      type: 'slug',
+      description: 'Shopify Product handle',
+    }),
+    // Description
+    defineField({
+      name: 'descriptionHtml',
+      title: 'HTML Description',
+      type: 'text',
+      rows: 5,
+    }),
+    // Product Type
+    defineField({
+      fieldset: 'organization',
+      name: 'productType',
+      title: 'Product type',
+      type: 'string',
+    }),
+    // Vendor
+    defineField({
+      fieldset: 'organization',
+      name: 'vendor',
+      title: 'Vendor',
+      type: 'string',
+    }),
+    // Tags
+    defineField({
+      fieldset: 'organization',
+      name: 'tags',
+      title: 'Tags',
+      type: 'string',
+    }),
+    // Price range
+    defineField({
+      name: 'priceRange',
+      type: 'priceRange',
+      title: 'Price range',
+    }),
+    // Preview Image URL
+    defineField({
+      name: 'previewImageUrl',
+      title: 'Preview Image URL',
+      type: 'string',
+      description: 'Image displayed in both cart and checkout',
+    }),
+    // Options
+    defineField({
+      name: 'options',
+      title: 'Options',
+      type: 'array',
+      of: [{type: 'option'}],
+    }),
+    // Variants
+    defineField({
+      fieldset: 'variants',
+      name: 'variants',
+      title: 'Variants',
+      type: 'array',
+      of: [
+        {
+          title: 'Variant',
+          type: 'reference',
+          weak: true,
+          to: [{type: 'productVariant'}],
+        },
+      ],
+    }),
+    // Shop details
+    defineField({
+      name: 'shop',
+      title: 'Shop',
+      type: 'shop',
+      description: 'Shopify Shop details',
+    }),
+  ],
+})

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

@@ -0,0 +1,151 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'shopifyProductVariant',
+  title: 'Shopify',
+  type: 'object',
+  options: {
+    collapsed: false,
+    collapsible: true,
+  },
+  fieldsets: [
+    {
+      name: 'options',
+      title: 'Options',
+      options: {
+        columns: 3,
+      },
+    },
+    {
+      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',
+    }),
+    // Product status
+    defineField({
+      fieldset: 'status',
+      name: 'status',
+      title: 'Product status',
+      type: 'string',
+      options: {
+        layout: 'dropdown',
+        list: ['active', 'archived', 'draft'],
+      },
+      validation: (Rule) => Rule.required(),
+    }),
+    // Deleted
+    defineField({
+      fieldset: 'status',
+      name: 'isDeleted',
+      title: 'Deleted from Shopify?',
+      type: 'boolean',
+    }),
+    // Title
+    defineField({
+      name: 'title',
+      title: 'Title',
+      type: 'string',
+    }),
+    // SKU
+    defineField({
+      name: 'sku',
+      title: 'SKU',
+      type: 'string',
+    }),
+    // ID
+    defineField({
+      name: 'id',
+      title: 'ID',
+      type: 'number',
+      description: 'Shopify Product Variant ID',
+    }),
+    // GID
+    defineField({
+      name: 'gid',
+      title: 'GID',
+      type: 'string',
+      description: 'Shopify Product Variant GID',
+    }),
+    // Product ID
+    defineField({
+      name: 'productId',
+      title: 'Product ID',
+      type: 'number',
+    }),
+    // Product GID
+    defineField({
+      name: 'productGid',
+      title: 'Product GID',
+      type: 'string',
+    }),
+    // Price
+    defineField({
+      name: 'price',
+      title: 'Price',
+      type: 'number',
+    }),
+    // Compare at price
+    defineField({
+      name: 'compareAtPrice',
+      title: 'Compare at price',
+      type: 'number',
+    }),
+    // Inventory
+    defineField({
+      name: 'inventory',
+      title: 'Inventory',
+      type: 'inventory',
+    }),
+    // Option 1
+    defineField({
+      fieldset: 'options',
+      name: 'option1',
+      title: 'Option 1',
+      type: 'string',
+    }),
+    // Option 2
+    defineField({
+      fieldset: 'options',
+      name: 'option2',
+      title: 'Option 2',
+      type: 'string',
+    }),
+    // Option 3
+    defineField({
+      fieldset: 'options',
+      name: 'option3',
+      title: 'Option 3',
+      type: 'string',
+    }),
+    // Preview Image URL
+    defineField({
+      name: 'previewImageUrl',
+      title: 'Preview Image URL',
+      type: 'string',
+      description: 'Image displayed in both cart and checkout',
+    }),
+    // Shop details
+    defineField({
+      name: 'shop',
+      title: 'Shop',
+      type: 'shop',
+      description: 'Shopify Shop details',
+    }),
+  ],
+  readOnly: true,
+})

package/templates/shopify-online-storefront/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-online-storefront/structure/index.ts

@@ -0,0 +1,37 @@
+import {ListItemBuilder, StructureResolver} from 'sanity/structure'
+import collections from './collectionStructure'
+import products from './productStructure'
+
+/**
+ * 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 schemas 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', 'media.tag', 'product', 'productVariant', 'vendor'].includes(id)
+}
+
+export const structure: StructureResolver = (S, context) =>
+  S.list()
+    .title('Content')
+    .items([
+      collections(S, context),
+      products(S, context),
+      S.divider(),
+      ...S.documentTypeListItems().filter(hiddenDocTypes),
+    ])

package/templates/shopify-online-storefront/structure/productStructure.ts

@@ -0,0 +1,35 @@
+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').child((id) =>
+        S.list()
+          .title('Product')
+          .items([
+            // Details
+            S.listItem()
+              .title('Details')
+              .icon(InfoOutlineIcon)
+              .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-', '')),
+                  }),
+              ),
+          ]),
+      ),
+    ),
+)

package/templates/shopify-online-storefront/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
+}

package/templates/shopify-online-storefront/utils/getPriceRange.ts

@@ -0,0 +1,24 @@
+import {DEFAULT_CURRENCY_CODE} from '../constants'
+
+type PriceObject = {
+  minVariantPrice: number
+  maxVariantPrice: number
+}
+
+const formatNumber = (val: number) => {
+  return new Intl.NumberFormat('en', {
+    currency: DEFAULT_CURRENCY_CODE,
+    style: 'currency',
+  }).format(val)
+}
+
+export const getPriceRange = (price: PriceObject) => {
+  if (!price || typeof price?.minVariantPrice === 'undefined') {
+    return 'No price found'
+  }
+  if (price.maxVariantPrice && price.minVariantPrice !== price.maxVariantPrice) {
+    return `${formatNumber(price.minVariantPrice)} – ${formatNumber(price.maxVariantPrice)}`
+  }
+
+  return formatNumber(price.minVariantPrice)
+}

package/templates/shopify-online-storefront/utils/shopifyUrls.ts

@@ -0,0 +1,22 @@
+import {SHOPIFY_STORE_ID} from '../constants'
+
+export const collectionUrl = (collectionId: number) => {
+  if (!SHOPIFY_STORE_ID) {
+    return null
+  }
+  return `https://${SHOPIFY_STORE_ID}/admin/collections/${collectionId}`
+}
+
+export const productUrl = (productId: number) => {
+  if (!SHOPIFY_STORE_ID) {
+    return null
+  }
+  return `https://${SHOPIFY_STORE_ID}/admin/products/${productId}`
+}
+
+export const productVariantUrl = (productId: number, productVariantId: number) => {
+  if (!SHOPIFY_STORE_ID) {
+    return null
+  }
+  return `https://${SHOPIFY_STORE_ID}/admin/products/${productId}/variants/${productVariantId}`
+}