oca_package 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +146 -4
  2. package/dist/cjs/oca_package.js +1 -1
  3. package/dist/cjs/oca_package.js.map +1 -1
  4. package/dist/esm/oca_package.js +1 -1
  5. package/dist/esm/oca_package.js.map +1 -1
  6. package/package.json +4 -5
package/README.md CHANGED
@@ -1,7 +1,149 @@
1
- # OCA_package
1
+ # OCA_Package
2
2
 
3
- [![npm version](https://badge.fury.io/js/oca-package.svg)](https://badge.fury.io/js/oca-package)
3
+ [![npm version](https://badge.fury.io/js/oca_package.svg)](https://badge.fury.io/js/oca_package)
4
4
 
5
- Generate oca-package using oca-bundle and extensions
5
+ Generate oca_package from oca_bundle and extensions
6
6
 
7
- For extended documentation refer to [oca-package-standard](https://github.com/agrifooddatacanada/OCA_package_standard?tab=readme-ov-file)
7
+ For extended documentation refer to [oca_package_standard](https://github.com/agrifooddatacanada/OCA_package_standard?tab=readme-ov-file)
8
+
9
+ ## Usage
10
+
11
+ ```bash
12
+ npm i oca_package
13
+ ```
14
+
15
+ ```typescript
16
+ import { OcaPackage } from 'oca_package';
17
+ import { except } from 'vitest'; // make sure to install vitest or use any other testing library
18
+
19
+ const extension = {
20
+ extensions: [
21
+ {
22
+ ordering_overlay: {
23
+ type: 'ordering',
24
+ ordering_attributes: ['i', 'd'],
25
+ ordering_entry_codes: {
26
+ i: ['Google', 'ISNI', 'ORCiD', 'ResearcherID', 'Scopus'],
27
+ d: ['001', '002', '003', '004', '005'],
28
+ },
29
+ },
30
+ },
31
+ ],
32
+ };
33
+
34
+ const oca_bundle = {
35
+ v: 'OCAA11JSON0008bc_',
36
+ bundle: {
37
+ v: 'OCAS11JSON00089f_',
38
+ d: 'ECpSix7tE3wyQM5jH5oaqdizR77rWdQ_BDP3AJn-Jykz',
39
+ capture_base: {
40
+ d: 'EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW',
41
+ type: 'spec/capture_base/1.0',
42
+ attributes: {
43
+ d: 'Text',
44
+ i: 'Text',
45
+ passed: 'Boolean',
46
+ },
47
+ classification: '',
48
+ flagged_attributes: [],
49
+ },
50
+ overlays: {
51
+ character_encoding: {
52
+ d: 'ED6Eio9KG2jHdFg3gXQpc0PX2xEI7aHnGDOpjU6VBfjs',
53
+ capture_base: 'EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW',
54
+ type: 'spec/overlays/character_encoding/1.0',
55
+ attribute_character_encoding: {
56
+ d: 'utf-8',
57
+ i: 'utf-8',
58
+ passed: 'utf-8',
59
+ },
60
+ },
61
+ conformance: {
62
+ d: 'EJSRe8DnLonKf6GVT_bC1QHoY0lQOG6-ldqxu7pqVCU8',
63
+ capture_base: 'EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW',
64
+ type: 'spec/overlays/conformance/1.0',
65
+ attribute_conformance: {
66
+ d: 'M',
67
+ i: 'M',
68
+ passed: 'M',
69
+ },
70
+ },
71
+ entry: [
72
+ {
73
+ d: 'EDQVwDAmYssKbGCcLYjYB_Kg5LPOgCTdT3ODzvXqKc1A',
74
+ capture_base: 'EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW',
75
+ type: 'spec/overlays/entry/1.0',
76
+ language: 'eng',
77
+ attribute_entries: {
78
+ d: {
79
+ '001': 'code1',
80
+ '002': 'code2',
81
+ '003': 'code3',
82
+ '004': 'code4',
83
+ '005': 'code5',
84
+ },
85
+ i: {
86
+ G: 'Google',
87
+ I: 'ISNI',
88
+ O: 'ORCiD',
89
+ R: 'ResearcherID',
90
+ S: 'Scopus',
91
+ },
92
+ },
93
+ },
94
+ ],
95
+ entry_code: {
96
+ d: 'EHrwr6xT_k3PHwd0y8RbIPGe0hDaELjJbjrKs_o8LfGY',
97
+ capture_base: 'EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW',
98
+ type: 'spec/overlays/entry_code/1.0',
99
+ attribute_entry_codes: {
100
+ d: ['001', '002', '003', '004', '005'],
101
+ i: ['G', 'I', 'O', 'R', 'S'],
102
+ },
103
+ },
104
+ information: [
105
+ {
106
+ d: 'EIBXpVvka3_4lheeajtitiafIP78Ig8LDMVX9dXpCC2l',
107
+ capture_base: 'EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW',
108
+ type: 'spec/overlays/information/1.0',
109
+ language: 'eng',
110
+ attribute_information: {
111
+ d: 'Schema digest',
112
+ i: 'Credential Issuee',
113
+ passed: 'Enables or disables passing',
114
+ },
115
+ },
116
+ ],
117
+ label: [
118
+ {
119
+ d: 'ECZc26INzjxVbNo7-hln6xN3HW3e1r6NGDmA5ogRo6ef',
120
+ capture_base: 'EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW',
121
+ type: 'spec/overlays/label/1.0',
122
+ language: 'eng',
123
+ attribute_categories: [],
124
+ attribute_labels: {
125
+ d: 'Schema digest',
126
+ i: 'Credential Issuee',
127
+ passed: 'Passed',
128
+ },
129
+ category_labels: {},
130
+ },
131
+ ],
132
+ meta: [
133
+ {
134
+ d: 'EOxvie-zslkGmFzVqYAzTVtO7RyFXAG8aCqE0OougnGV',
135
+ capture_base: 'EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW',
136
+ type: 'spec/overlays/meta/1.0',
137
+ language: 'eng',
138
+ description: 'Entrance credential',
139
+ name: 'Entrance credential',
140
+ },
141
+ ],
142
+ },
143
+ },
144
+ dependencies: [],
145
+ };
146
+
147
+ const oca_package = new OcaPackage(extension, oca_bundle);
148
+ expect(JSON.parse(oca_package).d).toBe('EBpX82P-HmRjGe3Qr-zQbQmvN7uqxVh0Xt_nM61I9oqA');
149
+ ```
package/dist/cjs/oca_package.js CHANGED
@@ -24,7 +24,7 @@ class OcaPackage {
24
24
  const extension_container = this.extensions.generate_extensions(this.extension_input, this.oca_bundle);
25
25
  return {
26
26
  d: '',
27
- type: 'adc/oca_package/1.0',
27
+ type: 'oca_package/1.0',
28
28
  oca_bundle: this.oca_bundle,
29
29
  extensions: extension_container,
30
30
  };
package/dist/cjs/oca_package.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"oca_package.js","sourceRoot":"","sources":["../../src/oca_package.ts"],"names":[],"mappings":";;;;;AAAA,2GAA+E;AAE/E,qCAAkC;AAOlC,MAAM,UAAU;IAKd,YAAY,eAAmC,EAAE,UAAkB;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,gCAAkB,EAAE,CAAC;QAC3C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAEO,UAAU;QAChB,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,IAAA,iBAAO,EAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEM,IAAI;QACT,MAAM,CAAC,IAAI,CAAC,GAAG,IAAA,iBAAO,EAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM;QACZ,IAAI,CAAC;YACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACvG,OAAO;gBACL,CAAC,EAAE,EAAE;gBACL,IAAI,EAAE,qBAAqB;gBAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,mBAAmB;aAChC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;CACF;AAED,kBAAe,UAAU,CAAC"}
1
+ {"version":3,"file":"oca_package.js","sourceRoot":"","sources":["../../src/oca_package.ts"],"names":[],"mappings":";;;;;AAAA,2GAA+E;AAE/E,qCAAkC;AAOlC,MAAM,UAAU;IAKd,YAAY,eAAmC,EAAE,UAAkB;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,gCAAkB,EAAE,CAAC;QAC3C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAEO,UAAU;QAChB,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,IAAA,iBAAO,EAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEM,IAAI;QACT,MAAM,CAAC,IAAI,CAAC,GAAG,IAAA,iBAAO,EAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM;QACZ,IAAI,CAAC;YACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACvG,OAAO;gBACL,CAAC,EAAE,EAAE;gBACL,IAAI,EAAE,iBAAiB;gBACvB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,mBAAmB;aAChC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;CACF;AAED,kBAAe,UAAU,CAAC"}
package/dist/esm/oca_package.js CHANGED
@@ -19,7 +19,7 @@ class OcaPackage {
19
19
  const extension_container = this.extensions.generate_extensions(this.extension_input, this.oca_bundle);
20
20
  return {
21
21
  d: '',
22
- type: 'adc/oca_package/1.0',
22
+ type: 'oca_package/1.0',
23
23
  oca_bundle: this.oca_bundle,
24
24
  extensions: extension_container,
25
25
  };
package/dist/esm/oca_package.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"oca_package.js","sourceRoot":"","sources":["../../src/oca_package.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,+CAA+C,CAAC;AAE/E,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAOlC,MAAM,UAAU;IAKd,YAAY,eAAmC,EAAE,UAAkB;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAC3C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAEO,UAAU;QAChB,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEM,IAAI;QACT,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM;QACZ,IAAI,CAAC;YACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACvG,OAAO;gBACL,CAAC,EAAE,EAAE;gBACL,IAAI,EAAE,qBAAqB;gBAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,mBAAmB;aAChC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;CACF;AAED,eAAe,UAAU,CAAC"}
1
+ {"version":3,"file":"oca_package.js","sourceRoot":"","sources":["../../src/oca_package.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,+CAA+C,CAAC;AAE/E,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAOlC,MAAM,UAAU;IAKd,YAAY,eAAmC,EAAE,UAAkB;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAC3C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAEO,UAAU;QAChB,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEM,IAAI;QACT,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM;QACZ,IAAI,CAAC;YACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACvG,OAAO;gBACL,CAAC,EAAE,EAAE;gBACL,IAAI,EAAE,iBAAiB;gBACvB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,mBAAmB;aAChC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;CACF;AAED,eAAe,UAAU,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "oca_package",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "The wrapper of OCA bundle to generate OCA Package at ADC",
5
5
  "type": "module",
6
6
  "main": "./dist/cjs/index.js",
@@ -15,9 +15,8 @@
15
15
  },
16
16
  "keywords": [
17
17
  "oca",
18
- "oca-package",
19
- "oca-extensions",
20
- "ordering overlay"
18
+ "oca_package",
19
+ "oca extensions"
21
20
  ],
22
21
  "sideEffects": false,
23
22
  "files": [
@@ -35,7 +34,7 @@
35
34
  },
36
35
  "repository": {
37
36
  "type": "git",
38
- "url": "https://github.com/agrifooddatacanada/OCA_Package.git"
37
+ "url": "https://github.com/agrifooddatacanada/OCA_Package"
39
38
  },
40
39
  "author": "Steven Mugisha Mizero <smugisha@uoguelph.ca>",
41
40
  "license": "EUPL-1.2",