@data-fair/lib-common-types 1.9.2 → 1.10.1

package/catalog/.type/index.d.ts

@@ -30,10 +30,6 @@ export type Metadata = {
    * The description of the plugin to be displayed in the UI
    */
   description: string;
-  /**
-   * The SVG Path icon of the plugin
-   */
-  icon: string;
   /**
    * The list of capabilities that a catalog can have.
    */

package/catalog/schema.d.ts

@@ -23,10 +23,6 @@ declare const _default: {
                     description: string;
                     type: string;
                 };
-                icon: {
-                    description: string;
-                    type: string;
-                };
                 capabilities: {
                     description: string;
                     type: string;

package/catalog/schema.js

@@ -22,7 +22,7 @@ export default {
     metadata: {
       type: 'object',
       description: 'The metadata of the catalog plugin',
-      required: ['title', 'description', 'icon', 'capabilities'],
+      required: ['title', 'description', 'capabilities'],
       additionalProperties: false,
       properties: {
         title: {
@@ -33,10 +33,6 @@ export default {
           description: 'The description of the plugin to be displayed in the UI',
           type: 'string'
         },
-        icon: {
-          description: 'The SVG Path icon of the plugin',
-          type: 'string'
-        },
         capabilities: {
           description: 'The list of capabilities that a catalog can have.',
           type: 'array',

package/package.json

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

package/processings.d.ts

@@ -3,9 +3,10 @@ import type { DataFairWsClient } from '@data-fair/lib-node/ws-client.js';
 /**
  * Processing context.
  */
-export interface ProcessingContext {
-    processingConfig: any;
+export interface ProcessingContext<TProcesssingConfig = any> {
+    processingConfig: TProcesssingConfig;
     pluginConfig: any;
+    secrets?: Record<string, string>;
     processingId: string;
     dir: string;
     tmpDir: string;
@@ -18,6 +19,19 @@ export interface ProcessingContext {
         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.
  */