@famgia/omnify-typescript 0.0.47 → 0.0.49

package/ai-guides/typescript-guide.md

@@ -2,9 +2,23 @@
 
 This guide covers TypeScript-specific features and generated code patterns for Omnify.
 
+## Quick Start
+
+```bash
+# Create new project (recommended)
+npx @famgia/omnify create-laravel-project my-app
+cd my-app
+
+# Or initialize in existing project
+npx @famgia/omnify init
+
+# Generate TypeScript types
+npx @famgia/omnify generate
+```
+
 ## Generated Files
 
-When you run `npx omnify generate`, the following TypeScript files are generated:
+When you run `npx @famgia/omnify generate`, the following TypeScript files are generated:
 
 - `base/*.ts` - Base model interfaces
 - `enum/*.ts` - Enum types with multi-locale labels
@@ -62,10 +76,25 @@ export interface User {
 | `Boolean` | `boolean` |
 | `Date` | `Date` |
 | `DateTime` | `Date` |
+| `Timestamp` | `Date` |
 | `Json` | `Record<string, unknown>` |
 | `EnumRef` | Generated enum type |
 | `Association` | Related model type / array |
 
+## Hidden Schemas
+
+Schemas with `options.hidden: true` are skipped for TypeScript generation:
+
+```yaml
+name: AppCache
+options:
+  hidden: true    # No TypeScript interface generated
+```
+
+Use cases:
+- System tables (cache, sessions, jobs)
+- Tables that don't need frontend types
+
 ## Enum Generation (Multi-locale)
 
 ```yaml
@@ -229,11 +258,20 @@ function handleStatus(value: unknown) {
 ## Commands
 
 ```bash
+# Create new project
+npx @famgia/omnify create-laravel-project my-app
+
 # Generate TypeScript types
-npx omnify generate
+npx @famgia/omnify generate
 
 # Force regenerate all files
-npx omnify generate --force
+npx @famgia/omnify generate --force
+
+# Only generate TypeScript types
+npx @famgia/omnify generate --types-only
+
+# Validate schemas
+npx @famgia/omnify validate
 ```
 
 ## Configuration
@@ -241,18 +279,32 @@ npx omnify generate --force
 ```typescript
 // omnify.config.ts
 import { defineConfig } from '@famgia/omnify';
+import typescript from '@famgia/omnify-typescript/plugin';
 
 export default defineConfig({
   schemasDir: './schemas',
-  output: {
-    typescript: {
-      path: './src/types/model',
-      generateRules: true,  // Generate Ant Design validation rules
-    },
-  },
+  lockFilePath: './.omnify.lock',
+
+  plugins: [
+    typescript({
+      // Output path for TypeScript files
+      path: './resources/ts/types/models',
+
+      // Generate Ant Design validation rules
+      generateRules: true,
+    }),
+  ],
+
   locale: {
     locales: ['ja', 'en'],
     defaultLocale: 'ja',
   },
 });
 ```
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `path` | `string` | `./src/types/model` | TypeScript output directory |
+| `generateRules` | `boolean` | `true` | Generate Ant Design validation rules |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@famgia/omnify-typescript",
-  "version": "0.0.47",
+  "version": "0.0.49",
   "description": "TypeScript type definitions generator for Omnify schemas",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -48,7 +48,7 @@
     "directory": "packages/typescript-generator"
   },
   "dependencies": {
-    "@famgia/omnify-types": "0.0.57"
+    "@famgia/omnify-types": "0.0.59"
   },
   "devDependencies": {
     "tsup": "^8.5.1",