Skip to content

Commit 986e2b2

Browse files
committed
fixup: remove unnecessary files copied from sdk-go
Signed-off-by: Lance Ball <[email protected]>
1 parent eb27489 commit 986e2b2

21 files changed

+315
-181
lines changed

.jsdoc.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,18 @@
66
"source": {
77
"include": ["lib", "package.json", "README.md"],
88
"includePattern": ".js$",
9-
"excludePattern": "(node_modules/|docs)"
9+
"excludePattern": "(node_modules/|docs|examples|coverage|test)"
1010
},
1111
"plugins": [
1212
"plugins/markdown"
1313
],
1414
"templates": {
1515
"referenceTitle": "cloudevents-sdk",
1616
"disableSort": false,
17-
"collapse": true
17+
"collapse": true,
18+
"resources": {
19+
"Concepts": "concepts.html"
20+
}
1821
},
1922
"opts": {
2023
"destination": "./docs/",

docs/CloudEvent.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,13 @@ <h3 class="reference-title">
6565
</h3>
6666

6767

68+
<h3>
69+
Resources
70+
</h3>
71+
72+
<a href="concepts.html">Concepts</a>
73+
74+
6875

6976
<h3>Classes</h3><ul><li id="CloudEvent-nav"><a href="CloudEvent.html">CloudEvent</a><ul class='methods'><li data-type="method" id="CloudEvent-addExtension-nav"><a href="CloudEvent.html#addExtension">addExtension</a></li><li data-type="method" id="CloudEvent-data-nav"><a href="CloudEvent.html#data">data</a></li><li data-type="method" id="CloudEvent-dataContenttype-nav"><a href="CloudEvent.html#dataContenttype">dataContenttype</a></li><li data-type="method" id="CloudEvent-format-nav"><a href="CloudEvent.html#format">format</a></li><li data-type="method" id="CloudEvent-getData-nav"><a href="CloudEvent.html#getData">getData</a></li><li data-type="method" id="CloudEvent-getDataContenttype-nav"><a href="CloudEvent.html#getDataContenttype">getDataContenttype</a></li><li data-type="method" id="CloudEvent-getExtensions-nav"><a href="CloudEvent.html#getExtensions">getExtensions</a></li><li data-type="method" id="CloudEvent-getFormats-nav"><a href="CloudEvent.html#getFormats">getFormats</a></li><li data-type="method" id="CloudEvent-getId-nav"><a href="CloudEvent.html#getId">getId</a></li><li data-type="method" id="CloudEvent-getSource-nav"><a href="CloudEvent.html#getSource">getSource</a></li><li data-type="method" id="CloudEvent-getSpecversion-nav"><a href="CloudEvent.html#getSpecversion">getSpecversion</a></li><li data-type="method" id="CloudEvent-getTime-nav"><a href="CloudEvent.html#getTime">getTime</a></li><li data-type="method" id="CloudEvent-getType-nav"><a href="CloudEvent.html#getType">getType</a></li><li data-type="method" id="CloudEvent-id-nav"><a href="CloudEvent.html#id">id</a></li><li data-type="method" id="CloudEvent-source-nav"><a href="CloudEvent.html#source">source</a></li><li data-type="method" id="CloudEvent-time-nav"><a href="CloudEvent.html#time">time</a></li><li data-type="method" id="CloudEvent-toString-nav"><a href="CloudEvent.html#toString">toString</a></li><li data-type="method" id="CloudEvent-type-nav"><a href="CloudEvent.html#type">type</a></li></ul></li><li id="HTTPReceiver-nav"><a href="HTTPReceiver.html">HTTPReceiver</a><ul class='methods'><li data-type="method" id="HTTPReceiver-accept-nav"><a href="HTTPReceiver.html#accept">accept</a></li></ul></li></ul>
7077
</nav>

docs/HTTPReceiver.html

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,13 @@ <h3 class="reference-title">
6565
</h3>
6666

6767

68+
<h3>
69+
Resources
70+
</h3>
71+
72+
<a href="concepts.html">Concepts</a>
73+
74+
6875

6976
<h3>Classes</h3><ul><li id="CloudEvent-nav"><a href="CloudEvent.html">CloudEvent</a><ul class='methods'><li data-type="method" id="CloudEvent-addExtension-nav"><a href="CloudEvent.html#addExtension">addExtension</a></li><li data-type="method" id="CloudEvent-data-nav"><a href="CloudEvent.html#data">data</a></li><li data-type="method" id="CloudEvent-dataContenttype-nav"><a href="CloudEvent.html#dataContenttype">dataContenttype</a></li><li data-type="method" id="CloudEvent-format-nav"><a href="CloudEvent.html#format">format</a></li><li data-type="method" id="CloudEvent-getData-nav"><a href="CloudEvent.html#getData">getData</a></li><li data-type="method" id="CloudEvent-getDataContenttype-nav"><a href="CloudEvent.html#getDataContenttype">getDataContenttype</a></li><li data-type="method" id="CloudEvent-getExtensions-nav"><a href="CloudEvent.html#getExtensions">getExtensions</a></li><li data-type="method" id="CloudEvent-getFormats-nav"><a href="CloudEvent.html#getFormats">getFormats</a></li><li data-type="method" id="CloudEvent-getId-nav"><a href="CloudEvent.html#getId">getId</a></li><li data-type="method" id="CloudEvent-getSource-nav"><a href="CloudEvent.html#getSource">getSource</a></li><li data-type="method" id="CloudEvent-getSpecversion-nav"><a href="CloudEvent.html#getSpecversion">getSpecversion</a></li><li data-type="method" id="CloudEvent-getTime-nav"><a href="CloudEvent.html#getTime">getTime</a></li><li data-type="method" id="CloudEvent-getType-nav"><a href="CloudEvent.html#getType">getType</a></li><li data-type="method" id="CloudEvent-id-nav"><a href="CloudEvent.html#id">id</a></li><li data-type="method" id="CloudEvent-source-nav"><a href="CloudEvent.html#source">source</a></li><li data-type="method" id="CloudEvent-time-nav"><a href="CloudEvent.html#time">time</a></li><li data-type="method" id="CloudEvent-toString-nav"><a href="CloudEvent.html#toString">toString</a></li><li data-type="method" id="CloudEvent-type-nav"><a href="CloudEvent.html#type">type</a></li></ul></li><li id="HTTPReceiver-nav"><a href="HTTPReceiver.html">HTTPReceiver</a><ul class='methods'><li data-type="method" id="HTTPReceiver-accept-nav"><a href="HTTPReceiver.html#accept">accept</a></li></ul></li></ul>
7077
</nav>
@@ -164,7 +171,7 @@ <h4 class="name" id="HTTPReceiver">
164171
<dd class="tag-source">
165172
<ul class="dummy">
166173
<li>
167-
<a href="bindings_http_http_receiver.js.html">bindings/http/http_receiver.js</a>, <a href="bindings_http_http_receiver.js.html#line14">line 14</a>
174+
<a href="bindings_http_http_receiver.js.html">bindings/http/http_receiver.js</a>, <a href="bindings_http_http_receiver.js.html#line21">line 21</a>
168175
</li>
169176
</ul>
170177
</dd>
@@ -364,7 +371,7 @@ <h5>Parameters:</h5>
364371
<dd class="tag-source">
365372
<ul class="dummy">
366373
<li>
367-
<a href="bindings_http_http_receiver.js.html">bindings/http/http_receiver.js</a>, <a href="bindings_http_http_receiver.js.html#line35">line 35</a>
374+
<a href="bindings_http_http_receiver.js.html">bindings/http/http_receiver.js</a>, <a href="bindings_http_http_receiver.js.html#line42">line 42</a>
368375
</li>
369376
</ul>
370377
</dd>

docs/bindings_http_http_receiver.js.html

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,13 @@ <h3 class="reference-title">
6767
</h3>
6868

6969

70+
<h3>
71+
Resources
72+
</h3>
73+
74+
<a href="concepts.html">Concepts</a>
75+
76+
7077

7178
<h3>Classes</h3><ul><li id="CloudEvent-nav"><a href="CloudEvent.html">CloudEvent</a><ul class='methods'><li data-type="method" id="CloudEvent-addExtension-nav"><a href="CloudEvent.html#addExtension">addExtension</a></li><li data-type="method" id="CloudEvent-data-nav"><a href="CloudEvent.html#data">data</a></li><li data-type="method" id="CloudEvent-dataContenttype-nav"><a href="CloudEvent.html#dataContenttype">dataContenttype</a></li><li data-type="method" id="CloudEvent-format-nav"><a href="CloudEvent.html#format">format</a></li><li data-type="method" id="CloudEvent-getData-nav"><a href="CloudEvent.html#getData">getData</a></li><li data-type="method" id="CloudEvent-getDataContenttype-nav"><a href="CloudEvent.html#getDataContenttype">getDataContenttype</a></li><li data-type="method" id="CloudEvent-getExtensions-nav"><a href="CloudEvent.html#getExtensions">getExtensions</a></li><li data-type="method" id="CloudEvent-getFormats-nav"><a href="CloudEvent.html#getFormats">getFormats</a></li><li data-type="method" id="CloudEvent-getId-nav"><a href="CloudEvent.html#getId">getId</a></li><li data-type="method" id="CloudEvent-getSource-nav"><a href="CloudEvent.html#getSource">getSource</a></li><li data-type="method" id="CloudEvent-getSpecversion-nav"><a href="CloudEvent.html#getSpecversion">getSpecversion</a></li><li data-type="method" id="CloudEvent-getTime-nav"><a href="CloudEvent.html#getTime">getTime</a></li><li data-type="method" id="CloudEvent-getType-nav"><a href="CloudEvent.html#getType">getType</a></li><li data-type="method" id="CloudEvent-id-nav"><a href="CloudEvent.html#id">id</a></li><li data-type="method" id="CloudEvent-source-nav"><a href="CloudEvent.html#source">source</a></li><li data-type="method" id="CloudEvent-time-nav"><a href="CloudEvent.html#time">time</a></li><li data-type="method" id="CloudEvent-toString-nav"><a href="CloudEvent.html#toString">toString</a></li><li data-type="method" id="CloudEvent-type-nav"><a href="CloudEvent.html#type">type</a></li></ul></li><li id="HTTPReceiver-nav"><a href="HTTPReceiver.html">HTTPReceiver</a><ul class='methods'><li data-type="method" id="HTTPReceiver-accept-nav"><a href="HTTPReceiver.html#accept">accept</a></li></ul></li></ul>
7279
</nav>
@@ -87,7 +94,14 @@ <h1 class="page-title">
8794
const V03Structured = require("./receiver_structured_0_3.js");
8895
const V1Binary = require("./receiver_binary_1.js");
8996
const V1Structured = require("./receiver_structured_1.js");
90-
const constants = require("./constants");
97+
const {
98+
SPEC_V03,
99+
SPEC_V1,
100+
HEADER_CONTENT_TYPE,
101+
MIME_CE,
102+
BINARY_HEADERS_1,
103+
DEFAULT_SPEC_VERSION_HEADER
104+
} = require("./constants");
91105

92106
/**
93107
* A class to receive a CloudEvent from an HTTP POST request.
@@ -121,33 +135,37 @@ <h1 class="page-title">
121135
const mode = getMode(headers);
122136
const version = getVersion(mode, headers, body);
123137
switch (version) {
124-
case constants.SPEC_V1:
138+
case SPEC_V1:
125139
return this.receivers.v1[mode].parse(body, headers);
126-
case constants.SPEC_V03:
140+
case SPEC_V03:
127141
return this.receivers.v03[mode].parse(body, headers);
128142
default:
129143
console.error(
130-
`Unknown spec version ${version}. Default to ${constants.SPEC_V1}`);
144+
`Unknown spec version ${version}. Default to ${SPEC_V1}`);
131145
return this.receivers.v1[mode].parse(body, headers);
132146
}
133147
}
134148
}
135149

136150
function getMode(headers) {
137-
let mode = "binary";
138-
const contentType = headers[constants.HEADER_CONTENT_TYPE];
139-
if (contentType &amp;&amp; contentType.startsWith(constants.MIME_CE)) {
151+
let mode = "unknown";
152+
const contentType = headers[HEADER_CONTENT_TYPE];
153+
if (contentType &amp;&amp; contentType.startsWith(MIME_CE)) {
140154
mode = "structured";
155+
} else if (headers[BINARY_HEADERS_1.ID]) {
156+
mode = "binary";
157+
} else {
158+
throw new TypeError("no cloud event detected");
141159
}
142160
return mode;
143161
}
144162

145163
function getVersion(mode, headers, body) {
146-
let version = constants.SPEC_V1; // default to 1.0
164+
let version = SPEC_V1; // default to 1.0
147165

148166
if (mode === "binary") {
149167
// Check the headers for the version
150-
const versionHeader = headers[constants.DEFAULT_SPEC_VERSION_HEADER];
168+
const versionHeader = headers[DEFAULT_SPEC_VERSION_HEADER];
151169
if (versionHeader) { version = versionHeader; }
152170
} else {
153171
// structured mode - the version is in the body

docs/cloudevent.js.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,13 @@ <h3 class="reference-title">
6767
</h3>
6868

6969

70+
<h3>
71+
Resources
72+
</h3>
73+
74+
<a href="concepts.html">Concepts</a>
75+
76+
7077

7178
<h3>Classes</h3><ul><li id="CloudEvent-nav"><a href="CloudEvent.html">CloudEvent</a><ul class='methods'><li data-type="method" id="CloudEvent-addExtension-nav"><a href="CloudEvent.html#addExtension">addExtension</a></li><li data-type="method" id="CloudEvent-data-nav"><a href="CloudEvent.html#data">data</a></li><li data-type="method" id="CloudEvent-dataContenttype-nav"><a href="CloudEvent.html#dataContenttype">dataContenttype</a></li><li data-type="method" id="CloudEvent-format-nav"><a href="CloudEvent.html#format">format</a></li><li data-type="method" id="CloudEvent-getData-nav"><a href="CloudEvent.html#getData">getData</a></li><li data-type="method" id="CloudEvent-getDataContenttype-nav"><a href="CloudEvent.html#getDataContenttype">getDataContenttype</a></li><li data-type="method" id="CloudEvent-getExtensions-nav"><a href="CloudEvent.html#getExtensions">getExtensions</a></li><li data-type="method" id="CloudEvent-getFormats-nav"><a href="CloudEvent.html#getFormats">getFormats</a></li><li data-type="method" id="CloudEvent-getId-nav"><a href="CloudEvent.html#getId">getId</a></li><li data-type="method" id="CloudEvent-getSource-nav"><a href="CloudEvent.html#getSource">getSource</a></li><li data-type="method" id="CloudEvent-getSpecversion-nav"><a href="CloudEvent.html#getSpecversion">getSpecversion</a></li><li data-type="method" id="CloudEvent-getTime-nav"><a href="CloudEvent.html#getTime">getTime</a></li><li data-type="method" id="CloudEvent-getType-nav"><a href="CloudEvent.html#getType">getType</a></li><li data-type="method" id="CloudEvent-id-nav"><a href="CloudEvent.html#id">id</a></li><li data-type="method" id="CloudEvent-source-nav"><a href="CloudEvent.html#source">source</a></li><li data-type="method" id="CloudEvent-time-nav"><a href="CloudEvent.html#time">time</a></li><li data-type="method" id="CloudEvent-toString-nav"><a href="CloudEvent.html#toString">toString</a></li><li data-type="method" id="CloudEvent-type-nav"><a href="CloudEvent.html#type">type</a></li></ul></li><li id="HTTPReceiver-nav"><a href="HTTPReceiver.html">HTTPReceiver</a><ul class='methods'><li data-type="method" id="HTTPReceiver-accept-nav"><a href="HTTPReceiver.html#accept">accept</a></li></ul></li></ul>
7279
</nav>

docs/concepts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ nav_order: 2
2525
[`CloudEvent`](CloudEvent.html).
2626
- Message Writer: Logic required to take in a `Message` in a specific encoding and write out to a
2727
given Protocol (request, message). A Message Writer can be a
28-
[`StructuredWriter`](../v2/binding/structured_writer.go),
29-
a [`BinaryWriter`](../v2/binding/binary_writer.go) or both, depending on what encodings a
28+
[`StructuredWriter`](../lib/bindings/http/emitter_structured.js),
29+
a [`BinaryWriter`](../lib/bindings/http/emitter_binary_1.js) or both, depending on what encodings a
3030
Protocol supports.
31-
- [`Client`](../v2/client/client.go): Interface to interact with a Protocol implementation
31+
- [`Client`](../lib/bindings/http/http_receiver.js): Interface to interact with a Protocol implementation
3232
to send/receive Events. Clients also provide protocol agnostic features that can be
3333
applied to events, such as extensions.
3434
- Extensions: Anything that extends the base requirements from the CloudEvents spec.

docs/event_data_structure.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

docs/formats_json_parser.js.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,13 @@ <h3 class="reference-title">
6767
</h3>
6868

6969

70+
<h3>
71+
Resources
72+
</h3>
73+
74+
<a href="concepts.html">Concepts</a>
75+
76+
7077

7178
<h3>Classes</h3><ul><li id="CloudEvent-nav"><a href="CloudEvent.html">CloudEvent</a><ul class='methods'><li data-type="method" id="CloudEvent-addExtension-nav"><a href="CloudEvent.html#addExtension">addExtension</a></li><li data-type="method" id="CloudEvent-data-nav"><a href="CloudEvent.html#data">data</a></li><li data-type="method" id="CloudEvent-dataContenttype-nav"><a href="CloudEvent.html#dataContenttype">dataContenttype</a></li><li data-type="method" id="CloudEvent-format-nav"><a href="CloudEvent.html#format">format</a></li><li data-type="method" id="CloudEvent-getData-nav"><a href="CloudEvent.html#getData">getData</a></li><li data-type="method" id="CloudEvent-getDataContenttype-nav"><a href="CloudEvent.html#getDataContenttype">getDataContenttype</a></li><li data-type="method" id="CloudEvent-getExtensions-nav"><a href="CloudEvent.html#getExtensions">getExtensions</a></li><li data-type="method" id="CloudEvent-getFormats-nav"><a href="CloudEvent.html#getFormats">getFormats</a></li><li data-type="method" id="CloudEvent-getId-nav"><a href="CloudEvent.html#getId">getId</a></li><li data-type="method" id="CloudEvent-getSource-nav"><a href="CloudEvent.html#getSource">getSource</a></li><li data-type="method" id="CloudEvent-getSpecversion-nav"><a href="CloudEvent.html#getSpecversion">getSpecversion</a></li><li data-type="method" id="CloudEvent-getTime-nav"><a href="CloudEvent.html#getTime">getTime</a></li><li data-type="method" id="CloudEvent-getType-nav"><a href="CloudEvent.html#getType">getType</a></li><li data-type="method" id="CloudEvent-id-nav"><a href="CloudEvent.html#id">id</a></li><li data-type="method" id="CloudEvent-source-nav"><a href="CloudEvent.html#source">source</a></li><li data-type="method" id="CloudEvent-time-nav"><a href="CloudEvent.html#time">time</a></li><li data-type="method" id="CloudEvent-toString-nav"><a href="CloudEvent.html#toString">toString</a></li><li data-type="method" id="CloudEvent-type-nav"><a href="CloudEvent.html#type">type</a></li></ul></li><li id="HTTPReceiver-nav"><a href="HTTPReceiver.html">HTTPReceiver</a><ul class='methods'><li data-type="method" id="HTTPReceiver-accept-nav"><a href="HTTPReceiver.html#accept">accept</a></li></ul></li></ul>
7279
</nav>

docs/images/Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.PHONY: all
2+
3+
all: $(patsubst %.dot,%.svg,$(wildcard *.dot))
4+
5+
%.svg: %.dot
6+
dot -Tsvg $< -o $@

docs/images/forwarder.dot

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
digraph {
2+
rankdir=LR;
3+
4+
Forwarder[shape=box]
5+
6+
downstream -> Forwarder;
7+
8+
Forwarder -> upstream;
9+
}

0 commit comments

Comments
 (0)