@api-client/core 0.18.20 → 0.18.22

package/src/modeling/templates/types.ts

@@ -7,3 +7,169 @@ export interface CreateTemplateOptions {
    */
   domain?: DataDomain
 }
+
+/**
+ * Template metadata for UI presentation
+ */
+export interface DomainTemplate {
+  /** Unique identifier for the template */
+  id: string
+  /** Display name of the template */
+  name: string
+  /** Short description of what the template does (plain text, no HTML/markdown) */
+  description: string
+  /** When the template was created (ISO string) */
+  createdAt: string
+  /** When the template was last updated (ISO string) */
+  updatedAt: string
+  /** Template version */
+  version: string
+  /** Author information */
+  author: string
+  /** Template categorization tags */
+  tags: string[]
+  /** Detailed domain structure for UI presentation */
+  structure: DomainTemplateStructure
+}
+
+/**
+ * Detailed domain structure information for UI presentation
+ */
+export interface DomainTemplateStructure {
+  /** Domain information */
+  domain: DomainInfo
+  /** List of namespaces in the domain */
+  namespaces: NamespaceInfo[]
+}
+
+/**
+ * Domain-level information
+ */
+export interface DomainInfo {
+  /** Domain name */
+  name: string
+  /** Domain description */
+  description?: string
+  /** Total number of entities across all namespaces */
+  totalEntities: number
+  /** Total number of properties across all entities */
+  totalProperties: number
+  /** Total number of associations across all entities */
+  totalAssociations: number
+}
+
+/**
+ * Namespace-level information
+ */
+export interface NamespaceInfo {
+  /** Namespace name */
+  name: string
+  /** Namespace display name */
+  displayName?: string
+  /** Namespace description */
+  description?: string
+  /** Number of models in this namespace */
+  modelCount: number
+  /** Number of entities in this namespace */
+  entityCount: number
+  /** List of models in this namespace */
+  models: ModelInfo[]
+}
+
+/**
+ * Model-level information
+ */
+export interface ModelInfo {
+  /** Model name */
+  name: string
+  /** Model display name */
+  displayName?: string
+  /** Model description */
+  description?: string
+  /** Number of entities in this model */
+  entityCount: number
+  /** List of entities in this model */
+  entities: EntityInfo[]
+}
+
+/**
+ * Entity-level information for UI presentation
+ */
+export interface EntityInfo {
+  /** Entity name */
+  name: string
+  /** Entity display name */
+  displayName?: string
+  /** Entity description */
+  description?: string
+  /** Number of properties */
+  propertyCount: number
+  /** Number of associations */
+  associationCount: number
+  /** Whether this entity is deprecated */
+  deprecated?: boolean
+  /** List of properties for this entity */
+  properties: PropertyInfo[]
+  /** List of associations for this entity */
+  associations: AssociationInfo[]
+  /** Applied semantic types */
+  semantics: string[]
+}
+
+/**
+ * Property-level information for UI presentation
+ */
+export interface PropertyInfo {
+  /** Property name */
+  name: string
+  /** Property display name */
+  displayName?: string
+  /** Property description */
+  description?: string
+  /** Data type (string, number, boolean, etc.) */
+  type: string
+  /** Whether this property is required */
+  required?: boolean
+  /** Whether this property allows multiple values */
+  multiple?: boolean
+  /** Whether this property is a primary key */
+  primary?: boolean
+  /** Whether this property is unique */
+  unique?: boolean
+  /** Whether this property is read-only */
+  readOnly?: boolean
+  /** Whether this property is write-only */
+  writeOnly?: boolean
+  /** Whether this property is deprecated */
+  deprecated?: boolean
+  /** Applied semantic types */
+  semantics: string[]
+  /** Enum values if applicable */
+  enumValues?: string[]
+  /** Default value if specified */
+  defaultValue?: string
+}
+
+/**
+ * Association-level information for UI presentation
+ */
+export interface AssociationInfo {
+  /** Association name */
+  name: string
+  /** Association display name */
+  displayName?: string
+  /** Association description */
+  description?: string
+  /** Whether this association is required */
+  required?: boolean
+  /** Whether this association allows multiple targets */
+  multiple?: boolean
+  /** Whether this association is read-only */
+  readOnly?: boolean
+  /** Target entity names this association points to */
+  targetEntities: string[]
+  /** Applied semantic types */
+  semantics: string[]
+  /** Relationship cardinality description (e.g., "One-to-Many", "Many-to-Many") */
+  cardinality: string
+}

package/src/modeling/templates/verticals/README.md

@@ -0,0 +1,122 @@
+# Industry Vertical Templates
+
+This directory organizes domain templates by industry verticals to provide better categorization and discovery for users looking for domain-specific templates.
+
+## Structure
+
+```plain
+verticals/
+├── business-services/           # E-commerce, Financial Services, Legal Services
+│   ├── ecommerce-domain.ts
+│   ├── financial-services-domain.ts
+│   └── index.ts
+├── healthcare-life-sciences/    # Healthcare, Pharmaceutical, Research
+│   ├── healthcare-domain.ts
+│   └── index.ts
+├── education-training/          # Education, Corporate Training, Certification
+│   ├── education-domain.ts
+│   └── index.ts
+├── real-estate-construction/    # Real Estate, Construction, Property Management
+│   ├── real-estate-domain.ts
+│   └── index.ts
+├── technology-media/            # Gaming, IoT, Content Management, Social Media
+│   ├── blog-domain.ts
+│   └── index.ts
+├── manufacturing-logistics/     # Manufacturing, Supply Chain, Distribution
+│   └── index.ts
+├── public-sector/              # Government, Non-Profit, Healthcare
+│   └── index.ts
+└── index.ts                    # Main verticals index
+```
+
+## Industry Verticals
+
+### 1. Business Services
+
+- **E-commerce Platform**: Complete e-commerce data domain with product management, orders, customers, and payments
+- **Financial Services Platform**: Comprehensive financial services data domain with accounts, transactions, investments, and compliance
+
+### 2. Healthcare & Life Sciences
+
+- **Healthcare Management Platform**: Comprehensive healthcare data domain with patients, providers, facilities, and medical records
+
+### 3. Education & Training
+
+- **Education Management Platform**: Comprehensive education data domain with students, courses, faculty, and academic management
+
+### 4. Real Estate & Construction
+
+- **Real Estate Management Platform**: Comprehensive real estate data domain with properties, clients, transactions, and marketing
+
+### 5. Technology & Media
+
+- **Blog Publishing Platform**: Complete blog and content publishing data domain with articles, authors, and media management
+
+### 6. Manufacturing & Logistics
+
+- *No templates yet* - Planned for Manufacturing, Supply Chain, Distribution
+
+### 7. Public Sector
+
+- *No templates yet* - Planned for Government, Non-Profit, Healthcare
+
+## Usage
+
+### Importing Templates by Vertical
+
+```typescript
+// Import all verticals
+import { 
+  businessServicesTemplates,
+  healthcareLifeSciencesTemplates,
+  educationTrainingTemplates,
+  realEstateConstructionTemplates,
+  technologyMediaTemplates,
+  manufacturingLogisticsTemplates,
+  publicSectorTemplates 
+} from './verticals/index.js'
+
+// Import specific templates
+import { createEcommerceDomain } from './verticals/business-services/index.js'
+import { createHealthcareDomain } from './verticals/healthcare-life-sciences/index.js'
+```
+
+### Using the Template Registry
+
+```typescript
+import { TemplateRegistry } from './template-registry.js'
+
+// Get all industry verticals
+const verticals = TemplateRegistry.getIndustryVerticals()
+
+// Get templates by vertical
+const businessTemplates = TemplateRegistry.getTemplatesByVertical('business-services')
+```
+
+## Adding New Templates
+
+1. **Choose the appropriate vertical** based on the industry focus
+2. **Create the template file** in the corresponding vertical directory
+3. **Update the vertical's index.ts** to export the new template
+4. **Update the main verticals index.ts** to include the template metadata
+5. **Update the metadata generation script** to include the new template
+6. **Run the build and metadata generation**:
+
+   ```bash
+   npm run build
+   node scripts/generate-template-metadata.js
+   ```
+
+## Template Categories
+
+Each vertical can contain multiple subcategories:
+
+- **Business Services**: E-commerce, Financial Services, Legal Services
+- **Healthcare & Life Sciences**: Healthcare, Pharmaceutical, Research
+- **Education & Training**: Education, Corporate Training, Certification
+- **Real Estate & Construction**: Real Estate, Construction, Property Management
+- **Manufacturing & Logistics**: Manufacturing, Supply Chain, Distribution
+- **Technology & Media**: Gaming, IoT, Content Management, Social Media
+- **Public Sector**: Government, Non-Profit, Healthcare
+
+This organization helps users quickly find templates relevant to their industry and use case.

package/src/modeling/templates/{ecommerce-domain.ts → verticals/business-services/ecommerce-domain.ts}

@@ -22,11 +22,11 @@
  * ```
  */
 
-import { DataDomain } from '../DataDomain.js'
-import { SemanticType } from '../Semantics.js'
-import { createCalculatedSemantic } from '../definitions/Calculated.js'
-import { createCurrencySemantic } from '../definitions/Currency.js'
-import { createSummarySemantic } from '../definitions/Summary.js'
+import { DataDomain } from '../../../DataDomain.js'
+import { SemanticType } from '../../../Semantics.js'
+import { createCalculatedSemantic } from '../../../definitions/Calculated.js'
+import { createCurrencySemantic } from '../../../definitions/Currency.js'
+import { createSummarySemantic } from '../../../definitions/Summary.js'
 import {
   addAvatarUrlField,
   addCreatedAtField,
@@ -51,8 +51,8 @@ import {
   addExpiresAtField,
   addUnitPriceField,
   addCurrencyAmountField,
-} from '../helpers/Intelisense.js'
-import type { CreateTemplateOptions } from './types.js'
+} from '../../../helpers/Intelisense.js'
+import type { CreateTemplateOptions } from '../../types.js'
 
 function createDomain(): DataDomain {
   return new DataDomain({