A TypeScript library to Add, Update, and Delete Sanity dataset documents using JSON input files.

• Add documents to Sanity dataset
• Update documents in Sanity dataset (updating specific fields without replacing the whole document)
• Delete documents from Sanity dataset using document IDs
• Easy integration with Sanity API and management of dataset documents

1. Clone the repository or download the project files.
2. Install dependencies (using NPM)
3. Ensure that you have a valid Sanity project and dataset.
4. Create a .env file at the root of the project to store your Sanity configuration:

SANITY_PROJECT_ID=your_project_id
SANITY_DATASET=your_dataset_name
SANITY_TOKEN=your_sanity_token

1. Add your Sanity project configuration to the .env file as shown above.
2. Ensure that your JSON files are structured correctly for adding, updating, or deleting documents.
3. The library expects three JSON files in the input folder (which should be gitignored):
4. add.json: A JSON file containing documents to add. Fields should contain all necessary data including _type except for the _id, which will be auto-generated.
5. update.json: A JSON file containing documents to update. Should contain all the fields to update, See below for examples.
6. delete.json: A JSON file containing an array of document IDs to delete.
7. Run the following command to execute the script:

npm start

The script will:

• Add documents from add.json
• Update documents from update.json
• Delete documents based on IDs in delete.json

Logs are written to both the console and a file (logs/app.log). Different log levels:

• INFO: General informational messages (blue).
• SUCCESS: Indicates successful operations (green).
• ERROR: For errors (red).
• WARNING: For warnings (yellow).
• DEBUG: Debug messages (magenta).
• GENERAL: Generic messages (white).

1. add.json (Add documents):

[{
	"_type": "blog", // Required - Type of the Document
	"content": "This is a newly added blog post"
}]

2. update.json (Update documents):

[{
	"_id": [Document ID], // Required - Update where _id is this
	"content": "This is a newly added document"
}]

OR

{
	"query": [Sanity Query],
	"params": {}, // Optional - Query params
	"onlyIfMissing": true, // Optional - Only Update if missing in Schema
	"update": {
		"content": "This is a newly added document",
	},
	"delete": ["title"] // Optional - Fields to Delete
}

3. delete.json (Delete documents):

[
	[Document ID 1],
	[Document ID 2]
]

MIT License. See LICENSE file for details.