@ifsoul/core 0.3.0 → 0.5.0

package/dist/packages/runtime/src/participants.d.ts

@@ -0,0 +1,107 @@
+import type { BehaviorOperatorPolicy } from "./behavior-types.js";
+import type { BehaviorState } from "./behavior-types.js";
+import type { PlanningState } from "./group-scheduler.js";
+/** Trusted session domain. Roots authenticate callers before constructing this access. */
+export interface SessionAccess {
+    principalId: string;
+    hostId: string;
+}
+export interface SessionParticipant {
+    participantId: string;
+    kind: "npc" | "player";
+    /** Trusted host subject, never a display name or imported character identifier. */
+    subjectId: string;
+}
+export interface SessionMember {
+    participantId: string;
+    role: "npc" | "player";
+    embodimentId?: string;
+}
+export interface ParticipantSession {
+    sessionId: string;
+    revision: number;
+    hostId: string;
+    worldId: string;
+    recallWorldIds: string[];
+    members: SessionMember[];
+    groups: {
+        groupId: string;
+        participantIds: string[];
+    }[];
+    channels: {
+        channelId: string;
+        participantIds: string[];
+    }[];
+}
+export interface AddressedEvent {
+    eventId: string;
+    sessionId: string;
+    revision: number;
+    channelId: string;
+    senderId: string;
+    recipientIds: string[];
+    observerIds: string[];
+    text: string;
+}
+export interface SessionTurn {
+    turnId: string;
+    sessionId: string;
+    revision: number;
+    npcId: string;
+    eventId: string;
+    recipientIds: string[];
+    observerIds: string[];
+}
+export interface ParticipantState {
+    format: "ifsoul-participants/0.4.0";
+    planning?: PlanningState;
+    behavior?: BehaviorState;
+    participants: SessionParticipant[];
+    sessions: ParticipantSession[];
+    events: AddressedEvent[];
+    transitions: {
+        transitionId: string;
+        session: ParticipantSession;
+    }[];
+    turns: {
+        ticket: SessionTurn;
+        output?: AddressedEvent;
+        cancelled?: boolean;
+        behaviorRevision?: number;
+    }[];
+}
+/** Must atomically commit the draft only when work succeeds; namespace by verified principal. */
+export interface ParticipantStore {
+    transact<T>(principalId: string, work: (state: ParticipantState) => T): T;
+}
+export declare const emptyParticipantState: () => ParticipantState;
+export declare class SessionError extends Error {
+    readonly code: "unauthorized" | "invalid" | "stale" | "conflict" | "busy" | "limit";
+    constructor(code: "unauthorized" | "invalid" | "stale" | "conflict" | "busy" | "limit");
+}
+/** No account system, model, transport or host mechanics are constructed here. */
+export declare function createParticipantRuntime(store: ParticipantStore, options?: {
+    behaviorOperator?: BehaviorOperatorPolicy;
+}): {
+    /** Only trusted verified host mappings may call this; imported IDs never register themselves. */
+    register(access: SessionAccess, participant: SessionParticipant): SessionParticipant;
+    /** Full explicit replacement is a trusted transition, including leave/join/group/channel/host handoff. */
+    transition(access: SessionAccess, transitionId: string, expectedRevision: number, next: ParticipantSession): ParticipantSession;
+    append(access: SessionAccess, event: AddressedEvent): AddressedEvent;
+    /** Owner-private history; never use a group log as a model context. */
+    history(access: SessionAccess, sessionId: string, participantId: string): AddressedEvent[];
+    /** Source-grounded relationship evidence, keyed by verified persistent player ID. */
+    relationshipEvidence(access: SessionAccess, sessionId: string, npcId: string, playerId: string): {
+        npcId: string;
+        playerId: string;
+        events: AddressedEvent[];
+    };
+    begin(access: SessionAccess, ticket: SessionTurn): {
+        ticket: SessionTurn;
+        trigger: AddressedEvent;
+        output: AddressedEvent | undefined;
+        memories: AddressedEvent[];
+    };
+    cancel(access: SessionAccess, ticket: SessionTurn): undefined;
+    complete(access: SessionAccess, ticket: SessionTurn, output: AddressedEvent): AddressedEvent;
+};

package/dist/packages/runtime/src/participants.js

@@ -0,0 +1,309 @@
+import { behaviorPermissions, behaviorRevision, behaviorEvidenceVisible, } from "./behavior.js";
+export const emptyParticipantState = () => ({
+    format: "ifsoul-participants/0.4.0",
+    participants: [],
+    sessions: [],
+    events: [],
+    transitions: [],
+    turns: [],
+});
+export class SessionError extends Error {
+    code;
+    constructor(code) {
+        super(`Session operation rejected: ${code}`);
+        this.code = code;
+    }
+}
+const fail = (code) => {
+    throw new SessionError(code);
+};
+const id = (x) => typeof x === "string" && /^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$/.test(x);
+const ids = (x) => Array.isArray(x) &&
+    x.length <= 64 &&
+    x.every(id) &&
+    new Set(x).size === x.length;
+const equal = (a, b) => JSON.stringify(a) === JSON.stringify(b);
+const audience = (e) => [
+    e.senderId,
+    ...e.recipientIds,
+    ...e.observerIds,
+];
+/** No account system, model, transport or host mechanics are constructed here. */
+export function createParticipantRuntime(store, options = {}) {
+    const behaviorOperator = options.behaviorOperator
+        ? structuredClone(options.behaviorOperator)
+        : undefined;
+    const run = (access, work) => {
+        if (!access || !id(access.principalId) || !id(access.hostId))
+            fail("unauthorized");
+        return store.transact(access.principalId, (state) => {
+            if (state.format !== "ifsoul-participants/0.4.0")
+                fail("invalid");
+            return structuredClone(work(state));
+        });
+    };
+    const session = (s, a, sessionId, revision) => {
+        const found = s.sessions.find((x) => x.sessionId === sessionId);
+        if (!found || found.hostId !== a.hostId)
+            return fail("unauthorized");
+        if (revision !== undefined && found.revision !== revision)
+            fail("stale");
+        return found;
+    };
+    const eventValid = (s, a, e) => {
+        if (!e ||
+            !id(e.eventId) ||
+            !id(e.senderId) ||
+            !id(e.channelId) ||
+            !ids(e.recipientIds) ||
+            !ids(e.observerIds) ||
+            typeof e.text !== "string" ||
+            !e.text.length ||
+            e.text.length > 4096)
+            fail("invalid");
+        const current = session(s, a, e.sessionId, e.revision);
+        const channel = current.channels.find((x) => x.channelId === e.channelId);
+        if (!channel ||
+            audience(e).some((p) => !channel.participantIds.includes(p) ||
+                !current.members.some((m) => m.participantId === p)))
+            fail("unauthorized");
+        return current;
+    };
+    return {
+        /** Only trusted verified host mappings may call this; imported IDs never register themselves. */
+        register(access, participant) {
+            return run(access, (s) => {
+                if (!participant ||
+                    !id(participant.participantId) ||
+                    !id(participant.subjectId) ||
+                    !["npc", "player"].includes(participant.kind))
+                    fail("invalid");
+                const previous = s.participants.find((p) => p.participantId === participant.participantId ||
+                    (p.subjectId === participant.subjectId &&
+                        p.kind === participant.kind));
+                if (previous && !equal(previous, participant))
+                    fail("conflict");
+                if (!previous) {
+                    if (s.participants.length >= 256)
+                        fail("limit");
+                    s.participants.push(structuredClone(participant));
+                }
+                return participant;
+            });
+        },
+        /** Full explicit replacement is a trusted transition, including leave/join/group/channel/host handoff. */
+        transition(access, transitionId, expectedRevision, next) {
+            return run(access, (s) => {
+                if (!id(transitionId) ||
+                    !next ||
+                    !id(next.sessionId) ||
+                    !id(next.hostId) ||
+                    !id(next.worldId) ||
+                    !ids(next.recallWorldIds) ||
+                    !next.recallWorldIds.includes(next.worldId) ||
+                    !Number.isSafeInteger(expectedRevision) ||
+                    expectedRevision < 0 ||
+                    next.revision !== expectedRevision + 1)
+                    fail("invalid");
+                const old = s.sessions.find((x) => x.sessionId === next.sessionId);
+                if ((old && old.hostId !== access.hostId) ||
+                    (!old && next.hostId !== access.hostId))
+                    fail("unauthorized");
+                const receipt = s.transitions.find((x) => x.transitionId === transitionId);
+                if (receipt) {
+                    if (!equal(receipt.session, next))
+                        fail("conflict");
+                    return receipt.session;
+                }
+                if ((old?.revision ?? 0) !== expectedRevision)
+                    fail("stale");
+                if (old && old.worldId !== next.worldId)
+                    fail("conflict");
+                if (!Array.isArray(next.members) ||
+                    next.members.length > 64 ||
+                    !ids(next.members.map((m) => m.participantId)) ||
+                    next.members.some((m) => !s.participants.some((p) => p.participantId === m.participantId && p.kind === m.role) ||
+                        (m.embodimentId !== undefined && !id(m.embodimentId))))
+                    fail("invalid");
+                for (const [list, key] of [
+                    [next.groups, "groupId"],
+                    [next.channels, "channelId"],
+                ]) {
+                    if (!Array.isArray(list) ||
+                        list.length > 64 ||
+                        !ids(list.map((x) => x[key])))
+                        fail("invalid");
+                    if (list.some((x) => !ids(x.participantIds) ||
+                        x.participantIds.some((p) => !next.members.some((m) => m.participantId === p))))
+                        fail("unauthorized");
+                }
+                if (s.transitions.length >= 2048 || (!old && s.sessions.length >= 128))
+                    fail("limit");
+                if (old)
+                    s.sessions[s.sessions.indexOf(old)] = structuredClone(next);
+                else
+                    s.sessions.push(structuredClone(next));
+                s.transitions.push({ transitionId, session: structuredClone(next) });
+                return next;
+            });
+        },
+        append(access, event) {
+            return run(access, (s) => {
+                eventValid(s, access, event);
+                const prior = s.events.find((e) => e.eventId === event.eventId);
+                if (prior) {
+                    if (!equal(prior, event))
+                        fail("conflict");
+                    return prior;
+                }
+                if (s.events.length >= 2048)
+                    fail("limit");
+                s.events.push(structuredClone(event));
+                return event;
+            });
+        },
+        /** Owner-private history; never use a group log as a model context. */
+        history(access, sessionId, participantId) {
+            return run(access, (s) => {
+                const current = session(s, access, sessionId);
+                if (!current.members.some((m) => m.participantId === participantId))
+                    fail("unauthorized");
+                return s.events.filter((e) => e.sessionId === sessionId &&
+                    audience(e).includes(participantId) &&
+                    (current.members.find((m) => m.participantId === participantId)
+                        ?.role !== "npc" ||
+                        behaviorEvidenceVisible(s, access, participantId, sessionId, e.eventId)));
+            });
+        },
+        /** Source-grounded relationship evidence, keyed by verified persistent player ID. */
+        relationshipEvidence(access, sessionId, npcId, playerId) {
+            return run(access, (s) => {
+                const current = session(s, access, sessionId);
+                if (!current.members.some((m) => m.participantId === npcId && m.role === "npc") ||
+                    !s.participants.some((p) => p.participantId === playerId && p.kind === "player"))
+                    return fail("unauthorized");
+                return {
+                    npcId,
+                    playerId,
+                    events: s.events.filter((e) => audience(e).includes(npcId) &&
+                        audience(e).includes(playerId) &&
+                        s.sessions.some((source) => source.sessionId === e.sessionId &&
+                            source.hostId === access.hostId &&
+                            current.recallWorldIds.includes(source.worldId))),
+                };
+            });
+        },
+        begin(access, ticket) {
+            return run(access, (s) => {
+                if (!ticket ||
+                    !id(ticket.turnId) ||
+                    !id(ticket.npcId) ||
+                    !ids(ticket.recipientIds) ||
+                    !ids(ticket.observerIds))
+                    fail("invalid");
+                const current = session(s, access, ticket.sessionId, ticket.revision);
+                if (!current.members.some((m) => m.participantId === ticket.npcId && m.role === "npc"))
+                    fail("unauthorized");
+                const trigger = s.events.find((e) => e.eventId === ticket.eventId &&
+                    e.sessionId === ticket.sessionId &&
+                    e.revision === ticket.revision);
+                if (!trigger ||
+                    !audience(trigger).includes(ticket.npcId) ||
+                    [...ticket.recipientIds, ...ticket.observerIds].some((p) => !audience(trigger).includes(p)))
+                    return fail("unauthorized");
+                const policy = behaviorPermissions(s, access, ticket.npcId, ticket.sessionId, ticket.eventId, behaviorOperator);
+                if (!policy.observe ||
+                    !policy.speak ||
+                    (s.behavior &&
+                        !s.behavior.observations.some((o) => o.npcId === ticket.npcId &&
+                            o.eventId === ticket.eventId &&
+                            o.permissions.observe)))
+                    return fail("unauthorized");
+                const replay = s.turns.find((t) => t.ticket.turnId === ticket.turnId);
+                if (replay) {
+                    if (!equal(replay.ticket, ticket) || !replay.output)
+                        return fail("conflict");
+                    return {
+                        ticket,
+                        trigger,
+                        memories: [],
+                        output: replay.output,
+                    };
+                }
+                if (s.turns.some((t) => t.ticket.npcId === ticket.npcId &&
+                    !t.output &&
+                    !t.cancelled &&
+                    s.sessions.some((x) => x.sessionId === t.ticket.sessionId &&
+                        x.revision === t.ticket.revision)))
+                    fail("busy");
+                if (s.turns.length >= 2048)
+                    fail("limit");
+                s.turns.push({
+                    ticket: structuredClone(ticket),
+                    behaviorRevision: behaviorRevision(s),
+                });
+                // Recall is NPC-private, with stable player identity across worlds. Sharing is checked at completion.
+                const memories = s.events
+                    .filter((e) => s.sessions.some((source) => source.sessionId === e.sessionId &&
+                    source.hostId === access.hostId &&
+                    current.recallWorldIds.includes(source.worldId)) &&
+                    behaviorEvidenceVisible(s, access, ticket.npcId, ticket.sessionId, e.eventId) &&
+                    [
+                        ticket.npcId,
+                        ...ticket.recipientIds,
+                        ...ticket.observerIds,
+                    ].every((p) => audience(e).includes(p)))
+                    .slice(-64);
+                if (new TextEncoder().encode(JSON.stringify({ ticket, trigger, memories })).length > 65536)
+                    return fail("limit");
+                return {
+                    ticket,
+                    trigger,
+                    output: undefined,
+                    memories,
+                };
+            });
+        },
+        cancel(access, ticket) {
+            return run(access, (s) => {
+                session(s, access, ticket.sessionId, ticket.revision);
+                const pending = s.turns.find((t) => t.ticket.turnId === ticket.turnId);
+                if (!pending || !equal(pending.ticket, ticket) || pending.output)
+                    return fail("conflict");
+                pending.cancelled = true;
+            });
+        },
+        complete(access, ticket, output) {
+            return run(access, (s) => {
+                const pending = s.turns.find((t) => t.ticket.turnId === ticket.turnId);
+                if (!pending || pending.cancelled || !equal(pending.ticket, ticket))
+                    return fail("unauthorized");
+                session(s, access, ticket.sessionId, ticket.revision);
+                if ((pending.behaviorRevision ?? 0) !== behaviorRevision(s) ||
+                    !behaviorPermissions(s, access, ticket.npcId, ticket.sessionId, ticket.eventId, behaviorOperator).speak)
+                    return fail("stale");
+                if (pending.output) {
+                    if (!equal(pending.output, output))
+                        fail("conflict");
+                    return pending.output;
+                }
+                eventValid(s, access, output);
+                if (output.sessionId !== ticket.sessionId ||
+                    output.revision !== ticket.revision ||
+                    output.senderId !== ticket.npcId ||
+                    output.channelId !==
+                        s.events.find((e) => e.eventId === ticket.eventId)?.channelId ||
+                    !equal(output.recipientIds, ticket.recipientIds) ||
+                    !equal(output.observerIds, ticket.observerIds))
+                    fail("unauthorized");
+                if (s.events.some((e) => e.eventId === output.eventId))
+                    fail("conflict");
+                if (s.events.length >= 2048)
+                    fail("limit");
+                s.events.push(structuredClone(output));
+                pending.output = structuredClone(output);
+                return output;
+            });
+        },
+    };
+}

package/dist/packages/runtime/src/types.d.ts

@@ -18,6 +18,7 @@ export interface TrustedSession {
     access: TrustedAccess;
 }
 export interface ControllerInput {
+    behavior?: Pick<import("./behavior-types.js").BehaviorInspection, "configRevision" | "effective" | "parameters" | "values">;
     portrayal?: {
         characterId: string;
         name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ifsoul/core",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "private": false,
   "type": "module",
   "description": "Experimental public IfSoul protocol, runtime, memory and provider primitives",
@@ -22,8 +22,7 @@
     "LICENSE",
     "LICENSES/CC-BY-4.0.txt",
     "LICENSES/CC0-1.0.txt",
-    "release.json",
-    "docs/npm-publishing.md"
+    "release.json"
   ],
   "sideEffects": false,
   "exports": {

package/packages/protocol/schemas/current/archive.schema.json

@@ -1,25 +1,25 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "urn:ifsoul:protocol:0.3.0:archive",
+  "$id": "urn:ifsoul:protocol:0.4.0:archive",
   "type": "object",
   "properties": {
     "schemaVersion": {
-      "const": "0.3.0"
+      "const": "0.4.0"
     },
     "kind": {
       "const": "archive-manifest"
     },
     "archiveVersion": {
-      "const": "0.3.0"
+      "const": "0.4.0"
     },
     "archiveId": {
-      "$ref": "urn:ifsoul:protocol:0.3.0:common#/$defs/id"
+      "$ref": "urn:ifsoul:protocol:0.4.0:common#/$defs/id"
     },
     "characterId": {
-      "$ref": "urn:ifsoul:protocol:0.3.0:common#/$defs/id"
+      "$ref": "urn:ifsoul:protocol:0.4.0:common#/$defs/id"
     },
     "createdAt": {
-      "$ref": "urn:ifsoul:protocol:0.3.0:common#/$defs/utc"
+      "$ref": "urn:ifsoul:protocol:0.4.0:common#/$defs/utc"
     },
     "transferIntent": {
       "oneOf": [
@@ -30,7 +30,7 @@
               "const": "resume"
             },
             "expectedCharacterId": {
-              "$ref": "urn:ifsoul:protocol:0.3.0:common#/$defs/id"
+              "$ref": "urn:ifsoul:protocol:0.4.0:common#/$defs/id"
             }
           },
           "required": ["mode", "expectedCharacterId"],
@@ -43,10 +43,10 @@
               "const": "fork"
             },
             "newCharacterId": {
-              "$ref": "urn:ifsoul:protocol:0.3.0:common#/$defs/id"
+              "$ref": "urn:ifsoul:protocol:0.4.0:common#/$defs/id"
             },
             "newParticipantId": {
-              "$ref": "urn:ifsoul:protocol:0.3.0:common#/$defs/id"
+              "$ref": "urn:ifsoul:protocol:0.4.0:common#/$defs/id"
             }
           },
           "required": ["mode", "newCharacterId", "newParticipantId"],
@@ -61,10 +61,10 @@
         "properties": {
           "schemaId": {
             "type": "string",
-            "pattern": "^urn:ifsoul:protocol:0[.]3[.]0:(character|memory)$"
+            "pattern": "^urn:ifsoul:protocol:0[.]4[.]0:(character|memory)$"
           },
           "schemaVersion": {
-            "const": "0.3.0"
+            "const": "0.4.0"
           }
         },
         "required": ["schemaId", "schemaVersion"],
@@ -88,7 +88,7 @@
           },
           "schemaId": {
             "type": "string",
-            "pattern": "^urn:ifsoul:protocol:0[.]3[.]0:(character|memory)$"
+            "pattern": "^urn:ifsoul:protocol:0[.]4[.]0:(character|memory)$"
           },
           "recordCount": {
             "type": "integer",
@@ -164,23 +164,23 @@
       "additionalProperties": false
     },
     "provenance": {
-      "$ref": "urn:ifsoul:protocol:0.3.0:common#/$defs/provenance"
+      "$ref": "urn:ifsoul:protocol:0.4.0:common#/$defs/provenance"
     },
     "portableCheckpointIds": {
       "type": "array",
       "items": {
-        "$ref": "urn:ifsoul:protocol:0.3.0:common#/$defs/id"
+        "$ref": "urn:ifsoul:protocol:0.4.0:common#/$defs/id"
       },
       "minItems": 0,
       "uniqueItems": true
     },
     "extensions": {
-      "$ref": "urn:ifsoul:protocol:0.3.0:common#/$defs/extensions"
+      "$ref": "urn:ifsoul:protocol:0.4.0:common#/$defs/extensions"
     },
     "requiredExtensions": {
       "type": "array",
       "items": {
-        "$ref": "urn:ifsoul:protocol:0.3.0:common#/$defs/extensionName"
+        "$ref": "urn:ifsoul:protocol:0.4.0:common#/$defs/extensionName"
       },
       "minItems": 0,
       "maxItems": 16,