Add Sanity Plugin

plugins/Sanity/v1/configValidation.json

@@ -0,0 +1,13 @@
+{
+    "steps": [
+        {
+            "displayName": "Authenticate",
+            "dataStream": {
+                "name": "listProjects"
+            },
+            "required": true,
+            "success": "Connected to the Sanity management API.",
+            "error": "Could not list projects. Check your Admin API token is valid and has access to your projects."
+        }
+    ]
+}

plugins/Sanity/v1/custom_types.json

@@ -0,0 +1,16 @@
+[
+    {
+        "name": "Project",
+        "sourceType": "Project",
+        "icon": "layer-group",
+        "singular": "Project",
+        "plural": "Projects"
+    },
+    {
+        "name": "Dataset",
+        "sourceType": "Dataset",
+        "icon": "layer-group",
+        "singular": "Dataset",
+        "plural": "Datasets"
+    }
+]

plugins/Sanity/v1/dataStreams/allProjects.json

@@ -0,0 +1,45 @@
+{
+    "name": "allProjects",
+    "displayName": "All Projects",
+    "description": "Every project the admin token can see, flagging which have a content API token configured",
+    "tags": ["Project"],
+    "baseDataSourceName": "httpRequestUnscoped",
+    "config": {
+        "httpMethod": "get",
+        "paging": {
+            "mode": "none"
+        },
+        "expandInnerObjects": false,
+        "endpointPath": "projects",
+        "getArgs": [],
+        "headers": [],
+        "postRequestScript": "allProjects.js"
+    },
+    "metadata": [
+        {
+            "name": "displayName",
+            "shape": "string",
+            "displayName": "Name",
+            "role": "label"
+        },
+        {
+            "name": "tokenStatus",
+            "displayName": "Token Status",
+            "shape": [
+                "state",
+                {
+                    "map": {
+                        "success": ["configured"],
+                        "error": ["missing"]
+                    }
+                }
+            ]
+        },
+        {
+            "name": "id",
+            "shape": "string",
+            "displayName": "Project ID"
+        }
+    ],
+    "timeframes": false
+}

plugins/Sanity/v1/dataStreams/customQuery.json

@@ -0,0 +1,69 @@
+{
+    "name": "customQuery",
+    "displayName": "Custom GROQ Query",
+    "description": "Run an arbitrary GROQ query against a dataset",
+    "tags": ["Documents"],
+    "baseDataSourceName": "httpRequestScopedSingle",
+    "matches": {
+        "sourceType": {
+            "type": "equals",
+            "value": "Dataset"
+        }
+    },
+    "providesPluginDiagnostics": true,
+    "config": {
+        "baseUrl": "https://{{object.projectId}}.api.sanity.io/{{dataSource.apiVersion}}/",
+        "httpMethod": "get",
+        "errorHandling": {
+            "type": "script",
+            "script": "const hasToken = {{ !!((dataSource.projects || []).find(p => p.key === object.projectId) || {}).value }}; const apiMsg = data && (data.message || (typeof data.error === 'string' ? data.error : (data.error || {}).description)); result = hasToken ? (apiMsg || ('Request failed with HTTP ' + response.status)) : 'No API token is configured for project {{object.projectId}} (which this dataset belongs to). Add its Project ID and API token under Project API tokens in the Sanity data source settings to query it.';"
+        },
+        "paging": {
+            "mode": "none"
+        },
+        "expandInnerObjects": true,
+        "endpointPath": "data/query/{{object.datasetId}}",
+        "pathToData": "result",
+        "getArgs": [
+            {
+                "key": "query",
+                "value": "{{query}}"
+            },
+            {
+                "key": "perspective",
+                "value": "{{perspective}}"
+            }
+        ],
+        "headers": [
+            {
+                "key": "Authorization",
+                "value": "Bearer {{ ((dataSource.projects || []).find(p => p.key === object.projectId) || {}).value }}"
+            }
+        ]
+    },
+    "ui": [
+        {
+            "type": "code",
+            "name": "query",
+            "language": "groq",
+            "label": "GROQ query",
+            "defaultValue": "*[ !(_id in path(\"_.**\")) ] | order(_updatedAt desc) [0...20] {_id, _type, _updatedAt}",
+            "validation": { "required": true },
+            "help": "See [GROQ query cheat sheet](https://www.sanity.io/docs/content-lake/query-cheat-sheet) for patterns"
+        },
+        {
+            "type": "switch",
+            "name": "perspective",
+            "label": "Perspective",
+            "defaultValue": "published",
+            "options": [
+                { "value": "published", "label": "Published" },
+                { "value": "drafts", "label": "Drafts" },
+                { "value": "raw", "label": "Raw" }
+            ]
+        }
+    ],
+    "metadata": [{ "pattern": ".*" }],
+    "timeframes": false,
+    "manualConfigApply": true
+}

plugins/Sanity/v1/dataStreams/datasetStats.json

@@ -0,0 +1,97 @@
+{
+    "name": "datasetStats",
+    "displayName": "Dataset Stats",
+    "description": "Get stats on how close to usage limits this dataset is",
+    "tags": ["Analytics"],
+    "baseDataSourceName": "httpRequestScopedSingle",
+    "matches": {
+        "sourceType": {
+            "type": "equals",
+            "value": "Dataset"
+        }
+    },
+    "config": {
+        "baseUrl": "https://{{object.projectId}}.api.sanity.io/v1/",
+        "httpMethod": "get",
+        "errorHandling": {
+            "type": "script",
+            "script": "const hasToken = {{ !!((dataSource.projects || []).find(p => p.key === object.projectId) || {}).value }}; const apiMsg = data && (data.message || (typeof data.error === 'string' ? data.error : (data.error || {}).description)); result = hasToken ? (apiMsg || ('Request failed with HTTP ' + response.status)) : 'No API token is configured for project {{object.projectId}} (which this dataset belongs to). Add its Project ID and API token under Project API tokens in the Sanity data source settings to see its usage stats.';"
+        },
+        "paging": {
+            "mode": "none"
+        },
+        "endpointPath": "data/stats/{{object.datasetId}}",
+        "getArgs": [],
+        "headers": [
+            {
+                "key": "Authorization",
+                "value": "Bearer {{ ((dataSource.projects || []).find(p => p.key === object.projectId) || {}).value }}"
+            }
+        ],
+        "expandInnerObjects": true,
+        "postRequestScript": "datasetStats.js"
+    },
+    "metadata": [
+        {
+            "name": "dataset",
+            "displayName": "Dataset",
+            "shape": "string",
+            "role": "label"
+        },
+        {
+            "name": "documentsPctOfLimit",
+            "displayName": "Documents (% of limit)",
+            "shape": "percent",
+            "role": "value"
+        },
+        {
+            "name": "fieldsPctOfLimit",
+            "displayName": "Fields (% of limit)",
+            "shape": "percent"
+        },
+        {
+            "name": "jsonSizePctOfLimit",
+            "displayName": "JSON Size (% of limit)",
+            "shape": "percent"
+        },
+        {
+            "name": "releasesPctOfLimit",
+            "displayName": "Releases (% of limit)",
+            "shape": "percent"
+        },
+        {
+            "name": "documents.count.value",
+            "displayName": "Documents",
+            "shape": "number"
+        },
+        {
+            "name": "documents.count.limit",
+            "displayName": "Document Limit",
+            "shape": "number"
+        },
+        {
+            "name": "fields.count.value",
+            "displayName": "Fields",
+            "shape": "number"
+        },
+        {
+            "name": "fields.count.limit",
+            "displayName": "Field Limit",
+            "shape": "number"
+        },
+        {
+            "name": "documents.jsonSizeSum.value",
+            "displayName": "JSON Size",
+            "shape": "bytes"
+        },
+        {
+            "name": "documents.jsonSizeSum.limit",
+            "displayName": "JSON Size Limit",
+            "shape": "bytes"
+        },
+        {
+            "pattern": ".*"
+        }
+    ],
+    "timeframes": false
+}

plugins/Sanity/v1/dataStreams/datasets.json

@@ -0,0 +1,80 @@
+{
+    "name": "datasets",
+    "displayName": "Datasets",
+    "description": "Lists the datasets in a project, with their access-control mode",
+    "tags": ["Datasets"],
+    "baseDataSourceName": "httpRequestScopedSingle",
+    "matches": {
+        "sourceType": {
+            "type": "equals",
+            "value": "Project"
+        }
+    },
+    "config": {
+        "httpMethod": "get",
+        "errorHandling": {
+            "type": "script",
+            "script": "errorHandling/datasets.js"
+        },
+        "paging": {
+            "mode": "none"
+        },
+        "expandInnerObjects": true,
+        "endpointPath": "projects/{{object.rawId}}/datasets",
+        "getArgs": [],
+        "postRequestScript": "datasets.js",
+        "headers": [
+            {
+                "key": "Authorization",
+                "value": "Bearer {{ ((dataSource.projects || []).find(p => p.key === object.rawId) || {}).value }}"
+            }
+        ]
+    },
+    "metadata": [
+        {
+            "name": "projectId",
+            "displayName": "Project ID",
+            "shape": "string",
+            "visible": false
+        },
+        {
+            "name": "datasetId",
+            "shape": "string",
+            "displayName": "Dataset",
+            "role": "label"
+        },
+        {
+            "name": "aclMode",
+            "shape": "string",
+            "displayName": "Access mode"
+        },
+        {
+            "name": "createdAt",
+            "shape": "date",
+            "displayName": "Created At"
+        },
+        {
+            "name": "createdByUserId",
+            "shape": "string",
+            "displayName": "Created By User Id"
+        },
+        {
+            "name": "projectName",
+            "displayName": "Project Name",
+            "shape": "string"
+        },
+        {
+            "name": "uid",
+            "displayName": "uid",
+            "shape": "string",
+            "visible": false
+        },
+        {
+            "name": "displayName",
+            "displayName": "Display Name",
+            "shape": "string",
+            "visible": false
+        }
+    ],
+    "timeframes": false
+}

plugins/Sanity/v1/dataStreams/listProjects.json

@@ -0,0 +1,52 @@
+{
+    "name": "listProjects",
+    "displayName": "Projects",
+    "description": "Lists the projects that have a content API token configured",
+    "tags": ["Project"],
+    "baseDataSourceName": "httpRequestUnscoped",
+    "config": {
+        "httpMethod": "get",
+        "paging": {
+            "mode": "none"
+        },
+        "expandInnerObjects": false,
+        "endpointPath": "projects",
+        "getArgs": [],
+        "headers": [],
+        "postRequestScript": "listProjects.js"
+    },
+    "metadata": [
+        {
+            "name": "id",
+            "shape": "string",
+            "displayName": "Project ID"
+        },
+        {
+            "name": "displayName",
+            "shape": "string",
+            "displayName": "Name"
+        },
+        {
+            "name": "organizationId",
+            "shape": "string",
+            "displayName": "Organization ID"
+        },
+        {
+            "name": "studioHost",
+            "shape": "string",
+            "displayName": "Studio host"
+        },
+        {
+            "name": "createdAt",
+            "shape": "date",
+            "displayName": "Created"
+        },
+        {
+            "pattern": ".*"
+        }
+    ],
+    "timeframes": false,
+    "visibility": {
+        "type": "hidden"
+    }
+}