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

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
@@ -197,23 +204,53 @@
         "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"
                     },
-                    "minItems": 1,
                     "type": "array"
                 },
                 "selector": {
+                    "title": "CSS selector",
                     "type": "string"
                 }
             },
@@ -265,6 +302,87 @@
             "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"
         }
     }
 }

package/lib/settingregistry.d.ts

@@ -29,18 +29,14 @@ export declare namespace ISchemaValidator {
      * A schema validation error definition.
      */
     interface IError {
-        /**
-         * The path in the data where the error occurred.
-         */
-        dataPath: string;
         /**
          * The keyword whose validation failed.
          */
-        keyword: string;
+        keyword: string | string[];
         /**
          * The error message.
          */
-        message: string;
+        message?: string;
         /**
          * Optional parameter metadata that might be included in an error.
          */
@@ -49,6 +45,26 @@ export declare namespace ISchemaValidator {
          * The path in the schema where the error occurred.
          */
         schemaPath: string;
+        /**
+         * @todo handle new fields from ajv8
+         **/
+        schema?: unknown;
+        /**
+         * @todo handle new fields from ajv8
+         **/
+        instancePath: string;
+        /**
+         * @todo handle new fields from ajv8
+         **/
+        propertyName?: string;
+        /**
+         * @todo handle new fields from ajv8
+         **/
+        data?: unknown;
+        /**
+         * @todo handle new fields from ajv8
+         **/
+        parentSchema?: unknown;
     }
 }
 /**
@@ -229,10 +245,35 @@ export declare class SettingRegistry implements ISettingRegistry {
     private _timeout;
     private _transformers;
 }
+/**
+ * Base settings specified by a JSON schema.
+ */
+export declare class BaseSettings<T extends ISettingRegistry.IProperty = ISettingRegistry.IProperty> {
+    constructor(options: {
+        schema: T;
+    });
+    /**
+     * The plugin's schema.
+     */
+    get schema(): T;
+    /**
+     * Checks if any fields are different from the default value.
+     */
+    isDefault(user: ReadonlyPartialJSONObject): boolean;
+    /**
+     * Calculate the default value of a setting by iterating through the schema.
+     *
+     * @param key - The name of the setting whose default value is calculated.
+     *
+     * @returns A calculated default JSON value for a specific setting.
+     */
+    default(key?: string): PartialJSONValue | undefined;
+    private _schema;
+}
 /**
  * A manager for a specific plugin's settings.
  */
-export declare class Settings implements ISettingRegistry.ISettings {
+export declare class Settings extends BaseSettings<ISettingRegistry.ISchema> implements ISettingRegistry.ISettings {
     /**
      * Instantiate a new plugin settings manager.
      */
@@ -258,14 +299,14 @@ export declare class Settings implements ISettingRegistry.ISettings {
      */
     get isDisposed(): boolean;
     get plugin(): ISettingRegistry.IPlugin;
-    /**
-     * The plugin's schema.
-     */
-    get schema(): ISettingRegistry.ISchema;
     /**
      * The plugin settings raw text value.
      */
     get raw(): string;
+    /**
+     * Whether the settings have been modified by the user or not.
+     */
+    get isModified(): boolean;
     /**
      * The user settings.
      */
@@ -278,14 +319,6 @@ export declare class Settings implements ISettingRegistry.ISettings {
      * Return the defaults in a commented JSON format.
      */
     annotatedDefaults(): string;
-    /**
-     * Calculate the default value of a setting by iterating through the schema.
-     *
-     * @param key - The name of the setting whose default value is calculated.
-     *
-     * @returns A calculated default JSON value for a specific setting.
-     */
-    default(key: string): PartialJSONValue | undefined;
     /**
      * Dispose of the plugin settings resources.
      */