oca_package 1.0.7 → 1.1.0

package/dist/cjs/index.js

@@ -3,9 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExtensionContainer = exports.OcaPackage = void 0;
+exports.OcaPackage = void 0;
 var oca_package_js_1 = require("./oca_package.js");
 Object.defineProperty(exports, "OcaPackage", { enumerable: true, get: function () { return __importDefault(oca_package_js_1).default; } });
-var extenstionContainer_js_1 = require("./oca_extensions/state/extenstionContainer.js");
-Object.defineProperty(exports, "ExtensionContainer", { enumerable: true, get: function () { return __importDefault(extenstionContainer_js_1).default; } });
-//# sourceMappingURL=index.js.map

package/dist/cjs/oca_extensions/extensions.js

@@ -3,82 +3,143 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExtensionState = void 0;
-const helpers_js_1 = require("../utils/helpers.js");
+exports.Extension = exports.Overlay = exports.ExtensionState = void 0;
 const ordering_js_1 = __importDefault(require("./state/overlays/ordering.js"));
+const unit_framing_js_1 = __importDefault(require("./state/overlays/framing/unit_framing.js"));
+const helpers_js_1 = require("../utils/helpers.js");
 const saidify_1 = require("saidify");
-// Internal representation of the extension json input
-// From this state, we can generate the extension overlay in any format
+const ADC_COMMUNITY = 'adc';
+const v = '1.0';
 class ExtensionState {
-    constructor(extension_obj) {
-        if (!extension_obj) {
-            throw new Error('Extension object is required');
-        }
-        this._attributes_ordering_arr = this.extractAttributeOrdering(extension_obj);
-        this._entry_code_ordering_arr = this.extractEntryCodeOrdering(extension_obj);
+    constructor(ExtensionInputJson) {
+        this._extension_input_json = ExtensionInputJson;
+        this._extensionState = this.BuildExtensionState();
     }
-    extractAttributeOrdering(extension_obj) {
-        if (extension_obj['ordering_overlay']) {
-            return extension_obj.ordering_overlay?.attribute_ordering;
-        }
-        else {
-            throw new Error('Ordering overlay is required');
+    BuildExtensionState() {
+        let state = {};
+        for (const community in this._extension_input_json.extensions) {
+            const community_extensions = this._extension_input_json.extensions[community];
+            state[community] = {};
+            for (const bundle_digest in community_extensions) {
+                state[community][bundle_digest] = community_extensions[bundle_digest];
+            }
         }
+        return state;
     }
-    extractEntryCodeOrdering(extension_obj) {
-        return extension_obj.ordering_overlay ? extension_obj.ordering_overlay.entry_code_ordering || {} : {};
-    }
-    get attribute_ordering_arr() {
-        return this._attributes_ordering_arr;
-    }
-    get entry_code_ordering_arr() {
-        return this._entry_code_ordering_arr;
+    // TODO: list the overlays
+    get communities() {
+        return this._extensionState;
     }
 }
 exports.ExtensionState = ExtensionState;
-// Generates a serialized extension overlay per OCA bundle
-class Extension {
-    constructor(extension_obj, oca_bundle) {
-        this.d = '';
-        this.type = 'community/adc/extension/1.0';
-        this.bundle_digest = '';
-        this.overlays = {};
-        if (!extension_obj || !oca_bundle) {
-            throw new Error('Extension object and OCA bundle are required');
+class Overlay {
+    constructor(community_overlay) {
+        this._overlay = community_overlay;
+    }
+    GenerateOverlay() {
+        const overlay = {};
+        for (const ov_type in this._overlay) {
+            if (ov_type === 'ordering_overlay') {
+                const ordering_instance = new ordering_js_1.default(this._overlay);
+                const ordering_ov = ordering_instance.GenerateOverlay();
+                overlay['ordering'] = JSON.parse(ordering_ov);
+            }
+            else if (ov_type === 'unit_framing_overlay') {
+                const unit_framing_instance = new unit_framing_js_1.default(this._overlay);
+                const unit_framing_ov = unit_framing_instance.GenerateOverlay();
+                overlay['unit_framing'] = JSON.parse(unit_framing_ov);
+            }
+            else {
+                throw new Error('Invalid overlay name');
+            }
         }
-        this.extensionState = new ExtensionState(extension_obj);
-        this.oca_bundle = oca_bundle;
-        this.overlays = this.generateOverlays();
+        return overlay;
     }
-    generateOverlays() {
+}
+exports.Overlay = Overlay;
+class ADCOverlayStrategy {
+    GenerateOverlay(extensions) {
         const overlays = {};
-        try {
-            if (this.extensionState.attribute_ordering_arr) {
-                const ordering = new ordering_js_1.default(this.extensionState, this.oca_bundle);
-                overlays['ordering'] = JSON.parse(ordering.generateOverlay());
+        for (const extKey in extensions) {
+            const ext = extensions[extKey];
+            const overlay_instance = new Overlay(ext);
+            const generated_overlay = overlay_instance.GenerateOverlay();
+            for (const overlay_type in generated_overlay) {
+                overlays[overlay_type] = generated_overlay[overlay_type];
             }
         }
-        catch (error) {
-            console.error('Error generating overlays:', error);
-        }
         return overlays;
     }
+}
+// To implement overlays for external communities, create a new class that implements the OverlayStrategy interface.
+// For example, if you have a community called "external_community", you can create a class like this:
+class DefaultOverlayStrategy {
+    GenerateOverlay(extensions) {
+        throw new Error('Unsupported community type');
+    }
+}
+class Extension {
+    constructor(_extensions_input, community) {
+        this.d = '';
+        this.overlays = {};
+        if (!_extensions_input || !community) {
+            throw new Error('extension array is required from extension state and community is required');
+        }
+        this._community = community;
+        this._exensions = _extensions_input;
+        this.type = `community/${this._community}/extension/${v}`;
+    }
+    GenerateOverlays() {
+        const strategy = this._community === ADC_COMMUNITY ? new ADCOverlayStrategy() : new DefaultOverlayStrategy();
+        return strategy.GenerateOverlay(this._exensions);
+    }
     toJSON() {
-        const oca_bundle_digest = (0, helpers_js_1.ocabundleDigest)(this.oca_bundle);
         return {
             d: '',
-            type: 'community/adc/extension/1.0',
-            bundle_digest: oca_bundle_digest,
-            overlays: this.overlays,
+            type: `community/${this._community}/extension/1.0`,
+            overlays: this.GenerateOverlays(),
         };
     }
-    saidifying() {
+    Saidifying() {
         const [, sad] = (0, saidify_1.saidify)(this.toJSON());
         return sad;
     }
-    generateExtension() {
-        return JSON.stringify(this.saidifying());
+    GenerateExtension() {
+        return this.Saidifying();
+    }
+}
+exports.Extension = Extension;
+class ExtensionBox {
+    constructor(extension_input_json, oca_bundle) {
+        this._extensions_box = {};
+        this._oca_bundle = oca_bundle;
+        this._extensionState = new ExtensionState(extension_input_json);
+    }
+    get buildExtensionsBox() {
+        const extensionsBox = {};
+        const extensionState_communities = this._extensionState.communities;
+        for (const community in extensionState_communities) {
+            extensionsBox[community] = {};
+            const current_community = extensionState_communities[community];
+            for (const bundle_digest in current_community) {
+                if (bundle_digest === (0, helpers_js_1.ocabundleDigest)(this._oca_bundle)) {
+                    const capture_base_digest = (0, helpers_js_1.getDigest)(this._oca_bundle);
+                    const community_extension_input = extensionState_communities[community][bundle_digest];
+                    const extension = new Extension(community_extension_input, community);
+                    extensionsBox[community][capture_base_digest] = extension.GenerateExtension();
+                }
+                else if (bundle_digest !== (0, helpers_js_1.ocabundleDigest)(this._oca_bundle)) {
+                    if ((0, helpers_js_1.isOcaBundleWithDeps)(this._oca_bundle)) {
+                        const current_bundle = (0, helpers_js_1.getOcaBundleFromDeps)(this._oca_bundle, bundle_digest);
+                        const capture_base_digest = (0, helpers_js_1.getDigest)(current_bundle);
+                        const community_extension_input = extensionState_communities[community][bundle_digest];
+                        const extension = new Extension(community_extension_input, community);
+                        extensionsBox[community][capture_base_digest] = extension.GenerateExtension();
+                    }
+                }
+            }
+        }
+        return extensionsBox;
     }
 }
-exports.default = Extension;
-//# sourceMappingURL=extensions.js.map
+exports.default = ExtensionBox;

package/dist/cjs/oca_extensions/state/attribute.js

@@ -10,4 +10,3 @@ class Attribute {
     }
 }
 exports.default = Attribute;
-//# sourceMappingURL=attribute.js.map

package/dist/cjs/oca_extensions/state/overlays/framing/attribute_framing.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const saidify_1 = require("saidify");
+class AttributeFraming {
+    constructor(dynOverlay) {
+        if (!dynOverlay) {
+            throw new Error('a dynamic extension overlay are required');
+        }
+        this.dynOverlay = dynOverlay;
+    }
+    GetAttributeFraming() {
+        return this.dynOverlay.attribute_framing_overlay.attributes;
+    }
+    GetId() {
+        return this.dynOverlay.attribute_framing_overlay.properties.id;
+    }
+    GetLabel() {
+        return this.dynOverlay.attribute_framing_overlay.properties.label;
+    }
+    GetLocation() {
+        return this.dynOverlay.attribute_framing_overlay.properties.location;
+    }
+    GetVersion() {
+        return this.dynOverlay.attribute_framing_overlay.properties.version;
+    }
+    toJSON() {
+        return {
+            d: '',
+            type: 'community/overlays/adc/attribute_framing/1.1',
+            framing_metadata: {
+                id: this.GetId(),
+                label: this.GetLabel(),
+                location: this.GetLocation(),
+                version: this.GetVersion(),
+            },
+            attribute_framing: this.GetAttributeFraming(),
+        };
+    }
+    Saidifying() {
+        const [, sad] = (0, saidify_1.saidify)(this.toJSON());
+        return sad;
+    }
+    GenerateOverlay() {
+        return JSON.stringify(this.Saidifying());
+    }
+}
+exports.default = AttributeFraming;

package/dist/cjs/oca_extensions/state/overlays/framing/entry_code_framing.js

@@ -0,0 +1 @@
+"use strict";

package/dist/cjs/oca_extensions/state/overlays/framing/unit_framing.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const saidify_1 = require("saidify");
+class UnitFraming {
+    constructor(dynOverlay) {
+        if (!dynOverlay) {
+            throw new Error('a dynamic extension overlay are required');
+        }
+        this.dynOverlay = dynOverlay;
+    }
+    GetUnits() {
+        return this.dynOverlay.unit_framing_overlay.units;
+    }
+    GetId() {
+        return this.dynOverlay.unit_framing_overlay.properties.id;
+    }
+    GetLabel() {
+        return this.dynOverlay.unit_framing_overlay.properties.label;
+    }
+    GetLocation() {
+        return this.dynOverlay.unit_framing_overlay.properties.location;
+    }
+    GetVersion() {
+        return this.dynOverlay.unit_framing_overlay.properties.version;
+    }
+    toJSON() {
+        return {
+            d: '',
+            type: 'community/overlays/adc/unit_framing/1.1',
+            framing_metadata: {
+                id: this.GetId(),
+                label: this.GetLabel(),
+                location: this.GetLocation(),
+                version: this.GetVersion(),
+            },
+            units: this.GetUnits(),
+        };
+    }
+    Saidifying() {
+        const [, sad] = (0, saidify_1.saidify)(this.toJSON());
+        return sad;
+    }
+    GenerateOverlay() {
+        return JSON.stringify(this.Saidifying());
+    }
+}
+exports.default = UnitFraming;

package/dist/cjs/oca_extensions/state/overlays/ordering.js

@@ -1,38 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const helpers_js_1 = require("../../../utils/helpers.js");
 const saidify_1 = require("saidify");
 class Ordering {
-    constructor(extensionState, oca_bundle) {
-        if (!oca_bundle || !extensionState) {
-            throw new Error('OCA bundle and ExtensionState are required');
+    constructor(dynOverlay) {
+        if (!dynOverlay) {
+            throw new Error('a dynamic extension overlay are required');
         }
-        this.oca_bundle = oca_bundle;
-        this.extensionState = extensionState;
-        this.ordering_overlay = this.getAttributeOrdering();
+        this.dynOverlay = dynOverlay;
     }
-    getAttributeOrdering() {
-        return this.extensionState.attribute_ordering_arr;
+    GetAttributeOrdering() {
+        return this.dynOverlay.ordering_overlay.attribute_ordering;
     }
-    getEntryCodeOrdering() {
-        return this.extensionState.entry_code_ordering_arr;
+    GetEntryCodeOrdering() {
+        return this.dynOverlay.ordering_overlay.entry_code_ordering;
     }
     toJSON() {
         return {
             d: '',
             type: 'community/overlays/adc/ordering/1.1',
-            capture_base: (0, helpers_js_1.getDigest)(this.oca_bundle),
-            attribute_ordering: this.getAttributeOrdering(),
-            entry_code_ordering: this.getEntryCodeOrdering(),
+            attribute_ordering: this.GetAttributeOrdering(),
+            entry_code_ordering: this.GetEntryCodeOrdering(),
         };
     }
-    saidifying() {
+    Saidifying() {
         const [, sad] = (0, saidify_1.saidify)(this.toJSON());
         return sad;
     }
-    generateOverlay() {
-        return JSON.stringify(this.saidifying());
+    GenerateOverlay() {
+        return JSON.stringify(this.Saidifying());
     }
 }
 exports.default = Ordering;
-//# sourceMappingURL=ordering.js.map

package/dist/cjs/oca_extensions/state/overlays/separator.js

@@ -87,4 +87,3 @@ class Separator {
     }
 }
 exports.default = Separator;
-//# sourceMappingURL=separator.js.map

package/dist/cjs/oca_package.js

@@ -3,39 +3,36 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const extenstionContainer_js_1 = __importDefault(require("./oca_extensions/state/extenstionContainer.js"));
+const extensions_js_1 = __importDefault(require("./oca_extensions/extensions.js"));
 const saidify_1 = require("saidify");
 class OcaPackage {
-    constructor(extension_input, oca_bundle) {
-        this.extensions = new extenstionContainer_js_1.default();
-        this.extension_input = extension_input;
+    constructor(extension_input_json, oca_bundle) {
+        this.extensions_box = new extensions_js_1.default(extension_input_json, oca_bundle);
         this.oca_bundle = oca_bundle;
     }
-    saidifying() {
+    Saidifying() {
         const [, sad] = (0, saidify_1.saidify)(this.toJSON());
-        return JSON.stringify(sad);
+        return sad;
     }
-    said() {
+    Said() {
         const [said] = (0, saidify_1.saidify)(this.toJSON());
         return said;
     }
     toJSON() {
         try {
-            const extension_container = this.extensions.generate_extensions(this.extension_input, this.oca_bundle);
             return {
                 d: '',
                 type: 'oca_package/1.0',
                 oca_bundle: this.oca_bundle,
-                extensions: extension_container,
+                extensions: this.extensions_box.buildExtensionsBox,
             };
         }
         catch (error) {
             throw new Error(`Failed to parse Extension JSON: ${error}`);
         }
     }
-    generateOcaPackage() {
-        return this.saidifying();
+    GenerateOcaPackage() {
+        return JSON.stringify(this.Saidifying());
     }
 }
 exports.default = OcaPackage;
-//# sourceMappingURL=oca_package.js.map

package/dist/cjs/types/types.js

@@ -7,4 +7,3 @@ var OverlayTypes;
     OverlayTypes["Separator"] = "separator";
     OverlayTypes["Example"] = "example";
 })(OverlayTypes || (exports.OverlayTypes = OverlayTypes = {}));
-//# sourceMappingURL=types.js.map

package/dist/cjs/utils/helpers.js

@@ -1,17 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ocabundleDigest = exports.getDigest = exports.isPresent = exports.getCaptureBase = void 0;
+exports.getOcaBundleFromDeps = exports.isOcaBundleWithDeps = exports.isSaid = exports.ocabundleDigest = exports.getDigest = exports.isPresent = exports.getCaptureBase = void 0;
 // Get capture base from the OCA bundle
 const getCaptureBase = (oca_bundle) => {
     try {
         if (!oca_bundle) {
             throw new Error('OCA bundle is undefined or null.');
         }
-        if (!oca_bundle.bundle) {
-            throw new Error('OCA bundle does not contain a bundle property.');
-        }
-        if (!oca_bundle.bundle.capture_base) {
-            throw new Error('OCA bundle does not contain a capture_base property.');
+        if (!oca_bundle.bundle && oca_bundle.capture_base) {
+            return oca_bundle.capture_base;
         }
         return oca_bundle.bundle.capture_base;
     }
@@ -51,7 +48,7 @@ exports.getDigest = getDigest;
 // Get oca bundle digest
 const ocabundleDigest = (oca_bundle) => {
     try {
-        const oca_bundle_d = oca_bundle.bundle.d;
+        const oca_bundle_d = oca_bundle.bundle?.d !== undefined ? oca_bundle.bundle.d : oca_bundle.d;
         return oca_bundle_d;
     }
     catch (error) {
@@ -60,4 +57,43 @@ const ocabundleDigest = (oca_bundle) => {
     }
 };
 exports.ocabundleDigest = ocabundleDigest;
-//# sourceMappingURL=helpers.js.map
+const isSaid = (value) => {
+    return typeof value === 'string' && value.length == 44;
+};
+exports.isSaid = isSaid;
+// Handling oca bundle with dependencies
+const isOcaBundleWithDeps = (oca_bundle) => {
+    try {
+        if (!oca_bundle) {
+            throw new Error('OCA bundle is undefined or null.');
+        }
+        if (!oca_bundle.dependencies || oca_bundle.dependencies.length === 0) {
+            return false;
+        }
+        return true;
+    }
+    catch (error) {
+        console.error('Error in checking oca bundle with dependencies:', error);
+        throw new Error(`Failed to check if the OCA bundle has dependencies: ${error.message}`);
+    }
+};
+exports.isOcaBundleWithDeps = isOcaBundleWithDeps;
+// Get corresponding oca bundle from oca bundle with dependencies
+const getOcaBundleFromDeps = (oca_bundle, digest) => {
+    try {
+        if (!(0, exports.isOcaBundleWithDeps)(oca_bundle)) {
+            throw new Error('OCA bundle does not have dependencies.');
+        }
+        const dependencies = oca_bundle['dependencies'];
+        for (const dep in dependencies) {
+            if ((0, exports.isSaid)(digest) && dependencies[dep].d === digest) {
+                return dependencies[dep];
+            }
+        }
+    }
+    catch (error) {
+        console.error('Error in getting oca bundle from dependencies:', error);
+        throw new Error(`Failed to get the OCA bundle from dependencies: ${error.message}`);
+    }
+};
+exports.getOcaBundleFromDeps = getOcaBundleFromDeps;

package/dist/esm/index.js

@@ -1,3 +1 @@
 export { default as OcaPackage } from './oca_package.js';
-export { default as ExtensionContainer } from './oca_extensions/state/extenstionContainer.js';
-//# sourceMappingURL=index.js.map