@eide/uniformgen 0.1.0

package/dist/generators/cms/route.js

@@ -0,0 +1,409 @@
+/**
+ * CMS Route Resolution Generator
+ *
+ * Generates the resolveRoute hook/function for CMS frontends.
+ * Only generated when there are models with cms.enabled = true.
+ *
+ * @generated by UniformGen
+ */
+/**
+ * Check if a model has CMS enabled (cms.enabled in extensions)
+ * Note: The `pages` property on EntityModel is extracted from extensions.cms
+ */
+export function hasRoutingEnabled(model) {
+    return model.pages?.enabled === true;
+}
+/**
+ * Get all routable models (models with cms.enabled = true)
+ */
+export function getRoutableModels(models) {
+    return models.filter(hasRoutingEnabled);
+}
+/**
+ * Generate React resolveRoute hook
+ */
+export function generateResolveRouteReact(routableModels) {
+    const modelKeys = routableModels.map(m => m.key);
+    return `/**
+ * CMS Route Resolution Hook
+ *
+ * Resolves any routable entity by URL path with template, zones, and layouts.
+ * Use with @eide/foir-renderer's EntityRenderer component.
+ *
+ * Handles models: ${modelKeys.join(', ')}
+ *
+ * @generated by UniformGen - DO NOT EDIT MANUALLY
+ */
+
+import { useQuery, type QueryHookOptions } from '@apollo/client';
+import { gql } from '@apollo/client';
+import type {
+  ResolvedRoute,
+  VariantContext,
+  ReferenceResolutionOptions,
+} from './types.js';
+
+// Re-export types for convenience
+export type {
+  ResolvedRoute,
+  ResolvedRecord,
+  ResolvedVariant,
+  ResolvedContent,
+  ResolvedField,
+  ResolvedTemplateRef,
+  ResolutionContext,
+  FieldLayout,
+  LayoutPosition,
+  FieldSource,
+  GridConfig,
+  Breadcrumb,
+  BreadcrumbType,
+  VariantContext,
+  ReferenceResolutionOptions,
+} from './types.js';
+
+/**
+ * GraphQL query for route resolution
+ *
+ * Fetches full template/zone data for CMS rendering
+ */
+const RESOLVE_ROUTE_QUERY = gql\`
+  query ResolveRoute(
+    $path: String!
+    $locale: String
+    $contexts: JSON
+    $referenceOptions: ReferenceResolutionOptionsInput
+  ) {
+    resolveRoute(
+      path: $path
+      locale: $locale
+      contexts: $contexts
+      referenceOptions: $referenceOptions
+    ) {
+      record {
+        id
+        modelKey
+        naturalKey
+        metadata
+      }
+      variant {
+        id
+        variantKey
+      }
+      content {
+        template {
+          id
+          modelKey
+          naturalKey
+          content
+        }
+        layoutMode
+        fields {
+          key
+          type
+          label
+          required
+          value
+          layout {
+            lg { x y w h minW maxW minH maxH }
+            md { x y w h minW maxW minH maxH }
+            sm { x y w h minW maxW minH maxH }
+            xs { x y w h minW maxW minH maxH }
+          }
+          order
+          source
+        }
+        extraContent {
+          key
+          type
+          label
+          required
+          value
+          layout {
+            lg { x y w h minW maxW minH maxH }
+            md { x y w h minW maxW minH maxH }
+            sm { x y w h minW maxW minH maxH }
+            xs { x y w h minW maxW minH maxH }
+          }
+          order
+          source
+        }
+      }
+      breadcrumbs {
+        label
+        url
+        type
+        isCurrent
+      }
+      gridConfig {
+        breakpoints
+        cols
+        rowHeight
+        containerPadding
+        margin
+      }
+      resolvedWith {
+        locale
+        contexts
+      }
+    }
+  }
+\`;
+
+/**
+ * Resolve entity content by URL path with full CMS features
+ *
+ * Returns template, zones, layouts, and breadcrumbs for rendering
+ * with @eide/foir-renderer's EntityRenderer component.
+ *
+ * @param path - URL path (e.g., '/uk/products/winter-jacket')
+ * @param context - Variant context (locale, market, device, etc.)
+ * @param options - Additional options (reference resolution, query options)
+ *
+ * @example
+ * const { data, loading } = useResolveRoute('/de/automated-collection', {
+ *   locale: 'de-DE',
+ *   contexts: { market: 'eu', device: 'mobile' },
+ * });
+ *
+ * // Use with EntityRenderer
+ * if (data) {
+ *   return <EntityRenderer data={data} registry={registry} />;
+ * }
+ */
+export function useResolveRoute(
+  path: string,
+  context?: VariantContext,
+  options?: {
+    referenceOptions?: ReferenceResolutionOptions;
+    queryOptions?: Omit<QueryHookOptions, 'variables'>;
+  }
+) {
+  const { queryOptions, referenceOptions } = options ?? {};
+
+  const result = useQuery(RESOLVE_ROUTE_QUERY, {
+    ...queryOptions,
+    variables: {
+      path,
+      locale: context?.locale,
+      contexts: context?.contexts,
+      referenceOptions,
+    },
+    skip: !path,
+  });
+
+  return {
+    ...result,
+    data: result.data?.resolveRoute as ResolvedRoute | undefined,
+  };
+}
+
+/**
+ * List of model keys that support route resolution
+ */
+export const ROUTABLE_MODELS = [${modelKeys.map(k => `'${k}'`).join(', ')}] as const;
+
+/**
+ * Type for routable model keys
+ */
+export type RoutableModelKey = typeof ROUTABLE_MODELS[number];
+`;
+}
+/**
+ * Generate Remix/Hydrogen resolveRoute function
+ */
+export function generateResolveRouteRemix(routableModels) {
+    const modelKeys = routableModels.map(m => m.key);
+    return `/**
+ * CMS Route Resolution Function
+ *
+ * Server-side function for resolving any routable entity by URL path.
+ * Use in Remix loaders or Hydrogen server functions.
+ *
+ * Handles models: ${modelKeys.join(', ')}
+ *
+ * @generated by UniformGen - DO NOT EDIT MANUALLY
+ */
+
+import type {
+  ResolvedRoute,
+  VariantContext,
+  ReferenceResolutionOptions,
+} from './types.js';
+
+// Re-export types for convenience
+export type {
+  ResolvedRoute,
+  ResolvedRecord,
+  ResolvedVariant,
+  ResolvedContent,
+  ResolvedField,
+  ResolvedTemplateRef,
+  ResolutionContext,
+  FieldLayout,
+  LayoutPosition,
+  FieldSource,
+  GridConfig,
+  Breadcrumb,
+  BreadcrumbType,
+  VariantContext,
+  ReferenceResolutionOptions,
+} from './types.js';
+
+/** GraphQL client interface */
+export interface GraphQLClient {
+  request<T>(query: string, variables?: Record<string, unknown>): Promise<T>;
+}
+
+/**
+ * GraphQL query for route resolution
+ */
+const RESOLVE_ROUTE_QUERY = \`
+  query ResolveRoute(
+    $path: String!
+    $locale: String
+    $contexts: JSON
+    $referenceOptions: ReferenceResolutionOptionsInput
+  ) {
+    resolveRoute(
+      path: $path
+      locale: $locale
+      contexts: $contexts
+      referenceOptions: $referenceOptions
+    ) {
+      record {
+        id
+        modelKey
+        naturalKey
+        metadata
+      }
+      variant {
+        id
+        variantKey
+      }
+      content {
+        template {
+          id
+          modelKey
+          naturalKey
+          content
+        }
+        layoutMode
+        fields {
+          key
+          type
+          label
+          required
+          value
+          layout {
+            lg { x y w h minW maxW minH maxH }
+            md { x y w h minW maxW minH maxH }
+            sm { x y w h minW maxW minH maxH }
+            xs { x y w h minW maxW minH maxH }
+          }
+          order
+          source
+        }
+        extraContent {
+          key
+          type
+          label
+          required
+          value
+          layout {
+            lg { x y w h minW maxW minH maxH }
+            md { x y w h minW maxW minH maxH }
+            sm { x y w h minW maxW minH maxH }
+            xs { x y w h minW maxW minH maxH }
+          }
+          order
+          source
+        }
+      }
+      breadcrumbs {
+        label
+        url
+        type
+        isCurrent
+      }
+      gridConfig {
+        breakpoints
+        cols
+        rowHeight
+        containerPadding
+        margin
+      }
+      resolvedWith {
+        locale
+        contexts
+      }
+    }
+  }
+\`;
+
+/**
+ * Resolve entity content by URL path with full CMS features
+ *
+ * Use in Remix loaders or Hydrogen server functions.
+ * Returns template, zones, layouts, and breadcrumbs for rendering.
+ *
+ * @param client - GraphQL client for making requests
+ * @param path - URL path (e.g., '/uk/products/winter-jacket')
+ * @param context - Variant context (locale, market, device, etc.)
+ * @param options - Additional options (reference resolution)
+ *
+ * @example
+ * // In a Remix loader
+ * export async function loader({ request, context }: LoaderFunctionArgs) {
+ *   const url = new URL(request.url);
+ *   const route = await resolveRoute(context.graphql, url.pathname, {
+ *     locale: 'de-DE',
+ *     contexts: { market: 'eu' },
+ *   });
+ *
+ *   if (!route) {
+ *     throw new Response('Not Found', { status: 404 });
+ *   }
+ *
+ *   return json({ route });
+ * }
+ *
+ * // In Hydrogen
+ * export async function loader({ context }: LoaderFunctionArgs) {
+ *   const route = await resolveRoute(context.storefront.graphql, '/products/jacket', {
+ *     locale: context.storefront.i18n.language,
+ *   });
+ *   return json({ route });
+ * }
+ */
+export async function resolveRoute(
+  client: GraphQLClient,
+  path: string,
+  context?: VariantContext,
+  options?: {
+    referenceOptions?: ReferenceResolutionOptions;
+  }
+): Promise<ResolvedRoute | null> {
+  const result = await client.request<{ resolveRoute: ResolvedRoute | null }>(
+    RESOLVE_ROUTE_QUERY,
+    {
+      path,
+      locale: context?.locale,
+      contexts: context?.contexts,
+      referenceOptions: options?.referenceOptions,
+    }
+  );
+  return result.resolveRoute;
+}
+
+/**
+ * List of model keys that support route resolution
+ */
+export const ROUTABLE_MODELS = [${modelKeys.map(k => `'${k}'`).join(', ')}] as const;
+
+/**
+ * Type for routable model keys
+ */
+export type RoutableModelKey = typeof ROUTABLE_MODELS[number];
+`;
+}

package/dist/generators/cms/types.d.ts

@@ -0,0 +1,15 @@
+/**
+ * CMS Types Generator
+ *
+ * Generates TypeScript types for CMS route resolution layer:
+ * - ResolvedRoute type with template/zone/layout data
+ * - ResolvedField and zone types
+ * - Grid configuration types
+ *
+ * @generated by UniformGen
+ */
+/**
+ * Generate CMS types file
+ */
+export declare function generateCmsTypes(): string;
+//# sourceMappingURL=types.d.ts.map

package/dist/generators/cms/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/generators/cms/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,CA2HzC"}

package/dist/generators/cms/types.js

@@ -0,0 +1,137 @@
+/**
+ * CMS Types Generator
+ *
+ * Generates TypeScript types for CMS route resolution layer:
+ * - ResolvedRoute type with template/zone/layout data
+ * - ResolvedField and zone types
+ * - Grid configuration types
+ *
+ * @generated by UniformGen
+ */
+/**
+ * Generate CMS types file
+ */
+export function generateCmsTypes() {
+    return `/**
+ * CMS Resolution Types
+ *
+ * Types for CMS-level route resolution with templates, zones, and layouts.
+ *
+ * @generated by UniformGen - DO NOT EDIT MANUALLY
+ */
+
+// Re-export common resolution types
+export type {
+  VariantContext,
+  ReferenceResolutionOptions,
+  Breadcrumb,
+  BreadcrumbType,
+} from '../types/field-types.js';
+
+/** Resolved record info */
+export interface ResolvedRecord {
+  id: string;
+  modelKey: string;
+  naturalKey: string | null;
+  metadata?: Record<string, unknown>;
+}
+
+/** Resolved variant info */
+export interface ResolvedVariant {
+  id: string;
+  variantKey: string;
+}
+
+/** Resolution context (what was used to resolve) */
+export interface ResolutionContext {
+  locale: string;
+  contexts: Record<string, string>;
+}
+
+/** Layout position for a breakpoint */
+export interface LayoutPosition {
+  x: number;
+  y: number;
+  w: number;
+  h: number;
+  minW?: number;
+  maxW?: number;
+  minH?: number;
+  maxH?: number;
+}
+
+/** Responsive layout for a field */
+export interface FieldLayout {
+  lg?: LayoutPosition;
+  md?: LayoutPosition;
+  sm?: LayoutPosition;
+  xs?: LayoutPosition;
+}
+
+/** Source of a resolved field value */
+export type FieldSource = 'schema' | 'template' | 'zone' | 'override';
+
+/** Resolved field with value and layout */
+export interface ResolvedField {
+  key: string;
+  type: string;
+  label?: string;
+  required?: boolean;
+  value: unknown;
+  layout?: FieldLayout;
+  order?: number;
+  source?: FieldSource;
+}
+
+/** Template reference */
+export interface ResolvedTemplateRef {
+  id: string;
+  modelKey: string;
+  naturalKey: string;
+  content?: unknown;
+}
+
+/** Resolved content with template and zones */
+export interface ResolvedContent {
+  template: ResolvedTemplateRef | null;
+  layoutMode: 'grid' | 'list';
+  fields: ResolvedField[];
+  extraContent?: ResolvedField[];
+}
+
+/** Grid configuration for layout rendering */
+export interface GridConfig {
+  breakpoints: Record<string, number>;
+  cols: Record<string, number>;
+  rowHeight: number;
+  containerPadding: [number, number];
+  margin: [number, number];
+}
+
+/** Breadcrumb item */
+export interface Breadcrumb {
+  label: string;
+  url: string;
+  type: BreadcrumbType;
+  isCurrent: boolean;
+}
+
+/** Breadcrumb type */
+export type BreadcrumbType = 'root' | 'category' | 'collection' | 'product' | 'page' | 'current';
+
+/**
+ * Resolved route response
+ *
+ * The primary response type for CMS route resolution.
+ * Use with @eide/foir-renderer's EntityRenderer component.
+ */
+export interface ResolvedRoute {
+  record: ResolvedRecord;
+  variant: ResolvedVariant;
+  content: ResolvedContent;
+  breadcrumbs: Breadcrumb[];
+  gridConfig: GridConfig;
+  resolvedWith: ResolutionContext;
+}
+`;
+}

package/dist/generators/contexts/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Context Types Generator
+ *
+ * Generates typed context helpers for variant resolution.
+ * Contexts define the available dimensions for personalizing content.
+ *
+ * Unlike other generators, contexts are queried at RUNTIME since their
+ * values can change dynamically in the database.
+ */
+import type { ContextDefinition } from '../../fetcher/fetch-schemas.js';
+/**
+ * Context definition used at generate time (values not included - fetched at runtime)
+ */
+export interface ContextForGeneration {
+    definition: ContextDefinition;
+}
+/**
+ * Generate the typed contexts file with runtime query support
+ */
+export declare function generateContextsFile(contexts: ContextForGeneration[]): string;
+/**
+ * Generate empty contexts file when no contexts are defined
+ */
+export declare function generateEmptyContextsFile(): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/generators/contexts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generators/contexts/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,iBAAiB,CAAC;CAC/B;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,oBAAoB,EAAE,GAAG,MAAM,CAgV7E;AAED;;GAEG;AACH,wBAAgB,yBAAyB,IAAI,MAAM,CAoQlD"}