solid-panes 3.5.14 → 3.5.16-alpha-07d0f77b

package/src/argument/argumentPane.js

@@ -6,9 +6,9 @@
 ** Should allow editing the data too
 
 */
-
-const UI = require('solid-ui')
-const panes = require('pane-registry')
+import { store } from 'solid-logic'
+import * as UI from 'solid-ui'
+import * as panes from 'pane-registry'
 
 // console.log('@@@ argument pane icon at ' + (module.__dirname || __dirname) + '/icon_argument.png')
 module.exports = {
@@ -17,7 +17,7 @@ module.exports = {
   name: 'argument',
 
   label: function (subject) {
-    const kb = UI.store
+    const kb = store
     const t = kb.findTypeURIs(subject)
 
     if (t[UI.ns.arg('Position').uri]) return 'Argument'
@@ -28,7 +28,7 @@ module.exports = {
   // View the data in a file in user-friendly way
   render: function (subject, dom) {
     const outliner = panes.getOutliner(dom)
-    const kb = UI.store
+    const kb = store
     const arg = UI.ns.arg
 
     subject = kb.canon(subject)

package/src/dashboard/basicPreferences.ts

@@ -1,9 +1,8 @@
-import { authn, icons, ns, widgets } from 'solid-ui'
+import { PaneDefinition } from 'pane-registry'
 import { IndexedFormula, NamedNode, parse, Store } from 'rdflib'
-
-import preferencesFormText from './preferencesFormText.ttl'
+import { icons, login, ns, widgets } from 'solid-ui'
 import ontologyData from './ontologyData.ttl'
-import { PaneDefinition } from 'pane-registry'
+import preferencesFormText from './preferencesFormText.ttl'
 
 export const basicPreferencesPane: PaneDefinition = {
   icon: icons.iconBase + 'noun_Sliders_341315_000000.svg',
@@ -46,7 +45,7 @@ export const basicPreferencesPane: PaneDefinition = {
     loadData(ontologyExtra, ontologyData)
 
     async function doRender () {
-      const renderContext = await authn.logInLoadPreferences({
+      const renderContext = await login.ensureLoadedPreferences({
         dom,
         div: container
       })

package/src/dashboard/dashboardPane.ts

@@ -1,4 +1,5 @@
-import { authn, icons, store } from 'solid-ui'
+import { icons } from 'solid-ui'
+import { authn, authSession, store } from 'solid-logic'
 import { Fetcher, NamedNode } from 'rdflib'
 import { generateHomepage } from './homepage'
 import { DataBrowserContext, PaneDefinition } from 'pane-registry'
@@ -27,11 +28,11 @@ export const dashboardPane: PaneDefinition = {
       )
     }
 
-    authn.authSession.onLogin(() => {
+    authSession.onLogin(() => {
       // console.log('On Login')
       runBuildPage()
     })
-    authn.authSession.onSessionRestore(() => {
+    authSession.onSessionRestore(() => {
       // console.log('On Session Restore')
       runBuildPage()
     })

package/src/dataContentPane.js

@@ -38,7 +38,7 @@ module.exports = {
   },
   /*
   shouldGetFocus: function(subject) {
-      return UI.store.whether(subject, UI.ns.rdf('type'), UI.ns.link('RDFDocument'))
+      return store.whether(subject, UI.ns.rdf('type'), UI.ns.link('RDFDocument'))
   },
 */
   statementsAsTables: function statementsAsTables (sts, context, initialRoots) {

package/src/form/pane.js

@@ -3,8 +3,9 @@
  **
  */
 
-const UI = require('solid-ui')
-const $rdf = require('rdflib')
+import * as UI from 'solid-ui'
+import { authn } from 'solid-logic'
+import * as $rdf from 'rdflib'
 const ns = UI.ns
 
 module.exports = {
@@ -50,7 +51,7 @@ module.exports = {
 
     // const t = kb.findTypeURIs(subject)
 
-    const me = UI.authn.currentUser()
+    const me = authn.currentUser()
 
     const box = dom.createElement('div')
     box.setAttribute('class', 'formPane')
@@ -190,7 +191,7 @@ module.exports = {
       renderFormsFor(store, subject)
     } else {
       complain('No suitable store is known, to edit <' + subject.uri + '>.')
-      const foobarbaz = UI.authn.selectWorkspace(dom, function (ws) {
+      const foobarbaz = UI.login.selectWorkspace(dom, function (ws) {
         mention('Workspace selected OK: ' + ws)
 
         const activities = store.each(undefined, ns.space('workspace'), ws)

package/src/home/homePane.ts

@@ -8,10 +8,11 @@
  **
  */
 
-import { authn, create, icons } from 'solid-ui'
 import { PaneDefinition } from 'pane-registry'
-import { CreateContext } from 'solid-ui/lib/create/types'
 import { NamedNode } from 'rdflib'
+import { authn } from 'solid-logic'
+import { create, icons, login } from 'solid-ui'
+import { CreateContext } from 'solid-ui/lib/create/types'
 
 const HomePaneSource: PaneDefinition = {
   icon: icons.iconBase + 'noun_547570.svg', // noun_25830
@@ -37,7 +38,7 @@ const HomePaneSource: PaneDefinition = {
             var loginStatusDiv = div.appendChild(context.dom.createElement('div'))
             // TODO: Find out what the actual type is:
             type UriType = unknown;
-            loginStatusDiv.appendChild(UI.authn.loginStatusBox(context.dom, () => {
+            loginStatusDiv.appendChild(UI.login.loginStatusBox(context.dom, () => {
               // Here we know new log in status
             }))
       */
@@ -50,20 +51,20 @@ const HomePaneSource: PaneDefinition = {
         statusArea: div,
         me: me
       }
-      const relevantPanes = await authn.filterAvailablePanes(
+      const relevantPanes = await login.filterAvailablePanes(
         context.session.paneRegistry.list
       )
       create.newThingUI(creationContext, context, relevantPanes) // newUI Have to pass panes down
 
       div.appendChild(dom.createElement('h4')).textContent = 'Private things'
       // TODO: Replace by a common, representative interface
-      authn
+      login
         .registrationList(homePaneContext, { private: true })
         .then(function (authContext) {
           div.appendChild(dom.createElement('h4')).textContent = 'Public things'
           div.appendChild(dom.createElement('p')).textContent =
             'Things in this list are visible to others.'
-          authn
+          login
             .registrationList(authContext, { public: true })
             .then(function () {
               // done

package/src/index.ts

@@ -10,10 +10,9 @@
  ** If it is relevant, then it returns a suitable tooltip for a control which selects the pane
  */
 
-// create the unique UI module on which to attach panes (no, don't attach as UI dot panes any more)
-// var UI = require('solid-ui') // Note we will add the panes register to this.
 import versionInfo from './versionInfo'
-import * as UI from 'solid-ui'
+import { LiveStore } from 'rdflib'
+import { solidLogicSingleton, store } from 'solid-logic'
 import OutlineManager from './outline/manager.js'
 import registerPanes from './registerPanes.js'
 import {
@@ -21,44 +20,51 @@ import {
   paneForIcon,
   paneForPredicate,
   register,
-  byName,
-  LiveStore
+  byName
 } from 'pane-registry'
 import { createContext } from './outline/context'
+import initMainPage from './mainPage'
 
-export function getOutliner (dom) {
+function getOutliner (dom) {
   if (!dom.outlineManager) {
     const context = createContext(
       dom,
       { list, paneForIcon, paneForPredicate, register, byName },
-            UI.store as LiveStore,
-            UI.solidLogicSingleton
+            store as LiveStore,
+            solidLogicSingleton
     )
     dom.outlineManager = new OutlineManager(context)
   }
   return dom.outlineManager
 }
+
 if (typeof window !== 'undefined') {
   getOutliner(window.document)
 }
 
 registerPanes((cjsOrEsModule: any) => register(cjsOrEsModule.default || cjsOrEsModule))
 
-export {
-  list,
-  paneForIcon,
-  paneForPredicate,
-  register,
-  byName
-} from 'pane-registry'
-
-// We attach the solid-UI lower-level system for convenience
-// Currently most panes are built using it anyway.
-// It also gives access to rdflib as panes.UI.rdf
-
 // This has common outline mode functionality for the default and other other panes
 // A separate outline manager is required per DOM in cases like a browser extension
 // where there are many occurrences of window and of window.document
 // But each DOM should have just one outline manager.
 
-export { OutlineManager, UI, versionInfo }
+export {
+  OutlineManager,
+  getOutliner,
+  // UI,
+  versionInfo,
+  initMainPage,
+  list, // from paneRegistry
+  paneForIcon, // from paneRegistry
+  paneForPredicate, // from paneRegistry
+  register, // from paneRegistry
+  byName // from paneRegistry
+}
+
+// export for simpler access by non-node scripts
+if (typeof window !== 'undefined') {
+  ;(<any>window).panes = {
+    getOutliner
+  }
+}

package/src/mainPage/footer.ts

@@ -0,0 +1,19 @@
+import { IndexedFormula } from 'rdflib'
+import { initFooter } from 'solid-ui'
+
+/**
+ * links in the footer
+*/
+const SOLID_PROJECT_URL = 'https://solidproject.org'
+const SOLID_PROJECT_NAME = 'solidproject.org'
+
+export function createFooter (store: IndexedFormula) {
+  initFooter(store, setFooterOptions())
+}
+
+function setFooterOptions () {
+  return {
+    solidProjectUrl: SOLID_PROJECT_URL,
+    solidProjectName: SOLID_PROJECT_NAME
+  }
+}

package/src/mainPage/header.ts

@@ -0,0 +1,76 @@
+import { authSession, authn } from 'solid-logic'
+import { icons, initHeader } from 'solid-ui'
+/**
+ * menu icons
+*/
+const HELP_MENU_ICON = icons.iconBase + 'noun_help.svg'
+const SOLID_ICON_URL = 'https://solidproject.org/assets/img/solid-emblem.svg'
+
+/**
+ * menu elements
+*/
+const USER_GUIDE_MENU_ITEM = 'User guide'
+const REPORT_A_PROBLEM_MENU_ITEM = 'Report a problem'
+const SHOW_YOUR_PROFILE_MENU_ITEM = 'Show your profile'
+const LOG_OUT_MENU_ITEM = 'Log out'
+/**
+ * URLS
+ */
+const USER_GUIDE_MENU_URL = 'https://solid.github.io/userguide/'
+const REPORT_A_PROBLEM_MENU_URL = 'https://github.com/solid/solidos/issues'
+
+export async function createHeader (store, outliner) {
+  initHeader(store, await setUserMenu(outliner), setHeaderOptions())
+}
+
+function setHeaderOptions () {
+  const helpMenuList = [
+    { label: USER_GUIDE_MENU_ITEM, url: USER_GUIDE_MENU_URL, target: '_blank' },
+    { label: REPORT_A_PROBLEM_MENU_ITEM, url: REPORT_A_PROBLEM_MENU_URL, target: '_blank' }
+  ]
+  const headerOptions = { logo: SOLID_ICON_URL, helpIcon: HELP_MENU_ICON, helpMenuList: helpMenuList }
+
+  return headerOptions
+}
+
+async function setUserMenu (outliner: any) {
+  const showProfile = {
+    label: SHOW_YOUR_PROFILE_MENU_ITEM,
+    onclick: () => openUserProfile(outliner)
+  }
+
+  const logOut = {
+    label: LOG_OUT_MENU_ITEM,
+    onclick: () => {
+      authSession.logout()
+    }
+  }
+
+  // the order of the menu is important here, show profile first and logout last
+  let userMenuList = [showProfile]
+  userMenuList = userMenuList.concat(await getMenuItems(outliner))
+  userMenuList.push(logOut)
+
+  return userMenuList
+}
+
+function openUserProfile (outliner: any) {
+  outliner.GotoSubject(authn.currentUser(), true, undefined, true, undefined)
+  location.reload()
+}
+
+async function getMenuItems (outliner: any) {
+  const items = await outliner.getDashboardItems()
+  return items.map((element) => {
+    return {
+      label: element.label,
+      onclick: () => openDashboardPane(outliner, element.tabName || element.paneName)
+    }
+  })
+}
+
+async function openDashboardPane (outliner: any, pane: string): Promise<void> {
+  outliner.showDashboard({
+    pane
+  })
+}

package/src/mainPage/index.ts

@@ -0,0 +1,20 @@
+/*   Main Page
+ **
+ **  This code is called in mashlib and renders the header and footer of the Databrowser.
+ */
+
+import { IndexedFormula, NamedNode } from 'rdflib'
+import { getOutliner } from '../index'
+import { createHeader } from './header'
+import { createFooter } from './footer'
+
+export default async function initMainPage (store: IndexedFormula, uri?: string|NamedNode|null) {
+  const outliner = getOutliner(document)
+  uri = uri || window.location.href
+  let subject = uri
+  if (typeof uri === 'string') subject = store.sym(uri)
+  outliner.GotoSubject(subject, true, undefined, true, undefined)
+  const header = await createHeader(store, outliner)
+  const footer = createFooter(store)
+  return Promise.all([header, footer])
+}

package/src/microblogPane/microblogPane.js

@@ -3,13 +3,14 @@
  Charles McKenzie <charles2@mit.edu>
 */
 /* global alert */
-const UI = require('solid-ui')
+import { authn, store } from 'solid-logic'
+import * as UI from 'solid-ui'
 
 module.exports = {
   icon: UI.icons.originalIconBase + 'microblog/microblog.png',
   name: 'microblogPane',
   label: function (subject) {
-    if (UI.store.whether(subject, UI.ns.rdf('type'), UI.ns.foaf('Person'))) {
+    if (store.whether(subject, UI.ns.rdf('type'), UI.ns.foaf('Person'))) {
       return 'Microblog'
     } else {
       return null
@@ -25,9 +26,9 @@ module.exports = {
     const terms = UI.rdf.Namespace('http://purl.org/dc/terms/')
     const RDF = UI.ns.rdf
 
-    const kb = UI.store
+    const kb = store
     const charCount = 140
-    const sf = UI.store.fetcher
+    const sf = store.fetcher
     //* **********************************************
     // BACK END
     //* **********************************************
@@ -134,7 +135,7 @@ module.exports = {
       // attempt to fetch user account from local preferences if just
       // in case the user's foaf was not writable. add it to the store
       // this will probably need to change.
-      const theUser = UI.authn.currentUser()
+      const theUser = authn.currentUser()
 
       if (theUser) {
         let theAccount = UI.preferences.get('acct')
@@ -304,7 +305,7 @@ module.exports = {
       })
     }
     Microblog.prototype.getMyURI = function () {
-      const me = UI.authn.currentUser()
+      const me = authn.currentUser()
       console.log(me)
       const myMicroblog = kb.any(kb.sym(me), FOAF('holdsAccount'))
       console.log('\n\n' + myMicroblog)
@@ -533,7 +534,7 @@ module.exports = {
       } else if (resourceType.uri === SIOC('User').uri) {
         this.thisIsMe = s.uri === mb.getMyURI()
       } else if (resourceType.uri === FOAF('Person').uri) {
-        const me = UI.authn.currentUser()
+        const me = authn.currentUser()
         const meUri = me && me.uri
         this.thisIsMe = s.uri === meUri
       } else {
@@ -900,7 +901,7 @@ module.exports = {
         ) {
           creator = creators[c]
           // var mb = kb.sym(creator.uri.split("#")[0]);
-          // UI.store.fetcher.refresh(mb);
+          // store.fetcher.refresh(mb);
           break
           // TODO add support for more than one microblog in same foaf
         }

package/src/outline/context.ts

@@ -1,6 +1,7 @@
-import { DataBrowserContext, LiveStore, PaneRegistry } from 'pane-registry'
+import { DataBrowserContext, PaneRegistry } from 'pane-registry'
 import { getOutliner } from '../index'
 import { SolidLogic } from 'solid-logic'
+import { LiveStore } from 'rdflib'
 
 export function createContext (
   dom: HTMLDocument,

package/src/outline/dragDrop.js

@@ -20,9 +20,10 @@ if (!tabulator_gBrowser) {
 */
 
 /* 2007: adapted from dragAndDrop UI Library */
+import { store } from 'solid-logic'
+import * as UI from 'solid-ui'
+import * as $rdf from 'rdflib'
 
-const UI = require('solid-ui')
-const $rdf = require('rdflib')
 const dragAndDrop = (module.exports = {})
 
 dragAndDrop.util = {}
@@ -270,7 +271,7 @@ const TabulatorOutlinerObserver = {
         const templateDoc = $rdf.sym(
           'chrome://tabulator/content/internalKnowledge.n3#defaultNew'
         )
-        UI.store.copyTo(templateDoc, $rdf.sym(url))
+        store.copyTo(templateDoc, $rdf.sym(url))
         /*
       function WriteToFileRepresentedBy (subject){
           var outputFormulaTerm=kb.any(subject,OWL('unionOf'))
@@ -333,7 +334,7 @@ const TabulatorOutlinerObserver = {
     const thisOutline = table.outline
     thisOutline.UserInput.insertTermTo(
       targetTd,
-      UI.utils.getAbout(UI.store, this.dragTarget)
+      UI.utils.getAbout(store, this.dragTarget)
     )
   },
   onDragStart: function (x, y, td) {

package/src/outline/licenseOptions.js

@@ -3,6 +3,8 @@
 
 // tabulator.options becaome UI.licenseOptions
 // Possible future alternative directoons: Store licence preferences in a solid preferences file
+import * as UI from 'solid-ui'
+import { store } from 'solid-logic'
 
 const licenseURI = [
   'http://creativecommons.org/licenses/by-nc-nd/3.0/',
@@ -15,9 +17,6 @@ const licenseURI = [
 
 const names = ['BY-NC-ND', 'BY-NC-SA', 'BY-NC', 'BY-ND', 'BY-SA', 'BY']
 
-const UI = require('solid-ui')
-const kb = UI.store
-
 module.exports = function licenseOptions () {
   this.options = {}
   this.references = []
@@ -83,9 +82,9 @@ module.exports = function licenseOptions () {
   }
 
   this.checkLicence = function checkLicense (statement) {
-    const licenses = kb.each(
+    const licenses = store.each(
       statement.why,
-      kb.sym('http://creativecommons.org/ns#license')
+      store.sym('http://creativecommons.org/ns#license')
     )
     UI.log.info('licenses:' + statement.why + ': ' + licenses)
     for (let i = 0; i < licenses.length; i++) {