@tailor-platform/create-sdk 0.0.1 → 0.8.1

package/dist/index.js

@@ -0,0 +1,180 @@
+#!/usr/bin/env node
+import { chdir } from "node:process";
+import { cancel, intro, isCancel, log, outro, select, spinner, text } from "@clack/prompts";
+import { defineCommand, runMain } from "citty";
+import pc from "picocolors";
+import { readPackageJSON } from "pkg-types";
+import { existsSync } from "node:fs";
+import { cp, readdir } from "node:fs/promises";
+import { resolve } from "node:path";
+import { execa } from "execa";
+
+//#region src/context.ts
+const templatesDir = () => resolve(import.meta.dirname, "..", "templates");
+const availableTemplates = async () => {
+	return (await readdir(templatesDir(), { withFileTypes: true })).filter((entry) => entry.isDirectory()).map((entry) => entry.name);
+};
+const templateHints = {
+	"hello-world": "Initial project to get started with Tailor Platform SDK",
+	"inventory-management": "Simple inventory management system",
+	testing: "Testing guide for Tailor Platform SDK"
+};
+const validateName = (name) => {
+	if (name.length < 3 || name.length > 30) return "Project name must be between 3 and 30 characters long.";
+	if (!/^[a-z0-9-]+$/.test(name)) return "Project name can only contain lowercase letters, numbers, and hyphens.";
+	if (name.startsWith("-") || name.endsWith("-")) return "Project name cannot start or end with a hyphen.";
+	if (existsSync(resolve(name))) return `Directory "${name}" already exists. Please choose a different project name.`;
+};
+const validateTemplate = async (template) => {
+	const availables = await availableTemplates();
+	if (!availables.includes(template)) return `Template "${template}" is not available. Available templates are: ${availables.join(", ")}.`;
+};
+const collectContext = async ({ name, template }) => {
+	if (name) {
+		const err = validateName(name);
+		if (err) {
+			log.error(`Invalid project name: ${err}`);
+			process.exit(1);
+		}
+	}
+	if (template) {
+		const err = await validateTemplate(template);
+		if (err) {
+			log.error(`Invalid template: ${err}`);
+			process.exit(1);
+		}
+	}
+	if (!name) {
+		const ret = await text({
+			message: "📝 What's your project name?",
+			validate: validateName
+		});
+		if (isCancel(ret)) {
+			cancel("Operation cancelled");
+			process.exit(0);
+		}
+		name = ret;
+	} else log.info(`📦 Project: ${name}`);
+	if (!template) {
+		const options = (await availableTemplates()).map((value) => ({
+			value,
+			hint: templateHints[value]
+		}));
+		const ret = await select({
+			message: "🎨 Choose your template",
+			options
+		});
+		if (isCancel(ret)) {
+			cancel("Operation cancelled");
+			process.exit(0);
+		}
+		template = ret;
+	} else log.info(`🎯 Template: ${template}`);
+	return {
+		projectName: name,
+		projectDir: resolve(name),
+		templateName: template,
+		templateDir: resolve(templatesDir(), template)
+	};
+};
+
+//#endregion
+//#region src/copy.ts
+const copyProject = async (ctx) => {
+	const s = spinner();
+	s.start("📋 Copying template files...");
+	await cp(ctx.templateDir, ctx.projectDir, {
+		recursive: true,
+		force: true
+	});
+	s.stop("✅ Template copied");
+};
+
+//#endregion
+//#region src/init.ts
+const detectPackageManager = () => {
+	const availablePMs = [
+		"npm",
+		"yarn",
+		"pnpm"
+	];
+	const userAgent = process.env.npm_config_user_agent;
+	if (!userAgent) return;
+	const [name] = userAgent.split("/");
+	if (!availablePMs.includes(name)) return;
+	return name;
+};
+const isGitRepository = async () => {
+	try {
+		await execa("git", ["status"]);
+		return true;
+	} catch {
+		return false;
+	}
+};
+const initProject = async () => {
+	const packageManager = detectPackageManager();
+	if (packageManager) {
+		const s = spinner();
+		s.start(`📦 Installing dependencies with ${packageManager}...`);
+		await execa(packageManager, ["install"]);
+		s.stop("✅ Dependencies installed");
+	} else log.warn("⚠️ Could not detect package manager, skipping dependency installation");
+	if (!await isGitRepository()) {
+		const s = spinner();
+		s.start("🔧 Initializing git repository...");
+		await execa("git", ["init"]);
+		await execa("git", ["add", "."]);
+		await execa("git", [
+			"commit",
+			"-m",
+			"Initial commit (by create-sdk)"
+		]);
+		s.stop("✅ Git initialized");
+	} else log.warn("⚠️ Already inside a git repository, skipping git initialization");
+};
+
+//#endregion
+//#region src/index.ts
+const main = async () => {
+	const packageJson = await readPackageJSON(import.meta.url);
+	const cmd = defineCommand({
+		meta: {
+			name: packageJson.name,
+			version: packageJson.version,
+			description: packageJson.description
+		},
+		args: {
+			name: {
+				type: "positional",
+				description: "Project name",
+				required: false
+			},
+			template: {
+				type: "string",
+				description: "Template name",
+				required: false
+			}
+		},
+		async run({ args }) {
+			intro(pc.bold(pc.cyan("✨ Welcome to Tailor Platform SDK")));
+			const ctx = await collectContext({
+				name: args.name,
+				template: args.template
+			});
+			await copyProject(ctx);
+			chdir(ctx.projectDir);
+			await initProject();
+			outro(pc.green("🎉 Project created successfully!") + "\n\n" + pc.dim("Next steps:") + `
+  ${pc.cyan(`cd ${ctx.projectName}`)}
+  ${pc.dim("Check README.md and deploy your project")}
+
+` + pc.dim("Learn more: https://docs.tailor.tech"));
+		}
+	});
+	await runMain(cmd);
+};
+await main();
+
+//#endregion
+export {  };

package/package.json

@@ -1,10 +1,43 @@
 {
   "name": "@tailor-platform/create-sdk",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @tailor-platform/create-sdk",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+  "version": "0.8.1",
+  "description": "A CLI tool to quickly create a new Tailor Platform SDK project",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tailor-platform/sdk.git",
+    "directory": "packages/create-sdk"
+  },
+  "bin": "dist/index.js",
+  "files": [
+    "dist",
+    "templates",
+    "templates/*/.gitignore",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@clack/prompts": "0.11.0",
+    "citty": "0.1.6",
+    "execa": "9.6.0",
+    "picocolors": "1.1.1",
+    "pkg-types": "2.3.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "9.39.1",
+    "@types/node": "22.19.0",
+    "eslint": "9.39.1",
+    "tsdown": "0.15.6",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.46.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "eslint --cache .",
+    "lint:fix": "eslint --cache --fix .",
+    "typecheck": "tsc --noEmit",
+    "prepublish": "node scripts/set-sdk-version.js && pnpm run build"
+  }
+}

package/templates/hello-world/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+.tailor-sdk/
+.eslintcache

package/templates/hello-world/.prettierignore

@@ -0,0 +1 @@
+pnpm-lock.yaml

package/templates/hello-world/.prettierrc

@@ -0,0 +1 @@
+{}

package/templates/hello-world/README.md

@@ -0,0 +1,59 @@
+# Hello World
+
+This is a sample project for [Tailor Platform SDK](https://www.npmjs.com/package/@tailor-platform/sdk).
+
+This project was bootstrapped with [Create Tailor Platform SDK](https://www.npmjs.com/package/@tailor-platform/create-sdk).
+
+## Usage
+
+1. Create a new workspace:
+
+```bash
+npx tailor-sdk login
+npx tailor-sdk workspace create --name <workspace-name> --region <workspace-region>
+npx tailor-sdk workspace list
+# For yarn: yarn tailor-sdk <command>
+# For pnpm: pnpm tailor-sdk <command>
+
+# OR
+# Create a new workspace using Tailor Platform Console
+# https://console.tailor.tech/
+```
+
+2. Deploy the project:
+
+```bash
+npm run deploy -- --workspace-id <your-workspace-id>
+# For yarn: yarn run deploy --workspace-id <your-workspace-id>
+# For pnpm: pnpm run deploy --workspace-id <your-workspace-id>
+```
+
+3. Open [Tailor Platform Console](https://console.tailor.tech/) and open GraphQL Playground.
+
+4. Test GraphQL operations:
+
+```graphql
+query {
+  hello(input: { name: "sdk" }) {
+    message
+  }
+}
+# {
+#   "data": {
+#     "hello": {
+#       "message": "Hello, sdk!"
+#     }
+#   }
+# }
+```
+
+## Scripts
+
+In the project directory, you can run:
+
+- `deploy`: Deploy the project to Tailor Platform
+- `format`: Format the code using Prettier
+- `format:check`: Check code formatting using Prettier
+- `lint`: Lint the code using ESLint
+- `lint:fix`: Fix linting issues using ESLint
+- `typecheck`: Run TypeScript type checks

package/templates/hello-world/eslint.config.js

@@ -0,0 +1,27 @@
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+import { defineConfig, globalIgnores } from "eslint/config";
+
+export default defineConfig([
+  // Ignore sdk's output directory.
+  globalIgnores([".tailor-sdk/"]),
+  // Use recommended rules.
+  // https://typescript-eslint.io/users/configs#projects-with-type-checking
+  eslint.configs.recommended,
+  tseslint.configs.recommendedTypeChecked,
+  tseslint.configs.stylisticTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  // Disable type-checked linting for root config files.
+  // https://typescript-eslint.io/troubleshooting/typed-linting/#how-do-i-disable-type-checked-linting-for-a-file
+  {
+    files: ["eslint.config.js"],
+    extends: [tseslint.configs.disableTypeChecked],
+  },
+]);

package/templates/hello-world/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "hello-world",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "deploy": "tailor-sdk apply",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "lint": "eslint --cache .",
+    "lint:fix": "eslint --cache --fix .",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@eslint/js": "9.39.1",
+    "@tailor-platform/sdk": "0.8.1",
+    "@types/node": "22.19.0",
+    "eslint": "9.39.1",
+    "prettier": "3.6.2",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.46.3"
+  }
+}

package/templates/hello-world/src/resolvers/hello.ts

@@ -0,0 +1,19 @@
+import { createResolver, t } from "@tailor-platform/sdk";
+
+export default createResolver({
+  name: "hello",
+  operation: "query",
+  input: {
+    name: t.string().description("Name to greet"),
+  },
+  body: (context) => {
+    return {
+      message: `Hello, ${context.input.name}!`,
+    };
+  },
+  output: t
+    .object({
+      message: t.string().description("Greeting message"),
+    })
+    .description("Greeting response"),
+});

package/templates/hello-world/tailor.config.ts

@@ -0,0 +1,6 @@
+import { defineConfig } from "@tailor-platform/sdk";
+
+export default defineConfig({
+  name: "hello-world",
+  resolver: { "main-resolver": { files: [`./src/resolvers/**/*.ts`] } },
+});

package/templates/hello-world/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "allowJs": true,
+    "strict": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*", "tailor.config.ts"]
+}

package/templates/inventory-management/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+.tailor-sdk/
+.eslintcache

package/templates/inventory-management/.prettierignore

@@ -0,0 +1,2 @@
+src/generated/
+pnpm-lock.yaml

package/templates/inventory-management/.prettierrc

@@ -0,0 +1 @@
+{}

package/templates/inventory-management/README.md

@@ -0,0 +1,246 @@
+# Inventory Management
+
+This is a sample project for an inventory management system using [Tailor Platform SDK](https://www.npmjs.com/package/@tailor-platform/sdk).
+
+This project was bootstrapped with [Create Tailor Platform SDK](https://www.npmjs.com/package/@tailor-platform/create-sdk).
+
+## Usage
+
+1. Create a new workspace:
+
+```bash
+npx tailor-sdk login
+npx tailor-sdk workspace create --name <workspace-name> --region <workspace-region>
+npx tailor-sdk workspace list
+# For yarn: yarn tailor-sdk <command>
+# For pnpm: pnpm tailor-sdk <command>
+
+# OR
+# Create a new workspace using Tailor Platform Console
+# https://console.tailor.tech/
+```
+
+2. Deploy the project:
+
+```bash
+npm run deploy -- --workspace-id <your-workspace-id>
+# For yarn: yarn run deploy --workspace-id <your-workspace-id>
+# For pnpm: pnpm run deploy --workspace-id <your-workspace-id>
+```
+
+3. Open [Tailor Platform Console](https://console.tailor.tech/) and open GraphQL Playground.
+
+4. Test GraphQL operations with machine user's token:
+
+```bash
+# Get Manager's token
+npx tailor-sdk machineuser token inventory-management -m manager
+# Get Staff's token
+npx tailor-sdk machineuser token inventory-management -m staff
+```
+
+## Features
+
+- Management of master data (e.g., User, Product, Category)
+  - Only users with Manager role can operate
+- Order creation
+  - Inventory is updated simultaneously
+- Inventory monitoring
+  - Notifications are created when inventory falls below a certain threshold
+
+## Scripts
+
+In the project directory, you can run:
+
+- `deploy`: Deploy the project to Tailor Platform
+- `gen`: Generate TypeScript types
+- `format`: Format the code using Prettier
+- `format:check`: Check code formatting using Prettier
+- `lint`: Lint the code using ESLint
+- `lint:fix`: Fix linting issues using ESLint
+- `typecheck`: Run TypeScript type checks
+
+## Examples
+
+The following are example GraphQL operations to test the inventory management system.
+
+1. Create a category:
+
+```graphql
+mutation createCategory {
+  createCategory(input: { name: "Furniture" }) {
+    id
+    name
+  }
+}
+# {
+#   "data": {
+#     "createCategory": {
+#       "id": "f7c9a16a-d69c-4570-a6b9-571f97f728fd",
+#       "name": "Furniture"
+#     }
+#   }
+# }
+```
+
+2. Create a product:
+
+```graphql
+mutation createProduct {
+  createProduct(
+    input: {
+      name: "Ergonomic Office Chair"
+      categoryId: "f7c9a16a-d69c-4570-a6b9-571f97f728fd"
+    }
+  ) {
+    id
+    name
+  }
+}
+# {
+#   "data": {
+#     "createProduct": {
+#       "id": "54ed76c5-30e5-4b36-a82f-3c03d6436323",
+#       "name": "Ergonomic Office Chair"
+#     }
+#   }
+# }
+```
+
+3. Create contacts:
+
+```graphql
+mutation createContact {
+  a: createContact(input: { name: "John Doe", email: "john.doe@example.com" }) {
+    id
+    name
+  }
+  b: createContact(
+    input: { name: "Jane Smith", email: "jane.smith@example.com" }
+  ) {
+    id
+    name
+  }
+}
+# {
+#   "data": {
+#     "a": {
+#       "id": "82596a87-d0b0-47d6-8535-e70e4600c3c1",
+#       "name": "John Doe"
+#     },
+#     "b": {
+#       "id": "87cfb619-b6a5-4ad6-9b62-7de15b8bd5b9",
+#       "name": "Jane Smith"
+#     }
+#   }
+# }
+```
+
+4. Create orders:
+
+```graphql
+mutation registerOrder {
+  a: registerOrder(
+    input: {
+      order: {
+        name: "order-1"
+        orderType: "PURCHASE"
+        orderDate: "2025-09-01T00:00:00Z"
+        contactId: "82596a87-d0b0-47d6-8535-e70e4600c3c1"
+      }
+      items: [
+        {
+          productId: "54ed76c5-30e5-4b36-a82f-3c03d6436323"
+          unitPrice: 200
+          quantity: 20
+        }
+      ]
+    }
+  ) {
+    success
+  }
+  b: registerOrder(
+    input: {
+      order: {
+        name: "order-2"
+        orderType: "SALES"
+        orderDate: "2025-10-01T00:00:00Z"
+        contactId: "87cfb619-b6a5-4ad6-9b62-7de15b8bd5b9"
+      }
+      items: [
+        {
+          productId: "54ed76c5-30e5-4b36-a82f-3c03d6436323"
+          unitPrice: 300
+          quantity: 15
+        }
+      ]
+    }
+  ) {
+    success
+  }
+}
+# {
+#   "data": {
+#     "a": {
+#       "success": true
+#     },
+#     "b": {
+#       "success": true
+#     }
+#   }
+# }
+```
+
+5. Check inventory:
+
+```graphql
+query inventories {
+  inventories {
+    edges {
+      node {
+        product {
+          name
+        }
+        quantity
+      }
+    }
+  }
+  notifications {
+    edges {
+      node {
+        message
+      }
+    }
+  }
+}
+# {
+#   "data": {
+#     "inventories": {
+#       "edges": [
+#         {
+#           "node": {
+#             "product": {
+#               "name": "Ergonomic Office Chair"
+#             },
+#             "quantity": 5
+#           }
+#         }
+#       ]
+#     },
+#     "notifications": {
+#       "edges": [
+#         {
+#           "node": {
+#             "message": "Inventory for product 54ed76c5-30e5-4b36-a82f-3c03d6436323 is below threshold. Current quantity: 5"
+#           }
+#         }
+#       ]
+#     }
+#   }
+# }
+```
+
+Note:
+
+- Replace IDs in the examples with the actual IDs returned from your operations.
+- Ensure you use the appropriate token (Manager or Staff) for each operation.

package/templates/inventory-management/eslint.config.js

@@ -0,0 +1,33 @@
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+import { defineConfig, globalIgnores } from "eslint/config";
+
+export default defineConfig([
+  // Ignore sdk's output directory.
+  globalIgnores([".tailor-sdk/", "src/generated/"]),
+  // Use recommended rules.
+  // https://typescript-eslint.io/users/configs#projects-with-type-checking
+  eslint.configs.recommended,
+  tseslint.configs.recommendedTypeChecked,
+  tseslint.configs.stylisticTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    rules: {
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        { argsIgnorePattern: "^_", varsIgnorePattern: "^_" },
+      ],
+    },
+  },
+  // Disable type-checked linting for root config files.
+  // https://typescript-eslint.io/troubleshooting/typed-linting/#how-do-i-disable-type-checked-linting-for-a-file
+  {
+    files: ["eslint.config.js"],
+    extends: [tseslint.configs.disableTypeChecked],
+  },
+]);