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

package/templates/ecommerce/schemaTypes/vendor.js

@@ -0,0 +1,39 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'vendor',
+  title: 'Vendor',
+  type: 'document',
+  fields: [
+    defineField({
+      name: 'title',
+      title: 'Title',
+      type: 'string',
+    }),
+    defineField({
+      name: 'slug',
+      title: 'Slug',
+      type: 'slug',
+      options: {
+        source: 'title',
+        maxLength: 96,
+      },
+    }),
+    defineField({
+      name: 'logo',
+      title: 'logo',
+      type: 'image',
+    }),
+    defineField({
+      name: 'description',
+      title: 'Description',
+      type: 'blockContent',
+    }),
+  ],
+  preview: {
+    select: {
+      title: 'title',
+      media: 'logo',
+    },
+  },
+})

package/templates/ecommerce/static/.gitkeep

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

package/templates/get-started/README.md

@@ -0,0 +1,9 @@
+# Sanity Clean 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)
+- [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/get-started/plugins/.gitkeep

@@ -0,0 +1 @@
+User-specific packages can be placed here

package/templates/get-started/plugins/sanity-plugin-tutorial/CustomDefaultLayout.tsx

@@ -0,0 +1,16 @@
+import React from 'react'
+import {LayoutProps, useCurrentUser} from 'sanity'
+import {GetStartedTutorial} from './GetStartedTutorial'
+
+export function CustomDefaultLayout(props: LayoutProps) {
+  const user = useCurrentUser()
+
+  const showTutorial = Boolean(user?.roles?.length)
+
+  return (
+    <>
+      {showTutorial && <GetStartedTutorial />}
+      {props.renderDefault(props)}
+    </>
+  )
+}

package/templates/get-started/plugins/sanity-plugin-tutorial/GetStartedTutorial.tsx

@@ -0,0 +1,104 @@
+import React, {useState} from 'react'
+import {
+  Card,
+  Container,
+  Button,
+  Flex,
+  Label,
+  Heading,
+  Text,
+  Stack,
+  useElementSize,
+  useTheme,
+} from '@sanity/ui'
+import {CloseIcon} from '@sanity/icons'
+import {css, styled} from 'styled-components'
+
+const BlueColor = css`
+  color: ${({theme}) => theme.sanity.color.muted.primary.enabled.fg};
+`
+
+const LabelContainer = styled(Label)`
+  ${BlueColor}
+`
+
+const TextContainer = styled(Text)`
+  ${BlueColor}
+`
+
+export const GetStartedTutorial = () => {
+  const [hideTutorial, setShowTutorial] = useState(
+    window.localStorage.getItem('getstarted_closedTutorial') !== null,
+  )
+
+  const {sanity} = useTheme()
+  const [rootElement, setRootElement] = useState<HTMLDivElement | null>(null)
+  const rect = useElementSize(rootElement)
+  const width = rect?.content?.width
+  const isSmallScreen = width ? width < sanity.media[1] : false
+  const isProdEnv = process.env.NODE_ENV !== 'development'
+
+  const onClose = () => {
+    window.localStorage.setItem('getstarted_closedTutorial', 'true')
+    setShowTutorial(true)
+  }
+
+  if (hideTutorial || isProdEnv) {
+    return null
+  }
+
+  return (
+    <div ref={setRootElement}>
+      <Card tone="primary" padding={isSmallScreen ? 3 : 5} paddingBottom={isSmallScreen ? 4 : 6}>
+        <Flex justify={isSmallScreen ? 'space-between' : 'flex-end'} align="center">
+          {isSmallScreen && (
+            <LabelContainer forwardedAs="p">Your Sanity Studio is all set up!</LabelContainer>
+          )}
+
+          <Button
+            aria-label="Close dialog"
+            icon={CloseIcon}
+            mode="bleed"
+            onClick={onClose}
+            padding={isSmallScreen ? undefined : 3}
+          />
+        </Flex>
+        <Stack space={5}>
+          {!isSmallScreen && (
+            <>
+              <LabelContainer forwardedAs="p" align="center">
+                Get started with sanity
+              </LabelContainer>
+
+              <Heading as="h1" size={4} align="center">
+                Your Sanity Studio is all set up!
+              </Heading>
+            </>
+          )}
+
+          <Container width={1}>
+            <TextContainer
+              forwardedAs="p"
+              size={isSmallScreen ? 1 : undefined}
+              align={isSmallScreen ? 'left' : 'center'}
+            >
+              Next, our docs will guide you through building schema types, adding content, and
+              connecting a frontend. You’ll see updates reflected in your Studio below.
+            </TextContainer>
+          </Container>
+
+          <Flex justify={isSmallScreen ? 'flex-start' : 'center'}>
+            <Button
+              as="a"
+              href="https://www.sanity.io/docs/create-a-schema-and-configure-sanity-studio"
+              target="_blank"
+              padding={isSmallScreen ? undefined : 4}
+              tone="primary"
+              text="Build a schema"
+            />
+          </Flex>
+        </Stack>
+      </Card>
+    </div>
+  )
+}

package/templates/get-started/plugins/sanity-plugin-tutorial/index.ts

@@ -0,0 +1,11 @@
+import {definePlugin} from 'sanity'
+import {CustomDefaultLayout} from './CustomDefaultLayout'
+
+export const getStartedPlugin = definePlugin({
+  name: 'sanity-plugin-tutorial',
+  studio: {
+    components: {
+      layout: CustomDefaultLayout,
+    },
+  },
+})

package/templates/get-started/schemaTypes/index.ts

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

package/templates/get-started/static/.gitkeep

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

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