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

package/account/index.d.ts

@@ -0,0 +1 @@
+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.d.ts

@@ -0,0 +1 @@
+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.1.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.d.ts

@@ -0,0 +1,34 @@
+import type { AxiosInstance } from 'axios';
+import type { DataFairWsClient } from '@data-fair/lib-node/ws-client.js';
+/**
+ * Processing context.
+ */
+export interface ProcessingContext {
+    processingConfig: any;
+    pluginConfig: any;
+    processingId: string;
+    dir: string;
+    tmpDir: string;
+    log: LogFunctions;
+    axios: AxiosInstance;
+    ws: DataFairWsClient;
+    sendMail: (mail: string) => Promise<void>;
+    patchConfig: (patch: {
+        datasetMode: string;
+        dataset: any;
+    }) => Promise<void>;
+}
+/**
+ * Log functions.
+ */
+export interface LogFunctions {
+    step: (msg: string) => Promise<void>;
+    error: (msg: string, extra?: any) => Promise<void>;
+    warning: (msg: string, extra?: any) => Promise<void>;
+    info: (msg: string, extra?: any) => Promise<void>;
+    debug: (msg: string, extra?: any) => Promise<void>;
+    task: (name: string) => Promise<void>;
+    progress: (taskName: string, progress: number, total: number) => Promise<void>;
+    testInfo?: (msg: any, extra?: any) => void;
+    testDebug?: (msg: any, extra?: any) => void;
+}

package/processings.js

@@ -0,0 +1 @@
+export {}

package/session/index.d.ts

@@ -0,0 +1,11 @@
+import type { AccountKeys } from '../account/index.js';
+import { type SessionState } from './.type/index.js';
+export type SessionStateAuthenticated = SessionState & Required<Pick<SessionState, 'user' | 'account' | 'accountRole'>>;
+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;
+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

@@ -1,78 +1,42 @@
-/**
- * @typedef {import('./types.js').SessionStateAuthenticated} SessionStateAuthenticated
- * @typedef {import('./.type/index.js').SessionState} SessionState
- */
-
-import { httpError } from '@data-fair/lib/http-errors.js'
-
+import { httpError } from '@data-fair/lib-utils/http-errors.js'
 export * from './.type/index.js'
-
-/** @type {(sessionState: SessionState) => sessionState is SessionStateAuthenticated} */
-export const isAuthenticated = (sessionState) => {
+export function isAuthenticated (sessionState) {
   return !!sessionState.user
 }
-
-/** @type {(sessionState: SessionState) => asserts sessionState is SessionStateAuthenticated} */
-export const assertAuthenticated = (sessionState) => {
-  if (!isAuthenticated(sessionState)) throw httpError(401)
+export function assertAuthenticated (sessionState) {
+  if (!isAuthenticated(sessionState)) { throw httpError(401) }
 }
-
-/** @type {(sessionState: SessionState) => asserts sessionState is SessionStateAuthenticated} */
-export const assertAdminMode = (sessionState) => {
+export function assertAdminMode (sessionState) {
   assertAuthenticated(sessionState)
   // TODO: use sessionState.locale to internationalize error message
-  if (!sessionState.user.adminMode) throw httpError(403, 'super admin only')
+  if (!sessionState.user.adminMode) { throw httpError(403, 'super admin only') }
 }
-
-/**
- * @param {import('../account/index.js').AccountKeys} userAccount
- * @param {import('../account/index.js').AccountKeys} resourceAccount
- * @returns {boolean}
- */
-const 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
+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
 }
-
-/**
- * @param {SessionState} sessionState
- * @param {import('../account/index.js').AccountKeys} account
- * @param {boolean} [onlyActiveAccount]
- * @returns {string | null}
- */
-export const getAccountRole = (sessionState, account, onlyActiveAccount = true) => {
-  if (!isAuthenticated(sessionState)) return null
-  if (sessionState.user.adminMode) return 'admin'
+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
+    if (matchAccount(sessionState.account, account)) { return sessionState.accountRole }
   } else {
-    if (account.type === 'user' && sessionState.user.id === account.id) return 'admin'
+    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)) { return org.role }
     }
   }
   return null
 }
-
-/**
- * @param {SessionState} sessionState
- * @param {import('../account/index.js').AccountKeys} account
- * @param {string} role
- * @param {boolean} [onlyActiveAccount]
- */
-export const assertAccountRole = (sessionState, account, role, onlyActiveAccount = true) => {
+export function assertAccountRole (sessionState, account, role, onlyActiveAccount = true) {
   const accountRole = getAccountRole(sessionState, account, onlyActiveAccount)
-  if (accountRole !== role) throw httpError(403, `requires ${role} role`)
+  if (accountRole !== role) { throw httpError(403, `requires ${role} role`) }
 }
-
-/** @type {(type: string) => type is "user" | "organization"} */
-export const isValidAccountType = (type) => {
+export function isValidAccountType (type) {
   return ['user', 'organization'].includes(type)
 }
-
-/** @type {(type: string) => asserts type is "user" | "organization"} */
-export const 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

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

package/session/types.js

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

package/ws.d.ts

@@ -0,0 +1,6 @@
+export interface Message {
+    type: string;
+    channel: string;
+    data?: any;
+    status?: number;
+}

package/ws.js

@@ -0,0 +1 @@
+export {}