-
Notifications
You must be signed in to change notification settings - Fork 0
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
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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); | ||
}, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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 additionaltsc
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 👍
There was a problem hiding this comment.
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 ;)