npmpackage.info

Gathering detailed insights and metrics for gatsby-source-mozaik

gatsby-source-mozaik - 1.0.0 | npmpackage.info

gatsby-source-mozaik

Gatsby source plugin for building static websites using Mozaik CMS as a data source.

1.0.0

JavaScript

9.46 kB

1.3

Installations

npm install gatsby-source-mozaik

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

8.9.4

NPM Version

5.6.0 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

mozaikio

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

1 Stars

3 Commits

1 Branches

1 Contributors

Updated on Apr 25, 2019

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.0.0

Package Id

gatsby-source-mozaik@1.0.0

Unpacked Size

9.46 kB

Size

3.63 kB

File Count

NPM Version

5.6.0

Node Version

8.9.4

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

babel-runtime isomorphic-fetch

Dev Dependencies

babel-cli babel-plugin-transform-object-rest-spread babel-plugin-transform-runtime babel-preset-env cross-env jest

gatsby-source-mozaik

Source plugin for pulling data from a Mozaik endpoint into Gatsby.

Install

yarn add gatsby-source-mozaik or npm i gatsby-source-mozaik
Add reference in your Gatsby config plugins section to gatsby-source-mozaik. See example below.
Run gatsby develop

Usage

Make sure that gatsby-source-mozaik plugin is referenced in you gatsby-config.js:

1plugins: [
2  {
3    resolve: `gatsby-source-mozaik`,
4    options: {
5      endpoint: `https://api.mozaik.io/[your-project-name]`,
6      accessToken: `your-access-token`,
7      query: `
8        query documentsQuery($types: [DocumentContentTypeEnum] $pageSize: Int $page: Int) {
9          documents(types: $types pageSize: $pageSize page: $page) {
10            pagination {
11              page
12              pageCount
13            }
14            items {
15              id
16              contentType
17              slug
18            }
19          }
20        }
21      `,
22      variables: {
23        types: [],
24        pageSize: 20,
25        page: 1
26      },
27      fragments: []
28    },
29  }
30],

Plugin options

Key	Value	Required
`endpoint`	Your mozaik api endpoint: `https://api.mozaik.io/[your-project-name]`	Yes
`accessToken`	The access token for authorizing against the api	Yes
`query`	The graphql query to execute. You should use the sample documents query and only amend it.	Yes
`variables`	Variables to use in the graphql query	Yes
`variables.types`	An array of string that defines the content types you want to get from the api	Yes
`variables.pageSize`	Number of items to download in one batch	Yes
`variables.page`	The page number	Yes
`fragments`	An array of string that defines the fields you want to query on each content type	No

How to write a query

Let's say you have created a blog project using the sample blog template on Mozaik. You will have 3 different content types (the enum name in your GraphQL schema):

Homepage (HOMEPAGE)
Post (POST)
Author (AUTHOR)

And you only implement the homepage and the post page components.

To create the query you have to add the following plugin options:

Variables

1variables: {
2  types: ['HOMEPAGE', 'POST'],
3  page: 1,
4  pageSize: 20
5}

Query and Fragments

In Mozaik each document implements the DocumentInterface type, and because of this the result of the documents query returns an array of DocumentInterface object. To be able to query specific fields on each document, you have to define a fragment for each content type. Although you can do this by inlining the fragments in the query itself, we highly recommend to add every fragment in the fragments plugin option in you config. You can read more about interfaces and fragments in the GraphQL documentation

First let's add the fragment definitions:

1fragments: [
2  `fragment HomepageDetails on HomepageDocument {
3    title
4    tagline
5    headerImage {
6      ...HeaderImageFragment
7    }
8    topPosts {
9      items {
10        ...PostDetails
11      }
12    }
13  }`
14  `fragment PostDetails on PostDocument {
15    title
16    slug
17    date
18    postContent {
19      html
20    }
21    postAuthor {
22      name
23    }
24    headerImage {
25      ...HeaderImageFragment
26    }
27  }`,
28  `fragment HeaderImageFragment on Asset {
29    url
30    thumbnailUrl
31    caption
32  }`
33]

Update the default query to add the fragments above:

1query documentsQuery($types: [DocumentContentTypeEnum] $pageSize: Int $page: Int) {
2  documents(types: $types pageSize: $pageSize page: $page) {
3    pagination {
4      page
5      pageCount
6    }
7    items {
8      id
9      contentType
10      slug
11      ...PostDetails
12      ...HomepageDetails
13    }
14  }
15}

And that's it! You're ready to run gatsby develop and load all your documents. If you open the graphql ide that comes with Gatsby you can query your Post documents by running the allPosts query (or the allHomepage query for the Homepage document).

Contributing

cd to the Gatsby project you've set up in which you want to test your changes of the plugin code, or clone mozaikio/mozaik-gatsby-example
If you cloned the example or previously installed the plugin through yarn or npm, run yarn remove gatsby-source-mozaik or npm r gatsby-source-mozaik
mkdir plugins if it does not exist in your Gatsby project yet and cd into it
The path should now be similar to this: ~/projects/mozaik-gatsby-website/plugins/
run git clone https://github.com/mozaikio/gatsby-source-mozaik.git
cd gatsby-source-mozaik
run yarn or yarn && yarn watch in gatsby-source-mozaik plugin’s folder for auto-rebuilding the plugin after you make changes to it (you need to do this only during development)
Make sure plugin is referenced in your Gatsby config (see above at Usage)
From there you can cd ../.. && yarn && yarn develop to test

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

67 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
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-6394-6h9h-cfjg
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
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-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.3

/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