# nvasilev-cstk/publish-stack architecture

> Architecture diagram of the GitHub repository nvasilev-cstk/publish-stack, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nvasilev-cstk/publish-stack
- Repository: https://github.com/nvasilev-cstk/publish-stack

## Overview

publish-everything provides two ways to publish all entries and assets across locales to a Contentstack environment: an embedded dashboard widget backed by resumable Cloud Function steps, and a standalone CLI. The dashboard sends state with each request; the function discovers locales, content types, entries, and assets, then publishes in bounded batches or reports a dry-run summary. The CLI performs the same discovery and publishing workflow interactively. Source excerpts establish the function and CLI orchestration; the widget loop and dashboard behavior are documented in the README, but its implementation was not sampled.

Main entry points: [`functions/publish-step.js`](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/publish-step.js) (Step endpoint), [`cli/publish-all.js`](https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/publish-all.js) (CLI workflow), [`cli/src/client.js`](https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/client.js) (CLI stack client), [`functions/lib/pipelineStep.js`](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js) (Resumable pipeline)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_dashboard["Dashboard app"]
  node_widget["Publish widget<br/>[index.html]"]
end

subgraph group_function["Cloud Function"]
  node_endpoint["Step endpoint<br/>[publish-step.js]"]
  node_pipeline["Resumable pipeline<br/>[pipelineStep.js]"]
  node_locale_discovery["Locale discovery<br/>[pipelineStep.js]"]
  node_type_discovery["Content type discovery<br/>[pipelineStep.js]"]
  node_entry_discovery["Entry discovery<br/>[pipelineStep.js]"]
  node_asset_discovery["Asset discovery<br/>[pipelineStep.js]"]
  node_entry_publish["Entry publishing<br/>[pipelineStep.js]"]
  node_asset_publish["Asset publishing<br/>[pipelineStep.js]"]
  node_function_config["Function config<br/>[config.js]"]
  node_function_errors["Error details<br/>[errors.js]"]
end

subgraph group_cli["Standalone CLI"]
  node_cli_runner["CLI workflow<br/>[publish-all.js]"]
  node_cli_locales["Locale discovery<br/>[locales.js]"]
  node_cli_types["Content type discovery<br/>[contentTypes.js]"]
  node_cli_entries["Entry operations<br/>[entries.js]"]
  node_cli_assets["Asset operations<br/>[assets.js]"]
  node_cli_config["CLI config<br/>[config.js]"]
end

subgraph group_shared["Contentstack access"]
  node_function_client["Function stack client<br/>[stackClient.js]"]
  node_function_limiter["Function rate limiter<br/>[rateLimiter.js]"]
  node_cli_client["CLI stack client<br/>[client.js]"]
  node_cli_limiter["CLI rate limiter<br/>[rateLimiter.js]"]
end

node_dashboard_user(("Dashboard user"))
node_contentstack["Contentstack Management API"]
node_cli_user(("CLI user"))

node_dashboard_user -->|"starts publish"| node_widget
node_widget -->|"POSTs state"| node_endpoint
node_endpoint -->|"returns state"| node_widget
node_endpoint -->|"loads config"| node_function_config
node_endpoint -->|"creates stack"| node_function_client
node_endpoint -->|"creates limiter"| node_function_limiter
node_endpoint -->|"runs step"| node_pipeline
node_endpoint -->|"formats errors"| node_function_errors
node_pipeline -->|"schedules and retries"| node_function_limiter
node_pipeline -->|"describes failures"| node_function_errors
node_pipeline -->|"queries and publishes"| node_contentstack
node_cli_user -->|"runs command"| node_cli_runner
node_cli_runner -->|"reads settings"| node_cli_config
node_cli_runner -->|"creates limiter"| node_cli_limiter
node_cli_runner -->|"fetches locales"| node_cli_locales
node_cli_runner -->|"fetches content types"| node_cli_types
node_cli_runner -->|"discovers and publishes"| node_cli_entries
node_cli_runner -->|"discovers and publishes"| node_cli_assets
node_cli_locales -->|"uses stack"| node_cli_client
node_cli_types -->|"uses stack"| node_cli_client
node_cli_entries -->|"queries and publishes"| node_cli_client
node_cli_assets -->|"queries and publishes"| node_cli_client
node_cli_entries -->|"schedules requests"| node_cli_limiter
node_cli_assets -->|"schedules requests"| node_cli_limiter
node_cli_locales -->|"schedules requests"| node_cli_limiter
node_cli_client -->|"creates SDK stack"| node_contentstack

click node_widget "https://github.com/nvasilev-cstk/publish-stack/blob/main/public/index.html"
click node_endpoint "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/publish-step.js"
click node_pipeline "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js"
click node_locale_discovery "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js"
click node_type_discovery "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js"
click node_entry_discovery "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js"
click node_asset_discovery "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js"
click node_entry_publish "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js"
click node_asset_publish "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js"
click node_function_config "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/config.js"
click node_function_client "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/stackClient.js"
click node_function_limiter "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/rateLimiter.js"
click node_function_errors "https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/errors.js"
click node_cli_runner "https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/publish-all.js"
click node_cli_locales "https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/locales.js"
click node_cli_types "https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/contentTypes.js"
click node_cli_entries "https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/entries.js"
click node_cli_assets "https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/assets.js"
click node_cli_config "https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/config.js"
click node_cli_client "https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/client.js"
click node_cli_limiter "https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/rateLimiter.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_widget,node_dashboard_user,node_cli_user toneBlue
class node_endpoint,node_pipeline,node_locale_discovery,node_type_discovery,node_entry_discovery,node_asset_discovery,node_entry_publish,node_asset_publish,node_function_config,node_function_errors toneAmber
class node_cli_runner,node_cli_locales,node_cli_types,node_cli_entries,node_cli_assets,node_cli_config,node_contentstack toneMint
class node_function_client,node_function_limiter,node_cli_client,node_cli_limiter toneRose
```

## Components

### Dashboard app

- [Publish widget](https://github.com/nvasilev-cstk/publish-stack/blob/main/public/index.html): `public/index.html`

### Cloud Function

- [Step endpoint](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/publish-step.js): `functions/publish-step.js`
- [Resumable pipeline](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js): `functions/lib/pipelineStep.js`
- [Locale discovery](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js): `functions/lib/pipelineStep.js`
- [Content type discovery](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js): `functions/lib/pipelineStep.js`
- [Entry discovery](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js): `functions/lib/pipelineStep.js`
- [Asset discovery](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js): `functions/lib/pipelineStep.js`
- [Entry publishing](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js): `functions/lib/pipelineStep.js`
- [Asset publishing](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/pipelineStep.js): `functions/lib/pipelineStep.js`
- [Function config](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/config.js): `functions/lib/config.js`
- [Error details](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/errors.js): `functions/lib/errors.js`

### Standalone CLI

- [CLI workflow](https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/publish-all.js): `cli/publish-all.js`
- [Locale discovery](https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/locales.js): `cli/src/locales.js`
- [Content type discovery](https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/contentTypes.js): `cli/src/contentTypes.js`
- [Entry operations](https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/entries.js): `cli/src/entries.js`
- [Asset operations](https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/assets.js): `cli/src/assets.js`
- [CLI config](https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/config.js): `cli/src/config.js`

### Contentstack access

- [Function stack client](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/stackClient.js): `functions/lib/stackClient.js`
- [Function rate limiter](https://github.com/nvasilev-cstk/publish-stack/blob/main/functions/lib/rateLimiter.js): `functions/lib/rateLimiter.js`
- [CLI stack client](https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/client.js): `cli/src/client.js`
- [CLI rate limiter](https://github.com/nvasilev-cstk/publish-stack/blob/main/cli/src/rateLimiter.js): `cli/src/rateLimiter.js`

### Other components

- **Dashboard user**
- **Contentstack Management API**
- **CLI user**

## Connections

- Dashboard user → Publish widget: starts publish (evidence: `README.md`)
- Publish widget → Step endpoint: POSTs state (evidence: `README.md`)
- Step endpoint → Publish widget: returns state (evidence: `README.md`)
- Step endpoint → Function config: loads config (evidence: `functions/publish-step.js`)
- Step endpoint → Function stack client: creates stack (evidence: `functions/publish-step.js`)
- Step endpoint → Function rate limiter: creates limiter (evidence: `functions/publish-step.js`)
- Step endpoint → Resumable pipeline: runs step (evidence: `functions/publish-step.js`)
- Step endpoint → Error details: formats errors (evidence: `functions/publish-step.js`)
- Resumable pipeline → Function rate limiter: schedules and retries (evidence: `functions/lib/pipelineStep.js`)
- Resumable pipeline → Error details: describes failures (evidence: `functions/lib/pipelineStep.js`)
- Resumable pipeline → Contentstack Management API: queries and publishes (evidence: `functions/lib/pipelineStep.js`)
- CLI user → CLI workflow: runs command (evidence: `cli/publish-all.js`)
- CLI workflow → CLI config: reads settings (evidence: `cli/publish-all.js`)
- CLI workflow → CLI rate limiter: creates limiter (evidence: `cli/publish-all.js`)
- CLI workflow → Locale discovery: fetches locales (evidence: `cli/publish-all.js`)
- CLI workflow → Content type discovery: fetches content types (evidence: `cli/publish-all.js`)
- CLI workflow → Entry operations: discovers and publishes (evidence: `cli/publish-all.js`)
- CLI workflow → Asset operations: discovers and publishes (evidence: `cli/publish-all.js`)
- Locale discovery → CLI stack client: uses stack (evidence: `cli/src/locales.js`)
- Content type discovery → CLI stack client: uses stack (evidence: `cli/src/contentTypes.js`)
- Entry operations → CLI stack client: queries and publishes (evidence: `cli/src/entries.js`)
- Asset operations → CLI stack client: queries and publishes (evidence: `cli/src/assets.js`)
- Entry operations → CLI rate limiter: schedules requests (evidence: `cli/src/entries.js`)
- Asset operations → CLI rate limiter: schedules requests (evidence: `cli/src/assets.js`)
- Locale discovery → CLI rate limiter: schedules requests (evidence: `cli/src/locales.js`)
- CLI stack client → Contentstack Management API: creates SDK stack (evidence: `cli/src/client.js`)
