@sanity/cli 3.93.1-next.60.e1dbdccb42 → 3.93.1-next.8.cf0bf8550a

package/src/actions/init-project/templates/nextjs/schemaTypes/blog.ts

@@ -0,0 +1,252 @@
+// Types
+
+const authorType = `import {UserIcon} from '@sanity/icons'
+import {defineArrayMember, defineField, defineType} from 'sanity'
+
+export const authorType = defineType({
+  name: 'author',
+  title: 'Author',
+  type: 'document',
+  icon: UserIcon,
+  fields: [
+    defineField({
+      name: 'name',
+      type: 'string',
+    }),
+    defineField({
+      name: 'slug',
+      type: 'slug',
+      options: {
+        source: 'name',
+      },
+    }),
+    defineField({
+      name: 'image',
+      type: 'image',
+      options: {
+        hotspot: true,
+      },
+    }),
+    defineField({
+      name: 'bio',
+      type: 'array',
+      of: [
+        defineArrayMember({
+          type: 'block',
+          styles: [{title: 'Normal', value: 'normal'}],
+          lists: [],
+        }),
+      ],
+    }),
+  ],
+  preview: {
+    select: {
+      title: 'name',
+      media: 'image',
+    },
+  },
+})
+`
+
+const blockContentType = `import {defineType, defineArrayMember} from 'sanity'
+import {ImageIcon} from '@sanity/icons'
+
+/**
+ * This is the schema type for block content used in the post document type
+ * Importing this type into the studio configuration's \`schema\` property
+ * lets you reuse it in other document types with:
+ *  {
+ *    name: 'someName',
+ *    title: 'Some title',
+ *    type: 'blockContent'
+ *  }
+ */
+
+export const blockContentType = defineType({
+  title: 'Block Content',
+  name: 'blockContent',
+  type: 'array',
+  of: [
+    defineArrayMember({
+      type: 'block',
+      // Styles let you define what blocks can be marked up as. The default
+      // set corresponds 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 Portable Text Editor
+      marks: {
+        // Decorators usually describe a single property – e.g. a typographic
+        // preference or highlighting
+        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',
+      icon: ImageIcon,
+      options: {hotspot: true},
+      fields: [
+        {
+          name: 'alt',
+          type: 'string',
+          title: 'Alternative Text',
+        }
+      ]
+    }),
+  ],
+})
+`
+
+const categoryType = `import {TagIcon} from '@sanity/icons'
+import {defineField, defineType} from 'sanity'
+
+export const categoryType = defineType({
+  name: 'category',
+  title: 'Category',
+  type: 'document',
+  icon: TagIcon,
+  fields: [
+    defineField({
+      name: 'title',
+      type: 'string',
+    }),
+    defineField({
+      name: 'slug',
+      type: 'slug',
+      options: {
+        source: 'title',
+      },
+    }),
+    defineField({
+      name: 'description',
+      type: 'text',
+    }),
+  ],
+})
+`
+
+const postType = `import {DocumentTextIcon} from '@sanity/icons'
+import {defineArrayMember, defineField, defineType} from 'sanity'
+
+export const postType = defineType({
+  name: 'post',
+  title: 'Post',
+  type: 'document',
+  icon: DocumentTextIcon,
+  fields: [
+    defineField({
+      name: 'title',
+      type: 'string',
+    }),
+    defineField({
+      name: 'slug',
+      type: 'slug',
+      options: {
+        source: 'title',
+      },
+    }),
+    defineField({
+      name: 'author',
+      type: 'reference',
+      to: {type: 'author'},
+    }),
+    defineField({
+      name: 'mainImage',
+      type: 'image',
+      options: {
+        hotspot: true,
+      },
+      fields: [
+        defineField({
+          name: 'alt',
+          type: 'string',
+          title: 'Alternative text',
+        })
+      ]
+    }),
+    defineField({
+      name: 'categories',
+      type: 'array',
+      of: [defineArrayMember({type: 'reference', to: {type: 'category'}})],
+    }),
+    defineField({
+      name: 'publishedAt',
+      type: 'datetime',
+    }),
+    defineField({
+      name: 'body',
+      type: 'blockContent',
+    }),
+  ],
+  preview: {
+    select: {
+      title: 'title',
+      author: 'author.name',
+      media: 'mainImage',
+    },
+    prepare(selection) {
+      const {author} = selection
+      return {...selection, subtitle: author && \`by \${author}\`}
+    },
+  },
+})
+`
+
+// Schema definition
+export const blogSchemaTS = `import { type SchemaTypeDefinition } from 'sanity'
+
+import {blockContentType} from './blockContentType'
+import {categoryType} from './categoryType'
+import {postType} from './postType'
+import {authorType} from './authorType'
+
+export const schema: { types: SchemaTypeDefinition[] } = {
+  types: [blockContentType, categoryType, postType, authorType],
+}
+`
+
+export const blogSchemaJS = `import {blockContentType} from './blockContentType'
+import {categoryType} from './categoryType'
+import {postType} from './postType'
+import {authorType} from './authorType'
+
+export const schema = {
+  types: [blockContentType, categoryType, postType, authorType],
+}
+`
+
+export const blogSchemaFolder: Record<string, string> = {
+  'authorType.': authorType,
+  'blockContentType.': blockContentType,
+  'categoryType.': categoryType,
+  'postType.': postType,
+}

package/src/actions/init-project/templates/quickstart.ts

@@ -0,0 +1,5 @@
+import {type ProjectTemplate} from '../initProject'
+
+const quickStartTemplate: ProjectTemplate = {}
+
+export default quickStartTemplate

package/src/actions/init-project/templates/shopify.ts

@@ -0,0 +1,78 @@
+import {type ProjectTemplate} from '../initProject'
+
+const configTemplate = `
+import {defineConfig, isDev} from 'sanity'
+
+import {structureTool} from 'sanity/structure'
+import {schemaTypes} from './schemaTypes'
+import {structure} from './structure'
+
+import {visionTool} from '@sanity/vision'
+import {colorInput} from '@sanity/color-input'
+import {imageHotspotArrayPlugin} from 'sanity-plugin-hotspot-array'
+import {media, mediaAssetSource} from 'sanity-plugin-media'
+import {customDocumentActions} from './plugins/customDocumentActions'
+import Navbar from './components/studio/Navbar'
+
+const devOnlyPlugins = [visionTool()]
+
+export default defineConfig({
+  name: '%sourceName%',
+  title: '%projectName%',
+
+  projectId: '%projectId%',
+  dataset: '%dataset%',
+
+  plugins: [
+    structureTool({structure}),
+    colorInput(),
+    imageHotspotArrayPlugin(),
+    customDocumentActions(),
+    media(),
+    ...(isDev ? devOnlyPlugins : []),
+  ],
+
+  schema: {
+    types: schemaTypes,
+  },
+
+  form: {
+    file: {
+      assetSources: (previousAssetSources) => {
+        return previousAssetSources.filter((assetSource) => assetSource !== mediaAssetSource)
+      },
+    },
+    image: {
+      assetSources: (previousAssetSources) => {
+        return previousAssetSources.filter((assetSource) => assetSource === mediaAssetSource)
+      },
+    },
+  },
+
+  studio: {
+    components: {
+      navbar: Navbar,
+    },
+  },
+})`
+
+const shopifyTemplate: ProjectTemplate = {
+  configTemplate,
+  dependencies: {
+    '@sanity/asset-utils': '^1.3.0',
+    '@sanity/color-input': '^3.0.2',
+    '@sanity/icons': '^2.11.0',
+    '@sanity/ui': '^2.0.0',
+    'lodash.get': '^4.4.2',
+    'pluralize-esm': '^9.0.2',
+    'sanity-plugin-hotspot-array': '^1.0.1',
+    'sanity-plugin-media': '^2.0.5',
+    'slug': '^8.2.2',
+  },
+  devDependencies: {
+    '@portabletext/types': '^2.0.2',
+    '@types/lodash.get': '^4.4.7',
+    '@types/slug': '^5.0.3',
+  },
+}
+export default shopifyTemplate

package/src/actions/init-project/templates/shopifyOnline.ts

@@ -0,0 +1,50 @@
+import {type ProjectTemplate} from '../initProject'
+
+const configTemplate = `
+import {shopifyAssets} from 'sanity-plugin-shopify-assets'
+import {defineConfig, isDev} from 'sanity'
+import {structureTool} from 'sanity/structure'
+import {visionTool} from '@sanity/vision'
+import {shopifyDocumentActions} from './plugins/shopifyDocumentActions'
+import {schemaTypes} from './schemaTypes'
+import {structure} from './structure'
+import {SHOPIFY_STORE_ID} from './constants'
+
+const devOnlyPlugins = [visionTool()]
+
+export default defineConfig({
+  name: '%sourceName%',
+  title: '%projectName%',
+
+  projectId: '%projectId%',
+  dataset: '%dataset%',
+
+  plugins: [
+    structureTool({structure}),
+    shopifyDocumentActions(),
+    shopifyAssets({
+      shopifyDomain: SHOPIFY_STORE_ID,
+    }),
+    ...(isDev ? devOnlyPlugins : []),
+  ],
+
+  schema: {
+    types: schemaTypes,
+  },
+})
+`
+
+const shopifyTemplate: ProjectTemplate = {
+  configTemplate,
+  typescriptOnly: true,
+  dependencies: {
+    '@portabletext/toolkit': '^2.0.1',
+    '@sanity/icons': '^2.11.0',
+    '@sanity/ui': '^2.0.0',
+    '@types/lodash.get': '^4.4.7',
+    'lodash.get': '^4.4.2',
+    'pluralize-esm': '^9.0.4',
+    'sanity-plugin-shopify-assets': '^1.1.0',
+  },
+}
+export default shopifyTemplate

package/src/actions/init-project/updateInitialTemplateMetadata.ts

@@ -0,0 +1,24 @@
+import {debug} from '../../debug'
+import {type CliApiClient} from '../../types'
+
+export async function updateInitialTemplateMetadata(
+  apiClient: CliApiClient,
+  projectId: string,
+  templateName: string,
+): Promise<void> {
+  try {
+    await apiClient({api: {projectId}}).request({
+      method: 'PATCH',
+      uri: `/projects/${projectId}`,
+      body: {metadata: {initialTemplate: templateName}},
+    })
+  } catch (err: unknown) {
+    // Non-critical that we update this metadata, and user does not need to be aware
+    let message = typeof err === 'string' ? err : '<unknown error>'
+    if (err instanceof Error) {
+      message = err.message
+    }
+
+    debug('Failed to update initial template metadata for project: %s', message)
+  }
+}

package/src/actions/login/login.telemetry.ts

@@ -0,0 +1,18 @@
+import {defineTrace} from '@sanity/telemetry'
+
+interface SelectProviderStep {
+  step: 'selectProvider'
+  provider: string | undefined
+}
+
+interface WaitForTokenStep {
+  step: 'waitForToken'
+}
+
+type LoginTraceData = SelectProviderStep | WaitForTokenStep
+
+export const LoginTrace = defineTrace<LoginTraceData>({
+  name: 'CLI Login Step Completed',
+  version: 1,
+  description: 'User completed a step in the CLI login flow',
+})