# @zesty-io/webengine-json

> > Fetch WebEngine generated JSON data

Latest version **0.1.1** (published 2023-07-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install @zesty-io/webengine-json
pnpm add @zesty-io/webengine-json
yarn add @zesty-io/webengine-json
bun add @zesty-io/webengine-json
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2023-07-07 |
| First published | 2023-05-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | zestyionpm |

## Links

- npm: https://www.npmjs.com/package/@zesty-io/webengine-json
- Repository: https://github.com/zesty-io/webengine-json
- Homepage: https://github.com/zesty-io/webengine-json#readme
- Issues: https://github.com/zesty-io/webengine-json/issues
- npm.io page: https://npm.io/package/@zesty-io/webengine-json

## Dependencies (1)

- [fetch-ponyfill](https://npm.io/package/fetch-ponyfill.md) ^7.1.0

## Recent versions

- 0.1.1 (latest) — 2023-07-07
- 0.1.0 — 2023-07-06
- 0.0.2 — 2023-05-05
- 0.0.1 — 2023-05-05

## README

# webengine-json

> Fetch WebEngine generated JSON data

A package which orchestrates the URL formation and fetching of `/-/headless/`, `/-/gql/` and `?toJSON` endpoints. Additional [documentation here](https://zesty.org/apis/json-endpoints).

- **domain**: Any domain registered with an instance. The [`live` and `dev`](https://zesty.org/quick-start-guide/instance-settings#zesty-vanity-domains) status determine what data is returned.
- **path**: The path to the page you want to fetch a JSON representation of.
- **password**: If a [preview lock](https://zesty.org/services/web-engine/security#stage-preview-lock-protection) has been set on an instance it must be provided.

### redirects(domain, password)

```JavaScript

import { redirects } from "@zesty-io/webengine-json"

async function() {
    const json = await redirects('https://kfg6bckb-dev.webengine.zesty.io')
    console.log(json)
    // [
    //     {
    //         path: "/%20rel=",
    //         target: "/",
    //         code: "301",
    //     },
    //     ...
    // ]
}

```

### routing(domain, password)

```JavaScript

import { routing } from "@zesty-io/webengine-json"

async function() {
    const json = await routing('https://kfg6bckb-dev.webengine.zesty.io')
    console.log(json)
    // [
    //     {
    //         zuid: "7-31209c-g7qsjg",
    //         title: "Zesty.io: Simplify digital. Maximize results.",
    //         description:
    //         "Zesty is built for teams to manage and distribute content to multiple sites, devices, and anywhere else it needs to go.",
    //         uri: "/",
    //         path_part: "zesty_home",
    //         url: "https://kfg6bckb-dev.webengine.zesty.io/",
    //         locale: "en-US",
    //         hybrid_json_url: "https://kfg6bckb-dev.webengine.zesty.io/?toJSON",
    //     },
    //     ...
    // ]
}

```

### gql(domain, password)

```JavaScript

import { gql } from "@zesty-io/webengine-json"

async function() {
    const json = await gql('https://kfg6bckb-dev.webengine.zesty.io')
    console.log(json)
    // {
    //     "generation_time": "1688749992",
    //     "base": "https://kfg6bckb-dev.webengine.zesty.io",
    //     "schema": "https://kfg6bckb-dev.webengine.zesty.io/-/gql/zesty.schema",
    //     "dataSource": "https://kfg6bckb-dev.webengine.zesty.io/-/gql/datasource.js",
    //     "resolverObject": "https://kfg6bckb-dev.webengine.zesty.io/-/gql/resolvers.js",
    //     "models": [... array of model objects]
    // }
}


```

### toJSON(domain, path, password)

```JavaScript

import { toJSON } from "@zesty-io/webengine-json"

async function() {
    const json = await toJSON('https://kfg6bckb-dev.webengine.zesty.io', '/')
    console.log(json)
//    {
//     field1: "...",
//     field2: "...",
//     field3: "...",
//     meta: {
//         type: "item",
//         model_name: "homepage",
//         model_alternate_name: "Homepage",
//         zuid: "7-31209c-g7qsjg",
//         createdAt: "2023-04-26 00:12:00",
//         updatedAt: "2023-04-26 00:12:00",
//         listed: "1",
//         version: "431",
//         locale: {
//             id: "1",
//             name: "English (United States)",
//             code: "en-US",
//             default: "1",
//             active: "1",
//             enabled: "1",
//         },
//         model: {
//             type: "model",
//             zuid: "6-31079c-vdg69q",
//             name: "homepage",
//             label: "Homepage",
//             resourceURI:
//                 "https://kfg6bckb-dev.webengine.zesty.io/-/instant/6-31079c-vdg69q.json",
//         },
//         web: {
//             url: "https://kfg6bckb-dev.webengine.zesty.io/",
//             uri: "/",
//             fragment: "zesty_home",
//             canonical_tag_mode: "1",
//             sitemap_priority: "-1.0",
//             sitemap_last_updated: "2023-04-26 00:12:00",
//             canonical_query_param_whitelist: null,
//             canonical_tag_custom_value: null,
//             seo_link_text: "Homepage",
//             seo_meta_title: "Zesty.io: Simplify digital. Maximize results.",
//             seo_meta_description:
//                 "Zesty is built for teams to manage and distribute content to multiple sites, devices, and anywhere else it needs to go.",
//             seo_meta_keywords: null,
//         },
//     }

```

---
_Source: https://npm.io/package/@zesty-io/webengine-json · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
