@tailor-platform/create-sdk 0.16.3 → 0.17.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @tailor-platform/create-sdk
 
+## 0.17.0
+
+### Patch Changes
+
+- [#182](https://github.com/tailor-platform/sdk/pull/182) [`a74af85`](https://github.com/tailor-platform/sdk/commit/a74af854b796cfdb701a1f8f78dbabcdfbd3fe02) Thanks [@toiroakr](https://github.com/toiroakr)! - chore: Add comprehensive documentation
+
 ## 0.16.3
 
 ## 0.16.2

package/README.md

@@ -20,6 +20,57 @@ pnpm create @tailor-platform/sdk [OPTIONS] [NAME]
 
 - `--template <template-name>`: (Optional) Specify a template to use for your project. If not provided, you'll be prompted to select one from a list of available templates.
 
+## Available Templates
+
+| Template               | Description                      | Features                                  |
+| ---------------------- | -------------------------------- | ----------------------------------------- |
+| `hello-world`          | Minimal starter project          | Simple resolver example                   |
+| `inventory-management` | Full-featured sample application | TailorDB, Resolver, Executor, Permissions |
+| `testing`              | Testing patterns guide           | Unit tests, E2E tests, Vitest setup       |
+| `multi-application`    | Multi-app architecture           | Shared databases, multiple applications   |
+
+### hello-world
+
+A minimal starter project with a single resolver. Best for learning the basics of the SDK.
+
+**Includes:**
+
+- Simple "hello" query resolver
+- Basic project configuration
+
+### inventory-management
+
+A complete inventory management system demonstrating real-world patterns.
+
+**Includes:**
+
+- TailorDB types: User, Product, Category, Order, Inventory, Contact, Notification
+- Role-based permissions (Manager, Staff)
+- Custom resolver for order registration with inventory updates
+- Executor for inventory threshold monitoring
+- Machine users for API access
+
+### testing
+
+A comprehensive guide to testing patterns with Vitest.
+
+**Includes:**
+
+- Unit test examples (simple resolver, mock TailorDB, dependency injection)
+- E2E test setup with deployed application
+- CI/CD integration patterns
+- Global setup for test credentials
+
+### multi-application
+
+Demonstrates multiple applications sharing databases within a workspace.
+
+**Includes:**
+
+- User application (owns shared database)
+- Admin application (references shared database as external)
+- Coordinated deployment scripts
+
 ## What it does
 
 This tool will:
@@ -33,3 +84,7 @@ This tool will:
 
 - If none of the supported package managers (npm, yarn, pnpm) are found, dependency installation will be skipped.
 - If the project already exists within a git repository, git initialization will be skipped.
+
+## Documentation
+
+For complete SDK documentation, see the [SDK documentation](https://github.com/tailor-platform/sdk/blob/main/packages/sdk/docs/quickstart.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailor-platform/create-sdk",
-  "version": "0.16.3",
+  "version": "0.17.0",
   "description": "A CLI tool to quickly create a new Tailor Platform SDK project",
   "license": "MIT",
   "type": "module",

package/templates/hello-world/README.md

@@ -34,7 +34,7 @@ npm run deploy -- --workspace-id <your-workspace-id>
 
 ```graphql
 query {
-  hello(input: { name: "sdk" }) {
+  hello(name: "sdk") {
     message
   }
 }

package/templates/hello-world/package.json

@@ -12,10 +12,10 @@
   },
   "devDependencies": {
     "@eslint/js": "9.39.1",
-    "@tailor-platform/sdk": "0.16.3",
+    "@tailor-platform/sdk": "0.17.0",
     "@types/node": "22.19.2",
     "eslint": "9.39.1",
-    "prettier": "3.7.3",
+    "prettier": "3.7.4",
     "typescript": "5.9.3",
     "typescript-eslint": "8.49.0"
   }

package/templates/inventory-management/README.md

@@ -34,9 +34,9 @@ npm run deploy -- --workspace-id <your-workspace-id>
 
 ```bash
 # Get Manager's token
-npx tailor-sdk machineuser token inventory-management -m manager
+npx tailor-sdk machineuser token manager --workspace-id <your-workspace-id>
 # Get Staff's token
-npx tailor-sdk machineuser token inventory-management -m staff
+npx tailor-sdk machineuser token staff --workspace-id <your-workspace-id>
 ```
 
 ## Features

package/templates/inventory-management/package.json

@@ -18,10 +18,10 @@
   "devDependencies": {
     "@eslint/js": "9.39.1",
     "@tailor-platform/function-types": "0.8.0",
-    "@tailor-platform/sdk": "0.16.3",
+    "@tailor-platform/sdk": "0.17.0",
     "@types/node": "22.19.2",
     "eslint": "9.39.1",
-    "prettier": "3.7.3",
+    "prettier": "3.7.4",
     "typescript": "5.9.3",
     "typescript-eslint": "8.49.0"
   }

package/templates/multi-application/package.json

@@ -14,10 +14,10 @@
   },
   "devDependencies": {
     "@eslint/js": "9.39.1",
-    "@tailor-platform/sdk": "0.16.3",
+    "@tailor-platform/sdk": "0.17.0",
     "@types/node": "22.19.2",
     "eslint": "9.39.1",
-    "prettier": "3.7.3",
+    "prettier": "3.7.4",
     "typescript": "5.9.3",
     "typescript-eslint": "8.49.0"
   }

package/templates/testing/package.json

@@ -21,13 +21,13 @@
   "devDependencies": {
     "@eslint/js": "9.39.1",
     "@tailor-platform/function-types": "0.8.0",
-    "@tailor-platform/sdk": "0.16.3",
+    "@tailor-platform/sdk": "0.17.0",
     "@types/node": "22.19.2",
     "eslint": "9.39.1",
     "graphql-request": "7.3.5",
-    "prettier": "3.7.3",
+    "prettier": "3.7.4",
     "typescript": "5.9.3",
     "typescript-eslint": "8.49.0",
-    "vitest": "4.0.14"
+    "vitest": "4.0.15"
   }
 }