Initial commit.

Author: na9da

.gitignore

@@ -0,0 +1,5 @@
+dist/
+node_modules/
+
+yarn.lock
+yarn-error.log

README.md

@@ -0,0 +1 @@
+Read [plugin-sample](https://github.com/terriajs/plugin-sample) for now.

package.json

@@ -0,0 +1,15 @@
+{
+  "name": "terriajs-plugin-api",
+  "version": "0.0.1",
+  "description": "An (experimental) API for writing plugins for terriajs.",
+  "repository": "https://github.com/terriajs/plugin-api",
+  "license": "Apache-2.0",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "devDependencies": {
+    "@types/styled-components": "^5.1.24",
+    "prettier": "^2.6.1",
+    "terriajs": "https://github.com/terriajs/terriajs#15751503bc6024b7e0cc0cab72f662fd9d32d3a7",
+    "typescript": "^3.9.4"
+  }
+}

src/Mixins.ts

@@ -0,0 +1,3 @@
+export { default as CatalogMemberMixin } from "terriajs/lib/ModelMixins/CatalogMemberMixin";
+export { default as MappableMixin } from "terriajs/lib/ModelMixins/MappableMixin";
+export { default as TableMixin } from "terriajs/lib/ModelMixins/TableMixin";

src/Models.ts

@@ -0,0 +1,11 @@
+export { MapItem } from "terriajs/lib/ModelMixins/MappableMixin";
+export { default as BoxDrawing } from "terriajs/lib/Models/BoxDrawing";
+export { default as CatalogMemberFactory } from "terriajs/lib/Models/Catalog/CatalogMemberFactory";
+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 { default as Terria } from "terriajs/lib/Models/Terria";
+export { default as UserDrawing } from "terriajs/lib/Models/UserDrawing";
+export { default as ViewerMode } from "terriajs/lib/Models/ViewerMode";
+export { default as ViewState } from "terriajs/lib/ReactViewModels/ViewState";
+export { default as MapNavigationItemController } from "terriajs/lib/ViewModels/MapNavigation/MapNavigationItemController";

src/TerriaPlugin.ts

@@ -0,0 +1,18 @@
+import ViewState from "terriajs/lib/ReactViewModels/ViewState";
+
+export interface TerriaPlugin {
+    name: string;
+    description: string;
+    version: string;
+    register: (ctx: TerriaPluginContext) => void;
+}
+
+export interface TerriaPluginContext {
+    viewState: ViewState;
+}
+
+export function createPluginContext(viewState: ViewState): TerriaPluginContext {
+    return {
+        viewState
+    }
+}

src/Traits.ts

@@ -0,0 +1,14 @@
+export { default as anyTrait } from "terriajs/lib/Traits/Decorators/anyTrait";
+export { default as modelReferenceArrayTrait } from "terriajs/lib/Traits/Decorators/modelReferenceArrayTrait";
+export { default as modelReferenceTrait } from "terriajs/lib/Traits/Decorators/modelReferenceTrait";
+export { default as objectArrayTrait } from "terriajs/lib/Traits/Decorators/objectArrayTrait";
+export { default as objectTrait } from "terriajs/lib/Traits/Decorators/objectTrait";
+export { default as primitiveArrayTrait } from "terriajs/lib/Traits/Decorators/primitiveArrayTrait";
+export { default as primitiveTrait } from "terriajs/lib/Traits/Decorators/primitiveTrait";
+export { default as mixTraits } from "terriajs/lib/Traits/mixTraits";
+export { default as ModelTraits } from "terriajs/lib/Traits/ModelTraits";
+export { default as CatalogMemberTraits } from "terriajs/lib/Traits/TraitsClasses/CatalogMemberTraits";
+export { default as HeadingPitchRollTraits } from "terriajs/lib/Traits/TraitsClasses/HeadingPitchRollTraits";
+export { default as LatLonHeightTraits } from "terriajs/lib/Traits/TraitsClasses/LatLonHeightTraits";
+export { default as MappableTraits } from "terriajs/lib/Traits/TraitsClasses/MappableTraits";
+export { default as TransformationTraits } from "terriajs/lib/Traits/TraitsClasses/TransformationTraits";

src/Views.ts

@@ -0,0 +1,2 @@
+export { default as Box } from "terriajs/lib/Styled/Box";
+export { default as Icon } from "terriajs/lib/Styled/Icon";

src/index.ts

@@ -0,0 +1,5 @@
+export * from "./TerriaPlugin";
+export * from "./Models";
+export * from "./Traits";
+export * from "./Mixins";
+export * from "./Views";

tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    "module": "esNext",
+    "target": "es6",
+    "moduleResolution": "node",
+    "outDir": "dist/",
+    "jsx": "react",
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "declaration": true,
+    "strict": true,
+    // Although this can result in subtle bugs, they are required for us to
+    // ignore TS errors on js files inside terria.  We'll get rid of them when
+    // we have a proper terria bundle with type declarations.
+    // "noImplicitAny": false,
+    // "strictNullChecks": false,
+    // Should these thirdparty types be included in terriajs tsconfig "types" settings,
+    // so that we can avoid specifying it here?
+    // Refer: https://www.typescriptlang.org/tsconfig#types
+    "typeRoots": [
+      "node_modules/terriajs/lib/ThirdParty",
+      // need this if we are in a yarn workspace
+      "../../node_modules/terriajs/lib/ThirdParty"
+    ]
+  },
+  "include": ["src"]
+}