Gathering detailed insights and metrics for @freighter-studio/sanity-typed-queries
Gathering detailed insights and metrics for @freighter-studio/sanity-typed-queries
A typed, zero-dependency schema generator and query builder for Sanity.
Installations
npm install @freighter-studio/sanity-typed-queriesDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
14.17.5
NPM Version
6.14.14
Releases
Unable to fetch releases
Languages
2
TypeScript
JavaScript
TypeScript (98.12%)
JavaScript (1.88%)
Developer
liammartens
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
270 Commits
1 Watchers
8 Branches
1 Contributors
Updated on Aug 27, 2021
Maintainers
1
Package Meta Information
Latest Version
0.8.3
Package Id
@freighter-studio/sanity-typed-queries@0.8.3
Unpacked Size
61.04 kB
Size
15.08 kB
File Count
7
NPM Version
6.14.14
Node Version
14.17.5
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
28
@babel/core@babel/plugin-transform-runtime@babel/preset-env@babel/preset-typescript@babel/runtime@release-it/conventional-changelog@siroc/eslint-config@siroc/jest-preset@types/jest@typescript-eslint/eslint-plugin@typescript-eslint/parsercodecovconventional-changelog-conventionalcommitsesbuildeslinteslint-config-prettiereslint-plugin-jesteslint-plugin-prettierexpect-typegroqhuskyjestlint-stagedprettierrelease-itsemversiroctypescript
🔤 sanity-typed-queries
A typed query generator for Sanity
A zero-dependency schema generator and query builder that is fully-typed and works in JavaScript and TypeScript.
Features
- 📚 Documentation: Sanity documentation appears as you type.
- 💪 TypeScript: Written in TypeScript.
Progress
- Fully typed schema builder
- Query builder (working with string, boolean, number), ordering, projections
- Inferred type of arrays
- Support for object types with subfields
- Custom mappings (
"prop": my.prop) - Resolving image and file types
- Resolving custom object/document types
- Distinguish object/document types within valid field types
- Additional query filters
- Querying multiple types of document
Help and contributions are welcome.
Quick Start
First install sanity-typed-queries:
1yarn add sanity-typed-queries 2 3# or npm 4 5npm install sanity-typed-queries --save
Schema definition
Now you will need to generate your Sanity schema documents using the schema builder. You will get documentation as you type, and enforced compliance with Sanity's schema builder, such as being able to see validation rules applicable to the type of field you are creating, and so on.
schema/author.js:
1import { defineDocument } from 'sanity-typed-queries' 2 3const { document } = defineDocument('author', { 4 name: { 5 type: 'string', 6 validation: Rule => Rule.required(), 7 }, 8 biography: { 9 type: 'text', 10 rows: 4, 11 }, 12 yearOfBirth: { 13 type: 'number', 14 }, 15}) 16 17export default document
This is equivalent to defining the following schema:
1export default { 2 name: 'author', 3 title: 'Author', 4 type: 'document', 5 fields: [ 6 { 7 name: 'name', 8 title: 'Name', 9 type: 'string', 10 validation: Rule => Rule.required(), 11 }, 12 { 13 name: 'biography', 14 title: 'Biography', 15 type: 'text', 16 rows: 4, 17 }, 18 { 19 name: 'yearOfBirth', 20 title: 'Year Of Birth', 21 type: 'number', 22 }, 23 ], 24}
Query builder
For more documentation, see this GROQ/query builder cheat sheet.
You can also export a query builder from the same file.
1import { defineDocument } from 'sanity-typed-queries' 2 3const { document, builder } = defineDocument('author', { 4 ... 5}) 6 7// Export your query builder for use elsewhere 8export { builder } 9export default document
You can use this builder elsewhere to generate the appropriate types and GROQ queries. For example:
1import { builder as authorBuilder } from './cms/schema/author.js' 2 3const [query, type] = authorBuilder.pick('name').first().use() 4 5// *[_type == 'author'][0].name 6const queryString = query 7 8// string 9type AuthorName = typeof type
If you're using the Sanity client, you might use it like this:
1import sanityClient from '@sanity/client' 2import { author } from './cms/schema/author.js' 3 4const [query, type] = author.pick('name').first().use() 5 6const client = sanityClient(config) 7// Promise<string> 8const result = client.fetch<typeof type>(query)
Custom types
You can export utility objects or documents for reference within other schemas.
schema/tag.js:
1import { defineObject } from 'sanity-typed-queries' 2 3const { tag, object } = defineObject('tag', { 4 ... 5}) 6 7export { tag } 8export default object
Then you can pass that when defining documents that reference it.
schema/author.js:
1import { defineObject } from 'sanity-typed-queries' 2import { tag } from './tag' 3 4const { builder, document } = defineDocument( 5 'author', 6 { 7 tag: { 8 type: 'tag', 9 }, 10 }, 11 [tag] 12) 13 14export default document
Inspirations
Projects I've found helpful are:
Contributors
This has been developed to suit my needs but additional use cases and contributions are very welcome.
License
MIT License - Copyright © Daniel Roe
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENCE:0
- Info: FSF or OSI recognized license: MIT License: LICENCE:0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/LiamMartens/sanity-typed-queries/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/LiamMartens/sanity-typed-queries/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/LiamMartens/sanity-typed-queries/ci.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/LiamMartens/sanity-typed-queries/ci.yml/main?enable=pin
- Info: 0 out of 3 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
60 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
- Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
- Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
- Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
- Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
- Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
- Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
- Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Score
2.5
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More