@glasstrace/sdk 1.3.8 → 1.4.0

package/dist/{index.d-Bo_Rxund.d.cts → index.d-Dq33YwFT.d.cts}

@@ -42,6 +42,7 @@ declare const CaptureConfigSchema: z.ZodObject<{
     importGraph: z.ZodBoolean;
     consoleErrors: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     errorResponseBodies: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    sideEffectEvidence: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
 }, z.core.$strip>;
 type CaptureConfig = z.infer<typeof CaptureConfigSchema>;
 /** Developer-facing config for registerGlasstrace(). */
@@ -110,6 +111,7 @@ declare const SdkInitResponseSchema: z.ZodObject<{
         importGraph: z.ZodBoolean;
         consoleErrors: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
         errorResponseBodies: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        sideEffectEvidence: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     }, z.core.$strip>;
     subscriptionStatus: z.ZodString;
     linkedAccountId: z.ZodOptional<z.ZodString>;
@@ -191,4 +193,92 @@ type SourceMapManifestResponse = z.infer<typeof SourceMapManifestResponseSchema>
  */
 declare function deriveSessionId(apiKey: string, origin: string, date: string, windowIndex: number): SessionId;
 
-export { type AnonApiKey as A, type CaptureConfig as C, type GlasstraceEnvVars as G, type ImportGraphPayload as I, type SdkInitResponse as S, type GlasstraceOptions as a, type SdkHealthReport as b, type SdkDiagnosticCode as c, deriveSessionId as d, type SessionId as e, type SourceMapUploadResponse as f, type SourceMapManifestResponse as g };
+/**
+ * Side-effect evidence value-enum constants.
+ *
+ * The runtime `as const` tuples are the source of truth for the
+ * allowlisted value sets. TypeScript types are derived via
+ * `typeof T[number]` so consumers get a literal-type union without a
+ * separate string-literal-union declaration that could silently drift
+ * from the runtime allowlist.
+ *
+ * These tuples align verbatim with the product-side wire schema in
+ * `glasstrace-product/shared/types/agent-evidence.ts`. Members must
+ * remain in sync across both repos; the SDK enforces these allowlists
+ * client-side as defense-in-depth before any attribute reaches the
+ * wire (the product's storage filter is a second defense, not the
+ * primary boundary).
+ *
+ * @drift-check ../../glasstrace-product/docs/component-designs/side-effect-evidence-summaries.md
+ */
+/**
+ * Allowlisted side-effect operation kinds (v1).
+ *
+ * Each kind names a category of side effect the receiver projects in
+ * MCP tool responses. New kinds require a coordinated bump across
+ * SCHEMA-036 (product), this tuple (SDK), and any downstream consumer
+ * that switches on the kind.
+ */
+declare const SIDE_EFFECT_OPERATION_KINDS: readonly ["email", "calendar_link", "webhook", "external_api", "queue", "after_callback"];
+/**
+ * One of the allowlisted side-effect operation kinds.
+ *
+ * @see {@link SIDE_EFFECT_OPERATION_KINDS}
+ */
+type SideEffectOperationKind = (typeof SIDE_EFFECT_OPERATION_KINDS)[number];
+/**
+ * Allowlisted semantic field keys for `recordSideEffect()` evidence.
+ *
+ * Only fields named here may be attached to a side-effect operation
+ * summary. Any other key is silently dropped at the SDK boundary and
+ * counted under the `unsupported_key` omission reason.
+ */
+declare const SIDE_EFFECT_SEMANTIC_FIELD_KEYS: readonly ["templateKey", "providerOperation", "role", "locale", "timezone", "status", "phase"];
+/**
+ * One of the allowlisted side-effect semantic field keys.
+ *
+ * @see {@link SIDE_EFFECT_SEMANTIC_FIELD_KEYS}
+ */
+type SideEffectSemanticFieldKey = (typeof SIDE_EFFECT_SEMANTIC_FIELD_KEYS)[number];
+/**
+ * Allowlisted reasons a side-effect value may be omitted from the
+ * emitted summary.
+ *
+ * The SDK records counts under these reasons rather than the rejected
+ * values themselves so unsafe input never appears anywhere on the
+ * wire. The set is fixed by SCHEMA-036; new reasons require a
+ * coordinated cross-repo bump.
+ */
+declare const SIDE_EFFECT_OMISSION_REASONS: readonly ["pii", "secret", "raw_payload", "unsupported_key", "value_too_long", "not_emitted", "capture_disabled"];
+/**
+ * One of the allowlisted side-effect omission reasons.
+ *
+ * @see {@link SIDE_EFFECT_OMISSION_REASONS}
+ */
+type SideEffectOmissionReason = (typeof SIDE_EFFECT_OMISSION_REASONS)[number];
+/**
+ * Allowlisted side-effect operation lifecycle statuses.
+ */
+declare const SIDE_EFFECT_OPERATION_STATUSES: readonly ["scheduled", "started", "succeeded", "failed", "unknown"];
+/**
+ * One of the allowlisted side-effect operation statuses.
+ *
+ * @see {@link SIDE_EFFECT_OPERATION_STATUSES}
+ */
+type SideEffectOperationStatus = (typeof SIDE_EFFECT_OPERATION_STATUSES)[number];
+/**
+ * Allowlisted side-effect operation execution phases.
+ *
+ * Distinguishes side effects that ran inside the request handler from
+ * those that ran after the response was sent (e.g., `after()` hook,
+ * background job).
+ */
+declare const SIDE_EFFECT_OPERATION_PHASES: readonly ["request", "post_response", "background", "unknown"];
+/**
+ * One of the allowlisted side-effect operation phases.
+ *
+ * @see {@link SIDE_EFFECT_OPERATION_PHASES}
+ */
+type SideEffectOperationPhase = (typeof SIDE_EFFECT_OPERATION_PHASES)[number];
+
+export { type AnonApiKey as A, type CaptureConfig as C, type GlasstraceEnvVars as G, type ImportGraphPayload as I, type SideEffectOperationKind as S, type SideEffectOperationStatus as a, type SideEffectOperationPhase as b, type SideEffectSemanticFieldKey as c, deriveSessionId as d, type SideEffectOmissionReason as e, type GlasstraceOptions as f, type SdkInitResponse as g, type SdkHealthReport as h, type SdkDiagnosticCode as i, type SessionId as j, type SourceMapUploadResponse as k, type SourceMapManifestResponse as l };

package/dist/{index.d-Bo_Rxund.d.ts → index.d-Dq33YwFT.d.ts}

@@ -42,6 +42,7 @@ declare const CaptureConfigSchema: z.ZodObject<{
     importGraph: z.ZodBoolean;
     consoleErrors: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     errorResponseBodies: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    sideEffectEvidence: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
 }, z.core.$strip>;
 type CaptureConfig = z.infer<typeof CaptureConfigSchema>;
 /** Developer-facing config for registerGlasstrace(). */
@@ -110,6 +111,7 @@ declare const SdkInitResponseSchema: z.ZodObject<{
         importGraph: z.ZodBoolean;
         consoleErrors: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
         errorResponseBodies: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        sideEffectEvidence: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     }, z.core.$strip>;
     subscriptionStatus: z.ZodString;
     linkedAccountId: z.ZodOptional<z.ZodString>;
@@ -191,4 +193,92 @@ type SourceMapManifestResponse = z.infer<typeof SourceMapManifestResponseSchema>
  */
 declare function deriveSessionId(apiKey: string, origin: string, date: string, windowIndex: number): SessionId;
 
-export { type AnonApiKey as A, type CaptureConfig as C, type GlasstraceEnvVars as G, type ImportGraphPayload as I, type SdkInitResponse as S, type GlasstraceOptions as a, type SdkHealthReport as b, type SdkDiagnosticCode as c, deriveSessionId as d, type SessionId as e, type SourceMapUploadResponse as f, type SourceMapManifestResponse as g };
+/**
+ * Side-effect evidence value-enum constants.
+ *
+ * The runtime `as const` tuples are the source of truth for the
+ * allowlisted value sets. TypeScript types are derived via
+ * `typeof T[number]` so consumers get a literal-type union without a
+ * separate string-literal-union declaration that could silently drift
+ * from the runtime allowlist.
+ *
+ * These tuples align verbatim with the product-side wire schema in
+ * `glasstrace-product/shared/types/agent-evidence.ts`. Members must
+ * remain in sync across both repos; the SDK enforces these allowlists
+ * client-side as defense-in-depth before any attribute reaches the
+ * wire (the product's storage filter is a second defense, not the
+ * primary boundary).
+ *
+ * @drift-check ../../glasstrace-product/docs/component-designs/side-effect-evidence-summaries.md
+ */
+/**
+ * Allowlisted side-effect operation kinds (v1).
+ *
+ * Each kind names a category of side effect the receiver projects in
+ * MCP tool responses. New kinds require a coordinated bump across
+ * SCHEMA-036 (product), this tuple (SDK), and any downstream consumer
+ * that switches on the kind.
+ */
+declare const SIDE_EFFECT_OPERATION_KINDS: readonly ["email", "calendar_link", "webhook", "external_api", "queue", "after_callback"];
+/**
+ * One of the allowlisted side-effect operation kinds.
+ *
+ * @see {@link SIDE_EFFECT_OPERATION_KINDS}
+ */
+type SideEffectOperationKind = (typeof SIDE_EFFECT_OPERATION_KINDS)[number];
+/**
+ * Allowlisted semantic field keys for `recordSideEffect()` evidence.
+ *
+ * Only fields named here may be attached to a side-effect operation
+ * summary. Any other key is silently dropped at the SDK boundary and
+ * counted under the `unsupported_key` omission reason.
+ */
+declare const SIDE_EFFECT_SEMANTIC_FIELD_KEYS: readonly ["templateKey", "providerOperation", "role", "locale", "timezone", "status", "phase"];
+/**
+ * One of the allowlisted side-effect semantic field keys.
+ *
+ * @see {@link SIDE_EFFECT_SEMANTIC_FIELD_KEYS}
+ */
+type SideEffectSemanticFieldKey = (typeof SIDE_EFFECT_SEMANTIC_FIELD_KEYS)[number];
+/**
+ * Allowlisted reasons a side-effect value may be omitted from the
+ * emitted summary.
+ *
+ * The SDK records counts under these reasons rather than the rejected
+ * values themselves so unsafe input never appears anywhere on the
+ * wire. The set is fixed by SCHEMA-036; new reasons require a
+ * coordinated cross-repo bump.
+ */
+declare const SIDE_EFFECT_OMISSION_REASONS: readonly ["pii", "secret", "raw_payload", "unsupported_key", "value_too_long", "not_emitted", "capture_disabled"];
+/**
+ * One of the allowlisted side-effect omission reasons.
+ *
+ * @see {@link SIDE_EFFECT_OMISSION_REASONS}
+ */
+type SideEffectOmissionReason = (typeof SIDE_EFFECT_OMISSION_REASONS)[number];
+/**
+ * Allowlisted side-effect operation lifecycle statuses.
+ */
+declare const SIDE_EFFECT_OPERATION_STATUSES: readonly ["scheduled", "started", "succeeded", "failed", "unknown"];
+/**
+ * One of the allowlisted side-effect operation statuses.
+ *
+ * @see {@link SIDE_EFFECT_OPERATION_STATUSES}
+ */
+type SideEffectOperationStatus = (typeof SIDE_EFFECT_OPERATION_STATUSES)[number];
+/**
+ * Allowlisted side-effect operation execution phases.
+ *
+ * Distinguishes side effects that ran inside the request handler from
+ * those that ran after the response was sent (e.g., `after()` hook,
+ * background job).
+ */
+declare const SIDE_EFFECT_OPERATION_PHASES: readonly ["request", "post_response", "background", "unknown"];
+/**
+ * One of the allowlisted side-effect operation phases.
+ *
+ * @see {@link SIDE_EFFECT_OPERATION_PHASES}
+ */
+type SideEffectOperationPhase = (typeof SIDE_EFFECT_OPERATION_PHASES)[number];
+
+export { type AnonApiKey as A, type CaptureConfig as C, type GlasstraceEnvVars as G, type ImportGraphPayload as I, type SideEffectOperationKind as S, type SideEffectOperationStatus as a, type SideEffectOperationPhase as b, type SideEffectSemanticFieldKey as c, deriveSessionId as d, type SideEffectOmissionReason as e, type GlasstraceOptions as f, type SdkInitResponse as g, type SdkHealthReport as h, type SdkDiagnosticCode as i, type SessionId as j, type SourceMapUploadResponse as k, type SourceMapManifestResponse as l };