@spotfire/mods-api - npm Package Compare versions

Comparing version 1.3.0 to 2.0.1

package.json

 {
     "name": "@spotfire/mods-api",
-    "version": "1.3.0",
-    "description": "Mods API.",
+    "version": "2.0.1",
+    "description": "API typings and schemas for Spotfire® Mods",
     "files": [
+        "action-mods/*.d.ts",
+        "action-mods/*.json",
         "visualization-mods/*.d.ts",
@@ -7,0 +9,0 @@ "visualization-mods/*.json"

README.md

@@ -16,3 +16,3 @@ <p align="center">
 This package is versioned in sync with the mods version.
-So if your mod manifest declares version 2.0 then you should depend on `~@spotfire/mods-api@2.0.0`.
+So if your mod manifest declares version 2.0 then you should depend on `@spotfire/mods-api@~2.0.0`.
 If you change the version in your manifest, for instance to version 1.3 to support older versions of Spotfire, then you should update the package version accordingly. 
@@ -19,0 +19,0 @@

visualization-mods/api.d.ts

@@ -1,6 +0,10 @@
-/*
-* Copyright © 2023. Cloud Software Group, Inc.
-* This file is subject to the license terms contained
-* in the license file that is distributed with this file.
-*/
+/**
+ * Copyright © 2024 Cloud Software Group, Inc.
+ * This file is subject to the license terms contained
+ * in the license file that is distributed with this file.
+ * 
+ * Spotfire Visualization Mods API declaration.
+ * Version: 2.0
+ */
+
 export as namespace Spotfire;
@@ -19,3 +23,4 @@
  */
-export declare interface AnalysisProperty<T extends AnalysisPropertyDataType = AnalysisPropertyDataType> extends AnalysisPropertyValue<T> {
+export declare interface AnalysisProperty<T extends AnalysisPropertyDataType = AnalysisPropertyDataType>
+    extends AnalysisPropertyValue<T> {
     /**
@@ -260,3 +265,15 @@ * Set the value of this instance.
      */
-    name: "String" | "Integer" | "LongInteger" | "Real" | "SingleReal" | "Currency" | "Boolean" | "Date" | "DateTime" | "Time" | "TimeSpan" | "Binary";
+    name:
+        | "String"
+        | "Integer"
+        | "LongInteger"
+        | "Real"
+        | "SingleReal"
+        | "Currency"
+        | "Boolean"
+        | "Date"
+        | "DateTime"
+        | "Time"
+        | "TimeSpan"
+        | "Binary";
     /**
@@ -297,3 +314,3 @@ * Gets a value indicating whether the data type is numeric or not, that is,
      */
-    mark(rows: DataViewRow[], operation?: MarkingOperation): void;
+    mark(rows: DataViewRow[], markingOperation?: MarkingOperation): void;
     /**
@@ -706,3 +723,3 @@ * Clears the current marking
      * Show error message. Showing any error message will hide the Mods UI.
-     * @param message - The error message.
+     * @param messages - The error message.
      * @param category - Optional error categorization. Useful if multiple error message are to be shown. Error messages will be sorted based on the category.
@@ -723,3 +740,5 @@ */
 export declare type ExtractValueType<readableArray extends ReadonlyArray<Readable<any>>> = {
-    [readableName in keyof readableArray]: readableArray[readableName] extends Readable<infer readableNameType> ? readableNameType : never;
+    [readableName in keyof readableArray]: readableArray[readableName] extends Readable<infer readableNameType>
+        ? readableNameType
+        : never;
 };
@@ -1315,3 +1334,4 @@
  */
-export declare type ReadableProxy<Node> = Readable<Node> & Omit<Pick<Node, MethodKeys<Node>>, OmittedReadableProxyMethods>;
+export declare type ReadableProxy<Node> = Readable<Node> &
+    Omit<Pick<Node, MethodKeys<Node>>, OmittedReadableProxyMethods>;
 
@@ -1328,4 +1348,3 @@ /**
      * Subscribe to changes in the content for the specified readables when the reader was created.
-     * @example
-     * Subscribe to changes in the {@link DataView}.
+     * @example Subscribe to changes in the {@link DataView}.
      *
@@ -1347,4 +1366,3 @@ * ```
      * Any current subscription for this reader will be cancelled.
-     * @example
-     * Read content of a mod property once.
+     * @example Read content of a mod property once.
      *
@@ -1373,4 +1391,3 @@ * ```
      *
-     * @example
-     * Check if the data view has changed in the subscribe loop.
+     * @example Check if the data view has changed in the subscribe loop.
      *
@@ -1499,3 +1516,5 @@ * ```
      */
-    property<T extends AnalysisPropertyDataType = AnalysisPropertyDataType>(name: string): ReadableProxy<AnalysisProperty<T>>;
+    property<T extends AnalysisPropertyDataType = AnalysisPropertyDataType>(
+        name: string
+    ): ReadableProxy<AnalysisProperty<T>>;
     /**
@@ -1502,0 +1521,0 @@ * Provides access to the {@link Page}s in the Spotfire document.

visualization-mods/schema.json

@@ -144,3 +144,3 @@ {
     "type": "object",
-    "required": ["apiVersion", "version", "name", "id", "icon", "files"],
+    "required": ["apiVersion", "version", "name", "id", "icon", "files", "type"],
     "additionalProperties": false,
@@ -160,4 +160,4 @@ "properties": {
             "description": "Specifies the version of the Mod JavaScript API used by the code of this Mod. Set the lowest possible version number that the Mod requires to ensure best possible backward compatibility with older Spotfire systems. Using a newer API version than specified will result in runtime errors, even if the current Spotfire system includes that API.",
-            "default": "1.3",
-            "examples": ["1.0", "1.1", "1.2", "1.3"],
+            "default": "2.0",
+            "examples": ["1.0", "1.1", "1.2", "1.3", "2.0"],
             "pattern": "^(.*)$"
@@ -173,2 +173,10 @@ },
         },
+        "description": {
+            "type": "string",
+            "title": "Description of the mod",
+            "description": "Specifies the description of this Mod. The description will be shown to the user of the mod.",
+            "default": "",
+            "examples": ["A bar chart visualization."],
+            "pattern": "^(.*)$"
+        },
         "icon": {
@@ -186,2 +194,9 @@ "type": "string",
         },
+        "type": {
+            "type": "string",
+            "title": "The type of mod.",
+            "default": "visualization",
+            "enum": ["visualization"],
+            "pattern": "^(.*)$"
+        },
         "externalResources": {
@@ -188,0 +203,0 @@ "type": "array",

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2409892

increased by2818.92%

Number of package files

6

increased by50%

Lines of code

51030

increased by2518.27%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes