@rippling/rippling-sdk 0.2.0-alpha.82 → 0.2.0-alpha.83

package/examples/manifest/grant-program-management/grant-program-management.ts

@@ -1,5 +1,6 @@
 /*
- * Grant Program Management - programs, grants, applicants, applications, milestones, and disbursements.
+ * Grant Program Management - programs, grants, applicants, applications,
+ * milestones, and disbursements.
  *
  *   gpm_program__c       <- funding program and budget
  *   gpm_grant__c         <- grant cycle under a program
@@ -13,26 +14,24 @@
  *       > examples/manifest/grant-program-management/manifest.json
  */
 
+import { toCustomCategoryApiName } from '@rippling/rippling-sdk/core/platform/custom-objects';
 import {
-  Category,
-  CustomObject,
-  CustomObjectFieldSection,
-  CustomObjectPageLayout,
-  DateField,
-  EmailField,
-  FormulaField,
-  ListViewDef,
-  LongTextField,
-  LookupField,
-  ManifestBuilder,
-  NumberField,
-  ParentChildField,
-  Rule,
-  RadioField,
-  SummaryField,
-  TextField,
-  Validation,
-} from '@rippling/rippling-sdk/lib/manifest';
+  defineBasicTypedPageLayout,
+  defineTypedListView,
+  defineTypedRule,
+  defineTypedValidation,
+  registerManifestCustomObjects,
+} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import { Category, ManifestBuilder, SummaryField } from '@rippling/rippling-sdk/lib/manifest';
+import {
+  applicantDefinition,
+  applicationDefinition,
+  disbursementDefinition,
+  grantDefinition,
+  GRANTS_CATEGORY,
+  milestoneDefinition,
+  programDefinition,
+} from './schema';
 
 const manifest = new ManifestBuilder({
   key: 'grant_program_management',
@@ -41,554 +40,261 @@ const manifest = new ManifestBuilder({
 });
 
 const category = new Category(manifest, {
-  apiName: 'grants__c',
+  apiName: toCustomCategoryApiName(GRANTS_CATEGORY),
   name: 'Grants',
   description: 'Grant program and funding records',
 });
 
-const programObj = new CustomObject(manifest, {
-  apiName: 'gpm_program__c',
-  name: 'Program',
-  pluralLabel: 'Programs',
-  category,
-  description: 'Funding program with annual budget and focus area',
-});
-
-const programSection = new CustomObjectFieldSection(programObj, {
-  name: 'Program',
-  sectionId: 'sec_gpm_program',
-});
-
-const programFocusField = new RadioField(programObj, {
-  apiName: 'focus_area__c',
-  displayName: 'Focus area',
-  description: 'Program focus area',
-  options: ['Education', 'Workforce', 'Climate', 'Health', 'Housing', 'Community safety'],
-  required: true,
-  section: programSection,
-});
-
-const programBudgetCentsField = new NumberField(programObj, {
-  apiName: 'annual_budget_cents__c',
-  displayName: 'Annual budget (cents)',
-  description: 'Annual funding budget in cents',
-  decimalPlaces: 0,
-  section: programSection,
-});
-
-const programGuidelinesField = new LongTextField(programObj, {
-  apiName: 'guidelines__c',
-  displayName: 'Guidelines',
-  description: 'Eligibility and operating guidelines',
-  maxLength: 8000,
-  section: programSection,
-});
-
-const grantObj = new CustomObject(manifest, {
-  apiName: 'gpm_grant__c',
-  name: 'Grant',
-  pluralLabel: 'Grants',
-  category,
-  description: 'Grant cycle under a funding program',
-});
-
-const grantSection = new CustomObjectFieldSection(grantObj, {
-  name: 'Grant',
-  sectionId: 'sec_gpm_grant',
-});
-
-const grantProgramRef = new ParentChildField(grantObj, {
-  apiName: 'program_ref__c',
-  displayName: 'Program',
-  target: programObj,
-  relatedDataLabel: 'Grants',
-  parentChildType: 'PRIMARY',
-  enableParentOwnerInheritance: false,
-  description: 'Program this grant belongs to',
-  section: grantSection,
-});
-
-const grantStatusField = new RadioField(grantObj, {
-  apiName: 'status__c',
-  displayName: 'Status',
-  description: 'Grant cycle status',
-  options: ['Planning', 'Open', 'Review', 'Awarded', 'Closed'],
-  required: true,
-  section: grantSection,
-});
-
-const grantOpenDateField = new DateField(grantObj, {
-  apiName: 'open_date__c',
-  displayName: 'Open date',
-  description: 'Application open date',
-  section: grantSection,
-});
-
-const grantCloseDateField = new DateField(grantObj, {
-  apiName: 'close_date__c',
-  displayName: 'Close date',
-  description: 'Application close date',
-  section: grantSection,
-});
-
-const grantAwardBudgetCentsField = new NumberField(grantObj, {
-  apiName: 'award_budget_cents__c',
-  displayName: 'Award budget (cents)',
-  description: 'Budget allocated to this grant cycle',
-  decimalPlaces: 0,
-  section: grantSection,
-});
-
-const applicantObj = new CustomObject(manifest, {
-  apiName: 'gpm_applicant__c',
-  name: 'Applicant',
-  pluralLabel: 'Applicants',
-  category,
-  description: 'Applicant organization and contact details',
-});
-
-const applicantSection = new CustomObjectFieldSection(applicantObj, {
-  name: 'Applicant',
-  sectionId: 'sec_gpm_applicant',
-});
-
-const applicantLegalNameField = new TextField(applicantObj, {
-  apiName: 'legal_name__c',
-  displayName: 'Legal name',
-  description: 'Applicant organization legal name',
-  maxLength: 200,
-  required: true,
-  section: applicantSection,
-});
-
-const applicantTypeField = new RadioField(applicantObj, {
-  apiName: 'applicant_type__c',
-  displayName: 'Applicant type',
-  description: 'Applicant organization type',
-  options: ['Nonprofit', 'School', 'Government', 'Small business', 'Community group'],
-  required: true,
-  section: applicantSection,
-});
-
-const applicantEmailField = new EmailField(applicantObj, {
-  apiName: 'contact_email__c',
-  displayName: 'Contact email',
-  description: 'Primary applicant contact email',
-  section: applicantSection,
-});
-
-const applicationObj = new CustomObject(manifest, {
-  apiName: 'gpm_application__c',
-  name: 'Application',
-  pluralLabel: 'Applications',
-  category,
-  description: 'Application submitted by an applicant for a grant',
-});
-
-const applicationSection = new CustomObjectFieldSection(applicationObj, {
-  name: 'Application',
-  sectionId: 'sec_gpm_application',
-});
-
-const applicationGrantRef = new ParentChildField(applicationObj, {
-  apiName: 'grant_ref__c',
-  displayName: 'Grant',
-  target: grantObj,
-  relatedDataLabel: 'Applications',
-  parentChildType: 'PRIMARY',
-  enableParentOwnerInheritance: false,
-  description: 'Grant cycle this application targets',
-  section: applicationSection,
-});
-
-const applicationApplicantRef = new LookupField(applicationObj, {
-  apiName: 'applicant_ref__c',
-  displayName: 'Applicant',
-  target: applicantObj,
-  relatedDataLabel: 'Applications',
-  description: 'Applicant submitting this request',
-  required: true,
-  section: applicationSection,
-});
-
-const applicationStatusField = new RadioField(applicationObj, {
-  apiName: 'status__c',
-  displayName: 'Status',
-  description: 'Application review state',
-  options: ['Draft', 'Submitted', 'Eligibility review', 'Panel review', 'Awarded', 'Declined'],
-  required: true,
-  section: applicationSection,
-});
-
-const requestedAmountCentsField = new NumberField(applicationObj, {
-  apiName: 'requested_amount_cents__c',
-  displayName: 'Requested amount (cents)',
-  description: 'Requested funding amount in cents',
-  decimalPlaces: 0,
-  required: true,
-  section: applicationSection,
-});
-
-const scoreField = new NumberField(applicationObj, {
-  apiName: 'review_score__c',
-  displayName: 'Review score',
-  description: 'Panel score from 0 to 100',
-  decimalPlaces: 2,
-  section: applicationSection,
-});
-
-const proposalSummaryField = new LongTextField(applicationObj, {
-  apiName: 'proposal_summary__c',
-  displayName: 'Proposal summary',
-  description: 'Program plan and impact narrative',
-  maxLength: 8000,
-  section: applicationSection,
-});
-
-const milestoneObj = new CustomObject(manifest, {
-  apiName: 'gpm_milestone__c',
-  name: 'Milestone',
-  pluralLabel: 'Milestones',
-  category,
-  description: 'Deliverable or report due for an awarded application',
-});
-
-const milestoneSection = new CustomObjectFieldSection(milestoneObj, {
-  name: 'Milestone',
-  sectionId: 'sec_gpm_milestone',
-});
-
-const milestoneApplicationRef = new ParentChildField(milestoneObj, {
-  apiName: 'application_ref__c',
-  displayName: 'Application',
-  target: applicationObj,
-  relatedDataLabel: 'Milestones',
-  parentChildType: 'PRIMARY',
-  enableParentOwnerInheritance: true,
-  description: 'Application this milestone belongs to',
-  section: milestoneSection,
-});
-
-const milestoneDueDateField = new DateField(milestoneObj, {
-  apiName: 'due_date__c',
-  displayName: 'Due date',
-  description: 'Milestone due date',
-  required: true,
-  section: milestoneSection,
-});
-
-const milestoneStatusField = new RadioField(milestoneObj, {
-  apiName: 'status__c',
-  displayName: 'Status',
-  description: 'Milestone status',
-  options: ['Not started', 'In progress', 'Submitted', 'Accepted', 'Late'],
-  required: true,
-  section: milestoneSection,
-});
-
-const disbursementObj = new CustomObject(manifest, {
-  apiName: 'gpm_disbursement__c',
-  name: 'Disbursement',
-  pluralLabel: 'Disbursements',
-  category,
-  description: 'Payment tranche tied to an awarded application',
-});
-
-const disbursementSection = new CustomObjectFieldSection(disbursementObj, {
-  name: 'Disbursement',
-  sectionId: 'sec_gpm_disbursement',
-});
-
-const disbursementApplicationRef = new ParentChildField(disbursementObj, {
-  apiName: 'application_ref__c',
-  displayName: 'Application',
-  target: applicationObj,
-  relatedDataLabel: 'Disbursements',
-  parentChildType: 'PRIMARY',
-  enableParentOwnerInheritance: true,
-  description: 'Application funded by this disbursement',
-  section: disbursementSection,
-});
-
-const disbursementAmountCentsField = new NumberField(disbursementObj, {
-  apiName: 'amount_cents__c',
-  displayName: 'Amount (cents)',
-  description: 'Disbursement amount in cents',
-  decimalPlaces: 0,
-  required: true,
-  section: disbursementSection,
-});
-
-const disbursementStatusField = new RadioField(disbursementObj, {
-  apiName: 'status__c',
-  displayName: 'Status',
-  description: 'Disbursement status',
-  options: ['Scheduled', 'Approved', 'Paid', 'Held', 'Cancelled'],
-  required: true,
-  section: disbursementSection,
-});
-
-const disbursementDateField = new DateField(disbursementObj, {
-  apiName: 'disbursement_date__c',
-  displayName: 'Disbursement date',
-  description: 'Scheduled or actual payment date',
-  section: disbursementSection,
-});
-
-const grantCountOnProgram = new SummaryField(programObj, {
+const [program, grant, applicant, application, milestone, disbursement] = registerManifestCustomObjects(
+  manifest,
+  {
+    category,
+    definitions: [
+      programDefinition,
+      grantDefinition,
+      applicantDefinition,
+      applicationDefinition,
+      milestoneDefinition,
+      disbursementDefinition,
+    ] as const,
+  },
+);
+
+const grantCountOnProgram = new SummaryField(program.object, {
   apiName: 'grant_count__c',
   displayName: 'Grants',
-  aggregates: grantStatusField,
+  aggregates: grant.fields.status,
   using: 'COUNT',
-  lookup: grantProgramRef,
+  lookup: grant.fields.program_ref,
   description: 'Grant cycles under this program',
-  section: programSection,
+  section: program.sections.program,
 });
 
-const applicationCountOnGrant = new SummaryField(grantObj, {
+const applicationCountOnGrant = new SummaryField(grant.object, {
   apiName: 'application_count__c',
   displayName: 'Applications',
-  aggregates: applicationApplicantRef,
+  aggregates: application.fields.applicant_ref,
   using: 'COUNT',
-  lookup: applicationGrantRef,
+  lookup: application.fields.grant_ref,
   description: 'Applications submitted for this grant',
-  section: grantSection,
+  section: grant.sections.grant,
 });
 
-const requestedAmountOnGrant = new SummaryField(grantObj, {
+const requestedAmountOnGrant = new SummaryField(grant.object, {
   apiName: 'requested_amount_cents_total__c',
   displayName: 'Requested amount total (cents)',
-  aggregates: requestedAmountCentsField,
+  aggregates: application.fields.requested_amount_cents,
   using: 'SUM',
-  lookup: applicationGrantRef,
+  lookup: application.fields.grant_ref,
   description: 'Total requested funding for this grant',
-  section: grantSection,
+  section: grant.sections.grant,
 });
 
-const milestoneCountOnApplication = new SummaryField(applicationObj, {
+const milestoneCountOnApplication = new SummaryField(application.object, {
   apiName: 'milestone_count__c',
   displayName: 'Milestones',
-  aggregates: milestoneStatusField,
+  aggregates: milestone.fields.status,
   using: 'COUNT',
-  lookup: milestoneApplicationRef,
+  lookup: milestone.fields.application_ref,
   description: 'Milestones attached to this application',
-  section: applicationSection,
+  section: application.sections.application,
 });
 
-const disbursedAmountOnApplication = new SummaryField(applicationObj, {
+const disbursedAmountOnApplication = new SummaryField(application.object, {
   apiName: 'disbursed_amount_cents__c',
   displayName: 'Disbursed amount (cents)',
-  aggregates: disbursementAmountCentsField,
+  aggregates: disbursement.fields.amount_cents,
   using: 'SUM',
-  lookup: disbursementApplicationRef,
+  lookup: disbursement.fields.application_ref,
   description: 'Total disbursements for this application',
-  section: applicationSection,
+  section: application.sections.application,
 });
 
-const applicationLabelField = new FormulaField(applicationObj, {
-  apiName: 'review_label__c',
-  displayName: 'Review label',
-  description: 'Review queue label',
-  fieldType: 'TEXT',
-  maxLength: 240,
-  formula: "CONCATENATE(status__c, ' - score ', review_score__c)",
-  section: applicationSection,
-});
-
-new Validation(grantObj, {
+// ── Validations & defaults ────────────────────────────────────────────────
+defineTypedValidation(grant, {
   ruleId: 'gpm_grant_close_after_open',
   displayName: 'Close date must be after open date',
-  rqlFormula: '(close_date__c <= open_date__c)',
+  whenInvalid: (c) => c.lte(c.fields.close_date, c.fields.open_date),
   errorMessage: 'Close date must be after open date.',
   ruleDescription: 'Prevents inverted application windows',
   state: 'ACTIVE',
   level: 'FIELD',
-  fieldRef: grantCloseDateField,
+  field: 'close_date',
 });
 
-new Validation(applicationObj, {
+defineTypedValidation(application, {
   ruleId: 'gpm_requested_amount_positive',
   displayName: 'Requested amount must be positive',
-  rqlFormula: '(requested_amount_cents__c <= 0)',
+  whenInvalid: (c) => c.lte(c.fields.requested_amount_cents, 0),
   errorMessage: 'Requested amount must be greater than zero.',
   ruleDescription: 'Blocks zero-value applications',
   state: 'ACTIVE',
   level: 'FIELD',
-  fieldRef: requestedAmountCentsField,
+  field: 'requested_amount_cents',
 });
 
-new Validation(applicationObj, {
+defineTypedValidation(application, {
   ruleId: 'gpm_review_score_range',
   displayName: 'Review score must be 0-100',
-  rqlFormula: '((review_score__c < 0) OR (review_score__c > 100))',
+  whenInvalid: (c) => c.or(c.lt(c.fields.review_score, 0), c.gt(c.fields.review_score, 100)),
   errorMessage: 'Review score must be between 0 and 100.',
   ruleDescription: 'Keeps panel scores in range',
   state: 'ACTIVE',
   level: 'FIELD',
-  fieldRef: scoreField,
+  field: 'review_score',
 });
 
-new Rule(applicationObj, {
+defineTypedRule(application, {
   flowId: 'gpm_default_application_status',
   flowName: 'Default application status',
   triggerType: 'CREATE',
   description: 'New applications start as Draft',
-  actions: [{ targetField: applicationStatusField, fixedValue: 'Draft' }],
+  actions: (rules) => [rules.setField('status').toValue('Draft')],
 });
 
-new Rule(milestoneObj, {
+defineTypedRule(milestone, {
   flowId: 'gpm_default_milestone_status',
   flowName: 'Default milestone status',
   triggerType: 'CREATE',
   description: 'New milestones start Not started',
-  actions: [{ targetField: milestoneStatusField, fixedValue: 'Not started' }],
+  actions: (rules) => [rules.setField('status').toValue('Not started')],
 });
 
-new ListViewDef(programObj, {
+// ── List views ─────────────────────────────────────────────────────────────
+defineTypedListView(program, {
   viewId: 'view_gpm_programs',
   name: 'Programs',
   description: 'Funding programs with budgets and grant counts',
-  fields: ['name', programFocusField, programBudgetCentsField, grantCountOnProgram],
+  fields: ['name', 'focus_area', 'annual_budget_cents', grantCountOnProgram],
   orderBy: 'name',
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
 });
 
-new ListViewDef(grantObj, {
+defineTypedListView(grant, {
   viewId: 'view_gpm_grants',
   name: 'Grants',
   description: 'Grant cycles with application and requested amount rollups',
   fields: [
     'name',
-    grantProgramRef,
-    grantStatusField,
-    grantOpenDateField,
-    grantCloseDateField,
-    grantAwardBudgetCentsField,
+    'program_ref',
+    'status',
+    'open_date',
+    'close_date',
+    'award_budget_cents',
     applicationCountOnGrant,
     requestedAmountOnGrant,
   ],
-  orderBy: grantCloseDateField,
+  orderBy: 'close_date',
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
 });
 
-new ListViewDef(applicantObj, {
+defineTypedListView(applicant, {
   viewId: 'view_gpm_applicants',
   name: 'Applicants',
   description: 'Applicant directory',
-  fields: ['name', applicantLegalNameField, applicantTypeField, applicantEmailField],
-  orderBy: applicantLegalNameField,
+  fields: ['name', 'legal_name', 'applicant_type', 'contact_email'],
+  orderBy: 'legal_name',
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
 });
 
-new ListViewDef(applicationObj, {
+defineTypedListView(application, {
   viewId: 'view_gpm_applications',
   name: 'Applications',
   description: 'Application review queue',
   fields: [
     'name',
-    applicationGrantRef,
-    applicationApplicantRef,
-    applicationStatusField,
-    requestedAmountCentsField,
-    scoreField,
+    'grant_ref',
+    'applicant_ref',
+    'status',
+    'requested_amount_cents',
+    'review_score',
     milestoneCountOnApplication,
     disbursedAmountOnApplication,
-    applicationLabelField,
+    'review_label',
   ],
-  orderBy: scoreField,
+  orderBy: 'review_score',
   sortOrder: 'DESC',
   isPublic: true,
   objectScope: 'all',
 });
 
-new ListViewDef(milestoneObj, {
+defineTypedListView(milestone, {
   viewId: 'view_gpm_milestones',
   name: 'Milestones',
   description: 'Deliverables and report deadlines',
-  fields: ['name', milestoneApplicationRef, milestoneDueDateField, milestoneStatusField],
-  orderBy: milestoneDueDateField,
+  fields: ['name', 'application_ref', 'due_date', 'status'],
+  orderBy: 'due_date',
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
 });
 
-new ListViewDef(disbursementObj, {
+defineTypedListView(disbursement, {
   viewId: 'view_gpm_disbursements',
   name: 'Disbursements',
   description: 'Payment tranches by application',
-  fields: [
-    'name',
-    disbursementApplicationRef,
-    disbursementAmountCentsField,
-    disbursementStatusField,
-    disbursementDateField,
-  ],
-  orderBy: disbursementDateField,
+  fields: ['name', 'application_ref', 'amount_cents', 'status', 'disbursement_date'],
+  orderBy: 'disbursement_date',
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
 });
 
-CustomObjectPageLayout.basic(programObj, {
-  section: programSection,
-  fields: ['name', programFocusField, programBudgetCentsField, grantCountOnProgram, programGuidelinesField],
+// ── Page layouts ───────────────────────────────────────────────────────────
+defineBasicTypedPageLayout(program, {
+  section: program.sections.program,
+  fields: ['name', 'focus_area', 'annual_budget_cents', grantCountOnProgram, 'guidelines'],
 });
 
-CustomObjectPageLayout.basic(grantObj, {
-  section: grantSection,
+defineBasicTypedPageLayout(grant, {
+  section: grant.sections.grant,
   fields: [
     'name',
-    grantProgramRef,
-    grantStatusField,
-    grantOpenDateField,
-    grantCloseDateField,
-    grantAwardBudgetCentsField,
+    'program_ref',
+    'status',
+    'open_date',
+    'close_date',
+    'award_budget_cents',
     applicationCountOnGrant,
     requestedAmountOnGrant,
   ],
 });
 
-CustomObjectPageLayout.basic(applicantObj, {
-  section: applicantSection,
-  fields: ['name', applicantLegalNameField, applicantTypeField, applicantEmailField],
+defineBasicTypedPageLayout(applicant, {
+  section: applicant.sections.applicant,
+  fields: ['name', 'legal_name', 'applicant_type', 'contact_email'],
 });
 
-CustomObjectPageLayout.basic(applicationObj, {
-  section: applicationSection,
+defineBasicTypedPageLayout(application, {
+  section: application.sections.application,
   fields: [
     'name',
-    applicationGrantRef,
-    applicationApplicantRef,
-    applicationStatusField,
-    requestedAmountCentsField,
-    scoreField,
+    'grant_ref',
+    'applicant_ref',
+    'status',
+    'requested_amount_cents',
+    'review_score',
     milestoneCountOnApplication,
     disbursedAmountOnApplication,
-    applicationLabelField,
-    proposalSummaryField,
+    'review_label',
+    'proposal_summary',
   ],
 });
 
-CustomObjectPageLayout.basic(milestoneObj, {
-  section: milestoneSection,
-  fields: ['name', milestoneApplicationRef, milestoneDueDateField, milestoneStatusField],
+defineBasicTypedPageLayout(milestone, {
+  section: milestone.sections.milestone,
+  fields: ['name', 'application_ref', 'due_date', 'status'],
 });
 
-CustomObjectPageLayout.basic(disbursementObj, {
-  section: disbursementSection,
-  fields: [
-    'name',
-    disbursementApplicationRef,
-    disbursementAmountCentsField,
-    disbursementStatusField,
-    disbursementDateField,
-  ],
+defineBasicTypedPageLayout(disbursement, {
+  section: disbursement.sections.disbursement,
+  fields: ['name', 'application_ref', 'amount_cents', 'status', 'disbursement_date'],
 });
 
 console.log(manifest.preview());