oca_package 1.0.0 → 1.0.1

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 +147 -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,150 @@
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
+
17
+ import { OcaPackage } from "oca_package";
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
+
35
+ const oca_bundle = {
36
+ v: "OCAA11JSON0008bc_",
37
+ bundle: {
38
+ v: "OCAS11JSON00089f_",
39
+ d: "ECpSix7tE3wyQM5jH5oaqdizR77rWdQ_BDP3AJn-Jykz",
40
+ capture_base: {
41
+ d: "EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW",
42
+ type: "spec/capture_base/1.0",
43
+ attributes: {
44
+ d: "Text",
45
+ i: "Text",
46
+ passed: "Boolean",
47
+ },
48
+ classification: "",
49
+ flagged_attributes: [],
50
+ },
51
+ overlays: {
52
+ character_encoding: {
53
+ d: "ED6Eio9KG2jHdFg3gXQpc0PX2xEI7aHnGDOpjU6VBfjs",
54
+ capture_base: "EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW",
55
+ type: "spec/overlays/character_encoding/1.0",
56
+ attribute_character_encoding: {
57
+ d: "utf-8",
58
+ i: "utf-8",
59
+ passed: "utf-8",
60
+ },
61
+ },
62
+ conformance: {
63
+ d: "EJSRe8DnLonKf6GVT_bC1QHoY0lQOG6-ldqxu7pqVCU8",
64
+ capture_base: "EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW",
65
+ type: "spec/overlays/conformance/1.0",
66
+ attribute_conformance: {
67
+ d: "M",
68
+ i: "M",
69
+ passed: "M",
70
+ },
71
+ },
72
+ entry: [
73
+ {
74
+ d: "EDQVwDAmYssKbGCcLYjYB_Kg5LPOgCTdT3ODzvXqKc1A",
75
+ capture_base: "EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW",
76
+ type: "spec/overlays/entry/1.0",
77
+ language: "eng",
78
+ attribute_entries: {
79
+ d: {
80
+ "001": "code1",
81
+ "002": "code2",
82
+ "003": "code3",
83
+ "004": "code4",
84
+ "005": "code5",
85
+ },
86
+ i: {
87
+ G: "Google",
88
+ I: "ISNI",
89
+ O: "ORCiD",
90
+ R: "ResearcherID",
91
+ S: "Scopus",
92
+ },
93
+ },
94
+ },
95
+ ],
96
+ entry_code: {
97
+ d: "EHrwr6xT_k3PHwd0y8RbIPGe0hDaELjJbjrKs_o8LfGY",
98
+ capture_base: "EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW",
99
+ type: "spec/overlays/entry_code/1.0",
100
+ attribute_entry_codes: {
101
+ d: ["001", "002", "003", "004", "005"],
102
+ i: ["G", "I", "O", "R", "S"],
103
+ },
104
+ },
105
+ information: [
106
+ {
107
+ d: "EIBXpVvka3_4lheeajtitiafIP78Ig8LDMVX9dXpCC2l",
108
+ capture_base: "EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW",
109
+ type: "spec/overlays/information/1.0",
110
+ language: "eng",
111
+ attribute_information: {
112
+ d: "Schema digest",
113
+ i: "Credential Issuee",
114
+ passed: "Enables or disables passing",
115
+ },
116
+ },
117
+ ],
118
+ label: [
119
+ {
120
+ d: "ECZc26INzjxVbNo7-hln6xN3HW3e1r6NGDmA5ogRo6ef",
121
+ capture_base: "EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW",
122
+ type: "spec/overlays/label/1.0",
123
+ language: "eng",
124
+ attribute_categories: [],
125
+ attribute_labels: {
126
+ d: "Schema digest",
127
+ i: "Credential Issuee",
128
+ passed: "Passed",
129
+ },
130
+ category_labels: {},
131
+ },
132
+ ],
133
+ meta: [
134
+ {
135
+ d: "EOxvie-zslkGmFzVqYAzTVtO7RyFXAG8aCqE0OougnGV",
136
+ capture_base: "EBnF9U9XW1EqteIW0ucAR4CsTUqojvfIWkeifsLRuOUW",
137
+ type: "spec/overlays/meta/1.0",
138
+ language: "eng",
139
+ description: "Entrance credential",
140
+ name: "Entrance credential",
141
+ },
142
+ ],
143
+ },
144
+ },
145
+ dependencies: [],
146
+ };
147
+
148
+ const oca_package = new OcaPackage(extension, oca_bundle);
149
+
150
+ ```
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.1",
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",