Include universal access API from inrupt

src/commands/solid-perms.ts

@@ -1,33 +1,7 @@
+import { getResourceInfo, universalAccess } from "@inrupt/solid-client";
+
 import { 
-  getAgentAccessAll, 
-  AgentAccess, 
-  Access, 
-  getPublicAccess, 
-  getResourceAcl, 
-  getGroupAccessAll, 
-  getAgentDefaultAccessAll, 
-  getPublicDefaultAccess, 
-  getGroupDefaultAccessAll, 
-  getAgentResourceAccessAll, 
-  getGroupResourceAccessAll, 
-  getPublicResourceAccess, 
-  getResourceInfoWithAcl, 
-  setAgentDefaultAccess, 
-  setGroupDefaultAccess, 
-  setPublicDefaultAccess, 
-  setAgentResourceAccess, 
-  setGroupResourceAccess, 
-  setPublicResourceAccess, 
-  hasAccessibleAcl,
-  getFallbackAcl,
-  AclDataset,
-  saveAclFor,
-  WithAccessibleAcl,
-  deleteAclFor,
-  hasResourceAcl,
-  createAclFromFallbackAcl,
-  hasFallbackAcl,
-  createAcl,
+  AccessModes,
 } from '@inrupt/solid-client';
 import { writeErrorString } from '../utils/util';
 import type { Logger } from '../logger';
@@ -39,143 +13,94 @@ export type Record<K extends keyof any, T> = {
   [P in K]: T;
 };
 
+export type UniversalAccess = {
+  read: boolean;
+  append: boolean;
+  write: boolean;
+  controlWrite: boolean;
+  controlRead: boolean;
+};
+
 
 export interface IPermissionListing {
   access: {
-    agent?: null | AgentAccess,
-    group?: null | Record<string, Access>,
-    public?: null | Access
+    agent?: null | Record<string, AccessModes>,
+    public?: null | AccessModes
   },
   default?: {
-    agent?: null | AgentAccess,
-    group?: null | Record<string, Access>,
-    public?: null | Access
+    agent?: null | Record<string, AccessModes>,
+    public?: null | AccessModes
   }
   resource?: {
-    agent?: null | AgentAccess,
-    group?: null | Record<string, Access>,
-    public?: null | Access
+    agent?: null | Record<string, AccessModes>,
+    public?: null | AccessModes
   }
 }
 
+
 export async function listPermissions(resourceUrl: string, options?: ICommandOptionsPermissions) {
   let commandOptions = setOptionDefaults<ICommandOptionsPermissions>(options || {});
 
   let permissions : IPermissionListing = { access: {} }
   try {
-    const resourceInfo = await getResourceInfoWithAcl(resourceUrl, { fetch: commandOptions.fetch })
-    permissions.access.agent = await getAgentAccessAll(resourceInfo)
-    permissions.access.group = await getGroupAccessAll(resourceInfo)
-    permissions.access.public = await getPublicAccess(resourceInfo)
-
-    let aclDataset = getResourceAcl(resourceInfo); 
-
-    if (aclDataset) {
-      permissions.default = {};
-      permissions.default.agent = await getAgentDefaultAccessAll(aclDataset)
-      permissions.default.group = await getGroupDefaultAccessAll(aclDataset)
-      permissions.default.public = await getPublicDefaultAccess(aclDataset)
-
-      permissions.resource = {};
-      permissions.resource.agent = await getAgentResourceAccessAll(aclDataset)
-      permissions.resource.group = await getGroupResourceAccessAll(aclDataset)
-      permissions.resource.public = await getPublicResourceAccess(aclDataset)
-
-    }
+    permissions.access.agent = await universalAccess.getAgentAccessAll(resourceUrl, {fetch: commandOptions.fetch})
+    permissions.access.public = await universalAccess.getPublicAccess(resourceUrl, {fetch: commandOptions.fetch})
     return permissions
   } catch (e) {
     if (commandOptions.verbose) writeErrorString(`Could not retrieve permissions for ${resourceUrl}`, e, commandOptions)
   }
 }
 
 export interface IPermissionOperation {
-  type: 'agent' | 'group' | 'public',
+  type: 'agent' | 'public',
   id?: string,
   read?: boolean,
   write?: boolean,
   append?: boolean,
   control?: boolean,
-  default?: boolean,
+  acl?: boolean,
 }
 
-export async function changePermissions(resourceUrl: string, operations: IPermissionOperation[], options?: ICommandOptionsPermissions) {
-  let commandOptions = setOptionDefaults<ICommandOptionsPermissions>(options || {});
 
-  const resourceInfo = await getResourceInfoWithAcl(resourceUrl, { fetch: commandOptions.fetch })
-  let aclDataset : AclDataset | null;
-  if (await hasResourceAcl(resourceInfo)) {
-    aclDataset = await getResourceAcl(resourceInfo); 
-  } else {
+// todo: getWebID here
+export async function setPermission(resourceUrl: string, operations: IPermissionOperation[], options?: ICommandOptionsPermissions) {
+  let commandOptions = setOptionDefaults<ICommandOptionsPermissions>(options || {});
+
+  for (let operation of operations) {
     try {
-      if (hasFallbackAcl(resourceInfo) && hasAccessibleAcl(resourceInfo)) {
-        aclDataset =  await createAclFromFallbackAcl(resourceInfo)
-      } else if (hasAccessibleAcl(resourceInfo)) {
-        aclDataset =  await createAcl(resourceInfo)
-      } else {
-        throw new Error('No acl found in path to root. This tool requires at least a root acl to be set.');
+      if (operation.type === 'agent') {
+        // Update access rights
+        if (!operation.id) { throw new Error('Please specify agent id in the passed operation.')}
+        let access: UniversalAccess = { read: false, write: false, append: false, controlRead: false, controlWrite: false }
+        access = updateAccess(access, operation)
+        // Update local acl for agent with new rights
+        await universalAccess.setAgentAccess(resourceUrl, operation.id, access, { fetch: commandOptions.fetch })
+      } else if (operation.type === 'public') {
+        // Update access rights
+        let access: UniversalAccess = { read: false, write: false, append: false, controlRead: false, controlWrite: false }
+        access = updateAccess(access, operation)
+        // Update local acl for agent with new rights
+        await universalAccess.setPublicAccess(resourceUrl, access, { fetch: commandOptions.fetch })
+      } else { 
+        if (commandOptions.verbose) writeErrorString("Incorrect operation type", 'Please provide an operation type of agent or public.', commandOptions)
       }
+      commandOptions.logger.log(`Updated permissions for: ${resourceUrl}`)
     } catch (e) {
-      throw new Error(`Could not find fallback ACL file to initialize permissions for ${resourceUrl}: ${(<Error>e).message}`)
+      if (commandOptions.verbose) writeErrorString(
+        `Problem setting permissions for resource ${resourceUrl} operation type`, (e as Error).message, commandOptions
+      )
     }
   }
-  if (!aclDataset) {
-    throw new Error(`You do not have the permissions to edit the ACL file for ${resourceUrl}`)
-  }
 
-  for (let operation of operations) {
-    if (operation.type === 'agent') {
-      // Update access rights
-      if (!operation.id) { throw new Error('Please specify agent id in the passed operation.')}
-      let access = { read: false, write: false, append: false, control: false }
-      access = updateAccess(access, operation)
-      // Update local acl for agent with new rights
-      if (operation.default) aclDataset = await setAgentDefaultAccess(aclDataset, operation.id, access)
-      aclDataset = await setAgentResourceAccess(aclDataset, operation.id, access)
-
-    } else if (operation.type === 'group') {
-      // Update access rights
-      if (!operation.id) { throw new Error('Please specify group id in the passed operation.')}
-      let access = { read: false, write: false, append: false, control: false }
-      access = updateAccess(access, operation)
-      // Update local acl for group with new rights
-      if (operation.default) aclDataset = await setGroupDefaultAccess(aclDataset, operation.id, access)
-      aclDataset = await setGroupResourceAccess(aclDataset, operation.id, access)
-
-    } else if (operation.type === 'public') {
-      // Update access rights
-      if (!operation.id) { throw new Error('Please specify agent id in the passed operation.')}
-      let access = { read: false, write: false, append: false, control: false }
-      access = updateAccess(access, operation)
-      // Update local acl for agent with new rights
-      if (operation.default) aclDataset = await setPublicDefaultAccess(aclDataset, access)
-      aclDataset = await setPublicResourceAccess(aclDataset, access)
-    } else { 
-      if (commandOptions.verbose) writeErrorString("Incorrect operation type", 'Please provide an operation type of agent, group or public.', commandOptions)
-    }
-  }
-  // Post updated acl to pod
-  if (aclDataset && await hasAccessibleAcl(resourceInfo)) {
-    await saveAclFor(resourceInfo as WithAccessibleAcl, aclDataset, {fetch: commandOptions.fetch})
-    if (commandOptions.verbose) commandOptions.logger.log(`Updated permissions for: ${resourceUrl}`)
-  }
-}
-
-export async function deletePermissions(resourceUrl: string, options?: ICommandOptionsPermissions) {
-  let commandOptions = setOptionDefaults<ICommandOptionsPermissions>(options || {});
-
-  let resourceInfo = await getResourceInfoWithAcl(resourceUrl, {fetch: commandOptions.fetch})
-  if (hasAccessibleAcl(resourceInfo)) {
-    await deleteAclFor(resourceInfo, {fetch: commandOptions.fetch})
-    if (commandOptions.verbose) commandOptions.logger.log(`Deleted resource at ${resourceUrl}`)
-  } else {
-    throw Error(`Resource at ${resourceUrl} does not have an accessible ACL resource`)
-  }
 }
 
-function updateAccess(access: Access, operation: IPermissionOperation) {
+function updateAccess(access: UniversalAccess, operation: IPermissionOperation) {
   if (operation.read !== undefined) access.read = operation.read
   if (operation.write !== undefined) access.write = operation.write
   if (operation.append !== undefined) access.append = operation.append
-  if (operation.control !== undefined) access.control = operation.control
+  if (operation.control !== undefined) { 
+    access.controlRead = operation.control 
+    access.controlWrite = operation.control 
+  }
   return access
-}
+}