@data-fair/lib-common-types 0.2.0 → 1.0.0

package/account/index.js

@@ -1 +1 @@
-export * from './.type/index.js';
+export * from './.type/index.js'

package/account/schema.json

@@ -0,0 +1,45 @@
+{
+  "$id": "https://github.com/data-fair/lib/account",
+  "x-exports": ["types", "validate", "schema"],
+  "type":"object",
+  "title": "account",
+  "required": ["type", "id", "name"],
+  "properties":{
+    "type":{
+      "type":"string",
+      "enum": ["user", "organization"]
+    },
+    "id":{
+      "type":"string"
+    },
+    "name":{
+      "type":"string"
+    },
+    "department":{
+      "type":"string"
+    },
+    "departmentName":{
+      "type":"string"
+    }
+  },
+  "$defs": {
+    "accountKeys": {
+      "type": "object",
+      "title": "account keys",
+      "required": ["type", "id"],
+      "additionalProperties": false,
+      "properties": {
+        "type":{
+          "type":"string",
+          "enum": ["user", "organization"]
+        },
+        "id": {
+          "type": "string"
+        },
+        "department": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/application/index.js

@@ -1 +1 @@
-export * from './.type/index.js';
+export * from './.type/index.js'

package/application/schema.json

@@ -0,0 +1,141 @@
+{
+  "$id": "https://github.com/data-fair/lib/application",
+  "title": "Application",
+  "x-exports": [
+    "types",
+    "schema"
+  ],
+  "type": "object",
+  "required": [
+    "id",
+    "title",
+    "exposedUrl",
+    "href",
+    "wsUrl",
+    "owner",
+    "configuration"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Globally unique identifier of the application"
+    },
+    "title": {
+      "type": "string",
+      "description": "Short title of the application"
+    },
+    "exposedUrl": {
+      "type": "string",
+      "description": "The URL where this application is exposed"
+    },
+    "href": {
+      "type": "string",
+      "description": "The URL where this resource can be fetched"
+    },
+    "wsUrl": {
+      "type": "string",
+      "description": "The URL where this application can be accessed through a websocket"
+    },
+    "owner": {
+      "$ref": "https://github.com/data-fair/lib/account#/$defs/accountKeys"
+    },
+    "configuration": {
+      "type": "object",
+      "description": "A free format configuration object used by applications. A minimal common structure is used to ensure proper linking between applications and datasets and remote services",
+      "additionalProperties": true,
+      "properties": {
+        "datasets": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/dataset"
+          }
+        }
+      }
+    }
+  },
+  "$defs": {
+    "dataset": {
+      "type": [
+        "object",
+        "null"
+      ],
+      "required": [
+        "href",
+        "id",
+        "title",
+        "finalizedAt"
+      ],
+      "properties": {
+        "href": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string"
+        },
+        "title": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string",
+          "description": "Not the id of the dataset, but a key inside this configuration object to define the role of the dataset in this context."
+        },
+        "schema": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/field"
+          }
+        },
+        "finalizedAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "field": {
+      "type": "object",
+      "required": [
+        "key",
+        "type"
+      ],
+      "properties": {
+        "key": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        },
+        "format": {
+          "type": "string"
+        },
+        "title": {
+          "type": "string"
+        },
+        "x-originalName": {
+          "type": "string"
+        },
+        "x-group": { "type": "string" },
+        "x-refersTo": {
+          "deprecated": true,
+          "type": ["string", "null"]
+        },
+        "x-concept": {
+          "type": "object",
+          "properties": {
+            "id": { "type": "string" },
+            "title": { "type": "string" },
+            "primary": { "type": "boolean" }
+          }
+        },
+        "x-labels": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "x-labelsRestricted": {
+          "type": "boolean"
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@data-fair/lib-common-types",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "Shared schemas and built type definitions in the data-fair stack.",
   "main": "index.js",
   "devDependencies": {},
   "files": [
+    "**/schema.json",
     "**/*.js",
     "**/*.d.ts"
   ],

package/processings.js

@@ -1 +1 @@
-export {};
+export {}

package/session/index.js

@@ -1,55 +1,42 @@
-import { httpError } from '@data-fair/lib-utils/http-errors.js';
-export * from './.type/index.js';
-export function isAuthenticated(sessionState) {
-    return !!sessionState.user;
-}
-export function assertAuthenticated(sessionState) {
-    if (!isAuthenticated(sessionState))
-        throw httpError(401);
-}
-export function assertAdminMode(sessionState) {
-    assertAuthenticated(sessionState);
-    // TODO: use sessionState.locale to internationalize error message
-    if (!sessionState.user.adminMode)
-        throw httpError(403, 'super admin only');
-}
-function matchAccount(userAccount, resourceAccount) {
-    if (userAccount.type !== resourceAccount.type)
-        return false;
-    if (userAccount.id !== resourceAccount.id)
-        return false;
-    if (userAccount.department && userAccount.department !== resourceAccount.department)
-        return false;
-    return true;
-}
-export function getAccountRole(sessionState, account, onlyActiveAccount = true) {
-    if (!isAuthenticated(sessionState))
-        return null;
-    if (sessionState.user.adminMode)
-        return 'admin';
-    if (onlyActiveAccount) {
-        if (matchAccount(sessionState.account, account))
-            return sessionState.accountRole;
+import { httpError } from '@data-fair/lib-utils/http-errors.js'
+export * from './.type/index.js'
+export function isAuthenticated (sessionState) {
+  return !!sessionState.user
+}
+export function assertAuthenticated (sessionState) {
+  if (!isAuthenticated(sessionState)) { throw httpError(401) }
+}
+export function assertAdminMode (sessionState) {
+  assertAuthenticated(sessionState)
+  // TODO: use sessionState.locale to internationalize error message
+  if (!sessionState.user.adminMode) { throw httpError(403, 'super admin only') }
+}
+function matchAccount (userAccount, resourceAccount) {
+  if (userAccount.type !== resourceAccount.type) { return false }
+  if (userAccount.id !== resourceAccount.id) { return false }
+  if (userAccount.department && userAccount.department !== resourceAccount.department) { return false }
+  return true
+}
+export function getAccountRole (sessionState, account, onlyActiveAccount = true) {
+  if (!isAuthenticated(sessionState)) { return null }
+  if (sessionState.user.adminMode) { return 'admin' }
+  if (onlyActiveAccount) {
+    if (matchAccount(sessionState.account, account)) { return sessionState.accountRole }
+  } else {
+    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 }
     }
-    else {
-        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;
-        }
-    }
-    return null;
+  }
+  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, role, onlyActiveAccount = true) {
+  const accountRole = getAccountRole(sessionState, account, onlyActiveAccount)
+  if (accountRole !== role) { throw httpError(403, `requires ${role} role`) }
 }
-export function isValidAccountType(type) {
-    return ['user', 'organization'].includes(type);
+export function isValidAccountType (type) {
+  return ['user', 'organization'].includes(type)
 }
-export function assertValidAccountType(type) {
-    if (!isValidAccountType(type))
-        throw httpError(400, 'invalid account type');
+export function assertValidAccountType (type) {
+  if (!isValidAccountType(type)) { throw httpError(400, 'invalid account type') }
 }

package/session/schema.json

@@ -0,0 +1,157 @@
+{
+  "$id": "https://github.com/data-fair/lib/session-state",
+  "x-exports": ["types", "validate", "schema"],
+  "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":"boolean"
+        }
+      }
+    },
+    "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":[
+            0,
+            1
+          ]
+        },
+        "adminMode":{
+          "type":"integer",
+          "enum":[
+            0,
+            1
+          ]
+        },
+        "asAdmin":{
+          "$ref":"#/$defs/userRef"
+        },
+        "pd":{
+          "type":"string",
+          "format":"date"
+        },
+        "ipa":{
+          "type":"integer",
+          "enum":[
+            0,
+            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"
+        }
+      }
+    }
+  }
+}

package/session/types.d.ts

@@ -1,2 +1,2 @@
-import { type SessionState } from './.type/index.js';
-export type SessionStateAuthenticated = SessionState & Required<Pick<SessionState, 'user' | 'account' | 'accountRole'>>;
+import { type SessionState } from './.type/index.js'
+export type SessionStateAuthenticated = SessionState & Required<Pick<SessionState, 'user' | 'account' | 'accountRole'>>

package/session/types.js

@@ -1 +1,2 @@
-export {};
+export {}
+// # sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJ0eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

package/ws.d.ts

@@ -1,22 +1,6 @@
-import { type Account } from '@data-fair/lib-common-types/session/index.js';
-type logFn = (msg: string, ...args: any[]) => void;
-export interface WsClientOpts {
-    log?: {
-        info: logFn;
-        error: logFn;
-        debug: logFn;
-    };
-    url: string;
-    headers?: Record<string, string>;
-    apiKey?: string;
-    adminMode?: boolean;
-    account?: Account;
-}
-export type FullWsClientOpts = WsClientOpts & Required<Pick<WsClientOpts, 'log'>>;
 export interface Message {
     type: string;
     channel: string;
     data?: any;
     status?: number;
 }
-export {};

package/ws.js

@@ -1 +1 @@
-export {};
+export {}