Skip to content
This repository has been archived by the owner on Mar 26, 2024. It is now read-only.

feat: sanity file asset type #263

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: sanity file asset type #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e65ec3f
feat: sanity file asset type
chrilis Apr 1, 2022
e4d09f1
Merge branch 'main' into feat/sanity-file-asset-type
chrilis Jun 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions src/generate-types.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -86,6 +87,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -192,7 +194,7 @@ describe('generate-types', () => {
*
*
*/
file?: { _type: \\"file\\"; asset: SanityReference<any> };
file?: { _type: \\"file\\"; asset: SanityReference<SanityFileAsset> };

/**
* geopoint — \`geopoint\`
Expand Down Expand Up @@ -237,6 +239,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -256,6 +259,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -314,6 +318,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -333,6 +338,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -415,6 +421,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -434,6 +441,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -542,6 +550,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -561,6 +570,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -616,7 +626,7 @@ describe('generate-types', () => {
*/
nestedFile?: {
_type: \\"file\\";
asset: SanityReference<any>;
asset: SanityReference<SanityFileAsset>;
/**
* Other Description — \`number\`
*
Expand Down Expand Up @@ -695,6 +705,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -714,6 +725,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -809,6 +821,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -828,6 +841,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -892,6 +906,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -911,6 +926,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -987,6 +1003,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -1006,6 +1023,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -1087,6 +1105,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -1106,6 +1125,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -1215,6 +1235,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -1234,6 +1255,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -1301,6 +1323,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -1320,6 +1343,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down Expand Up @@ -1519,6 +1543,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -1538,6 +1563,7 @@ describe('generate-types', () => {
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down
7 changes: 5 additions & 2 deletions src/generate-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,8 +238,9 @@ async function generateTypes({
const assetClause = `asset: SanityReference<${
intrinsic.type === 'image'
? 'SanityImageAsset'
: // TODO: add types for non-image assets
'any'
: intrinsic.type === 'file'
? 'SanityFileAsset'
: 'any'
}>;`;
const imageSpecificClause =
intrinsic.type === 'image'
Expand Down Expand Up @@ -408,6 +409,7 @@ async function generateTypes({
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand All @@ -427,6 +429,7 @@ async function generateTypes({
SanityAsset,
SanityImage,
SanityFile,
SanityFileAsset,
SanityGeoPoint,
SanityBlock,
SanityDocument,
Expand Down
13 changes: 13 additions & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,19 @@ export interface SanityImageHotspot {

export type SanityKeyed<T> = T extends object ? T & { _key: string } : T;

export interface SanityFileAsset extends SanityDocument {
_type: "sanity.fileAsset";
assetId: string;
extension: string,
mimeType: string;
originalFilename: string;
path: string;
sha1hash: string;
size: number,
uploadId: string;
url: string;
}

export interface SanityImageAsset extends SanityDocument {
_type: 'sanity.imageAsset';
assetId: string;
Expand Down