oca_package 1.2.0 → 1.2.1

package/dist/cjs/oca_extensions/extensions.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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 example_js_1 = __importDefault(require("./state/overlays/example.js"));
 const range_js_1 = __importDefault(require("./state/overlays/range.js"));
 const helpers_js_1 = require("../utils/helpers.js");
 const saidify_1 = require("saidify");
@@ -41,21 +42,26 @@ class Overlay {
         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_instance = new ordering_js_1.default(this._overlay.ordering_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_instance = new unit_framing_js_1.default(this._overlay.unit_framing_overlay);
                 const unit_framing_ov = unit_framing_instance.GenerateOverlay();
                 overlay['unit_framing'] = JSON.parse(unit_framing_ov);
             }
             else if (ov_type === 'range_overlay') {
-                const range_instance = new range_js_1.default(this._overlay);
+                const range_instance = new range_js_1.default(this._overlay.range_overlay);
                 const range_ov = range_instance.GenerateOverlay();
                 overlay['range'] = JSON.parse(range_ov);
             }
+            else if (ov_type === 'example_overlay') {
+                const example_ov = example_js_1.default.GenerateOverlay(this._overlay.example_overlay);
+                overlay['example'] = JSON.parse(example_ov);
+            }
             else {
+                // throwing an error as all extension overlays authored by adc should be handled by the overlay class
                 throw new Error('Invalid overlay name');
             }
         }
@@ -80,7 +86,7 @@ class ADCOverlayStrategy {
 // 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) {
+    GenerateOverlay(_extensions) {
         throw new Error('Unsupported community type');
     }
 }

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

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const saidify_1 = require("saidify");
+const canonical_js_1 = __importDefault(require("../../../utils/canonical.js"));
+class ExampleOverlay {
+    constructor(dynOverlay) {
+        if (!dynOverlay) {
+            throw new Error('A dynamic extension overlay is required');
+        }
+        this.dynOverlay = dynOverlay;
+    }
+    get language() {
+        return this.dynOverlay.language;
+    }
+    GetAttributeExamples() {
+        const examples = this.dynOverlay.attribute_examples;
+        const canonicalizedExamples = (0, canonical_js_1.default)(examples);
+        const sortedExamples = JSON.parse(canonicalizedExamples);
+        return sortedExamples;
+    }
+    toJSON() {
+        return {
+            d: '',
+            type: 'community/overlays/adc/example/1.1',
+            language: this.language,
+            attribute_examples: this.GetAttributeExamples(),
+        };
+    }
+    Saidifying() {
+        const [, sad] = (0, saidify_1.saidify)(this.toJSON());
+        return sad;
+    }
+    // generates a single example overlay
+    GenerateExampleOverlay() {
+        return JSON.stringify(this.Saidifying());
+    }
+    static GenerateOverlay(dynOverlay) {
+        if (!dynOverlay || typeof dynOverlay !== 'object' || !Array.isArray(dynOverlay['example_overlays'])) {
+            throw new Error('Invalid dynOverlay structure. Expected an object with an "example_overlays" array.');
+        }
+        const example_overlays = [];
+        const overlays = dynOverlay['example_overlays'];
+        for (let example_ov of overlays) {
+            try {
+                const example_overlay = new ExampleOverlay(example_ov);
+                example_overlays.push(JSON.parse(example_overlay.GenerateExampleOverlay()));
+            }
+            catch (error) {
+                console.error('Failed to process example overlay:', error);
+            }
+        }
+        example_overlays.sort((a, b) => a.language.localeCompare(b.language));
+        return JSON.stringify(example_overlays);
+    }
+}
+exports.default = ExampleOverlay;

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

@@ -13,22 +13,22 @@ class UnitFraming {
         this.dynOverlay = dynOverlay;
     }
     GetUnits() {
-        const units = this.dynOverlay.unit_framing_overlay.units;
+        const units = this.dynOverlay.units;
         const canonicalizedUnits = (0, canonical_js_1.default)(units);
         const sortedUnits = JSON.parse(canonicalizedUnits);
         return sortedUnits;
     }
     GetId() {
-        return this.dynOverlay.unit_framing_overlay.properties.id;
+        return this.dynOverlay.properties.id;
     }
     GetLabel() {
-        return this.dynOverlay.unit_framing_overlay.properties.label;
+        return this.dynOverlay.properties.label;
     }
     GetLocation() {
-        return this.dynOverlay.unit_framing_overlay.properties.location;
+        return this.dynOverlay.properties.location;
     }
     GetVersion() {
-        return this.dynOverlay.unit_framing_overlay.properties.version;
+        return this.dynOverlay.properties.version;
     }
     toJSON() {
         return {

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

@@ -9,10 +9,10 @@ class Ordering {
         this.dynOverlay = dynOverlay;
     }
     GetAttributeOrdering() {
-        return this.dynOverlay.ordering_overlay.attribute_ordering;
+        return this.dynOverlay.attribute_ordering;
     }
     GetEntryCodeOrdering() {
-        return this.dynOverlay.ordering_overlay.entry_code_ordering;
+        return this.dynOverlay.entry_code_ordering;
     }
     toJSON() {
         return {

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

@@ -13,7 +13,7 @@ class Range {
         this.dynOverlay = dynOverlay;
     }
     GetAttributes() {
-        const range_overlay_attributes = this.dynOverlay.range_overlay.attributes;
+        const range_overlay_attributes = this.dynOverlay.attributes;
         const canonicalized_attributes = (0, canonical_js_1.default)(range_overlay_attributes);
         const sortedAttributes = JSON.parse(canonicalized_attributes);
         return sortedAttributes;

package/dist/esm/oca_extensions/extensions.js

@@ -1,5 +1,6 @@
 import Ordering from './state/overlays/ordering.js';
 import UnitFraming from './state/overlays/framing/unit_framing.js';
+import ExampleOverlay from './state/overlays/example.js';
 import Range from './state/overlays/range.js';
 import { ocabundleDigest, getOcaBundleFromDeps, getDigest, isOcaBundleWithDeps } from '../utils/helpers.js';
 import { saidify } from 'saidify';
@@ -34,21 +35,26 @@ export class Overlay {
         const overlay = {};
         for (const ov_type in this._overlay) {
             if (ov_type === 'ordering_overlay') {
-                const ordering_instance = new Ordering(this._overlay);
+                const ordering_instance = new Ordering(this._overlay.ordering_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 UnitFraming(this._overlay);
+                const unit_framing_instance = new UnitFraming(this._overlay.unit_framing_overlay);
                 const unit_framing_ov = unit_framing_instance.GenerateOverlay();
                 overlay['unit_framing'] = JSON.parse(unit_framing_ov);
             }
             else if (ov_type === 'range_overlay') {
-                const range_instance = new Range(this._overlay);
+                const range_instance = new Range(this._overlay.range_overlay);
                 const range_ov = range_instance.GenerateOverlay();
                 overlay['range'] = JSON.parse(range_ov);
             }
+            else if (ov_type === 'example_overlay') {
+                const example_ov = ExampleOverlay.GenerateOverlay(this._overlay.example_overlay);
+                overlay['example'] = JSON.parse(example_ov);
+            }
             else {
+                // throwing an error as all extension overlays authored by adc should be handled by the overlay class
                 throw new Error('Invalid overlay name');
             }
         }
@@ -72,7 +78,7 @@ class ADCOverlayStrategy {
 // 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) {
+    GenerateOverlay(_extensions) {
         throw new Error('Unsupported community type');
     }
 }

package/dist/esm/oca_extensions/state/overlays/example.js

@@ -0,0 +1,54 @@
+import { saidify } from 'saidify';
+import canonicalize from '../../../utils/canonical.js';
+class ExampleOverlay {
+    constructor(dynOverlay) {
+        if (!dynOverlay) {
+            throw new Error('A dynamic extension overlay is required');
+        }
+        this.dynOverlay = dynOverlay;
+    }
+    get language() {
+        return this.dynOverlay.language;
+    }
+    GetAttributeExamples() {
+        const examples = this.dynOverlay.attribute_examples;
+        const canonicalizedExamples = canonicalize(examples);
+        const sortedExamples = JSON.parse(canonicalizedExamples);
+        return sortedExamples;
+    }
+    toJSON() {
+        return {
+            d: '',
+            type: 'community/overlays/adc/example/1.1',
+            language: this.language,
+            attribute_examples: this.GetAttributeExamples(),
+        };
+    }
+    Saidifying() {
+        const [, sad] = saidify(this.toJSON());
+        return sad;
+    }
+    // generates a single example overlay
+    GenerateExampleOverlay() {
+        return JSON.stringify(this.Saidifying());
+    }
+    static GenerateOverlay(dynOverlay) {
+        if (!dynOverlay || typeof dynOverlay !== 'object' || !Array.isArray(dynOverlay['example_overlays'])) {
+            throw new Error('Invalid dynOverlay structure. Expected an object with an "example_overlays" array.');
+        }
+        const example_overlays = [];
+        const overlays = dynOverlay['example_overlays'];
+        for (let example_ov of overlays) {
+            try {
+                const example_overlay = new ExampleOverlay(example_ov);
+                example_overlays.push(JSON.parse(example_overlay.GenerateExampleOverlay()));
+            }
+            catch (error) {
+                console.error('Failed to process example overlay:', error);
+            }
+        }
+        example_overlays.sort((a, b) => a.language.localeCompare(b.language));
+        return JSON.stringify(example_overlays);
+    }
+}
+export default ExampleOverlay;

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

@@ -8,22 +8,22 @@ class UnitFraming {
         this.dynOverlay = dynOverlay;
     }
     GetUnits() {
-        const units = this.dynOverlay.unit_framing_overlay.units;
+        const units = this.dynOverlay.units;
         const canonicalizedUnits = canonicalize(units);
         const sortedUnits = JSON.parse(canonicalizedUnits);
         return sortedUnits;
     }
     GetId() {
-        return this.dynOverlay.unit_framing_overlay.properties.id;
+        return this.dynOverlay.properties.id;
     }
     GetLabel() {
-        return this.dynOverlay.unit_framing_overlay.properties.label;
+        return this.dynOverlay.properties.label;
     }
     GetLocation() {
-        return this.dynOverlay.unit_framing_overlay.properties.location;
+        return this.dynOverlay.properties.location;
     }
     GetVersion() {
-        return this.dynOverlay.unit_framing_overlay.properties.version;
+        return this.dynOverlay.properties.version;
     }
     toJSON() {
         return {

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

@@ -7,10 +7,10 @@ class Ordering {
         this.dynOverlay = dynOverlay;
     }
     GetAttributeOrdering() {
-        return this.dynOverlay.ordering_overlay.attribute_ordering;
+        return this.dynOverlay.attribute_ordering;
     }
     GetEntryCodeOrdering() {
-        return this.dynOverlay.ordering_overlay.entry_code_ordering;
+        return this.dynOverlay.entry_code_ordering;
     }
     toJSON() {
         return {

package/dist/esm/oca_extensions/state/overlays/range.js

@@ -8,7 +8,7 @@ class Range {
         this.dynOverlay = dynOverlay;
     }
     GetAttributes() {
-        const range_overlay_attributes = this.dynOverlay.range_overlay.attributes;
+        const range_overlay_attributes = this.dynOverlay.attributes;
         const canonicalized_attributes = canonicalize(range_overlay_attributes);
         const sortedAttributes = JSON.parse(canonicalized_attributes);
         return sortedAttributes;

package/dist/types/oca_extensions/extensions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"extensions.d.ts","sourceRoot":"","sources":["../../../src/oca_extensions/extensions.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAQzC,MAAM,WAAW,kBAAkB;IACjC,CAAC,SAAS,EAAE,MAAM,GAAG;QACnB,CAAC,aAAa,EAAE,IAAI,GAAG,UAAU,EAAE,CAAC;KACrC,CAAC;CACH;AAGD,MAAM,WAAW,eAAe;IAC9B,CAAC,SAAS,EAAE,MAAM,GAAG;QACnB,CAAC,aAAa,EAAE,IAAI,GAAG,UAAU,CAAC;KACnC,CAAC;CACH;AAED,qBAAa,cAAc;IACzB,OAAO,CAAC,qBAAqB,CAAqB;IAC3C,eAAe,EAAE,eAAe,CAAC;gBAE5B,kBAAkB,EAAE,kBAAkB;IAKlD,OAAO,CAAC,mBAAmB;IAiB3B,IAAW,WAAW,IAAI,eAAe,CAExC;CACF;AAKD,MAAM,WAAW,UAAU;IACzB,CAAC,OAAO,EAAE,MAAM,GAAG;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED,qBAAa,OAAQ,YAAW,UAAU;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;gBAEP,iBAAiB,EAAE,UAAU;IAIlC,eAAe,IAAI,QAAQ,CAAC,UAAU,CAAC;CAsB/C;AAkFD,MAAM,WAAW,UAAU;IACzB,CAAC,EAAE,IAAI,CAAC;IACR,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,qBAAa,SAAU,YAAW,UAAU;IAC1C,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAM;IACf,UAAU,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,QAAQ,KAAM;gBAEX,iBAAiB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM;IAU5D,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,MAAM;IAQd,OAAO,CAAC,UAAU;IAKX,iBAAiB,IAAI,GAAG;CAGhC;AAED,KAAK,gBAAgB,GAAG;IAAE,CAAC,SAAS,EAAE,MAAM,GAAG;QAAE,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAA;CAAE,CAAC;AAE9F,cAAM,YAAY;IACT,eAAe,EAAE,gBAAgB,CAAC;IAClC,WAAW,EAAE,GAAG,CAAC;IACjB,eAAe,EAAE,cAAc,CAAC;gBAE3B,oBAAoB,EAAE,kBAAkB,EAAE,UAAU,EAAE,GAAG;IAMrE,IAAW,kBAAkB,IAAI,gBAAgB,CA4BhD;CACF;AAED,eAAe,YAAY,CAAC"}
+{"version":3,"file":"extensions.d.ts","sourceRoot":"","sources":["../../../src/oca_extensions/extensions.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAQzC,MAAM,WAAW,kBAAkB;IACjC,CAAC,SAAS,EAAE,MAAM,GAAG;QACnB,CAAC,aAAa,EAAE,IAAI,GAAG,UAAU,EAAE,CAAC;KACrC,CAAC;CACH;AAGD,MAAM,WAAW,eAAe;IAC9B,CAAC,SAAS,EAAE,MAAM,GAAG;QACnB,CAAC,aAAa,EAAE,IAAI,GAAG,UAAU,CAAC;KACnC,CAAC;CACH;AAED,qBAAa,cAAc;IACzB,OAAO,CAAC,qBAAqB,CAAqB;IAC3C,eAAe,EAAE,eAAe,CAAC;gBAE5B,kBAAkB,EAAE,kBAAkB;IAKlD,OAAO,CAAC,mBAAmB;IAiB3B,IAAW,WAAW,IAAI,eAAe,CAExC;CACF;AAKD,MAAM,WAAW,UAAU;IACzB,CAAC,OAAO,EAAE,MAAM,GAAG;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED,qBAAa,OAAQ,YAAW,UAAU;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;gBAEP,iBAAiB,EAAE,UAAU;IAIlC,eAAe,IAAI,QAAQ,CAAC,UAAU,CAAC;CA0B/C;AAiFD,MAAM,WAAW,UAAU;IACzB,CAAC,EAAE,IAAI,CAAC;IACR,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,qBAAa,SAAU,YAAW,UAAU;IAC1C,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAM;IACf,UAAU,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,QAAQ,KAAM;gBAEX,iBAAiB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM;IAU5D,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,MAAM;IAQd,OAAO,CAAC,UAAU;IAKX,iBAAiB,IAAI,GAAG;CAGhC;AAED,KAAK,gBAAgB,GAAG;IAAE,CAAC,SAAS,EAAE,MAAM,GAAG;QAAE,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAA;CAAE,CAAC;AAE9F,cAAM,YAAY;IACT,eAAe,EAAE,gBAAgB,CAAC;IAClC,WAAW,EAAE,GAAG,CAAC;IACjB,eAAe,EAAE,cAAc,CAAC;gBAE3B,oBAAoB,EAAE,kBAAkB,EAAE,UAAU,EAAE,GAAG;IAMrE,IAAW,kBAAkB,IAAI,gBAAgB,CA4BhD;CACF;AAED,eAAe,YAAY,CAAC"}

package/dist/types/oca_extensions/state/overlays/example.d.ts

@@ -0,0 +1,19 @@
+import { DynOverlay } from '../../extensions.js';
+export interface IExampleOverlay {
+    dynOverlay: DynOverlay;
+    GenerateExampleOverlay(): string;
+}
+declare class ExampleOverlay implements IExampleOverlay {
+    dynOverlay: DynOverlay;
+    constructor(dynOverlay: DynOverlay);
+    get language(): any;
+    private GetAttributeExamples;
+    private toJSON;
+    private Saidifying;
+    GenerateExampleOverlay(): string;
+    static GenerateOverlay(dynOverlay: {
+        example_overlays: any[];
+    }): string;
+}
+export default ExampleOverlay;
+//# sourceMappingURL=example.d.ts.map

package/dist/types/oca_extensions/state/overlays/example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../../../../../src/oca_extensions/state/overlays/example.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAIjD,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,UAAU,CAAC;IACvB,sBAAsB,IAAI,MAAM,CAAC;CAClC;AAED,cAAM,cAAe,YAAW,eAAe;IACtC,UAAU,EAAE,UAAU,CAAC;gBAElB,UAAU,EAAE,UAAU;IAOlC,IAAW,QAAQ,IAAI,GAAG,CAEzB;IAED,OAAO,CAAC,oBAAoB;IAO5B,OAAO,CAAC,MAAM;IASd,OAAO,CAAC,UAAU;IAMX,sBAAsB,IAAI,MAAM;WAIzB,eAAe,CAAC,UAAU,EAAE;QAAE,gBAAgB,EAAE,GAAG,EAAE,CAAA;KAAE,GAAG,MAAM;CAqB/E;AAED,eAAe,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oca_package",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "The wrapper of OCA bundle to generate OCA Package at ADC",
   "type": "module",
   "main": "./dist/cjs/index.js",