@ibgib/core-gib 0.1.21 → 0.1.23

package/src/sync/sync-saga-context/sync-saga-context-types.mts

@@ -4,28 +4,17 @@
 
 import { IbGibAddr } from '@ibgib/ts-gib/dist/types.mjs';
 import { IbGibData_V1, IbGibRel8ns_V1, IbGib_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs';
-import { SYNC_SAGA_PAYLOAD_ADDRS_REL8N_NAME } from '../sync-constants.mjs';
 
-// #region SyncSagaContextCmd
-/**
- * Commands for the Sync Saga Context.
- */
-export type SyncSagaContextCmd =
-    | 'process'
-    | 'ping';
-export const SyncSagaContextCmd = {
-    process: 'process' as SyncSagaContextCmd,
-    ping: 'ping' as SyncSagaContextCmd,
-} satisfies { [key in SyncSagaContextCmd]: SyncSagaContextCmd };
-export const SYNC_SAGA_CONTEXT_CMD_VALID_VALUES = Object.values(SyncSagaContextCmd);
-export function isValidSyncSagaContextCmd(cmd: string): cmd is SyncSagaContextCmd {
-    return SYNC_SAGA_CONTEXT_CMD_VALID_VALUES.includes(cmd as SyncSagaContextCmd);
-}
-// #endregion SyncSagaContextCmd
+import { SYNC_SAGA_PAYLOAD_ADDRS_DOMAIN } from '../sync-constants.mjs';
+import { SyncIbGib_V1 } from '../sync-types.mjs';
+import { SYNC_SAGA_CONTEXT_ATOM } from './sync-saga-context-constants.mjs';
 
 export interface SyncSagaContextIb_V1 {
-    atom: string; // SYNC_SAGA_CONTEXT_ATOM
-    cmd: SyncSagaContextCmd | string;
+    atom: typeof SYNC_SAGA_CONTEXT_ATOM;
+    /**
+     * simple metadata count of data["@payloadAddrsDomain"]
+     */
+    payloadCount: number;
 }
 
 /**
@@ -33,16 +22,10 @@ export interface SyncSagaContextIb_V1 {
  */
 export interface SyncSagaContextData_V1 extends IbGibData_V1 {
     /**
-     * Contextual command or metadata for the transport layer.
-     * e.g. "process", "ping".
-     */
-    cmd?: SyncSagaContextCmd | string;
-
-    /**
-     * Payload data (ibGibs) being transported in this context (e.g. for Delta stage).
+     * Payload data addresses for DOMAIN ibGibs (Timeline frames, user content).
      * Soft-linked via data property to avoid hard-linking graph dependencies.
      */
-    [SYNC_SAGA_PAYLOAD_ADDRS_REL8N_NAME]?: IbGibAddr[];
+    [SYNC_SAGA_PAYLOAD_ADDRS_DOMAIN]?: IbGibAddr[];
 }
 
 /**
@@ -52,13 +35,19 @@ export interface SyncSagaContextData_V1 extends IbGibData_V1 {
 export interface SyncSagaContextRel8ns_V1 extends IbGibRel8ns_V1 {
     /**
      * The primary Saga Frame being transported (Init, Ack, Delta, etc.).
-     * 0..1 (Optional only if trivial ping or strict metadata update)
+     * 
+     * Should be a single addr.
      */
-    sagaFrame?: IbGibAddr[];
+    sagaFrame: IbGibAddr[];
 
     /**
      * The Ephemeral Session Keystone Identity used for this saga.
      * Required for validating the saga frame signature.
+     * 
+     * ## notes
+     * 
+     * This will be different for the sender and receiver, yes? hmm...
+     * I think I need to put "sender" or "receiver" in the session keystone ib.
      */
     sessionKeystone?: IbGibAddr[];
 }
@@ -67,4 +56,19 @@ export interface SyncSagaContextRel8ns_V1 extends IbGibRel8ns_V1 {
  * The SyncSagaContext is a full-fledged ibGib used as the payload
  * between Sync Peers.
  */
-export interface SyncSagaContextIbGib_V1 extends IbGib_V1<SyncSagaContextData_V1, SyncSagaContextRel8ns_V1> { }
+export interface SyncSagaContextIbGib_V1 extends IbGib_V1<SyncSagaContextData_V1, SyncSagaContextRel8ns_V1> {
+    /**
+     * Domain ibgibs - OUTBOUND only.
+     * 
+     * For inbound, the domain payload ibgibs are streamed via observable in the
+     * peer.
+     */
+    payloadIbGibsDomain?: IbGib_V1[];
+
+    /**
+     * Reference to the actual sync saga frame that this context conveys.
+     * 
+     * This frame's addr should be {@link SyncSagaContextRel8ns_V1.sagaFrame}.
+     */
+    sagaFrame: SyncIbGib_V1;
+}