@tailor-platform/create-sdk 0.16.3 → 0.18.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @tailor-platform/create-sdk
 
+## 0.18.0
+
+## 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.18.0",
   "description": "A CLI tool to quickly create a new Tailor Platform SDK project",
   "license": "MIT",
   "type": "module",
@@ -25,9 +25,9 @@
     "pkg-types": "2.3.0"
   },
   "devDependencies": {
-    "@eslint/js": "9.39.1",
-    "@types/node": "22.19.2",
-    "eslint": "9.39.1",
+    "@eslint/js": "9.39.2",
+    "@types/node": "22.19.3",
+    "eslint": "9.39.2",
     "tsdown": "0.15.6",
     "typescript": "5.9.3",
     "typescript-eslint": "8.49.0"

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

@@ -11,11 +11,11 @@
     "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
-    "@eslint/js": "9.39.1",
-    "@tailor-platform/sdk": "0.16.3",
-    "@types/node": "22.19.2",
-    "eslint": "9.39.1",
-    "prettier": "3.7.3",
+    "@eslint/js": "9.39.2",
+    "@tailor-platform/sdk": "0.18.0",
+    "@types/node": "22.19.3",
+    "eslint": "9.39.2",
+    "prettier": "3.7.4",
     "typescript": "5.9.3",
     "typescript-eslint": "8.49.0"
   }

package/templates/hello-world/tsconfig.json

@@ -9,7 +9,8 @@
     "strict": true,
     "noEmit": true,
     "skipLibCheck": true,
-    "resolveJsonModule": true
+    "resolveJsonModule": true,
+    "types": ["node", "@tailor-platform/function-types"]
   },
   "include": ["**/*.ts"]
 }

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

@@ -16,12 +16,12 @@
     "kysely": "0.28.8"
   },
   "devDependencies": {
-    "@eslint/js": "9.39.1",
+    "@eslint/js": "9.39.2",
     "@tailor-platform/function-types": "0.8.0",
-    "@tailor-platform/sdk": "0.16.3",
-    "@types/node": "22.19.2",
-    "eslint": "9.39.1",
-    "prettier": "3.7.3",
+    "@tailor-platform/sdk": "0.18.0",
+    "@types/node": "22.19.3",
+    "eslint": "9.39.2",
+    "prettier": "3.7.4",
     "typescript": "5.9.3",
     "typescript-eslint": "8.49.0"
   }

package/templates/multi-application/package.json

@@ -13,11 +13,11 @@
     "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
-    "@eslint/js": "9.39.1",
-    "@tailor-platform/sdk": "0.16.3",
-    "@types/node": "22.19.2",
-    "eslint": "9.39.1",
-    "prettier": "3.7.3",
+    "@eslint/js": "9.39.2",
+    "@tailor-platform/sdk": "0.18.0",
+    "@types/node": "22.19.3",
+    "eslint": "9.39.2",
+    "prettier": "3.7.4",
     "typescript": "5.9.3",
     "typescript-eslint": "8.49.0"
   }

package/templates/multi-application/tsconfig.json

@@ -9,7 +9,8 @@
     "strict": true,
     "noEmit": true,
     "skipLibCheck": true,
-    "resolveJsonModule": true
+    "resolveJsonModule": true,
+    "types": ["node", "@tailor-platform/function-types"]
   },
   "include": ["**/*.ts"]
 }

package/templates/testing/e2e/globalSetup.ts

@@ -1,9 +1,9 @@
 import {
   apply,
-  machineUserToken,
+  getMachineUserToken,
   show,
-  workspaceCreate,
-  workspaceDelete,
+  createWorkspace,
+  deleteWorkspace,
   type WorkspaceInfo,
 } from "@tailor-platform/sdk/cli";
 import type { TestProject } from "vitest/node";
@@ -17,9 +17,9 @@ declare module "vitest" {
 
 let createdWorkspace: WorkspaceInfo | null = null;
 
-async function createWorkspace(name: string, region: string) {
+async function setupWorkspace(name: string, region: string) {
   console.log(`Creating workspace "${name}" in region "${region}"...`);
-  const workspace = await workspaceCreate({ name, region });
+  const workspace = await createWorkspace({ name, region });
   console.log(`Workspace "${workspace.name}" created successfully.`);
   return workspace;
 }
@@ -30,9 +30,9 @@ async function deployApplication() {
   console.log("Application deployed successfully.");
 }
 
-async function deleteWorkspace(workspaceId: string) {
+async function cleanupWorkspace(workspaceId: string) {
   console.log("Deleting workspace...");
-  await workspaceDelete({ workspaceId });
+  await deleteWorkspace({ workspaceId });
   console.log("Workspace deleted successfully.");
 }
 
@@ -46,20 +46,20 @@ export async function setup(project: TestProject) {
         "TAILOR_PLATFORM_WORKSPACE_NAME and TAILOR_PLATFORM_WORKSPACE_REGION must be set when CI=true",
       );
     }
-    createdWorkspace = await createWorkspace(workspaceName, workspaceRegion);
+    createdWorkspace = await setupWorkspace(workspaceName, workspaceRegion);
     process.env.TAILOR_PLATFORM_WORKSPACE_ID = createdWorkspace.id;
     await deployApplication();
   }
 
   const app = await show();
-  const tokens = await machineUserToken({ name: "admin" });
+  const tokens = await getMachineUserToken({ name: "admin" });
   project.provide("url", app.url);
   project.provide("token", tokens.accessToken);
 }
 
 export async function teardown() {
   if (createdWorkspace) {
-    await deleteWorkspace(createdWorkspace.id);
+    await cleanupWorkspace(createdWorkspace.id);
     createdWorkspace = null;
   }
 }

package/templates/testing/e2e/workflow.test.ts

@@ -1,13 +1,13 @@
 import { randomUUID } from "node:crypto";
 import { describe, expect, test } from "vitest";
-import { workflowStart } from "@tailor-platform/sdk/cli";
+import { startWorkflow } from "@tailor-platform/sdk/cli";
 
 describe.concurrent("workflow", () => {
   test(
     "simple-calculation: execute workflow and verify success",
     { timeout: 120000 },
     async () => {
-      const { executionId, wait } = await workflowStart({
+      const { executionId, wait } = await startWorkflow({
         nameOrId: "simple-calculation",
         machineUser: "admin",
         arg: { a: 2, b: 3 },
@@ -30,7 +30,7 @@ describe.concurrent("workflow", () => {
       const uuid = randomUUID();
       const testEmail = `workflow-test-${uuid}@example.com`;
 
-      const { executionId, wait } = await workflowStart({
+      const { executionId, wait } = await startWorkflow({
         nameOrId: "user-profile-sync",
         machineUser: "admin",
         arg: {

package/templates/testing/package.json

@@ -19,15 +19,15 @@
     "kysely": "0.28.8"
   },
   "devDependencies": {
-    "@eslint/js": "9.39.1",
+    "@eslint/js": "9.39.2",
     "@tailor-platform/function-types": "0.8.0",
-    "@tailor-platform/sdk": "0.16.3",
-    "@types/node": "22.19.2",
-    "eslint": "9.39.1",
-    "graphql-request": "7.3.5",
-    "prettier": "3.7.3",
+    "@tailor-platform/sdk": "0.18.0",
+    "@types/node": "22.19.3",
+    "eslint": "9.39.2",
+    "graphql-request": "7.4.0",
+    "prettier": "3.7.4",
     "typescript": "5.9.3",
     "typescript-eslint": "8.49.0",
-    "vitest": "4.0.14"
+    "vitest": "4.0.15"
   }
 }