@ibgib/core-gib 0.0.4

package/dist/witness/space/outer-space/outer-space-types.d.mts

@@ -0,0 +1,548 @@
+/**
+ * @module outer-space
+ * Outer spaces are spaces connecting local inner spaces.
+ * ATOW there is just sync spaces, but definitely just the beginning.
+ *
+ * ## on future implementations, CRDT-like behavior
+ *
+ * I just realized that when merging, I can actually create a meta transform
+ * ibgib to maintain the order of transforms.
+ */
+import { ReplaySubject, Subscription } from 'rxjs';
+import { IbGibRel8ns_V1, IbGib_V1 } from '@ibgib/ts-gib/dist/V1/index.mjs';
+import { IbGibAddr, IbGib, Gib } from '@ibgib/ts-gib';
+import { IbGibSpaceData, IbGibSpaceRel8ns, IbGibSpaceOptionsData, IbGibSpaceOptionsRel8ns, IbGibSpaceOptionsIbGib, IbGibSpaceOptionsCmdModifier, IbGibSpaceResultData, IbGibSpaceResultRel8ns, IbGibSpaceResultIbGib } from '../space-types.mjs';
+import { IbGibSpaceAny } from '../space-base-v1.mjs';
+import { CIPHERTEXT_REL8N_NAME } from '../../../common/encrypt/encrypt-constants.mjs';
+import { CONSENSUS_REL8N_NAME } from '../../../common/other/other-constants.mjs';
+/**
+ * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
+ *
+ * ## driving use case
+ *
+ * I'm adding this for tracking status for longer-running inter-spatial
+ * communications. Specifically, I'm working on the first aws dynamo db
+ * sync space.
+ *
+ * ## notes
+ *
+ * * I think http status codes do a pretty good job of protocol information
+ *   exchange.
+ * * The only non-standard status code I'm doing ATOW is 0 meaning "undefined".
+ * * I'm adding (whitelisting) codes as I use them.
+ *   * Note that sections of code check for validation of membership here and
+ *     will error if not present.
+ */
+export type StatusCode = 'undefined' | 'preparing' | 'started' | 'inserted' | 'updated' | 'merged_dna' | 'merged_state' | 'already_synced' | 'completed';
+export declare const StatusCode: {
+    /**
+     * Using this as the code for the parent primitive.
+     */
+    undefined: StatusCode;
+    /**
+     * gt
+     */
+    preparing: StatusCode;
+    /**
+     * Communication between spaces has just started, but no evaluation as to
+     * intrinsic ibgibs shared has been made.
+     *
+     * Using this for the start of the sync process, meaning the ball has begun
+     * rolling, a metadata ibgib to track the operation has been created (but
+     * not necessarily yet stored), but no intrinsic (non-meta) data has been
+     * exchanged.
+     */
+    started: StatusCode;
+    /**
+     * New insertion of ibgib(s) into the outerspace.
+     *
+     * The outerspace did not have the timeline or ibgib(s) at all, so this is
+     * the first time.
+     */
+    inserted: StatusCode;
+    /**
+     * Updated outerspace with local ibgib(s).
+     *
+     * The outerspace had the same timeline as the local space, just not as
+     * recent.
+     */
+    updated: StatusCode;
+    /**
+     * When syncing, this means that we've created new ibgib to merge into an
+     * existing timeline in the sync space BY APPLYING ALL UN-APPLIED LOCAL
+     * TRANSFORMS to the latest ibgib in the store.
+     *
+     * Note that in this case, we've created new ibgib to fulfill the operation
+     * (besides the derivative metadata ibgibs created in the communication).
+     */
+    merged_dna: StatusCode;
+    /**
+     * When syncing, this means that we've created new ibgib to merge into an
+     * existing timeline in the sync space BY MANUALLY SYNCHRONIZING ALL
+     * DATA AND REL8NS with the latest ibgib in the store.
+     *
+     * Note that in this case, we've created new ibgib to fulfill the operation
+     * (besides the derivative metadata ibgibs created in the communication).
+     */
+    merged_state: StatusCode;
+    /**
+     * The operation has completed, but there were no intrinsic changes.
+     *
+     * For example, if we were to sync an ibGib but it's already up-to-date in a
+     * space, then we have generated metadata ibgibs. But *intrinsically* we have
+     * not altered any timeline ibgibs or added any stone ibgibs.
+     */
+    already_synced: StatusCode;
+    /**
+     * Inter-spatial communication complete.
+     *
+     * * There should be no more status updates after this.
+     * * syncStatus$ observable should be completed just after this.
+     * * subscribers should unsubscribe if not already done.
+     *   * I think this happens at the publishing end also, but always good
+     *     to take care of your own cleanup if possible.
+     *
+     */
+    completed: StatusCode;
+};
+export type OuterSpaceType = "sync";
+export declare const OuterSpaceType: {
+    sync: "sync";
+};
+export declare const VALID_OUTER_SPACE_TYPES: "sync"[];
+export type SyncSpaceSubtype = 'aws-dynamodb';
+export declare const SyncSpaceSubtype: {
+    aws_dynamodb: "aws-dynamodb";
+};
+export type OuterSpaceSubtype = 'tbd' | SyncSpaceSubtype;
+export declare const OuterSpaceSubtype: {
+    aws_dynamodb: "aws-dynamodb";
+    tbd: OuterSpaceSubtype;
+};
+export declare const VALID_OUTER_SPACE_SUBTYPES: OuterSpaceSubtype[];
+export interface OuterSpaceData extends IbGibSpaceData {
+    type: OuterSpaceType;
+    subtype: OuterSpaceSubtype;
+}
+export interface OuterSpaceRel8ns extends IbGibSpaceRel8ns {
+    [CIPHERTEXT_REL8N_NAME]?: IbGibAddr[];
+    /**
+     * ATOW this will only be CONSENSUS_ADDR_SYNC_NAIVE_PUT_MERGE
+     */
+    [CONSENSUS_REL8N_NAME]?: IbGibAddr[];
+}
+export interface OuterSpaceIbGib extends IbGib_V1<OuterSpaceData, OuterSpaceRel8ns> {
+}
+export interface SyncSpaceData extends OuterSpaceData {
+    type: 'sync';
+    subtype: SyncSpaceSubtype;
+}
+export interface SyncSpaceRel8ns extends OuterSpaceRel8ns {
+}
+export interface ParticipantInfo {
+    id: string;
+    gib: Gib;
+    s_d: 'src' | 'dest';
+}
+/**
+ * Options shape specific to OuterSpaces.
+ * Marker interface only atm.
+ */
+export interface OuterSpaceOptionsData extends IbGibSpaceOptionsData {
+    /**
+     * Operation id across multiple spaces.
+     *
+     * ## notes
+     *
+     * If src/local space is communicating with more than one
+     * other space, then this can be used to coordinate among
+     * all of them. If there are only two spaces, then the
+     * gib of the individual status ibgib is just as uniquely
+     * identifying.
+     */
+    multiSpaceOpId?: string;
+    /**
+     * Modifying flags for cmd routing for the associated cmd ibGib.
+     */
+    cmdModifiers?: (OuterSpaceOptionsCmdModifier | string)[];
+    /**
+     * This id is used when communicating between two spaces.  During that
+     * communication, multiple ibgibs will be passed back and forth, and this
+     * `sagaId` will be common among those messages.
+     *
+     * There is also an id that is common to operations that
+     * refer to multiple spaces. {@see multiSpaceOpId}
+     */
+    sagaId?: string;
+    /**
+     * Info of the participating spaces (as endpoints) in the communication.
+     */
+    participants?: ParticipantInfo[];
+}
+export interface OuterSpaceOptionsRel8ns extends IbGibSpaceOptionsRel8ns {
+}
+export interface OuterSpaceOptionsIbGib<TIbGib extends IbGib = IbGib_V1, TOptsData extends OuterSpaceOptionsData = OuterSpaceOptionsData, TOptsRel8ns extends OuterSpaceOptionsRel8ns = OuterSpaceOptionsRel8ns> extends IbGibSpaceOptionsIbGib<TIbGib, TOptsData, TOptsRel8ns> {
+}
+export interface OuterSpaceResultData extends IbGibSpaceResultData {
+    /**
+     * If the space operation involves a saga, this is the id.
+     */
+    sagaId?: string;
+}
+export interface OuterSpaceResultRel8ns extends IbGibSpaceResultRel8ns {
+}
+export interface OuterSpaceResultIbGib<TIbGib extends IbGib, TResultData extends OuterSpaceResultData, TResultRel8ns extends OuterSpaceResultRel8ns> extends IbGibSpaceResultIbGib<TIbGib, TResultData, TResultRel8ns> {
+}
+/**
+ * Marker atm.
+ *
+ * {@see IbGibSpaceOptionsCmdModifier}
+ */
+export type OuterSpaceOptionsCmdModifier = IbGibSpaceOptionsCmdModifier;
+/**
+ * Marker atm.
+ *
+ * {@see IbGibSpaceOptionsCmdModifier}
+ */
+export declare const OuterSpaceOptionsCmdModifier: {
+    can: IbGibSpaceOptionsCmdModifier;
+    addrs: IbGibSpaceOptionsCmdModifier;
+    latest: IbGibSpaceOptionsCmdModifier;
+    watch: IbGibSpaceOptionsCmdModifier;
+    unwatch: IbGibSpaceOptionsCmdModifier;
+    tjps: IbGibSpaceOptionsCmdModifier;
+};
+/**
+ * Extends basic ibgib space options cmd modifiers to include sync specific ones.
+ *
+ * {@see IbGibSpaceOptionsCmdModifier}
+ * {@see OuterSpaceOptionsCmdModifier}
+ */
+export type SyncSpaceOptionsCmdModifier = OuterSpaceOptionsCmdModifier | 'sync';
+/**
+ * Flags to affect the command's interpretation.
+ *
+ * {@see IbGibSpaceOptionsCmdModifier}
+ * {@see OuterSpaceOptionsCmdModifier}
+ */
+export declare const SyncSpaceOptionsCmdModifier: {
+    /**
+     * special type of 'put' operation that will start a sync process.
+     */
+    sync: SyncSpaceOptionsCmdModifier;
+    can: IbGibSpaceOptionsCmdModifier;
+    addrs: IbGibSpaceOptionsCmdModifier;
+    latest: IbGibSpaceOptionsCmdModifier;
+    watch: IbGibSpaceOptionsCmdModifier;
+    unwatch: IbGibSpaceOptionsCmdModifier;
+    tjps: IbGibSpaceOptionsCmdModifier;
+};
+export interface SyncSpaceOptionsData extends OuterSpaceOptionsData {
+    /**
+     * Extends inherited
+     */
+    cmdModifiers?: (SyncSpaceOptionsCmdModifier | string)[];
+    /**
+     * Each Sync has a status ibGib that tracks the progress of the
+     * overall sync operation (saga).
+     *
+     *
+     * If this is specified, then it means the sync cmd is associated with
+     * an existing/ongoing operation.
+     */
+    tjpGib?: Gib;
+    ibGibAddrs_All_Tjps?: IbGibAddr[];
+    ibGibAddrs_All_NonTjps?: IbGibAddr[];
+}
+export interface SyncSpaceOptionsRel8ns extends OuterSpaceOptionsRel8ns {
+}
+export interface SyncSpaceOptionsIbGib<TIbGib extends IbGib = IbGib_V1, TOptsData extends SyncSpaceOptionsData = SyncSpaceOptionsData, TOptsRel8ns extends SyncSpaceOptionsRel8ns = SyncSpaceOptionsRel8ns> extends OuterSpaceOptionsIbGib<TIbGib, TOptsData, TOptsRel8ns> {
+    /**
+     * Produces status ibgibs or error strings.
+     */
+    syncSagaInfo: SyncSagaInfo;
+}
+export interface SyncSpaceResultData extends OuterSpaceResultData {
+    statusTjpAddr?: IbGibAddr;
+}
+export interface SyncSpaceResultRel8ns extends OuterSpaceResultRel8ns {
+}
+export interface SyncSpaceResultIbGib<TIbGib extends IbGib = IbGib_V1, TResultData extends SyncSpaceResultData = SyncSpaceResultData, TResultRel8ns extends SyncSpaceResultRel8ns = SyncSpaceResultRel8ns> extends OuterSpaceResultIbGib<TIbGib, TResultData, TResultRel8ns> {
+    /**
+     * Produces status ibgibs or error strings.
+     */
+    syncSagaInfo: SyncSagaInfo;
+}
+export interface SyncStatusData {
+    /**
+     * Status code for this status update.
+     *
+     * Note that this is also in the ib, which will be in each of the
+     * statuses' `past` rel8n. This way, callers can easily tell which
+     * kinds of actions were required.
+     */
+    statusCode: StatusCode;
+    syncGib: string;
+    participants: ParticipantInfo[];
+    /**
+     * Explicit re-declaration from base data, just to remind us...I guess...
+     *
+     * This indicates if this status ibgib is the tjp for the status line.
+     */
+    isTjp?: boolean;
+    /**
+     * When putting, this is the list of ibGibs to send.
+     *
+     * ## notes
+     *
+     * Maybe the receiver needs all of these, maybe it doesn't.
+     */
+    toTx?: IbGibAddr[];
+    /**
+     * When putting, this is the list of ibGibs we don't need/want (or refuse)
+     * to send.
+     *
+     * IGNORED ATOW
+     *
+     * ## notes
+     *
+     * Not really sure about this atow, since the aws-dynamo space is not a true
+     * communication between two separate nodes. Just figure someone will have a
+     * reason for it in the future.
+     */
+    notToTx?: IbGibAddr[];
+    /**
+     * When communicating, the receiver is asking the sender for
+     * these ibGibs.
+     *
+     * ## notes
+     *
+     * ATOW this indicates only that the receiver does not have
+     * these addresses.
+     */
+    toRx?: IbGibAddr[];
+    /**
+     * A receiving space can set this to indicate to the transmitter that it
+     * does not need/want these, possibly because they already have them or just
+     * are not interested in them.
+     *
+     * ## notes
+     *
+     * ATOW this will only be because the receiver already has these addresses.
+     */
+    notToRx?: IbGibAddr[];
+    /**
+     * Flag to indicate that THIS STEP in communication (part of a saga) had no
+     * errors.
+     */
+    success?: boolean;
+    /**
+     * If this is true, then the tx/rx inter-space saga is marked
+     * as complete and this status ibgib should be the last one.
+     */
+    complete?: boolean;
+    /**
+     * List of warnings for THIS STEP in the inter-spatial communication.
+     *
+     * Should NOT be an accumulating list of warnings, i.e., if a warning
+     * happens early on in a tx/rx, then it stays on that ibGib.
+     */
+    warnings?: string[];
+    /**
+     * List of errors for THIS STEP in the inter-spatial communication.
+     *
+     * Should NOT be an accumulating list of errors, i.e., if an error happens
+     * early on in a tx/rx, then it stays on that ibGib.
+     *
+     * ## notes
+     *
+     * atow my error workflow is pretty minimal. So I think if any error happens
+     * the entire saga gets nixed...
+     *
+     * But it should be that this type of behavior should be determined by
+     * on-chain ibgibs that correspond to consensus behavior contracts (with a
+     * default behavior ultimately existing hard-coded in source).
+     */
+    errors?: string[];
+    /**
+     * List of ibgib addrs that were newly created specifically for this
+     * space operation.
+     *
+     * ATOW, this means that there was a merged timeline event and
+     * the receiving space dynamically applied dna to its existing
+     * timeline.
+     *
+     * ## notes
+     *
+     * * This should not include status metadata ibgibs, as this is
+     *   already captured in the `past` rel8n.
+     */
+    didCreate?: IbGibAddr[];
+    /**
+     * List of ibgib addrs that were merged in the rx space instead of stored
+     * directly.
+     *
+     * Tx space may choose to somehow mark these as orphaned or whatever seems
+     * best per use case. (i.e. I haven't coded that yet even in this naive
+     * first implementation)
+     */
+    didMergeMap?: {
+        [oldAddr: string]: IbGibAddr;
+    };
+    /**
+     * List of ibgibs that were actively transmitted to the receiving
+     * space.
+     *
+     * ## notes
+     *
+     * * It could be that the receiving space received the ibgib,
+     *   but that it already had it. It may have been unsure if it
+     *   had it based on the algorithms in play.
+     * * An empty array upon completion of a communication saga
+     *   indicates that the receiving space already had all of the
+     *   ibgibs attempted to be sent, i.e., it was already up-to-date.
+     *
+     */
+    didRx?: IbGibAddr[];
+    /**
+     * List of ibgibs that were actively transmitted from the receiving
+     * space to the sending space.
+     *
+     * ## notes
+     *
+     * * During a sync operation, any ibgibs that start in the sync space
+     *   and are "sent" to the local space during the sync operation that
+     *   did not originate from the local space will be here.
+     */
+    didTx?: IbGibAddr[];
+}
+export interface SyncStatusRel8ns extends IbGibRel8ns_V1 {
+    created?: IbGibAddr[];
+    final?: IbGibAddr[];
+}
+/**
+ * IbGib that tracks/logs the entire syncing process.
+ *
+ * Since this is created with a tjp, it includes the tjp.gib in
+ * each status frame ibgib.gib. This tjp.gib acts as the "saga id"
+ * or "status stream id".
+ *
+ * ## stages
+ *
+ * ### starting - (code 102)
+ *
+ * Gets the ball rolling with creating the first status ibgib.
+ *
+ * ###
+ *
+ */
+export interface SyncStatusIbGib extends IbGib_V1<SyncStatusData, SyncStatusRel8ns> {
+    statusIbGibGraph: IbGib_V1[];
+    /**
+     * Ibgibs that were created as side effects from a merge.
+     *
+     * ## notes
+     *
+     * This happens when you apply one or more local transforms to
+     * a timeline in the store that has already been changed by some
+     * other space (other than local that is).
+     */
+    createdIbGibs?: IbGib_V1[];
+    /**
+     * Ibgibs that are only found in the store and not locally.
+     *
+     * ## notes
+     *
+     * This happens when ibgibs were created in some other space.
+     */
+    storeOnlyIbGibs?: IbGib_V1[];
+    /**
+     * This is a map of the local space "oldAddr" to the ultimately
+     * most recent ibgib address in the outer/sync space.
+     *
+     * ## notes
+     *
+     * You will need to also download the createdIbGibs and/or storeOnlyIbGibs
+     * which will contain the dependency graph between these two endpoints in
+     * each map entry here from old addr -> new addr.
+     *
+     * It is assumed that the local address already has all of the rest of the
+     * dependencies for `oldAddr`.
+     */
+    ibGibsMergeMap?: {
+        [oldAddr: string]: IbGib_V1;
+    };
+}
+/**
+ * A saga atow refers only to the saga across a single space.
+ */
+export interface SagaInfo<TIbGib extends IbGib_V1, TSpaceOptionsData extends OuterSpaceOptionsData, TSpaceOptionsRel8ns extends OuterSpaceOptionsRel8ns, TSpaceOptionsIbGib extends OuterSpaceOptionsIbGib<TIbGib, TSpaceOptionsData, TSpaceOptionsRel8ns>, TSpaceResultData extends OuterSpaceResultData, TSpaceResultRel8ns extends OuterSpaceResultRel8ns, TSpaceResultIbGib extends OuterSpaceResultIbGib<TIbGib, TSpaceResultData, TSpaceResultRel8ns>, TStatusIbGib extends TIbGib> {
+    /**
+     * UUID generated at the beginning of a multi-space operation that is common
+     * across all spaces.
+     *
+     * This is in contrast with a `sagaId`, which only pertains to a saga within
+     * a single space.
+     */
+    multiSpaceOpId: string;
+    /**
+     * UUID generated at the beginning of a sync saga for a single space.
+     *
+     * This is in contrast with the `syncId`, which pertains to a sync operation
+     * across all spaces.
+     */
+    sagaId: string;
+    /**
+     * Reference to the space with which we're communicating.
+     */
+    outerSpace: IbGibSpaceAny;
+    spaceId: string;
+    participants: ParticipantInfo[];
+    complete?: boolean;
+    /**
+     * Only publishes values after subscribed.
+     */
+    syncStatus$: ReplaySubject<TStatusIbGib>;
+    syncStatusSubscriptions: Subscription[];
+    /**
+     * For each communication saga, there will be one or more calls to each
+     * space's `witness` function. This will produce arg & result ibgibs. This
+     * is the observable stream/subject of those witness calls.
+     */
+    witnessFnArgsAndResults$: ReplaySubject<TSpaceOptionsIbGib | TSpaceResultIbGib>;
+    syncIbGibs_All: IbGib_V1[];
+    syncAddrs_All: IbGibAddr[];
+    syncAddrs_All_AreTjps: IbGibAddr[];
+    syncAddrs_All_WithTjps: IbGibAddr[];
+    syncAddrs_All_WithoutTjps: IbGibAddr[];
+    syncAddrs_Skipped: IbGibAddr[];
+    syncAddrs_ToDo: IbGibAddr[];
+    syncAddrs_InProgress: IbGibAddr[];
+    syncAddrs_Failed: IbGibAddr[];
+}
+/**
+ * Information about a sync operation over its entirety.
+ *
+ * ## notes
+ *
+ * This will be attached to each space arg/result ibgib, but this info object
+ * WILL NOT be part of the internal `data` of either arg or result ibGib.
+ */
+export interface SyncSagaInfo extends SagaInfo<IbGib_V1, SyncSpaceOptionsData, SyncSpaceOptionsRel8ns, SyncSpaceOptionsIbGib, SyncSpaceResultData, SyncSpaceResultRel8ns, SyncSpaceResultIbGib, SyncStatusIbGib> {
+}
+/**
+ * AWS-specific outerspace type
+ */
+export type AWSRegion = 'us-east-1' | string;
+export interface StatusIbInfo {
+    /**
+     * Code for the given status.
+     *
+     */
+    statusCode: StatusCode;
+    spaceType: OuterSpaceType;
+    spaceSubtype: OuterSpaceSubtype;
+    sagaId: string;
+    delimiter?: string;
+}
+//# sourceMappingURL=outer-space-types.d.mts.map

package/dist/witness/space/outer-space/outer-space-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"outer-space-types.d.mts","sourceRoot":"","sources":["../../../../src/witness/space/outer-space/outer-space-types.mts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAO,MAAM,eAAe,CAAC;AAI3D,OAAO,EACH,cAAc,EAAE,gBAAgB,EAChC,qBAAqB,EAAE,uBAAuB,EAAE,sBAAsB,EACtE,4BAA4B,EAC5B,oBAAoB,EAAE,sBAAsB,EAAE,qBAAqB,EACtE,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,+CAA+C,CAAC;AACtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AAEjF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,UAAU,GAClB,WAAW,GACX,WAAW,GACX,SAAS,GACT,UAAU,GAAG,SAAS,GACtB,YAAY,GAAG,cAAc,GAC7B,gBAAgB,GAChB,WAAW,CAAC;AAChB,eAAO,MAAM,UAAU;IACnB;;OAEG;;IAEH;;OAEG;;IAEH;;;;;;;;OAQG;;IAEH;;;;;OAKG;;IAEH;;;;;OAKG;;IAEH;;;;;;;OAOG;;IAEH;;;;;;;OAOG;;IAEH;;;;;;OAMG;;IAEH;;;;;;;;;OASG;;CAEN,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,eAAO,MAAM,cAAc;;CAE1B,CAAA;AACD,eAAO,MAAM,uBAAuB,UAAyC,CAAC;AAE9E,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAC;AAC9C,eAAO,MAAM,gBAAgB;;CAE5B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,gBAAgB,CAAC;AACzD,eAAO,MAAM,iBAAiB;;;CAG7B,CAAA;AACD,eAAO,MAAM,0BAA0B,qBAA4C,CAAC;AAEpF,MAAM,WAAW,cAAe,SAAQ,cAAc;IAClD,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,iBAAiB,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACtD,CAAC,qBAAqB,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC;IACtC;;OAEG;IACH,CAAC,oBAAoB,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,eACb,SAAQ,QAAQ,CAAC,cAAc,EAAE,gBAAgB,CAAC;CACrD;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC;CAC7B;AACD,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;CACxD;AAED,MAAM,WAAW,eAAe;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,GAAG,CAAC;IACT,GAAG,EAAE,KAAK,GAAG,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAChE;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,4BAA4B,GAAG,MAAM,CAAC,EAAE,CAAC;IACzD;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;CACvE;AACD,MAAM,WAAW,sBAAsB,CACnC,MAAM,SAAS,KAAK,GAAG,QAAQ,EAC/B,SAAS,SAAS,qBAAqB,GAAG,qBAAqB,EAE/D,WAAW,SAAS,uBAAuB,GAAG,uBAAuB,CACvE,SAAQ,sBAAsB,CAAC,MAAM,EAAE,SAAS,EAAE,WAAW,CAAC;CAC/D;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAC9D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,sBAAuB,SAAQ,sBAAsB;CACrE;AACD,MAAM,WAAW,qBAAqB,CAClC,MAAM,SAAS,KAAK,EACpB,WAAW,SAAS,oBAAoB,EACxC,aAAa,SAAS,sBAAsB,CAC9C,SAAQ,qBAAqB,CAAC,MAAM,EAAE,WAAW,EAAE,aAAa,CAAC;CAClE;AAED;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,4BAA4B,CAAC;AACxE;;;;GAIG;AACH,eAAO,MAAM,4BAA4B;;;;;;;CAExC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GAAG,4BAA4B,GAAG,MAAM,CAAC;AAChF;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B;IAEpC;;OAEG;;;;;;;;CAEN,CAAA;AAED,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IAC/D;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,2BAA2B,GAAG,MAAM,CAAC,EAAE,CAAC;IACxD;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,GAAG,CAAC;IAEb,mBAAmB,CAAC,EAAE,SAAS,EAAE,CAAC;IAClC,sBAAsB,CAAC,EAAE,SAAS,EAAE,CAAC;CACxC;AACD,MAAM,WAAW,sBAAuB,SAAQ,uBAAuB;CACtE;AACD,MAAM,WAAW,qBAAqB,CAClC,MAAM,SAAS,KAAK,GAAG,QAAQ,EAC/B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,EAC7D,WAAW,SAAS,sBAAsB,GAAG,sBAAsB,CACrE,SAAQ,sBAAsB,CAAC,MAAM,EAAE,SAAS,EAAE,WAAW,CAAC;IAC5D;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC7D,aAAa,CAAC,EAAE,SAAS,CAAC;CAC7B;AACD,MAAM,WAAW,qBAAsB,SAAQ,sBAAsB;CACpE;AACD,MAAM,WAAW,oBAAoB,CACjC,MAAM,SAAS,KAAK,GAAG,QAAQ,EAC/B,WAAW,SAAS,mBAAmB,GAAG,mBAAmB,EAC7D,aAAa,SAAS,qBAAqB,GAAG,qBAAqB,CACrE,SAAQ,qBAAqB,CAAC,MAAM,EAAE,WAAW,EAAE,aAAa,CAAC;IAC/D;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC3B;;;;;;OAMG;IACH,UAAU,EAAE,UAAU,CAAC;IAEvB,OAAO,EAAE,MAAM,CAAC;IAGhB,YAAY,EAAE,eAAe,EAAE,CAAC;IAEhC;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IACtB;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC;IACxB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAC;IAC/C;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;IACpB;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACpD,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;CACvB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ,CAAC,cAAc,EAAE,gBAAgB,CAAC;IAC/E,gBAAgB,EAAE,QAAQ,EAAE,CAAC;IAC7B;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC3B;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAAA;KAAE,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ,CACrB,MAAM,SAAS,QAAQ,EACvB,iBAAiB,SAAS,qBAAqB,EAC/C,mBAAmB,SAAS,uBAAuB,EACnD,kBAAkB,SAAS,sBAAsB,CAAC,MAAM,EAAE,iBAAiB,EAAE,mBAAmB,CAAC,EACjG,gBAAgB,SAAS,oBAAoB,EAC7C,kBAAkB,SAAS,sBAAsB,EACjD,iBAAiB,SAAS,qBAAqB,CAAC,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,EAC7F,YAAY,SAAS,MAAM;IAE3B;;;;;;OAMG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,EAAE,aAAa,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,eAAe,EAAE,CAAC;IAEhC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACzC,uBAAuB,EAAE,YAAY,EAAE,CAAC;IAExC;;;;OAIG;IACH,wBAAwB,EAAE,aAAa,CAAC,kBAAkB,GAAG,iBAAiB,CAAC,CAAC;IAEhF,cAAc,EAAE,QAAQ,EAAE,CAAC;IAC3B,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,qBAAqB,EAAE,SAAS,EAAE,CAAC;IACnC,sBAAsB,EAAE,SAAS,EAAE,CAAC;IACpC,yBAAyB,EAAE,SAAS,EAAE,CAAC;IACvC,iBAAiB,EAAE,SAAS,EAAE,CAAC;IAC/B,cAAc,EAAE,SAAS,EAAE,CAAC;IAC5B,oBAAoB,EAAE,SAAS,EAAE,CAAC;IAClC,gBAAgB,EAAE,SAAS,EAAE,CAAC;CACjC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,YACb,SAAQ,QAAQ,CACZ,QAAQ,EACR,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,CAAC;CACvB;AAOD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,MAAM,CAAC;AAE7C,MAAM,WAAW,YAAY;IACzB;;;OAGG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB,SAAS,EAAE,cAAc,CAAC;IAC1B,YAAY,EAAE,iBAAiB,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/witness/space/outer-space/outer-space-types.mjs

@@ -0,0 +1,118 @@
+/**
+ * @module outer-space
+ * Outer spaces are spaces connecting local inner spaces.
+ * ATOW there is just sync spaces, but definitely just the beginning.
+ *
+ * ## on future implementations, CRDT-like behavior
+ *
+ * I just realized that when merging, I can actually create a meta transform
+ * ibgib to maintain the order of transforms.
+ */
+import { IbGibSpaceOptionsCmdModifier, } from '../space-types.mjs';
+import { CIPHERTEXT_REL8N_NAME } from '../../../common/encrypt/encrypt-constants.mjs';
+import { CONSENSUS_REL8N_NAME } from '../../../common/other/other-constants.mjs';
+export const StatusCode = {
+    /**
+     * Using this as the code for the parent primitive.
+     */
+    undefined: 'undefined',
+    /**
+     * gt
+     */
+    preparing: 'preparing',
+    /**
+     * Communication between spaces has just started, but no evaluation as to
+     * intrinsic ibgibs shared has been made.
+     *
+     * Using this for the start of the sync process, meaning the ball has begun
+     * rolling, a metadata ibgib to track the operation has been created (but
+     * not necessarily yet stored), but no intrinsic (non-meta) data has been
+     * exchanged.
+     */
+    started: 'started',
+    /**
+     * New insertion of ibgib(s) into the outerspace.
+     *
+     * The outerspace did not have the timeline or ibgib(s) at all, so this is
+     * the first time.
+     */
+    inserted: 'inserted',
+    /**
+     * Updated outerspace with local ibgib(s).
+     *
+     * The outerspace had the same timeline as the local space, just not as
+     * recent.
+     */
+    updated: 'updated',
+    /**
+     * When syncing, this means that we've created new ibgib to merge into an
+     * existing timeline in the sync space BY APPLYING ALL UN-APPLIED LOCAL
+     * TRANSFORMS to the latest ibgib in the store.
+     *
+     * Note that in this case, we've created new ibgib to fulfill the operation
+     * (besides the derivative metadata ibgibs created in the communication).
+     */
+    merged_dna: 'merged_dna',
+    /**
+     * When syncing, this means that we've created new ibgib to merge into an
+     * existing timeline in the sync space BY MANUALLY SYNCHRONIZING ALL
+     * DATA AND REL8NS with the latest ibgib in the store.
+     *
+     * Note that in this case, we've created new ibgib to fulfill the operation
+     * (besides the derivative metadata ibgibs created in the communication).
+     */
+    merged_state: 'merged_state',
+    /**
+     * The operation has completed, but there were no intrinsic changes.
+     *
+     * For example, if we were to sync an ibGib but it's already up-to-date in a
+     * space, then we have generated metadata ibgibs. But *intrinsically* we have
+     * not altered any timeline ibgibs or added any stone ibgibs.
+     */
+    already_synced: 'already_synced',
+    /**
+     * Inter-spatial communication complete.
+     *
+     * * There should be no more status updates after this.
+     * * syncStatus$ observable should be completed just after this.
+     * * subscribers should unsubscribe if not already done.
+     *   * I think this happens at the publishing end also, but always good
+     *     to take care of your own cleanup if possible.
+     *
+     */
+    completed: 'completed',
+};
+export const OuterSpaceType = {
+    sync: 'sync',
+};
+export const VALID_OUTER_SPACE_TYPES = Object.values(OuterSpaceType).concat();
+export const SyncSpaceSubtype = {
+    aws_dynamodb: 'aws-dynamodb',
+};
+export const OuterSpaceSubtype = {
+    tbd: 'tbd',
+    ...SyncSpaceSubtype,
+};
+export const VALID_OUTER_SPACE_SUBTYPES = Object.values(OuterSpaceSubtype).concat();
+/**
+ * Marker atm.
+ *
+ * {@see IbGibSpaceOptionsCmdModifier}
+ */
+export const OuterSpaceOptionsCmdModifier = {
+    ...IbGibSpaceOptionsCmdModifier,
+};
+/**
+ * Flags to affect the command's interpretation.
+ *
+ * {@see IbGibSpaceOptionsCmdModifier}
+ * {@see OuterSpaceOptionsCmdModifier}
+ */
+export const SyncSpaceOptionsCmdModifier = {
+    ...OuterSpaceOptionsCmdModifier,
+    /**
+     * special type of 'put' operation that will start a sync process.
+     */
+    sync: 'sync',
+};
+//# sourceMappingURL=outer-space-types.mjs.map

package/dist/witness/space/outer-space/outer-space-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"outer-space-types.mjs","sourceRoot":"","sources":["../../../../src/witness/space/outer-space/outer-space-types.mts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AASH,OAAO,EAGH,4BAA4B,GAE/B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,+CAA+C,CAAC;AACtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AA4BjF,MAAM,CAAC,MAAM,UAAU,GAAG;IACtB;;OAEG;IACH,SAAS,EAAE,WAAyB;IACpC;;OAEG;IACH,SAAS,EAAE,WAAyB;IACpC;;;;;;;;OAQG;IACH,OAAO,EAAE,SAAuB;IAChC;;;;;OAKG;IACH,QAAQ,EAAE,UAAwB;IAClC;;;;;OAKG;IACH,OAAO,EAAE,SAAuB;IAChC;;;;;;;OAOG;IACH,UAAU,EAAE,YAA0B;IACtC;;;;;;;OAOG;IACH,YAAY,EAAE,cAA4B;IAC1C;;;;;;OAMG;IACH,cAAc,EAAE,gBAA8B;IAC9C;;;;;;;;;OASG;IACH,SAAS,EAAE,WAAyB;CACvC,CAAA;AAGD,MAAM,CAAC,MAAM,cAAc,GAAG;IAC1B,IAAI,EAAE,MAAwB;CACjC,CAAA;AACD,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC;AAG9E,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,YAAY,EAAE,cAAkC;CACnD,CAAA;AAGD,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC7B,GAAG,EAAE,KAA0B;IAC/B,GAAG,gBAAgB;CACtB,CAAA;AACD,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,EAAE,CAAC;AAmGpF;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG;IACxC,GAAG,4BAA4B;CAClC,CAAA;AASD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACvC,GAAG,4BAA4B;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAqC;CAC9C,CAAA"}