atomic

flowstate-epic-flowstate-community-epicdm-flowstate-tunnel

Package-local agent skill for @epicdm/flowstate-tunnel.

Tags

Publisher

Versions

1 version published — latest: 0.1.0

  • 0.1.0
    publishedInvalid Date

Skill

flowstate-tunnel Package Skill

Package: @epicdm/flowstate-tunnel Repository: epic-flowstate-community Path: packages/flowstate-tunnel Version: 0.1.0

Use this published Dojo skill as the package-level entrypoint. For detailed workflows, use the package-local skills listed below.

Primary Package Workflow

Tunnel Contracts

Status: Active Purpose: Keep tunnel shared contracts consistent across Worker and client code. Scope: packages/flowstate-tunnel/src/types.ts and src/constants.ts Trigger: A task involves tunnel endpoint payloads, KV records, status, heartbeat, Cloudflare API, or cloudflared timings. Input: Contract field or constant to use/change. Output: Correct shared type or constant usage.


Request And Response Types

TypeUsed For
TunnelRegisterRequestWorker /tunnel/register request body.
TunnelProvisionRequestWorker /tunnel/provision request body.
TunnelProvisionResponseProvision response with token, subdomain, and tunnel ID.
TunnelHeartbeatWorker /tunnel/heartbeat body.
TunnelStatusWorker /tunnel/status response.
TunnelTeardownRequestWorker /tunnel/teardown body.
TunnelKVRecordKV record stored under org:{orgId}.
TunnelResultElectron manager operation result.
TunnelManagerStateElectron IPC-visible manager state.

Constants

ConstantMeaning
HEARTBEAT_INTERVAL_MSElectron heartbeat cadence: 60 seconds.
STALE_TUNNEL_THRESHOLD_MSWorker stale cleanup threshold: 10 minutes.
CLOUDFLARED_STARTUP_DELAY_MSWait before checking cloudflared health: 3 seconds.
CLOUDFLARED_SHUTDOWN_TIMEOUT_MSGraceful shutdown wait before SIGKILL: 5 seconds.
TUNNEL_DOMAINBase domain: epicflowstate.ai.
CF_API_BASECloudflare API base URL.
MAX_SLUG_LENGTHDNS label length: 63.
SLUG_PATTERNDNS-safe slug pattern.

Verification

yarn workspace @epicdm/flowstate-tunnel typecheck
yarn workspace @epicdm/flowstate-tunnel-worker typecheck

Package Skill Inventory

Skill Inventory: @epicdm/flowstate-tunnel

Review date: 2026-06-30

Skill Map

SkillTypeUse When
flowstate-tunnelOrchestratorSelecting the shared tunnel contract package and composing with the worker.
flowstate-tunnel-contractsReferenceUsing tunnel request/response/KV/manager types and constants.
flowstate-tunnel-slug-validationWorkflow/referenceValidating org slugs for tunnel subdomains.
flowstate-tunnel-worker-compositionWorkflowChanging shared contracts that affect flowstate-tunnel-worker.
flowstate-tunnel-maintenanceMaintenanceUpdating docs, tests, Dojo files, or verification for this package.

Feature Coverage

Feature Matrix ItemsCovered By
constantsflowstate-tunnel-contracts, flowstate-tunnel-worker-composition
exported tunnel interfacesflowstate-tunnel-contracts
validateOrgSlug, SlugValidationResultflowstate-tunnel-slug-validation

Composition Notes

  • Use flowstate-tunnel-worker package skills for endpoint handlers, Cloudflare calls, KV behavior, cron cleanup, and auth.
  • Use this package for shared vocabulary and validation only.

Review Gate

Package Skill Review: @epicdm/flowstate-tunnel

Review date: 2026-06-30 Verdict: pass

Quality Gate

  • Source-backed package purpose: pass.
  • Public entry points documented: pass.
  • Composable skill map: pass.
  • Generated Dojo weaknesses called out: pass.
  • Dojo publish readiness: deferred until generated artifacts are rebuilt from reviewed skills.

Evidence Checked

  • package.json
  • src/index.ts
  • src/constants.ts
  • src/types.ts
  • src/validation.ts
  • src/__tests__/validation.test.ts
  • .flowstate/feature-matrix/inventory.md
  • .flowstate/dojo/agent-skillset.md

Verification Results

yarn workspace @epicdm/flowstate-tunnel test
yarn workspace @epicdm/flowstate-tunnel typecheck
yarn workspace @epicdm/flowstate-tunnel build
yarn workspace @epicdm/flowstate-tunnel lint
yarn nx build @epicdm/flowstate-tunnel

Results:

  • ASCII/frontmatter check passed.
  • test passed: 1 file, 7 tests. Vitest emitted the existing Vite CJS Node API deprecation warning.
  • typecheck passed.
  • lint passed.
  • build passed.
  • nx build passed with the existing Nx Cloud 401/unconnected workspace notice.

Dojo Status

Deferred. Existing generated Dojo artifacts should be rebuilt from reviewed local skills because the current skillset splits constants into separate skilllets rather than teaching shared tunnel contracts and worker composition.

Usage

Start with this skill to understand the package purpose, then use the package-local focused skills for specific workflows. Keep this Dojo version aligned with packages/flowstate-tunnel/package.json. Do not treat generated feature lists as lessons; use workflow evidence from CODE-REVIEW.md, SKILL-INVENTORY.md, and REVIEW.md.

Install

Run this in your project to install via CLI:

fscloud dojo skill install flowstate-epic-flowstate-community-epicdm-flowstate-tunnel --target <target> --out ./skills

Replace <target> with your agent target identifier. See the CLI docs for details.

flowstate-epic-flowstate-community-epicdm-flowstate-tunnel | dojo.epicflowstate.ai | Epic Dojo