sanity-plugin-workflow 1.0.6 → 2.0.1

package/README.md

@@ -2,11 +2,11 @@
 
 With Sanity Studio you can [customize your content tools to support arbitrary workflows like assignment and content pipelines](https://www.sanity.io/docs/custom-workflows).
 
-This plugin is distributed as an **example implementation** of customization APIs in the Sanity Studio V3 and is not considered to be a feature-complete implementation of what workflow management requires in production. It is meant as a starting point intended to be forked and customized to the needs of your organization and content creators, or simply as an illustration of what is possible in Sanity Studio V3.
+This plugin is distributed as an **example implementation** of customization APIs in the Sanity Studio and is not considered to be a feature-complete implementation of what workflow management requires in production. It is meant as a starting point intended to be forked and customized to the needs of your organization and content creators, or simply as an illustration of what is possible in Sanity Studio.
 
 An intentional design choice of this plugin is that it **does not influence or modify whether a document is in draft or published**. It only tracks the values of a separate "metadata" document. In this implementation, an "Approved" document could be a draft but will still need publishing. "Approving" the document deletes the "metadata" and so removes it from the "Workflow" process. You choose if Publishing the document happens in the Studio like normal, using the [Scheduled Publishing plugin](https://www.sanity.io/plugins/scheduled-publishing) or the [Scheduling API](https://www.sanity.io/docs/scheduling-api#fa3bb95f83ed).
 
-This plugin is considered finished in its current form. Your feedback for workflow features you would like to see in Sanity Studio would be appreciated and can be [shared in our Slack community](https://slack.sanity.io/).
+This plugin is considered finished in its current form. Your feedback for workflow features you would like to see in Sanity Studio would be appreciated and can be [shared in the Sanity Community Discord](https://snty.link/community).
 
 ![Screenshot 2023-03-21 at 12 11 24](https://user-images.githubusercontent.com/9684022/226602179-5bd3d91a-9c27-431e-be18-3c70f06c6ccb.png)
 
@@ -107,18 +107,3 @@ This plugin is largely based on the original Workflow Demo built into a Sanity S
 ## License
 
 [MIT](LICENSE) © Sanity.io
-
-## Develop & test
-
-This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
-with default configuration for build & watch scripts.
-
-See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
-on how to run this plugin with hot reload in the studio.
-
-### Release new version
-
-Run ["CI & Release" workflow](https://github.com/sanity-io/sanity-plugin-workflow/actions/workflows/main.yml).
-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 the release on any branch.

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import { Plugin } from "sanity";
+type State = {
+  id: string;
+  transitions: string[];
+  title: string;
+  roles?: string[];
+  requireAssignment?: boolean;
+  requireValidation?: boolean;
+  color?: 'primary' | 'success' | 'warning' | 'danger';
+};
+type WorkflowConfig = {
+  schemaTypes: string[];
+  states?: State[];
+};
+declare const workflow: Plugin<WorkflowConfig>;
+export { workflow };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":["SanityDocumentLike","State","StateCheck","Id","States","Id2","WorkflowConfig","defineStates","User","DragData","Metadata","KeyedMetadata","SanityDocumentWithMetadata","Plugin","WorkflowConfig","workflow"],"sources":["../src/types/index.d.ts","../src/index.d.ts"],"sourcesContent":["import type { SanityDocumentLike } from 'sanity';\nexport type State = {\n    id: string;\n    transitions: string[];\n    title: string;\n    roles?: string[];\n    requireAssignment?: boolean;\n    requireValidation?: boolean;\n    color?: 'primary' | 'success' | 'warning' | 'danger';\n};\nexport type StateCheck<Id, States> = {\n    id: Id;\n    transitions?: States extends {\n        id: infer Id2;\n    }[] ? Id2[] : never;\n} & State;\nexport type WorkflowConfig = {\n    schemaTypes: string[];\n    states?: State[];\n};\nexport declare function defineStates<Id extends string, States extends StateCheck<Id, States>[]>(states: States): States;\nexport type User = {\n    createdAt: string;\n    displayName: string;\n    email: string;\n    familyName: string;\n    givenName: string;\n    id: string;\n    imageUrl: string;\n    isCurrentUser: boolean;\n    middleName: string;\n    projectId: string;\n    provider: string;\n    sanityUserId: string;\n    updatedAt: string;\n};\nexport type DragData = {\n    documentId?: string;\n    x?: number;\n    y?: number;\n    state?: string;\n};\nexport type Metadata = SanityDocumentLike & {\n    _rev: string;\n    assignees: string[];\n    documentId: string;\n    state: string;\n    orderRank: string;\n};\nexport type KeyedMetadata = {\n    [key: string]: Metadata;\n};\nexport type SanityDocumentWithMetadata = {\n    _metadata: Metadata;\n    _id: string;\n    _type: string;\n    _rev: string;\n    _updatedAt: string;\n};\n//# sourceMappingURL=index.d.ts.map","import { type Plugin } from 'sanity';\nimport type { WorkflowConfig } from './types';\nexport declare const workflow: Plugin<WorkflowConfig>;\n//# sourceMappingURL=index.d.ts.map"],"mappings":";KACYC,KAAAA;EAAAA,EAAAA,EAAAA,MAAK;EAeLK,WAAAA,EAAAA,MAAc,EAAA;;ECdLS,KAAAA,CAAAA,EAAAA,MAAgC,EAAA;;;;;KDczCT,cAAAA;;WAECL;;AAjBDA,cCCSc,QDDJ,ECCcF,MDDd,CCCqBC,cDDrB,CAAA"}