@data-fair/lib-common-types 1.19.10 → 1.20.0

package/access-ref/.type/index.d.ts

@@ -0,0 +1,45 @@
+
+export const schemaExports: string[]
+
+// see https://github.com/bcherny/json-schema-to-typescript/issues/439 if some types are not exported
+export type AccessRef =
+  | UnMembreDeLOrganisation
+  | UnEmail
+  | UneOrganisationPartenaire
+  | UnRoleOuDepartementDeMonOrganisation;
+export type AdresseMail = string;
+
+export type UnMembreDeLOrganisation = {
+  mode: "member";
+  type: "user";
+  id: string;
+  [k: string]: unknown;
+}
+export type UnEmail = {
+  mode: "member";
+  type: "user";
+  email: AdresseMail;
+  [k: string]: unknown;
+}
+export type UneOrganisationPartenaire = {
+  mode: "member";
+  type: "organization";
+  department?: "*";
+  roles?: unknown[];
+  id: string;
+  [k: string]: unknown;
+}
+export type UnRoleOuDepartementDeMonOrganisation = {
+  mode: "internal";
+  type: "organization";
+  id: string;
+  department?: string;
+  roles?: string[];
+  [k: string]: unknown;
+}
+
+
+export declare function validate(data: any): data is AccessRef
+export declare function assertValid(data: any, options?: import('@data-fair/lib-validation').AssertValidOptions): asserts data is AccessRef
+export declare function returnValid(data: any, options?: import('@data-fair/lib-validation').AssertValidOptions): AccessRef
+      

package/access-ref/.type/index.js

@@ -0,0 +1,19 @@
+/* eslint-disable */
+
+
+import validate from './validate.js'
+import { assertValid as assertValidGeneric } from '@data-fair/lib-validation'
+
+export const schemaExports = [
+  "types",
+  "validate"
+]
+
+export { validate } from './validate.js'
+export function assertValid(data, options) {
+  assertValidGeneric(validate, data, options)
+}
+export function returnValid(data, options) {
+  assertValid(data, options)
+  return data
+}

package/access-ref/.type/validate.js

@@ -0,0 +1,538 @@
+/* eslint-disable */
+// @ts-nocheck
+
+"use strict";
+export const validate = validate14;
+export default validate14;
+const schema16 = {"$id":"https://github.com/data-fair/lib/access-ref","x-exports":["types","validate"],"title":"Access Ref","type":"object","oneOf":[{"title":"Un membre de l'organisation","layout":{"if":"context.owner.type === 'organization'"},"required":["mode","type","id"],"properties":{"mode":{"type":"string","const":"member"},"type":{"type":"string","const":"user"},"id":{"type":"string","layout":{"getItems":{"url":"/simple-directory/api/organization/${context.owner.id}/members","itemsResults":"data.results","itemTitle":"item.name","itemValue":"item.id","itemIcon":"`/simple-directory/api/avatars/user/${item.id}/avatar.png`"}}}}},{"title":"Un email","required":["mode","type","email"],"properties":{"mode":{"type":"string","const":"member"},"type":{"type":"string","const":"user"},"email":{"type":"string","title":"Adresse mail"}}},{"title":"Une organisation partenaire","layout":{"if":"context.owner.type === 'organization'"},"required":["mode","type","id"],"properties":{"mode":{"type":"string","const":"member"},"type":{"type":"string","const":"organization"},"department":{"type":"string","const":"*"},"roles":{"type":"array","const":[]},"id":{"type":"string","layout":{"getItems":{"url":"/simple-directory/api/organization/${context.owner.id}/partners","itemsResults":"data.results","itemTitle":"item.name","itemValue":"item.id","itemIcon":"`/simple-directory/api/avatars/organization/${item.id}/avatar.png`"}}}}},{"title":"Un role ou département de mon organisation","layout":{"if":"context.owner.type === 'organization'"},"required":["mode","type","id"],"properties":{"mode":{"type":"string","const":"internal"},"type":{"type":"string","const":"organization"},"id":{"type":"string"},"department":{"type":"string","layout":{"getItems":{"url":"/simple-directory/api/organization/${context.owner.id}/departments","itemsResults":"[...data.results, {id: \"*\", name: \"Tous les départements\"}, {id: \"-\", name: \"Racine de l'organisation uniquement\"}]","itemTitle":"item.name","itemValue":"item.id"}}},"roles":{"type":"array","items":{"type":"string"},"layout":{"getItems":{"url":"/simple-directory/api/organization/${context.owner.id}/roles","itemsResults":"data.results","itemTitle":"item.name","itemValue":"item.id"}}}}}]};
+const func0 = require("ajv/dist/runtime/equal").default;
+
+function validate14(data, {instancePath="", parentData, parentDataProperty, rootData=data}={}){
+/*# sourceURL="https://github.com/data-fair/lib/access-ref" */;
+let vErrors = null;
+let errors = 0;
+if(!(data && typeof data == "object" && !Array.isArray(data))){
+const err0 = {instancePath,schemaPath:"#/type",keyword:"type",params:{type: "object"},message:"must be object"};
+if(vErrors === null){
+vErrors = [err0];
+}
+else {
+vErrors.push(err0);
+}
+errors++;
+}
+const _errs1 = errors;
+let valid0 = false;
+let passing0 = null;
+const _errs2 = errors;
+if(data && typeof data == "object" && !Array.isArray(data)){
+if(data.mode === undefined){
+const err1 = {instancePath,schemaPath:"#/oneOf/0/required",keyword:"required",params:{missingProperty: "mode"},message:"must have required property '"+"mode"+"'"};
+if(vErrors === null){
+vErrors = [err1];
+}
+else {
+vErrors.push(err1);
+}
+errors++;
+}
+if(data.type === undefined){
+const err2 = {instancePath,schemaPath:"#/oneOf/0/required",keyword:"required",params:{missingProperty: "type"},message:"must have required property '"+"type"+"'"};
+if(vErrors === null){
+vErrors = [err2];
+}
+else {
+vErrors.push(err2);
+}
+errors++;
+}
+if(data.id === undefined){
+const err3 = {instancePath,schemaPath:"#/oneOf/0/required",keyword:"required",params:{missingProperty: "id"},message:"must have required property '"+"id"+"'"};
+if(vErrors === null){
+vErrors = [err3];
+}
+else {
+vErrors.push(err3);
+}
+errors++;
+}
+if(data.mode !== undefined){
+let data0 = data.mode;
+if(typeof data0 !== "string"){
+const err4 = {instancePath:instancePath+"/mode",schemaPath:"#/oneOf/0/properties/mode/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err4];
+}
+else {
+vErrors.push(err4);
+}
+errors++;
+}
+if("member" !== data0){
+const err5 = {instancePath:instancePath+"/mode",schemaPath:"#/oneOf/0/properties/mode/const",keyword:"const",params:{allowedValue: "member"},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err5];
+}
+else {
+vErrors.push(err5);
+}
+errors++;
+}
+}
+if(data.type !== undefined){
+let data1 = data.type;
+if(typeof data1 !== "string"){
+const err6 = {instancePath:instancePath+"/type",schemaPath:"#/oneOf/0/properties/type/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err6];
+}
+else {
+vErrors.push(err6);
+}
+errors++;
+}
+if("user" !== data1){
+const err7 = {instancePath:instancePath+"/type",schemaPath:"#/oneOf/0/properties/type/const",keyword:"const",params:{allowedValue: "user"},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err7];
+}
+else {
+vErrors.push(err7);
+}
+errors++;
+}
+}
+if(data.id !== undefined){
+if(typeof data.id !== "string"){
+const err8 = {instancePath:instancePath+"/id",schemaPath:"#/oneOf/0/properties/id/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err8];
+}
+else {
+vErrors.push(err8);
+}
+errors++;
+}
+}
+}
+var _valid0 = _errs2 === errors;
+if(_valid0){
+valid0 = true;
+passing0 = 0;
+}
+const _errs9 = errors;
+if(data && typeof data == "object" && !Array.isArray(data)){
+if(data.mode === undefined){
+const err9 = {instancePath,schemaPath:"#/oneOf/1/required",keyword:"required",params:{missingProperty: "mode"},message:"must have required property '"+"mode"+"'"};
+if(vErrors === null){
+vErrors = [err9];
+}
+else {
+vErrors.push(err9);
+}
+errors++;
+}
+if(data.type === undefined){
+const err10 = {instancePath,schemaPath:"#/oneOf/1/required",keyword:"required",params:{missingProperty: "type"},message:"must have required property '"+"type"+"'"};
+if(vErrors === null){
+vErrors = [err10];
+}
+else {
+vErrors.push(err10);
+}
+errors++;
+}
+if(data.email === undefined){
+const err11 = {instancePath,schemaPath:"#/oneOf/1/required",keyword:"required",params:{missingProperty: "email"},message:"must have required property '"+"email"+"'"};
+if(vErrors === null){
+vErrors = [err11];
+}
+else {
+vErrors.push(err11);
+}
+errors++;
+}
+if(data.mode !== undefined){
+let data3 = data.mode;
+if(typeof data3 !== "string"){
+const err12 = {instancePath:instancePath+"/mode",schemaPath:"#/oneOf/1/properties/mode/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err12];
+}
+else {
+vErrors.push(err12);
+}
+errors++;
+}
+if("member" !== data3){
+const err13 = {instancePath:instancePath+"/mode",schemaPath:"#/oneOf/1/properties/mode/const",keyword:"const",params:{allowedValue: "member"},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err13];
+}
+else {
+vErrors.push(err13);
+}
+errors++;
+}
+}
+if(data.type !== undefined){
+let data4 = data.type;
+if(typeof data4 !== "string"){
+const err14 = {instancePath:instancePath+"/type",schemaPath:"#/oneOf/1/properties/type/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err14];
+}
+else {
+vErrors.push(err14);
+}
+errors++;
+}
+if("user" !== data4){
+const err15 = {instancePath:instancePath+"/type",schemaPath:"#/oneOf/1/properties/type/const",keyword:"const",params:{allowedValue: "user"},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err15];
+}
+else {
+vErrors.push(err15);
+}
+errors++;
+}
+}
+if(data.email !== undefined){
+if(typeof data.email !== "string"){
+const err16 = {instancePath:instancePath+"/email",schemaPath:"#/oneOf/1/properties/email/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err16];
+}
+else {
+vErrors.push(err16);
+}
+errors++;
+}
+}
+}
+var _valid0 = _errs9 === errors;
+if(_valid0 && valid0){
+valid0 = false;
+passing0 = [passing0, 1];
+}
+else {
+if(_valid0){
+valid0 = true;
+passing0 = 1;
+}
+const _errs16 = errors;
+if(data && typeof data == "object" && !Array.isArray(data)){
+if(data.mode === undefined){
+const err17 = {instancePath,schemaPath:"#/oneOf/2/required",keyword:"required",params:{missingProperty: "mode"},message:"must have required property '"+"mode"+"'"};
+if(vErrors === null){
+vErrors = [err17];
+}
+else {
+vErrors.push(err17);
+}
+errors++;
+}
+if(data.type === undefined){
+const err18 = {instancePath,schemaPath:"#/oneOf/2/required",keyword:"required",params:{missingProperty: "type"},message:"must have required property '"+"type"+"'"};
+if(vErrors === null){
+vErrors = [err18];
+}
+else {
+vErrors.push(err18);
+}
+errors++;
+}
+if(data.id === undefined){
+const err19 = {instancePath,schemaPath:"#/oneOf/2/required",keyword:"required",params:{missingProperty: "id"},message:"must have required property '"+"id"+"'"};
+if(vErrors === null){
+vErrors = [err19];
+}
+else {
+vErrors.push(err19);
+}
+errors++;
+}
+if(data.mode !== undefined){
+let data6 = data.mode;
+if(typeof data6 !== "string"){
+const err20 = {instancePath:instancePath+"/mode",schemaPath:"#/oneOf/2/properties/mode/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err20];
+}
+else {
+vErrors.push(err20);
+}
+errors++;
+}
+if("member" !== data6){
+const err21 = {instancePath:instancePath+"/mode",schemaPath:"#/oneOf/2/properties/mode/const",keyword:"const",params:{allowedValue: "member"},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err21];
+}
+else {
+vErrors.push(err21);
+}
+errors++;
+}
+}
+if(data.type !== undefined){
+let data7 = data.type;
+if(typeof data7 !== "string"){
+const err22 = {instancePath:instancePath+"/type",schemaPath:"#/oneOf/2/properties/type/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err22];
+}
+else {
+vErrors.push(err22);
+}
+errors++;
+}
+if("organization" !== data7){
+const err23 = {instancePath:instancePath+"/type",schemaPath:"#/oneOf/2/properties/type/const",keyword:"const",params:{allowedValue: "organization"},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err23];
+}
+else {
+vErrors.push(err23);
+}
+errors++;
+}
+}
+if(data.department !== undefined){
+let data8 = data.department;
+if(typeof data8 !== "string"){
+const err24 = {instancePath:instancePath+"/department",schemaPath:"#/oneOf/2/properties/department/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err24];
+}
+else {
+vErrors.push(err24);
+}
+errors++;
+}
+if("*" !== data8){
+const err25 = {instancePath:instancePath+"/department",schemaPath:"#/oneOf/2/properties/department/const",keyword:"const",params:{allowedValue: "*"},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err25];
+}
+else {
+vErrors.push(err25);
+}
+errors++;
+}
+}
+if(data.roles !== undefined){
+let data9 = data.roles;
+if(!(Array.isArray(data9))){
+const err26 = {instancePath:instancePath+"/roles",schemaPath:"#/oneOf/2/properties/roles/type",keyword:"type",params:{type: "array"},message:"must be array"};
+if(vErrors === null){
+vErrors = [err26];
+}
+else {
+vErrors.push(err26);
+}
+errors++;
+}
+if(!func0(data9, schema16.oneOf[2].properties.roles.const)){
+const err27 = {instancePath:instancePath+"/roles",schemaPath:"#/oneOf/2/properties/roles/const",keyword:"const",params:{allowedValue: schema16.oneOf[2].properties.roles.const},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err27];
+}
+else {
+vErrors.push(err27);
+}
+errors++;
+}
+}
+if(data.id !== undefined){
+if(typeof data.id !== "string"){
+const err28 = {instancePath:instancePath+"/id",schemaPath:"#/oneOf/2/properties/id/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err28];
+}
+else {
+vErrors.push(err28);
+}
+errors++;
+}
+}
+}
+var _valid0 = _errs16 === errors;
+if(_valid0 && valid0){
+valid0 = false;
+passing0 = [passing0, 2];
+}
+else {
+if(_valid0){
+valid0 = true;
+passing0 = 2;
+}
+const _errs27 = errors;
+if(data && typeof data == "object" && !Array.isArray(data)){
+if(data.mode === undefined){
+const err29 = {instancePath,schemaPath:"#/oneOf/3/required",keyword:"required",params:{missingProperty: "mode"},message:"must have required property '"+"mode"+"'"};
+if(vErrors === null){
+vErrors = [err29];
+}
+else {
+vErrors.push(err29);
+}
+errors++;
+}
+if(data.type === undefined){
+const err30 = {instancePath,schemaPath:"#/oneOf/3/required",keyword:"required",params:{missingProperty: "type"},message:"must have required property '"+"type"+"'"};
+if(vErrors === null){
+vErrors = [err30];
+}
+else {
+vErrors.push(err30);
+}
+errors++;
+}
+if(data.id === undefined){
+const err31 = {instancePath,schemaPath:"#/oneOf/3/required",keyword:"required",params:{missingProperty: "id"},message:"must have required property '"+"id"+"'"};
+if(vErrors === null){
+vErrors = [err31];
+}
+else {
+vErrors.push(err31);
+}
+errors++;
+}
+if(data.mode !== undefined){
+let data11 = data.mode;
+if(typeof data11 !== "string"){
+const err32 = {instancePath:instancePath+"/mode",schemaPath:"#/oneOf/3/properties/mode/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err32];
+}
+else {
+vErrors.push(err32);
+}
+errors++;
+}
+if("internal" !== data11){
+const err33 = {instancePath:instancePath+"/mode",schemaPath:"#/oneOf/3/properties/mode/const",keyword:"const",params:{allowedValue: "internal"},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err33];
+}
+else {
+vErrors.push(err33);
+}
+errors++;
+}
+}
+if(data.type !== undefined){
+let data12 = data.type;
+if(typeof data12 !== "string"){
+const err34 = {instancePath:instancePath+"/type",schemaPath:"#/oneOf/3/properties/type/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err34];
+}
+else {
+vErrors.push(err34);
+}
+errors++;
+}
+if("organization" !== data12){
+const err35 = {instancePath:instancePath+"/type",schemaPath:"#/oneOf/3/properties/type/const",keyword:"const",params:{allowedValue: "organization"},message:"must be equal to constant"};
+if(vErrors === null){
+vErrors = [err35];
+}
+else {
+vErrors.push(err35);
+}
+errors++;
+}
+}
+if(data.id !== undefined){
+if(typeof data.id !== "string"){
+const err36 = {instancePath:instancePath+"/id",schemaPath:"#/oneOf/3/properties/id/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err36];
+}
+else {
+vErrors.push(err36);
+}
+errors++;
+}
+}
+if(data.department !== undefined){
+if(typeof data.department !== "string"){
+const err37 = {instancePath:instancePath+"/department",schemaPath:"#/oneOf/3/properties/department/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err37];
+}
+else {
+vErrors.push(err37);
+}
+errors++;
+}
+}
+if(data.roles !== undefined){
+let data15 = data.roles;
+if(Array.isArray(data15)){
+const len0 = data15.length;
+for(let i0=0; i0<len0; i0++){
+if(typeof data15[i0] !== "string"){
+const err38 = {instancePath:instancePath+"/roles/" + i0,schemaPath:"#/oneOf/3/properties/roles/items/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err38];
+}
+else {
+vErrors.push(err38);
+}
+errors++;
+}
+}
+}
+else {
+const err39 = {instancePath:instancePath+"/roles",schemaPath:"#/oneOf/3/properties/roles/type",keyword:"type",params:{type: "array"},message:"must be array"};
+if(vErrors === null){
+vErrors = [err39];
+}
+else {
+vErrors.push(err39);
+}
+errors++;
+}
+}
+}
+var _valid0 = _errs27 === errors;
+if(_valid0 && valid0){
+valid0 = false;
+passing0 = [passing0, 3];
+}
+else {
+if(_valid0){
+valid0 = true;
+passing0 = 3;
+}
+}
+}
+}
+if(!valid0){
+const err40 = {instancePath,schemaPath:"#/oneOf",keyword:"oneOf",params:{passingSchemas: passing0},message:"must match exactly one schema in oneOf"};
+if(vErrors === null){
+vErrors = [err40];
+}
+else {
+vErrors.push(err40);
+}
+errors++;
+}
+else {
+errors = _errs1;
+if(vErrors !== null){
+if(_errs1){
+vErrors.length = _errs1;
+}
+else {
+vErrors = null;
+}
+}
+}
+validate14.errors = vErrors;
+return errors === 0;
+}

package/access-ref/index.d.ts

@@ -0,0 +1,14 @@
+import { type AccessRef } from './.type/index.js';
+import { type SessionStateAuthenticated } from '../session/index.js';
+export * from './.type/index.js';
+/**
+ * Check if the current session matches an access ref.
+ */
+export declare const matchAccessRef: (session: SessionStateAuthenticated, accessRef: AccessRef) => boolean;
+/**
+ * Returns conditions to spread into a MongoDB $elemMatch for permissions array.
+ *
+ * @example
+ *   { permissions: { $elemMatch: { ...mongoFilterAccessRef(session), operation: 'read' } } }
+ */
+export declare const mongoFilterAccessRef: (session: SessionStateAuthenticated) => Record<string, any>;

package/access-ref/index.js

@@ -0,0 +1,63 @@
+export * from './.type/index.js';
+/**
+ * Check if the current session matches an access ref.
+ */
+export const matchAccessRef = (session, accessRef) => {
+    // Check by user, not active account
+    if (accessRef.type === 'user') {
+        if (accessRef.id)
+            return session.user.id === accessRef.id;
+        if (accessRef.email)
+            return session.user.email === accessRef.email;
+        return false;
+    }
+    // Check by active account
+    if (accessRef.type === 'organization') {
+        if (session.account.type !== 'organization')
+            return false;
+        if (session.account.id !== accessRef.id)
+            return false;
+        // Check department: '*' matches all, specific dept must match
+        if (accessRef.department &&
+            accessRef.department !== '*' &&
+            session.account.department !== accessRef.department)
+            return false;
+        // Check roles: empty array matches all, non-empty must include current role
+        if (accessRef.roles &&
+            accessRef.roles.length > 0 &&
+            !accessRef.roles.includes(session.accountRole))
+            return false;
+        return true;
+    }
+    return false;
+};
+/**
+ * Returns conditions to spread into a MongoDB $elemMatch for permissions array.
+ *
+ * @example
+ *   { permissions: { $elemMatch: { ...mongoFilterAccessRef(session), operation: 'read' } } }
+ */
+export const mongoFilterAccessRef = (session) => {
+    const userFilter = {
+        $or: [
+            { 'access.type': 'user', 'access.id': session.user.id },
+            { 'access.type': 'user', 'access.email': session.user.email }
+        ]
+    };
+    if (session.account.type === 'user')
+        return userFilter;
+    const baseOrgFilter = {
+        'access.type': 'organization',
+        'access.id': session.account.id,
+        $or: [
+            { 'access.roles': { $size: 0 } },
+            { 'access.roles': { $in: [session.accountRole] } }
+        ]
+    };
+    if (session.account.department)
+        baseOrgFilter['access.department'] = { $in: ['*', session.account.department] };
+    else
+        baseOrgFilter['access.department'] = { $in: ['-', '*'] };
+    userFilter.$or.push(baseOrgFilter);
+    return userFilter;
+};

package/access-ref/schema.d.ts

@@ -0,0 +1,148 @@
+declare const _default: {
+    $id: string;
+    'x-exports': string[];
+    title: string;
+    type: string;
+    oneOf: ({
+        title: string;
+        layout: {
+            if: string;
+        };
+        required: string[];
+        properties: {
+            mode: {
+                type: string;
+                const: string;
+            };
+            type: {
+                type: string;
+                const: string;
+            };
+            id: {
+                type: string;
+                layout: {
+                    getItems: {
+                        url: string;
+                        itemsResults: string;
+                        itemTitle: string;
+                        itemValue: string;
+                        itemIcon: string;
+                    };
+                };
+            };
+            email?: undefined;
+            department?: undefined;
+            roles?: undefined;
+        };
+    } | {
+        title: string;
+        required: string[];
+        properties: {
+            mode: {
+                type: string;
+                const: string;
+            };
+            type: {
+                type: string;
+                const: string;
+            };
+            email: {
+                type: string;
+                title: string;
+            };
+            id?: undefined;
+            department?: undefined;
+            roles?: undefined;
+        };
+        layout?: undefined;
+    } | {
+        title: string;
+        layout: {
+            if: string;
+        };
+        required: string[];
+        properties: {
+            mode: {
+                type: string;
+                const: string;
+            };
+            type: {
+                type: string;
+                const: string;
+            };
+            department: {
+                type: string;
+                const: string;
+                layout?: undefined;
+            };
+            roles: {
+                type: string;
+                const: never[];
+                items?: undefined;
+                layout?: undefined;
+            };
+            id: {
+                type: string;
+                layout: {
+                    getItems: {
+                        url: string;
+                        itemsResults: string;
+                        itemTitle: string;
+                        itemValue: string;
+                        itemIcon: string;
+                    };
+                };
+            };
+            email?: undefined;
+        };
+    } | {
+        title: string;
+        layout: {
+            if: string;
+        };
+        required: string[];
+        properties: {
+            mode: {
+                type: string;
+                const: string;
+            };
+            type: {
+                type: string;
+                const: string;
+            };
+            id: {
+                type: string;
+                layout?: undefined;
+            };
+            department: {
+                type: string;
+                layout: {
+                    getItems: {
+                        url: string;
+                        itemsResults: string;
+                        itemTitle: string;
+                        itemValue: string;
+                    };
+                };
+                const?: undefined;
+            };
+            roles: {
+                type: string;
+                items: {
+                    type: string;
+                };
+                layout: {
+                    getItems: {
+                        url: string;
+                        itemsResults: string;
+                        itemTitle: string;
+                        itemValue: string;
+                    };
+                };
+                const?: undefined;
+            };
+            email?: undefined;
+        };
+    })[];
+};
+export default _default;

package/access-ref/schema.js

@@ -0,0 +1,97 @@
+/* eslint-disable no-template-curly-in-string */
+export default {
+    $id: 'https://github.com/data-fair/lib/access-ref',
+    'x-exports': ['types', 'validate'],
+    title: 'Access Ref',
+    type: 'object',
+    oneOf: [
+        {
+            title: "Un membre de l'organisation",
+            layout: { if: "context.owner.type === 'organization'" },
+            required: ['mode', 'type', 'id'],
+            properties: {
+                mode: { type: 'string', const: 'member' },
+                type: { type: 'string', const: 'user' },
+                id: {
+                    type: 'string',
+                    layout: {
+                        getItems: {
+                            url: '/simple-directory/api/organization/${context.owner.id}/members',
+                            itemsResults: 'data.results',
+                            itemTitle: 'item.name',
+                            itemValue: 'item.id',
+                            itemIcon: '`/simple-directory/api/avatars/user/${item.id}/avatar.png`'
+                        }
+                    }
+                }
+            }
+        },
+        {
+            title: 'Un email',
+            required: ['mode', 'type', 'email'],
+            properties: {
+                mode: { type: 'string', const: 'member' },
+                type: { type: 'string', const: 'user' },
+                email: { type: 'string', title: 'Adresse mail' }
+            }
+        },
+        {
+            title: 'Une organisation partenaire',
+            layout: { if: "context.owner.type === 'organization'" },
+            required: ['mode', 'type', 'id'],
+            properties: {
+                mode: { type: 'string', const: 'member' },
+                type: { type: 'string', const: 'organization' },
+                department: { type: 'string', const: '*' },
+                roles: { type: 'array', const: [] },
+                id: {
+                    type: 'string',
+                    layout: {
+                        getItems: {
+                            url: '/simple-directory/api/organization/${context.owner.id}/partners',
+                            itemsResults: 'data.results',
+                            itemTitle: 'item.name',
+                            itemValue: 'item.id',
+                            itemIcon: '`/simple-directory/api/avatars/organization/${item.id}/avatar.png`'
+                        }
+                    }
+                }
+            }
+        },
+        {
+            title: 'Un role ou département de mon organisation',
+            layout: { if: "context.owner.type === 'organization'" },
+            required: ['mode', 'type', 'id'],
+            properties: {
+                mode: { type: 'string', const: 'internal' },
+                type: { type: 'string', const: 'organization' },
+                id: { type: 'string' },
+                department: {
+                    type: 'string',
+                    layout: {
+                        getItems: {
+                            url: '/simple-directory/api/organization/${context.owner.id}/departments',
+                            itemsResults: '[...data.results, {id: "*", name: "Tous les départements"}, {id: "-", name: "Racine de l\'organisation uniquement"}]',
+                            itemTitle: 'item.name',
+                            itemValue: 'item.id'
+                        }
+                    }
+                },
+                roles: {
+                    type: 'array',
+                    items: {
+                        type: 'string'
+                    },
+                    layout: {
+                        getItems: {
+                            url: '/simple-directory/api/organization/${context.owner.id}/roles',
+                            itemsResults: 'data.results',
+                            itemTitle: 'item.name',
+                            itemValue: 'item.id'
+                        }
+                    }
+                }
+            }
+        }
+    ]
+};

package/package.json

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

package/processings.d.ts

@@ -1,11 +1,33 @@
 import type { AxiosInstance } from 'axios';
 import type { DataFairWsClient } from '@data-fair/lib-node/ws-client.js';
+/**
+ * Function to prepare a processing (trigger when the config is updated).
+ * It can be used to:
+ * - throw additional errors to validate the config
+ * - remove secrets from the config and store them in the secrets object
+ */
+export type PrepareFunction<TProcessingConfig = any> = (context: {
+    processingConfig: TProcessingConfig;
+    secrets: Record<string, string>;
+}) => Promise<{
+    processingConfig?: TProcessingConfig;
+    secrets?: Record<string, string>;
+}>;
+/**
+ * Function to execute the processing (triggered when the processing is started).
+ * This is the main function of the plugin where the business logic is implemented.
+ *
+ * @returns An object with a optional deleteOnComplete property to indicate that the last run should be deleted after completion.
+ */
+export type RunFunction<TProcessingConfig = any, TPluginConfig = any> = (context: ProcessingContext<TProcessingConfig, TPluginConfig>) => Promise<void | {
+    deleteOnComplete?: boolean;
+}>;
 /**
  * Processing context.
  */
-export interface ProcessingContext<TProcesssingConfig = any> {
-    processingConfig: TProcesssingConfig;
-    pluginConfig: any;
+export interface ProcessingContext<TProcessingConfig = any, TPluginConfig = any> {
+    processingConfig: TProcessingConfig;
+    pluginConfig: TPluginConfig;
     secrets?: Record<string, string>;
     processingId: string;
     dir: string;
@@ -19,19 +41,6 @@ export interface ProcessingContext<TProcesssingConfig = any> {
         dataset: any;
     }) => Promise<void>;
 }
-/**
- * Function to prepare a processing (trigger when the config is updated).
- * It can be used to:
- * - throw additional errors to validate the config
- * - remove secrets from the config and store them in the secrets object
- */
-export type PrepareFunction<TProcesssingConfig = any> = (context: {
-    processingConfig: TProcesssingConfig;
-    secrets: Record<string, string>;
-}) => Promise<{
-    processingConfig?: TProcesssingConfig;
-    secrets?: Record<string, string>;
-}>;
 /**
  * Log functions.
  */