terriajs-plugin-api - npm Package Compare versions

Comparing version 0.0.1-alpha.6 to 0.0.1-alpha.7

dist/index.d.ts

@@ -6,1 +6,4 @@ export * from "./Mixins";
 export * from "./Views";
+export * from "./Hooks";
+import * as deprecated from "./Deprecated";
+export { deprecated };

dist/index.js

@@ -6,1 +6,4 @@ export * from "./Mixins";
 export * from "./Views";
+export * from "./Hooks";
+import * as deprecated from "./Deprecated";
+export { deprecated };

dist/Mixins.d.ts

 export { default as CatalogMemberMixin } from "terriajs/lib/ModelMixins/CatalogMemberMixin";
+export { default as Cesium3dTilesMixin } from "terriajs/lib/ModelMixins/Cesium3dTilesMixin";
 export { default as GeojsonMixin } from "terriajs/lib/ModelMixins/GeojsonMixin";
+export { default as GltfMixin, GltfTransformationJson } from "terriajs/lib/ModelMixins/GltfMixin";
 export { default as MappableMixin } from "terriajs/lib/ModelMixins/MappableMixin";
+export { default as ReferenceMixin } from "terriajs/lib/ModelMixins/ReferenceMixin";
 export { default as TableMixin } from "terriajs/lib/ModelMixins/TableMixin";

dist/Mixins.js

 export { default as CatalogMemberMixin } from "terriajs/lib/ModelMixins/CatalogMemberMixin";
+export { default as Cesium3dTilesMixin } from "terriajs/lib/ModelMixins/Cesium3dTilesMixin";
 export { default as GeojsonMixin } from "terriajs/lib/ModelMixins/GeojsonMixin";
+export { default as GltfMixin } from "terriajs/lib/ModelMixins/GltfMixin";
 export { default as MappableMixin } from "terriajs/lib/ModelMixins/MappableMixin";
+export { default as ReferenceMixin } from "terriajs/lib/ModelMixins/ReferenceMixin";
 export { default as TableMixin } from "terriajs/lib/ModelMixins/TableMixin";

dist/Models.d.ts

@@ -0,8 +1,12 @@
+export { default as TerriaError } from "terriajs/lib/Core/TerriaError";
 export { MapItem } from "terriajs/lib/ModelMixins/MappableMixin";
-export { default as BoxDrawing } from "terriajs/lib/Models/BoxDrawing";
+export { BoxDrawingChangeParams, default as BoxDrawing } from "terriajs/lib/Models/BoxDrawing";
 export { default as CatalogMemberFactory } from "terriajs/lib/Models/Catalog/CatalogMemberFactory";
+export { default as SplitItemReference } from "terriajs/lib/Models/Catalog/CatalogReferences/SplitItemReference";
+export { default as Cesium } from "terriajs/lib/Models/Cesium";
 export { default as CommonStrata } from "terriajs/lib/Models/Definition/CommonStrata";
 export { default as CreateModel } from "terriajs/lib/Models/Definition/CreateModel";
-export { default as Model } from "terriajs/lib/Models/Definition/Model";
+export { BaseModel, default as Model } from "terriajs/lib/Models/Definition/Model";
 export { default as updateModelFromJson } from "terriajs/lib/Models/Definition/updateModelFromJson";
+export { default as HasLocalData } from "terriajs/lib/Models/HasLocalData";
 export { SelectableDimensionButton, SelectableDimensionCheckbox, SelectableDimensionCheckboxGroup, SelectableDimensionColor, SelectableDimensionEnum, SelectableDimensionGroup, SelectableDimensionNumeric, SelectableDimensionText } from "terriajs/lib/Models/SelectableDimensions/SelectableDimensions";
@@ -16,2 +20,4 @@ export { default as Terria } from "terriajs/lib/Models/Terria";
 export { default as MapNavigationItemController } from "terriajs/lib/ViewModels/MapNavigation/MapNavigationItemController";
+export { SelectableDimensionWorkflow, runWorkflow };
+import { default as SelectableDimensionWorkflow, runWorkflow } from "terriajs/lib/Models/Workflows/SelectableDimensionWorkflow";
 import * as MapToolbar from "terriajs/lib/ViewModels/MapNavigation/MapToolbar";
@@ -21,4 +27,7 @@ export { MapToolbar };
 export { ViewingControlsMenu };
-import { default as SelectableDimensionWorkflow, runWorkflow } from "terriajs/lib/Models/Workflows/SelectableDimensionWorkflow";
-export { SelectableDimensionWorkflow, runWorkflow };
-export { default as TerriaError } from "terriajs/lib/Core/TerriaError";
+import * as WorkbenchItem from "terriajs/lib/ViewModels/WorkbenchItem";
+export { WorkbenchItem };
+import * as FeatureInfoPanel from "terriajs/lib/ViewModels/FeatureInfoPanel";
+export { FeatureInfoPanel };
+import * as UploadDataTypes from "terriajs/lib/ViewModels/UploadDataTypes";
+export { UploadDataTypes };

dist/Models.js

@@ -0,6 +1,11 @@
+export { default as TerriaError } from "terriajs/lib/Core/TerriaError";
 export { default as BoxDrawing } from "terriajs/lib/Models/BoxDrawing";
 export { default as CatalogMemberFactory } from "terriajs/lib/Models/Catalog/CatalogMemberFactory";
+export { default as SplitItemReference } from "terriajs/lib/Models/Catalog/CatalogReferences/SplitItemReference";
+export { default as Cesium } from "terriajs/lib/Models/Cesium";
 export { default as CommonStrata } from "terriajs/lib/Models/Definition/CommonStrata";
 export { default as CreateModel } from "terriajs/lib/Models/Definition/CreateModel";
+export { BaseModel } from "terriajs/lib/Models/Definition/Model";
 export { default as updateModelFromJson } from "terriajs/lib/Models/Definition/updateModelFromJson";
+export { default as HasLocalData } from "terriajs/lib/Models/HasLocalData";
 export { default as Terria } from "terriajs/lib/Models/Terria";
@@ -13,2 +18,4 @@ export { default as UserDrawing } from "terriajs/lib/Models/UserDrawing";
 export { default as MapNavigationItemController } from "terriajs/lib/ViewModels/MapNavigation/MapNavigationItemController";
+export { runWorkflow };
+import { runWorkflow } from "terriajs/lib/Models/Workflows/SelectableDimensionWorkflow";
 import * as MapToolbar from "terriajs/lib/ViewModels/MapNavigation/MapToolbar";
@@ -18,4 +25,7 @@ export { MapToolbar };
 export { ViewingControlsMenu };
-import { runWorkflow } from "terriajs/lib/Models/Workflows/SelectableDimensionWorkflow";
-export { runWorkflow };
-export { default as TerriaError } from "terriajs/lib/Core/TerriaError";
+import * as WorkbenchItem from "terriajs/lib/ViewModels/WorkbenchItem";
+export { WorkbenchItem };
+import * as FeatureInfoPanel from "terriajs/lib/ViewModels/FeatureInfoPanel";
+export { FeatureInfoPanel };
+import * as UploadDataTypes from "terriajs/lib/ViewModels/UploadDataTypes";
+export { UploadDataTypes };

dist/TerriaPlugin.d.ts

@@ -14,7 +14,40 @@ import ViewState from "terriajs/lib/ReactViewModels/ViewState";
 export interface TerriaPluginContext {
+    /**
+     * The root view model for terriajs. Most API interfaces will require this
+     * ViewState instance to be passed as a parameter.
+     */
     viewState: ViewState;
+    /**
+     * Terria app instance
+     */
     terria: Terria;
+    /**
+     * Workbench instance
+     *
+     * TODO: Decide whether we need to expose Workbench object?
+     * Perhaps we should write a Workbench ViewModel that
+     * defines functions like Workbench.addItem(viewState, item)
+     * without having to expose the internal Workbench object.
+     */
     workbench: Workbench;
+    /**
+     *
+     * Map overlay instance. Items added to the overlay appear on the map but do
+     * not appear in the workbench.
+     *
+     * TODO: Decide whether we need to expose Workbench object?
+     * Perhaps we should write a Workbench ViewModel that
+     * defines functions like Overlays.addItem(viewState, item)
+     * without having to expose the internal Workbench object.
+     */
     overlays: Workbench;
+    /**
+     * Configuration for the plugin read from `config.json`.
+     */
+    pluginConfig?: any;
 }
-export declare function createPluginContext(viewState: ViewState): TerriaPluginContext;
+/**
+ * Creates a TerriaPluginContext with top-level objects accessible to the plugin.
+ *
+ */
+export declare function createPluginContext(viewState: ViewState, pluginConfig: any): TerriaPluginContext;

dist/TerriaPlugin.js

@@ -1,2 +0,6 @@
-export function createPluginContext(viewState) {
+/**
+ * Creates a TerriaPluginContext with top-level objects accessible to the plugin.
+ *
+ */
+export function createPluginContext(viewState, pluginConfig) {
     return {
@@ -6,4 +10,5 @@ viewState,
         workbench: viewState.terria.workbench,
-        overlays: viewState.terria.overlays
+        overlays: viewState.terria.overlays,
+        pluginConfig
     };
 }

dist/Views.d.ts

@@ -0,1 +1,4 @@
+export { ActionBar } from "terriajs/lib/ReactViews/ActionBar/ActionBar";
+export { default as ActionBarGroup } from "terriajs/lib/ReactViews/ActionBar/ActionBarGroup";
+export { ActionButton, ActionButtonProps } from "terriajs/lib/ReactViews/ActionBar/ActionButton";
 export { default as WorkflowPanel } from "terriajs/lib/ReactViews/Workflow/WorkflowPanel";
@@ -6,5 +9,5 @@ export { default as AnimatedSpinnerIcon } from "terriajs/lib/Styled/AnimatedSpinnerIcon";
 export { default as Checkbox } from "terriajs/lib/Styled/Checkbox/Checkbox";
-export { default as Icon, StyledIcon, IconGlyph } from "terriajs/lib/Styled/Icon";
+export { default as Icon, IconGlyph, StyledIcon } from "terriajs/lib/Styled/Icon";
 export { default as Input, StyledTextArea } from "terriajs/lib/Styled/Input";
 export { default as Select } from "terriajs/lib/Styled/Select";
 export { default as Text, ITextProps, TextSpan } from "terriajs/lib/Styled/Text";

dist/Views.js

@@ -0,1 +1,4 @@
+export { ActionBar } from "terriajs/lib/ReactViews/ActionBar/ActionBar";
+export { default as ActionBarGroup } from "terriajs/lib/ReactViews/ActionBar/ActionBarGroup";
+export { ActionButton } from "terriajs/lib/ReactViews/ActionBar/ActionButton";
 export { default as WorkflowPanel } from "terriajs/lib/ReactViews/Workflow/WorkflowPanel";
@@ -2,0 +5,0 @@ export { default as AnimatedSpinnerIcon } from "terriajs/lib/Styled/AnimatedSpinnerIcon";

package.json

 {
   "name": "terriajs-plugin-api",
-  "version": "0.0.1-alpha.6",
+  "version": "0.0.1-alpha.7",
   "description": "An (experimental) API for writing plugins for terriajs.",
@@ -16,5 +16,8 @@ "repository": "https://github.com/terriajs/plugin-api",
     "prettier": "^2.6.1",
-    "terriajs": "8.2.11",
+    "terriajs": "8.2.23",
     "typescript": "^3.9.4"
+  },
+  "scripts": {
+    "build": "tsc"
   }
 }

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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

Total package byte prevSize

26047

increased by143.38%

Number of package files

20

increased by33.33%

Lines of code

245

increased by51.23%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes