Class SDOAdapter

const vocabularyOne = require("./myVocabulary.json"); // loads a local JSON-LD vocabulary file
const vocabularyTwo = "https://raw.githubusercontent.com/semantifyit/schemaorg/main/data/releases/13.0/schemaorg-all-https.jsonld"; // URL pointing to the schema.org vocabulary

// add the two vocabularies to the SDOAdapter instance
await mySdoAdapter.addVocabularies( [vocabularyOne, vocabularyTwo] );

const schemaUrl = await mySdoAdapter.constructURLSchemaVocabulary("13.0");
// creates following URL pointing to the schema.org vocabulary version 13.0
"https://raw.githubusercontent.com/semantifyit/schemaorg/main/data/releases/13.0/schemaorg-all-https.jsonld"

// creates an array with Class instances for all classes known to mySdoAdapter
const allClassesArray = mySdoAdapter.getAllClasses();

// creates an array with DataType instances for all data-types known to mySdoAdapter
const allDataTypesArray = mySdoAdapter.getAllDataTypes();

// creates an array with EnumerationMember instances for all enumeration members known to mySdoAdapter
const allEnumerationMembersArray = mySdoAdapter.getAllEnumerationMembers();

// creates an array with Enumeration instances for all enumerations known to mySdoAdapter
const allEnumerationsArray = mySdoAdapter.getAllEnumerations();

// creates an array with Property instances for all properties known to mySdoAdapter
const allPropertiesArray = mySdoAdapter.getAllProperties();

// creates an array with term instances for all terms known to mySdoAdapter
const allTermsArray = mySdoAdapter.getAllTerms();

// creates a Class instance for schema:Hotel
const classInstance = mySdoAdapter.getClass("schema:Hotel");

// creates a DataType instance for schema:Number
const dataTypeInstance = mySdoAdapter.getDataType("schema:Number");

const defaultFilter = mySdoAdapter.getDefaultFilter();

// creates an Enumeration instance for schema:DayOfWeek
const enumerationInstance = mySdoAdapter.getEnumeration("schema:DayOfWeek");

// creates an EnumerationMember instance for schema:Monday
const enumerationMemberInstance = mySdoAdapter.getEnumerationMember("schema:Monday");

const latestSchemaVersion = await mySdoAdapter.getLatestSchemaVersion();
// get the latest schema.org vocabulary version identifier
"13.0"

const allClassesArray = mySdoAdapter.getListOfClasses();
// creates an array with IRIs of all class terms known to mySdoAdapter
[
  'schema:CollegeOrUniversity',
  'schema:Hotel',
  'schema:Patient',
  ...
]

const allClassesArrayAbsoluteIRIs = mySdoAdapter.getListOfClasses({outputFormat: "Absolute"});
// creates an array with absolute IRIs
[
  'https://schema.org/CollegeOrUniversity',
  'https://schema.org/Hotel',
  'https://schema.org/Patient',
  ...
]

const allDataTypesArray = mySdoAdapter.getListOfDataTypes();
// creates an array with IRIs of all data-type terms known to mySdoAdapter
[
  'schema:Text',
  'schema:URL',
  'schema:Date',
  ...
]

const allDataTypesArrayAbsoluteIRIs = mySdoAdapter.getListOfDataTypes({outputFormat: "Absolute"});
// creates an array with absolute IRIs
[
  'https://schema.org/Text',
  'https://schema.org/URL',
  'https://schema.org/Date',
  ...
]

const allEnumerationMembersArray = mySdoAdapter.getListOfEnumerationMembers();
// creates an array with IRIs of all enumeration member terms known to mySdoAdapter
[
  'schema:PublicHolidays',
  'schema:UnofficialLegalValue',
  'schema:SoundtrackAlbum',
  ...
]

const allEnumerationMembersArrayAbsoluteIRIs = mySdoAdapter.getListOfEnumerationMembers({outputFormat: "Absolute"});
// creates an array with absolute IRIs
[
  'https://schema.org/PublicHolidays',
  'https://schema.org/UnofficialLegalValue',
  'https://schema.org/SoundtrackAlbum',
  ...
]

const allEnumerationsArray = mySdoAdapter.getListOfEnumerations();
// creates an array with IRIs of all enumeration terms known to mySdoAdapter
[
  'schema:PaymentMethod',
  'schema:DayOfWeek',
  'schema:GenderType',
  ...
]

const allEnumerationsArrayAbsoluteIRIs = mySdoAdapter.getListOfEnumerations({outputFormat: "Absolute"});
// creates an array with absolute IRIs
[
  'https://schema.org/PaymentMethod',
  'https://schema.org/DayOfWeek',
  'https://schema.org/GenderType',
  ...
]

const allPropertiesArray = mySdoAdapter.getListOfProperties();
// creates an array with IRIs of all property terms known to mySdoAdapter
[
  'schema:name',
  'schema:url',
  'schema:openingHours',
  ...
]

const allPropertiesArrayAbsoluteIRIs = mySdoAdapter.getListOfProperties({outputFormat: "Absolute"});
// creates an array with absolute IRIs
[
  'https://schema.org/name',
  'https://schema.org/url',
  'https://schema.org/openingHours',
  ...
]

const allTermsArray = mySdoAdapter.getListOfTerms();
// creates an array with IRIs of all terms known to mySdoAdapter
[
  'schema:CollegeOrUniversity',
  'schema:name',
  'schema:Monday',
  ...
]

const allTermsArrayAbsoluteIRIs = mySdoAdapter.getListOfTerms({outputFormat: "Absolute"});
// creates an array with absolute IRIs
[
  'https://schema.org/CollegeOrUniversity',
  'https://schema.org/name',
  'https://schema.org/Monday',
  ...
]

// creates a Property instance for schema:name
const propertyInstance = mySdoAdapter.getProperty("schema:name");

// creates a Class instance for schema:Hotel - using the compact IRI for identification is the recommended approach
const classInstance = mySdoAdapter.getTerm("schema:Hotel");

// creates a Property instance for schema:openingHours (handling of http/https is based on the setting "equateVocabularyProtocols")
const propertyInstance = mySdoAdapter.getTerm("https://schema.org/openingHours");

// creates an Enumeration instance for schema:DayOfWeek - Using the label for identification is risky when you have multiple vocabularies that may have equal labels
const enumerationInstance = mySdoAdapter.getTerm("DayOfWeek");

// assume mySdoAdapter has been initialized with schema.org and another example vocabulary
const usedVocabularies = mySdoAdapter.getVocabularies(); // same as mySdoAdapter.getVocabularies(true)
// creates an object with vocabulary indicators as keys, and their vocabulary namespaces as values
{
  "schema": "https://schema.org/",
  "ex": "https://example-vocab.ex/"
}

mySdoAdapter.setDefaultFilter({
  schemaModuleExclude: "attic",
  isSuperseded: false
});