@sylphx/contract 0.2.0

package/dist/schemas/email-admin.js

@@ -0,0 +1,313 @@
+/**
+ * Email Admin — Console-plane email templates / sending / scheduling / logs /
+ * suppressions / settings / admin-only operations. Distinct from the BaaS
+ * plane `email` namespace (BaaS covers `emailEndpoints.send/sendTemplated/
+ * sendToUser/isConfigured`); these admin surfaces operate on the platform
+ * database + Console UI and are only reachable by authenticated project
+ * members (or super-admins for `/admin/*`).
+ *
+ * Mirrors the wire shapes served at `/email/*` in
+ * `apps/api/src/server/platform/routes/email/*`.
+ */
+import { Schema } from 'effect';
+// ── Templates ──────────────────────────────────────────────────────────────
+export const EmailTemplateType = Schema.Literal('transactional', 'newsletter');
+export const EmailTemplateItem = Schema.Struct({
+    id: Schema.String,
+    key: Schema.String,
+    name: Schema.String,
+    description: Schema.NullOr(Schema.String),
+    type: Schema.String,
+    subject: Schema.String,
+    isActive: Schema.Boolean,
+    createdAt: Schema.String,
+    updatedAt: Schema.String,
+});
+export const ListTemplatesResult = Schema.Struct({
+    templates: Schema.Array(EmailTemplateItem),
+    total: Schema.Number,
+});
+/**
+ * Full template response — includes body text / variables. Returned from
+ * GET/POST/PATCH/DELETE on `/projects/:id/templates/:key`.
+ */
+export const EmailTemplateDetail = Schema.Struct({
+    id: Schema.String,
+    key: Schema.String,
+    name: Schema.String,
+    description: Schema.NullOr(Schema.String),
+    type: Schema.String,
+    subject: Schema.String,
+    htmlBody: Schema.String,
+    textBody: Schema.NullOr(Schema.String),
+    variables: Schema.NullOr(Schema.Array(Schema.String)),
+    fromName: Schema.NullOr(Schema.String),
+    fromEmail: Schema.NullOr(Schema.String),
+    replyTo: Schema.NullOr(Schema.String),
+    isActive: Schema.Boolean,
+    createdAt: Schema.String,
+    updatedAt: Schema.String,
+});
+export const CreateTemplateInput = Schema.Struct({
+    key: Schema.String,
+    name: Schema.String,
+    description: Schema.optional(Schema.String),
+    type: Schema.optional(EmailTemplateType),
+    subject: Schema.String,
+    htmlBody: Schema.String,
+    textBody: Schema.optional(Schema.String),
+    variables: Schema.optional(Schema.Array(Schema.String)),
+    fromEmail: Schema.optional(Schema.String),
+    fromName: Schema.optional(Schema.String),
+    replyTo: Schema.optional(Schema.String),
+    isActive: Schema.optional(Schema.Boolean),
+});
+export const UpdateTemplateInput = Schema.Struct({
+    name: Schema.optional(Schema.String),
+    description: Schema.optional(Schema.NullOr(Schema.String)),
+    type: Schema.optional(EmailTemplateType),
+    subject: Schema.optional(Schema.String),
+    htmlBody: Schema.optional(Schema.String),
+    textBody: Schema.optional(Schema.NullOr(Schema.String)),
+    variables: Schema.optional(Schema.NullOr(Schema.Array(Schema.String))),
+    fromEmail: Schema.optional(Schema.NullOr(Schema.String)),
+    fromName: Schema.optional(Schema.NullOr(Schema.String)),
+    replyTo: Schema.optional(Schema.NullOr(Schema.String)),
+    isActive: Schema.optional(Schema.Boolean),
+});
+// ── Send (Console surface — per-project) ───────────────────────────────────
+export const SendEmailAdminInput = Schema.Struct({
+    to: Schema.String,
+    subject: Schema.String,
+    html: Schema.String,
+    text: Schema.optional(Schema.String),
+    replyTo: Schema.optional(Schema.String),
+});
+export const SendEmailAdminResult = Schema.Struct({
+    success: Schema.Boolean,
+    id: Schema.optional(Schema.String),
+});
+export const SendTemplatedEmailAdminInput = Schema.Struct({
+    template: Schema.Literal('welcome', 'verification', 'password_reset', 'security_alert'),
+    to: Schema.String,
+    data: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+});
+export const SendTemplatedEmailAdminResult = Schema.Struct({
+    success: Schema.Boolean,
+    template: Schema.String,
+});
+export const SendToUserInput = Schema.Struct({
+    userId: Schema.String,
+    subject: Schema.String,
+    html: Schema.String,
+    text: Schema.optional(Schema.String),
+});
+// ── Scheduling ─────────────────────────────────────────────────────────────
+export const ScheduleEmailInput = Schema.Struct({
+    to: Schema.String,
+    toName: Schema.optional(Schema.String),
+    subject: Schema.String,
+    html: Schema.optional(Schema.String),
+    text: Schema.optional(Schema.String),
+    replyTo: Schema.optional(Schema.String),
+    fromEmail: Schema.optional(Schema.String),
+    fromName: Schema.optional(Schema.String),
+    scheduledFor: Schema.String,
+    templateKey: Schema.optional(Schema.String),
+    templateData: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+    idempotencyKey: Schema.optional(Schema.String),
+    metadata: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+});
+export const ScheduleEmailResult = Schema.Struct({
+    id: Schema.String,
+    status: Schema.String,
+    scheduledFor: Schema.String,
+    qstashMessageId: Schema.NullOr(Schema.String),
+});
+export const ScheduledEmail = Schema.Struct({
+    id: Schema.String,
+    toEmail: Schema.String,
+    toName: Schema.NullOr(Schema.String),
+    subject: Schema.String,
+    status: Schema.String,
+    scheduledFor: Schema.String,
+    templateKey: Schema.NullOr(Schema.String),
+    sentAt: Schema.NullOr(Schema.String),
+    cancelledAt: Schema.NullOr(Schema.String),
+    error: Schema.NullOr(Schema.String),
+    createdAt: Schema.String,
+});
+export const ScheduledEmailDetail = Schema.Struct({
+    id: Schema.String,
+    toEmail: Schema.String,
+    toName: Schema.NullOr(Schema.String),
+    subject: Schema.String,
+    status: Schema.String,
+    scheduledFor: Schema.String,
+    templateKey: Schema.NullOr(Schema.String),
+    templateData: Schema.NullOr(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+    metadata: Schema.NullOr(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+    sentAt: Schema.NullOr(Schema.String),
+    cancelledAt: Schema.NullOr(Schema.String),
+    error: Schema.NullOr(Schema.String),
+    providerMessageId: Schema.NullOr(Schema.String),
+    createdAt: Schema.String,
+});
+export const ListScheduledEmailsQuery = Schema.Struct({
+    status: Schema.optional(Schema.String),
+    search: Schema.optional(Schema.String),
+    from: Schema.optional(Schema.String),
+    to: Schema.optional(Schema.String),
+    limit: Schema.optional(Schema.String),
+    offset: Schema.optional(Schema.String),
+    environmentId: Schema.optional(Schema.String),
+});
+export const ListScheduledEmailsResult = Schema.Struct({
+    emails: Schema.Array(ScheduledEmail),
+    total: Schema.Number,
+    limit: Schema.Number,
+    offset: Schema.Number,
+});
+export const CancelScheduledEmailResult = Schema.Struct({
+    id: Schema.String,
+    status: Schema.String,
+    cancelledAt: Schema.NullOr(Schema.String),
+});
+export const RescheduleEmailInput = Schema.Struct({
+    scheduledFor: Schema.String,
+});
+export const RescheduleEmailResult = Schema.Struct({
+    id: Schema.String,
+    status: Schema.String,
+    scheduledFor: Schema.String,
+    qstashMessageId: Schema.NullOr(Schema.String),
+});
+export const ScheduledEmailStatsQuery = Schema.Struct({
+    from: Schema.optional(Schema.String),
+    to: Schema.optional(Schema.String),
+});
+export const ScheduledEmailStatsResult = Schema.Struct({
+    total: Schema.Number,
+    pending: Schema.Number,
+    queued: Schema.Number,
+    sent: Schema.Number,
+    cancelled: Schema.Number,
+    failed: Schema.Number,
+});
+// ── Logs ───────────────────────────────────────────────────────────────────
+export const EmailLogItem = Schema.Struct({
+    id: Schema.String,
+    object: Schema.Literal('email'),
+    to: Schema.Array(Schema.String),
+    from: Schema.String,
+    subject: Schema.String,
+    status: Schema.String,
+    created_at: Schema.String,
+    last_event: Schema.NullOr(Schema.String),
+});
+export const EmailLogEvent = Schema.Struct({
+    id: Schema.String,
+    type: Schema.String,
+    created_at: Schema.String,
+});
+export const EmailLogDetail = Schema.Struct({
+    id: Schema.String,
+    object: Schema.Literal('email'),
+    to: Schema.Array(Schema.String),
+    from: Schema.String,
+    subject: Schema.String,
+    status: Schema.String,
+    created_at: Schema.String,
+    last_event: Schema.NullOr(Schema.String),
+    reply_to: Schema.NullOr(Schema.String),
+    bcc: Schema.NullOr(Schema.Array(Schema.String)),
+    cc: Schema.NullOr(Schema.Array(Schema.String)),
+    delivered_at: Schema.NullOr(Schema.String),
+    bounced_at: Schema.NullOr(Schema.String),
+    complained_at: Schema.NullOr(Schema.String),
+    opened_at: Schema.NullOr(Schema.String),
+    clicked_at: Schema.NullOr(Schema.String),
+    bounce_type: Schema.NullOr(Schema.String),
+    error: Schema.NullOr(Schema.String),
+    events: Schema.Array(EmailLogEvent),
+});
+export const ListEmailLogsQuery = Schema.Struct({
+    cursor: Schema.optional(Schema.String),
+    limit: Schema.optional(Schema.String),
+    status: Schema.optional(Schema.Literal('queued', 'sent', 'delivered', 'bounced', 'complained', 'failed')),
+    email: Schema.optional(Schema.String),
+    from: Schema.optional(Schema.String),
+    to: Schema.optional(Schema.String),
+});
+export const ListEmailLogsResult = Schema.Struct({
+    data: Schema.Array(EmailLogItem),
+    nextCursor: Schema.NullOr(Schema.String),
+});
+// ── Suppressions ───────────────────────────────────────────────────────────
+export const SuppressionReason = Schema.Literal('hard_bounce', 'complaint', 'manual');
+export const SuppressionItem = Schema.Struct({
+    id: Schema.String,
+    email: Schema.String,
+    reason: SuppressionReason,
+    can_unsuppress: Schema.Boolean,
+    suppressed_at: Schema.String,
+    unsuppressed_at: Schema.NullOr(Schema.String),
+    created_at: Schema.String,
+});
+export const ListSuppressionsQuery = Schema.Struct({
+    cursor: Schema.optional(Schema.String),
+    limit: Schema.optional(Schema.String),
+    reason: Schema.optional(SuppressionReason),
+});
+export const ListSuppressionsResult = Schema.Struct({
+    data: Schema.Array(SuppressionItem),
+    nextCursor: Schema.NullOr(Schema.String),
+});
+export const AddSuppressionInput = Schema.Struct({
+    email: Schema.String,
+    reason: Schema.optional(Schema.Literal('manual')),
+});
+// ── Settings (per-project email config) ────────────────────────────────────
+export const EmailSettings = Schema.Struct({
+    defaultFromEmail: Schema.NullOr(Schema.String),
+    defaultFromName: Schema.NullOr(Schema.String),
+    webhookUrl: Schema.NullOr(Schema.String),
+    webhookSecretPrefix: Schema.NullOr(Schema.String),
+    trackOpens: Schema.Boolean,
+    trackClicks: Schema.Boolean,
+});
+export const UpdateEmailSettingsInput = Schema.Struct({
+    defaultFromEmail: Schema.optional(Schema.NullOr(Schema.String)),
+    defaultFromName: Schema.optional(Schema.NullOr(Schema.String)),
+    webhookUrl: Schema.optional(Schema.NullOr(Schema.String)),
+    rotateWebhookSecret: Schema.optional(Schema.Boolean),
+    trackOpens: Schema.optional(Schema.Boolean),
+    trackClicks: Schema.optional(Schema.Boolean),
+});
+// ── Admin (super-admin platform ops) ───────────────────────────────────────
+export const AdminSendEmailInput = Schema.Struct({
+    to: Schema.Union(Schema.String, Schema.Array(Schema.String)),
+    subject: Schema.String,
+    html: Schema.String,
+    text: Schema.optional(Schema.String),
+});
+export const AdminSendEmailResult = Schema.Struct({
+    success: Schema.Boolean,
+    id: Schema.optional(Schema.String),
+    sentTo: Schema.Number,
+});
+export const AdminEmailStatsResult = Schema.Struct({
+    period: Schema.Struct({
+        days: Schema.Number,
+        since: Schema.String,
+    }),
+    emails: Schema.Struct({
+        total: Schema.Number,
+        successful: Schema.Number,
+        failed: Schema.Number,
+        successRate: Schema.Number,
+    }),
+});
+// Note: `GET /email/configured` is served by the shared BaaS
+// `emailEndpoints.isConfigured` — the Console route mounts the same contract
+// behind `platformAuth`. No admin-specific schema is needed here.

package/dist/schemas/email.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Email — BaaS plane transactional send. Mirrors `@sylphx/sdk/email.ts`.
+ */
+import { Schema } from 'effect';
+export declare const EmailMessageId: Schema.brand<typeof Schema.String, "EmailMessageId">;
+export type EmailMessageId = typeof EmailMessageId.Type;
+export declare const SendEmailInput: Schema.Struct<{
+    to: typeof Schema.String;
+    subject: typeof Schema.String;
+    html: typeof Schema.String;
+    text: Schema.optional<typeof Schema.String>;
+    replyTo: Schema.optional<typeof Schema.String>;
+    fromEmail: Schema.optional<typeof Schema.String>;
+    fromName: Schema.optional<typeof Schema.String>;
+    headers: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.String>>;
+}>;
+export type SendEmailInput = typeof SendEmailInput.Type;
+export declare const SendEmailResult: Schema.Struct<{
+    id: typeof Schema.String;
+    success: typeof Schema.Boolean;
+}>;
+export type SendEmailResult = typeof SendEmailResult.Type;
+export declare const EmailTemplate: Schema.Literal<["welcome", "verification", "password_reset", "security_alert"]>;
+export type EmailTemplate = typeof EmailTemplate.Type;
+export declare const SendTemplatedEmailInput: Schema.Struct<{
+    template: Schema.Literal<["welcome", "verification", "password_reset", "security_alert"]>;
+    to: typeof Schema.String;
+    data: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+}>;
+export type SendTemplatedEmailInput = typeof SendTemplatedEmailInput.Type;
+/** `POST /email/send-template` — mirrors `SendEmailResult` envelope. */
+export declare const SendTemplatedEmailResult: Schema.Struct<{
+    id: typeof Schema.String;
+    success: typeof Schema.Boolean;
+}>;
+export type SendTemplatedEmailResult = typeof SendEmailResult.Type;
+export declare const SendEmailToUserInput: Schema.Struct<{
+    userId: typeof Schema.String;
+    subject: typeof Schema.String;
+    html: typeof Schema.String;
+    text: Schema.optional<typeof Schema.String>;
+}>;
+export type SendEmailToUserInput = typeof SendEmailToUserInput.Type;
+export declare const EmailConfiguredResult: typeof Schema.Boolean;
+export type EmailConfiguredResult = typeof EmailConfiguredResult.Type;
+//# sourceMappingURL=email.d.ts.map

package/dist/schemas/email.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../../src/schemas/email.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAE/B,eAAO,MAAM,cAAc,sDAAqD,CAAA;AAChF,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC,IAAI,CAAA;AAEvD,eAAO,MAAM,cAAc;;;;;;;;;EASzB,CAAA;AACF,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC,IAAI,CAAA;AAEvD,eAAO,MAAM,eAAe;;;EAG1B,CAAA;AACF,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAEzD,eAAO,MAAM,aAAa,iFAKzB,CAAA;AACD,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA;AAErD,eAAO,MAAM,uBAAuB;;;;EAIlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC,IAAI,CAAA;AAEzE,wEAAwE;AACxE,eAAO,MAAM,wBAAwB;;;EAAkB,CAAA;AACvD,MAAM,MAAM,wBAAwB,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAElE,eAAO,MAAM,oBAAoB;;;;;EAK/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,OAAO,oBAAoB,CAAC,IAAI,CAAA;AAEnE,eAAO,MAAM,qBAAqB,uBAAiB,CAAA;AAEnD,MAAM,MAAM,qBAAqB,GAAG,OAAO,qBAAqB,CAAC,IAAI,CAAA"}

package/dist/schemas/email.js

@@ -0,0 +1,34 @@
+/**
+ * Email — BaaS plane transactional send. Mirrors `@sylphx/sdk/email.ts`.
+ */
+import { Schema } from 'effect';
+export const EmailMessageId = Schema.String.pipe(Schema.brand('EmailMessageId'));
+export const SendEmailInput = Schema.Struct({
+    to: Schema.String,
+    subject: Schema.String,
+    html: Schema.String,
+    text: Schema.optional(Schema.String),
+    replyTo: Schema.optional(Schema.String),
+    fromEmail: Schema.optional(Schema.String),
+    fromName: Schema.optional(Schema.String),
+    headers: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.String })),
+});
+export const SendEmailResult = Schema.Struct({
+    id: Schema.String,
+    success: Schema.Boolean,
+});
+export const EmailTemplate = Schema.Literal('welcome', 'verification', 'password_reset', 'security_alert');
+export const SendTemplatedEmailInput = Schema.Struct({
+    template: EmailTemplate,
+    to: Schema.String,
+    data: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+});
+/** `POST /email/send-template` — mirrors `SendEmailResult` envelope. */
+export const SendTemplatedEmailResult = SendEmailResult;
+export const SendEmailToUserInput = Schema.Struct({
+    userId: Schema.String,
+    subject: Schema.String,
+    html: Schema.String,
+    text: Schema.optional(Schema.String),
+});
+export const EmailConfiguredResult = Schema.Boolean;

package/dist/schemas/engagement-admin.d.ts

@@ -0,0 +1,148 @@
+/**
+ * Engagement Admin — Console-plane gamification config + overrides + stats.
+ * Distinct from the BaaS-plane engagement API that customer SDKs consume.
+ * Base configs are defined in customer code and synced to the platform on
+ * provider init; Console is read-only + override-only.
+ *
+ * Mirrors the wire shapes served at `/engagement/*` in
+ * `apps/api/src/server/platform/routes/engagement.ts`. Streaks / leaderboards /
+ * achievements are stored as JSON blobs; the contract exposes them as
+ * permissive records to avoid drifting from customer-defined shapes.
+ */
+import { Schema } from 'effect';
+export declare const EngagementEntityType: Schema.Literal<["streak", "leaderboard", "achievement", "all"]>;
+export type EngagementEntityType = typeof EngagementEntityType.Type;
+/** Base config (raw from customer code, synced on provider init). */
+export declare const EngagementBaseConfig: Schema.Struct<{
+    streaks: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    leaderboards: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    achievements: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    achievementCategories: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+}>;
+export type EngagementBaseConfig = typeof EngagementBaseConfig.Type;
+/** Resolved config (base + Console overrides, disabled entities filtered out). */
+export declare const EngagementResolvedConfig: Schema.Struct<{
+    streaks: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    leaderboards: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    achievements: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+}>;
+export type EngagementResolvedConfig = typeof EngagementResolvedConfig.Type;
+export declare const StreakOverride: Schema.Struct<{
+    name: Schema.optional<typeof Schema.String>;
+    description: Schema.optional<typeof Schema.String>;
+    gracePeriodHours: Schema.optional<typeof Schema.Number>;
+    maxValue: Schema.optional<typeof Schema.Number>;
+    resetOnMiss: Schema.optional<typeof Schema.Boolean>;
+    enabled: Schema.optional<typeof Schema.Boolean>;
+}>;
+export type StreakOverride = typeof StreakOverride.Type;
+export declare const LeaderboardOverride: Schema.Struct<{
+    name: Schema.optional<typeof Schema.String>;
+    description: Schema.optional<typeof Schema.String>;
+    maxEntries: Schema.optional<typeof Schema.Number>;
+    sortDirection: Schema.optional<Schema.Literal<["asc", "desc"]>>;
+    enabled: Schema.optional<typeof Schema.Boolean>;
+}>;
+export type LeaderboardOverride = typeof LeaderboardOverride.Type;
+export declare const AchievementOverride: Schema.Struct<{
+    name: Schema.optional<typeof Schema.String>;
+    description: Schema.optional<typeof Schema.String>;
+    unlockedDescription: Schema.optional<typeof Schema.String>;
+    points: Schema.optional<typeof Schema.Number>;
+    tier: Schema.optional<Schema.Literal<["bronze", "silver", "gold", "platinum", "diamond"]>>;
+    secret: Schema.optional<typeof Schema.Boolean>;
+    enabled: Schema.optional<typeof Schema.Boolean>;
+}>;
+export type AchievementOverride = typeof AchievementOverride.Type;
+export declare const EngagementProjectQuery: Schema.Struct<{
+    projectId: typeof Schema.String;
+}>;
+export type EngagementProjectQuery = typeof EngagementProjectQuery.Type;
+export declare const UpdateStreakOverrideInput: Schema.Struct<{
+    projectId: typeof Schema.String;
+    streakId: typeof Schema.String;
+    override: Schema.Struct<{
+        name: Schema.optional<typeof Schema.String>;
+        description: Schema.optional<typeof Schema.String>;
+        gracePeriodHours: Schema.optional<typeof Schema.Number>;
+        maxValue: Schema.optional<typeof Schema.Number>;
+        resetOnMiss: Schema.optional<typeof Schema.Boolean>;
+        enabled: Schema.optional<typeof Schema.Boolean>;
+    }>;
+}>;
+export type UpdateStreakOverrideInput = typeof UpdateStreakOverrideInput.Type;
+export declare const UpdateLeaderboardOverrideInput: Schema.Struct<{
+    projectId: typeof Schema.String;
+    leaderboardId: typeof Schema.String;
+    override: Schema.Struct<{
+        name: Schema.optional<typeof Schema.String>;
+        description: Schema.optional<typeof Schema.String>;
+        maxEntries: Schema.optional<typeof Schema.Number>;
+        sortDirection: Schema.optional<Schema.Literal<["asc", "desc"]>>;
+        enabled: Schema.optional<typeof Schema.Boolean>;
+    }>;
+}>;
+export type UpdateLeaderboardOverrideInput = typeof UpdateLeaderboardOverrideInput.Type;
+export declare const UpdateAchievementOverrideInput: Schema.Struct<{
+    projectId: typeof Schema.String;
+    achievementId: typeof Schema.String;
+    override: Schema.Struct<{
+        name: Schema.optional<typeof Schema.String>;
+        description: Schema.optional<typeof Schema.String>;
+        unlockedDescription: Schema.optional<typeof Schema.String>;
+        points: Schema.optional<typeof Schema.Number>;
+        tier: Schema.optional<Schema.Literal<["bronze", "silver", "gold", "platinum", "diamond"]>>;
+        secret: Schema.optional<typeof Schema.Boolean>;
+        enabled: Schema.optional<typeof Schema.Boolean>;
+    }>;
+}>;
+export type UpdateAchievementOverrideInput = typeof UpdateAchievementOverrideInput.Type;
+export declare const ClearOverridesInput: Schema.Struct<{
+    projectId: typeof Schema.String;
+    entityType: Schema.optional<Schema.Literal<["streak", "leaderboard", "achievement", "all"]>>;
+    entityId: Schema.optional<typeof Schema.String>;
+}>;
+export type ClearOverridesInput = typeof ClearOverridesInput.Type;
+export declare const GetEngagementConfigResult: Schema.Struct<{
+    exists: typeof Schema.Boolean;
+    base: Schema.Struct<{
+        streaks: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+        leaderboards: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+        achievements: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+        achievementCategories: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    }>;
+    resolved: Schema.Struct<{
+        streaks: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+        leaderboards: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+        achievements: Schema.Array$<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    }>;
+    overrides: Schema.NullOr<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    lastSyncedAt: Schema.NullOr<typeof Schema.String>;
+}>;
+export type GetEngagementConfigResult = typeof GetEngagementConfigResult.Type;
+export declare const EngagementSuccessResult: Schema.Struct<{
+    success: typeof Schema.Boolean;
+}>;
+export type EngagementSuccessResult = typeof EngagementSuccessResult.Type;
+export declare const GetEngagementStatsResult: Schema.Struct<{
+    config: Schema.Struct<{
+        exists: typeof Schema.Boolean;
+        lastSyncedAt: Schema.NullOr<typeof Schema.String>;
+        streakCount: typeof Schema.Number;
+        leaderboardCount: typeof Schema.Number;
+        achievementCount: typeof Schema.Number;
+    }>;
+    streaks: Schema.Struct<{
+        totalUsers: typeof Schema.Number;
+        activeStreaks: typeof Schema.Number;
+    }>;
+    leaderboards: Schema.Struct<{
+        totalParticipants: typeof Schema.Number;
+    }>;
+    achievements: Schema.Struct<{
+        totalProgress: typeof Schema.Number;
+        totalUnlocked: typeof Schema.Number;
+    }>;
+}>;
+export type GetEngagementStatsResult = typeof GetEngagementStatsResult.Type;
+//# sourceMappingURL=engagement-admin.d.ts.map

package/dist/schemas/engagement-admin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engagement-admin.d.ts","sourceRoot":"","sources":["../../src/schemas/engagement-admin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAI/B,eAAO,MAAM,oBAAoB,iEAAgE,CAAA;AACjG,MAAM,MAAM,oBAAoB,GAAG,OAAO,oBAAoB,CAAC,IAAI,CAAA;AAEnE,qEAAqE;AACrE,eAAO,MAAM,oBAAoB;;;;;EAK/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,OAAO,oBAAoB,CAAC,IAAI,CAAA;AAEnE,kFAAkF;AAClF,eAAO,MAAM,wBAAwB;;;;EAInC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,OAAO,wBAAwB,CAAC,IAAI,CAAA;AAI3E,eAAO,MAAM,cAAc;;;;;;;EAOzB,CAAA;AACF,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC,IAAI,CAAA;AAEvD,eAAO,MAAM,mBAAmB;;;;;;EAM9B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,IAAI,CAAA;AAEjE,eAAO,MAAM,mBAAmB;;;;;;;;EAQ9B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,IAAI,CAAA;AAIjE,eAAO,MAAM,sBAAsB;;EAEjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,OAAO,sBAAsB,CAAC,IAAI,CAAA;AAEvE,eAAO,MAAM,yBAAyB;;;;;;;;;;;EAIpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,OAAO,yBAAyB,CAAC,IAAI,CAAA;AAE7E,eAAO,MAAM,8BAA8B;;;;;;;;;;EAIzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,OAAO,8BAA8B,CAAC,IAAI,CAAA;AAEvF,eAAO,MAAM,8BAA8B;;;;;;;;;;;;EAIzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,OAAO,8BAA8B,CAAC,IAAI,CAAA;AAEvF,eAAO,MAAM,mBAAmB;;;;EAI9B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,IAAI,CAAA;AAIjE,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;EAMpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,OAAO,yBAAyB,CAAC,IAAI,CAAA;AAE7E,eAAO,MAAM,uBAAuB;;EAElC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC,IAAI,CAAA;AAEzE,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;EAmBnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,OAAO,wBAAwB,CAAC,IAAI,CAAA"}

package/dist/schemas/engagement-admin.js

@@ -0,0 +1,107 @@
+/**
+ * Engagement Admin — Console-plane gamification config + overrides + stats.
+ * Distinct from the BaaS-plane engagement API that customer SDKs consume.
+ * Base configs are defined in customer code and synced to the platform on
+ * provider init; Console is read-only + override-only.
+ *
+ * Mirrors the wire shapes served at `/engagement/*` in
+ * `apps/api/src/server/platform/routes/engagement.ts`. Streaks / leaderboards /
+ * achievements are stored as JSON blobs; the contract exposes them as
+ * permissive records to avoid drifting from customer-defined shapes.
+ */
+import { Schema } from 'effect';
+const OpaqueRecord = Schema.Record({ key: Schema.String, value: Schema.Unknown });
+export const EngagementEntityType = Schema.Literal('streak', 'leaderboard', 'achievement', 'all');
+/** Base config (raw from customer code, synced on provider init). */
+export const EngagementBaseConfig = Schema.Struct({
+    streaks: Schema.Array(OpaqueRecord),
+    leaderboards: Schema.Array(OpaqueRecord),
+    achievements: Schema.Array(OpaqueRecord),
+    achievementCategories: Schema.Array(OpaqueRecord),
+});
+/** Resolved config (base + Console overrides, disabled entities filtered out). */
+export const EngagementResolvedConfig = Schema.Struct({
+    streaks: Schema.Array(OpaqueRecord),
+    leaderboards: Schema.Array(OpaqueRecord),
+    achievements: Schema.Array(OpaqueRecord),
+});
+// ── Overrides ─────────────────────────────────────────────────────────────
+export const StreakOverride = Schema.Struct({
+    name: Schema.optional(Schema.String),
+    description: Schema.optional(Schema.String),
+    gracePeriodHours: Schema.optional(Schema.Number),
+    maxValue: Schema.optional(Schema.Number),
+    resetOnMiss: Schema.optional(Schema.Boolean),
+    enabled: Schema.optional(Schema.Boolean),
+});
+export const LeaderboardOverride = Schema.Struct({
+    name: Schema.optional(Schema.String),
+    description: Schema.optional(Schema.String),
+    maxEntries: Schema.optional(Schema.Number),
+    sortDirection: Schema.optional(Schema.Literal('asc', 'desc')),
+    enabled: Schema.optional(Schema.Boolean),
+});
+export const AchievementOverride = Schema.Struct({
+    name: Schema.optional(Schema.String),
+    description: Schema.optional(Schema.String),
+    unlockedDescription: Schema.optional(Schema.String),
+    points: Schema.optional(Schema.Number),
+    tier: Schema.optional(Schema.Literal('bronze', 'silver', 'gold', 'platinum', 'diamond')),
+    secret: Schema.optional(Schema.Boolean),
+    enabled: Schema.optional(Schema.Boolean),
+});
+// ── Requests ──────────────────────────────────────────────────────────────
+export const EngagementProjectQuery = Schema.Struct({
+    projectId: Schema.String,
+});
+export const UpdateStreakOverrideInput = Schema.Struct({
+    projectId: Schema.String,
+    streakId: Schema.String,
+    override: StreakOverride,
+});
+export const UpdateLeaderboardOverrideInput = Schema.Struct({
+    projectId: Schema.String,
+    leaderboardId: Schema.String,
+    override: LeaderboardOverride,
+});
+export const UpdateAchievementOverrideInput = Schema.Struct({
+    projectId: Schema.String,
+    achievementId: Schema.String,
+    override: AchievementOverride,
+});
+export const ClearOverridesInput = Schema.Struct({
+    projectId: Schema.String,
+    entityType: Schema.optional(EngagementEntityType),
+    entityId: Schema.optional(Schema.String),
+});
+// ── Responses ─────────────────────────────────────────────────────────────
+export const GetEngagementConfigResult = Schema.Struct({
+    exists: Schema.Boolean,
+    base: EngagementBaseConfig,
+    resolved: EngagementResolvedConfig,
+    overrides: Schema.NullOr(OpaqueRecord),
+    lastSyncedAt: Schema.NullOr(Schema.String),
+});
+export const EngagementSuccessResult = Schema.Struct({
+    success: Schema.Boolean,
+});
+export const GetEngagementStatsResult = Schema.Struct({
+    config: Schema.Struct({
+        exists: Schema.Boolean,
+        lastSyncedAt: Schema.NullOr(Schema.String),
+        streakCount: Schema.Number,
+        leaderboardCount: Schema.Number,
+        achievementCount: Schema.Number,
+    }),
+    streaks: Schema.Struct({
+        totalUsers: Schema.Number,
+        activeStreaks: Schema.Number,
+    }),
+    leaderboards: Schema.Struct({
+        totalParticipants: Schema.Number,
+    }),
+    achievements: Schema.Struct({
+        totalProgress: Schema.Number,
+        totalUnlocked: Schema.Number,
+    }),
+});