dbm-graph-api 1.1.13 → 1.1.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dbm-graph-api",
-  "version": "1.1.13",
+  "version": "1.1.14",
   "main": "index.js",
   "type": "module",
   "scripts": {
@@ -13,7 +13,7 @@
   "dependencies": {
     "@aws-sdk/client-s3": "^3.741.0",
     "@aws-sdk/s3-request-presigner": "^3.741.0",
-    "dbm": "^1.1.9",
+    "dbm": "^1.1.10",
     "mime": "^4.0.6",
     "sharp": "^0.33.5",
     "ws": "^8.18.0"

package/src/dbm-graph-api/action/admin/index.js

@@ -1 +1,3 @@
-export {default as AddAndProcessAction} from "./AddAndProcessAction.js";
+export {default as AddAndProcessAction} from "./AddAndProcessAction.js";
+
+export * as setup from "./setup/index.js";

package/src/dbm-graph-api/action/admin/setup/SetupOrganization.js

@@ -0,0 +1,48 @@
+import Dbm from "dbm";
+
+export default class SetupOrganization extends Dbm.core.BaseObject {
+    _construct() {
+        super._construct();
+    }
+
+    async performAction(aData, aEncodeSession) {
+        let returnObject = {};
+
+        let user = await aEncodeSession.outputController.getUser();
+        
+        if(user) {
+            let database = Dbm.getInstance().repository.getItem("graphDatabase").controller;
+
+
+            let website = await database.getGlobalObject("website");
+            
+            if(website) {
+                let organization = await website.singleObjectRelationQuery("out:by:organization");
+                if(!organization) {
+                    organization = await database.createObject("private", ["organization"]); 
+                    await website.addOutgoingRelation(organization, "by");
+
+                    let localBusiness = await database.createObject("private", ["localBusiness"]);
+                    await organization.addIncomingRelation(localBusiness, "in");
+
+                    let location = await database.createObject("private", ["location"]);
+                    await location.updateField("name", "Local business location");
+                    localBusiness.addOutgoingRelation(location, "at");
+
+                    let schemaSubtype = "LocalBusiness";
+                    if(aData["localBusinessType"]) {
+                        schemaSubtype = aData["localBusinessType"]
+                    }
+                    let schemaType = await database.getTypeObject("schema/type", schemaSubtype);
+                    localBusiness.addIncomingRelation(schemaType, "for");
+
+                    returnObject["localBusinessId"] = localBusiness.id;
+                }
+            }
+
+            returnObject["websiteId"] = website.id;
+        }
+
+        return returnObject;
+    }
+}

package/src/dbm-graph-api/action/admin/setup/SetupWebsite.js

@@ -0,0 +1,29 @@
+import Dbm from "dbm";
+
+export default class SetupWebsite extends Dbm.core.BaseObject {
+    _construct() {
+        super._construct();
+    }
+
+    async performAction(aData, aEncodeSession) {
+        let returnObject = {};
+
+        let user = await aEncodeSession.outputController.getUser();
+        
+        if(user) {
+            let database = Dbm.getInstance().repository.getItem("graphDatabase").controller;
+
+            let globalObject = await database.getIdentifiableObject("globalObject", "website");
+
+            let website = await globalObject.singleObjectRelationQuery("out:pointingTo:*");
+            if(!website) {
+                website = await database.createObject("private", ["website"]); 
+                await globalObject.addOutgoingRelation(website, "pointingTo");
+            }
+
+            returnObject["id"] = website.id;
+        }
+
+        return returnObject;
+    }
+}

package/src/dbm-graph-api/action/admin/setup/index.js

@@ -0,0 +1,2 @@
+export {default as SetupWebsite} from "./SetupWebsite.js";
+export {default as SetupOrganization} from "./SetupOrganization.js"

package/src/dbm-graph-api/index.js

@@ -18,6 +18,7 @@ export * as data from "./data/index.js";
 export * as action from "./action/index.js";
 export * as processAction from "./processAction/index.js";
 export * as taskrunner from "./taskrunner/index.js";
+export * as schema from "./schema/index.js";
 
 let fullSelectSetup = function() {
     let selectPrefix = "graphApi/range/select/";
@@ -50,6 +51,12 @@ let fullSelectSetup = function() {
         let currentSelect = new DbmGraphApi.range.select.ObjectRelationQuery();
         currentSelect.item.register(selectPrefix + name);
     }
+
+    {
+        let name = "globalObjectRelationQuery";
+        let currentSelect = new DbmGraphApi.range.select.GlobalObjectRelationQuery();
+        currentSelect.item.register(selectPrefix + name);
+    }
 }
 
 export {fullSelectSetup};
@@ -167,6 +174,13 @@ let fullEncodeSetup = function() {
         currentEncode.item.register(encodePrefix + name);
         currentEncode.item.setValue("encodingType", name);
     }
+
+    {
+        let name = "admin_fields";
+        let currentEncode = new DbmGraphApi.range.encode.admin.Fields();
+        currentEncode.item.register(encodePrefix + name);
+        currentEncode.item.setValue("encodingType", name);
+    }
 }
 
 export {fullEncodeSetup};
@@ -207,6 +221,9 @@ let fullActionSetup = function() {
     registerActionFunction("cron/processActions", new DbmGraphApi.action.cron.ProcessActions());
     registerActionFunction("admin/addAndProcessAction", new DbmGraphApi.action.admin.AddAndProcessAction());
 
+    registerActionFunction("admin/setup/setupWebsite", new DbmGraphApi.action.admin.setup.SetupWebsite());
+    registerActionFunction("admin/setup/setupOrganization", new DbmGraphApi.action.admin.setup.SetupOrganization());
+
     registerActionFunction("development/restartServer", new DbmGraphApi.action.development.RestartServer());
     registerActionFunction("development/restartDatabaseConnection", new DbmGraphApi.action.development.RestartDatabaseConnection());
 }
@@ -541,6 +558,10 @@ export const setupSite = function(aServer) {
 			let url = await databaseObject.getUrl();
 			if(url) {
 				let fields = await databaseObject.getFields();
+
+                if(fields["seo/noIndex"]) {
+                    continue;
+                }
 				
 				response += '  <url>\n';
 				response += '    <loc>' + fullUrl + url + '</loc>\n';
@@ -673,13 +694,31 @@ export const setupSite = function(aServer) {
             if(fields["seo/noIndex"]) {
                 robotsSettings[0] = "noindex";
             }
-            if(fields["seo/nofollow"]) {
+            if(fields["seo/noFollow"]) {
                 robotsSettings[1] = "nofollow";
             }
 
             let content = robotsSettings.join(", ");
             returnString += `<meta name="robots" content="${content}" />`;
         }
+
+        let baseUrl = request.protocol + "://" + request.hostname;
+		if(request.port && request.port !== 80 && request.port !== 443) {
+			baseUrl += ":" + request.port;
+		}
+
+        let schemaGenrator = new DbmGraphApi.schema.JsonLdGenerator();
+        schemaGenrator.baseUrl = baseUrl;
+        let schemaMarkup = await schemaGenrator.getWebsiteEntites();
+        schemaMarkup = schemaMarkup.concat(await schemaGenrator.getPageEntites(urlObject))
+        let encodedMarkup = JSON.stringify(schemaMarkup, null, 2);
+
+        returnString += `<script type="application/ld+json">
+        {
+            "@context": "https://schema.org",
+            "@graph": ${encodedMarkup}
+        }
+        </script>`;
             
         returnString += `<title>${fields.title} - ${siteName}</title>
 
@@ -707,11 +746,7 @@ export const setupSite = function(aServer) {
 			`;
 		}
 
-		let fullUrl = request.protocol + "://" + request.hostname;
-		if(request.port && request.port !== 80 && request.port !== 443) {
-			fullUrl += ":" + request.port;
-		}
-		fullUrl += url;
+		let fullUrl = baseUrl + url;
 
 		returnString += `
 			<link rel="canonical" href="${fullUrl}" />

package/src/dbm-graph-api/range/encode/UrlRequest.js

@@ -21,6 +21,8 @@ export default class UrlRequest extends EncodeBaseObject {
 
         let fields = await object.getFields();
         returnObject["meta/description"] = fields["meta/description"] ? fields["meta/description"] : null;
+        returnObject["seo/noIndex"] = fields["seo/noIndex"] ? fields["seo/noIndex"] : false;
+        returnObject["seo/noFollow"] = fields["seo/noFollow"] ? fields["seo/noFollow"] : false;
 
         return returnObject;
     }

package/src/dbm-graph-api/range/encode/admin/Fields.js

@@ -0,0 +1,22 @@
+import Dbm from "dbm";
+import EncodeBaseObject from "../EncodeBaseObject.js";
+
+export default class Fields extends EncodeBaseObject {
+    _construct() {
+        super._construct();
+    }
+
+    async getEncodedData(aId, aEncodingSession) {
+
+        let returnObject = {};
+
+        await aEncodingSession.outputController.requireRole("admin");
+
+        let object = Dbm.getInstance().repository.getItem("graphDatabase").controller.getObject(aId);
+
+        let fields = await object.getFields();
+        returnObject["fields"] = fields;
+
+        return returnObject;
+    }
+}

package/src/dbm-graph-api/range/encode/admin/index.js

@@ -0,0 +1 @@
+export {default as Fields} from "./Fields.js";

package/src/dbm-graph-api/range/encode/index.js

@@ -15,4 +15,6 @@ export {default as Visibility} from "./Visibility.js";
 export {default as Relations} from "./Relations.js";
 export {default as ObjectTypes} from "./ObjectTypes.js";
 export {default as RepresentingPage} from "./RepresentingPage.js";
-export {default as PageRepresentation} from "./PageRepresentation.js";
+export {default as PageRepresentation} from "./PageRepresentation.js";
+
+export * as admin from "./admin/index.js";

package/src/dbm-graph-api/range/select/GlobalObjectRelationQuery.js

@@ -0,0 +1,41 @@
+import Dbm from "dbm";
+
+import SelectBaseObject from "./SelectBaseObject.js";
+
+export default class GlobalObjectRelationQuery extends SelectBaseObject {
+    _construct() {
+        super._construct();
+    }
+
+    async select(aQuery, aData, aRequest) {
+        //console.log("ObjectRelationQuery::select");
+
+        if(!aData["path"]) {
+            throw("Parameter path not set");
+        }
+        if(!aData["identifer"]) {
+            throw("Parameter identifer not set");
+        }
+
+        let database = Dbm.getInstance().repository.getItem("graphDatabase").controller;
+
+        let globalObject = await database.getGlobalObject(aData["identifer"]);
+
+        let fromIds = globalObject ? [globalObject.id] : [];
+
+        let ids;
+        if(aData["path"] === "(root)") {
+            ids = fromIds;
+        }
+        else {
+            ids = await database.objectRelationQuery(fromIds, aData["path"]);
+        }
+
+        console.log(ids);
+        await aQuery.includeOnly(ids);
+    }
+
+    async filter(aIds, aData, aRequest) {
+        return aIds;
+    }
+}

package/src/dbm-graph-api/range/select/index.js

@@ -3,4 +3,5 @@ export {default as IdSelection} from "./IdSelection.js";
 export {default as ByObjectType} from "./ByObjectType.js";
 export {default as IncludePrivate} from "./IncludePrivate.js";
 export {default as IncludeDraft} from "./IncludeDraft.js";
-export {default as ObjectRelationQuery} from "./ObjectRelationQuery.js";
+export {default as ObjectRelationQuery} from "./ObjectRelationQuery.js";
+export {default as GlobalObjectRelationQuery} from "./GlobalObjectRelationQuery.js";

package/src/dbm-graph-api/schema/JsonLdGenerator.js

@@ -0,0 +1,191 @@
+import Dbm from "dbm";
+
+export default class JsonLdGenerator extends Dbm.core.BaseObject{
+
+    _construct() {
+        super._construct();
+
+        this.baseUrl = null;
+        this.name = null;
+    }
+
+    async encodeWebsiteEntity(aDatabaseObject) {
+        console.log("encodeWebsiteEntity");
+
+        let site = Dbm.getInstance().repository.getItem("site");
+        let fields = await aDatabaseObject.getFields();
+    
+        return {
+            "@type": "WebSite",
+            "@id": this.baseUrl + "/" + "#website",
+            "url": this.baseUrl + "/",
+            "name": fields["name"] ? fields["name"] : site.name,
+            "publisher": {
+                "@id": this.baseUrl + "/" + "#organization"
+            }
+        };
+    }
+
+    async encodeOrganizationEntity(aDatabaseObject) {
+        console.log("encodeOrganizationEntity");
+
+        let site = Dbm.getInstance().repository.getItem("site");
+        let fields = await aDatabaseObject.getFields();
+    
+        return {
+            "@type": "Organization",
+            "@id": this.baseUrl + "/" + "#organization",
+            "url": this.baseUrl + "/",
+            "name": fields["name"] ? fields["name"] : site.name,
+        };
+
+        //Logo
+    }
+
+    async encodeLocalBusiness(aDatabaseObject) {
+
+        let site = Dbm.getInstance().repository.getItem("site");
+
+        let type = await aDatabaseObject.singleObjectRelationQuery("in:for:schema/type");
+        let typeName = await type.getIdentifier();
+        let fields = await aDatabaseObject.getFields();
+
+        let returnObject = {
+            "@type": typeName,
+            "@id": this.baseUrl + "/" + "#local-business",
+            "url": this.baseUrl + "/",
+            "name": fields["name"] ? fields["name"] : site.name,
+            "telephone": fields["phoneNumber"],
+            "email": fields["email"],
+            "priceRange": fields["priceRangeDescription"],
+            "parentOrganization": {
+                "@id": this.baseUrl + "/" + "#organization"
+            }
+        };
+
+        if(fields["rating/value"]) {
+            returnObject["aggregateRating"] = {
+                "@type": "AggregateRating",
+                "ratingValue": fields["rating/value"],
+                "reviewCount": fields["rating/count"],
+                "bestRating": fields["rating/max"] ? fields["rating/max"] : "5",
+                "worstRating": fields["rating/min"] ? fields["rating/min"] : "1",
+              }
+        }
+
+        let location = await aDatabaseObject.singleObjectRelationQuery("out:at:location");
+
+        if(location) {
+            let fields =  await location.getFields();
+
+            returnObject["address"] = {
+                "@type": "PostalAddress",
+                "streetAddress": fields["street"],
+                "addressLocality": fields["city"],
+                "postalCode": fields["postCode"],
+                "addressCountry": fields["country"]
+            },
+
+            returnObject["geo"] = {
+                "@type": "GeoCoordinates",
+                "latitude": fields["latitude"],
+                "longitude": fields["longitude"]
+            };
+        }
+
+        return returnObject;
+    }
+    
+    async getWebsiteEntites() {
+        console.log("getWebsiteEntites");
+    
+        let returnArray = [];
+        let database = Dbm.getInstance().repository.getItem("graphDatabase").controller;
+    
+        let website = await database.getGlobalObject("website");
+        if(website) {
+            returnArray.push(await this.encodeWebsiteEntity(website));
+
+            let organization = await website.singleObjectRelationQuery("out:by:organization");
+            returnArray.push(await this.encodeOrganizationEntity(organization));
+
+            let currentArray = await website.objectRelationQuery("out:by:organization,in:in:localBusiness");
+            let currentArrayLength = currentArray.length;
+            for(let i = 0; i < currentArrayLength; i++) {
+                let currentLocalBusiness = currentArray[i];
+                returnArray.push(await this.encodeLocalBusiness(currentLocalBusiness));
+            }
+        }
+    
+        return returnArray;
+    }
+
+    async getPageEntites(aPage) {
+
+        let database = Dbm.getInstance().repository.getItem("graphDatabase").controller;
+
+        let fields = await aPage.getFields();
+        let url = await aPage.getUrl();
+        let returnArray = [];
+
+        let fullUrl = this.baseUrl + url;
+
+        let pageObject = {
+            "@type": "WebPage",
+            "@id": fullUrl + "#webpage",
+            "url": fullUrl,
+            "name": fields["title"],
+            "description": fields["meta/description"],
+            "breadcrumb": {
+              "@id": fullUrl +"#breadcrumb"
+            },
+            
+          }
+          returnArray.push(pageObject);
+
+          let urlParts = url.split("/");
+          urlParts.pop();
+
+          let breadcrumbItems = [];
+
+          let currentUrl = "";
+          let currentArray = urlParts;
+          let currentArrayLength = currentArray.length;
+          for(let i = 0; i < currentArrayLength; i++) {
+            let currentPart = currentArray[i];
+            currentUrl += currentPart + "/";
+            let urlObject = await database.getObjectByUrl(currentUrl);
+            if(urlObject) {
+                let urlObjectFields = await urlObject.getFields();
+                let encodedStep = {
+                    "@type": "ListItem",
+                    "position": (i+1),
+                    "name": urlObjectFields["navigationName"] ? urlObjectFields["navigationName"] : urlObjectFields["title"],
+                    "item": this.baseUrl + currentUrl
+                  }
+                
+                  breadcrumbItems.push(encodedStep);
+            }
+          }
+
+            let breadcrumbList = {
+            "@type": "BreadcrumbList",
+            "@id": fullUrl + "#breadcrumb",
+            "itemListElement": breadcrumbItems
+          }
+
+          returnArray.push(breadcrumbList);
+
+        return returnArray;
+
+
+        
+
+          /*
+          "primaryImageOfPage": {
+              "@id": "https://example.com/product/acme-coffee-maker#primaryimage"
+            }
+              */
+    }
+}
+

package/src/dbm-graph-api/schema/index.js

@@ -0,0 +1 @@
+export {default as JsonLdGenerator} from "./JsonLdGenerator.js";