@checkstack/sdk 0.129.0 → 0.131.0

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # @checkstack/sdk
 
+## 0.130.1
+
+### Patch Changes
+
+- Updated dependencies [a74fa01]
+- Updated dependencies [4568dcc]
+- Updated dependencies [4568dcc]
+- Updated dependencies [4568dcc]
+- Updated dependencies [a74fa01]
+- Updated dependencies [d00e099]
+  - @checkstack/healthcheck-common@1.17.0
+  - @checkstack/satellite-common@0.10.0
+  - @checkstack/catalog-common@2.7.3
+  - @checkstack/anomaly-common@1.8.1
+  - @checkstack/announcement-common@0.7.1
+  - @checkstack/auth-common@0.14.0
+  - @checkstack/automation-common@0.10.1
+  - @checkstack/cache-common@0.5.11
+  - @checkstack/command-common@0.3.11
+  - @checkstack/common@0.22.0
+  - @checkstack/dependency-common@1.7.5
+  - @checkstack/gitops-common@0.7.3
+  - @checkstack/incident-common@1.10.3
+  - @checkstack/integration-common@0.9.9
+  - @checkstack/maintenance-common@1.10.3
+  - @checkstack/notification-common@1.7.1
+  - @checkstack/pluginmanager-common@0.2.16
+  - @checkstack/queue-common@0.6.12
+  - @checkstack/script-packages-common@0.4.1
+  - @checkstack/secrets-common@0.3.2
+  - @checkstack/slo-common@0.9.3
+  - @checkstack/theme-common@0.2.11
+  - @checkstack/tips-common@0.3.11
+
+## 0.129.1
+
+### Patch Changes
+
+- Updated dependencies [1f20b5a]
+  - @checkstack/anomaly-common@1.8.0
+  - @checkstack/catalog-common@2.7.2
+  - @checkstack/dependency-common@1.7.4
+  - @checkstack/healthcheck-common@1.16.2
+  - @checkstack/incident-common@1.10.2
+  - @checkstack/maintenance-common@1.10.2
+  - @checkstack/slo-common@0.9.2
+  - @checkstack/satellite-common@0.9.6
+
 ## 0.128.1
 
 ### Patch Changes

package/generated/editor-bundle.d.ts

@@ -46,6 +46,13 @@ declare module "@checkstack/sdk/healthcheck" {
       readonly id: string;
       /** The system's display name (falls back to the id). */
       readonly name: string;
+      /**
+       * The system's free-form custom fields, with the original
+       * (non-normalized) keys — so you read `metadata.baseUrl` directly.
+       * Values are arbitrary JSON (metadata only, never secrets); narrow
+       * each before use, e.g. `typeof metadata.baseUrl === "string"`.
+       */
+      readonly metadata: Record<string, unknown>;
     };
     /**
      * The environment this run resolved to, when the check fanned out into

package/generated/healthcheck.d.ts

@@ -35,6 +35,13 @@ interface HealthCheckScriptContext {
     readonly id: string;
     /** The system's display name (falls back to the id). */
     readonly name: string;
+    /**
+     * The system's free-form custom fields, with the original
+     * (non-normalized) keys — so you read `metadata.baseUrl` directly.
+     * Values are arbitrary JSON (metadata only, never secrets); narrow
+     * each before use, e.g. `typeof metadata.baseUrl === "string"`.
+     */
+    readonly metadata: Record<string, unknown>;
   };
   /**
    * The environment this run resolved to, when the check fanned out into

package/generated/index.d.ts

@@ -117,6 +117,13 @@ interface HealthCheckScriptContext {
     readonly id: string;
     /** The system's display name (falls back to the id). */
     readonly name: string;
+    /**
+     * The system's free-form custom fields, with the original
+     * (non-normalized) keys — so you read `metadata.baseUrl` directly.
+     * Values are arbitrary JSON (metadata only, never secrets); narrow
+     * each before use, e.g. `typeof metadata.baseUrl === "string"`.
+     */
+    readonly metadata: Record<string, unknown>;
   };
   /**
    * The environment this run resolved to, when the check fanned out into

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/sdk",
-  "version": "0.129.0",
+  "version": "0.131.0",
   "license": "Elastic-2.0",
   "type": "module",
   "description": "Auto-generated, version-pinned typed client and script-authoring helpers for Checkstack.",
@@ -27,27 +27,27 @@
     }
   },
   "dependencies": {
-    "@checkstack/announcement-common": "0.7.0",
-    "@checkstack/anomaly-common": "1.7.2",
+    "@checkstack/announcement-common": "0.7.1",
+    "@checkstack/anomaly-common": "1.8.1",
     "@checkstack/auth-common": "0.14.0",
-    "@checkstack/automation-common": "0.10.0",
+    "@checkstack/automation-common": "0.10.1",
     "@checkstack/cache-common": "0.5.11",
-    "@checkstack/catalog-common": "2.7.1",
+    "@checkstack/catalog-common": "2.7.3",
     "@checkstack/command-common": "0.3.11",
     "@checkstack/common": "0.22.0",
-    "@checkstack/dependency-common": "1.7.3",
+    "@checkstack/dependency-common": "1.7.5",
     "@checkstack/gitops-common": "0.7.3",
-    "@checkstack/healthcheck-common": "1.16.1",
-    "@checkstack/incident-common": "1.10.1",
-    "@checkstack/integration-common": "0.9.8",
-    "@checkstack/maintenance-common": "1.10.1",
-    "@checkstack/notification-common": "1.7.0",
+    "@checkstack/healthcheck-common": "1.17.0",
+    "@checkstack/incident-common": "1.10.3",
+    "@checkstack/integration-common": "0.9.9",
+    "@checkstack/maintenance-common": "1.10.3",
+    "@checkstack/notification-common": "1.7.1",
     "@checkstack/pluginmanager-common": "0.2.16",
-    "@checkstack/queue-common": "0.6.11",
-    "@checkstack/satellite-common": "0.9.5",
-    "@checkstack/script-packages-common": "0.4.0",
+    "@checkstack/queue-common": "0.6.12",
+    "@checkstack/satellite-common": "0.10.0",
+    "@checkstack/script-packages-common": "0.4.1",
     "@checkstack/secrets-common": "0.3.2",
-    "@checkstack/slo-common": "0.9.1",
+    "@checkstack/slo-common": "0.9.3",
     "@checkstack/theme-common": "0.2.11",
     "@checkstack/tips-common": "0.3.11",
     "@orpc/client": "^1.14.4",
@@ -56,7 +56,7 @@
   "devDependencies": {
     "typescript": "^5.7.2",
     "@checkstack/tsconfig": "0.0.7",
-    "@checkstack/scripts": "0.7.3"
+    "@checkstack/scripts": "0.7.4"
   },
   "scripts": {
     "typecheck": "tsgo -b",

package/src/editor-bundle.ts

@@ -8,6 +8,6 @@
 // must NOT bundle (it fetches the bundle live; see ./version.ts).
 
 /** The combined ambient `.d.ts` the in-app editor mounts into Monaco. */
-export const SDK_EDITOR_BUNDLE_DTS = "// AUTO-GENERATED by scripts/generate-sdk.ts - DO NOT EDIT BY HAND.\n// Run `bun run generate:sdk` after changing a *-common contract or the\n// script-context helper builders.\n\n// Combined ambient declarations served ONLY by the version-keyed editor\n// route and mounted into Monaco. NOT the `exports`-resolved declarations\n// (those are the per-subpath generated/*.d.ts). Declares the subpath module\n// names only - bare names are intentionally absent so an old import errors.\n//\n// Every declaration is module-scoped (no top-level globals): the editor\n// mounts this bundle alongside scriptContext.ts, which owns the global\n// `defineHealthCheck` / `defineIntegration` + schema-narrowed context types\n// (plan §6.2). Top-level globals here would duplicate those and error.\n\ndeclare module \"@checkstack/sdk/healthcheck\" {\n  /** Result emitted by an inline health-check script. */\n  interface HealthCheckScriptResult {\n    /** Whether the health check passed. */\n    success: boolean;\n    /** Optional status message — surfaces in the run detail. */\n    message?: string;\n    /** Optional numeric value — feeds the value chart + anomaly detection. */\n    value?: number;\n  }\n\n  /**\n   * Runtime context exposed to inline health-check scripts. `config` is\n   * typed from the collector's own JSON Schema, so the fields you've\n   * declared on the configuration are autocompletable inside the script.\n   */\n  interface HealthCheckScriptContext {\n    /** Strongly-typed collector configuration. */\n    readonly config: Record<string, unknown>;\n    /** Metadata about the health check this run is for. */\n    readonly check: {\n      /** The health check configuration id. */\n      readonly id: string;\n      /** The health check's display name (falls back to the id). */\n      readonly name: string;\n      /** The configured run interval, in seconds. */\n      readonly intervalSeconds: number;\n    };\n    /** Metadata about the system this check runs for. */\n    readonly system: {\n      /** The system id. */\n      readonly id: string;\n      /** The system's display name (falls back to the id). */\n      readonly name: string;\n    };\n    /**\n     * The environment this run resolved to, when the check fanned out into\n     * one. `undefined` when the assignment opts out or the system has no\n     * environments — always guard with `context.environment?.…`.\n     */\n    readonly environment?: {\n      /** The environment id. */\n      readonly id: string;\n      /** The environment's display name (falls back to the id). */\n      readonly name: string;\n      /**\n       * The environment's free-form custom metadata, with the original\n       * (non-normalized) keys — so you read `fields.baseUrl` directly.\n       * Values are arbitrary JSON (metadata only, never secrets); narrow\n       * each before use, e.g. `typeof fields.baseUrl === \"string\"`.\n       */\n      readonly fields: Record<string, unknown>;\n    };\n  }\n\n  export function defineHealthCheck<\n    T extends\n      | HealthCheckScriptResult\n      | ((ctx: HealthCheckScriptContext) =>\n          | HealthCheckScriptResult\n          | Promise<HealthCheckScriptResult>),\n  >(value: T): T;\n  export type { HealthCheckScriptResult, HealthCheckScriptContext };\n}\n\ndeclare module \"@checkstack/sdk/integration\" {\n  /** Result emitted by an inline integration script. */\n  interface IntegrationScriptResult {\n    /** External ID for tracking (e.g. ticket number, message ID). */\n    id?: string;\n    /** Same as `id` — accepted for backwards compatibility. */\n    externalId?: string;\n  }\n\n  /**\n   * Runtime context exposed to inline integration scripts. `event.payload`\n   * is typed from the event's payload schema so the fields it advertises\n   * are autocompletable inside the script.\n   */\n  interface IntegrationScriptContext {\n    /** The event being delivered. */\n    readonly event: {\n      /** Fully-qualified event ID, e.g. \"incident.created\". */\n      readonly eventId: string;\n      /** Strongly-typed event payload. */\n      readonly payload: Record<string, unknown>;\n      /** ISO-8601 timestamp of when the event was emitted. */\n      readonly timestamp: string;\n      /** Unique ID for this delivery attempt. */\n      readonly deliveryId: string;\n    };\n    /** Subscription that triggered this delivery. */\n    readonly subscription: {\n      readonly id: string;\n      readonly name: string;\n    };\n  }\n\n  export function defineIntegration<\n    T extends\n      | IntegrationScriptResult\n      | void\n      | ((ctx: IntegrationScriptContext) =>\n          | IntegrationScriptResult\n          | void\n          | Promise<IntegrationScriptResult | void>),\n  >(value: T): T;\n  export type { IntegrationScriptResult, IntegrationScriptContext };\n}\n\ndeclare module \"@checkstack/sdk\" {\n  export { defineHealthCheck } from \"@checkstack/sdk/healthcheck\";\n  export type { HealthCheckScriptResult, HealthCheckScriptContext } from \"@checkstack/sdk/healthcheck\";\n  export { defineIntegration } from \"@checkstack/sdk/integration\";\n  export type { IntegrationScriptResult, IntegrationScriptContext } from \"@checkstack/sdk/integration\";\n  export interface CreateCheckstackClientOptions {\n    baseUrl: string;\n    headers?: Record<string, string>;\n  }\n  /** The fully-typed Checkstack API client (one entry per plugin id). */\n  export type CheckstackClient = Record<string, unknown>;\n  /** Build a typed Checkstack client over the REST/OpenAPI surface. */\n  export function createCheckstackClient(\n    options: CreateCheckstackClientOptions,\n  ): CheckstackClient;\n}\n";
+export const SDK_EDITOR_BUNDLE_DTS = "// AUTO-GENERATED by scripts/generate-sdk.ts - DO NOT EDIT BY HAND.\n// Run `bun run generate:sdk` after changing a *-common contract or the\n// script-context helper builders.\n\n// Combined ambient declarations served ONLY by the version-keyed editor\n// route and mounted into Monaco. NOT the `exports`-resolved declarations\n// (those are the per-subpath generated/*.d.ts). Declares the subpath module\n// names only - bare names are intentionally absent so an old import errors.\n//\n// Every declaration is module-scoped (no top-level globals): the editor\n// mounts this bundle alongside scriptContext.ts, which owns the global\n// `defineHealthCheck` / `defineIntegration` + schema-narrowed context types\n// (plan §6.2). Top-level globals here would duplicate those and error.\n\ndeclare module \"@checkstack/sdk/healthcheck\" {\n  /** Result emitted by an inline health-check script. */\n  interface HealthCheckScriptResult {\n    /** Whether the health check passed. */\n    success: boolean;\n    /** Optional status message — surfaces in the run detail. */\n    message?: string;\n    /** Optional numeric value — feeds the value chart + anomaly detection. */\n    value?: number;\n  }\n\n  /**\n   * Runtime context exposed to inline health-check scripts. `config` is\n   * typed from the collector's own JSON Schema, so the fields you've\n   * declared on the configuration are autocompletable inside the script.\n   */\n  interface HealthCheckScriptContext {\n    /** Strongly-typed collector configuration. */\n    readonly config: Record<string, unknown>;\n    /** Metadata about the health check this run is for. */\n    readonly check: {\n      /** The health check configuration id. */\n      readonly id: string;\n      /** The health check's display name (falls back to the id). */\n      readonly name: string;\n      /** The configured run interval, in seconds. */\n      readonly intervalSeconds: number;\n    };\n    /** Metadata about the system this check runs for. */\n    readonly system: {\n      /** The system id. */\n      readonly id: string;\n      /** The system's display name (falls back to the id). */\n      readonly name: string;\n      /**\n       * The system's free-form custom fields, with the original\n       * (non-normalized) keys — so you read `metadata.baseUrl` directly.\n       * Values are arbitrary JSON (metadata only, never secrets); narrow\n       * each before use, e.g. `typeof metadata.baseUrl === \"string\"`.\n       */\n      readonly metadata: Record<string, unknown>;\n    };\n    /**\n     * The environment this run resolved to, when the check fanned out into\n     * one. `undefined` when the assignment opts out or the system has no\n     * environments — always guard with `context.environment?.…`.\n     */\n    readonly environment?: {\n      /** The environment id. */\n      readonly id: string;\n      /** The environment's display name (falls back to the id). */\n      readonly name: string;\n      /**\n       * The environment's free-form custom metadata, with the original\n       * (non-normalized) keys — so you read `fields.baseUrl` directly.\n       * Values are arbitrary JSON (metadata only, never secrets); narrow\n       * each before use, e.g. `typeof fields.baseUrl === \"string\"`.\n       */\n      readonly fields: Record<string, unknown>;\n    };\n  }\n\n  export function defineHealthCheck<\n    T extends\n      | HealthCheckScriptResult\n      | ((ctx: HealthCheckScriptContext) =>\n          | HealthCheckScriptResult\n          | Promise<HealthCheckScriptResult>),\n  >(value: T): T;\n  export type { HealthCheckScriptResult, HealthCheckScriptContext };\n}\n\ndeclare module \"@checkstack/sdk/integration\" {\n  /** Result emitted by an inline integration script. */\n  interface IntegrationScriptResult {\n    /** External ID for tracking (e.g. ticket number, message ID). */\n    id?: string;\n    /** Same as `id` — accepted for backwards compatibility. */\n    externalId?: string;\n  }\n\n  /**\n   * Runtime context exposed to inline integration scripts. `event.payload`\n   * is typed from the event's payload schema so the fields it advertises\n   * are autocompletable inside the script.\n   */\n  interface IntegrationScriptContext {\n    /** The event being delivered. */\n    readonly event: {\n      /** Fully-qualified event ID, e.g. \"incident.created\". */\n      readonly eventId: string;\n      /** Strongly-typed event payload. */\n      readonly payload: Record<string, unknown>;\n      /** ISO-8601 timestamp of when the event was emitted. */\n      readonly timestamp: string;\n      /** Unique ID for this delivery attempt. */\n      readonly deliveryId: string;\n    };\n    /** Subscription that triggered this delivery. */\n    readonly subscription: {\n      readonly id: string;\n      readonly name: string;\n    };\n  }\n\n  export function defineIntegration<\n    T extends\n      | IntegrationScriptResult\n      | void\n      | ((ctx: IntegrationScriptContext) =>\n          | IntegrationScriptResult\n          | void\n          | Promise<IntegrationScriptResult | void>),\n  >(value: T): T;\n  export type { IntegrationScriptResult, IntegrationScriptContext };\n}\n\ndeclare module \"@checkstack/sdk\" {\n  export { defineHealthCheck } from \"@checkstack/sdk/healthcheck\";\n  export type { HealthCheckScriptResult, HealthCheckScriptContext } from \"@checkstack/sdk/healthcheck\";\n  export { defineIntegration } from \"@checkstack/sdk/integration\";\n  export type { IntegrationScriptResult, IntegrationScriptContext } from \"@checkstack/sdk/integration\";\n  export interface CreateCheckstackClientOptions {\n    baseUrl: string;\n    headers?: Record<string, string>;\n  }\n  /** The fully-typed Checkstack API client (one entry per plugin id). */\n  export type CheckstackClient = Record<string, unknown>;\n  /** Build a typed Checkstack client over the REST/OpenAPI surface. */\n  export function createCheckstackClient(\n    options: CreateCheckstackClientOptions,\n  ): CheckstackClient;\n}\n";
 
 export { SDK_RELEASE_VERSION } from "./version.ts";

package/src/healthcheck.ts

@@ -35,6 +35,13 @@ interface HealthCheckScriptContext {
     readonly id: string;
     /** The system's display name (falls back to the id). */
     readonly name: string;
+    /**
+     * The system's free-form custom fields, with the original
+     * (non-normalized) keys — so you read `metadata.baseUrl` directly.
+     * Values are arbitrary JSON (metadata only, never secrets); narrow
+     * each before use, e.g. `typeof metadata.baseUrl === "string"`.
+     */
+    readonly metadata: Record<string, unknown>;
   };
   /**
    * The environment this run resolved to, when the check fanned out into

package/src/version.ts

@@ -3,4 +3,4 @@
 // script-context helper builders.
 
 /** The platform release version this SDK was stamped to. */
-export const SDK_RELEASE_VERSION = "0.129.0";
+export const SDK_RELEASE_VERSION = "0.131.0";