forked from w3c-ccg/vc-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
common.js
279 lines (266 loc) · 8.67 KB
/
common.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
/* globals omitTerms, respecConfig, $, require */
/* DID WG common Javascript ReSpec functions */
/* ... stolen from Gregg Kellogg of the JSON-LD 1.1 Working Group */
/* ... who stole it from Manu Sporny of the JSON-LD 1.0 Working Group */
/* ... who stole it from Shane McCarron, that beautiful, beautiful man. */
const ccg = {
// Add as the respecConfig localBiblio variable
// Extend or override global respec references
localBiblio: {
"DID-SPEC-REGISTRIES": {
title: "DID Specification Registries",
href: "https://w3c.github.io/did-spec-registries/",
authors: [
"Orie Steele",
"Manu Sporny"
],
status: "ED",
publisher: "Decentralized Identifier Working Group"
},
REST: {
title: "Architectural Styles and the Design of Network-based Software Architectures",
date: "2000",
href: "http://www.ics.uci.edu/~fielding/pubs/dissertation/",
authors: [
"Fielding, Roy Thomas"
],
publisher: "University of California, Irvine."
},
"VC-USECASES": {
title: "Verifiable Claims Use Cases",
href: "https://www.w3.org/TR/verifiable-claims-use-cases/",
authors: [
"Shane McCarron",
"Daniel Burnett",
"Gregg Kellogg",
"Brian Sletten",
"Manu Sporny"
],
status: "FPWD",
publisher: "Verifiable Claims Working Group"
},
"DID-USE-CASES": {
title: "Decentralized Identifier Use Cases",
href: "https://www.w3.org/TR/did-use-cases/",
authors: [
"Joe Andrieu",
"Kim Hamilton Duffy",
"Ryan Grant",
"Adrian Gropper"
],
status: "ED",
publisher: "Decentralized Identifier Working Group"
},
// aliases to known references
"HTTP-SIGNATURES": {
aliasOf: "http-signatures"
},
MACAROONS: {
title: 'Macaroons',
// TODO: create spec
href: 'http://macaroons.io/',
authors: ['Arnar Birgisson', 'Joe Gibbs Politz', 'Úlfar Erlingsson',
'Ankur Taly', 'Michael Vrable', 'Mark Lentczner'],
status: 'unofficial',
publisher: 'Credentials Community Group'
},
'OPEN-BADGES': {
title: 'Open Badges',
href: 'https://github.com/openbadges/openbadges-specification',
authors: ['Brian Brennan', 'Mike Larsson', 'Chris McAvoy',
'Nate Otto', 'Kerri Lemoie'],
status: 'BA-DRAFT',
publisher: 'Badge Alliance Standard Working Group'
},
'RDF-NORMALIZATION': {
title: 'RDF Dataset Normalization',
href: 'http://json-ld.github.io/normalization/spec/',
authors: ['Dave Longley', 'Manu Sporny'],
status: 'CG-DRAFT',
publisher: 'Credentials W3C Community Group'
},
"LD-PROOFS": {
title: "Linked Data Proofs",
href: "https://w3c-dvcg.github.io/ld-proofs/",
authors: [
"Manu Sporny",
"Dave Longley"
],
status: "CG-DRAFT",
publisher: "Digital Verification Community Group"
},
"LD-SIGNATURES": {
title: "Linked Data Signatures",
href: "https://w3c-dvcg.github.io/ld-signatures/",
authors: [
"Manu Sporny",
"Dave Longley"
],
status: "CG-DRAFT",
publisher: "Digital Verification Community Group"
},
"MATRIX-URIS": {
title: "Matrix URIs - Ideas about Web Architecture",
date: "December 1996",
href: "https://www.w3.org/DesignIssues/MatrixURIs.html",
authors: [
"Tim Berners-Lee"
],
status: "Personal View"
},
HASHLINK: {
title: "Cryptographic Hyperlinks",
date: "December 2018",
href: "https://tools.ietf.org/html/draft-sporny-hashlink-05",
authors: [
"Manu Sporny"
],
status: "Internet-Draft",
publisher: "IETF"
},
BASE58: {
title: "The Base58 Encoding Scheme",
date: "October 2020",
href: "https://tools.ietf.org/html/draft-msporny-base58",
authors: [
"Manu Sporny"
],
status: "Internet-Draft",
publisher: "IETF"
},
"DNS-DID": {
title: "The Decentralized Identifier (DID) in the DNS",
date: "February 2019",
href: "https://datatracker.ietf.org/doc/draft-mayrhofer-did-dns/",
authors: [
"Alexander Mayrhofer",
"Dimitrij Klesev",
"Markus Sabadello"
],
status: "Internet-Draft"
},
"DID-RESOLUTION": {
title: "Decentralized Identifier Resolution",
href: "https://w3c-ccg.github.io/did-resolution/",
authors: [
"Markus Sabadello",
"Dmitri Zagidulin"
],
status: "Draft Community Group Report",
publisher: "Credentials Community Group"
},
"DID-RUBRIC": {
title: "Decentralized Characteristics Rubric v1.0",
href: "https://w3c.github.io/did-rubric/",
authors: [
"Joe Andrieu"
],
status: "Draft Community Group Report",
publisher: "Credentials Community Group"
},
"PRIVACY-BY-DESIGN": {
title: "Privacy by Design",
href: "https://iapp.org/media/pdf/resource_center/pbd_implement_7found_principles.pdf",
authors: [
"Ann Cavoukian"
],
date: "2011",
publisher: "Information and Privacy Commissioner"
},
MULTIBASE: {
title: "The Multibase Encoding Scheme",
date: "February 2021",
href: "https://datatracker.ietf.org/doc/html/draft-multiformats-multibase-03",
authors: [
"Juan Benet",
"Manu Sporny"
],
status: "Internet-Draft",
publisher: "IETF"
},
"JSON-LD11": {
title: "JSON-LD 1.1",
date: "2020-07-16",
authors: [
"Gregg Kellogg", "Pierre-Antoine Champin", "Dave Longley"
],
status: "W3C Recommendation",
publisher: "W3C",
href: "https://www.w3.org/TR/json-ld11/"
},
"VC-DATA-MODEL": {
title: "Verifiable Credentials Data Model 1.0",
date: "2019-11-19",
authors: [
"Manu Sporny", "Grant Noble", "Dave Longley", "Daniel Burnett", "Brent Zundel"
],
status: "W3C Recommendation",
publisher: "W3C",
href: "https://www.w3.org/TR/vc-data-model/"
}
}
};
require(["core/pubsubhub"], respecEvents => {
"use strict";
respecEvents.sub('end-all', message => {
// remove data-cite on where the citation is to ourselves.
const selfDfns = document.querySelectorAll("dfn[data-cite^='" + respecConfig.shortName.toUpperCase() + "#']");
for(const dfn of selfDfns) {
delete dfn.dataset.cite;
}
// Update data-cite references to ourselves.
const selfRefs = document.querySelectorAll("a[data-cite^='" + respecConfig.shortName.toUpperCase() + "#']");
for(const anchor of selfRefs) {
anchor.href = anchor.dataset.cite.replace(/^.*#/, "#");
delete anchor.dataset.cite;
}
});
});
// Removes dfns that aren't referenced anywhere in the spec.
// To ensure a definition appears in the Terminology section, use
// and link to it!
// This is triggered by postProcess in the respec config.
function restrictRefs(utils, content, url) {
// Get set of ids internal dfns referenced in the spec body
const internalDfnLinks = document.querySelectorAll("a.internalDFN");
const internalDfnIds = new Set();
for(const dfnLink of internalDfnLinks) {
const dfnHref = dfnLink.href.split("#")[1];
internalDfnIds.add(dfnHref);
}
// Remove unused dfns from the termlist
const termlist = document.querySelector(".termlist");
const linkIdsInDfns = [];
for(const child of termlist.querySelectorAll("dfn")) {
if(!internalDfnIds.has(child.id)) {
const dt = child.closest("dt");
const dd = dt.nextElementSibling;
// Get internal links from dfns we're going to remove
// because these show up in the dfn-panels later and then
// trigger the local-refs-exist linter (see below)
const linksInDfn = dd.querySelectorAll("a.internalDFN");
for(link of linksInDfn) {
linkIdsInDfns.push(link.id);
}
termlist.removeChild(dt);
termlist.removeChild(dd);
}
}
// Remove unused dfns from the dfn-panels
// (these are hidden, but still trigger the local-refs-exist linter)
// (this seems like a hack, there's probably a better way to hook into respec
// before it gets to this point)
const dfnPanels = document.querySelectorAll(".dfn-panel");
for(const panel of dfnPanels) {
if(!internalDfnIds.has(panel.querySelector(".self-link").href.split("#")[1])) {
panel.parentNode.removeChild(panel);
}
// Remove references to dfns we removed which link to other dfns
const panelLinks = panel.querySelectorAll("li a");
for(const link of panelLinks) {
if(linkIdsInDfns.includes(link.href.split("#")[1])) {
link.parentNode.removeChild(link);
}
}
}
}