@api-client/core 0.18.20 → 0.18.22

package/src/modeling/templates/meta/non-profit-platform.json

@@ -0,0 +1 @@
+{"id":"non-profit-platform","name":"Non-Profit Platform","description":"A comprehensive non-profit platform with donor management, programs, volunteers, grants, events, and financial management","createdAt":"2025-01-27T00:00:00.000Z","updatedAt":"2025-01-27T00:00:00.000Z","version":"1.0.0","author":"API Now! Core Team","tags":["non-profit","charity","donor-management","volunteer-management","grant-management"],"structure":{"domain":{"name":"Non-Profit Platform","description":"A comprehensive non-profit platform with donor management, programs, volunteers, grants, events, and financial management","totalEntities":15,"totalProperties":146,"totalAssociations":13},"namespaces":[{"name":"DonorManagement","displayName":"Donor Management","description":"Donors, donations, campaigns, and stewardship","modelCount":1,"entityCount":3,"models":[{"name":"Donors","displayName":"Donor Management","description":"Donor profiles and relationships","entityCount":3,"entities":[{"name":"donor","displayName":"Donor","description":"Donor with profile and giving history","propertyCount":12,"associationCount":0,"properties":[{"name":"id","displayName":"Donor ID","description":"Unique identifier for the donor","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Donor name and title","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Donor description and notes","type":"string","semantics":["Semantic#Description"]},{"name":"email","displayName":"Email Address","description":"Donor email address","type":"string","required":true,"semantics":["Semantic#Email"]},{"name":"phone","displayName":"Phone Number","description":"Donor phone number","type":"string","semantics":["Semantic#Phone"]},{"name":"donor_type","displayName":"Donor Type","description":"Type of donor","type":"string","required":true,"semantics":[],"enumValues":["individual","corporation","foundation","government","anonymous"]},{"name":"address","displayName":"Address","description":"Donor address","type":"string","required":false,"semantics":[]},{"name":"date_of_birth","displayName":"Date of Birth","description":"Donor date of birth","type":"date","required":false,"semantics":[]},{"name":"employer","displayName":"Employer","description":"Donor employer","type":"string","required":false,"semantics":[]},{"name":"status","displayName":"Donor Status","description":"Current status of the donor","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["active","inactive","prospect","lapsed"],"defaultValue":"active"},{"name":"created_at","displayName":"Created At","description":"When the donor record was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]},{"name":"updated_at","displayName":"Updated At","description":"When the donor record was last updated","type":"datetime","readOnly":true,"semantics":["Semantic#UpdatedTimestamp"]}],"associations":[],"semantics":[]},{"name":"donation","displayName":"Donation","description":"Donor contribution","propertyCount":9,"associationCount":2,"properties":[{"name":"id","displayName":"Donation ID","description":"Unique identifier for the donation","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Donation name and description","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Donation description and purpose","type":"string","semantics":["Semantic#Description"]},{"name":"donation_date","displayName":"Donation Date","description":"Date of the donation","type":"date","required":true,"semantics":[]},{"name":"donation_type","displayName":"Donation Type","description":"Type of donation","type":"string","required":true,"semantics":[],"enumValues":["one_time","recurring","pledge","in_kind","matching"]},{"name":"payment_method","displayName":"Payment Method","description":"Payment method used","type":"string","required":true,"semantics":[],"enumValues":["check","credit_card","bank_transfer","cash","online","stock"]},{"name":"amount","displayName":"Donation Amount","description":"Donation amount","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"status","displayName":"Donation Status","description":"Current status of the donation","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["pending","received","acknowledged","thanked"],"defaultValue":"pending"},{"name":"created_at","displayName":"Created At","description":"When the donation was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"donor","displayName":"Donor","description":"Donor for this donation","required":true,"multiple":false,"targetEntities":["donor"],"semantics":[],"cardinality":"One-to-One"},{"name":"campaign","displayName":"Campaign","description":"Campaign for this donation","required":false,"multiple":false,"targetEntities":["campaign"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]},{"name":"campaign","displayName":"Campaign","description":"Fundraising campaign","propertyCount":10,"associationCount":0,"properties":[{"name":"id","displayName":"Campaign ID","description":"Unique identifier for the campaign","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Campaign name and title","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Campaign description and goals","type":"string","semantics":["Semantic#Description"]},{"name":"campaign_type","displayName":"Campaign Type","description":"Type of campaign","type":"string","required":true,"semantics":[],"enumValues":["annual","capital","emergency","special_event","online","mail"]},{"name":"start_date","displayName":"Start Date","description":"Campaign start date","type":"date","required":true,"semantics":[]},{"name":"end_date","displayName":"End Date","description":"Campaign end date","type":"date","required":true,"semantics":[]},{"name":"goal_amount","displayName":"Goal Amount","description":"Campaign fundraising goal","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"raised_amount","displayName":"Raised Amount","description":"Amount raised so far","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"status","displayName":"Campaign Status","description":"Current status of the campaign","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["planning","active","completed","cancelled"],"defaultValue":"planning"},{"name":"created_at","displayName":"Created At","description":"When the campaign was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[],"semantics":[]}]}]},{"name":"ProgramManagement","displayName":"Program Management","description":"Programs, services, outcomes, and impact","modelCount":1,"entityCount":3,"models":[{"name":"Programs","displayName":"Program Management","description":"Programs and services","entityCount":3,"entities":[{"name":"program","displayName":"Program","description":"Non-profit program or service","propertyCount":11,"associationCount":0,"properties":[{"name":"id","displayName":"Program ID","description":"Unique identifier for the program","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Program name and title","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Program description and objectives","type":"string","semantics":["Semantic#Description"]},{"name":"program_type","displayName":"Program Type","description":"Type of program","type":"string","required":true,"semantics":[],"enumValues":["education","healthcare","social_services","environmental","arts_culture","community_development"]},{"name":"start_date","displayName":"Start Date","description":"Program start date","type":"date","required":true,"semantics":[]},{"name":"end_date","displayName":"End Date","description":"Program end date","type":"date","required":false,"semantics":[]},{"name":"budget","displayName":"Program Budget","description":"Program budget amount","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"target_population","displayName":"Target Population","description":"Target population served","type":"string","required":false,"semantics":[]},{"name":"status","displayName":"Program Status","description":"Current status of the program","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["planning","active","completed","suspended"],"defaultValue":"planning"},{"name":"created_at","displayName":"Created At","description":"When the program was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]},{"name":"updated_at","displayName":"Updated At","description":"When the program was last updated","type":"datetime","readOnly":true,"semantics":["Semantic#UpdatedTimestamp"]}],"associations":[],"semantics":[]},{"name":"service","displayName":"Service","description":"Service provided by the program","propertyCount":7,"associationCount":1,"properties":[{"name":"id","displayName":"Service ID","description":"Unique identifier for the service","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Service name and title","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Service description and details","type":"string","semantics":["Semantic#Description"]},{"name":"service_type","displayName":"Service Type","description":"Type of service","type":"string","required":true,"semantics":[],"enumValues":["direct_service","referral","advocacy","education","support","counseling"]},{"name":"location","displayName":"Location","description":"Service location","type":"string","required":false,"semantics":[]},{"name":"status","displayName":"Service Status","description":"Current status of the service","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["available","unavailable","waitlist"],"defaultValue":"available"},{"name":"created_at","displayName":"Created At","description":"When the service was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"program","displayName":"Program","description":"Program for this service","required":true,"multiple":false,"targetEntities":["program"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]},{"name":"outcome","displayName":"Outcome","description":"Program outcomes and impact measurement","propertyCount":9,"associationCount":1,"properties":[{"name":"id","displayName":"Outcome ID","description":"Unique identifier for the outcome","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Outcome name and description","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Outcome description and measurement","type":"string","semantics":["Semantic#Description"]},{"name":"outcome_type","displayName":"Outcome Type","description":"Type of outcome","type":"string","required":true,"semantics":[],"enumValues":["short_term","medium_term","long_term","impact","output"]},{"name":"measurement_unit","displayName":"Measurement Unit","description":"Unit of measurement","type":"string","required":true,"semantics":[]},{"name":"target_value","displayName":"Target Value","description":"Target outcome value","type":"number","required":true,"semantics":[]},{"name":"actual_value","displayName":"Actual Value","description":"Actual outcome value","type":"number","required":false,"semantics":[]},{"name":"status","displayName":"Outcome Status","description":"Current status of the outcome","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["planned","in_progress","achieved","not_achieved"],"defaultValue":"planned"},{"name":"created_at","displayName":"Created At","description":"When the outcome was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"program","displayName":"Program","description":"Program for this outcome","required":true,"multiple":false,"targetEntities":["program"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]}]}]},{"name":"VolunteerManagement","displayName":"Volunteer Management","description":"Volunteers, opportunities, and scheduling","modelCount":1,"entityCount":3,"models":[{"name":"Volunteers","displayName":"Volunteer Management","description":"Volunteer profiles and opportunities","entityCount":3,"entities":[{"name":"volunteer","displayName":"Volunteer","description":"Volunteer with profile and skills","propertyCount":11,"associationCount":0,"properties":[{"name":"id","displayName":"Volunteer ID","description":"Unique identifier for the volunteer","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Volunteer name and title","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Volunteer description and notes","type":"string","semantics":["Semantic#Description"]},{"name":"email","displayName":"Email Address","description":"Volunteer email address","type":"string","required":true,"semantics":["Semantic#Email"]},{"name":"phone","displayName":"Phone Number","description":"Volunteer phone number","type":"string","semantics":["Semantic#Phone"]},{"name":"volunteer_type","displayName":"Volunteer Type","description":"Type of volunteer","type":"string","required":true,"semantics":[],"enumValues":["individual","corporate","student","retired","professional"]},{"name":"skills","displayName":"Skills","description":"Volunteer skills and expertise","type":"string","required":false,"semantics":[]},{"name":"availability","displayName":"Availability","description":"Volunteer availability","type":"string","required":false,"semantics":[]},{"name":"status","displayName":"Volunteer Status","description":"Current status of the volunteer","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["active","inactive","pending","suspended"],"defaultValue":"active"},{"name":"created_at","displayName":"Created At","description":"When the volunteer record was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]},{"name":"updated_at","displayName":"Updated At","description":"When the volunteer record was last updated","type":"datetime","readOnly":true,"semantics":["Semantic#UpdatedTimestamp"]}],"associations":[],"semantics":[]},{"name":"opportunity","displayName":"Opportunity","description":"Volunteer opportunity","propertyCount":9,"associationCount":1,"properties":[{"name":"id","displayName":"Opportunity ID","description":"Unique identifier for the opportunity","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Opportunity name and title","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Opportunity description and requirements","type":"string","semantics":["Semantic#Description"]},{"name":"opportunity_type","displayName":"Opportunity Type","description":"Type of opportunity","type":"string","required":true,"semantics":[],"enumValues":["event_support","program_delivery","administrative","fundraising","mentoring","outreach"]},{"name":"location","displayName":"Location","description":"Opportunity location","type":"string","required":false,"semantics":[]},{"name":"required_skills","displayName":"Required Skills","description":"Skills required for opportunity","type":"string","required":false,"semantics":[]},{"name":"duration","displayName":"Duration","description":"Opportunity duration","type":"string","required":false,"semantics":[]},{"name":"status","displayName":"Opportunity Status","description":"Current status of the opportunity","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["open","filled","closed","cancelled"],"defaultValue":"open"},{"name":"created_at","displayName":"Created At","description":"When the opportunity was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"program","displayName":"Program","description":"Program for this opportunity","required":false,"multiple":false,"targetEntities":["program"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]},{"name":"volunteer_assignment","displayName":"Volunteer Assignment","description":"Volunteer assignments and scheduling","propertyCount":8,"associationCount":2,"properties":[{"name":"id","displayName":"Assignment ID","description":"Unique identifier for the volunteer assignment","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Assignment name and description","type":"string","semantics":["Semantic#Title"]},{"name":"assignment_date","displayName":"Assignment Date","description":"Assignment date","type":"date","required":true,"semantics":[]},{"name":"start_time","displayName":"Start Time","description":"Assignment start time","type":"time","required":true,"semantics":[]},{"name":"end_time","displayName":"End Time","description":"Assignment end time","type":"time","required":true,"semantics":[]},{"name":"hours_worked","displayName":"Hours Worked","description":"Hours worked on assignment","type":"number","required":false,"semantics":[]},{"name":"status","displayName":"Assignment Status","description":"Current status of the volunteer assignment","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["scheduled","in_progress","completed","cancelled"],"defaultValue":"scheduled"},{"name":"created_at","displayName":"Created At","description":"When the assignment was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"volunteer","displayName":"Volunteer","description":"Volunteer for this assignment","required":true,"multiple":false,"targetEntities":["volunteer"],"semantics":[],"cardinality":"One-to-One"},{"name":"opportunity","displayName":"Opportunity","description":"Opportunity for this assignment","required":true,"multiple":false,"targetEntities":["opportunity"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]}]}]},{"name":"GrantManagement","displayName":"Grant Management","description":"Grants, applications, reporting, and compliance","modelCount":1,"entityCount":2,"models":[{"name":"Grants","displayName":"Grant Management","description":"Grant applications and management","entityCount":2,"entities":[{"name":"grant","displayName":"Grant","description":"Grant application or award","propertyCount":11,"associationCount":1,"properties":[{"name":"id","displayName":"Grant ID","description":"Unique identifier for the grant","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Grant name and title","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Grant description and objectives","type":"string","semantics":["Semantic#Description"]},{"name":"grant_type","displayName":"Grant Type","description":"Type of grant","type":"string","required":true,"semantics":[],"enumValues":["program","operating","capital","research","emergency","matching"]},{"name":"funder","displayName":"Funder","description":"Grant funder or foundation","type":"string","required":true,"semantics":[]},{"name":"application_date","displayName":"Application Date","description":"Grant application date","type":"date","required":true,"semantics":[]},{"name":"decision_date","displayName":"Decision Date","description":"Grant decision date","type":"date","required":false,"semantics":[]},{"name":"requested_amount","displayName":"Requested Amount","description":"Amount requested in grant","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"awarded_amount","displayName":"Awarded Amount","description":"Amount awarded in grant","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"status","displayName":"Grant Status","description":"Current status of the grant","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["draft","submitted","under_review","approved","rejected","active","completed"],"defaultValue":"draft"},{"name":"created_at","displayName":"Created At","description":"When the grant was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"program","displayName":"Program","description":"Program for this grant","required":true,"multiple":false,"targetEntities":["program"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]},{"name":"grant_report","displayName":"Grant Report","description":"Grant reporting and compliance","propertyCount":8,"associationCount":1,"properties":[{"name":"id","displayName":"Report ID","description":"Unique identifier for the grant report","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Report name and title","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Report description and content","type":"string","semantics":["Semantic#Description"]},{"name":"report_type","displayName":"Report Type","description":"Type of grant report","type":"string","required":true,"semantics":[],"enumValues":["progress","final","financial","narrative","compliance"]},{"name":"due_date","displayName":"Due Date","description":"Report due date","type":"date","required":true,"semantics":[]},{"name":"submission_date","displayName":"Submission Date","description":"Report submission date","type":"date","required":false,"semantics":[]},{"name":"status","displayName":"Report Status","description":"Current status of the grant report","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["draft","submitted","approved","revision_requested"],"defaultValue":"draft"},{"name":"created_at","displayName":"Created At","description":"When the report was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"grant","displayName":"Grant","description":"Grant for this report","required":true,"multiple":false,"targetEntities":["grant"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]}]}]},{"name":"EventManagement","displayName":"Event Management","description":"Fundraising events, registrations, and logistics","modelCount":1,"entityCount":2,"models":[{"name":"Events","displayName":"Event Management","description":"Fundraising events and activities","entityCount":2,"entities":[{"name":"event","displayName":"Event","description":"Fundraising event or activity","propertyCount":13,"associationCount":0,"properties":[{"name":"id","displayName":"Event ID","description":"Unique identifier for the event","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Event name and title","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Event description and details","type":"string","semantics":["Semantic#Description"]},{"name":"event_type","displayName":"Event Type","description":"Type of event","type":"string","required":true,"semantics":[],"enumValues":["gala","auction","walk_run","golf_tournament","conference","workshop","volunteer_day"]},{"name":"event_date","displayName":"Event Date","description":"Event date","type":"date","required":true,"semantics":[]},{"name":"start_time","displayName":"Start Time","description":"Event start time","type":"time","required":true,"semantics":[]},{"name":"end_time","displayName":"End Time","description":"Event end time","type":"time","required":false,"semantics":[]},{"name":"location","displayName":"Location","description":"Event location","type":"string","required":true,"semantics":[]},{"name":"capacity","displayName":"Capacity","description":"Event capacity","type":"number","required":false,"semantics":[]},{"name":"goal_amount","displayName":"Goal Amount","description":"Event fundraising goal","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"raised_amount","displayName":"Raised Amount","description":"Amount raised from event","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"status","displayName":"Event Status","description":"Current status of the event","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["planning","registration_open","registration_closed","in_progress","completed","cancelled"],"defaultValue":"planning"},{"name":"created_at","displayName":"Created At","description":"When the event was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[],"semantics":[]},{"name":"registration","displayName":"Registration","description":"Event registration","propertyCount":8,"associationCount":2,"properties":[{"name":"id","displayName":"Registration ID","description":"Unique identifier for the registration","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Registration name and description","type":"string","semantics":["Semantic#Title"]},{"name":"registration_date","displayName":"Registration Date","description":"Registration date","type":"date","required":true,"semantics":[]},{"name":"registration_type","displayName":"Registration Type","description":"Type of registration","type":"string","required":true,"semantics":[],"enumValues":["individual","group","sponsor","volunteer"]},{"name":"number_of_attendees","displayName":"Number of Attendees","description":"Number of attendees","type":"number","required":true,"semantics":[]},{"name":"registration_fee","displayName":"Registration Fee","description":"Registration fee amount","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"status","displayName":"Registration Status","description":"Current status of the registration","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["pending","confirmed","cancelled","attended"],"defaultValue":"pending"},{"name":"created_at","displayName":"Created At","description":"When the registration was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"event","displayName":"Event","description":"Event for this registration","required":true,"multiple":false,"targetEntities":["event"],"semantics":[],"cardinality":"One-to-One"},{"name":"donor","displayName":"Donor","description":"Donor for this registration","required":true,"multiple":false,"targetEntities":["donor"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]}]}]},{"name":"FinancialManagement","displayName":"Financial Management","description":"Budgets, expenses, and reporting","modelCount":1,"entityCount":2,"models":[{"name":"Financial","displayName":"Financial Management","description":"Financial management and reporting","entityCount":2,"entities":[{"name":"budget","displayName":"Budget","description":"Organization budget","propertyCount":11,"associationCount":1,"properties":[{"name":"id","displayName":"Budget ID","description":"Unique identifier for the budget","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Budget name and description","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Budget description and notes","type":"string","semantics":["Semantic#Description"]},{"name":"budget_type","displayName":"Budget Type","description":"Type of budget","type":"string","required":true,"semantics":[],"enumValues":["operating","program","capital","project","department"]},{"name":"fiscal_year","displayName":"Fiscal Year","description":"Budget fiscal year","type":"string","required":true,"semantics":[]},{"name":"start_date","displayName":"Start Date","description":"Budget start date","type":"date","required":true,"semantics":[]},{"name":"end_date","displayName":"End Date","description":"Budget end date","type":"date","required":true,"semantics":[]},{"name":"total_budget","displayName":"Total Budget","description":"Total budget amount","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"spent_amount","displayName":"Spent Amount","description":"Amount spent so far","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"status","displayName":"Budget Status","description":"Current status of the budget","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["draft","approved","active","closed"],"defaultValue":"draft"},{"name":"created_at","displayName":"Created At","description":"When the budget was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"program","displayName":"Program","description":"Program for this budget","required":false,"multiple":false,"targetEntities":["program"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]},{"name":"expense","displayName":"Expense","description":"Organization expense","propertyCount":9,"associationCount":1,"properties":[{"name":"id","displayName":"Expense ID","description":"Unique identifier for the expense","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Name","description":"Expense name and description","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Expense description and details","type":"string","semantics":["Semantic#Description"]},{"name":"expense_type","displayName":"Expense Type","description":"Type of expense","type":"string","required":true,"semantics":[],"enumValues":["personnel","program","administrative","fundraising","facilities","equipment"]},{"name":"expense_date","displayName":"Expense Date","description":"Expense date","type":"date","required":true,"semantics":[]},{"name":"vendor","displayName":"Vendor","description":"Expense vendor","type":"string","required":false,"semantics":[]},{"name":"amount","displayName":"Expense Amount","description":"Expense amount","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"status","displayName":"Expense Status","description":"Current status of the expense","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["pending","approved","paid","rejected"],"defaultValue":"pending"},{"name":"created_at","displayName":"Created At","description":"When the expense was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"budget","displayName":"Budget","description":"Budget for this expense","required":true,"multiple":false,"targetEntities":["budget"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]}]}]}]}}

package/src/modeling/templates/meta/real-estate-management-platform.json

@@ -0,0 +1 @@
+{"id":"real-estate-management-platform","name":"Real Estate Management Platform","description":"A comprehensive real estate management platform with property management, client management, transaction management, market analysis, and marketing features. Perfect for real estate agencies, brokers, and property managers.","createdAt":"2025-01-27T00:00:00.000Z","updatedAt":"2025-01-27T00:00:00.000Z","version":"1.0.0","author":"API Now! Core Team","tags":["real-estate","property-management","client-management","transaction-management","market-analysis"],"structure":{"domain":{"name":"Real Estate Management Platform","description":"A comprehensive real estate management platform with property management, client management, transaction management, market analysis, and marketing features","totalEntities":15,"totalProperties":116,"totalAssociations":16},"namespaces":[{"name":"PropertyManagement","displayName":"Property Management","description":"Listings, properties, amenities, and photos","modelCount":1,"entityCount":4,"models":[{"name":"Properties","displayName":"Property Management","description":"Property information and listings","entityCount":4,"entities":[{"name":"property","displayName":"Property","description":"Real estate property information","propertyCount":16,"associationCount":2,"properties":[{"name":"id","displayName":"Property ID","description":"Unique identifier for the property","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Property Name","description":"Name or title of the property","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Property description and features","type":"string","semantics":["Semantic#Description"]},{"name":"address","displayName":"Address","description":"Property street address","type":"string","required":true,"semantics":[]},{"name":"city","displayName":"City","description":"Property city","type":"string","required":true,"semantics":[]},{"name":"state","displayName":"State","description":"Property state","type":"string","required":true,"semantics":[]},{"name":"zip_code","displayName":"ZIP Code","description":"Property ZIP code","type":"string","required":true,"semantics":[]},{"name":"square_feet","displayName":"Square Feet","description":"Property square footage","type":"number","required":true,"semantics":[]},{"name":"bedrooms","displayName":"Bedrooms","description":"Number of bedrooms","type":"number","required":true,"semantics":[]},{"name":"bathrooms","displayName":"Bathrooms","description":"Number of bathrooms","type":"number","required":true,"semantics":[]},{"name":"property_type","displayName":"Property Type","description":"Type of real estate property","type":"string","required":true,"semantics":[],"enumValues":["residential","commercial","industrial","land","mixed_use"]},{"name":"status","displayName":"Listing Status","description":"Current listing status of the property","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["for_sale","for_rent","sold","rented","off_market"],"defaultValue":"for_sale"},{"name":"list_price","displayName":"List Price","description":"Listing price of the property","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"market_value","displayName":"Market Value","description":"Estimated market value of the property","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"created_at","displayName":"Created At","description":"When the property was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]},{"name":"updated_at","displayName":"Updated At","description":"When the property was last updated","type":"datetime","readOnly":true,"semantics":["Semantic#UpdatedTimestamp"]}],"associations":[{"name":"amenities","displayName":"Amenities","description":"Amenities available at this property","required":false,"multiple":true,"targetEntities":["amenity"],"semantics":[],"cardinality":"One-to-Many"},{"name":"photos","displayName":"Photos","description":"Photos of this property","required":false,"multiple":true,"targetEntities":["photo"],"semantics":[],"cardinality":"One-to-Many"}],"semantics":[]},{"name":"listing","displayName":"Listing","description":"Property listing information","propertyCount":7,"associationCount":1,"properties":[{"name":"id","displayName":"Listing ID","description":"Unique identifier for the listing","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Listing Title","description":"Title of the listing","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Listing description and details","type":"string","semantics":["Semantic#Description"]},{"name":"price","displayName":"Listing Price","description":"Price for the listing","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"list_date","displayName":"List Date","description":"Date when property was listed","type":"date","required":true,"semantics":[]},{"name":"status","displayName":"Listing Status","description":"Current status of the listing","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["active","pending","sold","expired","withdrawn"],"defaultValue":"active"},{"name":"created_at","displayName":"Created At","description":"When the listing was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"property","displayName":"Property","description":"Property for this listing","required":true,"multiple":false,"targetEntities":["property"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]},{"name":"amenity","displayName":"Amenity","description":"Property amenities and features","propertyCount":6,"associationCount":0,"properties":[{"name":"id","displayName":"Amenity ID","description":"Unique identifier for the amenity","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Amenity Name","description":"Name of the amenity","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Amenity description and details","type":"string","semantics":["Semantic#Description"]},{"name":"amenity_type","displayName":"Amenity Type","description":"Type of amenity","type":"string","required":true,"semantics":[],"enumValues":["interior","exterior","community","utilities"]},{"name":"available","displayName":"Available","description":"Whether the amenity is available","type":"boolean","required":true,"semantics":[],"defaultValue":"true"},{"name":"created_at","displayName":"Created At","description":"When the amenity was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[],"semantics":[]},{"name":"photo","displayName":"Photo","description":"Property photos and images","propertyCount":7,"associationCount":0,"properties":[{"name":"id","displayName":"Photo ID","description":"Unique identifier for the photo","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"url","displayName":"Photo URL","description":"URL to the photo","type":"string","required":true,"semantics":[]},{"name":"name","displayName":"Photo Title","description":"Title or caption for the photo","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Photo description and details","type":"string","semantics":["Semantic#Description"]},{"name":"photo_type","displayName":"Photo Type","description":"Type of property photo","type":"string","required":true,"semantics":[],"enumValues":["exterior","interior","kitchen","bathroom","bedroom","living_room"]},{"name":"featured","displayName":"Featured","description":"Whether this is a featured photo","type":"boolean","required":true,"semantics":[],"defaultValue":"false"},{"name":"created_at","displayName":"Created At","description":"When the photo was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[],"semantics":[]}]}]},{"name":"ClientManagement","displayName":"Client Management","description":"Buyers, sellers, agents, and leads","modelCount":1,"entityCount":3,"models":[{"name":"Clients","displayName":"Client Management","description":"Client information and relationships","entityCount":3,"entities":[{"name":"client","displayName":"Client","description":"Real estate client (buyer or seller)","propertyCount":11,"associationCount":1,"properties":[{"name":"id","displayName":"Client ID","description":"Unique identifier for the client","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"first_name","displayName":"First Name","description":"Client first name","type":"string","semantics":[]},{"name":"last_name","displayName":"Last Name","description":"Client last name","type":"string","semantics":[]},{"name":"email","displayName":"Email Address","description":"Client email address","type":"string","required":true,"semantics":["Semantic#Email"]},{"name":"phone","displayName":"Phone Number","description":"Client phone number","type":"string","semantics":["Semantic#Phone"]},{"name":"client_type","displayName":"Client Type","description":"Type of client (buyer, seller, or both)","type":"string","required":true,"semantics":[],"enumValues":["buyer","seller","both"]},{"name":"status","displayName":"Client Status","description":"Current status of the client","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["active","inactive","prospect","closed"],"defaultValue":"active"},{"name":"budget_min","displayName":"Minimum Budget","description":"Minimum budget for property purchase","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"budget_max","displayName":"Maximum Budget","description":"Maximum budget for property purchase","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"created_at","displayName":"Created At","description":"When the client was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]},{"name":"updated_at","displayName":"Updated At","description":"When the client was last updated","type":"datetime","readOnly":true,"semantics":["Semantic#UpdatedTimestamp"]}],"associations":[{"name":"agent","displayName":"Agent","description":"Agent representing this client","required":true,"multiple":false,"targetEntities":["agent"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]},{"name":"agent","displayName":"Agent","description":"Real estate agent information","propertyCount":8,"associationCount":0,"properties":[{"name":"id","displayName":"Agent ID","description":"Unique identifier for the agent","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"first_name","displayName":"First Name","description":"Agent first name","type":"string","semantics":[]},{"name":"last_name","displayName":"Last Name","description":"Agent last name","type":"string","semantics":[]},{"name":"email","displayName":"Email Address","description":"Agent email address","type":"string","required":true,"semantics":["Semantic#Email"]},{"name":"phone","displayName":"Phone Number","description":"Agent phone number","type":"string","semantics":["Semantic#Phone"]},{"name":"license_number","displayName":"License Number","description":"Real estate license number","type":"string","required":true,"unique":true,"semantics":[]},{"name":"status","displayName":"Agent Status","description":"Current status of the agent","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["active","inactive","suspended"],"defaultValue":"active"},{"name":"created_at","displayName":"Created At","description":"When the agent was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[],"semantics":[]},{"name":"lead","displayName":"Lead","description":"Sales leads and prospects","propertyCount":9,"associationCount":1,"properties":[{"name":"id","displayName":"Lead ID","description":"Unique identifier for the lead","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"first_name","displayName":"First Name","description":"Lead first name","type":"string","semantics":[]},{"name":"last_name","displayName":"Last Name","description":"Lead last name","type":"string","semantics":[]},{"name":"email","displayName":"Email Address","description":"Lead email address","type":"string","required":true,"semantics":["Semantic#Email"]},{"name":"phone","displayName":"Phone Number","description":"Lead phone number","type":"string","semantics":["Semantic#Phone"]},{"name":"status","displayName":"Lead Status","description":"Current status of the lead","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["new","contacted","qualified","converted","lost"],"defaultValue":"new"},{"name":"lead_source","displayName":"Lead Source","description":"Source of the lead","type":"string","required":true,"semantics":[],"enumValues":["website","referral","social_media","cold_call","event"]},{"name":"description","displayName":"Description","description":"Lead notes and information","type":"string","semantics":["Semantic#Description"]},{"name":"created_at","displayName":"Created At","description":"When the lead was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"agent","displayName":"Agent","description":"Agent assigned to this lead","required":true,"multiple":false,"targetEntities":["agent"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]}]}]},{"name":"TransactionManagement","displayName":"Transaction Management","description":"Offers, contracts, closings, and escrow","modelCount":1,"entityCount":3,"models":[{"name":"Transactions","displayName":"Transaction Management","description":"Real estate transactions and deals","entityCount":3,"entities":[{"name":"offer","displayName":"Offer","description":"Property purchase offers","propertyCount":6,"associationCount":2,"properties":[{"name":"id","displayName":"Offer ID","description":"Unique identifier for the offer","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"offer_price","displayName":"Offer Price","description":"Price offered for the property","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"offer_date","displayName":"Offer Date","description":"Date when offer was made","type":"date","required":true,"semantics":[]},{"name":"status","displayName":"Offer Status","description":"Current status of the offer","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["pending","accepted","rejected","countered","withdrawn"],"defaultValue":"pending"},{"name":"description","displayName":"Description","description":"Offer terms and conditions","type":"string","semantics":["Semantic#Description"]},{"name":"created_at","displayName":"Created At","description":"When the offer was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"property","displayName":"Property","description":"Property for this offer","required":true,"multiple":false,"targetEntities":["property"],"semantics":[],"cardinality":"One-to-One"},{"name":"buyer","displayName":"Buyer","description":"Buyer making this offer","required":true,"multiple":false,"targetEntities":["client"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]},{"name":"contract","displayName":"Contract","description":"Real estate purchase contracts","propertyCount":6,"associationCount":3,"properties":[{"name":"id","displayName":"Contract ID","description":"Unique identifier for the contract","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"purchase_price","displayName":"Purchase Price","description":"Final purchase price","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"contract_date","displayName":"Contract Date","description":"Date when contract was signed","type":"date","required":true,"semantics":[]},{"name":"closing_date","displayName":"Closing Date","description":"Scheduled closing date","type":"date","required":true,"semantics":[]},{"name":"status","displayName":"Contract Status","description":"Current status of the contract","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["draft","signed","pending","closed","cancelled"],"defaultValue":"draft"},{"name":"created_at","displayName":"Created At","description":"When the contract was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"property","displayName":"Property","description":"Property in this contract","required":true,"multiple":false,"targetEntities":["property"],"semantics":[],"cardinality":"One-to-One"},{"name":"buyer","displayName":"Buyer","description":"Buyer in this contract","required":true,"multiple":false,"targetEntities":["client"],"semantics":[],"cardinality":"One-to-One"},{"name":"seller","displayName":"Seller","description":"Seller in this contract","required":true,"multiple":false,"targetEntities":["client"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]},{"name":"escrow","displayName":"Escrow","description":"Escrow account and transaction details","propertyCount":5,"associationCount":1,"properties":[{"name":"id","displayName":"Escrow ID","description":"Unique identifier for the escrow","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"escrow_amount","displayName":"Escrow Amount","description":"Amount held in escrow","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"escrow_date","displayName":"Escrow Date","description":"Date when escrow was opened","type":"date","required":true,"semantics":[]},{"name":"status","displayName":"Escrow Status","description":"Current status of the escrow","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["open","funded","closed","cancelled"],"defaultValue":"open"},{"name":"created_at","displayName":"Created At","description":"When the escrow was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"contract","displayName":"Contract","description":"Contract for this escrow","required":true,"multiple":false,"targetEntities":["contract"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]}]}]},{"name":"MarketAnalysis","displayName":"Market Analysis","description":"Comps, market data, and pricing models","modelCount":1,"entityCount":2,"models":[{"name":"Market","displayName":"Market Analysis","description":"Market data and analysis","entityCount":2,"entities":[{"name":"market_data","displayName":"Market Data","description":"Real estate market data and trends","propertyCount":7,"associationCount":0,"properties":[{"name":"id","displayName":"Market Data ID","description":"Unique identifier for the market data","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"area","displayName":"Area","description":"Geographic area for market data","type":"string","required":true,"semantics":[]},{"name":"data_date","displayName":"Data Date","description":"Date of market data","type":"date","required":true,"semantics":[]},{"name":"avg_price","displayName":"Average Price","description":"Average property price in the area","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"days_on_market","displayName":"Days on Market","description":"Average days on market","type":"number","required":true,"semantics":[]},{"name":"inventory_count","displayName":"Inventory Count","description":"Number of properties for sale","type":"number","required":true,"semantics":[]},{"name":"created_at","displayName":"Created At","description":"When the market data was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[],"semantics":[]},{"name":"comparable","displayName":"Comparable","description":"Comparable property sales data","propertyCount":6,"associationCount":1,"properties":[{"name":"id","displayName":"Comparable ID","description":"Unique identifier for the comparable","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Comparable Name","description":"Name or address of comparable property","type":"string","semantics":["Semantic#Title"]},{"name":"sale_price","displayName":"Sale Price","description":"Sale price of the comparable property","type":"number","required":true,"semantics":["Semantic#Currency"]},{"name":"sale_date","displayName":"Sale Date","description":"Date when comparable property sold","type":"date","required":true,"semantics":[]},{"name":"square_feet","displayName":"Square Feet","description":"Square footage of comparable property","type":"number","required":true,"semantics":[]},{"name":"created_at","displayName":"Created At","description":"When the comparable was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"property","displayName":"Property","description":"Property for this comparable","required":true,"multiple":false,"targetEntities":["property"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]}]}]},{"name":"DocumentManagement","displayName":"Document Management","description":"Contracts, disclosures, and legal documents","modelCount":1,"entityCount":1,"models":[{"name":"Documents","displayName":"Document Management","description":"Document storage and management","entityCount":1,"entities":[{"name":"document","displayName":"Document","description":"Legal documents and contracts","propertyCount":7,"associationCount":2,"properties":[{"name":"id","displayName":"Document ID","description":"Unique identifier for the document","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Document Name","description":"Name of the document","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Document description and details","type":"string","semantics":["Semantic#Description"]},{"name":"file_url","displayName":"File URL","description":"URL to the document file","type":"string","required":true,"semantics":[]},{"name":"document_type","displayName":"Document Type","description":"Type of document","type":"string","required":true,"semantics":[],"enumValues":["contract","disclosure","inspection","appraisal","title","other"]},{"name":"status","displayName":"Document Status","description":"Current status of the document","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["draft","pending","signed","archived"],"defaultValue":"draft"},{"name":"created_at","displayName":"Created At","description":"When the document was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"contract","displayName":"Contract","description":"Contract for this document","required":false,"multiple":false,"targetEntities":["contract"],"semantics":[],"cardinality":"One-to-One"},{"name":"property","displayName":"Property","description":"Property for this document","required":false,"multiple":false,"targetEntities":["property"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]}]}]},{"name":"Marketing","displayName":"Marketing","description":"Lead generation, campaigns, and follow-ups","modelCount":1,"entityCount":2,"models":[{"name":"Marketing","displayName":"Marketing Management","description":"Marketing campaigns and activities","entityCount":2,"entities":[{"name":"campaign","displayName":"Campaign","description":"Marketing campaigns and promotions","propertyCount":8,"associationCount":0,"properties":[{"name":"id","displayName":"Campaign ID","description":"Unique identifier for the campaign","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Campaign Name","description":"Name of the marketing campaign","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Campaign description and objectives","type":"string","semantics":["Semantic#Description"]},{"name":"start_date","displayName":"Start Date","description":"Campaign start date","type":"date","required":true,"semantics":[]},{"name":"end_date","displayName":"End Date","description":"Campaign end date","type":"date","required":true,"semantics":[]},{"name":"status","displayName":"Campaign Status","description":"Current status of the campaign","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["draft","active","paused","completed","cancelled"],"defaultValue":"draft"},{"name":"campaign_type","displayName":"Campaign Type","description":"Type of marketing campaign","type":"string","required":true,"semantics":[],"enumValues":["email","social_media","print","digital","event"]},{"name":"created_at","displayName":"Created At","description":"When the campaign was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[],"semantics":[]},{"name":"follow_up","displayName":"Follow-up","description":"Client follow-up activities","propertyCount":7,"associationCount":2,"properties":[{"name":"id","displayName":"Follow-up ID","description":"Unique identifier for the follow-up","type":"string","primary":true,"readOnly":true,"semantics":[]},{"name":"name","displayName":"Follow-up Title","description":"Title of the follow-up activity","type":"string","semantics":["Semantic#Title"]},{"name":"description","displayName":"Description","description":"Follow-up notes and details","type":"string","semantics":["Semantic#Description"]},{"name":"scheduled_date","displayName":"Scheduled Date","description":"Scheduled follow-up date","type":"date","required":true,"semantics":[]},{"name":"status","displayName":"Follow-up Status","description":"Current status of the follow-up","type":"string","required":true,"semantics":["Semantic#Status"],"enumValues":["scheduled","completed","cancelled","overdue"],"defaultValue":"scheduled"},{"name":"follow_up_type","displayName":"Follow-up Type","description":"Type of follow-up activity","type":"string","required":true,"semantics":[],"enumValues":["phone_call","email","meeting","text","other"]},{"name":"created_at","displayName":"Created At","description":"When the follow-up was created","type":"datetime","readOnly":true,"semantics":["Semantic#CreatedTimestamp"]}],"associations":[{"name":"client","displayName":"Client","description":"Client for this follow-up","required":true,"multiple":false,"targetEntities":["client"],"semantics":[],"cardinality":"One-to-One"},{"name":"agent","displayName":"Agent","description":"Agent responsible for this follow-up","required":true,"multiple":false,"targetEntities":["agent"],"semantics":[],"cardinality":"One-to-One"}],"semantics":[]}]}]}]}}

package/src/modeling/templates/readme.md

@@ -0,0 +1,260 @@
+# Domain Templates
+
+The domain templates allow creating or updating existing data domains from a template. Templates follow the Domain-Driven Design (DDD) principles and provide pre-built business domain structures that users can instantiate or extend.
+
+## Organization by Industry Verticals
+
+Templates are organized by industry verticals to provide better categorization and discovery:
+
+- **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
+
+See `verticals/README.md` for detailed information about the vertical organization.
+
+## Template Structure
+
+Each template is a TypeScript file that exports a default function conforming to the template signature. Templates create comprehensive data domains with proper namespace organization, entity relationships, and semantic annotations.
+
+### Required Function Signature
+
+```typescript
+import type { CreateTemplateOptions } from './types.js'
+import { DataDomain } from '../DataDomain.js'
+
+export default function createMyDomain(options: CreateTemplateOptions = {}): DataDomain {
+  // Template implementation
+}
+```
+
+### Template Implementation Pattern
+
+```typescript
+/**
+ * Template Documentation Header
+ * 
+ * Provide comprehensive documentation explaining:
+ * - What business domain this template models
+ * - Key entities and relationships included
+ * - Semantic annotations and business rules applied
+ * - Example usage scenarios
+ */
+
+import { DataDomain } from '../DataDomain.js'
+import { SemanticType } from '../Semantics.js'
+import {
+  addIdField,
+  addNameField,
+  addEmailField,
+  // Import other helper functions as needed
+} from '../helpers/Intelisense.js'
+import type { CreateTemplateOptions } from './types.js'
+
+function createDomain(): DataDomain {
+  return new DataDomain({
+    info: {
+      name: 'My Business Domain',
+      displayName: 'My Business Domain',
+      description: 'Clear description of what this domain models',
+    },
+  })
+}
+
+export default function createMyDomain(options: CreateTemplateOptions = {}): DataDomain {
+  // Use existing domain if provided, otherwise create new one
+  const domain = options.domain ?? createDomain()
+  
+  // Create namespaces following business capabilities
+  const coreNamespace = domain.addNamespace({ 
+    info: { name: 'CoreManagement' } 
+  })
+  
+  // Add models to organize related entities
+  const entityModel = coreNamespace.addModel({ 
+    info: { name: 'CoreEntities' } 
+  })
+  
+  // Create entities with proper semantic annotations
+  const mainEntity = entityModel.addEntity({ 
+    info: { name: 'MainEntity' },
+    semantics: [{ type: SemanticType.User }] // If applicable
+  })
+  
+  // Add properties using helper functions for consistency
+  addIdField(mainEntity)
+  addNameField(mainEntity)
+  addEmailField(mainEntity)
+  
+  // Add custom properties with proper semantics
+  mainEntity.addProperty({
+    info: { name: 'customField' },
+    type: 'string',
+    required: false,
+    semantics: [/* appropriate semantics */]
+  })
+  
+  // Create associations between entities
+  // (Add more entities and relationships as needed)
+  
+  return domain
+}
+```
+
+## Adding a Template
+
+### 1. Create the Template File
+
+Create a new file `[domain-name]-domain.ts` in `src/modeling/templates/` following the naming convention:
+
+- Use kebab-case for file names
+- End with `-domain.ts`
+- Examples: `healthcare-domain.ts`, `financial-services-domain.ts`
+
+### 2. Follow Modeling Guidelines
+
+Templates must adhere to the modeling instructions in `.github/instructions/modeling.instructions.md`:
+
+- **Business-First Approach**: Model business concepts, not technical concerns
+- **Proper Hierarchy**: DataDomain → DomainNamespace → DomainModel → DomainEntity → DomainProperty
+- **Semantic Annotations**: Use `SemanticType` for passwords, emails, timestamps, etc.
+- **Security**: Mark sensitive properties as `writeOnly`, validate all inputs
+- **Database Compliance**: Follow PostgreSQL naming conventions (snake_case conversion)
+
+### 3. Required Imports
+
+Include these essential imports:
+
+```typescript
+import { DataDomain } from '../DataDomain.js'
+import { SemanticType } from '../Semantics.js'
+import type { CreateTemplateOptions } from './types.js'
+
+// Import semantic definition helpers as needed
+import { createCalculatedSemantic } from '../definitions/Calculated.js'
+import { createCurrencySemantic } from '../definitions/Currency.js'
+
+// Import property helper functions for consistency
+import {
+  addIdField,
+  addNameField,
+  addEmailField,
+  addPasswordField,
+  addCreatedAtField,
+  addUpdatedAtField,
+  // ... other helpers as needed
+} from '../helpers/Intelisense.js'
+```
+
+### 4. Handle Template Options
+
+Always support the `CreateTemplateOptions` interface:
+
+```typescript
+export default function createMyDomain(options: CreateTemplateOptions = {}): DataDomain {
+  // Use provided domain or create new one
+  const domain = options.domain ?? createDomain()
+  
+  // If domain is provided, you're extending an existing domain
+  // If not provided, you're creating a new domain
+  
+  return domain
+}
+```
+
+## Registering Templates
+
+### 1. Add to Generation Script
+
+Edit `scripts/generate-template-metadata.js` and add your template to the registry:
+
+```javascript
+// Import your template function
+import createMyDomain from '../build/src/modeling/templates/my-domain.js'
+
+// Add to templates array
+const TEMPLATE_CONFIGS = [
+  {
+    id: 'my-business-domain',
+    name: 'My Business Domain',
+    description: 'Brief description for UI display',
+    version: '1.0.0',
+    author: 'API Now! Core Team',
+    tags: ['business', 'industry-specific'], // For categorization
+    createdAt: '2025-01-01T00:00:00.000Z',
+    updatedAt: '2025-01-01T00:00:00.000Z',
+    createDomainFn: createMyDomain,
+  },
+  // ... other templates
+]
+```
+
+### 2. Template Metadata
+
+The generation script will create metadata including:
+
+- Template structure analysis (namespaces, models, entities)
+- Property counts and types
+- Association mappings
+- Semantic annotation usage
+- UI presentation information
+
+## Generating Metadata
+
+Each template needs to be processed to generate metadata files. These metadata are used to generate the templates view in the UI.
+
+**If you won't generate metadata, the template won't get registered by the UI.**
+
+### 1. Build the Project First
+
+```sh
+npm run build
+```
+
+### 2. Run the Metadata Generation Script
+
+```sh
+node scripts/generate-template-metadata.js
+```
+
+### 3. Rebuild to Include New Metadata
+
+```sh
+npm run build
+```
+
+All metadata are generated under `src/modeling/templates/meta` directory as JSON files.
+
+## Best Practices
+
+### Domain Design
+
+1. **Business Alignment**: Model actual business processes and entities
+2. **Clear Naming**: Use business-meaningful names, not technical jargon
+3. **Proper Grouping**: Organize entities into logical namespaces and models
+4. **Semantic Richness**: Apply appropriate semantic annotations for security and behavior
+
+### Code Quality
+
+1. **Documentation**: Include comprehensive JSDoc comments explaining the business purpose
+2. **Type Safety**: Use TypeScript interfaces and proper type annotations
+3. **Error Handling**: Validate inputs and provide clear error messages
+4. **Consistency**: Use helper functions from `helpers/Intelisense.js` for common patterns
+
+### Security
+
+1. **Sensitive Data**: Mark passwords and sensitive fields as `writeOnly`
+2. **Validation**: Validate all user inputs and model structures
+3. **Access Control**: Consider data access patterns in your domain design
+
+## Example Templates
+
+Refer to existing templates for comprehensive examples:
+
+- `ecommerce-domain.ts` - E-commerce platform with users, products, orders
+- `blog-domain.ts` - Content management with publishing workflow
+
+These demonstrate proper structure, semantic usage, and business modeling patterns.

package/src/modeling/templates/template-registry.ts

@@ -0,0 +1,140 @@
+import type { DomainTemplate } from './types.js'
+import {
+  getAllTemplates,
+  getTemplate,
+  getTemplatesByTag,
+  getTemplatesByCategory,
+  searchTemplates,
+  getTemplateStats,
+} from './meta/index.js'
+
+/**
+ * Registry of all available domain templates with their metadata.
+ * This provides a central location for UI components to discover and present templates.
+ *
+ * The templates are pre-processed at build time using the generate-template-metadata.js script
+ * to avoid loading and processing all templates on the client side.
+ */
+// eslint-disable-next-line @typescript-eslint/no-extraneous-class
+export class TemplateRegistry {
+  /**
+   * Gets all available templates
+   */
+  static getAllTemplates(): DomainTemplate[] {
+    return getAllTemplates()
+  }
+
+  /**
+   * Gets a template by its ID
+   */
+  static getTemplate(id: string): DomainTemplate | undefined {
+    return getTemplate(id)
+  }
+
+  /**
+   * Gets templates filtered by tags
+   */
+  static getTemplatesByTag(tag: string): DomainTemplate[] {
+    return getTemplatesByTag(tag)
+  }
+
+  /**
+   * Gets templates filtered by category (based on tags)
+   */
+  static getTemplatesByCategory(category: 'business' | 'content' | 'social' | 'technical'): DomainTemplate[] {
+    return getTemplatesByCategory(category)
+  }
+
+  /**
+   * Gets templates filtered by industry vertical
+   */
+  static getTemplatesByVertical(vertical: string): DomainTemplate[] {
+    // This would need to be implemented in the meta/index.js
+    return getAllTemplates().filter((template) =>
+      template.tags?.some((tag) => tag.toLowerCase().includes(vertical.toLowerCase()))
+    )
+  }
+
+  /**
+   * Gets all available industry verticals
+   */
+  static getIndustryVerticals(): {
+    id: string
+    name: string
+    description: string
+    subcategories: string[]
+    templateCount: number
+  }[] {
+    return [
+      {
+        id: 'business-services',
+        name: 'Business Services',
+        description: 'E-commerce, Financial Services, Legal Services',
+        subcategories: ['E-commerce', 'Financial Services', 'Legal Services'],
+        templateCount: 4,
+      },
+      {
+        id: 'healthcare-life-sciences',
+        name: 'Healthcare & Life Sciences',
+        description: 'Healthcare, Pharmaceutical, Research',
+        subcategories: ['Healthcare', 'Pharmaceutical', 'Research'],
+        templateCount: 1,
+      },
+      {
+        id: 'education-training',
+        name: 'Education & Training',
+        description: 'Education, Corporate Training, Certification',
+        subcategories: ['Education', 'Corporate Training', 'Certification'],
+        templateCount: 1,
+      },
+      {
+        id: 'real-estate-construction',
+        name: 'Real Estate & Construction',
+        description: 'Real Estate, Construction, Property Management',
+        subcategories: ['Real Estate', 'Construction', 'Property Management'],
+        templateCount: 1,
+      },
+      {
+        id: 'manufacturing-logistics',
+        name: 'Manufacturing & Logistics',
+        description: 'Manufacturing, Supply Chain, Distribution',
+        subcategories: ['Manufacturing', 'Supply Chain', 'Distribution'],
+        templateCount: 1,
+      },
+      {
+        id: 'technology-media',
+        name: 'Technology & Media',
+        description: 'Gaming, IoT, Content Management, Social Media',
+        subcategories: ['Gaming', 'IoT', 'Content Management', 'Social Media'],
+        templateCount: 3,
+      },
+      {
+        id: 'public-sector',
+        name: 'Public Sector',
+        description: 'Government, Non-Profit, Healthcare',
+        subcategories: ['Government', 'Non-Profit', 'Healthcare'],
+        templateCount: 1,
+      },
+    ]
+  }
+
+  /**
+   * Searches templates by name or description
+   */
+  static searchTemplates(query: string): DomainTemplate[] {
+    return searchTemplates(query)
+  }
+
+  /**
+   * Gets template statistics for analytics
+   */
+  static getTemplateStats(): {
+    totalTemplates: number
+    totalEntities: number
+    totalProperties: number
+    totalAssociations: number
+    categoryCounts: Record<string, number>
+  } {
+    return getTemplateStats()
+  }
+}