@agnostack/next-zcli

Installation

yarn add @agnostack/next-zcli
# npm install @agnostack/next-zcli

Quickstart

Inside of next.config.js, add the following:

const { withZendeskCLI } = require('@agnostack/next-zcli')

const manifestTemplate = require('./manifestTemplate.json')

const nextConfig = withZendeskCLI({
  zendesk: { manifestTemplate },
})

Also, create an api route (pages/api/apps.js) containing the following:

import getConfig from 'next/config'
import { zendeskCLIHandler } from '@agnostack/next-zcli'

const { serverRuntimeConfig } = getConfig() ?? {}

// NOTE: api routes do NOT work in `next export`
export default zendeskCLIHandler(serverRuntimeConfig)

Alternate Option #1

Inside of next.config.js, add the following:

const { withPlugins } = require('@agnostack/next-plugins')
const { withZendeskCLI } = require('@agnostack/next-zcli')

const manifest = require('./manifest.json')

const nextPlugins = [{
  [withZendeskCLI]: {
    manifestTemplate: manifest,
    /* NOTE: add optionale below
    apiRoute: '/api/my-custom-api-json-route', // (defaults to /api/apps)
    interactive: true, // (defaults to false)
    data: {
      plan: 'silver',
      app_id: 123,
      installation_id: 12434234,
      my_token: 'myValue',
      parameters: {
        someToken: 'fksjdhfb231435',
        someSecret: 123,
      },
    },
    routes: {
      background: '/background'
      user_sidebar: '/noTicket',
      organization_sidebar: '/noTicket',
      ticket_sidebar: '/ticket',
      new_ticket_sidebar: '/ticket',
    },
    */
  },
}]

const nextConfig = withPlugins({
  /* NOTE: standard nextConfig goes in here
  reactStrictMode: true,
  experimental: {
    esmExternals: false,
  },
  */
}, [nextPlugins])

Also, create an api route (pages/api/apps.js) containing the following:

import getConfig from 'next/config'
import { zendeskCLIHandler } from '@agnostack/next-zcli'

const { publicRuntimeConfig } = getConfig() ?? {}

// NOTE: api routes do NOT work in `next export`
export default zendeskCLIHandler(publicRuntimeConfig)

Contact Adam Grohs @ agnoStack for any questions.