Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add typescript support #7

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@
"types": "./types/wit.d.ts",
"scripts": {
"build": "npx @bytecodealliance/jco componentize src/index.js --wit wit -o example-js-component.wasm -n data-collection -d all",
"build-typescript": "npx tsc & npx @bytecodealliance/jco componentize src/typescript/index.js --wit wit -o example-js-component.wasm -n data-collection -d all",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just for that i think its own repo is a good idea :D

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah I had to create another folder because tsc by default compiles index.ts into index.js (overwriting the existing JS file). And then the build script needs the additional tsc step to generate the .js file, so it can't be 100% identical either.

I'd also agree this is enough to justify splitting to its own repo 👍

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexcasalboni, I'd definitely recommend splitting TypeScript into its own repo. Mixing JS and TS adds extra build steps and potential conflicts (like overwriting issues), plus not everyone uses TS. Keeping them separate makes things cleaner, easier to maintain, and avoids unnecessary complexity. Sounds like a win-win ;)

"test": "mocha",
"coverage": "c8 --src js --all -r text -r text-summary npm test"
},
"devDependencies": {
"c8": "^10.1.3",
"mocha": "^11.1.0"
"mocha": "^11.1.0",
"typescript": "^5.7.3"
}
}
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const API_ENDPOINT = "https://your-endpoint.com/path";
*
* @returns {Map}
*/
export const convertDict = (dict) => {
const convertDict = (dict) => {
let data = {};

for (let [key, value] of dict) {
Expand Down
120 changes: 120 additions & 0 deletions src/typescript/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
import {
EdgeeProtocolsDataCollection,
EdgeeRequest,
Dict,
Event,
PageData,
TrackData,
UserData,
Context
} from "../../types/interfaces/edgee-protocols-data-collection"

const API_ENDPOINT: string = "https://your-endpoint.com/path";

const convertDict = (dict: Dict): Map<string, string> => {
let data = new Map<string, string>();

for (let [key, value] of dict) {
data.set(key, value);
}

return data;
};

const buildEdgeeRequest = (payload: any, apiKey: string): EdgeeRequest => ({
method: 'POST',
url: API_ENDPOINT,
headers: [
['Content-Type', 'application/json'],
["Authorization", `Bearer ${apiKey}`],
],
body: JSON.stringify(payload),
forwardClientHeaders: true,
});

const buildPagePayload = (data: PageData, context: Context): any => {
const sessionId = parseInt(context.session.sessionId);
const pageTitle = data.title;
// TODO extract data/context fields and build payload object
return {
sessionId,
pageTitle,
};
};

const buildTrackPayload = (data: TrackData, context: Context): any => {
const sessionId = parseInt(context.session.sessionId);
const eventName = data.name;
const eventProperties = convertDict(data.properties);
// TODO extract data/context fields and build payload object
return {
sessionId,
eventName,
eventProperties,
};
};

const buildUserPayload = (data: UserData, context: Context): any => {
const sessionId = parseInt(context.session.sessionId);
const userId = data.userId;
// TODO extract data/context fields and build payload object
return {
sessionId,
userId,
};
};

export const dataCollection: typeof EdgeeProtocolsDataCollection = {

page(e: Event, settings: Dict) {
if (e.data.tag != 'page') {
throw new Error("Missing page data");
}

// convert to native object
const dictSettings = convertDict(settings);
const apiKey = dictSettings.get('your_api_key');
if (!apiKey) throw new Error("Missing API key");

// build payload
const payload = buildPagePayload(e.data.val, e.context);

// build and return EdgeeRequest
return buildEdgeeRequest(payload, apiKey);
},

track(e: Event, settings: Dict) {
if (e.data.tag != 'track') {
throw new Error("Missing track data");
}

// convert to native object
const dictSettings = convertDict(settings);
const apiKey = dictSettings.get('your_api_key');
if (!apiKey) throw new Error("Missing API key");


// build payload
const payload = buildTrackPayload(e.data.val, e.context);

// build and return EdgeeRequest
return buildEdgeeRequest(payload, apiKey);
},

user(e: Event, settings: Dict) {
if (e.data.tag != 'user') {
throw new Error("Missing user data");
}

// convert to native object
const dictSettings = convertDict(settings);
const apiKey = dictSettings.get('your_api_key');
if (!apiKey) throw new Error("Missing API key");

// build payload
const payload = buildUserPayload(e.data.val, e.context);

// build and return EdgeeRequest
return buildEdgeeRequest(payload, apiKey);
},
};
11 changes: 11 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"files": [
"src/typescript/index.ts",
],
"compilerOptions": {
"target": "es6",
"module": "es6",
"strict": true,
"skipLibCheck": true
}
}