Restructure project to use NPM workspaces

- Create packages/dynamodb-entity-store/ for main package
- Add root package.json with workspace configuration
- Update examples to reference workspace package
- Update GitHub Actions workflows for new structure
- All scripts now delegate to workspace packages

This prepares the project for adding the testutils package
while maintaining the ability to publish the main package.

Author: claude

.github/workflows/publish.yaml

@@ -51,17 +51,17 @@ jobs:
 
       - run: npm install
 
-      # Modify package.json, inserting version attribute
-      - run: npm version $RELEASE_VERSION --no-git-tag-version
+      # Modify package.json, inserting version attribute in the main package
+      - run: npm version $RELEASE_VERSION --no-git-tag-version --workspace=@symphoniacloud/dynamodb-entity-store
 
       # Perform publish with appropriate tag and provenance, which will also run prepublishOnly
       # Uses npm provenance (OIDC) instead of long-lived token for security
-      - run: npm publish --access public --provenance --tag ${{ steps.dist-tag.outputs.tag }}
+      - run: npm publish --access public --provenance --tag ${{ steps.dist-tag.outputs.tag }} --workspace=@symphoniacloud/dynamodb-entity-store
 
       # Only generate and deploy docs for stable releases
       - name: Generate docs
         if: steps.dist-tag.outputs.tag == 'latest'
-        run: npm run generate-docs
+        run: npm run generate-docs --workspace=@symphoniacloud/dynamodb-entity-store
 
       - name: Upload docs artifact
         if: steps.dist-tag.outputs.tag == 'latest'

examples/package.json

@@ -15,7 +15,7 @@
     "local-checks": "tsc"
   },
   "dependencies": {
-    "@symphoniacloud/dynamodb-entity-store": "1.x"
+    "@symphoniacloud/dynamodb-entity-store": "*"
   },
   "devDependencies": {
     "@aws-sdk/types": "3.x",

package-lock.json

@@ -1,49 +1,41 @@
 {
-  "name": "@symphoniacloud/dynamodb-entity-store",
-  "description": "A lightly opinionated DynamoDB library for TypeScript & JavaScript applications",
+  "name": "@symphoniacloud/dynamodb-entity-store-workspace",
+  "version": "1.0.0",
+  "private": true,
+  "description": "Workspace for DynamoDB Entity Store packages",
   "license": "MIT",
   "author": {
     "email": "[email protected]",
     "name": "Mike Roberts",
     "url": "https://symphonia.io"
   },
-  "keywords": [
-    "dynamodb"
+  "workspaces": [
+    "packages/*",
+    "examples"
   ],
-  "homepage": "https://github.com/symphoniacloud/dynamodb-entity-store",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/symphoniacloud/dynamodb-entity-store.git"
-  },
-  "bugs": {
-    "url": "https://github.com/symphoniacloud/dynamodb-entity-store/issues"
-  },
-  "type": "module",
   "scripts": {
-    "lint": "eslint --max-warnings=0 --fix-dry-run \"{src,test}/**/*.{js,ts}\"",
-    "format": "prettier --check \"{src,test}/**/*.{js,ts}\"",
-    "unit-tests": "npx vitest run --dir test/unit",
-    "local-checks": "tsc && npm run lint && npm run unit-tests",
-    "integration-tests": "npx vitest run --dir test/integration --config ./test/integration/vitest.config.ts",
-    "all-checks": "npm run local-checks && npm run integration-tests",
-    "deploy": "cd test/examples && aws cloudformation deploy --template-file template.yaml --stack-name \"${STACK_NAME-entity-store-test-stack}\" --no-fail-on-empty-changeset",
-    "deploy-and-all-checks": "npm run deploy && npm run all-checks",
-    "build": "rm -rf dist && tsc -p tsconfig.json",
-    "prepublishOnly": "npm run local-checks && npm run build",
-    "check-examples": "cd examples && npm run local-checks",
-    "generate-docs": "typedoc src/lib/index.ts"
+    "build": "npm run build --workspace=@symphoniacloud/dynamodb-entity-store",
+    "test": "npm run unit-tests --workspace=@symphoniacloud/dynamodb-entity-store && npm run integration-tests --workspace=@symphoniacloud/dynamodb-entity-store",
+    "unit-tests": "npm run unit-tests --workspace=@symphoniacloud/dynamodb-entity-store",
+    "integration-tests": "npm run integration-tests --workspace=@symphoniacloud/dynamodb-entity-store",
+    "lint": "npm run lint --workspaces --if-present",
+    "format": "npm run format --workspaces --if-present",
+    "local-checks": "npm run local-checks --workspace=@symphoniacloud/dynamodb-entity-store",
+    "all-checks": "npm run all-checks --workspace=@symphoniacloud/dynamodb-entity-store",
+    "deploy": "npm run deploy --workspace=@symphoniacloud/dynamodb-entity-store",
+    "deploy-and-all-checks": "npm run deploy-and-all-checks --workspace=@symphoniacloud/dynamodb-entity-store",
+    "check-examples": "npm run local-checks --workspace=@symphoniacloud/dynamodb-entity-store-examples",
+    "generate-docs": "npm run generate-docs --workspace=@symphoniacloud/dynamodb-entity-store"
   },
   "engines": {
     "node": ">=22.0.0"
   },
-  "dependencies": {
-    "@aws-sdk/client-dynamodb": "3.x",
-    "@aws-sdk/lib-dynamodb": "3.x",
-    "@aws-sdk/util-dynamodb": "3.x"
-  },
   "devDependencies": {
     "@aws-sdk/client-cloudformation": "3.x",
+    "@aws-sdk/client-dynamodb": "3.x",
+    "@aws-sdk/lib-dynamodb": "3.x",
     "@aws-sdk/types": "3.x",
+    "@aws-sdk/util-dynamodb": "3.x",
     "@eslint/js": "9.x",
     "@types/deep-equal": "1.x",
     "@types/node": "22.x",
@@ -58,17 +50,5 @@
     "typescript": "5.x",
     "typescript-eslint": "8.x",
     "vitest": "3.x"
-  },
-  "files": [
-    "package.json",
-    "README.md",
-    "LICENSE",
-    "dist/"
-  ],
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    }
   }
 }

package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@symphoniacloud/dynamodb-entity-store",
+  "description": "A lightly opinionated DynamoDB library for TypeScript & JavaScript applications",
+  "license": "MIT",
+  "author": {
+    "email": "[email protected]",
+    "name": "Mike Roberts",
+    "url": "https://symphonia.io"
+  },
+  "keywords": [
+    "dynamodb"
+  ],
+  "homepage": "https://github.com/symphoniacloud/dynamodb-entity-store",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/symphoniacloud/dynamodb-entity-store.git"
+  },
+  "bugs": {
+    "url": "https://github.com/symphoniacloud/dynamodb-entity-store/issues"
+  },
+  "type": "module",
+  "scripts": {
+    "lint": "eslint --max-warnings=0 --fix-dry-run \"{src,test}/**/*.{js,ts}\"",
+    "format": "prettier --check \"{src,test}/**/*.{js,ts}\"",
+    "unit-tests": "npx vitest run --dir test/unit",
+    "local-checks": "tsc && npm run lint && npm run unit-tests",
+    "integration-tests": "npx vitest run --dir test/integration --config ./test/integration/vitest.config.ts",
+    "all-checks": "npm run local-checks && npm run integration-tests",
+    "deploy": "cd test/examples && aws cloudformation deploy --template-file template.yaml --stack-name \"${STACK_NAME-entity-store-test-stack}\" --no-fail-on-empty-changeset",
+    "deploy-and-all-checks": "npm run deploy && npm run all-checks",
+    "build": "rm -rf dist && tsc -p tsconfig.json",
+    "prepublishOnly": "npm run local-checks && npm run build",
+    "generate-docs": "typedoc src/lib/index.ts"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "dependencies": {
+    "@aws-sdk/client-dynamodb": "3.x",
+    "@aws-sdk/lib-dynamodb": "3.x",
+    "@aws-sdk/util-dynamodb": "3.x"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-cloudformation": "3.x",
+    "@aws-sdk/types": "3.x",
+    "@eslint/js": "9.x",
+    "@types/deep-equal": "1.x",
+    "@types/node": "22.x",
+    "@typescript-eslint/eslint-plugin": "8.x",
+    "@typescript-eslint/parser": "8.x",
+    "deep-equal": "2.x",
+    "eslint": "9.x",
+    "eslint-config-prettier": "9.x",
+    "prettier": "3.x",
+    "ts-node": "10.x",
+    "typedoc": "^0.26.0",
+    "typescript": "5.x",
+    "typescript-eslint": "8.x",
+    "vitest": "3.x"
+  },
+  "files": [
+    "package.json",
+    "../../README.md",
+    "../../LICENSE",
+    "dist/"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  }
+}