@vicacha-devs/strapi-plugin-events 0.0.0-stage → 1.0.0

package/dist/shared/pluginId.d.ts

@@ -0,0 +1,4 @@
+export declare const PLUGIN_ID = "events";
+export declare const RRULE_CUSTOM_FIELD_UID = "plugin::events.rrule";
+export declare const EVENT_CONTENT_TYPE_UID = "plugin::events.event";
+export declare const REGISTRATION_CONTENT_TYPE_UID = "plugin::events.registration";

package/dist/shared/rruleEngine.d.ts

@@ -0,0 +1,20 @@
+import { ExpandedSlot, parseRRule } from '../../strapi-plugin-calendar/shared/index.ts';
+import { OccurrenceOverride, ParsedRRule, RRuleFieldValue } from './types';
+export type RawOccurrenceSlot = ExpandedSlot;
+export { parseRRule };
+export declare function isValidCalendarDateKey(dateStr: string): boolean;
+export declare function toDateKey(dateInput: Date | string): string;
+export declare function normalizeRRuleString(raw: string | undefined | null): string;
+export declare function sanitizeOccurrenceOverrides(rawOverrides: Record<string, OccurrenceOverride> | undefined): Record<string, OccurrenceOverride>;
+export declare function sanitizeRRuleFieldValue(rec: RRuleFieldValue | null | undefined, defaultTimezone?: string): RRuleFieldValue;
+export declare function parseRRuleFieldValue(raw: unknown, defaultTimezone?: string): RRuleFieldValue;
+export declare function buildRRule(parsed: Partial<ParsedRRule>): string;
+export declare function describeRRule(rruleString: string | undefined | null): string;
+export declare function expandRuleSlots(options: {
+    baseStartDate: string;
+    baseEndDate?: string | null;
+    recurrence: RRuleFieldValue;
+    windowStart: string | Date;
+    windowEnd: string | Date;
+    maxInstances?: number;
+}): RawOccurrenceSlot[];

package/dist/shared/spotlightHelpers.d.ts

@@ -0,0 +1,17 @@
+import { EventLifecycleStatus, EventSourceMapping, EventSpotlightConfig, ExpandedOccurrence } from './types';
+import { isSafeObjectKey, normalizeEventActionLinks, normalizeEventPoster, sanitizeEventUrl, sanitizePlainRecord } from './urlAndPosterHelpers';
+export { isSafeObjectKey, normalizeEventActionLinks, normalizeEventPoster, sanitizeEventUrl, sanitizePlainRecord, };
+export declare function normalizeEventSpotlightConfig(rawConfig: unknown): EventSpotlightConfig | undefined;
+export declare function isEventSpotlightActiveOnDate(params: {
+    spotlightConfig?: EventSpotlightConfig;
+    eventStartDate: string;
+    eventEndDate?: string | null;
+    referenceDate?: string | Date;
+}): boolean;
+export declare function deduplicateAndSortSpotlights(occurrences: ExpandedOccurrence[]): ExpandedOccurrence[];
+export declare function resolveStartEndFromDocument(doc: Record<string, unknown>, source: EventSourceMapping): {
+    startDate: string;
+    endDate: string | null;
+    allDay: boolean;
+} | null;
+export declare function mapEventStatus(rawStatus: unknown): EventLifecycleStatus;

package/dist/shared/types.d.ts

@@ -0,0 +1,309 @@
+export type RRuleFrequency = "NONE" | "DAILY" | "WEEKLY" | "MONTHLY" | "YEARLY";
+export type RRuleWeekday = "MO" | "TU" | "WE" | "TH" | "FR" | "SA" | "SU";
+export type EventLifecycleStatus = "scheduled" | "cancelled" | "postponed" | "rescheduled";
+export type EventLocationType = "in_person" | "online" | "hybrid";
+export type RsvpStatus = "confirmed" | "waitlisted" | "cancelled" | "checked_in";
+export interface OccurrenceOverride {
+    /** Original occurrence ISO date (YYYY-MM-DD) */
+    originalDate: string;
+    /** Whether this specific occurrence is cancelled */
+    cancelled?: boolean;
+    /** Optional overridden start ISO datetime */
+    startDate?: string;
+    /** Optional overridden end ISO datetime */
+    endDate?: string;
+    /** Optional overridden title for this occurrence */
+    title?: string;
+    /** Optional overridden location for this occurrence */
+    location?: string;
+    /** Optional note for attendees on this occurrence */
+    note?: string;
+}
+export interface RRuleFieldValue {
+    /** RFC 5545 RRULE string (e.g. "FREQ=WEEKLY;INTERVAL=1;BYDAY=FR") or empty string for non-recurring */
+    rrule: string;
+    /** IANA timezone identifier (e.g. "UTC", "America/New_York", "America/Bogota") */
+    timezone: string;
+    /** Whether the event spans full days */
+    allDay?: boolean;
+    /** Excluded occurrence dates in YYYY-MM-DD format */
+    exdates?: string[];
+    /** Per-occurrence overrides keyed by YYYY-MM-DD */
+    overrides?: Record<string, OccurrenceOverride>;
+}
+export interface ParsedRRule {
+    freq: RRuleFrequency;
+    interval: number;
+    byDay: RRuleWeekday[];
+    byMonthDay?: number;
+    count?: number;
+    until?: string;
+}
+export interface TimeSlotWindow {
+    /** Start time in HH:mm:ss format (e.g. "09:00:00") */
+    start: string;
+    /** End time in HH:mm:ss format (e.g. "11:00:00") */
+    end: string;
+}
+export interface CalendarSystemConfig {
+    /** Unique identifier for this calendar system (e.g. "hijri", "hebrew", "persian", "fiscal") */
+    id: string;
+    /** Human-readable display label (e.g. "Hijri (Umm al-Qura)", "Hebrew", "Persian") */
+    label: string;
+    /** Unicode BCP 47 calendar identifier (e.g. "islamic-umalqura", "hebrew", "persian", "buddhist", "chinese") or custom formatter ID */
+    intlCalendar: string;
+    /** Optional BCP 47 locale tag for formatting (defaults to current request/UI locale) */
+    locale?: string;
+    /** Optional day offset (-2 to +2) for lunar sighting or regional adjustments */
+    dayOffset?: number;
+    /** Optional document field name that overrides the auto-computed date when non-empty (e.g. "hijriDate") */
+    overrideField?: string;
+    /** Whether this calendar system is active in the Admin Calendar & Occurrence APIs */
+    enabled: boolean;
+}
+export type CalendarSystemFormatterFn = (date: Date, context: {
+    locale: string;
+    system: CalendarSystemConfig;
+    compact: boolean;
+}) => string;
+export interface AlternateDateValue {
+    calendarId: string;
+    label: string;
+    formatted: string;
+    compact?: string;
+    intlCalendar?: string;
+    isOverridden?: boolean;
+}
+export interface EventPosterAsset {
+    /** Safe relative or https/http URL to the poster image or document */
+    url: string;
+    /** Accessible alt text for the poster */
+    alt?: string;
+    /** MIME type (e.g., "image/webp", "image/jpeg", "application/pdf") */
+    mime?: string;
+    /** Intrinsic width in pixels if available */
+    width?: number;
+    /** Intrinsic height in pixels if available */
+    height?: number;
+}
+export type EventActionLinkVariant = "primary" | "secondary" | "outline";
+export interface EventActionLink {
+    /** Human-readable CTA button or resource link label */
+    label: string;
+    /** Safe destination URL (https://, http://, mailto:, or relative /path) */
+    url: string;
+    /** Visual button style variant */
+    variant?: EventActionLinkVariant;
+    /** Whether the link opens in a new tab with rel="noopener noreferrer" */
+    external?: boolean;
+    /** Optional icon identifier */
+    icon?: string;
+}
+export type EventSpotlightPosition = "bottom-end" | "bottom-start";
+export interface EventSpotlightConfig {
+    /** Whether this event is promoted in the floating Spotlight corner dock */
+    enabled: boolean;
+    /** Optional generic badge label (e.g. "Open Registration", "Featured", "Convocatoria") */
+    badgeText?: string;
+    /** Sorting priority in the dock when multiple spotlights are active (higher = first) */
+    priority?: number;
+    /** Logical corner placement (supports LTR and RTL layouts) */
+    position?: EventSpotlightPosition;
+    /** Whether to display a live remaining-days countdown badge until endAt/endDate */
+    showCountdown?: boolean;
+    /** Optional ISO date/datetime when the spotlight starts appearing (defaults to startDate) */
+    startAt?: string;
+    /** Optional ISO date/datetime when the spotlight stops appearing (defaults to endDate) */
+    endAt?: string;
+}
+export interface EventSourceMapping {
+    /** Unique identifier for this source mapping (e.g. "builtin-events", "workshops", "bookings") */
+    id: string;
+    /** Human-readable label shown in Calendar filter pills */
+    label: string;
+    /** Strapi Content-Type UID (e.g. "plugin::events.event", "api::event.event") */
+    uid: string;
+    /** Hex color used on the calendar grid (e.g. "#0D9488") */
+    color: string;
+    /** Whether this source is enabled on the calendar & occurrence APIs */
+    enabled: boolean;
+    /** Field mapping on the target collection type */
+    fields: {
+        title: string;
+        startDate: string;
+        endDate?: string;
+        rrule?: string;
+        location?: string;
+        category?: string;
+        status?: string;
+        summary?: string;
+        slug?: string;
+        capacity?: string;
+        rsvpEnabled?: string;
+        timeSlot?: string;
+        /** Optional field name for the event poster media or asset object */
+        poster?: string;
+        /** Optional field name for structured CTA / resource links JSON array */
+        actionLinks?: string;
+        /** Optional field name for floating corner spotlight configuration JSON */
+        spotlightConfig?: string;
+        /** Optional mapping of calendar system IDs to document override fields (e.g. { hijri: "hijriDate" }) */
+        alternateDateFields?: Record<string, string>;
+        /** Optional list of custom document attributes to pass through onto each ExpandedOccurrence */
+        customFields?: string[];
+    };
+    /** Optional custom mapping from timeSlot enum values to start/end times */
+    timeSlotMap?: Record<string, TimeSlotWindow>;
+    /** Optional category-to-color overrides */
+    categoryColors?: Record<string, string>;
+    /** Default allDay flag when endDate is omitted and startDate is date-only */
+    defaultAllDay?: boolean;
+}
+export interface RecurrencePreset {
+    /** Unique identifier for the preset (e.g. "daily", "weekly-fri") */
+    id: string;
+    /** Human-readable preset label */
+    label: string;
+    /** RFC 5545 RRULE string */
+    rrule: string;
+}
+export interface SchemaExtensionsConfig {
+    /** Additional Strapi attributes merged into `plugin::events.event` during register() */
+    event?: Record<string, Record<string, unknown>>;
+    /** Additional Strapi attributes merged into `plugin::events.registration` during register() */
+    registration?: Record<string, Record<string, unknown>>;
+}
+export interface EventsPluginSettings {
+    /** Default IANA timezone (e.g. "UTC") */
+    defaultTimezone: string;
+    /** Optional default locale for querying localized event sources (e.g. "es", "en", "auto") */
+    defaultLocale?: string;
+    /** Default seat capacity when RSVP is enabled on an event */
+    defaultCapacity: number;
+    /** Automatically place excess registrations on the waitlist when capacity is full */
+    waitlistEnabledByDefault: boolean;
+    /** Maximum party size per single registration */
+    defaultMaxGuestsPerRegistration: number;
+    /** Send confirmation / waitlist promotion emails via Strapi email plugin */
+    sendRsvpEmails: boolean;
+    /** Public iCal feed calendar name */
+    feedTitle: string;
+    /** Configured event collection sources */
+    sources: EventSourceMapping[];
+    /** Optional secondary/alternative calendar systems (e.g. Hijri, Hebrew, Persian, Buddhist, or custom) */
+    secondaryCalendars?: CalendarSystemConfig[];
+    /** Configurable RRULE recurrence presets shown in Quick-Create & RRuleInput */
+    recurrencePresets?: RecurrencePreset[];
+    /** Declarative attribute extensions merged into built-in plugin schemas during register() */
+    schemaExtensions?: SchemaExtensionsConfig;
+}
+export interface CalendarLinkSet {
+    google: string;
+    outlook: string;
+    yahoo: string;
+    icsPath: string;
+}
+export interface RsvpStats {
+    eventUid: string;
+    eventDocumentId: string;
+    occurrenceDate: string | null;
+    rsvpEnabled: boolean;
+    capacity: number | null;
+    waitlistEnabled: boolean;
+    confirmedCount: number;
+    confirmedSeats: number;
+    checkedInSeats: number;
+    waitlistedCount: number;
+    waitlistedSeats: number;
+    cancelledCount: number;
+    remainingSeats: number | null;
+    isFull: boolean;
+}
+export interface ExpandedOccurrence {
+    /** Deterministic ID: `${sourceId}:${documentId}:${occurrenceDate}` */
+    occurrenceId: string;
+    /** Source mapping ID */
+    sourceId: string;
+    /** Source display label */
+    sourceLabel: string;
+    /** Strapi Content-Type UID */
+    uid: string;
+    /** Strapi v5 documentId */
+    documentId: string;
+    /** Document locale code when localized via Strapi i18n (e.g. "es", "en") */
+    locale?: string;
+    /** Occurrence date key (YYYY-MM-DD) */
+    occurrenceDate: string;
+    /** Effective start ISO timestamp */
+    startDate: string;
+    /** Effective end ISO timestamp */
+    endDate: string;
+    /** All-day flag */
+    allDay: boolean;
+    /** IANA timezone */
+    timezone: string;
+    /** Event title */
+    title: string;
+    /** Optional slug */
+    slug?: string;
+    /** Optional summary */
+    summary?: string;
+    /** Physical location or venue */
+    location?: string;
+    /** Virtual meeting URL */
+    virtualUrl?: string;
+    /** Category string */
+    category?: string;
+    /** Lifecycle status */
+    status: EventLifecycleStatus;
+    /** Hex badge color */
+    color: string;
+    /** Whether generated from an RRULE recurrence */
+    isRecurring: boolean;
+    /** Raw RRULE string if recurring */
+    rrule?: string;
+    /** Whether this specific occurrence has an override applied */
+    isOverridden?: boolean;
+    /** RSVP availability stats */
+    rsvp?: RsvpStats;
+    /** Add-to-calendar links */
+    calendarLinks: CalendarLinkSet;
+    /** Alternate calendar representations (e.g., Hijri, Hebrew, Persian, or custom date systems) */
+    alternateDates?: Record<string, AlternateDateValue>;
+    /** Normalized poster media or asset if configured on the event */
+    poster?: EventPosterAsset;
+    /** Normalized CTA / resource action links */
+    actionLinks?: EventActionLink[];
+    /** Normalized floating corner spotlight configuration */
+    spotlightConfig?: EventSpotlightConfig;
+    /** Custom fields extracted from the source document via `source.fields.customFields` */
+    customFields?: Record<string, unknown>;
+}
+export interface RsvpRegistrationInput {
+    eventUid?: string;
+    occurrenceDate?: string;
+    attendeeName: string;
+    attendeeEmail: string;
+    attendeePhone?: string;
+    guestsCount?: number;
+    locale?: string;
+    notes?: string;
+    metadata?: Record<string, unknown>;
+}
+export interface RsvpRegistrationRecord {
+    documentId: string;
+    eventUid: string;
+    eventDocumentId: string;
+    eventTitle?: string;
+    occurrenceDate: string;
+    attendeeName: string;
+    attendeeEmail: string;
+    attendeePhone?: string;
+    guestsCount: number;
+    status: RsvpStatus;
+    checkInToken?: string;
+    checkedInAt?: string | null;
+    locale: string;
+    notes?: string;
+    createdAt?: string;
+}

package/dist/shared/urlAndPosterHelpers.d.ts

@@ -0,0 +1,18 @@
+import { EventActionLink, EventPosterAsset } from './types';
+export declare function isSafeObjectKey(key: unknown): key is string;
+export declare function sanitizePlainRecord(raw: unknown, maxDepth?: number): Record<string, unknown> | null;
+/**
+ * Validates that a URL is either a safe relative path (`/path`, no `//` or `\`)
+ * or uses an allow-listed protocol (`https:`, `http:`, plus `mailto:` unless disabled).
+ */
+export declare function sanitizeEventUrl(rawUrl: unknown, options?: {
+    allowMailto?: boolean;
+}): string | null;
+export declare function parseJsonIfNeeded(raw: unknown): unknown;
+export declare function getTrimmedString(val: unknown, maxLen?: number): string | undefined;
+/**
+ * Normalizes a Strapi Media field value into a unified `EventPosterAsset`.
+ * Disallows `mailto:` URLs on poster assets.
+ */
+export declare function normalizeEventPoster(rawPoster: unknown, fallbackAlt?: string): EventPosterAsset | undefined;
+export declare function normalizeEventActionLinks(rawLinks: unknown): EventActionLink[] | undefined;

package/package.json

@@ -1,6 +1,112 @@
 {
   "name": "@vicacha-devs/strapi-plugin-events",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "description": "Production-grade Strapi v5 Events, RSVP Capacity, Automatic Waitlist Promotion, Attendee Check-In & iCal Plugin powered by @vicacha-devs/strapi-plugin-calendar",
+  "keywords": [
+    "calendar",
+    "events",
+    "ical",
+    "plugin",
+    "rrule",
+    "rsvp",
+    "strapi",
+    "strapi-v5",
+    "waitlist"
+  ],
+  "homepage": "https://github.com/Vicacha-Devs/strapi-v5-extensions/tree/main/packages/strapi-plugin-events#readme",
+  "bugs": {
+    "url": "https://github.com/Vicacha-Devs/strapi-v5-extensions/issues"
+  },
+  "license": "MIT",
+  "author": "Vicacha Devs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Vicacha-Devs/strapi-v5-extensions.git",
+    "directory": "packages/strapi-plugin-events"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    "./strapi-admin": {
+      "types": "./dist/admin/src/index.d.ts",
+      "source": "./admin/src/index.ts",
+      "import": "./dist/admin/index.mjs",
+      "require": "./dist/admin/index.js",
+      "default": "./dist/admin/index.js"
+    },
+    "./strapi-server": {
+      "types": "./dist/server/src/index.d.ts",
+      "source": "./server/src/index.ts",
+      "import": "./dist/server/index.mjs",
+      "require": "./dist/server/index.js",
+      "default": "./dist/server/index.js"
+    },
+    "./shared": {
+      "types": "./dist/shared/index.d.ts",
+      "source": "./shared/index.ts",
+      "import": "./dist/shared/index.mjs",
+      "require": "./dist/shared/index.js",
+      "default": "./dist/shared/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "@strapi/design-system": "2.2.0",
+    "@strapi/icons": "2.2.0",
+    "react-intl": "8.1.3"
+  },
+  "devDependencies": {
+    "@strapi/sdk-plugin": "6.1.1",
+    "@strapi/strapi": "5.39.0",
+    "@strapi/typescript-utils": "5.39.0",
+    "@types/node": "22.10.2",
+    "@types/react": "19.2.14",
+    "@types/react-dom": "19.2.3",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "react-router-dom": "6.30.3",
+    "styled-components": "6.3.11",
+    "typescript": "5.9.3",
+    "@vicacha-devs/eslint-config": "1.0.0",
+    "@vicacha-devs/typescript-config": "1.0.0",
+    "@vicacha-devs/strapi-plugin-calendar": "1.1.1",
+    "@vicacha-devs/plugin-shared": "1.0.0"
+  },
+  "peerDependencies": {
+    "@strapi/design-system": "^2.0.0",
+    "@strapi/icons": "^2.0.0",
+    "@strapi/sdk-plugin": "^5.0.0 || ^6.0.0",
+    "@strapi/strapi": "^5.0.0",
+    "@vicacha-devs/strapi-plugin-calendar": "^1.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "react-router-dom": "^6.0.0",
+    "styled-components": "^6.0.0"
+  },
+  "engines": {
+    "node": ">=20.16.0",
+    "pnpm": ">=10.0.0"
+  },
+  "strapi": {
+    "kind": "plugin",
+    "name": "events",
+    "displayName": "Events & RSVPs",
+    "description": "Manage recurring events, RSVPs, seat capacity, waitlists, and attendee check-in in Strapi v5 powered by @vicacha-devs/strapi-plugin-calendar"
+  },
+  "scripts": {
+    "build": "strapi-plugin build && node ../../scripts/ensure-dist-types.ts",
+    "clean": "rm -rf dist .strapi",
+    "test": "node --import ./tests/register-ts-resolver.ts --test tests/*.test.ts",
+    "test:ts": "npm run test:ts:front && npm run test:ts:back",
+    "test:ts:back": "tsc --noEmit -p server/tsconfig.json",
+    "test:ts:front": "tsc --noEmit -p admin/tsconfig.json",
+    "verify": "strapi-plugin verify",
+    "watch": "strapi-plugin watch",
+    "watch:link": "strapi-plugin watch:link"
+  }
 }