@jupyterlab/rendermime-interfaces - npm Package Compare versions

Comparing version 0.2.1 to 0.3.0

lib/index.d.ts

@@ -59,11 +59,2 @@ import { ReadonlyJSONObject } from '@phosphor/coreutils';
         /**
-         * The file extensions the widget can view.
-         *
-         * #### Notes
-         * Use "*" to denote all files. Specific file extensions must be preceded
-         * with '.', like '.png', '.txt', etc.  They may themselves contain a
-         * period (e.g. .table.json).
-         */
-        readonly fileExtensions: ReadonlyArray<string>;
-        /**
          * The name of the widget to display in dialogs.
@@ -73,29 +64,43 @@ */
         /**
-         * The file extensions for which the factory should be the default.
-         *
-         * #### Notes
-         * Use "*" to denote all files. Specific file extensions must be preceded
-         * with '.', like '.png', '.txt', etc. Entries in this attribute must also
-         * be included in the fileExtensions attribute.
-         * The default is an empty array.
-         *
-         * **See also:** [[fileExtensions]].
+         * The primary file type of the widget.
          */
+        readonly primaryFileType: string;
+        /**
+         * The file types the widget can view.
+         */
+        readonly fileTypes: ReadonlyArray<string>;
+        /**
+         * The file types for which the factory should be the default.
+         */
         readonly defaultFor?: ReadonlyArray<string>;
+    }
+    /**
+     * A file type to associate with the renderer.
+     */
+    interface IFileType {
         /**
-         * Whether the widget factory is read only.
+         * The name of the file type.
          */
-        readonly readOnly?: boolean;
+        readonly name: string;
         /**
-         * The registered name of the model type used to create the widgets.
+         * The mime types associated the file type.
          */
-        readonly modelName?: string;
+        readonly mimeTypes: ReadonlyArray<string>;
         /**
-         * Whether the widgets prefer having a kernel started.
+         * The extensions of the file type (e.g. `".txt"`).  Can be a compound
+         * extension (e.g. `".table.json`).
          */
-        readonly preferKernel?: boolean;
+        readonly extensions: ReadonlyArray<string>;
         /**
-         * Whether the widgets can start a kernel when opened.
+         * An optional pattern for a file name (e.g. `^Dockerfile$`).
          */
-        readonly canStartKernel?: boolean;
+        readonly pattern?: string;
+        /**
+         * The icon class name for the file type.
+         */
+        readonly iconClass?: string;
+        /**
+         * The icon label for the file type.
+         */
+        readonly iconLabel?: string;
     }
@@ -107,5 +112,5 @@ /**
         /**
-         * The MIME type for the renderer, which is the output MIME type it will handle.
+         * The name of the extension.
          */
-        readonly mimeType: string;
+        readonly name: string;
         /**
@@ -128,13 +133,9 @@ * A renderer factory to be registered to render the MIME type.
         /**
-         * The icon class name for the widget.
+         * The options used to open a document with the renderer factory.
          */
-        readonly iconClass?: string;
+        readonly documentWidgetFactoryOptions?: IDocumentWidgetFactoryOptions | ReadonlyArray<IDocumentWidgetFactoryOptions>;
         /**
-         * The icon label for the widget.
+         * The optional file type associated with the extension.
          */
-        readonly iconLabel?: string;
-        /**
-         * The options used to open a document with the renderer factory.
-         */
-        readonly documentWidgetFactoryOptions?: IDocumentWidgetFactoryOptions;
+        readonly fileTypes?: ReadonlyArray<IFileType>;
     }
@@ -152,3 +153,3 @@ /**
     /**
-     * A widget which dislays the contents of a mime model.
+     * A widget which displays the contents of a mime model.
      */
@@ -155,0 +156,0 @@ interface IRenderer extends Widget {

package.json

 {
   "name": "@jupyterlab/rendermime-interfaces",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "JupyterLab - Interfaces for Mime Renderers",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

245

increased by0.41%

Worsened metrics

Total package byte prevSize

8178

decreased by-2.42%

No dependency changes