@omnifyjp/omnify 3.13.1 → 3.14.0

package/ts-dist/ts-hooks-generator.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @omnify/ts — Frontend Hooks Generator (issue #58)
+ *
+ * Generates a `{Entity}Hooks.ts` per schema with `options.service` or
+ * `options.api`. Each file exports a `create{Entity}BaseHooks` factory
+ * that returns TanStack Query hooks (useQuery + useMutation) with toast
+ * notifications and cache invalidation.
+ */
+import type { SchemaDefinition, TypeScriptFile } from './types.js';
+export declare function generateTsHooks(schemas: Record<string, SchemaDefinition>): TypeScriptFile[];

package/ts-dist/ts-hooks-generator.js

@@ -0,0 +1,131 @@
+/**
+ * @omnify/ts — Frontend Hooks Generator (issue #58)
+ *
+ * Generates a `{Entity}Hooks.ts` per schema with `options.service` or
+ * `options.api`. Each file exports a `create{Entity}BaseHooks` factory
+ * that returns TanStack Query hooks (useQuery + useMutation) with toast
+ * notifications and cache invalidation.
+ */
+// ---------------------------------------------------------------------------
+// Public API
+// ---------------------------------------------------------------------------
+export function generateTsHooks(schemas) {
+    const files = [];
+    for (const [name, schema] of Object.entries(schemas)) {
+        if (schema.kind === 'enum')
+            continue;
+        if (schema.options?.hidden)
+            continue;
+        if (!schema.options?.api && !schema.options?.service)
+            continue;
+        files.push(generateHooksFile(name, schema));
+    }
+    return files;
+}
+// ---------------------------------------------------------------------------
+// Per-schema generator
+// ---------------------------------------------------------------------------
+function generateHooksFile(name, schema) {
+    const hasSoftDelete = schema.options?.softDelete ?? false;
+    const hasRestore = schema.options?.api?.restore ?? hasSoftDelete;
+    const restoreHook = hasRestore ? `
+    useRestore: (slug: string) => {
+      const qc = useQueryClient();
+      return useMutation({
+        mutationFn: (id: string) => service.restore(slug, id),
+        onSuccess: () => {
+          toast.success(\`\${entityLabel} restored.\`);
+          qc.invalidateQueries({ queryKey: keys.all(slug) });
+        },
+        onError: (e: Error) =>
+          toast.error(e.message || \`Failed to restore \${entityLabel}.\`),
+      });
+    },` : '';
+    const content = `/**
+ * DO NOT EDIT - Auto-generated by Omnify.
+ * @generated by omnify
+ */
+import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
+import { toast } from "sonner";
+import type { ${name}Filters, ${name}BaseServiceType } from "./${name}Service";
+import type { create${name}QueryKeys } from "./${name}QueryKeys";
+
+export function create${name}BaseHooks(
+  service: ${name}BaseServiceType,
+  keys: ReturnType<typeof create${name}QueryKeys>,
+  entityLabel: string,
+) {
+  return {
+    useList: (slug: string, filters: ${name}Filters = {}) =>
+      useQuery({
+        queryKey: keys.list(slug, filters),
+        queryFn: () => service.list(slug, filters),
+        enabled: !!slug,
+      }),
+
+    useDetail: (slug: string, id: string) =>
+      useQuery({
+        queryKey: keys.detail(slug, id),
+        queryFn: () => service.getById(slug, id),
+        enabled: !!slug && !!id,
+      }),
+
+    useLookup: (slug: string) =>
+      useQuery({
+        queryKey: keys.lookup(slug),
+        queryFn: () => service.lookup(slug),
+        enabled: !!slug,
+      }),
+
+    useCreate: (slug: string) => {
+      const qc = useQueryClient();
+      return useMutation({
+        mutationFn: (data: Parameters<typeof service.create>[1]) =>
+          service.create(slug, data),
+        onSuccess: () => {
+          toast.success(\`\${entityLabel} created.\`);
+          qc.invalidateQueries({ queryKey: keys.all(slug) });
+        },
+        onError: (e: Error) =>
+          toast.error(e.message || \`Failed to create \${entityLabel}.\`),
+      });
+    },
+
+    useUpdate: (slug: string) => {
+      const qc = useQueryClient();
+      return useMutation({
+        mutationFn: ({ id, data }: { id: string; data: Parameters<typeof service.update>[2] }) =>
+          service.update(slug, id, data),
+        onSuccess: () => {
+          toast.success(\`\${entityLabel} updated.\`);
+          qc.invalidateQueries({ queryKey: keys.all(slug) });
+        },
+        onError: (e: Error) =>
+          toast.error(e.message || \`Failed to update \${entityLabel}.\`),
+      });
+    },
+
+    useDelete: (slug: string) => {
+      const qc = useQueryClient();
+      return useMutation({
+        mutationFn: (id: string) => service.delete(slug, id),
+        onSuccess: () => {
+          toast.success(\`\${entityLabel} deleted.\`);
+          qc.invalidateQueries({ queryKey: keys.all(slug) });
+        },
+        onError: (e: Error) =>
+          toast.error(e.message || \`Failed to delete \${entityLabel}.\`),
+      });
+    },
+${restoreHook}
+  };
+}
+`;
+    return {
+        filePath: `base/${name}Hooks.ts`,
+        content,
+        types: [`create${name}BaseHooks`],
+        overwrite: true,
+        category: 'base',
+    };
+}

package/ts-dist/ts-query-keys-generator.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @omnify/ts — Frontend QueryKeys Generator (issue #58)
+ *
+ * Generates a `{Entity}QueryKeys.ts` per schema with `options.service` or
+ * `options.api`. Each file exports a `create{Entity}QueryKeys` factory for
+ * TanStack Query cache key management.
+ */
+import type { SchemaDefinition, TypeScriptFile } from './types.js';
+export declare function generateTsQueryKeys(schemas: Record<string, SchemaDefinition>): TypeScriptFile[];

package/ts-dist/ts-query-keys-generator.js

@@ -0,0 +1,52 @@
+/**
+ * @omnify/ts — Frontend QueryKeys Generator (issue #58)
+ *
+ * Generates a `{Entity}QueryKeys.ts` per schema with `options.service` or
+ * `options.api`. Each file exports a `create{Entity}QueryKeys` factory for
+ * TanStack Query cache key management.
+ */
+// ---------------------------------------------------------------------------
+// Public API
+// ---------------------------------------------------------------------------
+export function generateTsQueryKeys(schemas) {
+    const files = [];
+    for (const [name, schema] of Object.entries(schemas)) {
+        if (schema.kind === 'enum')
+            continue;
+        if (schema.options?.hidden)
+            continue;
+        if (!schema.options?.api && !schema.options?.service)
+            continue;
+        files.push(generateQueryKeysFile(name));
+    }
+    return files;
+}
+// ---------------------------------------------------------------------------
+// Per-schema generator
+// ---------------------------------------------------------------------------
+function generateQueryKeysFile(name) {
+    const lowerName = name.charAt(0).toLowerCase() + name.slice(1);
+    const content = `/**
+ * DO NOT EDIT - Auto-generated by Omnify.
+ * @generated by omnify
+ */
+export function create${name}QueryKeys(entity: string) {
+  return {
+    all: (slug: string) => [entity, slug] as const,
+    list: (slug: string, filters?: object) =>
+      [entity, slug, "list", filters] as const,
+    detail: (slug: string, id: string) =>
+      [entity, slug, "detail", id] as const,
+    lookup: (slug: string) =>
+      [entity, slug, "lookup"] as const,
+  };
+}
+`;
+    return {
+        filePath: `base/${name}QueryKeys.ts`,
+        content,
+        types: [`create${name}QueryKeys`],
+        overwrite: true,
+        category: 'base',
+    };
+}

package/ts-dist/ts-service-generator.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @omnify/ts — Frontend BaseService Generator (issue #58)
+ *
+ * Generates a `{Entity}Service.ts` per schema with `options.service` or
+ * `options.api`. Each file exports a factory function `create{Entity}BaseService`
+ * that returns typed CRUD methods. URL construction is injected by the caller
+ * so the generated code never hardcodes routes.
+ */
+import type { SchemaDefinition, TypeScriptFile, GeneratorOptions } from './types.js';
+export declare function generateTsServices(schemas: Record<string, SchemaDefinition>, options: GeneratorOptions): TypeScriptFile[];

package/ts-dist/ts-service-generator.js

@@ -0,0 +1,190 @@
+/**
+ * @omnify/ts — Frontend BaseService Generator (issue #58)
+ *
+ * Generates a `{Entity}Service.ts` per schema with `options.service` or
+ * `options.api`. Each file exports a factory function `create{Entity}BaseService`
+ * that returns typed CRUD methods. URL construction is injected by the caller
+ * so the generated code never hardcodes routes.
+ */
+import { toSnakeCase } from './interface-generator.js';
+// ---------------------------------------------------------------------------
+// Public API
+// ---------------------------------------------------------------------------
+export function generateTsServices(schemas, options) {
+    const files = [];
+    for (const [name, schema] of Object.entries(schemas)) {
+        if (schema.kind === 'enum')
+            continue;
+        if (schema.options?.hidden)
+            continue;
+        if (!schema.options?.api && !schema.options?.service)
+            continue;
+        files.push(generateServiceFile(name, schema, options));
+    }
+    return files;
+}
+// ---------------------------------------------------------------------------
+// Per-schema generator
+// ---------------------------------------------------------------------------
+function generateServiceFile(name, schema, options) {
+    const svc = schema.options?.service ?? {};
+    const api = schema.options?.api;
+    const hasSoftDelete = schema.options?.softDelete ?? false;
+    const hasRestore = api?.restore ?? hasSoftDelete;
+    const lowerName = name.charAt(0).toLowerCase() + name.slice(1);
+    // Resolve filterable/searchable fields
+    const properties = schema.properties ?? {};
+    const propertyOrder = schema.propertyOrder ?? Object.keys(properties);
+    const filterableFields = resolveFilterable(svc, properties, propertyOrder);
+    const lookupFields = svc.lookupFields ?? ['id', 'name'];
+    // Build filters interface
+    const filtersInterface = buildFiltersInterface(name, filterableFields, hasSoftDelete, properties);
+    // Build lookup item interface
+    const lookupInterface = buildLookupInterface(name, lookupFields, properties);
+    // Build toParams function
+    const toParamsBody = buildToParams(filterableFields, hasSoftDelete, properties);
+    // Build service factory
+    const serviceMethods = buildServiceMethods(name, hasRestore);
+    const content = `/**
+ * DO NOT EDIT - Auto-generated by Omnify.
+ * @generated by omnify
+ */
+import type { ${name}, ${name}CreateFormState, ${name}UpdateFormState } from "./${name}";
+
+${filtersInterface}
+
+${lookupInterface}
+
+${toParamsBody}
+
+// Factory — URL is injected by user-land, not hardcoded.
+export function create${name}BaseService(baseUrl: (slug: string, path?: string) => string) {
+  return {
+${serviceMethods}
+  };
+}
+
+export type ${name}BaseServiceType = ReturnType<typeof create${name}BaseService>;
+`;
+    return {
+        filePath: `base/${name}Service.ts`,
+        content,
+        types: [`${name}Filters`, `${name}LookupItem`, `create${name}BaseService`, `${name}BaseServiceType`],
+        overwrite: true,
+        category: 'base',
+    };
+}
+function resolveFilterable(svc, properties, propertyOrder) {
+    const fields = [];
+    const names = svc.filterable && svc.filterable.length > 0
+        ? svc.filterable
+        : propertyOrder.filter(p => properties[p]?.filterable);
+    for (const propName of names) {
+        const prop = properties[propName];
+        if (!prop)
+            continue;
+        const colName = toSnakeCase(propName);
+        const isBool = prop.type === 'Boolean';
+        const tsType = isBool ? 'boolean' : 'string';
+        fields.push({ name: propName, colName, tsType, isBool });
+    }
+    return fields;
+}
+function buildFiltersInterface(name, filterableFields, hasSoftDelete, properties) {
+    const lines = [];
+    lines.push(`export interface ${name}Filters {`);
+    lines.push(`  page?: number;`);
+    lines.push(`  per_page?: number;`);
+    lines.push(`  search?: string;`);
+    for (const f of filterableFields) {
+        lines.push(`  ${f.colName}?: ${f.tsType};`);
+    }
+    if (hasSoftDelete) {
+        lines.push(`  with_trashed?: boolean;`);
+        lines.push(`  only_trashed?: boolean;`);
+    }
+    lines.push(`  sort?: string;`);
+    lines.push(`}`);
+    return lines.join('\n');
+}
+function buildLookupInterface(name, lookupFields, properties) {
+    const lines = [];
+    lines.push(`export interface ${name}LookupItem {`);
+    for (const f of lookupFields) {
+        const col = toSnakeCase(f);
+        const prop = properties[f];
+        let tsType = 'string';
+        if (prop) {
+            if (prop.type === 'Int' || prop.type === 'BigInt' || prop.type === 'TinyInt' || prop.type === 'Float' || prop.type === 'Decimal') {
+                tsType = 'number';
+            }
+            else if (prop.type === 'Boolean') {
+                tsType = 'boolean';
+            }
+        }
+        lines.push(`  ${col}: ${tsType};`);
+    }
+    lines.push(`}`);
+    return lines.join('\n');
+}
+function buildToParams(filterableFields, hasSoftDelete, properties) {
+    const lines = [];
+    lines.push(`function toParams(filters: ${filterableFields.length > 0 ? 'Record<string, any>' : 'Record<string, any>'}): string {`);
+    lines.push(`  const p = new URLSearchParams();`);
+    lines.push(`  if (filters.page) p.set("page", String(filters.page));`);
+    lines.push(`  if (filters.per_page) p.set("per_page", String(filters.per_page));`);
+    lines.push(`  if (filters.search) p.set("search", filters.search);`);
+    for (const f of filterableFields) {
+        if (f.isBool) {
+            lines.push(`  if (filters.${f.colName} !== undefined) p.set("${f.colName}", filters.${f.colName} ? "1" : "0");`);
+        }
+        else {
+            lines.push(`  if (filters.${f.colName}) p.set("${f.colName}", filters.${f.colName});`);
+        }
+    }
+    if (hasSoftDelete) {
+        lines.push(`  if (filters.with_trashed) p.set("with_trashed", "1");`);
+        lines.push(`  if (filters.only_trashed) p.set("only_trashed", "1");`);
+    }
+    lines.push(`  if (filters.sort) p.set("sort", filters.sort);`);
+    lines.push(`  return p.toString();`);
+    lines.push(`}`);
+    return lines.join('\n');
+}
+function buildServiceMethods(name, hasRestore) {
+    const lines = [];
+    const indent = '    ';
+    lines.push(`${indent}list: (slug: string, filters: ${name}Filters = {}) =>`);
+    lines.push(`${indent}  apiFetch<PaginatedResponse<${name}>>(`);
+    lines.push(`${indent}    \`\${baseUrl(slug)}?\${toParams({ per_page: 25, ...filters })}\``);
+    lines.push(`${indent}  ),`);
+    lines.push('');
+    lines.push(`${indent}getById: (slug: string, id: string) =>`);
+    lines.push(`${indent}  apiFetch<{ data: ${name} }>(baseUrl(slug, \`/\${id}\`)),`);
+    lines.push('');
+    lines.push(`${indent}lookup: (slug: string) =>`);
+    lines.push(`${indent}  apiFetch<{ data: ${name}LookupItem[] }>(baseUrl(slug, "/lookup")),`);
+    lines.push('');
+    lines.push(`${indent}create: (slug: string, data: ${name}CreateFormState) =>`);
+    lines.push(`${indent}  apiFetch<{ data: ${name} }>(baseUrl(slug), {`);
+    lines.push(`${indent}    method: "POST",`);
+    lines.push(`${indent}    body: JSON.stringify(data),`);
+    lines.push(`${indent}  }),`);
+    lines.push('');
+    lines.push(`${indent}update: (slug: string, id: string, data: Partial<${name}UpdateFormState>) =>`);
+    lines.push(`${indent}  apiFetch<{ data: ${name} }>(baseUrl(slug, \`/\${id}\`), {`);
+    lines.push(`${indent}    method: "PUT",`);
+    lines.push(`${indent}    body: JSON.stringify(data),`);
+    lines.push(`${indent}  }),`);
+    lines.push('');
+    lines.push(`${indent}delete: (slug: string, id: string) =>`);
+    lines.push(`${indent}  apiFetch<null>(baseUrl(slug, \`/\${id}\`), { method: "DELETE" }),`);
+    if (hasRestore) {
+        lines.push('');
+        lines.push(`${indent}restore: (slug: string, id: string) =>`);
+        lines.push(`${indent}  apiFetch<{ data: ${name} }>(baseUrl(slug, \`/\${id}/restore\`), {`);
+        lines.push(`${indent}    method: "POST",`);
+        lines.push(`${indent}  }),`);
+    }
+    return lines.join('\n');
+}

package/ts-dist/types.d.ts

@@ -113,6 +113,15 @@ export interface ApiOptions {
     readonly middleware?: readonly string[];
     readonly perPage?: number;
 }
+/** Service layer codegen options — controls BaseService generation. Issue #57. */
+export interface ServiceOptions {
+    readonly searchable?: readonly string[];
+    readonly filterable?: readonly string[];
+    readonly defaultSort?: string;
+    readonly eagerLoad?: readonly string[];
+    readonly eagerCount?: readonly string[];
+    readonly lookupFields?: readonly string[];
+}
 /** Schema options. */
 export interface SchemaOptions {
     readonly id?: boolean | string;
@@ -129,6 +138,8 @@ export interface SchemaOptions {
         readonly updatedBy?: boolean;
         readonly deletedBy?: boolean;
     };
+    /** Service layer codegen options. Issue #57. */
+    readonly service?: ServiceOptions;
     /** Schema-level default ordering — generates a global Eloquent scope. Issue #40. */
     readonly defaultOrder?: readonly OrderByItem[];
 }
@@ -328,6 +339,7 @@ export interface SchemaDisplayNames {
     readonly displayName: LocaleMap;
     readonly propertyDisplayNames: Record<string, LocaleMap>;
     readonly propertyPlaceholders: Record<string, LocaleMap>;
+    readonly propertyDescriptions: Record<string, LocaleMap>;
 }
 /** Generation options (internal). */
 export interface GeneratorOptions {

package/ts-dist/zod-generator.js

@@ -26,6 +26,27 @@ function getMultiLocaleDisplayName(value, locales, fallbackLocale, defaultValue)
     }
     return result;
 }
+/**
+ * Auto-derive placeholder from label per locale (issue #59).
+ * - ja: "{label}を入力"
+ * - en: "Enter {label}"
+ * - vi: "Nhập {label}"
+ * Other locales: "Enter {label}" (fallback to English pattern)
+ */
+function autoDerivePlaceholder(label, locales) {
+    const PREFIXES = {
+        ja: { prefix: '', suffix: 'を入力' },
+        en: { prefix: 'Enter ', suffix: '' },
+        vi: { prefix: 'Nhập ', suffix: '' },
+    };
+    const result = {};
+    for (const locale of locales) {
+        const l = label[locale] ?? '';
+        const pattern = PREFIXES[locale] ?? PREFIXES['en'];
+        result[locale] = `${pattern.prefix}${l}${pattern.suffix}`;
+    }
+    return result;
+}
 /** Type categories for Zod rule applicability. */
 const ZOD_STRING_TYPES = new Set([
     'String', 'Email', 'Password', 'Text', 'MediumText', 'LongText',
@@ -340,6 +361,7 @@ export function generateDisplayNames(schema, options) {
     const displayName = getMultiLocaleDisplayName(schema.displayName, locales, fallbackLocale, schema.name);
     const propertyDisplayNames = {};
     const propertyPlaceholders = {};
+    const propertyDescriptions = {};
     if (schema.properties) {
         const propNames = schema.propertyOrder ?? Object.keys(schema.properties);
         for (const propName of propNames) {
@@ -378,14 +400,22 @@ export function generateDisplayNames(schema, options) {
                 continue;
             }
             // Regular field display name
-            propertyDisplayNames[fieldName] = getMultiLocaleDisplayName(propDef.displayName, locales, fallbackLocale, propName);
-            // Placeholder
+            const label = getMultiLocaleDisplayName(propDef.displayName, locales, fallbackLocale, propName);
+            propertyDisplayNames[fieldName] = label;
+            // Placeholder — explicit or auto-derived from label (issue #59)
             if (propDef.placeholder) {
                 propertyPlaceholders[fieldName] = getMultiLocaleDisplayName(propDef.placeholder, locales, fallbackLocale, '');
             }
+            else if (propDef.displayName) {
+                propertyPlaceholders[fieldName] = autoDerivePlaceholder(label, locales);
+            }
+            // Description (issue #59)
+            if (propDef.description) {
+                propertyDescriptions[fieldName] = getMultiLocaleDisplayName(propDef.description, locales, fallbackLocale, '');
+            }
         }
     }
-    return { displayName, propertyDisplayNames, propertyPlaceholders };
+    return { displayName, propertyDisplayNames, propertyPlaceholders, propertyDescriptions };
 }
 /**
  * Get fields to exclude from create/update schemas.