oca_package 1.2.4 → 1.4.0

package/dist/cjs/index.js

@@ -3,6 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OcaPackage = void 0;
+exports.VerifyOcaPackage = 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 verify_js_1 = require("./verify.js");
+Object.defineProperty(exports, "VerifyOcaPackage", { enumerable: true, get: function () { return verify_js_1.VerifyOcaPackage; } });

package/dist/cjs/oca_extensions/extensions.js

@@ -1,4 +1,6 @@
 "use strict";
+// TODO: use canonicalize to consistently order how properties of overlays should appear
+// Do validation for the generation exentension chunck, and parts of oca_package.
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -9,10 +11,11 @@ const unit_framing_js_1 = __importDefault(require("./state/overlays/framing/unit
 const example_js_1 = __importDefault(require("./state/overlays/example.js"));
 const range_js_1 = __importDefault(require("./state/overlays/range.js"));
 const sensitive_js_1 = __importDefault(require("./state/overlays/sensitive.js"));
+const attribute_framing_js_1 = __importDefault(require("./state/overlays/framing/attribute_framing.js"));
 const helpers_js_1 = require("../utils/helpers.js");
 const saidify_1 = require("saidify");
 const ADC_COMMUNITY = 'adc';
-const v = '1.0';
+const EXTENSION_VERSION = '1.0';
 class ExtensionState {
     constructor(ExtensionInputJson) {
         this._extension_input_json = ExtensionInputJson;
@@ -66,6 +69,11 @@ class Overlay {
                 const sensitive_ov = sensitive_instance.GenerateOverlay();
                 overlay['sensitive'] = JSON.parse(sensitive_ov);
             }
+            else if (ov_type === 'attribute_framing_overlay') {
+                const attribute_framing_instance = new attribute_framing_js_1.default(this._overlay.attribute_framing_overlay);
+                const attribute_framing_ov = attribute_framing_instance.GenerateOverlay();
+                overlay['attribute_framing'] = JSON.parse(attribute_framing_ov);
+            }
             else {
                 throw new Error(`Unsupported overaly type ${ov_type}. Supported extension overlays at ADC are [ ordering_overlay, unit_framing_overlay, range_overlay, example_overlay, sensitive_overlay ]`);
             }
@@ -110,7 +118,7 @@ class Extension {
         }
         this._community = community;
         this._exensions = _extensions_input;
-        this.type = `community/${this._community}/extension/${v}`;
+        this.type = `community/${this._community}/extension/${EXTENSION_VERSION}`;
     }
     GenerateOverlays() {
         const strategy = this._community === ADC_COMMUNITY ? new ADCOverlayStrategy() : new DefaultOverlayStrategy();

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

@@ -1,6 +1,10 @@
 "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 AttributeFraming {
     constructor(dynOverlay) {
         if (!dynOverlay) {
@@ -8,32 +12,38 @@ class AttributeFraming {
         }
         this.dynOverlay = dynOverlay;
     }
-    GetAttributeFraming() {
-        return this.dynOverlay.attribute_framing_overlay.attributes;
+    GetFramedAttributes() {
+        const attributes = this.dynOverlay.attributes;
+        const canonicalizedAttributes = (0, canonical_js_1.default)(attributes);
+        const sortedAttributes = JSON.parse(canonicalizedAttributes);
+        return sortedAttributes;
     }
     GetId() {
-        return this.dynOverlay.attribute_framing_overlay.properties.id;
+        return this.dynOverlay.framing_metadata.id;
     }
     GetLabel() {
-        return this.dynOverlay.attribute_framing_overlay.properties.label;
+        return this.dynOverlay.framing_metadata.label;
     }
     GetLocation() {
-        return this.dynOverlay.attribute_framing_overlay.properties.location;
+        return this.dynOverlay.framing_metadata.location;
     }
     GetVersion() {
-        return this.dynOverlay.attribute_framing_overlay.properties.version;
+        return this.dynOverlay.framing_metadata.version;
+    }
+    GetFramingMetadata() {
+        return {
+            id: this.GetId(),
+            label: this.GetLabel(),
+            location: this.GetLocation(),
+            version: this.GetVersion(),
+        };
     }
     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(),
+            framing_metadata: this.GetFramingMetadata(),
+            attributes: this.GetFramedAttributes(),
         };
     }
     Saidifying() {

package/dist/cjs/verify.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VerifyOcaPackage = VerifyOcaPackage;
+const saidify_1 = require("saidify");
+/**
+ * Verifies the OCA package against a digest.
+ * @param oca_package - The OCA package to verify.
+ * @param digest - The digest to verify against.
+ * @returns {boolean} - Returns true if the verification is successful, otherwise false.
+ */
+function VerifyOcaPackage(oca_package, digest) {
+    const label = 'd';
+    // prefixed is set to true this avoid d = '' to be considered as a valid self-addressing data
+    return (0, saidify_1.verify)(oca_package, digest, label, saidify_1.SAIDDex.Blake3_256, saidify_1.Serials.JSON, true);
+}

package/dist/esm/index.js

@@ -1 +1,2 @@
 export { default as OcaPackage } from './oca_package.js';
+export { VerifyOcaPackage } from './verify.js';

package/dist/esm/oca_extensions/extensions.js

@@ -1,12 +1,15 @@
+// TODO: use canonicalize to consistently order how properties of overlays should appear
+// Do validation for the generation exentension chunck, and parts of oca_package.
 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 Sensitive from './state/overlays/sensitive.js';
+import AttributeFraming from './state/overlays/framing/attribute_framing.js';
 import { ocabundleDigest, getOcaBundleFromDeps, getDigest, isOcaBundleWithDeps } from '../utils/helpers.js';
 import { saidify } from 'saidify';
 const ADC_COMMUNITY = 'adc';
-const v = '1.0';
+const EXTENSION_VERSION = '1.0';
 export class ExtensionState {
     constructor(ExtensionInputJson) {
         this._extension_input_json = ExtensionInputJson;
@@ -59,6 +62,11 @@ export class Overlay {
                 const sensitive_ov = sensitive_instance.GenerateOverlay();
                 overlay['sensitive'] = JSON.parse(sensitive_ov);
             }
+            else if (ov_type === 'attribute_framing_overlay') {
+                const attribute_framing_instance = new AttributeFraming(this._overlay.attribute_framing_overlay);
+                const attribute_framing_ov = attribute_framing_instance.GenerateOverlay();
+                overlay['attribute_framing'] = JSON.parse(attribute_framing_ov);
+            }
             else {
                 throw new Error(`Unsupported overaly type ${ov_type}. Supported extension overlays at ADC are [ ordering_overlay, unit_framing_overlay, range_overlay, example_overlay, sensitive_overlay ]`);
             }
@@ -102,7 +110,7 @@ export class Extension {
         }
         this._community = community;
         this._exensions = _extensions_input;
-        this.type = `community/${this._community}/extension/${v}`;
+        this.type = `community/${this._community}/extension/${EXTENSION_VERSION}`;
     }
     GenerateOverlays() {
         const strategy = this._community === ADC_COMMUNITY ? new ADCOverlayStrategy() : new DefaultOverlayStrategy();

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

@@ -1,4 +1,5 @@
 import { saidify } from 'saidify';
+import canonicalize from '../../../../utils/canonical.js';
 class AttributeFraming {
     constructor(dynOverlay) {
         if (!dynOverlay) {
@@ -6,32 +7,38 @@ class AttributeFraming {
         }
         this.dynOverlay = dynOverlay;
     }
-    GetAttributeFraming() {
-        return this.dynOverlay.attribute_framing_overlay.attributes;
+    GetFramedAttributes() {
+        const attributes = this.dynOverlay.attributes;
+        const canonicalizedAttributes = canonicalize(attributes);
+        const sortedAttributes = JSON.parse(canonicalizedAttributes);
+        return sortedAttributes;
     }
     GetId() {
-        return this.dynOverlay.attribute_framing_overlay.properties.id;
+        return this.dynOverlay.framing_metadata.id;
     }
     GetLabel() {
-        return this.dynOverlay.attribute_framing_overlay.properties.label;
+        return this.dynOverlay.framing_metadata.label;
     }
     GetLocation() {
-        return this.dynOverlay.attribute_framing_overlay.properties.location;
+        return this.dynOverlay.framing_metadata.location;
     }
     GetVersion() {
-        return this.dynOverlay.attribute_framing_overlay.properties.version;
+        return this.dynOverlay.framing_metadata.version;
+    }
+    GetFramingMetadata() {
+        return {
+            id: this.GetId(),
+            label: this.GetLabel(),
+            location: this.GetLocation(),
+            version: this.GetVersion(),
+        };
     }
     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(),
+            framing_metadata: this.GetFramingMetadata(),
+            attributes: this.GetFramedAttributes(),
         };
     }
     Saidifying() {

package/dist/esm/verify.js

@@ -0,0 +1,12 @@
+import { verify, SAIDDex, Serials } from 'saidify';
+/**
+ * Verifies the OCA package against a digest.
+ * @param oca_package - The OCA package to verify.
+ * @param digest - The digest to verify against.
+ * @returns {boolean} - Returns true if the verification is successful, otherwise false.
+ */
+export function VerifyOcaPackage(oca_package, digest) {
+    const label = 'd';
+    // prefixed is set to true this avoid d = '' to be considered as a valid self-addressing data
+    return verify(oca_package, digest, label, SAIDDex.Blake3_256, Serials.JSON, true);
+}

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export { default as OcaPackage } from './oca_package.js';
+export { VerifyOcaPackage } from './verify.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC"}

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":"AAKA,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AASzC,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;CAsC/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"}
+{"version":3,"file":"extensions.d.ts","sourceRoot":"","sources":["../../../src/oca_extensions/extensions.ts"],"names":[],"mappings":"AASA,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;CA0C/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/framing/attribute_framing.d.ts

@@ -6,11 +6,12 @@ export interface IAttributeFraming {
 declare class AttributeFraming implements IAttributeFraming {
     dynOverlay: DynOverlay;
     constructor(dynOverlay: DynOverlay);
-    private GetAttributeFraming;
+    private GetFramedAttributes;
     private GetId;
     private GetLabel;
     private GetLocation;
     private GetVersion;
+    private GetFramingMetadata;
     private toJSON;
     private Saidifying;
     GenerateOverlay(): string;

package/dist/types/oca_extensions/state/overlays/framing/attribute_framing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"attribute_framing.d.ts","sourceRoot":"","sources":["../../../../../../src/oca_extensions/state/overlays/framing/attribute_framing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAGpD,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,UAAU,CAAC;IACvB,eAAe,IAAI,MAAM,CAAC;CAC3B;AAED,cAAM,gBAAiB,YAAW,iBAAiB;IAC1C,UAAU,EAAE,UAAU,CAAC;gBAElB,UAAU,EAAE,UAAU;IAQlC,OAAO,CAAC,mBAAmB;IAG3B,OAAO,CAAC,KAAK;IAGb,OAAO,CAAC,QAAQ;IAGhB,OAAO,CAAC,WAAW;IAGnB,OAAO,CAAC,UAAU;IAGlB,OAAO,CAAC,MAAM;IAad,OAAO,CAAC,UAAU;IAIX,eAAe,IAAI,MAAM;CAGjC;AACD,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"attribute_framing.d.ts","sourceRoot":"","sources":["../../../../../../src/oca_extensions/state/overlays/framing/attribute_framing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAIpD,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,UAAU,CAAC;IACvB,eAAe,IAAI,MAAM,CAAC;CAC3B;AAED,cAAM,gBAAiB,YAAW,iBAAiB;IAC1C,UAAU,EAAE,UAAU,CAAC;gBAElB,UAAU,EAAE,UAAU;IAQlC,OAAO,CAAC,mBAAmB;IAM3B,OAAO,CAAC,KAAK;IAGb,OAAO,CAAC,QAAQ;IAGhB,OAAO,CAAC,WAAW;IAGnB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,kBAAkB;IAS1B,OAAO,CAAC,MAAM;IAQd,OAAO,CAAC,UAAU;IAIX,eAAe,IAAI,MAAM;CAGjC;AACD,eAAe,gBAAgB,CAAC"}

package/dist/types/verify.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Verifies the OCA package against a digest.
+ * @param oca_package - The OCA package to verify.
+ * @param digest - The digest to verify against.
+ * @returns {boolean} - Returns true if the verification is successful, otherwise false.
+ */
+export declare function VerifyOcaPackage(oca_package: any, digest: string): boolean;
+//# sourceMappingURL=verify.d.ts.map

package/dist/types/verify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verify.d.ts","sourceRoot":"","sources":["../../src/verify.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAI1E"}

package/package.json

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