Gathering detailed insights and metrics for @sanity/groq-store
Gathering detailed insights and metrics for @sanity/groq-store
Installations
npm install @sanity/groq-storeDeveloper
sanity-io
Developer Guide
BETA
Module System
CommonJS, ESM, UMD
Min. Node Version
>= 18
Typescript Support
Yes
Node Version
18.18.0
NPM Version
9.8.1
Statistics
45 Stars
303 Commits
6 Forks
15 Watching
10 Branches
31 Contributors
Updated on 22 Aug 2024
Bundle Size
61.59 kB
Minified
16.68 kB
Minified + Gzipped
Languages
TypeScript (95.18%)
HTML (1.71%)
CSS (1.52%)
JavaScript (1.29%)
Shell (0.29%)
Total Downloads
Cumulative downloads
Total Downloads
5,802,660
Last day
-3.5%
4,864
Compared to previous day
Last week
6.1%
27,672
Compared to previous week
Last month
1.3%
120,130
Compared to previous month
Last year
3%
2,334,852
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
9
Dev Dependencies
26
huskyeslintrimrafvitestprettierls-enginestypescript@types/nodelint-staged@types/split2@sanity/client@commitlint/cli@sanity/pkg-utils@vitest/coverage-v8eslint-plugin-reacteslint-config-sanityeslint-config-prettiereslint-plugin-prettier@types/throttle-debounce@typescript-eslint/parserprettier-plugin-packagejsonvitest-github-actions-reporter@commitlint/config-conventional@sanity/semantic-release-preset@typescript-eslint/eslint-plugineslint-plugin-simple-import-sort
Versions
@sanity/groq-store
In-memory GROQ store. Streams all available documents from Sanity into an in-memory database and allows you to query them there.
Targets
- Node.js >= 14
- Modern browsers (Edge >= 14, Chrome, Safari, Firefox etc)
Caveats
- Streams entire dataset to memory, so generally not recommended for large datasets
- Needs custom event source to work with tokens in browser
Installation
1npm i @sanity/groq-store
Usage
1import {groqStore, groq} from '@sanity/groq-store'
2// import SanityEventSource from '@sanity/eventsource'
3
4const store = groqStore({
5 projectId: 'abc123',
6 dataset: 'blog',
7
8 // Keep dataset up to date with remote changes. Default: false
9 listen: true,
10
11 // "Replaces" published documents with drafts, if available.
12 // Note that document IDs will not reflect draft status, currently
13 overlayDrafts: true,
14
15 // Optional token, if you want to receive drafts, or read data from private datasets
16 // NOTE: Needs custom EventSource to work in browsers
17 token: 'someAuthToken',
18
19 // Optional limit on number of documents, to prevent using too much memory unexpectedly
20 // Throws on the first operation (query, retrieval, subscription) if reaching this limit.
21 documentLimit: 10000,
22
23 // Optional EventSource. Necessary to authorize using token in the browser, since
24 // the native window.EventSource does not accept headers.
25 // EventSource: SanityEventSource,
26
27 // Optional allow list filter for document types. You can use this to limit the amount of documents by declaring the types you want to sync. Note that since you're fetching a subset of your dataset, queries that works against your Content Lake might not work against the local groq-store.
28 // You can quickly list all your types using this query: `array::unique(*[]._type)`
29 includeTypes: ['post', 'page', 'product', 'sanity.imageAsset'],
30})
31
32store.query(groq`*[_type == "author"]`).then((docs) => {
33 console.log(docs)
34})
35
36store.getDocument('grrm').then((grrm) => {
37 console.log(grrm)
38})
39
40store.getDocuments(['grrm', 'jrrt']).then(([grrm, jrrt]) => {
41 console.log(grrm, jrrt)
42})
43
44const sub = store.subscribe(
45 groq`*[_type == $type][] {name}`, // Query
46 {type: 'author'}, // Params
47 (err, result) => {
48 if (err) {
49 console.error('Oh no, an error:', err)
50 return
51 }
52
53 console.log('Result:', result)
54 },
55)
56
57// Later, to close subscription:
58sub.unsubscribe()
59
60// Later, to close listener:
61store.close()License
MIT © Sanity.io
Release new version
Run "CI & Release" workflow. Make sure to select the main branch and check "Release new version".
Version will be automatically bumped based on conventional commits since the last release.
Semantic release will only release on configured branches, so it is safe to run release on any branch.
Note: commits with chore: will be ignored. If you want updated dependencies to trigger
a new version, use fix(deps): instead.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
GitHub workflow tokens follow principle of least privilege
Details
- Info: topLevel 'contents' permission set to 'read': .github/workflows/main.yml:36
- Info: no jobLevel write permissions found
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/sanity-io/.github/SECURITY.md:1
- Info: Found linked content: github.com/sanity-io/.github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/sanity-io/.github/SECURITY.md:1
- Info: Found text in security policy: github.com/sanity-io/.github/SECURITY.md:1
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/main.yml:89
Reason
dependency not pinned by hash detected -- score normalized to 2
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/groq-store/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/groq-store/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:101: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/groq-store/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:106: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/groq-store/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/groq-store/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/groq-store/main.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yml:87
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 2 out of 3 npmCommand dependencies pinned
Reason
Found 0/3 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
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v4.1.3 not signed: https://api.github.com/repos/sanity-io/groq-store/releases/124797479
- Warn: release artifact v4.1.2 not signed: https://api.github.com/repos/sanity-io/groq-store/releases/121671692
- Warn: release artifact v4.1.1 not signed: https://api.github.com/repos/sanity-io/groq-store/releases/118405391
- Warn: release artifact v4.1.0 not signed: https://api.github.com/repos/sanity-io/groq-store/releases/118403415
- Warn: release artifact v4.0.4 not signed: https://api.github.com/repos/sanity-io/groq-store/releases/115916114
- Warn: release artifact v4.1.3 does not have provenance: https://api.github.com/repos/sanity-io/groq-store/releases/124797479
- Warn: release artifact v4.1.2 does not have provenance: https://api.github.com/repos/sanity-io/groq-store/releases/121671692
- Warn: release artifact v4.1.1 does not have provenance: https://api.github.com/repos/sanity-io/groq-store/releases/118405391
- Warn: release artifact v4.1.0 does not have provenance: https://api.github.com/repos/sanity-io/groq-store/releases/118403415
- Warn: release artifact v4.0.4 does not have provenance: https://api.github.com/repos/sanity-io/groq-store/releases/115916114
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 27 are checked with a SAST tool
Reason
16 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-x565-32qp-m3vf
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-3787-6prv-h9w3
- Warn: Project is vulnerable to: GHSA-9qxr-qj54-h672
- Warn: Project is vulnerable to: GHSA-m4v8-wqvr-p9f7
- Warn: Project is vulnerable to: GHSA-92r3-m2mg-pj97
- Warn: Project is vulnerable to: GHSA-c24v-8rfc-w8vw
- Warn: Project is vulnerable to: GHSA-8jhw-289h-jh2g
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
Score
4.5
/10
Last Scanned on 2024-11-18
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