Craft CMS Yardi Templates

Frontend assets and Twig template partials for the Yardi appointment scheduler used in Craft CMS.

Project Layout

• src/js/index.js: scheduler JavaScript entry point
• src/pcss/: PostCSS and Tailwind styles
• template/_yardi_scheduler.twig: Twig partial used by Craft
• dist/: built files published to npm and consumed from CDN

Prerequisites

• Node.js 20.19+ or 22.12+
• npm

Install dependencies from the project root:

npm install

Build The Package

This project uses Vite to generate distributable JS and CSS files in dist/.

Run a production build:

npm run build

The build writes these publishable assets:

• dist/index.es.js
• dist/index.umd.js
• dist/index.iife.js
• dist/index.css
• compressed .gz variants generated by Vite compression

Before publishing, confirm npm run build completes successfully and review the generated dist/ output if you changed bundle structure, CSS, or public behavior.

Publish To npm

This package publishes only the dist/ directory because package.json limits published files with:

"files": ["dist"]

Recommended release workflow:

1. Make and review your source changes.
2. Run npm install if dependencies changed.
3. Run npm run build.
4. Bump the package version in package.json.
5. Verify what npm will publish.
6. Publish from the repository root.
7. Update any template or CDN references that pin a specific package version.

1. Bump The Version

Use npm so package.json stays consistent:

npm version patch

Use minor or major instead when the change warrants it:

npm version minor
npm version major

If you do not want npm version to create a git tag or commit automatically, use:

npm version patch --no-git-tag-version

2. Preview The Package Contents

Check the tarball contents before publishing:

npm pack --dry-run

This is the fastest way to confirm the built dist/ files are included and nothing unexpected is being shipped.

3. Login And Publish

Authenticate with npm if needed:

npm login

Then publish from this repo directory:

npm publish --access public

--access public is important for scoped packages such as @span-studio/craft-yardi-templates.

After Publishing

If downstream Twig templates or CDN includes reference an exact package version, update them to the newly published version. For example, jsDelivr URLs should reference the new tag explicitly when you want deterministic behavior.

Craft Dependencies

Version 1.1.0 requires Craft-side support for secure appointment management links:

• span-studio/craft-yardi >= 2.6.0
• span-studio/craft-formie-yardi-integration >= 1.1.1
• verbb/formie compatible with the active Craft major version
• Working Craft mail transport for management-link emails
• Persistent Craft cache storage for short-lived management tokens

Form Contract

The scheduler renders the canonical Formie form handle:

{{ craft.formie.renderForm('yardiAppointmentForm') }}

Required user/contact field handles remain:

• firstName
• lastName
• email
• phone

Required hidden scheduler fields:

• apptDate
• apptTime
• voyagerProspectId
• voyagerProspectAppointmentId
• appointmentStatus

Recommended hidden scheduler field:

• propertyCode

The JavaScript also adds a runtime-only appointmentAction field with either booking or reschedule. This does not need to be configured as a Formie field.

Appointment Management Endpoints

Cancellation and rescheduling use secure email links provided by craft-formie-yardi-integration.

POST /actions/formie-yardi-integration/appointments/request-access

Body:

• email
• propertyCode
• mode: cancel or reschedule
• manageUrl
• Craft CSRF token when required

The public response should be generic and must not reveal whether matching appointments exist.

POST /actions/formie-yardi-integration/appointments/resolve

Body:

• token
• Craft CSRF token when required

Successful responses should include only safe appointment summaries:

• key
• firstName
• lastName
• email
• date
• time
• sortValue

POST /actions/formie-yardi-integration/appointments/cancel

Body:

• token
• appointmentKey
• Craft CSRF token when required

The integration plugin owns server-side lookup of Yardi prospect and appointment identifiers.

Shared Frontend Behavior

The scheduler dispatches completion events on #yardi-appointments:

• yardi:appointment-completed
• yardi:appointment-booked
• yardi:appointment-cancelled
• yardi:appointment-rescheduled

Version 1.1.0 event payloads are privacy-safe. Allowed fields are:

• action
• isReschedule
• submissionId when available after booking
• selectedDate
• selectedTime
• currentAppointment with safe contact and date/time summary data only

Yardi prospect IDs, appointment IDs, raw Formie submission objects, and hidden Yardi fields are intentionally excluded from public events and rendered appointment summaries.

Migration From 1.0.28

• Replace any Client ID / Appointment ID cancellation instructions with the email-link flow.
• Install/update craft-formie-yardi-integration to 1.1.1 or newer.
• Ensure /schedule-tour can receive links with #manage=<token>.
• Add the recommended propertyCode hidden field for reusable or multi-property deployments.
• Update analytics/listeners that expected prospectId or appointmentId in scheduler event payloads.