@commercelayer/sanity-plugin-commerce
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Sanity Commerce by Commerce Layer

This is a Sanity Studio v3 plugin.

Rationale

Traditionally, product catalogs and commerce engines are closely tied together, often leading to complex management and limited flexibility in content presentation. This plugin proposes a paradigm shift by decoupling the product catalog from the commerce engine. It enables you to manage your product catalog within Sanity CMS, while platforms like Commerce Layer handle the transactional aspects. This approach offers enhanced content management capabilities, improved editorial workflows, and a richer user experience.

Features

The Sanity Commerce Plugin is designed to seamlessly integrate e-commerce functionalities into Sanity CMS. Focused on simplifying content management for e-commerce platforms, this plugin allows you to manage your product catalog directly within Sanity, leveraging the power and flexibility of headless commerce.

  • Spin up a content model to handle products within Sanity.
  • Customizable schema for products, variants, taxonomies, and taxons.
  • Flexible configuration options to adapt to different e-commerce needs.
  • Streamlined management of product details, variants, and categorizations.

Installation

npm install @commercelayer/sanity-plugin-commerce

Usage

Configure the plugin in your sanity.config.ts file. Here’s an example configuration:

import { defineConfig } from 'sanity';
import {
  sanityCommerce,
  SanityCommercePluginConfig,
} from '@commercelayer/sanity-plugin-commerce';

const sanityCommerceConfig: SanityCommercePluginConfig = {
  // ...configure the plugin here.
};

export default defineConfig({
  // ... other config settings.
  plugins: [sanityCommerce(sanityCommerceConfig)],
});

Configuration Options

For product and variant attributes, there are some fields already preconfigured. Using field names that already exist will override the default content model. It is highly recommended to check the result of the content model before adding custom extensions.

The Sanity Commerce Plugin offers flexible configuration to adapt to your specific e-commerce needs. Below is a table summarizing the configuration options:

Option Type Description Example
productLabel string Sets the display name for products in the CMS. 'Coffee'
variantLabel string Sets the display name for product variants. 'Coffee Variant'
taxonomyLabel string Sets the display name for taxonomies. 'Category System'
taxonLabel string Sets the display name for individual taxons or categories. 'Category'
productAttributes FieldDefinition[] An array of additional field definitions for the product. [ { name: 'origin', type: 'string' } ]
variantAttributes FieldDefinition[] An array of additional field definitions for the variant. [ { name: 'roastLevel', type: 'string' } ]

Example Configuration

Here is a full example of how you might configure the plugin in your sanity.config.ts:

import { defineConfig } from 'sanity';
import { sanityCommerce } from 'sanity-plugin-commerce';

const sanityCommerceConfig = {
  productLabel: 'Coffee',
  variantLabel: 'Coffee Variant',
  taxonomyLabel: 'Category System',
  taxonLabel: 'Category',
  productAttributes: [{ name: 'origin', title: 'Origin', type: 'string' }],
  variantAttributes: [
    {
      name: 'roastLevel',
      title: 'Roast Level',
      type: 'string',
      options: {
        list: [
          { title: 'Light', value: 'light' },
          { title: 'Medium', value: 'medium' },
          { title: 'Dark', value: 'dark' },
        ],
      },
    },
  ],
};

export default defineConfig({
  plugins: [sanityCommerce(sanityCommerceConfig)],
});

This configuration allows you to tailor the plugin to best fit your product catalog and editorial workflow.

Develop & test

This plugin uses @sanity/plugin-kit with default configuration for build & watch scripts.

See Testing a plugin in Sanity Studio on how to run this plugin with hotreload in the studio.

License

This plugin is released under the MIT License © Commerce Layer.

Release new version

Run "CI & Release" workflow. Make sure to select the main branch and check "Release new version".

Semantic release will only release on configured branches, so it is safe to run release on any branch.

Readme

Keywords

Package Sidebar

Install

npm i @commercelayer/sanity-plugin-commerce

Weekly Downloads

24

Version

1.0.0

License

MIT

Unpacked Size

35.5 kB

Total Files

12

Last publish

Collaborators

  • commercelayer.io
  • drpierlu