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

package/templates/moviedb/README.md

@@ -0,0 +1,10 @@
+# Sanity Movies Content Studio
+
+Congratulations, you have now installed the Sanity Content Studio, an open-source real-time content editing environment connected to the Sanity backend.
+
+Now you can do the following things:
+
+- [Read “getting started” in the docs](https://www.sanity.io/docs/introduction/getting-started?utm_source=readme)
+- Check out one of the example frontends: [React](https://github.com/sanity-io/example-frontend-next-js) | [React Native](https://github.com/sanity-io/example-app-react-native) | [Vue](https://github.com/sanity-io/example-frontend-vue-js) | [PHP](https://github.com/sanity-io/example-frontend-silex-twig)
+- [Join the Sanity community](https://www.sanity.io/community/join?utm_source=readme)
+- [Extend and build plugins](https://www.sanity.io/docs/content-studio/extending?utm_source=readme)

package/templates/moviedb/schemaTypes/blockContent.js

@@ -0,0 +1,67 @@
+import {defineArrayMember, defineType} 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 defineType({
+  title: 'Block Content',
+  name: 'blockContent',
+  type: 'array',
+  of: [
+    defineArrayMember({
+      title: 'Block',
+      type: 'block',
+      // Styles let you set what your user can mark up blocks with. These
+      // correspond with HTML tags, but you can set any title or value
+      // you want and decide how you want to deal with it where you want to
+      // use your content.
+      styles: [
+        {title: 'Normal', value: 'normal'},
+        {title: 'H1', value: 'h1'},
+        {title: 'H2', value: 'h2'},
+        {title: 'H3', value: 'h3'},
+        {title: 'H4', value: 'h4'},
+        {title: 'Quote', value: 'blockquote'},
+      ],
+      lists: [{title: 'Bullet', value: 'bullet'}],
+      // Marks let you mark up inline text in the block editor.
+      marks: {
+        // Decorators usually describe a single property – e.g. a typographic
+        // preference or highlighting by editors.
+        decorators: [
+          {title: 'Strong', value: 'strong'},
+          {title: 'Emphasis', value: 'em'},
+        ],
+        // Annotations can be any object structure – e.g. a link or a footnote.
+        annotations: [
+          {
+            title: 'URL',
+            name: 'link',
+            type: 'object',
+            fields: [
+              {
+                title: 'URL',
+                name: 'href',
+                type: 'url',
+              },
+            ],
+          },
+        ],
+      },
+    }),
+    // 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: 'image',
+      options: {hotspot: true},
+    }),
+  ],
+})

package/templates/moviedb/schemaTypes/castMember.js

@@ -0,0 +1,37 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'castMember',
+  title: 'Cast Member',
+  type: 'object',
+  fields: [
+    defineField({
+      name: 'characterName',
+      title: 'Character Name',
+      type: 'string',
+    }),
+    defineField({
+      name: 'person',
+      title: 'Actor',
+      type: 'reference',
+      to: [{type: 'person'}],
+    }),
+    defineField({
+      name: 'externalId',
+      title: 'External ID',
+      type: 'number',
+    }),
+    defineField({
+      name: 'externalCreditId',
+      title: 'External Credit ID',
+      type: 'string',
+    }),
+  ],
+  preview: {
+    select: {
+      subtitle: 'characterName',
+      title: 'person.name',
+      media: 'person.image',
+    },
+  },
+})

package/templates/moviedb/schemaTypes/crewMember.js

@@ -0,0 +1,52 @@
+// @ts-check
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'crewMember',
+  title: 'Crew Member',
+  type: 'object',
+  fields: [
+    defineField({
+      name: 'department',
+      title: 'Department',
+      type: 'string',
+    }),
+    defineField({
+      name: 'job',
+      title: 'Job',
+      type: 'string',
+    }),
+    defineField({
+      name: 'person',
+      title: 'Person',
+      type: 'reference',
+      to: [{type: 'person'}],
+    }),
+    defineField({
+      name: 'externalId',
+      title: 'External ID',
+      type: 'number',
+    }),
+    defineField({
+      name: 'externalCreditId',
+      title: 'External Credit ID',
+      type: 'string',
+    }),
+  ],
+  preview: {
+    select: {
+      name: 'person.name',
+      job: 'job',
+      department: 'department',
+      media: 'person.image',
+    },
+    prepare(selection) {
+      const {name, job, department, media} = selection
+      return {
+        title: name,
+        subtitle: `${job} [${department}]`,
+        media,
+      }
+    },
+  },
+})

package/templates/moviedb/schemaTypes/index.js

@@ -0,0 +1,22 @@
+import blockContent from './blockContent'
+import crewMember from './crewMember'
+import castMember from './castMember'
+import movie from './movie'
+import person from './person'
+import screening from './screening'
+import plotSummary from './plotSummary'
+import plotSummaries from './plotSummaries'
+
+export const schemaTypes = [
+  // Document types
+  movie,
+  person,
+  screening,
+
+  // Other types
+  blockContent,
+  plotSummary,
+  plotSummaries,
+  castMember,
+  crewMember,
+]

package/templates/moviedb/schemaTypes/movie.js

@@ -0,0 +1,85 @@
+import {defineField, defineType} from 'sanity'
+import {MdLocalMovies as icon} from 'react-icons/md'
+
+export default defineType({
+  name: 'movie',
+  title: 'Movie',
+  type: 'document',
+  icon,
+  fields: [
+    defineField({
+      name: 'title',
+      title: 'Title',
+      type: 'string',
+    }),
+    defineField({
+      name: 'slug',
+      title: 'Slug',
+      type: 'slug',
+      options: {
+        source: 'title',
+        maxLength: 100,
+      },
+    }),
+    defineField({
+      name: 'overview',
+      title: 'Overview',
+      type: 'blockContent',
+    }),
+    defineField({
+      name: 'releaseDate',
+      title: 'Release date',
+      type: 'datetime',
+    }),
+    defineField({
+      name: 'poster',
+      title: 'Poster Image',
+      type: 'image',
+      options: {
+        hotspot: true,
+      },
+    }),
+    defineField({
+      name: 'externalId',
+      title: 'External ID',
+      type: 'number',
+    }),
+    defineField({
+      name: 'popularity',
+      title: 'Popularity',
+      type: 'number',
+    }),
+    defineField({
+      name: 'castMembers',
+      title: 'Cast Members',
+      type: 'array',
+      of: [{type: 'castMember'}],
+    }),
+    defineField({
+      name: 'crewMembers',
+      title: 'Crew Members',
+      type: 'array',
+      of: [{type: 'crewMember'}],
+    }),
+  ],
+  preview: {
+    select: {
+      title: 'title',
+      date: 'releaseDate',
+      media: 'poster',
+      castName0: 'castMembers.0.person.name',
+      castName1: 'castMembers.1.person.name',
+    },
+    prepare(selection) {
+      const year = selection.date && selection.date.split('-')[0]
+      const cast = [selection.castName0, selection.castName1].filter(Boolean).join(', ')
+
+      return {
+        title: `${selection.title} ${year ? `(${year})` : ''}`,
+        date: selection.date,
+        subtitle: cast,
+        media: selection.media,
+      }
+    },
+  },
+})

package/templates/moviedb/schemaTypes/person.js

@@ -0,0 +1,37 @@
+import {defineField, defineType} from 'sanity'
+import {MdPerson as icon} from 'react-icons/md'
+
+export default defineType({
+  name: 'person',
+  title: 'Person',
+  type: 'document',
+  icon,
+  fields: [
+    defineField({
+      name: 'name',
+      title: 'Name',
+      type: 'string',
+      description: 'Please use "Firstname Lastname" format',
+    }),
+    defineField({
+      name: 'slug',
+      title: 'Slug',
+      type: 'slug',
+      options: {
+        source: 'name',
+        maxLength: 100,
+      },
+    }),
+    defineField({
+      name: 'image',
+      title: 'Image',
+      type: 'image',
+      options: {
+        hotspot: true,
+      },
+    }),
+  ],
+  preview: {
+    select: {title: 'name', media: 'image'},
+  },
+})

package/templates/moviedb/schemaTypes/plotSummaries.js

@@ -0,0 +1,20 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  title: 'Plot summaries',
+  name: 'plotSummaries',
+  type: 'object',
+  fields: [
+    defineField({
+      name: 'caption',
+      title: 'Caption',
+      type: 'string',
+    }),
+    defineField({
+      name: 'summaries',
+      title: 'Summaries',
+      type: 'array',
+      of: [{type: 'plotSummary'}],
+    }),
+  ],
+})

package/templates/moviedb/schemaTypes/plotSummary.js

@@ -0,0 +1,24 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'plotSummary',
+  title: 'Plot Summary',
+  type: 'object',
+  fields: [
+    defineField({
+      title: 'Summary',
+      name: 'summary',
+      type: 'text',
+    }),
+    defineField({
+      title: 'Author',
+      name: 'author',
+      type: 'string',
+    }),
+    defineField({
+      title: 'Link to author',
+      name: 'url',
+      type: 'url',
+    }),
+  ],
+})

package/templates/moviedb/schemaTypes/screening.js

@@ -0,0 +1,81 @@
+import {defineField, defineType} from 'sanity'
+import {MdLocalPlay as icon} from 'react-icons/md'
+
+export default defineType({
+  name: 'screening',
+  title: 'Screening',
+  type: 'document',
+  icon,
+  fields: [
+    defineField({
+      name: 'title',
+      title: 'Title',
+      type: 'string',
+      description: 'E.g.: Our first ever screening of Gattaca',
+    }),
+    defineField({
+      name: 'movie',
+      title: 'Movie',
+      type: 'reference',
+      to: [{type: 'movie'}],
+      description: 'Which movie are we screening',
+    }),
+    defineField({
+      name: 'published',
+      title: 'Published',
+      type: 'boolean',
+      description: 'Set to published when this screening should be visible on a front-end',
+    }),
+    defineField({
+      name: 'location',
+      title: 'Location',
+      type: 'geopoint',
+      description: 'Where will the screening take place?',
+      hidden: true,
+    }),
+    defineField({
+      name: 'beginAt',
+      title: 'Starts at',
+      type: 'datetime',
+      description: 'When does the screening start?',
+    }),
+    defineField({
+      name: 'endAt',
+      title: 'Ends at',
+      type: 'datetime',
+      description: 'When does the screening end?',
+    }),
+    defineField({
+      name: 'allowedGuests',
+      title: 'Who can come?',
+      type: 'string',
+      options: {
+        list: [
+          {title: 'Members', value: 'members'},
+          {title: 'Members and friends', value: 'friends'},
+          {title: 'Anyone', value: 'anyone'},
+        ],
+        layout: 'radio',
+      },
+    }),
+    defineField({
+      name: 'infoUrl',
+      title: 'More info at',
+      type: 'url',
+      description:
+        'URL to imdb.com, rottentomatoes.com or some other place with reviews, stats, etc',
+    }),
+    defineField({
+      name: 'ticket',
+      title: 'Ticket',
+      type: 'file',
+      description: 'PDF for printing a physical ticket',
+    }),
+  ],
+  preview: {
+    select: {
+      title: 'title',
+      media: 'movie.poster',
+    },
+  },
+})

package/templates/moviedb/static/.gitkeep

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

package/templates/quickstart/README.md

@@ -0,0 +1,9 @@
+# Sanity Studio
+
+Congratulations, you have now installed Sanity Studio, an open-source real-time content editing environment connected to the Sanity Content Lake backend.
+
+Now you can do the following things:
+
+- [Read “getting started” in the docs](https://www.sanity.io/docs/introduction/getting-started?utm_source=readme)
+- [Join the Sanity community](https://www.sanity.io/community/join?utm_source=readme)
+- [Extend and build plugins](https://www.sanity.io/docs/content-studio/extending?utm_source=readme)

package/templates/quickstart/schemaTypes/index.js

@@ -0,0 +1 @@
+export const schemaTypes = []

package/templates/quickstart/static/.gitkeep

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

package/templates/shared/gitignore.txt

@@ -0,0 +1,29 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# Dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# Compiled Sanity Studio
+/dist
+
+# Temporary Sanity runtime, generated by the CLI on every dev server start
+/.sanity
+
+# Logs
+/logs
+*.log
+
+# Coverage directory used by testing tools
+/coverage
+
+# Misc
+.DS_Store
+*.pem
+
+# Typescript
+*.tsbuildinfo
+
+# Dotenv and similar local-only files
+*.local

package/templates/shared/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES2017",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true
+  },
+  "include": ["**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules"]
+}

package/templates/shopify/README.md

@@ -0,0 +1,85 @@
+# Sanity Studio for Shopify Projects
+
+<img width="1072" alt="Sanity Studio with Shopify products" src="https://github.com/sanity-io/learn/assets/9684022/13aed6ff-a028-4c3f-bc4b-15bf9ba4c6ff">
+
+## About
+
+This Sanity Studio is configured for headless Shopify projects that use the official [Sanity Connect app][sanity-shopify], allowing you to extend Shopify products and collections with your own rich editorial content.
+
+It contains examples of customizing your [structure][docs-structure], [document actions][docs-document-actions] and [input components][docs-input-components].
+
+This studio can be used with any front end, or anywhere else you want your e-commerce content to go.
+
+## Features
+
+This studio comes configured with Shopify-friendly content schema types and a whole host of customizations to make managing Shopify data in your Sanity studio easier.
+
+It also comes with several convenient layout modules which can be re-used across various pages.
+
+**[View studio features][studio-features]**
+
+## Assumptions
+
+No two custom storefronts are the same, and we've taken a few strong opinions on how we've approached this studio.
+
+- Synced Shopify data for `collection`, `product` and `productVariant` documents are stored in a read-only object, `store`
+- Shopify is the source of truth for both product titles, slugs (handles) and thumbnail images
+- Shopify is the source of truth for collections
+- Sanity is used as an additional presentational layer to add custom metadata to both Shopify collections and products
+  - For products: this includes a portable text field with support for editorial modules
+  - For collections: this includes a customizable array of editorial modules
+- Some images (such as product and cart line item thumbnails) are served by Shopify's CDN whilst other images (such as those served in editorial modules) are handled by Sanity's Image API
+- We only concern ourselves with incoming data from Shopify _collections_, _products_ and _product variants_
+
+We believe these rules work well for simpler use cases, and keeping product titles, images and slugs handled by Shopify helps keep content consistent as you navigate from your product views to the cart and ultimately checkout. Managing collections in Shopify gives you the flexibility to take full advantage of manual and automated collections.
+
+You may have differing opinions on how content best be modeled to fit your particular needs – this is normal and encouraged! Fortunately, Sanity was built with this flexibility in mind, and we've written [a guide on structured content patterns of e-commerce][structured-content-patterns] which may help inform how to tackle this challenge.
+
+## Setup
+
+If you're reading this on GitHub, chances are you haven't initialized the studio locally yet. To do so, run the following shell command:
+
+```sh
+# run a one-off initializing script:
+npx @sanity/cli init --template shopify
+```
+
+Make sure to run the tagged release! (`@sanity/cli`)
+
+## Local Development
+
+### Starting development server
+
+```sh
+npm run dev
+```
+
+### Deploying the studio
+
+```sh
+npm run deploy
+```
+
+### Upgrading Sanity Studio
+
+```sh
+npm run upgrade
+```
+
+If you have the [Sanity CLI][docs-cli] installed, you can also run this with `sanity start|deploy|upgrade`. It comes with additional useful functionality.
+
+## License
+
+This repository is published under the [MIT](license) license.
+
+[docs-cli]: https://www.sanity.io/docs/cli
+[docs-custom-input-components]: https://www.sanity.io/docs/custom-input-components
+[docs-structure]: https://www.sanity.io/docs/structure-builder
+[docs-document-actions]: https://www.sanity.io/docs/document-actions
+[docs-input-components]: https://www.sanity.io/docs/custom-input-widgets
+[docs-string-input]: https://www.sanity.io/docs/string-type
+[hydrogen-demo]: https://github.com/sanity-io/hydrogen-sanity-demo
+[license]: https://github.com/sanity-io/sanity/blob/next/LICENSE
+[sanity-shopify]: https://apps.shopify.com/sanity-connect
+[structured-content-patterns]: https://www.sanity.io/guides/structured-content-patterns-for-e-commerce
+[studio-features]: docs/features.md

package/templates/shopify/components/hotspots/ProductTooltip.tsx

@@ -0,0 +1,38 @@
+import {styled} from 'styled-components'
+import {PreviewLayoutKey, SchemaType, useSchema} from 'sanity'
+import {Box} from '@sanity/ui'
+import {HotspotTooltipProps} from 'sanity-plugin-hotspot-array'
+import {useMemo} from 'react'
+
+interface HotspotFields {
+  productWithVariant?: {
+    product: {
+      _ref: string
+    }
+  }
+}
+
+const StyledBox = styled(Box)`
+  width: 200px;
+`
+
+export default function ProductPreview(props: HotspotTooltipProps<HotspotFields>) {
+  const {value, renderPreview} = props
+  const productSchemaType = useSchema().get('product')
+  const hasProduct = value?.productWithVariant?.product?._ref && productSchemaType
+
+  const previewProps = useMemo(
+    () => ({
+      value: value?.productWithVariant?.product,
+      schemaType: productSchemaType as SchemaType,
+      layout: 'default' as PreviewLayoutKey,
+    }),
+    [productSchemaType, value?.productWithVariant?.product],
+  )
+
+  return (
+    <StyledBox padding={2}>
+      {hasProduct && previewProps ? renderPreview(previewProps) : `No product selected`}
+    </StyledBox>
+  )
+}

package/templates/shopify/components/icons/Shopify.tsx

@@ -0,0 +1,20 @@
+const ShopifyIcon = () => {
+  return (
+    <svg width="18" height="20" viewBox="0 0 18 20" fill="none" xmlns="http://www.w3.org/2000/svg">
+      <path
+        d="M15.3269 3.85113C15.3132 3.75015 15.2258 3.69411 15.1531 3.688C15.081 3.6819 13.6693 3.66026 13.6693 3.66026C13.6693 3.66026 12.4887 2.50392 12.3722 2.38628C12.2555 2.26865 12.0277 2.30417 11.9392 2.3308C11.9381 2.33135 11.7175 2.40016 11.3461 2.51612C11.2839 2.31304 11.1927 2.06335 11.0622 1.81255C10.6419 1.00356 10.0263 0.575752 9.2825 0.574642C9.28142 0.574642 9.28092 0.574642 9.27975 0.574642C9.22808 0.574642 9.17692 0.579636 9.12517 0.584074C9.10317 0.557441 9.08117 0.531362 9.05808 0.505838C8.73408 0.156272 8.31869 -0.0140727 7.82082 0.000908712C6.86027 0.0286521 5.90357 0.72834 5.12787 1.97124C4.58212 2.84572 4.16677 3.94435 4.04904 4.79497C2.94601 5.13953 2.17471 5.38035 2.15766 5.3859C1.60091 5.56235 1.58331 5.57955 1.51069 6.10889C1.45677 6.50895 0 17.8704 0 17.8704L12.2082 20L17.4994 18.6733C17.4994 18.6733 15.3407 3.95212 15.3269 3.85113ZM10.7349 2.707C10.4537 2.79467 10.1342 2.89454 9.78758 3.00274C9.78042 2.51224 9.72267 1.82975 9.496 1.23992C10.2249 1.3792 10.5836 2.21095 10.7349 2.707ZM9.14883 3.20249C8.509 3.40225 7.81091 3.62031 7.11058 3.83892C7.30753 3.0782 7.68107 2.32081 8.13989 1.8242C8.31044 1.63943 8.54917 1.43358 8.832 1.31594C9.09767 1.87525 9.15542 2.66705 9.14883 3.20249ZM7.84007 0.645665C8.06562 0.640671 8.25542 0.690609 8.41775 0.798253C8.15805 0.9342 7.90718 1.12951 7.67172 1.38419C7.06162 2.04448 6.594 3.06932 6.4075 4.0581C5.826 4.23954 5.25715 4.41766 4.73342 4.58078C5.06405 3.02438 6.35743 0.688944 7.84007 0.645665Z"
+        fill="#95BF47"
+      />
+      <path
+        d="M9.276 6.43238L8.66142 8.75117C8.66142 8.75117 7.97598 8.43658 7.16342 8.48817C5.97181 8.56417 5.95916 9.32217 5.97126 9.51242C6.03618 10.5495 8.74125 10.7759 8.89308 13.2051C9.01242 15.1161 7.88796 16.4233 6.26779 16.5265C4.32303 16.6502 3.25246 15.4933 3.25246 15.4933L3.66452 13.7256C3.66452 13.7256 4.74224 14.5457 5.60487 14.4907C6.16821 14.4547 6.36957 13.9924 6.34921 13.6657C6.26448 12.3128 4.06172 12.3927 3.92253 10.17C3.80536 8.29951 5.02337 6.40408 7.71081 6.23318C8.74617 6.16604 9.276 6.43238 9.276 6.43238Z"
+        fill="white"
+      />
+      <path
+        d="M15.1536 3.68853C15.0815 3.68243 13.6698 3.66078 13.6698 3.66078C13.6698 3.66078 12.4893 2.50444 12.3726 2.38681C12.3292 2.34298 12.2703 2.32023 12.2087 2.31079L12.2093 19.9994L17.4999 18.6733C17.4999 18.6733 15.3412 3.95264 15.3274 3.85166C15.3137 3.75068 15.2257 3.69463 15.1536 3.68853Z"
+        fill="#5E8E3E"
+      />
+    </svg>
+  )
+}
+
+export default ShopifyIcon