@data-fair/lib-common-types 1.12.0 → 1.13.0

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

@@ -11,6 +11,7 @@ export const schemaExports: string[]
  *  - importConfig: The plugin gives an import configuration schema
  *  - publishDataset: The plugin can publish a dataset
  *  - deletePublication: The plugin can delete a dataset or a resource published in a remote catalog
+ *  - thumbnail: The plugin provides a thumbnail image
  *
  * This interface was referenced by `CatalogsCommonTypes`'s JSON-Schema
  * via the `definition` "capability".
@@ -22,7 +23,8 @@ export type Capability =
   | "additionalFilters"
   | "importConfig"
   | "publishDataset"
-  | "deletePublication";
+  | "deletePublication"
+  | "thumbnail";
 
 export type CatalogsCommonTypes = {}
 /**
@@ -44,6 +46,10 @@ export type Metadata = {
    * The list of capabilities that a catalog can have.
    */
   capabilities: Capability[];
+  /**
+   * Optional path of the thumbnail image from the root of the plugin to be displayed in the UI.
+   */
+  thumbnailPath?: string;
 }
 /**
  * This interface was referenced by `CatalogsCommonTypes`'s JSON-Schema
@@ -104,7 +110,16 @@ export type Resource = {
    * The URL of the image representing the resource, if available
    */
   image?: string;
-  license?: string;
+  license?: {
+    /**
+     * Short title for the license
+     */
+    title: string;
+    /**
+     * The URL where the license can be read
+     */
+    href: string;
+  };
   /**
    * The list of keywords associated with the resource, if available
    */

package/catalog/index.d.ts

@@ -210,4 +210,6 @@ export type DeletePublicationContext<TCatalogConfig> = {
 export type CatalogMetadata<TCapabilities extends Capability[]> = Metadata & {
     /** The capabilities of the catalog plugin */
     capabilities: TCapabilities;
-};
+} & (Includes<TCapabilities, 'thumbnail'> extends true ? {
+    thumbnailPath: string;
+} : {});

package/catalog/schema.d.ts

@@ -31,6 +31,10 @@ declare const _default: {
                         $ref: string;
                     };
                 };
+                thumbnailPath: {
+                    description: string;
+                    type: string;
+                };
             };
         };
         folder: {
@@ -85,6 +89,18 @@ declare const _default: {
                 };
                 license: {
                     type: string;
+                    additionalProperties: boolean;
+                    required: string[];
+                    properties: {
+                        title: {
+                            type: string;
+                            description: string;
+                        };
+                        href: {
+                            type: string;
+                            description: string;
+                        };
+                    };
                 };
                 keywords: {
                     type: string;

package/catalog/schema.js

@@ -14,7 +14,8 @@ export default {
  - additionalFilters: The plugin can use additional filters in the list method
  - importConfig: The plugin gives an import configuration schema
  - publishDataset: The plugin can publish a dataset
- - deletePublication: The plugin can delete a dataset or a resource published in a remote catalog`,
+ - deletePublication: The plugin can delete a dataset or a resource published in a remote catalog
+ - thumbnail: The plugin provides a thumbnail image`,
       enum: [
         'import',
         'search',
@@ -22,7 +23,8 @@ export default {
         'additionalFilters',
         'importConfig',
         'publishDataset',
-        'deletePublication'
+        'deletePublication',
+        'thumbnail'
       ]
     },
     metadata: {
@@ -45,6 +47,10 @@ export default {
           items: {
             $ref: '#/$defs/capability'
           }
+        },
+        thumbnailPath: {
+          description: 'Optional path of the thumbnail image from the root of the plugin to be displayed in the UI.',
+          type: 'string',
         }
       }
     },
@@ -100,7 +106,19 @@ export default {
           description: 'The URL of the image representing the resource, if available'
         },
         license: {
-          type: 'string'
+          type: 'object',
+          additionalProperties: false,
+          required: ['title', 'href'],
+          properties: {
+            title: {
+              type: 'string',
+              description: 'Short title for the license'
+            },
+            href: {
+              type: 'string',
+              description: 'The URL where the license can be read'
+            }
+          }
         },
         keywords: {
           type: 'array',

package/package.json

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

package/processings.js

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

package/ws.js

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