@jupyterlab/settingregistry 4.0.0-alpha.2 → 4.0.0-alpha.20

package/lib/tokens.d.ts

@@ -1,8 +1,10 @@
+import { CellType } from '@jupyterlab/nbformat';
 import { IDataConnector } from '@jupyterlab/statedb';
 import { PartialJSONObject, PartialJSONValue, ReadonlyPartialJSONObject, ReadonlyPartialJSONValue, Token } from '@lumino/coreutils';
 import { IDisposable } from '@lumino/disposable';
 import { ISignal } from '@lumino/signaling';
 import { ISchemaValidator } from './settingregistry';
+import type { RJSFSchema, UiSchema } from '@rjsf/utils';
 /**
  * The setting registry token.
  */
@@ -216,6 +218,9 @@ export declare namespace ISettingRegistry {
          */
         disabled?: boolean;
     }
+    /**
+     * An interface describing a context menu item
+     */
     interface IContextMenuItem extends IMenuItem {
         /**
          * The CSS selector for the context menu item.
@@ -355,6 +360,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.
          */
@@ -486,7 +495,12 @@ export declare namespace ISettingRegistry {
          */
         disabled?: boolean;
         /**
-         * The key combination of the shortcut.
+         * The key sequence of the shortcut.
+         *
+         * ### Notes
+         *
+         * If this is a list like `['Ctrl A', 'B']`, the user needs to press
+         * `Ctrl A` followed by `B` to trigger the shortcuts.
          */
         keys: string[];
         /**
@@ -494,6 +508,91 @@ 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.
+         */
+        metadataSchema: IMetadataSchema;
+        /**
+         * The ui schema as used by react-JSON-schema-form.
+         */
+        uiSchema?: {
+            [metadataKey: string]: UiSchema;
+        };
+        /**
+         * 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.
+     */
+    interface IMetadataSchema extends RJSFSchema {
+        /**
+         * 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

@@ -3,7 +3,6 @@
 | Distributed under the terms of the Modified BSD License.
 |----------------------------------------------------------------------------*/
 import { Token } from '@lumino/coreutils';
-/* tslint:disable */
 /**
  * The setting registry token.
  */

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,oBAAoB;AACpB;;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;AAM3B;;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.2",
+  "version": "4.0.0-alpha.20",
   "description": "Settings registry for Jupyterlab",
   "homepage": "https://github.com/jupyterlab/jupyterlab",
   "bugs": {
@@ -21,7 +21,9 @@
   "files": [
     "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
     "schema/*.json",
-    "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}"
+    "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
+    "src/**/*.{ts,tsx}",
+    "src/plugin-schema.json"
   ],
   "scripts": {
     "build": "tsc -b",
@@ -35,22 +37,21 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/statedb": "^4.0.0-alpha.2",
-    "@lumino/commands": "^1.19.0",
-    "@lumino/coreutils": "^1.11.1",
-    "@lumino/disposable": "^1.10.1",
-    "@lumino/signaling": "^1.10.1",
-    "ajv": "^6.12.3",
-    "json5": "^2.1.1"
+    "@jupyterlab/nbformat": "^4.0.0-alpha.20",
+    "@jupyterlab/statedb": "^4.0.0-alpha.20",
+    "@lumino/commands": "^2.0.0-rc.0",
+    "@lumino/coreutils": "^2.0.0-rc.0",
+    "@lumino/disposable": "^2.0.0-rc.0",
+    "@lumino/signaling": "^2.0.0-rc.0",
+    "@rjsf/utils": "^5.1.0",
+    "ajv": "^8.12.0",
+    "json5": "^2.2.3"
   },
   "devDependencies": {
-    "@jupyterlab/testutils": "^4.0.0-alpha.2",
-    "@types/jest": "^26.0.10",
-    "@types/json5": "^0.0.30",
-    "jest": "^26.4.2",
+    "@jupyterlab/testing": "^4.0.0-alpha.20",
+    "@types/jest": "^29.2.0",
     "rimraf": "~3.0.0",
-    "ts-jest": "^26.3.0",
-    "typescript": "~4.5.2"
+    "typescript": "~5.0.0-beta"
   },
   "publishConfig": {
     "access": "public"

package/src/index.ts

@@ -0,0 +1,11 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+/**
+ * @packageDocumentation
+ * @module settingregistry
+ */
+
+export * from './settingregistry';
+export * from './tokens';

package/src/plugin-schema.json

@@ -0,0 +1,388 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "title": "JupyterLab Plugin Settings/Preferences Schema",
+  "description": "JupyterLab plugin settings/preferences schema",
+  "version": "1.0.0",
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "jupyter.lab.internationalization": {
+      "type": "object",
+      "properties": {
+        "selectors": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "domain": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "jupyter.lab.menus": {
+      "type": "object",
+      "properties": {
+        "main": {
+          "title": "Main menu entries",
+          "description": "List of menu items to add to the main menubar.",
+          "items": {
+            "$ref": "#/definitions/menu"
+          },
+          "type": "array",
+          "default": []
+        },
+        "context": {
+          "title": "The application context menu.",
+          "description": "List of context menu items.",
+          "items": {
+            "allOf": [
+              { "$ref": "#/definitions/menuItem" },
+              {
+                "properties": {
+                  "selector": {
+                    "description": "The CSS selector for the context menu item.",
+                    "type": "string"
+                  }
+                }
+              }
+            ]
+          },
+          "type": "array",
+          "default": []
+        }
+      },
+      "additionalProperties": false
+    },
+    "jupyter.lab.metadataforms": {
+      "items": {
+        "$ref": "#/definitions/metadataForm"
+      },
+      "type": "array",
+      "default": []
+    },
+    "jupyter.lab.setting-deprecated": {
+      "type": "boolean",
+      "default": false
+    },
+    "jupyter.lab.setting-icon": {
+      "type": "string",
+      "default": ""
+    },
+    "jupyter.lab.setting-icon-class": {
+      "type": "string",
+      "default": ""
+    },
+    "jupyter.lab.setting-icon-label": {
+      "type": "string",
+      "default": "Plugin"
+    },
+    "jupyter.lab.shortcuts": {
+      "items": {
+        "$ref": "#/definitions/shortcut"
+      },
+      "type": "array",
+      "default": []
+    },
+    "jupyter.lab.toolbars": {
+      "properties": {
+        "^\\w[\\w-\\.]*$": {
+          "items": {
+            "$ref": "#/definitions/toolbarItem"
+          },
+          "type": "array",
+          "default": []
+        }
+      },
+      "type": "object",
+      "default": {}
+    },
+    "jupyter.lab.transform": {
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "definitions": {
+    "menu": {
+      "properties": {
+        "disabled": {
+          "description": "Whether the menu is disabled or not",
+          "type": "boolean",
+          "default": false
+        },
+        "icon": {
+          "description": "Menu icon id",
+          "type": "string"
+        },
+        "id": {
+          "description": "Menu unique id",
+          "oneOf": [
+            {
+              "type": "string",
+              "enum": [
+                "jp-menu-file",
+                "jp-menu-file-new",
+                "jp-menu-edit",
+                "jp-menu-help",
+                "jp-menu-kernel",
+                "jp-menu-run",
+                "jp-menu-settings",
+                "jp-menu-view",
+                "jp-menu-tabs"
+              ]
+            },
+            { "type": "string", "pattern": "[a-z][a-z0-9\\-_]+" }
+          ]
+        },
+        "items": {
+          "description": "Menu items",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/menuItem"
+          }
+        },
+        "label": {
+          "description": "Menu label",
+          "type": "string"
+        },
+        "mnemonic": {
+          "description": "Mnemonic index for the label",
+          "type": "number",
+          "minimum": -1,
+          "default": -1
+        },
+        "rank": {
+          "description": "Menu rank",
+          "type": "number",
+          "minimum": 0
+        }
+      },
+      "required": ["id"],
+      "type": "object"
+    },
+    "menuItem": {
+      "properties": {
+        "args": {
+          "description": "Command arguments",
+          "type": "object"
+        },
+        "command": {
+          "description": "Command id",
+          "type": "string"
+        },
+        "disabled": {
+          "description": "Whether the item is disabled or not",
+          "type": "boolean",
+          "default": false
+        },
+        "type": {
+          "description": "Item type",
+          "type": "string",
+          "enum": ["command", "submenu", "separator"],
+          "default": "command"
+        },
+        "rank": {
+          "description": "Item rank",
+          "type": "number",
+          "minimum": 0
+        },
+        "submenu": {
+          "oneOf": [
+            {
+              "$ref": "#/definitions/menu"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "shortcut": {
+      "properties": {
+        "args": {
+          "title": "The arguments for the command",
+          "type": "object"
+        },
+        "command": {
+          "title": "The command id",
+          "description": "The command executed when the binding is matched.",
+          "type": "string"
+        },
+        "disabled": {
+          "description": "Whether this shortcut is disabled or not.",
+          "type": "boolean",
+          "default": false
+        },
+        "keys": {
+          "title": "The key sequence for the binding",
+          "description": "The key shortcut like `Accel A` or the sequence of shortcuts to press like [`Accel A`, `B`]",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "macKeys": {
+          "title": "The key sequence for the binding on macOS",
+          "description": "The key shortcut like `Cmd A` or the sequence of shortcuts to press like [`Cmd A`, `B`]",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "winKeys": {
+          "title": "The key sequence for the binding on Windows",
+          "description": "The key shortcut like `Ctrl A` or the sequence of shortcuts to press like [`Ctrl A`, `B`]",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "linuxKeys": {
+          "title": "The key sequence for the binding on Linux",
+          "description": "The key shortcut like `Ctrl A` or the sequence of shortcuts to press like [`Ctrl A`, `B`]",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "selector": {
+          "title": "CSS selector",
+          "type": "string"
+        }
+      },
+      "required": ["command", "keys", "selector"],
+      "type": "object"
+    },
+    "toolbarItem": {
+      "properties": {
+        "name": {
+          "title": "Unique name",
+          "type": "string"
+        },
+        "args": {
+          "title": "Command arguments",
+          "type": "object"
+        },
+        "command": {
+          "title": "Command id",
+          "type": "string",
+          "default": ""
+        },
+        "disabled": {
+          "title": "Whether the item is ignored or not",
+          "type": "boolean",
+          "default": false
+        },
+        "icon": {
+          "title": "Item icon id",
+          "description": "If defined, it will override the command icon",
+          "type": "string"
+        },
+        "label": {
+          "title": "Item label",
+          "description": "If defined, it will override the command label",
+          "type": "string"
+        },
+        "type": {
+          "title": "Item type",
+          "type": "string",
+          "enum": ["command", "spacer"]
+        },
+        "rank": {
+          "title": "Item rank",
+          "type": "number",
+          "minimum": 0,
+          "default": 50
+        }
+      },
+      "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": {
+        "customRenderer": {
+          "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"
+    }
+  }
+}