DOP-4916: Implement SoftwareSourceCode structured data #1258
There are no files selected for viewing
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
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,87 @@ | ||
| /** | ||
| * Classes to construct Structured Data JSON. | ||
| * Required props should be read in constructor function (to fail validity). | ||
| * Optional props can be set conditionally. | ||
| * Constant values should be set in the constructor function. | ||
| * Optional overwrites can be set in params as default values | ||
| */ | ||
|
|
||
| import { getFullLanguageName } from './get-language'; | ||
|
|
||
| export class StructuredData { | ||
| constructor(type) { | ||
| this['@context'] = 'https://schema.org'; | ||
| this['@type'] = type; | ||
| } | ||
|
|
||
| isValid() { | ||
| function recursiveValidity(param) { | ||
| // array | ||
| if (Array.isArray(param)) { | ||
| return param.every((e) => recursiveValidity(e)); | ||
| } | ||
| // object | ||
| else if (param && typeof param === 'object') { | ||
| return Object.keys(param).every((e) => { | ||
| if (param.hasOwnProperty(e)) return recursiveValidity(param[e]); | ||
| return true; | ||
| }); | ||
| } | ||
|
|
||
| // string or number | ||
| return String(param).length > 0; | ||
| } | ||
|
|
||
| return recursiveValidity(this); | ||
| } | ||
|
|
||
| toString() { | ||
| return JSON.stringify(this); | ||
| } | ||
|
|
||
| static addCompanyToName(name) { | ||
| if (!name) { | ||
| return name; | ||
| } | ||
| if (Array.isArray(name)) { | ||
| return name.map(this.addCompanyToName); | ||
| } | ||
| if (name.toLowerCase().includes('mongodb')) { | ||
| return name; | ||
| } | ||
| return `MongoDB ` + name; | ||
| } | ||
| } | ||
|
|
||
| export class SoftwareSourceCodeSd extends StructuredData { | ||
| constructor({ code, lang }) { | ||
| super('SoftwareSourceCode'); | ||
| this.codeSampleType = 'code snippet'; | ||
| this.text = code; | ||
|
|
||
| const programmingLanguage = getFullLanguageName(lang); | ||
| if (programmingLanguage) { | ||
| this.programmingLanguage = programmingLanguage; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| export class VideoObjectSd extends StructuredData { | ||
| constructor({ embedUrl, name, uploadDate, thumbnailUrl, description }) { | ||
| super('VideoObject'); | ||
|
|
||
| this.embedUrl = embedUrl; | ||
| this.name = name; | ||
| this.uploadDate = uploadDate; | ||
| this.thumbnailUrl = thumbnailUrl; | ||
|
|
||
| if (description) { | ||
| this.description = description; | ||
| } | ||
| } | ||
|
|
||
| isValid() { | ||
| const hasAllReqFields = [this.embedUrl, this.name, this.uploadDate, this.thumbnailUrl].every((val) => !!val); | ||
| return hasAllReqFields && super.isValid(); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
same minor point here for checking validity and returning !