@adonis-agora/telescope 0.8.2 → 0.8.3

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @adonis-agora/telescope
 
+## 0.8.3
+
+### Patch Changes
+
+- [#28](https://github.com/DavideCarvalho/adonis-agora-telescope/pull/28) [`4b6e205`](https://github.com/DavideCarvalho/adonis-agora-telescope/commit/4b6e205c87367b48c9817ca1c8e8e2b5258d51c8) Thanks [@DavideCarvalho](https://github.com/DavideCarvalho)! - Make the commented-out examples in the published config stubs actually compile.
+
+  Every `config/telescope_*.ts` stub documents its options as a commented block you uncomment. Three
+  of those blocks did not type-check the moment you did:
+
+  - `config/telescope_ui.ts`, `config/telescope_mcp.ts` and `config/telescope_alerts.ts` used
+    `env.get(...)` in their examples without importing `env` — uncommenting one gave
+    `Cannot find name 'env'`. Each now carries a commented `import env from '#start/env'` next to the
+    examples that need it.
+  - The `authorize` example read `ctx.auth?.user?.isAdmin`, but the hook's declared parameter is the
+    framework-light `{ request, response }` slice, so `auth` is not on the type (the provider does
+    pass your real `HttpContext` through at runtime). The example now narrows `ctx` explicitly, which
+    is both correct and honest about why the cast is there.
+  - The `geoLookup` example did `const body = await res.json()`, which is `unknown` — every
+    `body.city` read was an error. It is now typed at the boundary.
+
+  The same four fixes are applied to the docs, which carried the identical examples.
+
+  A new test compiles every published stub inside a scratch consumer app — with the package resolved
+  by name, so against the shipped `dist/**/*.d.ts` — and compiles a second copy of each config stub
+  with every commented example switched on. Across the seven config stubs there are 28 lines of live
+  code and 101 commented ones, so without that second pass the gate would have been watching under a
+  quarter of what these files document.
+
+  `copy:stubs` also now copies the stubs directory wholesale instead of naming each of the eight files
+  in a chained `cp`, so an added stub can no longer be published as a missing file.
+
 ## 0.8.2
 
 ### Patch Changes

package/dist/src/ai/index.d.ts

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export declare const VERSION = "0.8.2";
+export declare const VERSION = "0.8.3";
 export { TelescopeAiDiagnoser } from './telescope_ai_diagnoser.js';
 export type { AnthropicMessagesClient, DiagnoseOptions, TelescopeAiDiagnoserOptions, } from './telescope_ai_diagnoser.js';
 export { normalizeConfidence, parseDiagnosis } from './diagnoser.js';

package/dist/src/ai/index.js

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export const VERSION = '0.8.2';
+export const VERSION = '0.8.3';
 // — diagnoser —
 export { TelescopeAiDiagnoser } from './telescope_ai_diagnoser.js';
 // — diagnosis model + parsing —

package/dist/src/alerts/index.d.ts

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export declare const VERSION = "0.8.2";
+export declare const VERSION = "0.8.3";
 export { consoleChannel, customChannel, slackChannel, webhookChannel, } from './alert_channel.js';
 export type { AlertChannel, ChannelFetch, ConsoleSink } from './alert_channel.js';
 export { formatSlackMessage } from './slack_format.js';

package/dist/src/alerts/index.js

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export const VERSION = '0.8.2';
+export const VERSION = '0.8.3';
 // — channels —
 export { consoleChannel, customChannel, slackChannel, webhookChannel, } from './alert_channel.js';
 // — slack formatting —

package/dist/src/index.d.ts

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export declare const VERSION = "0.8.2";
+export declare const VERSION = "0.8.3";
 export { EntryType, isBatchOrigin } from './entry.js';
 export type { BatchOrigin, BuiltinEntryType, Entry, RecordInput } from './entry.js';
 export type { EntryQuery, TelescopeStore } from './store.js';

package/dist/src/index.js

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export const VERSION = '0.8.2';
+export const VERSION = '0.8.3';
 // — entry model —
 export { EntryType, isBatchOrigin } from './entry.js';
 export { InMemoryTelescopeStore } from './stores/memory.js';

package/dist/src/mcp/index.d.ts

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export declare const VERSION = "0.8.2";
+export declare const VERSION = "0.8.3";
 export { defineConfig, resolveConfig, MCP_TOOL_NAMES } from './define_config.js';
 export type { McpToolName, ResolvedTelescopeMcpConfig, TelescopeMcpConfig, } from './define_config.js';
 export { MCP_INTERNAL_ERROR, MCP_METHOD_NOT_FOUND, MCP_TOOLS, MCP_UNAUTHORIZED, TelescopeMcpServer, } from './server.js';

package/dist/src/mcp/index.js

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export const VERSION = '0.8.2';
+export const VERSION = '0.8.3';
 // — config —
 export { defineConfig, resolveConfig, MCP_TOOL_NAMES } from './define_config.js';
 // — server (plain, testable JSON-RPC surface) —

package/dist/src/profiling/index.d.ts

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export declare const VERSION = "0.8.2";
+export declare const VERSION = "0.8.3";
 export { defineConfig, resolveConfig } from './define_config.js';
 export type { ResolvedTelescopeCpuProfilingConfig, TelescopeCpuProfilingConfig, } from './define_config.js';
 export { CPU_PROFILE_ENTRY_TYPE, ProfilerService, } from './profiler_service.js';

package/dist/src/profiling/index.js

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export const VERSION = '0.8.2';
+export const VERSION = '0.8.3';
 export { defineConfig, resolveConfig } from './define_config.js';
 export { CPU_PROFILE_ENTRY_TYPE, ProfilerService, } from './profiler_service.js';
 export { CpuProfiler, defaultSessionFactory } from './cpu-profiler.js';

package/dist/src/ui/index.d.ts

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export declare const VERSION = "0.8.2";
+export declare const VERSION = "0.8.3";
 export { defineConfig, resolveConfig, normalizePath, defaultAuthorize } from './define_config.js';
 export type { AuthorizeHook, ReplayConfig, ResolvedTelescopeUiConfig, TelescopeUiConfig, UiCredentials, } from './define_config.js';
 export { resolveDashboardAuth, performLogin, readSession, sanitizeReturnTo, decideDashboardAuth, SESSION_COOKIE_NAME, } from './auth.js';

package/dist/src/ui/index.js

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export const VERSION = '0.8.2';
+export const VERSION = '0.8.3';
 // — config —
 export { defineConfig, resolveConfig, normalizePath, defaultAuthorize } from './define_config.js';
 // — built-in `dashboardAuth` login screen (optional; opt-in via `config/telescope_ui.ts`) —

package/dist/src/watchers/index.d.ts

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export declare const VERSION = "0.8.2";
+export declare const VERSION = "0.8.3";
 export type { EmitterLike, Watcher } from './emitter.js';
 export { resolveStore, safeRecord } from './record.js';
 export { buildQueryEntry, DB_QUERY_EVENT, LucidQueryWatcher } from './lucid_query_watcher.js';

package/dist/src/watchers/index.js

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export const VERSION = '0.8.2';
+export const VERSION = '0.8.3';
 // — runtime recording (advanced) —
 export { resolveStore, safeRecord } from './record.js';
 // — Lucid query watcher (the headline watcher) —

package/dist/stubs/config/telescope_alerts.stub

@@ -1,6 +1,8 @@
 {{{
   exports({ to: app.configPath('telescope_alerts.ts') })
 }}}
+/** Uncomment alongside any example below that reads env.get(...). */
+// import env from '#start/env'
 import { defineConfig } from '@adonis-agora/telescope/alerts'
 
 /**
@@ -72,7 +74,7 @@ export default defineConfig({
    */
   // geoLookup: async (ip) => {
   //   const res = await fetch('https://ipapi.example/' + ip)
-  //   const body = await res.json()
+  //   const body = (await res.json()) as { city?: string; region?: string; country?: string; country_code?: string }
   //   return { city: body.city, country: body.country, countryCode: body.country_code }
   // },
 })

package/dist/stubs/config/telescope_mcp.stub

@@ -1,6 +1,8 @@
 {{{
   exports({ to: app.configPath('telescope_mcp.ts') })
 }}}
+/** Uncomment alongside any example below that reads env.get(...). */
+// import env from '#start/env'
 import { defineConfig } from '@adonis-agora/telescope/mcp'
 
 /**
@@ -28,7 +30,12 @@ export default defineConfig({
    * Access-decision hook (identical to the UI/metrics guard). Return true to allow
    * the request. Delegate to your own app auth here, e.g.:
    */
-  // authorize: (ctx) => ctx.auth?.user?.isAdmin === true,
+  // authorize: async (ctx) => {
+  //   // The provider passes your real HttpContext through at runtime; the declared
+  //   // parameter is a framework-light slice, so narrow it to reach your own auth.
+  //   const { auth } = ctx as unknown as { auth: { user?: { isAdmin?: boolean } } }
+  //   return auth.user?.isAdmin === true
+  // },
 
   /**
    * Built-in credentials for the default policy (ignored when authorize is set):

package/dist/stubs/config/telescope_ui.stub

@@ -1,6 +1,8 @@
 {{{
   exports({ to: app.configPath('telescope_ui.ts') })
 }}}
+/** Uncomment alongside any example below that reads env.get(...). */
+// import env from '#start/env'
 import { defineConfig } from '@adonis-agora/telescope/ui'
 
 /**
@@ -25,7 +27,12 @@ export default defineConfig({
    * (the guard answers 401 when no credential was presented, 403 when one was and
    * was rejected). Delegate to your own app auth here, e.g.:
    */
-  // authorize: (ctx) => ctx.auth?.user?.isAdmin === true,
+  // authorize: async (ctx) => {
+  //   // The provider passes your real HttpContext through at runtime; the declared
+  //   // parameter is a framework-light slice, so narrow it to reach your own auth.
+  //   const { auth } = ctx as unknown as { auth: { user?: { isAdmin?: boolean } } }
+  //   return auth.user?.isAdmin === true
+  // },
 
   /**
    * Built-in credentials for the default policy (ignored when authorize is set).

package/dist/stubs/{main.js → main.ts}

@@ -1,7 +1,7 @@
 import { fileURLToPath } from 'node:url';
+
 /**
  * Absolute path to the published stubs directory, resolved from this compiled
  * module's location (`dist/stubs/main.js`). Passed to `codemods.makeUsingStub`.
  */
 export const stubsRoot = fileURLToPath(new URL('./', import.meta.url));
-//# sourceMappingURL=main.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonis-agora/telescope",
-  "version": "0.8.2",
+  "version": "0.8.3",
   "description": "Laravel Telescope-style headless observability for AdonisJS — records HTTP requests and every Agora diagnostics event as queryable entries, plus opt-in subpaths for per-technology watchers, a web dashboard, AI exception diagnosis, and alerting.",
   "license": "MIT",
   "repository": {
@@ -156,7 +156,7 @@
   ],
   "scripts": {
     "build": "tsc -p tsconfig.json && pnpm run copy:stubs && pnpm run copy:assets",
-    "copy:stubs": "mkdir -p dist/stubs/config dist/stubs/database/migrations && cp stubs/config/telescope.stub dist/stubs/config/telescope.stub && cp stubs/config/telescope_watchers.stub dist/stubs/config/telescope_watchers.stub && cp stubs/config/telescope_ui.stub dist/stubs/config/telescope_ui.stub && cp stubs/config/telescope_ai.stub dist/stubs/config/telescope_ai.stub && cp stubs/config/telescope_alerts.stub dist/stubs/config/telescope_alerts.stub && cp stubs/config/telescope_mcp.stub dist/stubs/config/telescope_mcp.stub && cp stubs/config/telescope_cpu_profiling.stub dist/stubs/config/telescope_cpu_profiling.stub && cp stubs/database/migrations/create_telescope_entries_table.stub dist/stubs/database/migrations/create_telescope_entries_table.stub",
+    "copy:stubs": "rm -rf dist/stubs && mkdir -p dist/stubs && cp -R stubs/. dist/stubs/",
     "copy:assets": "mkdir -p dist/src/ui && cp src/ui/dashboard.html dist/src/ui/dashboard.html",
     "test": "vitest run --passWithNoTests",
     "test:watch": "vitest",

package/dist/stubs/main.d.ts

@@ -1,6 +0,0 @@
-/**
- * Absolute path to the published stubs directory, resolved from this compiled
- * module's location (`dist/stubs/main.js`). Passed to `codemods.makeUsingStub`.
- */
-export declare const stubsRoot: string;
-//# sourceMappingURL=main.d.ts.map

package/dist/stubs/main.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../stubs/main.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,SAAS,QAAgD,CAAC"}

package/dist/stubs/main.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../../stubs/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC"}