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.

• domain: Any domain registered with an instance. The live and dev 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 has been set on an instance it must be provided.

redirects(domain, password)

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)

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)

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)

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,
//         },
//     }