manyfest 1.0.42 → 1.0.44

package/types/Manyfest-ObjectAddress-SetValue.d.ts

@@ -18,10 +18,23 @@ export = ManyfestObjectAddressSetValue;
 * @class ManyfestObjectAddressSetValue
 */
 declare class ManyfestObjectAddressSetValue {
-    constructor(pInfoLog: any, pErrorLog: any);
-    logInfo: any;
-    logError: any;
-    cleanWrapCharacters: (pCharacter: any, pString: any) => any;
-    setValueAtAddress(pObject: any, pAddress: any, pValue: any): any;
+    /**
+     * @param {function} [pInfoLog] - (optional) A logging function for info messages
+     * @param {function} [pErrorLog] - (optional) A logging function for error messages
+     */
+    constructor(pInfoLog?: Function, pErrorLog?: Function);
+    logInfo: Function;
+    logError: Function;
+    cleanWrapCharacters: (pCharacter: string, pString: string) => string;
+    /**
+     * Set the value of an element at an address
+     *
+     * @param {object} pObject - The object to set the value in
+     * @param {string} pAddress - The address to set the value at
+     * @param {any} pValue - The value to set at the address
+     *
+     * @return {boolean} True if the value was set, false otherwise
+     */
+    setValueAtAddress(pObject: object, pAddress: string, pValue: any): boolean;
 }
 //# sourceMappingURL=Manyfest-ObjectAddress-SetValue.d.ts.map

package/types/Manyfest-ObjectAddress-SetValue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Manyfest-ObjectAddress-SetValue.d.ts","sourceRoot":"","sources":["../source/Manyfest-ObjectAddress-SetValue.js"],"names":[],"mappings":";AAMA;;;;;;;;;;;;;;;;;EAiBE;AACF;IAEC,2CAOC;IAJA,aAAyE;IACzE,cAA4E;IAE5E,4DAA+C;IAIhD,iEAgOC;CACD"}
+{"version":3,"file":"Manyfest-ObjectAddress-SetValue.d.ts","sourceRoot":"","sources":["../source/Manyfest-ObjectAddress-SetValue.js"],"names":[],"mappings":";AAMA;;;;;;;;;;;;;;;;;EAiBE;AACF;IAEC;;;OAGG;IACH,uDAOC;IAJA,kBAAyE;IACzE,mBAA4E;IAE5E,qEAA+C;IAGhD;;;;;;;;OAQG;IACH,2BANW,MAAM,YACN,MAAM,UACN,GAAG,GAEF,OAAO,CAkOlB;CACD"}

package/types/Manyfest-ObjectAddressGeneration.d.ts

@@ -22,9 +22,30 @@ export = ManyfestObjectAddressGeneration;
 * @class ManyfestObjectAddressGeneration
 */
 declare class ManyfestObjectAddressGeneration {
-    constructor(pInfoLog: any, pErrorLog: any);
-    logInfo: any;
-    logError: any;
-    generateAddressses(pObject: any, pBaseAddress: any, pSchema: any): any;
+    /**
+     * @param {function} [pInfoLog] - (optional) A logging function for info messages
+     * @param {function} [pErrorLog] - (optional) A logging function for error messages
+     */
+    constructor(pInfoLog?: Function, pErrorLog?: Function);
+    logInfo: Function;
+    logError: Function;
+    /**
+     * generateAddressses
+     *
+     * This flattens an object into a set of key:value pairs for *EVERY SINGLE
+     * POSSIBLE ADDRESS* in the object.  It can get ... really insane really
+     * quickly.  This is not meant to be used directly to generate schemas, but
+     * instead as a starting point for scripts or UIs.
+     *
+     * This will return a mega set of key:value pairs with all possible schema
+     * permutations and default values (when not an object) and everything else.
+     *
+     * @param {any} pObject - The object to generate addresses for
+     * @param {string} [pBaseAddress] - (optional) The base address to start from
+     * @param {object} [pSchema] - (optional) The schema object to append to
+     *
+     * @return {object} The generated schema object
+     */
+    generateAddressses(pObject: any, pBaseAddress?: string, pSchema?: object): object;
 }
 //# sourceMappingURL=Manyfest-ObjectAddressGeneration.d.ts.map

package/types/Manyfest-ObjectAddressGeneration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Manyfest-ObjectAddressGeneration.d.ts","sourceRoot":"","sources":["../source/Manyfest-ObjectAddressGeneration.js"],"names":[],"mappings":";AAKA;;;;;;;;;;;;;;;;;;;;;EAqBE;AACF;IAEC,2CAKC;IAFA,aAAyE;IACzE,cAA4E;IAY7E,uEA+EC;CACD"}
+{"version":3,"file":"Manyfest-ObjectAddressGeneration.d.ts","sourceRoot":"","sources":["../source/Manyfest-ObjectAddressGeneration.js"],"names":[],"mappings":";AAKA;;;;;;;;;;;;;;;;;;;;;EAqBE;AACF;IAEC;;;OAGG;IACH,uDAKC;IAFA,kBAAyE;IACzE,mBAA4E;IAG7E;;;;;;;;;;;;;;;;OAgBG;IACH,4BANW,GAAG,iBACH,MAAM,YACN,MAAM,GAEL,MAAM,CAgFjB;CACD"}

package/types/Manyfest-SchemaManipulation.d.ts

@@ -5,11 +5,52 @@ export = ManyfestSchemaManipulation;
 * @class ManyfestSchemaManipulation
 */
 declare class ManyfestSchemaManipulation {
-    constructor(pInfoLog: any, pErrorLog: any);
-    logInfo: any;
-    logError: any;
-    resolveAddressMappings(pManyfestSchemaDescriptors: any, pAddressMapping: any): boolean;
-    safeResolveAddressMappings(pManyfestSchemaDescriptors: any, pAddressMapping: any): any;
-    mergeAddressMappings(pManyfestSchemaDescriptorsDestination: any, pManyfestSchemaDescriptorsSource: any): any;
+    /**
+     * @param {function} [pInfoLog] - (optional) A logging function for info messages
+     * @param {function} [pErrorLog] - (optional) A logging function for error messages
+     */
+    constructor(pInfoLog?: Function, pErrorLog?: Function);
+    logInfo: Function;
+    logError: Function;
+    /**
+     * This translates the default address mappings to something different.
+     *
+     * For instance you can pass in manyfest schema descriptor object:
+     * 	{
+     *	  "Address.Of.a": { "Hash": "a", "Type": "Number" },
+     *	  "Address.Of.b": { "Hash": "b", "Type": "Number" }
+     *  }
+     *
+     *
+     * And then an address mapping (basically a Hash->Address map)
+     *  {
+     *    "a": "New.Address.Of.a",
+     *    "b": "New.Address.Of.b"
+     *  }
+     *
+     * NOTE: This mutates the schema object permanently, altering the base hash.
+     *       If there is a collision with an existing address, it can lead to overwrites.
+     * TODO: Discuss what should happen on collisions.
+     *
+     * @param {object} pManyfestSchemaDescriptors - The manyfest schema descriptors to resolve address mappings for
+     * @param {object} pAddressMapping - The address mapping object to use for remapping
+     *
+     * @return {boolean} True if successful, false if there was an error
+     */
+    resolveAddressMappings(pManyfestSchemaDescriptors: object, pAddressMapping: object): boolean;
+    /**
+     * @param {object} pManyfestSchemaDescriptors - The manyfest schema descriptors to resolve address mappings for
+     * @param {object} pAddressMapping - The address mapping object to use for remapping
+     *
+     * @return {object} A new object containing the remapped schema descriptors
+     */
+    safeResolveAddressMappings(pManyfestSchemaDescriptors: object, pAddressMapping: object): object;
+    /**
+     * @param {object} pManyfestSchemaDescriptorsDestination - The destination manyfest schema descriptors
+     * @param {object} pManyfestSchemaDescriptorsSource - The source manyfest schema descriptors
+     *
+     * @return {object} A new object containing the merged schema descriptors
+     */
+    mergeAddressMappings(pManyfestSchemaDescriptorsDestination: object, pManyfestSchemaDescriptorsSource: object): object;
 }
 //# sourceMappingURL=Manyfest-SchemaManipulation.d.ts.map

package/types/Manyfest-SchemaManipulation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Manyfest-SchemaManipulation.d.ts","sourceRoot":"","sources":["../source/Manyfest-SchemaManipulation.js"],"names":[],"mappings":";AAKA;;;;EAIE;AACF;IAEC,2CAKC;IAFA,aAA0E;IAC1E,cAA6E;IAqB9E,uFA8DC;IAED,uFAMC;IAED,6GAwBC;CACD"}
+{"version":3,"file":"Manyfest-SchemaManipulation.d.ts","sourceRoot":"","sources":["../source/Manyfest-SchemaManipulation.js"],"names":[],"mappings":";AAKA;;;;EAIE;AACF;IAEC;;;OAGG;IACH,uDAKC;IAFA,kBAA0E;IAC1E,mBAA6E;IAG9E;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,mDALW,MAAM,mBACN,MAAM,GAEL,OAAO,CAgElB;IAED;;;;;OAKG;IACH,uDALW,MAAM,mBACN,MAAM,GAEL,MAAM,CAQjB;IAED;;;;;OAKG;IACH,4DALW,MAAM,oCACN,MAAM,GAEL,MAAM,CA0BjB;CACD"}

package/types/Manyfest.d.ts

@@ -17,8 +17,14 @@ export = Manyfest;
 */
 declare class Manyfest {
     constructor(pFable: any, pManifest: any, pServiceHash: any);
+    /** @type {import('fable')} */
+    fable: any;
     /** @type {Record<string, any>} */
     options: Record<string, any>;
+    /** @type {string} */
+    Hash: string;
+    /** @type {string} */
+    UUID: string;
     serviceType: string;
     logInfo: (pLogLine: any, pLogObject: any) => void;
     logError: (pLogLine: any, pLogObject: any) => void;
@@ -26,10 +32,14 @@ declare class Manyfest {
     objectAddressGetValue: libObjectAddressGetValue;
     objectAddressSetValue: libObjectAddressSetValue;
     objectAddressDeleteValue: libObjectAddressDeleteValue;
-    scope: any;
-    elementAddresses: any[];
-    elementHashes: {};
-    elementDescriptors: {};
+    /** @type {string} */
+    scope: string;
+    /** @type {Array<string>} */
+    elementAddresses: Array<string>;
+    /** @type {Record<string, string>} */
+    elementHashes: Record<string, string>;
+    /** @type {Record<string, ManifestDescriptor>} */
+    elementDescriptors: Record<string, ManifestDescriptor>;
     schemaManipulations: libSchemaManipulation;
     objectAddressGeneration: libObjectAddressGeneration;
     hashTranslations: libHashTranslation;
@@ -39,13 +49,26 @@ declare class Manyfest {
      */
     reset(): void;
     clone(): import("./Manyfest.js");
-    deserialize(pManifestString: any): void;
+    /**
+     * @param {string} pManifestString - The manifest string to deserialize
+     *
+     * @return {Manyfest} The deserialized manifest
+     */
+    deserialize(pManifestString: string): Manyfest;
     loadManifest(pManifest: any): void;
+    /**
+     * Serialize the Manifest to a string
+     *
+     * @return {string} - The serialized manifest
+     */
     serialize(): string;
+    /**
+     * @return {{ Scope: string, Descriptors: Record<string, ManifestDescriptor>, HashTranslations: Record<string, string> }} - A copy of the manifest state.
+     */
     getManifest(): {
-        Scope: any;
-        Descriptors: any;
-        HashTranslations: any;
+        Scope: string;
+        Descriptors: Record<string, ManifestDescriptor>;
+        HashTranslations: Record<string, string>;
     };
     /**
      * Add a descriptor to the manifest
@@ -74,14 +97,14 @@ declare class Manyfest {
     /*************************************************************************
      * Beginning of Object Manipulation (read & write) Functions
      */
-    checkAddressExistsByHash(pObject: any, pHash: any): any;
-    checkAddressExists(pObject: any, pAddress: any): any;
+    checkAddressExistsByHash(pObject: any, pHash: any): boolean;
+    checkAddressExists(pObject: any, pAddress: any): boolean;
     resolveHashAddress(pHash: any): any;
     getValueByHash(pObject: any, pHash: any): any;
     lintAddress(pAddress: any): any;
     getValueAtAddress(pObject: any, pAddress: any): any;
-    setValueByHash(pObject: any, pHash: any, pValue: any): any;
-    setValueAtAddress(pObject: any, pAddress: any, pValue: any): any;
+    setValueByHash(pObject: any, pHash: any, pValue: any): boolean;
+    setValueAtAddress(pObject: any, pAddress: any, pValue: any): boolean;
     deleteValueByHash(pObject: any, pHash: any, pValue: any): any;
     deleteValueAtAddress(pObject: any, pAddress: any, pValue: any): any;
     validate(pObject: any): {

package/types/Manyfest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Manyfest.d.ts","sourceRoot":"","sources":["../source/Manyfest.js"],"names":[],"mappings":";AAiBA;;;;;;;;;;GAUG;AAEH;;;;EAIE;AACF;IAEC,4DAkEC;IAvDA,kCAAkC;IAClC,SADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAClB;IAEN,oBAA6B;IAGnC,kDAA2B;IAC3B,mDAA4B;IAG5B,oEAA0G;IAC1G,gDAAsF;IACtF,gDAAsF;IACtF,sDAA4F;IAwB5F,WAAsB;IACtB,wBAAiC;IACjC,kBAA8B;IAC9B,uBAAmC;IASnC,2CAAiF;IACjF,oDAA0F;IAE1F,qCAA2E;IAE3E,oBAA8D;IAG/D;;OAEG;IAGH,cAMC;IAED,iCAWC;IAGD,wCAIC;IAGD,mCAiEC;IAGD,oBAGC;IAED;;;;MAQC;IAED;;;;;OAKG;IACH,wBAHW,MAAM,eACN,kBAAkB,WAyC5B;IAED;;;;OAIG;IACH,2BAJW,MAAM,GAEL,kBAAkB,CAK7B;IAED;;;;OAIG;IACH,wBAJW,MAAM,GAEL,kBAAkB,CAK7B;IAED;;;OAGG;IACH,wBAFW,CAAC,CAAC,EAAE,kBAAkB,KAAK,IAAI,QAUzC;IAED;;OAEG;IAEH,wDAGC;IAGD,qDAGC;IAGD,oCA8BC;IAGD,8CAWC;IAED,gCAcC;IAGD,oDAiBC;IAGD,2DAGC;IAGD,iEAIC;IAGD,8DAGC;IAGD,oEAIC;IAGD;;;;MAiHC;IAED;;;;OAIG;IACH,6BAFW,kBAAkB,OA4B5B;IAGD,+DAQC;IAID,2EA0BC;CACD;;;;;;;;;;;0BArlBY;IACR,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACzB,CAAK,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB"}
+{"version":3,"file":"Manyfest.d.ts","sourceRoot":"","sources":["../source/Manyfest.js"],"names":[],"mappings":";AAiBA;;;;;;;;;;GAUG;AAEH;;;;EAIE;AACF;IAEC,4DA4EC;IAjEA,8BAA8B;IAC9B,WAAU;IACV,kCAAkC;IAClC,SADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAClB;IACZ,qBAAqB;IACrB,MADW,MAAM,CACR;IACT,qBAAqB;IACrB,MADW,MAAM,CACR;IAEH,oBAA6B;IAGnC,kDAA2B;IAC3B,mDAA4B;IAG5B,oEAA0G;IAC1G,gDAAsF;IACtF,gDAAsF;IACtF,sDAA4F;IAwB5F,qBAAqB;IACrB,OADW,MAAM,CACK;IACtB,4BAA4B;IAC5B,kBADW,KAAK,CAAC,MAAM,CAAC,CACS;IACjC,qCAAqC;IACrC,eADW,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CACH;IAC9B,iDAAiD;IACjD,oBADW,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CACV;IASnC,2CAAiF;IACjF,oDAA0F;IAE1F,qCAA2E;IAE3E,oBAA8D;IAG/D;;OAEG;IAGH,cAMC;IAED,iCA6BC;IAGD;;;;OAIG;IACH,6BAJW,MAAM,GAEL,QAAQ,CAOnB;IAGD,mCAkEC;IAED;;;;OAIG;IACH,aAFY,MAAM,CAKjB;IAED;;OAEG;IACH,eAFY;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAUvH;IAED;;;;;OAKG;IACH,wBAHW,MAAM,eACN,kBAAkB,WAyC5B;IAED;;;;OAIG;IACH,2BAJW,MAAM,GAEL,kBAAkB,CAK7B;IAED;;;;OAIG;IACH,wBAJW,MAAM,GAEL,kBAAkB,CAK7B;IAED;;;OAGG;IACH,wBAFW,CAAC,CAAC,EAAE,kBAAkB,KAAK,IAAI,QAUzC;IAED;;OAEG;IAEH,4DAGC;IAGD,yDAGC;IAGD,oCA8BC;IAGD,8CAWC;IAED,gCAcC;IAGD,oDAiBC;IAGD,+DAGC;IAGD,qEAIC;IAGD,8DAGC;IAGD,oEAIC;IAGD;;;;MAiHC;IAED;;;;OAIG;IACH,6BAFW,kBAAkB,OA4B5B;IAGD,+DAQC;IAID,2EA0BC;CACD;;;;;;;;;;;0BA/nBY;IACR,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACzB,CAAK,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB"}