@stackbit/sdk NPM | npm.io

1.0.24 • Published 4 days ago

Install

Weekly downloads

-

License

MIT

Repository

Last release

4 days ago

Stackbit SDK

Stackbit SDK contains set of utilities to work with stackbit.yaml file.

Add to your project

npm install @stackbit/sdk

Generate stackbit.yaml

Create a FileBrowser with FileSystemFileBrowserAdapter or GitHubFileBrowserAdapter:

Analyzing a local project:

import { FileSystemFileBrowserAdapter, FileBrowser } from '@stackbit/sdk';

const fileBrowserAdapter = new FileSystemFileBrowserAdapter({ dirPath: inputDir });
const fileBrowser = new FileBrowser({ fileBrowserAdapter });

Analyzing a remote GitHub project:

import { GitHubFileBrowserAdapter, FileBrowser } from '@stackbit/sdk';

const fileBrowserAdapter = new GitHubFileBrowserAdapter({
    owner: 'stackbit',
    repo: 'theme',
    branch: 'master',
    auth: GITHUB_PERSONAL_ACCESS_TOKEN
});
const fileBrowser = new FileBrowser({ fileBrowserAdapter });

Then, pass the fileBrowser to the analyzeSite() method, get the result and save the config as stackbit.yaml:

import { writeConfig, analyzeSite } from '@stackbit/sdk';

const analyzeResult = await analyzeSite({ fileBrowser });
await writeConfig({ dirPath: inputDir, config: analyzeResult.config });

Validate stackbit.yaml

Load and validate stackbit.yaml. Any errors will be returned within the errors array.

import { loadConfig } from '@stackbit/sdk';

const configResult = await loadConfig({ dirPath: inputDir });

configResult.errors.forEach((error) => {
    console.log(error.message);
});

If configResult.config is not null, pass it to load and validate web-site's content. Any errors will be returned within the errors array, and loaded content within the contentItems:

import { loadContent } from '@stackbit/sdk';

if (configResult.config) {
    return;
}

const contentResult = await loadContent({ dirPath: inputDir, config: configResult.config });

contentResult.contentItems.forEach((contentItem) => {
    console.log(contentItem.__metadata.filePath);
});

contentResult.errors.forEach((error) => {
    console.log(error.message);
});

stackbit sdk jamstack ssg cms headless-cms schema

@octokit/rest @stackbit/types @stackbit/utils acorn chokidar esbuild fs-extra joi js-yaml lodash micromatch moment semver

1.0.25-staging.1

4 days ago

4 days ago

1.0.24-staging.2

12 days ago

1.0.24-staging.1

13 days ago

13 days ago

1.0.22-staging.2

20 days ago

1.0.23-staging.1

20 days ago

20 days ago

1.0.22-staging.1

25 days ago

25 days ago

25 days ago

1.0.21-feature-document-statuses.1

25 days ago

1.0.20-staging.1

1 month ago

1.0.20-staging.2

1 month ago

1 month ago

1.0.20-develop.2

1 month ago

1.0.20-develop.1

1 month ago

1 month ago

1.0.19-staging.1

1 month ago

1.0.19-develop.2

2 months ago

1.0.18-staging.2

2 months ago

1.0.18-feature-clac.0

2 months ago

1.0.19-develop.1

2 months ago

2 months ago

1.0.18-staging.1

2 months ago

1.0.17-develop.3

2 months ago

1.0.18-develop.1

2 months ago

1.0.17-staging.1

2 months ago

1.0.16-staging.3

2 months ago

2 months ago

1.0.17-develop.2

2 months ago

1.0.16-staging.2

2 months ago

1.0.17-develop.1

2 months ago

1.0.15-staging.1

2 months ago

1.0.16-develop.1

2 months ago

1.0.16-staging.1

2 months ago

2 months ago

2 months ago

1.0.14-staging.2

2 months ago

1.0.15-develop.2

2 months ago

1.0.14-staging.1

2 months ago

1.0.15-develop.1

2 months ago

2 months ago

1.0.13-staging.0

3 months ago

1.0.13-staging.1

3 months ago

1.0.14-develop.1

3 months ago

3 months ago

1.0.13-develop.2

3 months ago

1.0.13-develop.1

3 months ago

1.0.12-staging.1

3 months ago

3 months ago

1.0.12-develop.3

3 months ago

1.0.11-staging.4

3 months ago

1.0.12-develop.2

3 months ago

1.0.12-develop.1

3 months ago

1.0.11-staging.2

3 months ago

1.0.11-staging.1

3 months ago

1.0.11-staging.3

3 months ago

3 months ago

1.0.11-develop.2

3 months ago

1.0.11-develop.1

3 months ago

1.0.10-staging.1

3 months ago

3 months ago

1.0.10-develop.2

4 months ago

1.0.9-develop.1

4 months ago

1.0.10-develop.1

4 months ago

4 months ago

1.0.8-staging.1

4 months ago

1.0.9-staging.1

4 months ago

1.0.8-develop.1

4 months ago

4 months ago

1.0.7-staging.1

4 months ago

1.0.7-develop.1

4 months ago

1.0.6-staging.1

4 months ago

4 months ago

1.0.6-develop.1

5 months ago

1.0.5-staging.1

5 months ago

5 months ago

1.0.5-develop.4

5 months ago

1.0.4-staging.3

5 months ago

1.0.4-staging.2

5 months ago

1.0.5-develop.3

5 months ago

1.0.5-develop.2

5 months ago

1.0.4-staging.1

5 months ago

1.0.5-develop.1

5 months ago

5 months ago

0.7.0-staging.1

9 months ago

0.6.6-develop.1

10 months ago

0.6.6-develop.2

9 months ago

0.7.17-staging.1

6 months ago

0.6.3-staging.2

10 months ago

0.7.3-develop.1

9 months ago

0.6.3-staging.1

10 months ago

1.0.3-staging.1

5 months ago

9 months ago

9 months ago

8 months ago

0.7.9-develop.1

7 months ago

9 months ago

1.0.1-develop.1

6 months ago

0.7.1-staging.1

9 months ago

1.0.0-develop.0

6 months ago

0.6.2-staging.1

10 months ago

0.7.4-develop.2

8 months ago

0.7.4-develop.1

9 months ago

0.6.2-staging.2

10 months ago

0.7.16-staging.1

6 months ago

0.7.4-develop.3

8 months ago

0.7.13-develop.1

7 months ago

0.7.16-develop.3

6 months ago

0.7.16-develop.2

6 months ago

0.6.2-develop.1

10 months ago

0.7.16-develop.1

6 months ago

1.0.2-develop.1

5 months ago

0.7.15-staging.1

6 months ago

1.0.2-develop.2

5 months ago

0.7.15-staging.2

6 months ago

0.7.2-develop.1

9 months ago

0.7.1-develop.1

9 months ago

8 months ago

8 months ago

7 months ago

7 months ago

0.7.12-staging.1

7 months ago

1.0.4-develop.1

5 months ago

1.0.1-staging.1

5 months ago

0.7.1-develop.2

9 months ago

0.7.13-staging.1

7 months ago

0.7.14-develop.1

7 months ago

10 months ago

0.7.0-develop.0

9 months ago

10 months ago

9 months ago

10 months ago

1.0.2-staging.1

5 months ago

10 months ago

0.7.17-develop.1

6 months ago

1.0.3-develop.1

5 months ago

0.7.6-develop.1

8 months ago

0.7.6-develop.2

8 months ago

0.7.6-develop.3

8 months ago

0.7.6-develop.4

8 months ago

0.6.3-develop.2

10 months ago

0.7.3-staging.1

9 months ago

0.6.3-develop.1

10 months ago

1.0.0-staging.1

6 months ago

7 months ago

7 months ago

0.7.8-staging.1

7 months ago

6 months ago

6 months ago

6 months ago

6 months ago

0.7.18-develop.1

6 months ago

0.7.9-staging.1

7 months ago

0.7.2-staging.1

9 months ago

5 months ago

0.7.7-staging.1

8 months ago

0.7.4-staging.1

8 months ago

0.6.5-develop.2

10 months ago

0.6.5-develop.1

10 months ago

0.7.5-develop.1

8 months ago

0.6.4-staging.1

10 months ago

0.7.8-develop.3

7 months ago

0.7.8-develop.1

8 months ago

0.7.8-develop.2

8 months ago

0.7.5-staging.1

8 months ago

0.7.5-staging.2

8 months ago

0.6.5-staging.1

10 months ago

0.7.7-develop.3

8 months ago

0.7.7-develop.2

8 months ago

0.7.7-develop.1

8 months ago

0.7.6-staging.1

8 months ago

0.7.6-staging.2

8 months ago

0.6.1-staging.1

10 months ago

10 months ago

0.5.3-develop.1

12 months ago

0.5.6-develop.3

11 months ago

0.6.0-staging.1

10 months ago

0.5.6-develop.1

11 months ago

0.5.6-develop.2

11 months ago

0.5.3-staging.1

12 months ago

0.5.3-develop.2

12 months ago

0.5.3-develop.3

12 months ago

0.5.9-develop.1

11 months ago

0.5.8-staging.1

11 months ago

10 months ago

11 months ago

10 months ago

0.5.2-staging.1

12 months ago

0.5.5-develop.2

12 months ago

0.5.5-develop.1

12 months ago

0.5.4-develop.1

12 months ago

0.5.7-staging.1

11 months ago

0.5.4-staging.4

12 months ago

0.5.4-staging.3

12 months ago

12 months ago

0.5.4-staging.1

12 months ago

12 months ago

11 months ago

11 months ago

12 months ago

0.5.8-develop.1

11 months ago

0.5.5-staging.2

11 months ago

0.5.5-staging.1

11 months ago

0.5.7-develop.1

11 months ago

0.6.0-develop.0

11 months ago

0.5.6-staging.1

11 months ago

0.5.0-staging.1

1 year ago

0.5.0-staging.2

1 year ago

0.4.3-develop.1

1 year ago

0.5.0-staging.0

1 year ago

0.4.0-staging.1

1 year ago

0.4.0-staging.0

1 year ago

0.4.3-staging.1

1 year ago

0.4.2-staging.1

1 year ago

0.4.4-develop.1

1 year ago

1 year ago

1 year ago

0.3.26-develop.1

1 year ago

0.3.26-develop.0

1 year ago

0.4.1-staging.1

1 year ago

0.3.26-staging.0

1 year ago

1 year ago

1 year ago

0.3.19-develop.0

1 year ago

0.3.19-develop.1

1 year ago

1 year ago

1 year ago

0.5.1-staging.1

1 year ago

0.4.2-develop.1

1 year ago

1 year ago

0.5.2-develop.1

1 year ago

0.4.1-develop.1

1 year ago

0.4.1-develop.2

1 year ago

0.4.1-develop.3

1 year ago

0.3.19-staging.0

1 year ago

0.3.19-staging.1

1 year ago

0.3.19-staging.2

1 year ago

0.3.19-gitcms.0

1 year ago

0.3.19-gitcms.1

1 year ago

0.3.19-gitcms.2

1 year ago

0.4.0-develop.1

1 year ago

0.4.0-develop.0

1 year ago

0.3.19-gitcms.3

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.3.22-types-alpha.0

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.3.18-cloudinary-presets.0

1 year ago

1 year ago

1 year ago

0.3.13-sanity-locale.0

1 year ago

0.3.10-canary.0

1 year ago

1 year ago

1 year ago

0.3.15-cross-references.0

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago