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

package/account/index.d.ts

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

package/account/index.js

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

package/application/index.d.ts

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

package/application/index.js

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

package/package.json

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

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,55 @@
-/**
- * @typedef {import('./types.js').SessionStateAuthenticated} SessionStateAuthenticated
- * @typedef {import('./.type/index.js').SessionState} SessionState
- */
-
-import { httpError } from '@data-fair/lib/http-errors.js'
-
-export * from './.type/index.js'
-
-/** @type {(sessionState: SessionState) => sessionState is SessionStateAuthenticated} */
-export const isAuthenticated = (sessionState) => {
-  return !!sessionState.user
-}
-
-/** @type {(sessionState: SessionState) => asserts sessionState is SessionStateAuthenticated} */
-export const assertAuthenticated = (sessionState) => {
-  if (!isAuthenticated(sessionState)) throw httpError(401)
-}
-
-/** @type {(sessionState: SessionState) => asserts sessionState is SessionStateAuthenticated} */
-export const assertAdminMode = (sessionState) => {
-  assertAuthenticated(sessionState)
-  // TODO: use sessionState.locale to internationalize error message
-  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
-  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'
-  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
+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;
+        }
     }
-  }
-  return null
+    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) => {
-  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`);
 }
-
-/** @type {(type: string) => type is "user" | "organization"} */
-export const isValidAccountType = (type) => {
-  return ['user', 'organization'].includes(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/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 @@
+export {};

package/ws.d.ts

@@ -0,0 +1,22 @@
+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

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