7x docs and stability improvements

.vscode/launch.json

@@ -90,7 +90,21 @@
       "cwd": "${workspaceFolder}/packages/template-ocean-eez",
       "runtimeArgs": [
         "--inspect-brk",
-        "${workspaceRoot}/packages/template-ocean-eez/node_modules/.bin/geoprocessing",
+        "${workspaceRoot}/node_modules/.bin/geoprocessing",
+        "test"
+      ],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "port": 9229
+    },
+    {
+      "name": "template-blank-project - debug tests",
+      "type": "node",
+      "request": "launch",
+      "cwd": "${workspaceFolder}/packages/template-blank-project",
+      "runtimeArgs": [
+        "--inspect-brk",
+        "${workspaceRoot}/node_modules/.bin/geoprocessing",
         "test"
       ],
       "console": "integratedTerminal",

README.md

@@ -1,15 +1,15 @@
 # Geoprocessing
 
-All-in-one solution for developing low-cost and low-maintenance geoprocessing functions and reports for the web, with Typescript. Simplified publish to cloud with auto-scaling to meet high demand.
+All-in-one solution for developing low-cost and low-maintenance geoprocessing functions and reports for SeaSketch. Simplified publish to cloud with auto-scaling to meet high demand.
 
 This framework is part of the [SeaSketch](https://seasketch.org) ecosystem.
 
-- [Documentation](https://github.com/seasketch/geoprocessing/wiki)
-- [Changelog](https://github.com/seasketch/geoprocessing/blob/dev/CHANGELOG.md)
+- [Documentation](https://seasketch.github.io/geoprocessing)
+- [Releases](https://github.com/seasketch/geoprocessing/releases)
 
 ## Who is this framework for?
 
-This framework is primarily designed for people that want to create and host their own geoprocessing functions and reports and plug them into their SeaSketch project, though it is not dependent on SeaSketch. It is used for all SeaSketch [projects](https://github.com/seasketch/geoprocessing/network/dependents?package_id=UGFja2FnZS0xMTc3OTQ1NDg5).
+This framework is designed for people with coding experience that want to create and host their own geoprocessing functions and reports and plug them into their SeaSketch project. It is used for all SeaSketch [projects](https://github.com/seasketch/geoprocessing/network/dependents?package_id=UGFja2FnZS0xMTc3OTQ1NDg5).
 
 ## Goals
 

eslint.config.mjs

@@ -41,6 +41,7 @@ export default [
     rules: {
       "@typescript-eslint/no-explicit-any": "off",
       "@typescript-eslint/no-unused-vars": "warn",
+      "@typescript-eslint/ban-ts-comment": "off",
       "react/no-unescaped-entities": "off",
       trailingComma: "off",
       "unicorn/prevent-abbreviations": "off",

package.json

@@ -2,7 +2,9 @@
   "name": "root",
   "private": true,
   "workspaces": [
-    "packages/*"
+    "packages/geoprocessing",
+    "packages/base-project",
+    "packages/template-blank-project"
   ],
   "license": "BSD-3-Clause",
   "devDependencies": {
@@ -51,9 +53,10 @@
     "publish:experimental:canary": "BRANCH_NAME=`git rev-parse --symbolic-full-name --abbrev-ref HEAD`; if [ $BRANCH_NAME != \"dev\" -a $BRANCH_NAME != \"main\" ] ; then CI=1 lerna publish --force-publish --canary --preid experimental-${BRANCH_NAME} --dist-tag=experimental-${BRANCH_NAME} ; fi",
     "publish:alpha": "CI=1 lerna publish --force-publish --preid alpha --dist-tag=alpha",
     "publish:beta": "CI=1 lerna publish --force-publish --preid beta --dist-tag=beta",
-    "publish:stable": "npm run test && CI=1 lerna publish",
-    "publish:backport": "npm run test && CI=1 lerna publish --preid backport --dist-tag=backport",
+    "publish:stable": "CI=1 lerna publish",
+    "publish:backport": "CI=1 lerna publish --preid backport --dist-tag=backport",
     "prepare": "husky",
+    "prepublish": "npm test && lerna run --scope=@seasketch/geoprocessing prepare",
     "publish:translation": "npx tsx packages/geoprocessing/src/i18n/bin/publishTerms.ts",
     "import:translation": "npx tsx packages/geoprocessing/src/i18n/bin/importTerms.ts",
     "sync:translation": "npm run extract:translationt && npm run publish:translation && npm run import:translation",

packages/base-project/.prettierignore

@@ -2,4 +2,4 @@
 **/.svn
 **/.hg
 node_modules
-examples/output
+examples

packages/base-project/.storybook/genReportStories.ts

@@ -10,8 +10,6 @@ import {
 import { GpStoryConfig } from "./types.js";
 import { v4 as uuid } from "uuid";
 
-// Not currently used, project space responsible for its own storybook+vite setup
-
 if (!process.env.PROJECT_PATH) {
   throw new Error("PROJECT_PATH environment variable not set");
 }
@@ -162,6 +160,11 @@ for (const storyConfig of storyConfigs) {
       ...(childProperties ? { childProperties } : {}),
     };
 
+    // Convert sketch name to valid variable name, which is displayed as the story name
+    const sketchVariableName = sketch.properties.name
+      .replace(/^[^a-zA-Z$_\p{L}]/u, "_") // Replace invalid starting characters
+      .replaceAll(/[^a-zA-Z0-9$_\p{L}]/gu, "_"); // Replace invalid subsequent characters
+
     const story = `
       import React from "react";
       import { ${storyConfig.componentName} } from '${importFromCacheStr}';
@@ -180,7 +183,7 @@ for (const storyConfig of storyConfigs) {
         language: "en"
       });
 
-      export const ${sketch.properties.name.replaceAll("-", "_")} = () => (
+      export const ${sketchVariableName} = () => (
         <Translator>
           <${storyConfig.componentName} />
         </Translator>

packages/base-project/.vscode/schemas.json

@@ -53,37 +53,67 @@
       ],
       "additionalProperties": false
     },
-    "metricsSchema": {
+    "metricGroupSchema": {
       "type": "array",
       "items": {
-        "type": "object",
-        "properties": {
-          "metricId": { "type": "string" },
-          "type": { "type": "string" },
-          "datasourceId": { "type": "string" },
-          "classKey": { "type": "string" },
-          "classes": {
-            "type": "array",
-            "items": {
-              "type": "object",
-              "properties": {
-                "classId": { "type": "string" },
-                "classKey": { "type": "string" },
-                "datasourceId": { "type": "string" },
-                "display": { "type": "string" },
-                "numericClassId": { "type": "number" },
-                "layerId": { "type": "string" },
-                "objectiveId": { "type": "string" }
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "metricId": { "type": "string" },
+              "type": { "type": "string" },
+              "datasourceId": { "type": "string" },
+              "classKey": { "type": "string" },
+              "classes": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "classId": { "type": "string" },
+                    "display": { "type": "string" },
+                    "numericClassId": { "type": "number" },
+                    "layerId": { "type": "string" },
+                    "objectiveId": { "type": "string" }
+                  },
+                  "required": ["classId", "display"],
+                  "additionalProperties": false
+                }
               },
-              "required": ["classId", "display"],
-              "additionalProperties": false
-            }
+              "layerId": { "type": "string" },
+              "objectiveId": { "type": "string" }
+            },
+            "required": ["metricId", "classes", "datasourceId"],
+            "additionalProperties": false
           },
-          "layerId": { "type": "string" },
-          "objectiveId": { "type": "string" }
-        },
-        "required": ["metricId", "type", "classes"],
-        "additionalProperties": false
+          {
+            "type": "object",
+            "properties": {
+              "metricId": { "type": "string" },
+              "type": { "type": "string" },
+              "classes": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "classId": { "type": "string" },
+                    "classKey": { "type": "string" },
+                    "datasourceId": { "type": "string" },
+                    "display": { "type": "string" },
+                    "numericClassId": { "type": "number" },
+                    "layerId": { "type": "string" },
+                    "objectiveId": { "type": "string" }
+                  },
+                  "required": ["classId", "display", "datasourceId"],
+                  "additionalProperties": false
+                }
+              },
+              "layerId": { "type": "string" },
+              "objectiveId": { "type": "string" }
+            },
+            "required": ["metricId", "classes"],
+            "additionalProperties": false
+          }
+        ]
       }
     },
     "objectivesSchema": {
@@ -431,7 +461,7 @@
   "oneOf": [
     { "$ref": "#/definitions/basicSchema" },
     { "$ref": "#/definitions/objectivesSchema" },
-    { "$ref": "#/definitions/metricsSchema" },
+    { "$ref": "#/definitions/metricGroupSchema" },
     { "$ref": "#/definitions/geographiesSchema" },
     { "$ref": "#/definitions/datasourcesSchema" }
   ]

packages/base-project/README.md

@@ -1,5 +1,3 @@
 # Getting Started
 
-This is a geoprocessing project. It was created using the `geoprocessing init` command, as part of the tutorial to [create a new project](https://github.com/seasketch/geoprocessing/wiki/Tutorials#create-a-new-geoprocessing-project).
-
-Once established, you can follow the tutorial to [setup an existing project on a new system](https://github.com/seasketch/geoprocessing/wiki/Tutorials#setup-an-exising-project-on-your-local-system)
+This is a geoprocessing project created using the SeaSketch geoprocessing framework.

packages/base-project/package.json

@@ -35,7 +35,7 @@
     "reimport:data": "geoprocessing reimport:data",
     "start:data": "http-server data/dist -c-1",
     "start:client": "geoprocessing start:client",
-    "storybook": "PROJECT_PATH=$(pwd) npx tsx .storybook/genReportStories.ts && storybook dev -p 6006",
+    "storybook": "PROJECT_PATH=$(pwd) npx tsx .storybook/genReportStories.ts && storybook dev -p 6006 --no-open",
     "sync:translation": "npm run extract:translation && npm run publish:translation && npm run import:translation",
     "synth": "geoprocessing synth",
     "test": "start-server-and-test start:data 8080 'npm run __test'",
@@ -72,6 +72,7 @@
     "storybook": "^8.2.9",
     "vite": "^5.4.2",
     "vitest": "^2.0.5",
+    "vitest-fetch-mock": "^0.4.2",
     "zx": "^8.1.5"
   }
 }