ns.gs1.org becomes ref.gs1.org as defined in the standard (#50)

* ns.gs1.org becomes ref.gs1.org as defined in the standard * 2.6.2 * Updated version * Updated hash algorithm to reflect standard changes * Updated hash algorithm to reflect standard changes * Fixed tests linked to the hashing algo * Applied linter * The context field is now ignored in the hashing algorithm * Certification info is remove from the hashed fields * npm audit fix * Replaced measurement type with gs1 voc extended url * Typo * 2.7.0 * Added Mark and Ralph remarks * Added Mark and Ralph remarks * 2.7.0
evrythng · Dec 7, 2022 · f9d4148 · f9d4148
1 parent a2e7574
commit f9d4148
Show file tree

Hide file tree

Showing 13 changed files with 1,009 additions and 110 deletions.
diff --git a/README.md b/README.md
@@ -56,7 +56,7 @@ import * as epcis from 'epcis2.js';
 
 Or use a simple script tag to load it from the CDN:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/epcis2.js@2.6.1/dist/epcis2.browser.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/epcis2.js@2.7.0/dist/epcis2.browser.js"></script>
 ```
 
 Then use in a browser `script` tag using the `epcis2` global variable:
@@ -482,7 +482,7 @@ This feature is still experimental, please submit an [issue](https://github.com/
 ### Generating a hashed ID for an event
 
 You have the possibility to generate a hashed ID for each event you create. The generation algorithm is a pure
-implementation of the one defined [here](https://github.com/RalphTro/epcis-event-hash-generator).
+implementation of the one defined [here](https://ref.gs1.org/standards/cbv/) (section 8.9.2).
 
 Generating a hashed ID allows developers to uniquely identify an EPCIS event or validate the integrity thereof.
 

diff --git a/example/web-example/index.html b/example/web-example/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="UTF-8">
   <title>EPCIS2.js demo</title>
-  <script src="https://cdn.jsdelivr.net/npm/epcis2.js@2.6.1/dist/epcis2.browser.js" defer></script>
+  <script src="https://cdn.jsdelivr.net/npm/epcis2.js@2.7.0/dist/epcis2.browser.js" defer></script>
   <script>
     window.onload = () => {
       const doc = new epcis2.EPCISDocument();

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "epcis2.js",
-  "version": "2.6.1",
+  "version": "2.7.0",
   "description": "Javascript SDK for the EPCIS 2.0 standard",
   "main": "./dist/epcis2.node.js",
   "browser": "./dist/epcis2.browser.js",

diff --git a/src/hash_generator/EPCISEventToPreHashedString.js b/src/hash_generator/EPCISEventToPreHashedString.js
@@ -211,9 +211,9 @@ export const preHashStringTheList = (list, context, fieldName, throwError) => {
       for (let i = 0; i < list.length; i += 1) {
         res = list[i];
         // if, for example, the field is equal to 'completeness_inferred' instead of
-        // 'https://ns.gs1.org/cbv/Disp-completeness_inferred' for example, we need to complete it
+        // 'https://ref.gs1.org/cbv/Disp-completeness_inferred' for example, we need to complete it
         if (Object.values(cbv.dispositions).includes(res)) {
-          res = `https://ns.gs1.org/cbv/Disp-${res}`;
+          res = `https://ref.gs1.org/cbv/Disp-${res}`;
         }
         strings.push(getPreHashStringOfField('set', res, throwError));
       }
@@ -223,9 +223,9 @@ export const preHashStringTheList = (list, context, fieldName, throwError) => {
       for (let i = 0; i < list.length; i += 1) {
         res = list[i];
         // if, for example, the field is equal to 'completeness_inferred' instead of
-        // 'https://ns.gs1.org/cbv/Disp-completeness_inferred' for example, we need to complete it
+        // 'https://ref.gs1.org/cbv/Disp-completeness_inferred' for example, we need to complete it
         if (Object.values(cbv.dispositions).includes(res)) {
-          res = `https://ns.gs1.org/cbv/Disp-${res}`;
+          res = `https://ref.gs1.org/cbv/Disp-${res}`;
         }
         strings.push(getPreHashStringOfField('unset', res, throwError));
       }
@@ -281,9 +281,9 @@ export const preHashStringTheList = (list, context, fieldName, throwError) => {
     case 'bizTransactionList':
       for (let i = 0; i < list.length; i += 1) {
         // if, for example, the field is equal to 'bol' instead of
-        // 'https://ns.gs1.org/cbv/BTT-bol', we need to complete it
+        // 'https://ref.gs1.org/cbv/BTT-bol', we need to complete it
         if (Object.values(cbv.businessTransactionTypes).includes(list[i].type)) {
-          list[i].type = `https://ns.gs1.org/cbv/BTT-${list[i].type}`;
+          list[i].type = `https://ref.gs1.org/cbv/BTT-${list[i].type}`;
         }
         res = getOrderedPreHashString(
           list[i],
@@ -298,9 +298,9 @@ export const preHashStringTheList = (list, context, fieldName, throwError) => {
     case 'sourceList':
       for (let i = 0; i < list.length; i += 1) {
         // if, for example, the field is equal to 'location' instead of
-        // 'https://ns.gs1.org/cbv/SDT-location', we need to complete it
+        // 'https://ref.gs1.org/cbv/SDT-location', we need to complete it
         if (Object.values(cbv.sourceDestinationTypes).includes(list[i].type)) {
-          list[i].type = `https://ns.gs1.org/cbv/SDT-${list[i].type}`;
+          list[i].type = `https://ref.gs1.org/cbv/SDT-${list[i].type}`;
         }
         res = getOrderedPreHashString(list[i], context, sourceCanonicalPropertyOrder, throwError);
         strings.push(res.preHashed);
@@ -310,9 +310,9 @@ export const preHashStringTheList = (list, context, fieldName, throwError) => {
     case 'destinationList':
       for (let i = 0; i < list.length; i += 1) {
         // if, for example, the field is equal to 'location' instead of
-        // 'https://ns.gs1.org/cbv/SDT-location', we need to complete it
+        // 'https://ref.gs1.org/cbv/SDT-location', we need to complete it
         if (Object.values(cbv.sourceDestinationTypes).includes(list[i].type)) {
-          list[i].type = `https://ns.gs1.org/cbv/SDT-${list[i].type}`;
+          list[i].type = `https://ref.gs1.org/cbv/SDT-${list[i].type}`;
         }
         res = getOrderedPreHashString(
           list[i],
@@ -340,9 +340,9 @@ export const preHashStringTheList = (list, context, fieldName, throwError) => {
       string = '';
       for (let i = 0; i < list.length; i += 1) {
         // if, for example, the field is equal to 'Temperature' instead of
-        // 'https://gs1.org/voc/MeasurementType-Temperature' we need to complete it
+        // 'https://gs1.org/voc/Temperature' we need to complete it
         if (Object.values(cbv.sensorMeasurementTypes).includes(list[i].type)) {
-          list[i].type = `https://gs1.org/voc/MeasurementType-${list[i].type}`;
+          list[i].type = `https://gs1.org/voc/${list[i].type}`;
         }
 
         // if, for example, the field is equal to 'ALARM_CONDITION' instead of
@@ -352,9 +352,9 @@ export const preHashStringTheList = (list, context, fieldName, throwError) => {
         }
 
         // if, for example, the field is equal to 'x' instead of
-        // 'https://ns.gs1.org/cbv/Comp-x' we need to complete it
+        // 'https://ref.gs1.org/cbv/Comp-x' we need to complete it
         if (Object.values(cbv.components).includes(list[i].component)) {
-          list[i].component = `https://ns.gs1.org/cbv/Comp-${list[i].component}`;
+          list[i].component = `https://ref.gs1.org/cbv/Comp-${list[i].component}`;
         }
 
         res = getOrderedPreHashString(
@@ -481,19 +481,19 @@ export const getOrderedPreHashString = (
           case 'bizStep':
             res = object[orderList[i]];
             // if, for example, the field is equal to 'accepting' instead of
-            // 'https://ns.gs1.org/cbv/BizStep-accepting' for example, we need to complete it
+            // 'https://ref.gs1.org/cbv/BizStep-accepting' for example, we need to complete it
             if (Object.values(cbv.bizSteps).includes(res)) {
-              res = `https://ns.gs1.org/cbv/BizStep-${res}`;
+              res = `https://ref.gs1.org/cbv/BizStep-${res}`;
             }
 
             string += getPreHashStringOfField(orderList[i], res, throwError);
             break;
           case 'disposition':
             res = object[orderList[i]];
             // if, for example, the field is equal to 'active' instead of
-            // 'https://ns.gs1.org/cbv/Disp-active', we need to complete it
+            // 'https://ref.gs1.org/cbv/Disp-active', we need to complete it
             if (Object.values(cbv.dispositions).includes(res)) {
-              res = `https://ns.gs1.org/cbv/Disp-${res}`;
+              res = `https://ref.gs1.org/cbv/Disp-${res}`;
             }
 
             string += getPreHashStringOfField(orderList[i], res, throwError);

diff --git a/src/hash_generator/canonicalPropertyOrder.js b/src/hash_generator/canonicalPropertyOrder.js
@@ -13,8 +13,9 @@ export const canonicalPropertyOrder = [
   'type',
   'eventTime',
   'eventTimeZoneOffset',
-  'parentID',
+  'certificationInfo',
   'epcList',
+  'parentID',
   'inputEPCList',
   'childEPCs',
   'quantityList',
@@ -36,17 +37,6 @@ export const canonicalPropertyOrder = [
   'ilmd',
 ];
 
-/**
- * This variable sets the order of Error Declaration fields that a pre-hashed string has to follow
- * in order to comply with the used algorithm
- * @type {string[]}
- */
-export const errorDeclarationCanonicalPropertyOrder = [
-  'declarationTime',
-  'reason',
-  'correctiveEventIDs',
-];
-
 /**
  * This variable sets the order of Quantity Element fields that a pre-hashed string has to follow
  * in order to comply with the used algorithm
@@ -73,21 +63,21 @@ export const bizLocationCanonicalPropertyOrder = ['id'];
  * order to comply with the used algorithm
  * @type {string[]}
  */
-export const bizTransactionCanonicalPropertyOrder = ['bizTransaction', 'type'];
+export const bizTransactionCanonicalPropertyOrder = ['type', 'bizTransaction'];
 
 /**
  * This variable sets the order of Source fields that a pre-hashed string has to follow in order to
  * comply with the used algorithm
  * @type {string[]}
  */
-export const sourceCanonicalPropertyOrder = ['source', 'type'];
+export const sourceCanonicalPropertyOrder = ['type', 'source'];
 
 /**
  * This variable sets the order of Destination fields that a pre-hashed string has to follow in
  * order to comply with the used algorithm
  * @type {string[]}
  */
-export const destinationCanonicalPropertyOrder = ['destination', 'type'];
+export const destinationCanonicalPropertyOrder = ['type', 'destination'];
 
 /**
  * This variable sets the order of Sensor Element fields that a pre-hashed string has to follow in
@@ -140,6 +130,7 @@ export const sensorReportCanonicalPropertyOrder = [
   'percRank',
   'percValue',
   'uom',
+  'coordinateReferenceSystem',
 ];
 
 /**

diff --git a/src/hash_generator/hashAlgorithmUtils.js b/src/hash_generator/hashAlgorithmUtils.js
@@ -14,7 +14,7 @@ import { normalizeDigitalLinks } from './dlNormalizer';
  * The list of fields that will be ignored in the pre-hashed string
  * @type {string[]}
  */
-export const toBeIgnored = ['recordTime', 'eventID', 'errorDeclaration'];
+export const toBeIgnored = ['recordTime', 'eventID', 'errorDeclaration', '@context'];
 
 /**
  * Check if the parameter is a string
@@ -68,7 +68,7 @@ export const isADate = (obj) => isNaN(obj) && !isNaN(Date.parse(obj)) && obj.len
 
 /**
  * If the UTC date passed in param contains a timezone, it removes it
- * It useful for the rule n°8 of the algorithm
+ * It is useful for the rule n°8 of the algorithm
  *
  * @param {string} date - a string representing an UTC date
  * @return {string} - the date without the timezone

diff --git a/test/data/hashing/epcisDocWithCustomSchemaInContext.json b/test/data/hashing/epcisDocWithCustomSchemaInContext.json
@@ -11,7 +11,6 @@
   "epcisBody": {
     "eventList": [
       {
-        "id": "_:event1",
         "type": "ObjectEvent",
         "action": "OBSERVE",
         "bizStep": "shipping",
@@ -29,7 +28,6 @@
         "example:myField": "myValue"
       },
       {
-        "id": "_:event2",
         "type": "ObjectEvent",
         "action": "OBSERVE",
         "bizStep": "receiving",

diff --git a/test/data/hashing/epcisDocWithDefaultSchemaInContext.json b/test/data/hashing/epcisDocWithDefaultSchemaInContext.json
@@ -8,7 +8,6 @@
   "epcisBody": {
     "eventList": [
       {
-        "id": "_:event1",
         "type": "ObjectEvent",
         "action": "OBSERVE",
         "bizStep": "shipping",
@@ -25,7 +24,6 @@
         ]
       },
       {
-        "id": "_:event2",
         "type": "ObjectEvent",
         "action": "OBSERVE",
         "bizStep": "receiving",