@opencode/schema 2.0.32 → 2.1.0

package/dist/session-event.js

@@ -118,6 +118,16 @@ export const Viewed = Event.durable({
         idle: Schema.Finite,
     },
 });
+export const Archived = Event.durable({
+    type: "session.archived",
+    ...options,
+    schema: Base,
+});
+export const Unarchived = Event.durable({
+    type: "session.unarchived",
+    ...options,
+    schema: Base,
+});
 // Replay-only: older releases allowed replacing completed assistant content.
 export const MessageContentUpdated = Event.durable({
     type: "session.message.content.updated",
@@ -302,7 +312,7 @@ export var Step;
             assistantMessageID: SessionMessage.ID,
             finish: FinishReason,
             rawFinish: Schema.String.pipe(optional),
-            providerState: SessionMessage.ProviderState.pipe(optional),
+            native: SessionMessage.Native.pipe(optional),
             cost: Money.USD,
             tokens: TokenUsage.Info,
             snapshot: Snapshot.ID.pipe(optional),
@@ -318,7 +328,7 @@ export var Step;
             error: SessionError.Error,
             finish: Schema.Literals(["content-filter"]).pipe(optional),
             rawFinish: Schema.String.pipe(optional),
-            providerState: SessionMessage.ProviderState.pipe(optional),
+            native: SessionMessage.Native.pipe(optional),
             cost: Money.USD.pipe(optional),
             tokens: TokenUsage.Info.pipe(optional),
             snapshot: Snapshot.ID.pipe(optional),
@@ -355,7 +365,7 @@ export var Text;
             assistantMessageID: SessionMessage.ID,
             ordinal: NonNegativeInt,
             text: Schema.String,
-            state: SessionMessage.ProviderState.pipe(optional),
+            native: SessionMessage.Native.pipe(optional),
         },
     });
 })(Text || (Text = {}));
@@ -368,7 +378,7 @@ export var Reasoning;
             ...Base,
             assistantMessageID: SessionMessage.ID,
             ordinal: NonNegativeInt,
-            state: SessionMessage.ProviderState.pipe(optional),
+            native: SessionMessage.Native.pipe(optional),
         },
     });
     // Stream fragments are live-only; Reasoning.Ended is the replayable full-value boundary.
@@ -389,7 +399,7 @@ export var Reasoning;
             assistantMessageID: SessionMessage.ID,
             ordinal: NonNegativeInt,
             text: Schema.String,
-            state: SessionMessage.ProviderState.pipe(optional),
+            native: SessionMessage.Native.pipe(optional),
         },
     });
 })(Reasoning || (Reasoning = {}));
@@ -434,7 +444,7 @@ export var Tool;
             ...ToolBase,
             input: Schema.Record(Schema.String, Schema.Unknown),
             executed: Schema.Boolean,
-            state: SessionMessage.ProviderState.pipe(optional),
+            native: SessionMessage.Native.pipe(optional),
         },
     });
     /** Live replacement metadata for a running tool. */
@@ -457,7 +467,7 @@ export var Tool;
             content: Schema.NonEmptyArray(Content),
             metadata: Schema.Record(Schema.String, Schema.Json).pipe(optional),
             executed: Schema.Boolean,
-            resultState: SessionMessage.ProviderState.pipe(optional),
+            native: SessionMessage.Native.pipe(optional),
         },
     });
     /**
@@ -477,7 +487,7 @@ export var Tool;
             content: Schema.NonEmptyArray(Content).pipe(optional),
             metadata: Schema.Record(Schema.String, Schema.Json).pipe(optional),
             executed: Schema.Boolean,
-            resultState: SessionMessage.ProviderState.pipe(optional),
+            native: SessionMessage.Native.pipe(optional),
         },
     });
 })(Tool || (Tool = {}));
@@ -500,7 +510,6 @@ export var Compaction;
         schema: {
             ...Base,
             reason: Schema.Literals(["auto", "manual"]),
-            recent: Schema.String,
             inputID: SessionMessage.ID.pipe(optional),
         },
     });
@@ -518,10 +527,8 @@ export var Compaction;
             ...Base,
             reason: Compaction.Started.data.fields.reason,
             model: SessionMessage.CompactionCompleted.fields.model,
-            providerState: SessionMessage.CompactionCompleted.fields.providerState,
-            providerContext: SessionMessage.CompactionCompleted.fields.providerContext,
+            native: SessionMessage.CompactionCompleted.fields.native,
             text: Schema.String,
-            recent: Schema.String,
             // Repeats the internal `session.usage.recorded` figures: that event never reaches clients, and it
             // stays the accounting source for session totals and stats.
             cost: SessionMessage.CompactionCompleted.fields.cost,
@@ -555,7 +562,7 @@ export var RevertEvent;
         schema: { ...Base, to: SessionMessage.ID },
     });
 })(RevertEvent || (RevertEvent = {}));
-export const Definitions = Event.inventory(Created, AgentSelected, ModelSelected, Moved, Renamed, MetadataUpdated, Permissions, Viewed, UsageUpdated, Deleted, Forked, InboxDelivered, InboxEnqueued, InboxCancelled, InboxDeliveryChanged, Execution.Started, Execution.Succeeded, Execution.Failed, Execution.Interrupted, InstructionsUpdated, Synthetic, Skill.Activated, Shell.Started, Shell.Ended, Step.Started, Step.Streamed, Step.Ended, Step.Failed, Text.Started, Text.Delta, Text.Ended, Reasoning.Started, Reasoning.Delta, Reasoning.Ended, Tool.Input.Started, Tool.Input.Delta, Tool.Input.Ended, Tool.Called, Tool.Progress, Tool.Success, Tool.Failed, RetryScheduled, Compaction.Started, Compaction.Delta, Compaction.Ended, Compaction.Failed, RevertEvent.Staged, RevertEvent.Cleared, RevertEvent.Committed);
+export const Definitions = Event.inventory(Created, AgentSelected, ModelSelected, Moved, Renamed, MetadataUpdated, Permissions, Viewed, Archived, Unarchived, UsageUpdated, Deleted, Forked, InboxDelivered, InboxEnqueued, InboxCancelled, InboxDeliveryChanged, Execution.Started, Execution.Succeeded, Execution.Failed, Execution.Interrupted, InstructionsUpdated, Synthetic, Skill.Activated, Shell.Started, Shell.Ended, Step.Started, Step.Streamed, Step.Ended, Step.Failed, Text.Started, Text.Delta, Text.Ended, Reasoning.Started, Reasoning.Delta, Reasoning.Ended, Tool.Input.Started, Tool.Input.Delta, Tool.Input.Ended, Tool.Called, Tool.Progress, Tool.Success, Tool.Failed, RetryScheduled, Compaction.Started, Compaction.Delta, Compaction.Ended, Compaction.Failed, RevertEvent.Staged, RevertEvent.Cleared, RevertEvent.Committed);
 // Internal and replay-only events are excluded from the public manifest.
 export const DurableDefinitions = Event.inventory(...Definitions.filter((definition) => definition.durability === "durable"), UsageRecorded, MessageContentUpdated);
 export const EphemeralDefinitions = Event.inventory(...Definitions.filter((definition) => definition.durability === "ephemeral"));

package/dist/session-inbox.d.ts

@@ -5,7 +5,6 @@ export type Delivery = typeof Delivery.Type;
 export interface UserPayload extends Schema.Schema.Type<typeof UserPayload> {
 }
 export declare const UserPayload: Schema.Struct<{
-    readonly metadata: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Record<Schema.String, Schema.Unknown>>>, Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>, never, never>;
     readonly text: Schema.String;
     readonly files: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Array<Schema.Struct<{
         readonly data: Schema.String;
@@ -30,15 +29,15 @@ export declare const UserPayload: Schema.Struct<{
     }> & {
         create: (input: import("./prompt.js").FileAttachment) => {
             readonly data: string;
+            readonly mime: string;
             readonly source: {
                 readonly type: "inline";
             } | {
                 readonly type: "uri";
                 readonly uri: string;
             };
-            readonly mime: string;
-            readonly description?: string | undefined;
             readonly name?: string | undefined;
+            readonly description?: string | undefined;
             readonly mention?: {
                 readonly start: number;
                 readonly end: number;
@@ -68,15 +67,15 @@ export declare const UserPayload: Schema.Struct<{
     }> & {
         create: (input: import("./prompt.js").FileAttachment) => {
             readonly data: string;
+            readonly mime: string;
             readonly source: {
                 readonly type: "inline";
             } | {
                 readonly type: "uri";
                 readonly uri: string;
             };
-            readonly mime: string;
-            readonly description?: string | undefined;
             readonly name?: string | undefined;
+            readonly description?: string | undefined;
             readonly mention?: {
                 readonly start: number;
                 readonly end: number;
@@ -134,6 +133,7 @@ export declare const UserPayload: Schema.Struct<{
             readonly text: Schema.String;
         }>>, never, never>;
     }>>>, never, never>;
+    readonly metadata: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Record<Schema.String, Schema.Unknown>>>, Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>, never, never>;
 }>;
 export interface SyntheticPayload extends Schema.Schema.Type<typeof SyntheticPayload> {
 }
@@ -166,7 +166,6 @@ export declare const MovePayload: Schema.Struct<{
 export declare const Item: Schema.Union<readonly [Schema.Struct<{
     readonly type: Schema.tag<"user">;
     readonly payload: Schema.Struct<{
-        readonly metadata: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Record<Schema.String, Schema.Unknown>>>, Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>, never, never>;
         readonly text: Schema.String;
         readonly files: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Array<Schema.Struct<{
             readonly data: Schema.String;
@@ -191,15 +190,15 @@ export declare const Item: Schema.Union<readonly [Schema.Struct<{
         }> & {
             create: (input: import("./prompt.js").FileAttachment) => {
                 readonly data: string;
+                readonly mime: string;
                 readonly source: {
                     readonly type: "inline";
                 } | {
                     readonly type: "uri";
                     readonly uri: string;
                 };
-                readonly mime: string;
-                readonly description?: string | undefined;
                 readonly name?: string | undefined;
+                readonly description?: string | undefined;
                 readonly mention?: {
                     readonly start: number;
                     readonly end: number;
@@ -229,15 +228,15 @@ export declare const Item: Schema.Union<readonly [Schema.Struct<{
         }> & {
             create: (input: import("./prompt.js").FileAttachment) => {
                 readonly data: string;
+                readonly mime: string;
                 readonly source: {
                     readonly type: "inline";
                 } | {
                     readonly type: "uri";
                     readonly uri: string;
                 };
-                readonly mime: string;
-                readonly description?: string | undefined;
                 readonly name?: string | undefined;
+                readonly description?: string | undefined;
                 readonly mention?: {
                     readonly start: number;
                     readonly end: number;
@@ -295,6 +294,7 @@ export declare const Item: Schema.Union<readonly [Schema.Struct<{
                 readonly text: Schema.String;
             }>>, never, never>;
         }>>>, never, never>;
+        readonly metadata: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Record<Schema.String, Schema.Unknown>>>, Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>, never, never>;
     }>;
     readonly delivery: Schema.Literals<readonly ["steer", "queue"]>;
 }>, Schema.Struct<{
@@ -335,7 +335,6 @@ export interface User extends Schema.Schema.Type<typeof User> {
 export declare const User: Schema.Struct<{
     readonly type: Schema.tag<"user">;
     readonly payload: Schema.Struct<{
-        readonly metadata: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Record<Schema.String, Schema.Unknown>>>, Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>, never, never>;
         readonly text: Schema.String;
         readonly files: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Array<Schema.Struct<{
             readonly data: Schema.String;
@@ -360,15 +359,15 @@ export declare const User: Schema.Struct<{
         }> & {
             create: (input: import("./prompt.js").FileAttachment) => {
                 readonly data: string;
+                readonly mime: string;
                 readonly source: {
                     readonly type: "inline";
                 } | {
                     readonly type: "uri";
                     readonly uri: string;
                 };
-                readonly mime: string;
-                readonly description?: string | undefined;
                 readonly name?: string | undefined;
+                readonly description?: string | undefined;
                 readonly mention?: {
                     readonly start: number;
                     readonly end: number;
@@ -398,15 +397,15 @@ export declare const User: Schema.Struct<{
         }> & {
             create: (input: import("./prompt.js").FileAttachment) => {
                 readonly data: string;
+                readonly mime: string;
                 readonly source: {
                     readonly type: "inline";
                 } | {
                     readonly type: "uri";
                     readonly uri: string;
                 };
-                readonly mime: string;
-                readonly description?: string | undefined;
                 readonly name?: string | undefined;
+                readonly description?: string | undefined;
                 readonly mention?: {
                     readonly start: number;
                     readonly end: number;
@@ -464,6 +463,7 @@ export declare const User: Schema.Struct<{
                 readonly text: Schema.String;
             }>>, never, never>;
         }>>>, never, never>;
+        readonly metadata: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Record<Schema.String, Schema.Unknown>>>, Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>, never, never>;
     }>;
     readonly delivery: Schema.Literals<readonly ["steer", "queue"]>;
     readonly id: Schema.brand<Schema.String, "Session.Message.ID"> & {
@@ -554,7 +554,6 @@ export declare const Move: Schema.Struct<{
 export declare const Info: Schema.Union<readonly [Schema.Struct<{
     readonly type: Schema.tag<"user">;
     readonly payload: Schema.Struct<{
-        readonly metadata: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Record<Schema.String, Schema.Unknown>>>, Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>, never, never>;
         readonly text: Schema.String;
         readonly files: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Array<Schema.Struct<{
             readonly data: Schema.String;
@@ -579,15 +578,15 @@ export declare const Info: Schema.Union<readonly [Schema.Struct<{
         }> & {
             create: (input: import("./prompt.js").FileAttachment) => {
                 readonly data: string;
+                readonly mime: string;
                 readonly source: {
                     readonly type: "inline";
                 } | {
                     readonly type: "uri";
                     readonly uri: string;
                 };
-                readonly mime: string;
-                readonly description?: string | undefined;
                 readonly name?: string | undefined;
+                readonly description?: string | undefined;
                 readonly mention?: {
                     readonly start: number;
                     readonly end: number;
@@ -617,15 +616,15 @@ export declare const Info: Schema.Union<readonly [Schema.Struct<{
         }> & {
             create: (input: import("./prompt.js").FileAttachment) => {
                 readonly data: string;
+                readonly mime: string;
                 readonly source: {
                     readonly type: "inline";
                 } | {
                     readonly type: "uri";
                     readonly uri: string;
                 };
-                readonly mime: string;
-                readonly description?: string | undefined;
                 readonly name?: string | undefined;
+                readonly description?: string | undefined;
                 readonly mention?: {
                     readonly start: number;
                     readonly end: number;
@@ -683,6 +682,7 @@ export declare const Info: Schema.Union<readonly [Schema.Struct<{
                 readonly text: Schema.String;
             }>>, never, never>;
         }>>>, never, never>;
+        readonly metadata: Schema.decodeTo<Schema.optional<Schema.toType<Schema.$Record<Schema.String, Schema.Unknown>>>, Schema.optionalKey<Schema.$Record<Schema.String, Schema.Unknown>>, never, never>;
     }>;
     readonly delivery: Schema.Literals<readonly ["steer", "queue"]>;
     readonly id: Schema.brand<Schema.String, "Session.Message.ID"> & {

package/dist/session-legacy.d.ts

@@ -0,0 +1,7 @@
+export * as SessionLegacy from "./session-legacy.js";
+/** Upgrades a durable event payload by event type. */
+export declare function event(type: string, data: unknown): unknown;
+/** Upgrades a projected message's data by message type. */
+export declare function message(type: unknown, data: Record<string, unknown>): Record<string, unknown>;
+/** Upgrades complete messages, such as those in an exported session, before decoding. */
+export declare function messages(values: ReadonlyArray<unknown>): unknown[];

package/dist/session-legacy.js

@@ -0,0 +1,118 @@
+export * as SessionLegacy from "./session-legacy.js";
+/**
+ * Storage and wire compatibility for current-architecture data written before v2.1 (not V1 contracts). Native data
+ * was then named `state` or `providerState`, a tool's result native data `resultState` or `providerResultState`,
+ * summary compactions stored the text of the messages they kept in `recent`, and provider compactions stored their
+ * replacement window in `providerContext`. Stored events, projected messages, and exported transcripts keep whichever
+ * shape they were written with, so these upgrade them before decoding.
+ */
+const renames = {
+    "session.text.ended": ["state", "native"],
+    "session.reasoning.started": ["state", "native"],
+    "session.reasoning.ended": ["state", "native"],
+    "session.tool.called": ["state", "native"],
+    "session.step.ended": ["providerState", "native"],
+    "session.step.failed": ["providerState", "native"],
+    "session.tool.success": ["resultState", "native"],
+    "session.tool.failed": ["resultState", "native"],
+};
+/** Upgrades a durable event payload by event type. */
+export function event(type, data) {
+    if (!isRecord(data))
+        return data;
+    if (type === "session.message.content.updated")
+        return content(data);
+    // Messages carry a legacy compaction's kept text; its events have no reader for it.
+    if (type === "session.compaction.started")
+        return omit(data, "recent");
+    if (type === "session.compaction.ended")
+        return providerContext(omit(rename(data, "providerState", "native"), "recent"));
+    const entry = renames[type];
+    return entry ? rename(data, entry[0], entry[1]) : data;
+}
+/** Upgrades a projected message's data by message type. */
+export function message(type, data) {
+    if (type === "assistant")
+        return content(rename(data, "providerState", "native"));
+    if (type === "compaction")
+        return providerContext(recent(rename(data, "providerState", "native")));
+    return data;
+}
+/** Upgrades complete messages, such as those in an exported session, before decoding. */
+export function messages(values) {
+    return values.map((value) => (isRecord(value) ? message(value.type, value) : value));
+}
+function content(data) {
+    if (!Array.isArray(data.content))
+        return data;
+    return { ...data, content: data.content.map(part) };
+}
+function part(value) {
+    if (!isRecord(value))
+        return value;
+    if (value.type === "text" || value.type === "reasoning")
+        return rename(value, "state", "native");
+    // A tool part's own `state` is its lifecycle status, not native data.
+    if (value.type === "tool")
+        return toolResult(rename(value, "providerState", "native"));
+    return value;
+}
+/** Kept text a summary compaction stored before it referenced `metadata.keepID`; replay still reads it. */
+function recent(data) {
+    const text = data.recent;
+    const rest = omit(data, "recent");
+    if (typeof text !== "string" || !text)
+        return rest;
+    const metadata = isRecord(rest.metadata) ? rest.metadata : {};
+    return { ...rest, metadata: { recent: text, ...metadata } };
+}
+/** The window moves to `native.messages`; the `native` stored beside it was never replayed. */
+function providerContext(data) {
+    const context = data.providerContext;
+    const rest = omit(data, "providerContext");
+    if (!isRecord(context))
+        return rest;
+    return {
+        ...rest,
+        native: { messages: Array.isArray(context.messages) ? context.messages.map(media) : context.messages },
+    };
+}
+/** Before 2.0.15, window media parts stored `mediaType` and base64 `data` directly. */
+function media(message) {
+    if (!isRecord(message) || !Array.isArray(message.content))
+        return message;
+    return {
+        ...message,
+        content: message.content.map((part) => {
+            if (!isRecord(part) || part.type !== "media" || part.media !== undefined || typeof part.data !== "string")
+                return part;
+            const { mediaType, data, ...rest } = part;
+            return { ...rest, media: { source: { type: "base64", data, mediaType } } };
+        }),
+    };
+}
+function omit(value, key) {
+    if (!(key in value))
+        return value;
+    const { [key]: _, ...rest } = value;
+    return rest;
+}
+// Result data now merges into the tool's single `native`, as projection does for current result events.
+function toolResult(value) {
+    if (!("providerResultState" in value))
+        return value;
+    const { providerResultState, ...rest } = value;
+    if (!isRecord(providerResultState))
+        return rest;
+    return { ...rest, native: { ...(isRecord(rest.native) ? rest.native : {}), ...providerResultState } };
+}
+// The current name wins when a payload carries both.
+function rename(value, from, to) {
+    if (!(from in value))
+        return value;
+    const { [from]: moved, ...rest } = value;
+    return to in rest ? rest : { ...rest, [to]: moved };
+}
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}