@ibgib/core-gib 0.0.4

package/dist/witness/space/space-constants.d.mts

@@ -0,0 +1,181 @@
+/**
+ * Zero space is a default space that uses default values that should be
+ * reproducible and not break or something...it's all in flux really.
+ */
+export declare const ZERO_SPACE_ID = "zero";
+export declare const IBGIB_SPACE_NAME_DEFAULT = "default_space";
+/**
+ * Base directory for all data of the app.
+ */
+export declare const IBGIB_BASE_SUBPATH = "ibgib";
+/**
+ * Default space that is also used for bootstrapping.
+ *
+ * The user should provide his/her own space name that will contain their data.
+ * If a custom user space name is not provided, one should be auto-generated.
+ *
+ * ## notes
+ *
+ * * the leading 000's help to put the space earlier in alphabetized listing if viewing through an OS file viewer
+ */
+export declare const IBGIB_SPACE_SUBPATH_DEFAULT: string;
+/**
+ * Subpath for "normal" ibgibs (non-meta, non-dna, non-binary, etc.).
+ */
+export declare const IBGIB_IBGIBS_SUBPATH = "ibgibs";
+/**
+ * should contain special-use ibgibs to the application.
+ *
+ * Use case:
+ *   Because some special ibgibs will be changed frequently,
+ *   e.g. settings, a separate folder will be useful.
+ */
+export declare const IBGIB_META_SUBPATH = "meta";
+/**
+ * For use with documentation and UX help.
+ *
+ * This is probably scoped to a particular schema...(e.g. v1)
+ */
+export declare const VALID_SPACE_NAME_EXAMPLES: string[];
+/**
+ * For use with documentation and UX help.
+ *
+ * This is probably scoped to a particular schema...(e.g. v1)
+ */
+export declare const INVALID_SPACE_NAME_EXAMPLES: string[];
+/**
+ *
+ */
+export declare const PERSIST_OPTS_AND_RESULTS_IBGIBS_DEFAULT = false;
+/**
+ * Yep, this one starts with default instead of ending with it.
+ */
+export declare const DEFAULT_LOCAL_SPACE_DESCRIPTION = "This is a local space. There are many like it, but this one is mine.";
+/**
+ * The main roots^gib ibgib uses this rel8n name to keep track of roots.
+ */
+export declare const SPACE_REL8N_NAME = "space";
+/**
+ * rel8n name in a space ibgib to the config ibgib(s?)
+ */
+export declare const SPACE_REL8N_NAME_CONFIG = "config";
+export declare const SPACE_NAME_REGEXP: RegExp;
+/**
+ * A spaces ibGib uses this rel8n name for related sync spaces, used
+ * in replicating ibgib spaces.
+ */
+export declare const SYNC_SPACE_REL8N_NAME = "syncSpace";
+/**
+ * ...?
+ */
+export declare const DEFAULT_SPACE_TEXT = "space";
+/**
+ * Default icon specifically for spaces.
+ */
+export declare const DEFAULT_SPACE_ICON = "sparkles-outline";
+/**
+ * Default description specifically for spaces.
+ */
+export declare const DEFAULT_SPACE_DESCRIPTION = "This is a space ibgib, which is basically a special ibgib who has behavior\nto interface with data stores and/or other space(s) to provide concrete location\nfor ibgibs. All ibgibs can have relationships with other ibgibs, but this one\nspecifically either implies a physical interface to things like databases,\nfile systems, and similar; OR, when this space interfaces with other spaces, this\nis a logical organization of ibgib locations, like when configuring clusters or\nconsensus algorithms.";
+/**
+ * rel8n name used inside the root to those ibgib it contains.
+ *
+ * @example
+ * ```json
+ *  {
+ *      ib: root,
+ *      gib: ABC123,
+ *      data: {...},
+ *      rel8ns: {
+ *          [rel8nName]: ["a^1", "b^2"]
+ *      }
+ *  }
+ * ```
+ */
+export declare const DEFAULT_SPACE_REL8N_NAME = "x";
+/**
+ * Interval in ms between polling for updates ("notifications") between local
+ * space (ibgibs service) and dynamo sync space(s), or for use within a single
+ * space for checking its internal state.
+ *
+ * Of course, long polling is very hacky, but so is using DynamoDB in the cloud
+ * for a sync space. Obviously need to progress to a more mature and robust sync
+ * space/outer space architecture.
+ */
+export declare const DEFAULT_LOCAL_SPACE_POLLING_INTERVAL_MS = 30000;
+export declare const DEFAULT_LOCAL_SPACE_POLLING_DELAY_FIRST_RUN_MS = 10000;
+/**
+ * {@link DEFAULT_LOCAL_SPACE_POLLING_INTERVAL_MS} but for outer spaces, so
+ * longer interval atow.
+ */
+export declare const DEFAULT_OUTER_SPACE_POLLING_INTERVAL_MS = 20000;
+/**
+ * Amount of time to delay for FIRST poll execution.
+ */
+export declare const DEFAULT_OUTER_SPACE_POLLING_DELAY_FIRST_RUN_MS = 10000;
+/**
+ * When a status is first created, this is used to indicate that
+ * the tjp has not been set.
+ */
+export declare const STATUS_UNDEFINED_TJP_GIB = "gib";
+/**
+ * When a status is first created, this is used to indicate that
+ * the txId has not been set.
+ */
+export declare const STATUS_UNDEFINED_TX_ID = "0";
+export declare const SPACE_LOCK_IB_TERM = "space_lock";
+/**
+ * When attempting to acquire a lock ona  space, and it is already lock, it will
+ * wait a random amount of ms before trying to lock again. This is the default
+ * max amount of ms before reattempting.
+ */
+export declare const DEFAULT_MAX_DELAY_MS_RETRY_LOCK_ACQUIRE = 100;
+/**
+ * Will retry this many times before giving up...
+ */
+export declare const DEFAULT_MAX_DELAY_RETRY_LOCK_ACQUIRE_ATTEMPTS = 100;
+/**
+ * We don't want someone locking a space forever by accident.
+ */
+export declare const MAX_LOCK_SECONDS_VALID: number;
+/**
+ * Default value for secondsValid when acquiring/releasing lock in/on LOCAL
+ * space.
+ */
+export declare const DEFAULT_SECONDS_VALID_LOCAL = 2;
+/**
+ * Default value for secondsValid when acquiring/releasing lock in/on
+ * OUTER space, e.g. sync spaces like aws dynamo sync space.
+ */
+export declare const DEFAULT_SECONDS_VALID_OUTER = 30;
+/**
+ * retry count when calling getDependencyGraph.
+ *
+ * ## driving use case
+ *
+ * dependency graph fails when concurrent merges made in sync space.
+ * need to wait until previous graph merger happens then retry.
+ */
+export declare const DEFAULT_MAX_RETRIES_GET_DEPENDENCY_GRAPH_OUTERSPACE = 5;
+/**
+ * when getting dependency graph, sometimes we have to wait to retry
+ */
+export declare const DEFAULT_MS_BETWEEN_RETRIES_GET_DEPENDENCY_GRAPH_OUTERSPACE = 5000;
+/**
+ * retry count when calling getDependencyGraph.
+ *
+ * ## driving use case
+ *
+ * dependency graph fails when concurrent merges made in sync space.
+ * need to wait until previous graph merger happens then retry.
+ */
+export declare const DEFAULT_MAX_RETRIES_GET_DEPENDENCY_GRAPH_LOCAL = 3;
+/**
+ * when getting dependency graph, sometimes we have to wait to retry
+ */
+export declare const DEFAULT_MS_BETWEEN_RETRIES_GET_DEPENDENCY_GRAPH_LOCAL = 1000;
+/**
+ * currently not used in ionic-gib.
+ */
+export declare const DEFAULT_TX_ID_LENGTH = 5;
+//# sourceMappingURL=space-constants.d.mts.map

package/dist/witness/space/space-constants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"space-constants.d.mts","sourceRoot":"","sources":["../../../src/witness/space/space-constants.mts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,aAAa,SAAS,CAAC;AAEpC,eAAO,MAAM,wBAAwB,kBAAkB,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,kBAAkB,UAAU,CAAC;AAC1C;;;;;;;;;GASG;AACH,eAAO,MAAM,2BAA2B,QAAoC,CAAC;AAC7E;;GAEG;AACH,eAAO,MAAM,oBAAoB,WAAW,CAAC;AAC7C;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,SAAS,CAAC;AAEzC;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,UAErC,CAAC;AACF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,UAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uCAAuC,QAAQ,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,+BAA+B,yEAAyE,CAAC;AAEtH;;GAEG;AACH,eAAO,MAAM,gBAAgB,UAAU,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,uBAAuB,WAAW,CAAC;AAChD,eAAO,MAAM,iBAAiB,QAAmC,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,qBAAqB,cAAc,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,kBAAkB,UAAU,CAAC;AAC1C;;GAEG;AACH,eAAO,MAAM,kBAAkB,qBAAqB,CAAC;AACrD;;GAEG;AACH,eAAO,MAAM,yBAAyB,ufAOhB,CAAC;AACvB;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAE5C;;;;;;;;GAQG;AACH,eAAO,MAAM,uCAAuC,QAAS,CAAC;AAC9D,eAAO,MAAM,8CAA8C,QAAS,CAAC;AAErE;;;GAGG;AACH,eAAO,MAAM,uCAAuC,QAAS,CAAC;AAC9D;;GAEG;AACH,eAAO,MAAM,8CAA8C,QAAS,CAAC;AAErE;;;GAGG;AACH,eAAO,MAAM,wBAAwB,QAAM,CAAC;AAC5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAE1C,eAAO,MAAM,kBAAkB,eAAe,CAAC;AAC/C;;;;GAIG;AACH,eAAO,MAAM,uCAAuC,MAAM,CAAC;AAC3D;;GAEG;AACH,eAAO,MAAM,6CAA6C,MAAM,CAAC;AACjE;;GAEG;AACH,eAAO,MAAM,sBAAsB,QAAS,CAAC;AAC7C;;;GAGG;AACH,eAAO,MAAM,2BAA2B,IAAI,CAAC;AAC7C;;;GAGG;AACH,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C;;;;;;;GAOG;AACH,eAAO,MAAM,mDAAmD,IAAI,CAAC;AACrE;;GAEG;AACH,eAAO,MAAM,0DAA0D,OAAO,CAAC;AAC/E;;;;;;;GAOG;AACH,eAAO,MAAM,8CAA8C,IAAI,CAAC;AAChE;;GAEG;AACH,eAAO,MAAM,qDAAqD,OAAO,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,oBAAoB,IAAI,CAAC"}

package/dist/witness/space/space-constants.mjs

@@ -0,0 +1,192 @@
+import { GIB } from '@ibgib/ts-gib/dist/V1/index.mjs';
+/**
+ * Zero space is a default space that uses default values that should be
+ * reproducible and not break or something...it's all in flux really.
+ */
+export const ZERO_SPACE_ID = 'zero';
+export const IBGIB_SPACE_NAME_DEFAULT = 'default_space';
+/**
+ * Base directory for all data of the app.
+ */
+export const IBGIB_BASE_SUBPATH = 'ibgib';
+/**
+ * Default space that is also used for bootstrapping.
+ *
+ * The user should provide his/her own space name that will contain their data.
+ * If a custom user space name is not provided, one should be auto-generated.
+ *
+ * ## notes
+ *
+ * * the leading 000's help to put the space earlier in alphabetized listing if viewing through an OS file viewer
+ */
+export const IBGIB_SPACE_SUBPATH_DEFAULT = `000_${IBGIB_SPACE_NAME_DEFAULT}`;
+/**
+ * Subpath for "normal" ibgibs (non-meta, non-dna, non-binary, etc.).
+ */
+export const IBGIB_IBGIBS_SUBPATH = 'ibgibs';
+/**
+ * should contain special-use ibgibs to the application.
+ *
+ * Use case:
+ *   Because some special ibgibs will be changed frequently,
+ *   e.g. settings, a separate folder will be useful.
+ */
+export const IBGIB_META_SUBPATH = 'meta';
+/**
+ * For use with documentation and UX help.
+ *
+ * This is probably scoped to a particular schema...(e.g. v1)
+ */
+export const VALID_SPACE_NAME_EXAMPLES = [
+    'justLetters', 'valid_here', 'hyphens-allowed', '0CanStartOrEndWithNumbers9'
+];
+/**
+ * For use with documentation and UX help.
+ *
+ * This is probably scoped to a particular schema...(e.g. v1)
+ */
+export const INVALID_SPACE_NAME_EXAMPLES = [
+    'IHaveASymbol!', 'invalid hereWithSpace', '-cantStartWithHyphen', '_OrUnderscore'
+];
+/**
+ *
+ */
+export const PERSIST_OPTS_AND_RESULTS_IBGIBS_DEFAULT = false;
+/**
+ * Yep, this one starts with default instead of ending with it.
+ */
+export const DEFAULT_LOCAL_SPACE_DESCRIPTION = `This is a local space. There are many like it, but this one is mine.`;
+/**
+ * The main roots^gib ibgib uses this rel8n name to keep track of roots.
+ */
+export const SPACE_REL8N_NAME = 'space';
+/**
+ * rel8n name in a space ibgib to the config ibgib(s?)
+ */
+export const SPACE_REL8N_NAME_CONFIG = `config`;
+export const SPACE_NAME_REGEXP = /^[a-zA-Z][\w\-]{0,62}[a-zA-Z]$/;
+/**
+ * A spaces ibGib uses this rel8n name for related sync spaces, used
+ * in replicating ibgib spaces.
+ */
+export const SYNC_SPACE_REL8N_NAME = 'syncSpace';
+/**
+ * ...?
+ */
+export const DEFAULT_SPACE_TEXT = 'space';
+/**
+ * Default icon specifically for spaces.
+ */
+export const DEFAULT_SPACE_ICON = 'sparkles-outline';
+/**
+ * Default description specifically for spaces.
+ */
+export const DEFAULT_SPACE_DESCRIPTION = `This is a space ibgib, which is basically a special ibgib who has behavior
+to interface with data stores and/or other space(s) to provide concrete location
+for ibgibs. All ibgibs can have relationships with other ibgibs, but this one
+specifically either implies a physical interface to things like databases,
+file systems, and similar; OR, when this space interfaces with other spaces, this
+is a logical organization of ibgib locations, like when configuring clusters or
+consensus algorithms.`;
+/**
+ * rel8n name used inside the root to those ibgib it contains.
+ *
+ * @example
+ * ```json
+ *  {
+ *      ib: root,
+ *      gib: ABC123,
+ *      data: {...},
+ *      rel8ns: {
+ *          [rel8nName]: ["a^1", "b^2"]
+ *      }
+ *  }
+ * ```
+ */
+export const DEFAULT_SPACE_REL8N_NAME = 'x';
+/**
+ * Interval in ms between polling for updates ("notifications") between local
+ * space (ibgibs service) and dynamo sync space(s), or for use within a single
+ * space for checking its internal state.
+ *
+ * Of course, long polling is very hacky, but so is using DynamoDB in the cloud
+ * for a sync space. Obviously need to progress to a more mature and robust sync
+ * space/outer space architecture.
+ */
+export const DEFAULT_LOCAL_SPACE_POLLING_INTERVAL_MS = 30000;
+export const DEFAULT_LOCAL_SPACE_POLLING_DELAY_FIRST_RUN_MS = 10000;
+/**
+ * {@link DEFAULT_LOCAL_SPACE_POLLING_INTERVAL_MS} but for outer spaces, so
+ * longer interval atow.
+ */
+export const DEFAULT_OUTER_SPACE_POLLING_INTERVAL_MS = 20000;
+/**
+ * Amount of time to delay for FIRST poll execution.
+ */
+export const DEFAULT_OUTER_SPACE_POLLING_DELAY_FIRST_RUN_MS = 10000;
+/**
+ * When a status is first created, this is used to indicate that
+ * the tjp has not been set.
+ */
+export const STATUS_UNDEFINED_TJP_GIB = GIB;
+/**
+ * When a status is first created, this is used to indicate that
+ * the txId has not been set.
+ */
+export const STATUS_UNDEFINED_TX_ID = '0';
+export const SPACE_LOCK_IB_TERM = 'space_lock';
+/**
+ * When attempting to acquire a lock ona  space, and it is already lock, it will
+ * wait a random amount of ms before trying to lock again. This is the default
+ * max amount of ms before reattempting.
+ */
+export const DEFAULT_MAX_DELAY_MS_RETRY_LOCK_ACQUIRE = 100;
+/**
+ * Will retry this many times before giving up...
+ */
+export const DEFAULT_MAX_DELAY_RETRY_LOCK_ACQUIRE_ATTEMPTS = 100;
+/**
+ * We don't want someone locking a space forever by accident.
+ */
+export const MAX_LOCK_SECONDS_VALID = 60 * 2; // two minutes
+/**
+ * Default value for secondsValid when acquiring/releasing lock in/on LOCAL
+ * space.
+ */
+export const DEFAULT_SECONDS_VALID_LOCAL = 2;
+/**
+ * Default value for secondsValid when acquiring/releasing lock in/on
+ * OUTER space, e.g. sync spaces like aws dynamo sync space.
+ */
+export const DEFAULT_SECONDS_VALID_OUTER = 30;
+/**
+ * retry count when calling getDependencyGraph.
+ *
+ * ## driving use case
+ *
+ * dependency graph fails when concurrent merges made in sync space.
+ * need to wait until previous graph merger happens then retry.
+ */
+export const DEFAULT_MAX_RETRIES_GET_DEPENDENCY_GRAPH_OUTERSPACE = 5;
+/**
+ * when getting dependency graph, sometimes we have to wait to retry
+ */
+export const DEFAULT_MS_BETWEEN_RETRIES_GET_DEPENDENCY_GRAPH_OUTERSPACE = 5000;
+/**
+ * retry count when calling getDependencyGraph.
+ *
+ * ## driving use case
+ *
+ * dependency graph fails when concurrent merges made in sync space.
+ * need to wait until previous graph merger happens then retry.
+ */
+export const DEFAULT_MAX_RETRIES_GET_DEPENDENCY_GRAPH_LOCAL = 3;
+/**
+ * when getting dependency graph, sometimes we have to wait to retry
+ */
+export const DEFAULT_MS_BETWEEN_RETRIES_GET_DEPENDENCY_GRAPH_LOCAL = 1000;
+/**
+ * currently not used in ionic-gib.
+ */
+export const DEFAULT_TX_ID_LENGTH = 5;
+//# sourceMappingURL=space-constants.mjs.map

package/dist/witness/space/space-constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"space-constants.mjs","sourceRoot":"","sources":["../../../src/witness/space/space-constants.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC;AAEtD;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC;AAEpC,MAAM,CAAC,MAAM,wBAAwB,GAAG,eAAe,CAAC;AAExD;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,OAAO,CAAC;AAC1C;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,OAAO,wBAAwB,EAAE,CAAC;AAC7E;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAC7C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAEzC;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACrC,aAAa,EAAE,YAAY,EAAE,iBAAiB,EAAE,4BAA4B;CAC/E,CAAC;AACF;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACvC,eAAe,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,eAAe;CACpF,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG,KAAK,CAAC;AAE7D;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,sEAAsE,CAAC;AAEtH;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,OAAO,CAAC;AAExC;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,QAAQ,CAAC;AAChD,MAAM,CAAC,MAAM,iBAAiB,GAAG,gCAAgC,CAAC;AAElE;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,OAAO,CAAC;AAC1C;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,kBAAkB,CAAC;AACrD;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAClC;;;;;;sBAMkB,CAAC;AACvB;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAE5C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG,KAAM,CAAC;AAC9D,MAAM,CAAC,MAAM,8CAA8C,GAAG,KAAM,CAAC;AAErE;;;GAGG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG,KAAM,CAAC;AAC9D;;GAEG;AACH,MAAM,CAAC,MAAM,8CAA8C,GAAG,KAAM,CAAC;AAErE;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAC5C;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAE1C,MAAM,CAAC,MAAM,kBAAkB,GAAG,YAAY,CAAC;AAC/C;;;;GAIG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG,GAAG,CAAC;AAC3D;;GAEG;AACH,MAAM,CAAC,MAAM,6CAA6C,GAAG,GAAG,CAAC;AACjE;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,cAAc;AAC5D;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC;AAC7C;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AAE9C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mDAAmD,GAAG,CAAC,CAAC;AACrE;;GAEG;AACH,MAAM,CAAC,MAAM,0DAA0D,GAAG,IAAI,CAAC;AAC/E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,8CAA8C,GAAG,CAAC,CAAC;AAChE;;GAEG;AACH,MAAM,CAAC,MAAM,qDAAqD,GAAG,IAAI,CAAC;AAE1E;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC"}