Merge pull request #116 from tinloof/disable-creation-update-types

Simplier route with target types

.changeset/thick-meals-unite.md

@@ -0,0 +1,5 @@
+---
+"@tinloof/sanity-studio": patch
+---
+
+Disable creation plugin made simplier

packages/sanity-studio/README.md

@@ -517,32 +517,13 @@ export default defineConfig({
   schema: {
     types: schemas,
   },
-  plugins: [disableCreation({ schemaTypes: schemas })],
-});
-```
-
-```tsx
-/schemas/egilnnosst / home.ts;
-
-import { defineType } from "sanity";
-export default defineType({
-  type: "document",
-  name: "home",
-  fields: [
-    {
-      type: "string",
-      name: "title",
-    },
-  ],
-  options: {
-    disableCreation: true,
-  },
+  plugins: [disableCreation({ schemas: ["home", "header", "footer"] })],
 });
 ```
 
 ### Parameters
 
-- `schemaTypes`: array of schemas found within your Studio
+- `schemas`: String array of document types
 - `overrideDocumentActions`: The document actions to override, defaults to publish, discardChanges, restore
 
 ### Important notice

packages/sanity-studio/src/plugins/disableCreation/actions.ts

@@ -1,7 +1,6 @@
 import { DocumentActionComponent, DocumentActionsContext } from "sanity";
 
 import { DefaultDocumentActions } from "./types";
-import { getIsCreationDisabledDocument } from "./utils";
 
 const defaultActions: DefaultDocumentActions[] = [
   "publish",
@@ -12,10 +11,11 @@ const defaultActions: DefaultDocumentActions[] = [
 // Disable creation actions for documents that have disableCreation set to true
 export const actions = (
   prev: DocumentActionComponent[],
-  { schema, schemaType }: DocumentActionsContext,
+  { schemaType }: DocumentActionsContext,
+  schemas: string[],
   overrideDocumentActions?: DefaultDocumentActions[]
 ): DocumentActionComponent[] => {
-  const isCreationDisabled = getIsCreationDisabledDocument(schema, schemaType);
+  const isCreationDisabled = schemas.includes(schemaType);
 
   const documentActions = overrideDocumentActions?.length
     ? overrideDocumentActions

packages/sanity-studio/src/plugins/disableCreation/index.ts

@@ -5,7 +5,7 @@ import getTemplates from "./templates";
 import { DisableCreationPluginOptions } from "./types";
 
 /**
- * The `disableCreation` plugin can be used to disable creation of documents that have disableCreation option set to true.
+ * The `disableCreation` plugin can be used to disable creation of documents.
  *
  * @example
  *
@@ -14,40 +14,22 @@ import { DisableCreationPluginOptions } from "./types";
  * import schemas from "@/sanity/schemas";
  *
  * export default defineConfig({
- *   plugins: [disableCreation({ schemaTypes: schemas })],
+ *   plugins: [disableCreation({ schemas: ['home', 'header', 'footer'] })],
  * });
  * ```
  *
- * ```tsx
- * import {defineType} from 'sanity'
- *
- * export default defineType({
- *   type: 'document',
- *   name: 'home',
- *   fields: [
- *     {
- *       type: 'string',
- *       name: 'title',
- *     },
- *   ],
- *   options: {
- *     disableCreation: true,
- *   },
- * })
- * ```
- *
- * @param schemaTypes - The schema types found in the studio, used to filter out templates that have disableCreation set to true
+ * @param schemas - The schema types to be disabled from creation
  * @param overrideDocumentActions - The document actions to override, defaults to publish, discardChanges, restore
  */
 export const disableCreation = definePlugin<DisableCreationPluginOptions>(
-  ({ schemaTypes, overrideDocumentActions }) => ({
+  ({ schemas, overrideDocumentActions }) => ({
     name: "tinloof-sanity-disable-creation",
     document: {
       actions: (prev, context) =>
-        actions(prev, context, overrideDocumentActions),
+        actions(prev, context, schemas, overrideDocumentActions),
     },
     schema: {
-      templates: (templates) => getTemplates(templates, schemaTypes),
+      templates: (templates) => getTemplates(templates, schemas),
     },
   })
 );

packages/sanity-studio/src/plugins/disableCreation/templates.ts

@@ -1,14 +1,10 @@
 import { Template } from "sanity";
-import { SchemaTypeDefinition } from "sanity";
-
-import { getCreationDisabledDocuments } from "./utils";
 
 export default function getTemplates(
   templates: Template[],
-  schemaTypes: SchemaTypeDefinition[]
+  schemas: string[]
 ): Template[] {
   return templates?.filter(
-    (template) =>
-      !getCreationDisabledDocuments(schemaTypes)?.includes(template.schemaType)
+    (template) => !schemas?.includes(template.schemaType)
   );
 }

packages/sanity-studio/src/plugins/disableCreation/types.ts

@@ -1,9 +1,3 @@
-import { SchemaTypeDefinition } from "sanity";
-
-export type DisableCreationSchemaOptions = {
-  disableCreation?: boolean;
-};
-
 export type DefaultDocumentActions =
   | "publish"
   | "discardChanges"
@@ -13,6 +7,6 @@ export type DefaultDocumentActions =
   | "duplicate";
 
 export type DisableCreationPluginOptions = {
-  schemaTypes: SchemaTypeDefinition[];
+  schemas: string[];
   overrideDocumentActions?: DefaultDocumentActions[];
 };