@jupyterlab/settingregistry 4.0.0-alpha.15 → 4.0.0-alpha.17

package/lib/plugin-schema.json

@@ -56,6 +56,13 @@
             },
             "additionalProperties": false
         },
+        "jupyter.lab.metadataforms": {
+            "items": {
+                "$ref": "#/definitions/metadataForm"
+            },
+            "type": "array",
+            "default": []
+        },
         "jupyter.lab.setting-deprecated": {
             "type": "boolean",
             "default": false
@@ -295,6 +302,90 @@
             "required": ["name"],
             "additionalProperties": false,
             "type": "object"
+        },
+        "metadataForm": {
+            "type": "object",
+            "properties": {
+                "id": {
+                    "type": "string",
+                    "description": "The section ID"
+                },
+                "metadataSchema": {
+                    "type": "object",
+                    "items": {
+                        "$ref": "#/definitions/metadataSchema"
+                    }
+                },
+                "uiSchema": {
+                    "type": "object"
+                },
+                "metadataOptions": {
+                    "type": "object",
+                    "items": {
+                        "$ref": "#/definitions/metadataOptions"
+                    }
+                },
+                "label": {
+                    "type": "string",
+                    "description": "The section label"
+                },
+                "rank": {
+                    "type": "integer",
+                    "description": "The rank of the section in the right panel"
+                },
+                "showModified": {
+                    "type": "boolean",
+                    "description": "Whether to show modified values from defaults"
+                }
+            },
+            "required": ["id", "metadataSchema"]
+        },
+        "metadataSchema": {
+            "properties": {
+                "properties": {
+                    "type": "object",
+                    "description": "The property set up by extension",
+                    "properties": {
+                        "title": {
+                            "type": "string"
+                        },
+                        "description": {
+                            "type": "string"
+                        },
+                        "type": {
+                            "type": "string"
+                        }
+                    }
+                }
+            },
+            "type": "object",
+            "required": ["properties"]
+        },
+        "metadataOptions": {
+            "properties": {
+                "customWidget": {
+                    "type": "string"
+                },
+                "customField": {
+                    "type": "string"
+                },
+                "metadataLevel": {
+                    "type": "string",
+                    "enum": ["cell", "notebook"],
+                    "default": "cell"
+                },
+                "cellTypes": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "enum": ["code", "markdown", "raw"]
+                    }
+                },
+                "writeDefault": {
+                    "type": "boolean"
+                }
+            },
+            "type": "object"
         }
     }
 }

package/lib/tokens.d.ts

@@ -1,3 +1,4 @@
+import { CellType } from '@jupyterlab/nbformat';
 import { IDataConnector } from '@jupyterlab/statedb';
 import { PartialJSONObject, PartialJSONValue, ReadonlyPartialJSONObject, ReadonlyPartialJSONValue, Token } from '@lumino/coreutils';
 import { IDisposable } from '@lumino/disposable';
@@ -358,6 +359,10 @@ export declare namespace ISettingRegistry {
          * The JupyterLab shortcuts that are created by a plugin's schema.
          */
         'jupyter.lab.shortcuts'?: IShortcut[];
+        /**
+         * The JupyterLab metadata-form schema
+         */
+        'jupyter.lab.metadataforms'?: IMetadataForm[];
         /**
          * The root schema is always an object.
          */
@@ -502,6 +507,104 @@ export declare namespace ISettingRegistry {
          */
         selector: string;
     }
+    /**
+     * An interface describing the metadata form.
+     */
+    interface IMetadataForm extends PartialJSONObject {
+        /**
+         * The section unique ID.
+         */
+        id: string;
+        /**
+         * The metadata schema.
+         *
+         * ## Notes:
+         * To change to type @rjsf/utils -> RJSFSchema when upgrading rjsf to v5.
+         */
+        metadataSchema: IMetadataSchema;
+        /**
+         * The ui schema as used by react-JSON-schema-form.
+         *
+         * ## Notes:
+         * To change to type @rjsf/utils -> UiSchema when upgrading rjsf to v5.
+         */
+        uiSchema?: {
+            [metadataKey: string]: PartialJSONObject;
+        };
+        /**
+         * The jupyter properties.
+         */
+        metadataOptions?: {
+            [metadataKey: string]: IMetadataOptions;
+        };
+        /**
+         * The section label.
+         */
+        label?: string;
+        /**
+         * The section rank in notebooktools panel.
+         */
+        rank?: number;
+        /**
+         * Whether to show the modified field from default value.
+         */
+        showModified?: boolean;
+        /**
+         * Keep the plugin at origin of the metadata form.
+         */
+        _origin?: string;
+    }
+    /**
+     * The metadata schema as defined in JSON schema.
+     *
+     * ## Notes:
+     * To remove in favour of @rjsf/utils -> RJSFSchema when upgrading rjsf to v5.
+     */
+    interface IMetadataSchema extends PartialJSONObject {
+        /**
+         * The type of data (should be object at first level).
+         */
+        type: string;
+        /**
+         * The properties as defined in JSON schema, and interpretable by react-JSON-schema-form.
+         */
+        properties: {
+            [option: string]: any;
+        };
+        /**
+         * The required fields.
+         */
+        required?: string[];
+        /**
+         * Support for allOf feature of JSON schema (useful for if/then/else).
+         */
+        allOf?: Array<PartialJSONObject>;
+    }
+    /**
+     * Options to customize the widget, the field and the relevant metadata.
+     */
+    interface IMetadataOptions extends PartialJSONObject {
+        /**
+         * Name of a custom react widget registered.
+         */
+        customWidget?: string;
+        /**
+         * Name of a custom react field registered.
+         */
+        customField?: string;
+        /**
+         * Metadata applied to notebook or cell.
+         */
+        metadataLevel?: 'cell' | 'notebook';
+        /**
+         * Cells which should have this metadata.
+         */
+        cellTypes?: CellType[];
+        /**
+         * Whether to avoid writing default value in metadata.
+         */
+        writeDefault?: boolean;
+    }
     /**
      * An interface describing a toolbar item.
      */

package/lib/tokens.js.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;+EAG+E;AAG/E,OAAO,EAKL,KAAK,EACN,MAAM,mBAAmB,CAAC;AAK3B;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,KAAK,CACvC,wCAAwC,CACzC,CAAC"}
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;+EAG+E;AAI/E,OAAO,EAKL,KAAK,EACN,MAAM,mBAAmB,CAAC;AAK3B;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,KAAK,CACvC,wCAAwC,CACzC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlab/settingregistry",
-  "version": "4.0.0-alpha.15",
+  "version": "4.0.0-alpha.17",
   "description": "Settings registry for Jupyterlab",
   "homepage": "https://github.com/jupyterlab/jupyterlab",
   "bugs": {
@@ -35,7 +35,8 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/statedb": "^4.0.0-alpha.15",
+    "@jupyterlab/nbformat": "^4.0.0-alpha.17",
+    "@jupyterlab/statedb": "^4.0.0-alpha.17",
     "@lumino/commands": "^2.0.0-alpha.6",
     "@lumino/coreutils": "^2.0.0-alpha.6",
     "@lumino/disposable": "^2.0.0-alpha.6",
@@ -44,12 +45,10 @@
     "json5": "^2.1.1"
   },
   "devDependencies": {
-    "@jupyterlab/testutils": "^4.0.0-alpha.15",
-    "@types/jest": "^26.0.10",
+    "@jupyterlab/testing": "^4.0.0-alpha.17",
+    "@types/jest": "^29.2.0",
     "@types/json5": "^0.0.30",
-    "jest": "^26.4.2",
     "rimraf": "~3.0.0",
-    "ts-jest": "^26.3.0",
     "typescript": "~4.7.3"
   },
   "publishConfig": {