@contractspec/example.team-hub 1.57.0 → 1.58.0

package/dist/node/announcement/announcement.operations.js

@@ -0,0 +1,71 @@
+// src/announcement/announcement.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var AnnouncementModel = defineSchemaModel({
+  name: "Announcement",
+  description: "Announcement to spaces/org",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    body: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audience: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audienceRole: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    spaceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var PostAnnouncementInputModel = defineSchemaModel({
+  name: "PostAnnouncementInput",
+  description: "Post an announcement",
+  fields: {
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    body: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audience: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audienceRole: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    spaceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    expiresAt: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+
+// src/announcement/announcement.operations.ts
+import { defineCommand } from "@contractspec/lib.contracts";
+var OWNERS = ["@examples.team-hub"];
+var PostAnnouncementContract = defineCommand({
+  meta: {
+    key: "team.announcement.post",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["team-hub", "announcement", "post"],
+    description: "Post an announcement.",
+    goal: "Communicate with team.",
+    context: "Communication."
+  },
+  io: {
+    input: PostAnnouncementInputModel,
+    output: AnnouncementModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "post-announcement-happy-path",
+        given: ["User is authenticated"],
+        when: ["User posts an announcement"],
+        then: ["Announcement is posted and distributed"]
+      }
+    ],
+    examples: [
+      {
+        key: "post-general",
+        input: {
+          spaceId: "space-123",
+          title: "New Policy",
+          content: "Please read..."
+        },
+        output: { id: "ann-456", status: "posted" }
+      }
+    ]
+  }
+});
+export {
+  PostAnnouncementContract
+};

package/dist/node/announcement/announcement.schema.js

@@ -0,0 +1,30 @@
+// src/announcement/announcement.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var AnnouncementModel = defineSchemaModel({
+  name: "Announcement",
+  description: "Announcement to spaces/org",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    body: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audience: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audienceRole: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    spaceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var PostAnnouncementInputModel = defineSchemaModel({
+  name: "PostAnnouncementInput",
+  description: "Post an announcement",
+  fields: {
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    body: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audience: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audienceRole: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    spaceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    expiresAt: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+export {
+  PostAnnouncementInputModel,
+  AnnouncementModel
+};

package/dist/node/announcement/index.js

@@ -0,0 +1,73 @@
+// src/announcement/announcement.schema.ts
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
+var AnnouncementModel = defineSchemaModel({
+  name: "Announcement",
+  description: "Announcement to spaces/org",
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    body: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audience: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audienceRole: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    spaceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
+  }
+});
+var PostAnnouncementInputModel = defineSchemaModel({
+  name: "PostAnnouncementInput",
+  description: "Post an announcement",
+  fields: {
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    body: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audience: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    audienceRole: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    spaceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    expiresAt: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+
+// src/announcement/announcement.operations.ts
+import { defineCommand } from "@contractspec/lib.contracts";
+var OWNERS = ["@examples.team-hub"];
+var PostAnnouncementContract = defineCommand({
+  meta: {
+    key: "team.announcement.post",
+    version: "1.0.0",
+    stability: "stable",
+    owners: [...OWNERS],
+    tags: ["team-hub", "announcement", "post"],
+    description: "Post an announcement.",
+    goal: "Communicate with team.",
+    context: "Communication."
+  },
+  io: {
+    input: PostAnnouncementInputModel,
+    output: AnnouncementModel
+  },
+  policy: { auth: "user" },
+  acceptance: {
+    scenarios: [
+      {
+        key: "post-announcement-happy-path",
+        given: ["User is authenticated"],
+        when: ["User posts an announcement"],
+        then: ["Announcement is posted and distributed"]
+      }
+    ],
+    examples: [
+      {
+        key: "post-general",
+        input: {
+          spaceId: "space-123",
+          title: "New Policy",
+          content: "Please read..."
+        },
+        output: { id: "ann-456", status: "posted" }
+      }
+    ]
+  }
+});
+export {
+  PostAnnouncementInputModel,
+  PostAnnouncementContract,
+  AnnouncementModel
+};

package/dist/node/docs/index.js

@@ -0,0 +1,94 @@
+// src/docs/team-hub.docblock.ts
+import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
+var teamHubDocBlocks = [
+  {
+    id: "docs.examples.team-hub",
+    title: "Team Hub",
+    summary: "Internal collaboration hub with spaces, tasks, rituals, and announcements.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/team-hub",
+    tags: ["tasks", "rituals", "announcements", "collaboration"],
+    body: `## Domains
+
+- Spaces/projects with members and roles.
+- Tasks with status, priority, assignees, due dates.
+- Rituals (standups/retros/planning) with cadence and attendance.
+- Announcements targeted by space or role.
+
+## Modules reused
+- Identity/RBAC for roles and membership
+- Notifications for reminders and announcements
+- Jobs for scheduling rituals/reminders
+- Audit trail for state changes
+
+## Presentations
+- Dashboard, space list, task board/detail, ritual calendar, announcement feed.
+`
+  },
+  {
+    id: "docs.examples.team-hub.goal",
+    title: "Team Hub — Goal",
+    summary: "Why this collaboration hub exists and outcomes it targets.",
+    kind: "goal",
+    visibility: "public",
+    route: "/docs/examples/team-hub/goal",
+    tags: ["collaboration", "goal"],
+    body: `## Why it matters
+- Provides a regenerable hub for spaces, tasks, rituals, and announcements.
+- Keeps ceremonies and task flows consistent across UI/API/events.
+
+## Business/Product goal
+- Support team rituals with reminders, visibility, and auditability.
+- Enable staged rollouts of new rituals/boards via feature flags.
+
+## Success criteria
+- Tasks/rituals/announcements regenerate safely from spec updates.
+- Notifications and audit hooks fire for key transitions.`
+  },
+  {
+    id: "docs.examples.team-hub.usage",
+    title: "Team Hub — Usage",
+    summary: "How to set up spaces, tasks, and rituals and regenerate safely.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/team-hub/usage",
+    tags: ["collaboration", "usage"],
+    body: `## Setup
+1) Seed (if available) or create a space; add members and tasks; schedule rituals.
+2) Configure Notifications for rituals/reminders and announcements; use Jobs for scheduling.
+
+## Extend & regenerate
+1) Adjust schemas: task priority/status, ritual cadence/attendance, announcement targeting.
+2) Regenerate to update boards/calendars/feeds; mark PII paths as needed.
+3) Use Feature Flags to trial new rituals or task views.
+
+## Guardrails
+- Emit events for task/ritual/announcement changes; log in Audit Trail.
+- Keep ritual cadence declarative; avoid hardcoded schedules.
+- Ensure announcements carry title/description for accessibility.`
+  },
+  {
+    id: "docs.examples.team-hub.constraints",
+    title: "Team Hub — Constraints & Safety",
+    summary: "Internal guardrails for rituals, tasks, and announcements regeneration.",
+    kind: "reference",
+    visibility: "internal",
+    route: "/docs/examples/team-hub/constraints",
+    tags: ["collaboration", "constraints", "internal"],
+    body: `## Constraints
+- Ritual cadence and task states must stay declarative in spec; no hardcoded schedules.
+- Events to emit: task.created/updated/completed, ritual.scheduled/completed, announcement.published.
+- Regeneration should not drop reminders or announcements routing.
+
+## PII & A11y
+- Mark PII (names/emails) for redaction in presentations.
+- Announcements must include title/description; respect accessibility guidance.
+
+## Verification
+- Add fixtures for ritual cadence changes and announcement targeting.
+- Ensure Notifications/Jobs wiring persists after regeneration.
+- Use Feature Flags to trial new boards/rituals with safe defaults.`
+  }
+];
+registerDocBlocks(teamHubDocBlocks);

package/dist/node/docs/team-hub.docblock.js

@@ -0,0 +1,94 @@
+// src/docs/team-hub.docblock.ts
+import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
+var teamHubDocBlocks = [
+  {
+    id: "docs.examples.team-hub",
+    title: "Team Hub",
+    summary: "Internal collaboration hub with spaces, tasks, rituals, and announcements.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/team-hub",
+    tags: ["tasks", "rituals", "announcements", "collaboration"],
+    body: `## Domains
+
+- Spaces/projects with members and roles.
+- Tasks with status, priority, assignees, due dates.
+- Rituals (standups/retros/planning) with cadence and attendance.
+- Announcements targeted by space or role.
+
+## Modules reused
+- Identity/RBAC for roles and membership
+- Notifications for reminders and announcements
+- Jobs for scheduling rituals/reminders
+- Audit trail for state changes
+
+## Presentations
+- Dashboard, space list, task board/detail, ritual calendar, announcement feed.
+`
+  },
+  {
+    id: "docs.examples.team-hub.goal",
+    title: "Team Hub — Goal",
+    summary: "Why this collaboration hub exists and outcomes it targets.",
+    kind: "goal",
+    visibility: "public",
+    route: "/docs/examples/team-hub/goal",
+    tags: ["collaboration", "goal"],
+    body: `## Why it matters
+- Provides a regenerable hub for spaces, tasks, rituals, and announcements.
+- Keeps ceremonies and task flows consistent across UI/API/events.
+
+## Business/Product goal
+- Support team rituals with reminders, visibility, and auditability.
+- Enable staged rollouts of new rituals/boards via feature flags.
+
+## Success criteria
+- Tasks/rituals/announcements regenerate safely from spec updates.
+- Notifications and audit hooks fire for key transitions.`
+  },
+  {
+    id: "docs.examples.team-hub.usage",
+    title: "Team Hub — Usage",
+    summary: "How to set up spaces, tasks, and rituals and regenerate safely.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/team-hub/usage",
+    tags: ["collaboration", "usage"],
+    body: `## Setup
+1) Seed (if available) or create a space; add members and tasks; schedule rituals.
+2) Configure Notifications for rituals/reminders and announcements; use Jobs for scheduling.
+
+## Extend & regenerate
+1) Adjust schemas: task priority/status, ritual cadence/attendance, announcement targeting.
+2) Regenerate to update boards/calendars/feeds; mark PII paths as needed.
+3) Use Feature Flags to trial new rituals or task views.
+
+## Guardrails
+- Emit events for task/ritual/announcement changes; log in Audit Trail.
+- Keep ritual cadence declarative; avoid hardcoded schedules.
+- Ensure announcements carry title/description for accessibility.`
+  },
+  {
+    id: "docs.examples.team-hub.constraints",
+    title: "Team Hub — Constraints & Safety",
+    summary: "Internal guardrails for rituals, tasks, and announcements regeneration.",
+    kind: "reference",
+    visibility: "internal",
+    route: "/docs/examples/team-hub/constraints",
+    tags: ["collaboration", "constraints", "internal"],
+    body: `## Constraints
+- Ritual cadence and task states must stay declarative in spec; no hardcoded schedules.
+- Events to emit: task.created/updated/completed, ritual.scheduled/completed, announcement.published.
+- Regeneration should not drop reminders or announcements routing.
+
+## PII & A11y
+- Mark PII (names/emails) for redaction in presentations.
+- Announcements must include title/description; respect accessibility guidance.
+
+## Verification
+- Add fixtures for ritual cadence changes and announcement targeting.
+- Ensure Notifications/Jobs wiring persists after regeneration.
+- Use Feature Flags to trial new boards/rituals with safe defaults.`
+  }
+];
+registerDocBlocks(teamHubDocBlocks);

package/dist/node/entities/index.js

@@ -0,0 +1,231 @@
+// src/entities/index.ts
+import {
+  defineEntity,
+  defineEntityEnum,
+  field,
+  index
+} from "@contractspec/lib.schema";
+var schema = "lssm_team_hub";
+var TaskStatusEnum = defineEntityEnum({
+  name: "TaskStatus",
+  schema,
+  values: ["BACKLOG", "IN_PROGRESS", "BLOCKED", "DONE"],
+  description: "Task workflow status."
+});
+var TaskPriorityEnum = defineEntityEnum({
+  name: "TaskPriority",
+  schema,
+  values: ["LOW", "MEDIUM", "HIGH", "CRITICAL"],
+  description: "Task priority levels."
+});
+var RitualCadenceEnum = defineEntityEnum({
+  name: "RitualCadence",
+  schema,
+  values: ["DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY"],
+  description: "Recurrence cadence for rituals."
+});
+var AnnouncementAudienceEnum = defineEntityEnum({
+  name: "AnnouncementAudience",
+  schema,
+  values: ["ALL", "SPACE", "ROLE"],
+  description: "Targeting scope for announcements."
+});
+var SpaceEntity = defineEntity({
+  name: "Space",
+  description: "Space/project container for a team.",
+  schema,
+  map: "space",
+  fields: {
+    id: field.id({ description: "Unique space identifier" }),
+    name: field.string({ description: "Space name" }),
+    description: field.string({
+      description: "Space description",
+      isOptional: true
+    }),
+    orgId: field.string({ description: "Organization ID" }),
+    ownerId: field.string({ description: "Space owner" }),
+    members: field.json({ description: "Member roles map", isOptional: true }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt(),
+    tasks: field.hasMany("Task"),
+    rituals: field.hasMany("Ritual"),
+    announcements: field.hasMany("Announcement")
+  },
+  indexes: [index.on(["orgId"]), index.on(["ownerId"]), index.on(["name"])]
+});
+var TaskEntity = defineEntity({
+  name: "Task",
+  description: "Work item within a space.",
+  schema,
+  map: "task",
+  fields: {
+    id: field.id({ description: "Unique task identifier" }),
+    spaceId: field.foreignKey({ description: "Parent space" }),
+    title: field.string({ description: "Task title" }),
+    description: field.string({
+      description: "Task details",
+      isOptional: true
+    }),
+    status: field.enum("TaskStatus", {
+      description: "Task status",
+      default: "BACKLOG"
+    }),
+    priority: field.enum("TaskPriority", {
+      description: "Task priority",
+      default: "MEDIUM"
+    }),
+    assigneeId: field.string({
+      description: "User assigned",
+      isOptional: true
+    }),
+    dueDate: field.dateTime({ description: "Due date", isOptional: true }),
+    tags: field.json({ description: "Labels/tags", isOptional: true }),
+    orgId: field.string({ description: "Organization ID" }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt(),
+    space: field.belongsTo("Space", ["spaceId"], ["id"], {
+      onDelete: "Cascade"
+    })
+  },
+  enums: [TaskStatusEnum, TaskPriorityEnum],
+  indexes: [
+    index.on(["spaceId"]),
+    index.on(["orgId", "status"]),
+    index.on(["assigneeId", "status"]),
+    index.on(["dueDate"])
+  ]
+});
+var RitualEntity = defineEntity({
+  name: "Ritual",
+  description: "Recurring ceremony (standup, retro, planning).",
+  schema,
+  map: "ritual",
+  fields: {
+    id: field.id({ description: "Unique ritual identifier" }),
+    spaceId: field.foreignKey({ description: "Parent space" }),
+    title: field.string({ description: "Ritual title" }),
+    cadence: field.enum("RitualCadence", { description: "Ritual cadence" }),
+    dayOfWeek: field.string({ description: "Day of week", isOptional: true }),
+    time: field.string({ description: "Local time (HH:mm)", isOptional: true }),
+    facilitatorId: field.string({
+      description: "Facilitator user ID",
+      isOptional: true
+    }),
+    participants: field.json({
+      description: "Participant user IDs",
+      isOptional: true
+    }),
+    location: field.string({ description: "Location/URL", isOptional: true }),
+    agendaTemplate: field.string({
+      description: "Agenda template markdown",
+      isOptional: true
+    }),
+    orgId: field.string({ description: "Organization ID" }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt(),
+    occurrences: field.hasMany("RitualOccurrence"),
+    space: field.belongsTo("Space", ["spaceId"], ["id"], {
+      onDelete: "Cascade"
+    })
+  },
+  enums: [RitualCadenceEnum],
+  indexes: [index.on(["spaceId"]), index.on(["orgId"])]
+});
+var RitualOccurrenceEntity = defineEntity({
+  name: "RitualOccurrence",
+  description: "Specific occurrence of a ritual.",
+  schema,
+  map: "ritual_occurrence",
+  fields: {
+    id: field.id({ description: "Unique occurrence identifier" }),
+    ritualId: field.foreignKey({ description: "Parent ritual" }),
+    scheduledFor: field.dateTime({ description: "Scheduled datetime" }),
+    status: field.string({
+      description: "Occurrence status",
+      default: '"scheduled"'
+    }),
+    summary: field.string({ description: "Summary/notes", isOptional: true }),
+    attendance: field.json({
+      description: "Attendance list with responses",
+      isOptional: true
+    }),
+    recordingUrl: field.string({
+      description: "Recording link",
+      isOptional: true
+    }),
+    orgId: field.string({ description: "Organization ID" }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt(),
+    ritual: field.belongsTo("Ritual", ["ritualId"], ["id"], {
+      onDelete: "Cascade"
+    })
+  },
+  indexes: [
+    index.on(["ritualId"]),
+    index.on(["scheduledFor"]),
+    index.on(["orgId"])
+  ]
+});
+var AnnouncementEntity = defineEntity({
+  name: "Announcement",
+  description: "Announcement to a space or org.",
+  schema,
+  map: "announcement",
+  fields: {
+    id: field.id({ description: "Unique announcement identifier" }),
+    spaceId: field.string({ description: "Target space", isOptional: true }),
+    title: field.string({ description: "Announcement title" }),
+    body: field.string({ description: "Announcement body" }),
+    audience: field.enum("AnnouncementAudience", {
+      description: "Audience targeting",
+      default: "ALL"
+    }),
+    audienceRole: field.string({
+      description: "Role targeted when audience is ROLE",
+      isOptional: true
+    }),
+    pinnedUntil: field.dateTime({
+      description: "Pin expiration",
+      isOptional: true
+    }),
+    orgId: field.string({ description: "Organization ID" }),
+    createdBy: field.string({ description: "Creator user ID" }),
+    createdAt: field.createdAt(),
+    expiresAt: field.dateTime({
+      description: "Expiration time",
+      isOptional: true
+    })
+  },
+  enums: [AnnouncementAudienceEnum],
+  indexes: [index.on(["orgId"]), index.on(["spaceId"]), index.on(["audience"])]
+});
+var teamHubEntities = [
+  SpaceEntity,
+  TaskEntity,
+  RitualEntity,
+  RitualOccurrenceEntity,
+  AnnouncementEntity
+];
+var teamHubSchemaContribution = {
+  moduleId: "@contractspec/example.team-hub",
+  entities: teamHubEntities,
+  enums: [
+    TaskStatusEnum,
+    TaskPriorityEnum,
+    RitualCadenceEnum,
+    AnnouncementAudienceEnum
+  ]
+};
+export {
+  teamHubSchemaContribution,
+  teamHubEntities,
+  TaskStatusEnum,
+  TaskPriorityEnum,
+  TaskEntity,
+  SpaceEntity,
+  RitualOccurrenceEntity,
+  RitualEntity,
+  RitualCadenceEnum,
+  AnnouncementEntity,
+  AnnouncementAudienceEnum
+};