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

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

@@ -0,0 +1,269 @@
+/**
+ * Typed custom-object schema definitions for the grant program management example.
+ */
+
+import {
+  date,
+  defineCustomObject,
+  email,
+  formula,
+  longText,
+  lookup,
+  number,
+  parentChild,
+  radio,
+  section,
+  text,
+} from '@rippling/rippling-sdk/core/platform/custom-objects';
+
+/** Logical category shared by the grant program management example. */
+export const GRANTS_CATEGORY = 'grants';
+
+/** Funding-program schema used by grant cycles. */
+export const programDefinition = defineCustomObject({
+  name: 'gpm_program',
+  displayName: 'Program',
+  pluralLabel: 'Programs',
+  category: GRANTS_CATEGORY,
+  description: 'Funding program with annual budget and focus area',
+  sections: {
+    program: section('Program', { sectionId: 'sec_gpm_program' }),
+  },
+  fields: {
+    focus_area: radio({
+      displayName: 'Focus area',
+      description: 'Program focus area',
+      options: ['Education', 'Workforce', 'Climate', 'Health', 'Housing', 'Community safety'],
+      required: true,
+      section: 'program',
+    }),
+    annual_budget_cents: number({
+      displayName: 'Annual budget (cents)',
+      description: 'Annual funding budget in cents',
+      decimalPlaces: 0,
+      section: 'program',
+    }),
+    guidelines: longText({
+      displayName: 'Guidelines',
+      description: 'Eligibility and operating guidelines',
+      maxLength: 8000,
+      section: 'program',
+    }),
+  },
+});
+
+/** Grant-cycle schema tied to a parent program. */
+export const grantDefinition = defineCustomObject({
+  name: 'gpm_grant',
+  displayName: 'Grant',
+  pluralLabel: 'Grants',
+  category: GRANTS_CATEGORY,
+  description: 'Grant cycle under a funding program',
+  sections: {
+    grant: section('Grant', { sectionId: 'sec_gpm_grant' }),
+  },
+  fields: {
+    program_ref: parentChild(programDefinition, {
+      displayName: 'Program',
+      description: 'Program this grant belongs to',
+      relatedDataLabel: 'Grants',
+      parentChildType: 'PRIMARY',
+      enableParentOwnerInheritance: false,
+      section: 'grant',
+    }),
+    status: radio({
+      displayName: 'Status',
+      description: 'Grant cycle status',
+      options: ['Planning', 'Open', 'Review', 'Awarded', 'Closed'],
+      required: true,
+      section: 'grant',
+    }),
+    open_date: date({
+      displayName: 'Open date',
+      description: 'Application open date',
+      section: 'grant',
+    }),
+    close_date: date({
+      displayName: 'Close date',
+      description: 'Application close date',
+      section: 'grant',
+    }),
+    award_budget_cents: number({
+      displayName: 'Award budget (cents)',
+      description: 'Budget allocated to this grant cycle',
+      decimalPlaces: 0,
+      section: 'grant',
+    }),
+  },
+});
+
+/** Applicant schema used by applications. */
+export const applicantDefinition = defineCustomObject({
+  name: 'gpm_applicant',
+  displayName: 'Applicant',
+  pluralLabel: 'Applicants',
+  category: GRANTS_CATEGORY,
+  description: 'Applicant organization and contact details',
+  sections: {
+    applicant: section('Applicant', { sectionId: 'sec_gpm_applicant' }),
+  },
+  fields: {
+    legal_name: text({
+      displayName: 'Legal name',
+      description: 'Applicant organization legal name',
+      maxLength: 200,
+      required: true,
+      section: 'applicant',
+    }),
+    applicant_type: radio({
+      displayName: 'Applicant type',
+      description: 'Applicant organization type',
+      options: ['Nonprofit', 'School', 'Government', 'Small business', 'Community group'],
+      required: true,
+      section: 'applicant',
+    }),
+    contact_email: email({
+      displayName: 'Contact email',
+      description: 'Primary applicant contact email',
+      section: 'applicant',
+    }),
+  },
+});
+
+/** Application schema tied to a grant and applicant. */
+export const applicationDefinition = defineCustomObject({
+  name: 'gpm_application',
+  displayName: 'Application',
+  pluralLabel: 'Applications',
+  category: GRANTS_CATEGORY,
+  description: 'Application submitted by an applicant for a grant',
+  sections: {
+    application: section('Application', { sectionId: 'sec_gpm_application' }),
+  },
+  fields: {
+    grant_ref: parentChild(grantDefinition, {
+      displayName: 'Grant',
+      description: 'Grant cycle this application targets',
+      relatedDataLabel: 'Applications',
+      parentChildType: 'PRIMARY',
+      enableParentOwnerInheritance: false,
+      section: 'application',
+    }),
+    applicant_ref: lookup(applicantDefinition, {
+      displayName: 'Applicant',
+      description: 'Applicant submitting this request',
+      relatedDataLabel: 'Applications',
+      required: true,
+      section: 'application',
+    }),
+    status: radio({
+      displayName: 'Status',
+      description: 'Application review state',
+      options: ['Draft', 'Submitted', 'Eligibility review', 'Panel review', 'Awarded', 'Declined'],
+      required: true,
+      section: 'application',
+    }),
+    requested_amount_cents: number({
+      displayName: 'Requested amount (cents)',
+      description: 'Requested funding amount in cents',
+      decimalPlaces: 0,
+      required: true,
+      section: 'application',
+    }),
+    review_score: number({
+      displayName: 'Review score',
+      description: 'Panel score from 0 to 100',
+      decimalPlaces: 2,
+      section: 'application',
+    }),
+    proposal_summary: longText({
+      displayName: 'Proposal summary',
+      description: 'Program plan and impact narrative',
+      maxLength: 8000,
+      section: 'application',
+    }),
+    review_label: formula.text({
+      displayName: 'Review label',
+      description: 'Review queue label',
+      formula: "CONCATENATE(status__c, ' - score ', review_score__c)",
+      maxLength: 240,
+      section: 'application',
+    }),
+  },
+});
+
+/** Milestone schema tied to a parent application. */
+export const milestoneDefinition = defineCustomObject({
+  name: 'gpm_milestone',
+  displayName: 'Milestone',
+  pluralLabel: 'Milestones',
+  category: GRANTS_CATEGORY,
+  description: 'Deliverable or report due for an awarded application',
+  sections: {
+    milestone: section('Milestone', { sectionId: 'sec_gpm_milestone' }),
+  },
+  fields: {
+    application_ref: parentChild(applicationDefinition, {
+      displayName: 'Application',
+      description: 'Application this milestone belongs to',
+      relatedDataLabel: 'Milestones',
+      parentChildType: 'PRIMARY',
+      enableParentOwnerInheritance: true,
+      section: 'milestone',
+    }),
+    due_date: date({
+      displayName: 'Due date',
+      description: 'Milestone due date',
+      required: true,
+      section: 'milestone',
+    }),
+    status: radio({
+      displayName: 'Status',
+      description: 'Milestone status',
+      options: ['Not started', 'In progress', 'Submitted', 'Accepted', 'Late'],
+      required: true,
+      section: 'milestone',
+    }),
+  },
+});
+
+/** Disbursement schema tied to a parent application. */
+export const disbursementDefinition = defineCustomObject({
+  name: 'gpm_disbursement',
+  displayName: 'Disbursement',
+  pluralLabel: 'Disbursements',
+  category: GRANTS_CATEGORY,
+  description: 'Payment tranche tied to an awarded application',
+  sections: {
+    disbursement: section('Disbursement', { sectionId: 'sec_gpm_disbursement' }),
+  },
+  fields: {
+    application_ref: parentChild(applicationDefinition, {
+      displayName: 'Application',
+      description: 'Application funded by this disbursement',
+      relatedDataLabel: 'Disbursements',
+      parentChildType: 'PRIMARY',
+      enableParentOwnerInheritance: true,
+      section: 'disbursement',
+    }),
+    amount_cents: number({
+      displayName: 'Amount (cents)',
+      description: 'Disbursement amount in cents',
+      decimalPlaces: 0,
+      required: true,
+      section: 'disbursement',
+    }),
+    status: radio({
+      displayName: 'Status',
+      description: 'Disbursement status',
+      options: ['Scheduled', 'Approved', 'Paid', 'Held', 'Cancelled'],
+      required: true,
+      section: 'disbursement',
+    }),
+    disbursement_date: date({
+      displayName: 'Disbursement date',
+      description: 'Scheduled or actual payment date',
+      section: 'disbursement',
+    }),
+  },
+});

package/examples/manifest/gym-membership-management/functions/check-in-desk.ts

@@ -1,28 +1,18 @@
-import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
-import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
+import { FunctionContext, FunctionResponse } from '@rippling/rippling-sdk';
+import {
+  handleTypedObjectListPageEvent,
+  type TypedObjectListPageInput,
+  type TypedObjectListPageOutput,
+} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import { enrollmentDefinition } from '../schema';
 
-const OBJECT = 'gym_class_enrollment__c';
+export type Input = TypedObjectListPageInput;
+
+export type Output = TypedObjectListPageOutput;
 
 export async function onRipplingEvent(
-  event: SduiPageFunctionEvent,
+  event: Input,
   context: FunctionContext,
-): Promise<FunctionResponse> {
-  const action = event.parameters.action;
-
-  if (action === 'init') {
-    const spec = render({
-      root: ObjectListView({
-        props: { objectApiName: OBJECT },
-      }),
-      state: {},
-    });
-    return new FunctionResponse({
-      body: { spec: JSON.stringify(spec) },
-      statusCode: 200,
-      headers: {},
-      message: '',
-    });
-  }
-
-  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });
+): Promise<FunctionResponse<Output>> {
+  return handleTypedObjectListPageEvent(event, context, enrollmentDefinition);
 }

package/examples/manifest/gym-membership-management/functions/member-list.ts

@@ -1,28 +1,18 @@
-import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
-import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
+import { FunctionContext, FunctionResponse } from '@rippling/rippling-sdk';
+import {
+  handleTypedObjectListPageEvent,
+  type TypedObjectListPageInput,
+  type TypedObjectListPageOutput,
+} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import { memberDefinition } from '../schema';
 
-const OBJECT = 'gym_member__c';
+export type Input = TypedObjectListPageInput;
+
+export type Output = TypedObjectListPageOutput;
 
 export async function onRipplingEvent(
-  event: SduiPageFunctionEvent,
+  event: Input,
   context: FunctionContext,
-): Promise<FunctionResponse> {
-  const action = event.parameters.action;
-
-  if (action === 'init') {
-    const spec = render({
-      root: ObjectListView({
-        props: { objectApiName: OBJECT },
-      }),
-      state: {},
-    });
-    return new FunctionResponse({
-      body: { spec: JSON.stringify(spec) },
-      statusCode: 200,
-      headers: {},
-      message: '',
-    });
-  }
-
-  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });
+): Promise<FunctionResponse<Output>> {
+  return handleTypedObjectListPageEvent(event, context, memberDefinition);
 }

package/examples/manifest/gym-membership-management/functions/today-schedule.ts

@@ -1,28 +1,18 @@
-import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
-import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
+import { FunctionContext, FunctionResponse } from '@rippling/rippling-sdk';
+import {
+  handleTypedObjectListPageEvent,
+  type TypedObjectListPageInput,
+  type TypedObjectListPageOutput,
+} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import { sessionDefinition } from '../schema';
 
-const OBJECT = 'gym_class_session__c';
+export type Input = TypedObjectListPageInput;
+
+export type Output = TypedObjectListPageOutput;
 
 export async function onRipplingEvent(
-  event: SduiPageFunctionEvent,
+  event: Input,
   context: FunctionContext,
-): Promise<FunctionResponse> {
-  const action = event.parameters.action;
-
-  if (action === 'init') {
-    const spec = render({
-      root: ObjectListView({
-        props: { objectApiName: OBJECT },
-      }),
-      state: {},
-    });
-    return new FunctionResponse({
-      body: { spec: JSON.stringify(spec) },
-      statusCode: 200,
-      headers: {},
-      message: '',
-    });
-  }
-
-  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });
+): Promise<FunctionResponse<Output>> {
+  return handleTypedObjectListPageEvent(event, context, sessionDefinition);
 }

package/examples/manifest/gym-membership-management/functions/trainer-list.ts

@@ -1,28 +1,18 @@
-import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
-import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
+import { FunctionContext, FunctionResponse } from '@rippling/rippling-sdk';
+import {
+  handleTypedObjectListPageEvent,
+  type TypedObjectListPageInput,
+  type TypedObjectListPageOutput,
+} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import { trainerDefinition } from '../schema';
 
-const OBJECT = 'gym_trainer__c';
+export type Input = TypedObjectListPageInput;
+
+export type Output = TypedObjectListPageOutput;
 
 export async function onRipplingEvent(
-  event: SduiPageFunctionEvent,
+  event: Input,
   context: FunctionContext,
-): Promise<FunctionResponse> {
-  const action = event.parameters.action;
-
-  if (action === 'init') {
-    const spec = render({
-      root: ObjectListView({
-        props: { objectApiName: OBJECT },
-      }),
-      state: {},
-    });
-    return new FunctionResponse({
-      body: { spec: JSON.stringify(spec) },
-      statusCode: 200,
-      headers: {},
-      message: '',
-    });
-  }
-
-  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });
+): Promise<FunctionResponse<Output>> {
+  return handleTypedObjectListPageEvent(event, context, trainerDefinition);
 }