@data-fair/lib-common-types 1.2.0 → 1.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-fair/lib-common-types",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Shared schemas and built type definitions in the data-fair stack.",
   "main": "index.js",
   "scripts": {

package/session/.type/index.d.ts

@@ -30,6 +30,7 @@ export interface User {
   ipa?: ShortForIgnorePersonalAccount;
   idp?: IsTheUserComingFromACoreIDProvider;
   os?: ShortForOrgStorage;
+  rememberMe?: boolean;
 }
 /**
  * This interface was referenced by `SessionState`'s JSON-Schema

package/session/.type/validate.js

@@ -5,10 +5,10 @@ import { fullFormats } from "ajv-formats/dist/formats.js";
 "use strict";
 export const validate = validate14;
 export default validate14;
-const schema16 = {"$id":"https://github.com/data-fair/lib/session-state","x-exports":["types","validate"],"type":"object","title":"session state","additionalProperties":false,"properties":{"user":{"$ref":"#/$defs/user"},"organization":{"$ref":"#/$defs/organizationMembership"},"account":{"$ref":"#/$defs/account"},"accountRole":{"type":"string"},"lang":{"type":"string"},"dark":{"type":"boolean"}},"$defs":{"organizationMembership":{"type":"object","additionalProperties":false,"required":["id","name","role"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"},"dflt":{"type":"integer","enum":[1]}}},"userRef":{"type":"object","additionalProperties":false,"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"user":{"type":"object","additionalProperties":false,"required":["email","id","name","organizations"],"properties":{"email":{"type":"string","format":"email"},"id":{"type":"string"},"name":{"type":"string"},"organizations":{"type":"array","items":{"$ref":"#/$defs/organizationMembership"}},"isAdmin":{"type":"integer","enum":[1]},"adminMode":{"type":"integer","enum":[1]},"asAdmin":{"$ref":"#/$defs/userRef"},"pd":{"type":"string","format":"date"},"ipa":{"type":"integer","title":"short for ignorePersonalAccount","enum":[1]},"idp":{"type":"integer","title":"Is the user coming from a core ID provider ?","enum":[1]},"os":{"type":"integer","title":"short for orgStorage","enum":[1]}}},"account":{"type":"object","additionalProperties":false,"required":["type","id","name"],"properties":{"type":{"type":"string","enum":["user","organization"]},"id":{"type":"string"},"name":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"}}}}};
+const schema16 = {"$id":"https://github.com/data-fair/lib/session-state","x-exports":["types","validate"],"type":"object","title":"session state","additionalProperties":false,"properties":{"user":{"$ref":"#/$defs/user"},"organization":{"$ref":"#/$defs/organizationMembership"},"account":{"$ref":"#/$defs/account"},"accountRole":{"type":"string"},"lang":{"type":"string"},"dark":{"type":"boolean"}},"$defs":{"organizationMembership":{"type":"object","additionalProperties":false,"required":["id","name","role"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"},"dflt":{"type":"integer","enum":[1]}}},"userRef":{"type":"object","additionalProperties":false,"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"user":{"type":"object","additionalProperties":false,"required":["email","id","name","organizations"],"properties":{"email":{"type":"string","format":"email"},"id":{"type":"string"},"name":{"type":"string"},"organizations":{"type":"array","items":{"$ref":"#/$defs/organizationMembership"}},"isAdmin":{"type":"integer","enum":[1]},"adminMode":{"type":"integer","enum":[1]},"asAdmin":{"$ref":"#/$defs/userRef"},"pd":{"type":"string","format":"date"},"ipa":{"type":"integer","title":"short for ignorePersonalAccount","enum":[1]},"idp":{"type":"integer","title":"Is the user coming from a core ID provider ?","enum":[1]},"os":{"type":"integer","title":"short for orgStorage","enum":[1]},"rememberMe":{"type":"boolean"}}},"account":{"type":"object","additionalProperties":false,"required":["type","id","name"],"properties":{"type":{"type":"string","enum":["user","organization"]},"id":{"type":"string"},"name":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"}}}}};
 const schema18 = {"type":"object","additionalProperties":false,"required":["id","name","role"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"},"dflt":{"type":"integer","enum":[1]}}};
 const schema21 = {"type":"object","additionalProperties":false,"required":["type","id","name"],"properties":{"type":{"type":"string","enum":["user","organization"]},"id":{"type":"string"},"name":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"}}};
-const schema17 = {"type":"object","additionalProperties":false,"required":["email","id","name","organizations"],"properties":{"email":{"type":"string","format":"email"},"id":{"type":"string"},"name":{"type":"string"},"organizations":{"type":"array","items":{"$ref":"#/$defs/organizationMembership"}},"isAdmin":{"type":"integer","enum":[1]},"adminMode":{"type":"integer","enum":[1]},"asAdmin":{"$ref":"#/$defs/userRef"},"pd":{"type":"string","format":"date"},"ipa":{"type":"integer","title":"short for ignorePersonalAccount","enum":[1]},"idp":{"type":"integer","title":"Is the user coming from a core ID provider ?","enum":[1]},"os":{"type":"integer","title":"short for orgStorage","enum":[1]}}};
+const schema17 = {"type":"object","additionalProperties":false,"required":["email","id","name","organizations"],"properties":{"email":{"type":"string","format":"email"},"id":{"type":"string"},"name":{"type":"string"},"organizations":{"type":"array","items":{"$ref":"#/$defs/organizationMembership"}},"isAdmin":{"type":"integer","enum":[1]},"adminMode":{"type":"integer","enum":[1]},"asAdmin":{"$ref":"#/$defs/userRef"},"pd":{"type":"string","format":"date"},"ipa":{"type":"integer","title":"short for ignorePersonalAccount","enum":[1]},"idp":{"type":"integer","title":"Is the user coming from a core ID provider ?","enum":[1]},"os":{"type":"integer","title":"short for orgStorage","enum":[1]},"rememberMe":{"type":"boolean"}}};
 const schema19 = {"type":"object","additionalProperties":false,"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}};
 const func2 = Object.prototype.hasOwnProperty;
 const formats0 = /^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/i;
@@ -486,9 +486,9 @@ vErrors.push(err39);
 errors++;
 }
 }
-}
-else {
-const err40 = {instancePath,schemaPath:"#/type",keyword:"type",params:{type: "object"},message:"must be object"};
+if(data.rememberMe !== undefined){
+if(typeof data.rememberMe !== "boolean"){
+const err40 = {instancePath:instancePath+"/rememberMe",schemaPath:"#/properties/rememberMe/type",keyword:"type",params:{type: "boolean"},message:"must be boolean"};
 if(vErrors === null){
 vErrors = [err40];
 }
@@ -497,6 +497,18 @@ vErrors.push(err40);
 }
 errors++;
 }
+}
+}
+else {
+const err41 = {instancePath,schemaPath:"#/type",keyword:"type",params:{type: "object"},message:"must be object"};
+if(vErrors === null){
+vErrors = [err41];
+}
+else {
+vErrors.push(err41);
+}
+errors++;
+}
 validate15.errors = vErrors;
 return errors === 0;
 }

package/session/index.d.ts

@@ -5,7 +5,11 @@ export * from './.type/index.js';
 export declare function isAuthenticated(sessionState: SessionState): sessionState is SessionStateAuthenticated;
 export declare function assertAuthenticated(sessionState: SessionState): asserts sessionState is SessionStateAuthenticated;
 export declare function assertAdminMode(sessionState: SessionState): asserts sessionState is SessionStateAuthenticated;
-export declare function getAccountRole(sessionState: SessionState, account: AccountKeys, onlyActiveAccount?: boolean): string | null;
-export declare function assertAccountRole(sessionState: SessionState, account: AccountKeys, role: string, onlyActiveAccount?: boolean): void;
+type AssertRoleOptions = {
+    allAccounts?: boolean;
+    acceptDepAsRoot?: boolean;
+};
+export declare function getAccountRole(sessionState: SessionState, account: AccountKeys, options?: AssertRoleOptions): string | null;
+export declare function assertAccountRole(sessionState: SessionState, account: AccountKeys, roles: string | string[], options?: AssertRoleOptions): void;
 export declare function isValidAccountType(type: string): type is 'user' | 'organization';
 export declare function assertValidAccountType(type: string): asserts type is 'user' | 'organization';

package/session/index.js

@@ -11,28 +11,31 @@ export function assertAdminMode (sessionState) {
   // TODO: use sessionState.locale to internationalize error message
   if (!sessionState.user.adminMode) { throw httpError(403, 'super admin only') }
 }
-function matchAccount (userAccount, resourceAccount) {
+function matchAccount (userAccount, resourceAccount, acceptDepAsRoot = false) {
   if (userAccount.type !== resourceAccount.type) { return false }
   if (userAccount.id !== resourceAccount.id) { return false }
-  if (userAccount.department && userAccount.department !== resourceAccount.department) { return false }
+  if (!acceptDepAsRoot) {
+    if (userAccount.department && userAccount.department !== resourceAccount.department) { return false }
+  }
   return true
 }
-export function getAccountRole (sessionState, account, onlyActiveAccount = true) {
+export function getAccountRole (sessionState, account, options = {}) {
   if (!isAuthenticated(sessionState)) { return null }
   if (sessionState.user.adminMode) { return 'admin' }
-  if (onlyActiveAccount) {
-    if (matchAccount(sessionState.account, account)) { return sessionState.accountRole }
-  } else {
+  if (options.allAccounts) {
     if (account.type === 'user' && sessionState.user.id === account.id) { return 'admin' }
     for (const org of sessionState.user.organizations) {
-      if (matchAccount({ type: 'organization', id: org.id, department: org.department }, account)) { return org.role }
+      if (matchAccount({ type: 'organization', id: org.id, department: org.department }, account, options.acceptDepAsRoot)) { return org.role }
     }
+  } else {
+    if (matchAccount(sessionState.account, account, options.acceptDepAsRoot)) { return sessionState.accountRole }
   }
   return null
 }
-export function assertAccountRole (sessionState, account, role, onlyActiveAccount = true) {
-  const accountRole = getAccountRole(sessionState, account, onlyActiveAccount)
-  if (accountRole !== role) { throw httpError(403, `requires ${role} role`) }
+export function assertAccountRole (sessionState, account, roles, options = {}) {
+  if (typeof roles === 'string') { roles = [roles] }
+  const accountRole = getAccountRole(sessionState, account, options)
+  if (!accountRole || !roles.includes(accountRole)) { throw httpError(403, `requires ${roles.join(', ')} role(s)`) }
 }
 export function isValidAccountType (type) {
   return ['user', 'organization'].includes(type)

package/session/schema.d.ts

@@ -115,6 +115,9 @@ declare const _default: {
                     title: string;
                     enum: number[];
                 };
+                rememberMe: {
+                    type: string;
+                };
             };
         };
         account: {

package/session/schema.js

@@ -126,6 +126,9 @@ export default {
           type: 'integer',
           title: 'short for orgStorage',
           enum: [1]
+        },
+        rememberMe: {
+          type: 'boolean'
         }
       }
     },