@ibgib/core-gib 0.0.65 → 0.0.66

package/src/witness/space/metaspace/metaspace-types.mts

@@ -14,7 +14,7 @@ import {
     GetIbGibOpts, GetIbGibResult,
     PutIbGibOpts, PutIbGibResult
 } from '../../../common/other/other-types.mjs';
-import { SyncSagaInfo, } from '../../../witness/space/outer-space/outer-space-types.mjs';
+import { SyncSagaInfo, SyncSpaceIbGib, } from '../../../witness/space/outer-space/outer-space-types.mjs';
 import { SpaceId } from '../../../witness/space/space-types.mjs';
 import { IbGibSpaceAny } from '../../../witness/space/space-base-v1.mjs';
 import { IbGibTimelineUpdateInfo, SpecialIbGibType } from '../../../common/other/other-types.mjs';
@@ -544,24 +544,24 @@ export interface MetaspaceService {
         dontPrompt?: boolean,
         space: IbGibSpaceAny,
     }): Promise<string>;
-    unwrapEncryptedSyncSpace(arg: {
-        encryptedSpace: IbGibSpaceAny,
-        fnPromptPassword: (title: string, msg: string) => Promise<string | null>,
-        dontPrompt?: boolean,
-        space?: IbGibSpaceAny,
-    }): Promise<IbGibSpaceAny>;
-    getSyncSpaces(arg: {
-        unwrapEncrypted: boolean,
-        createIfNone: boolean,
-        /**
-         * If true, don't prompt the user if we don't have it already cached.
-         *
-         * We don't want the user to hit the page and then always have to type in
-         * the password, just because my password code sucks atow.
-         */
-        dontPrompt?: boolean,
-        space?: IbGibSpaceAny,
-    }): Promise<IbGibSpaceAny[]>;
+    // unwrapEncryptedSyncSpace(arg: {
+    //     encryptedSpace: IbGibSpaceAny,
+    //     fnPromptPassword: (title: string, msg: string) => Promise<string | null>,
+    //     dontPrompt?: boolean,
+    //     space?: IbGibSpaceAny,
+    // }): Promise<IbGibSpaceAny>;
+    // getSyncSpaces(arg: {
+    //     // unwrapEncrypted: boolean,
+    //     createIfNone: boolean,
+    //     /**
+    //      * If true, don't prompt the user if we don't have it already cached.
+    //      *
+    //      * We don't want the user to hit the page and then always have to type in
+    //      * the password, just because my password code sucks atow.
+    //      */
+    //     dontPrompt?: boolean,
+    //     space?: IbGibSpaceAny,
+    // }): Promise<SyncSpaceIbGib[]>;
     getAppRobbotIbGibs(arg: {
         createIfNone: boolean,
         fnPromptRobbot: (space: IbGibSpaceAny, ibGib: RobbotIbGib_V1 | null) => Promise<RobbotPromptResult | undefined>;
@@ -581,55 +581,20 @@ export interface MetaspaceService {
          * ibgibs to be synced.
          */
         dependencyGraphIbGibs?: IbGib_V1[],
-        // confirm?: boolean,
+        /**
+         * sync space witnesses that we are going to send a put+sync cmd with
+         * the given {@link dependencyGraphIbGibs}.
+         *
+         * Note these are witnesses ({@link IbGibSpaceAny}) and not just the
+         * {@link SyncSpaceIbGib} interface, which is itself only an ibgib shape.
+         */
+        syncSpaceIbGibs: IbGibSpaceAny[],
         // /**
         //  * If true, will watch ibgibs in dependency graph that have timelines
         //  * (tjps) to keep in sync going forward.
         //  */
         // watch?: boolean,
-        /**
-         * if provided, these will determine which outerspace(s) we will sync
-         * the {@link dependencyGraphIbGibs} with.
-         */
-        outerspaceIds?: SpaceId[],
-        /**
-         * The meat of the sync process is tracked via a status within the sync
-         * spaces themselves. I'm addign this fn to track the pre and post progress
-         * stuff, since decrypting takes some time, and building the dependency
-         * graphs takes time. Both of these happen before the actual syncing occurs
-         * in the spaces.
-         */
-        fnPreSyncProgress?: (msg: string) => Promise<void>,
     }): Promise<SyncSagaInfo[] | undefined>;
-    // /**
-    //  * Prompts the user to select a new picture for the given `picIbGib`.
-    //  *
-    //  * If the user does select one, this creates the appropriate ibgibs (pic,
-    //  * binary, dependencies), saves them, registers the new pic (but not the bin)
-    //  * in the given `space` if specified, else in the current `localUserSpace`.
-    //  */
-    // updatePic(arg: {
-    //   /**
-    //    * picIbGib to update with a new image.
-    //    */
-    //   picIbGib: PicIbGib_V1,
-    //   /**
-    //    * space within which we are working, i.e., where the incoming `picIbGib` is
-    //    * and where we will save any new ibgibs.
-    //    */
-    //   space?: IbGibSpaceAny,
-    // }): Promise<void>;
-    // updateComment(arg: {
-    //   /**
-    //    * commentIbGib to update with a new text
-    //    */
-    //   commentIbGib: CommentIbGib_V1,
-    //   /**
-    //    * space within which we are working, i.e., where the incoming `commentIbGib` is
-    //    * and where we will save any new ibgibs.
-    //    */
-    //   space?: IbGibSpaceAny,
-    // }): Promise<void>;
 
     /**
      * creates a new local space with the given `fnLocalSpaceFactory` function

package/src/witness/space/outer-space/outer-space-types.mts

@@ -125,9 +125,16 @@ export interface OuterSpaceData extends IbGibSpaceData {
 }
 
 export interface OuterSpaceRel8ns extends IbGibSpaceRel8ns {
+    /**
+     * the ciphertext will contain private data that is typed per use case (per
+     * concrete implementation).
+     */
     [CIPHERTEXT_REL8N_NAME]?: IbGibAddr[];
 }
 
+/**
+ *
+ */
 export interface OuterSpaceIbGib
     extends IbGib_V1<OuterSpaceData, OuterSpaceRel8ns> {
 }
@@ -567,6 +574,9 @@ export interface SagaInfo<
     sagaId: string;
     /**
      * Reference to the space with which we're communicating.
+     *
+     * Note that this is a witness not just an ibgib data shape. so you will be
+     * able to pass in args to witness to this space.
      */
     outerSpace: IbGibSpaceAny;
     spaceId: string;