Rethink Versioning

When a developer wants to use CloudEvents, they think about an event, not which version they’re using. The way this module is written is highly segmented towards the version of CloudEvent.

Rather than this:

const v1 = require("cloudevents-sdk/v1");

Where const v1 doesn’t make much sense.

We should have

const CloudEvents = require("cloudevents-sdk");

It should be easy to create a CloudEvent:

let myevent= new CloudEvent({
  specversion: '1.0',
  source: '/source',
  type: 'type',
  dataContentType: 'text/plain',
  dataschema: 'http://d.schema.com/my.json',
  subject: 'cha.json',
  data: 'my-data',
  addExtension: ["my-ext", "0x600"]
});

let myevent2= new CloudEvent({
  specversion: '0.3',
  source: '/source',
  type: 'type',
  dataContentType: 'text/plain',
  dataschema: 'http://d.schema.com/my.json',
  subject: 'cha.json',
  data: 'my-data',
  addExtension: ["my-ext", "0x600"]
});

We should remove the v03 and v1 folders in the repo and just have one CloudEvent that can support multiple versions.

[lance]

That’s in some ways what this pull request that landed yesterday was about.

const { CloudEvent, HTTPReceiver } = require('cloudevent-sdk');
const ce = new CloudEvent();
// Produces
// CloudEvent {
//  spec:
//   Spec1 {
//     payload:
//      { specversion: '1.0',
//        id: '888798a5-0a22-463a-b2d5-bd9a443c736b' },
//     caller: [Function: CloudEvent] },
//  formatter: JSONFormatter {},
//  extensions: {} }

And you can see the HTTPReceiver usage in the test here: https://github.com/cloudevents/sdk-javascript/blob/master/test/bindings/http/promiscuous_receiver_test.js#L13

Once a CloudEvent has been created, that instance cannot be changed to a different version by just setting the specversion property. You can see here, that was a conscious choice by @fabiojose and I think it makes sense. Converting from one specification version to another is more than just changing the version number.

With the changes that landed yesterday, when a CloudEvent is created using the constructor from the top level default export, it’s defaulting to an event conforming to the 1.0 spec. You can create a 0.3 event by reaching down into the v3 exports as before.

I think your direct object notation could be a nice change. But that’s already covered by https://github.com/cloudevents/sdk-javascript/issues/65 isn’t it?

[lance]

Closing this, as I think we have come to resolution. If not, feel free to reopen and we can discuss further.