@stina/extension-api 1.7.0 → 1.9.0

package/src/schemas/card.schema.test.ts

@@ -30,6 +30,30 @@ describe('validateChatCard', () => {
     expect(result.ok).toBe(true)
   })
 
+  it('accepts a quotation with its attribution', () => {
+    const result = validateChatCard({
+      component: 'Quote',
+      text: 'Fyll gärna i del två i mallen innan vi ses.',
+      source: 'Maria Lind',
+      context: 'i morse 07:42',
+      footer: 'Ur mejlet om medarbetarsamtalet',
+    })
+
+    expect(result.ok).toBe(true)
+  })
+
+  it('rejects markup properties on a quotation', () => {
+    // Quoted text is printed as it arrived. A property that implied formatting
+    // would let someone else's words be dressed up as Stina's own.
+    const result = validateChatCard({
+      component: 'Quote',
+      text: 'Fyll gärna i del två.',
+      variant: 'accent',
+    })
+
+    expect(result.ok).toBe(false)
+  })
+
   it('accepts an icon beside every heading that has one', () => {
     for (const card of [
       { component: 'Chart', icon: 'temperature', series: [{ points: [1] }] },

package/src/schemas/card.schema.ts

@@ -333,6 +333,17 @@ const NoteCardSchema = z
   })
   .strict()
 
+const QuoteCardSchema = z
+  .object({
+    component: z.literal('Quote'),
+    text: z.string(),
+    source: z.string().optional(),
+    context: z.string().optional(),
+    footer: z.string().optional(),
+    style,
+  })
+  .strict()
+
 const CalendarEventCardSchema = z
   .object({
     component: z.literal('CalendarEvent'),
@@ -373,6 +384,7 @@ export const CHAT_CARD_COMPONENTS = [
   'KeyValueList',
   'Timeline',
   'Note',
+  'Quote',
   'CalendarEvent',
 ] as const
 
@@ -406,6 +418,7 @@ const CARD_MEMBERS = [
   KeyValueListCardSchema,
   TimelineCardSchema,
   NoteCardSchema,
+  QuoteCardSchema,
   CalendarEventCardSchema,
 ] as const
 

package/src/types.components.ts

@@ -886,6 +886,33 @@ export interface NoteProps extends ExtensionComponentData {
   variant?: NoteVariant
 }
 
+/**
+ * The extension API properties for the Quote component.
+ *
+ * Someone else's words, set apart and attributed. For the sentence out of a mail
+ * that actually answers the question, the line from a document worth reading as
+ * written, the message a colleague sent.
+ *
+ * The text is rendered as written and never as markdown, which is the whole
+ * point of it existing beside `Note`: a link or a heading inside quoted text
+ * would be formatted as though Stina had put it there. `Note` is for the user's
+ * own writing and for hers; this is for everyone else's.
+ *
+ * Quote what bears quoting, not the whole message. A card is a thing to glance
+ * at, and a page of pasted mail is a page nobody reads.
+ */
+export interface QuoteProps extends ExtensionComponentData {
+  component: 'Quote'
+  /** The words themselves, verbatim. Rendered as written, never as markdown. */
+  text: string
+  /** Who wrote or said it, as they are known: a name, an address, a title. */
+  source?: string
+  /** When or where it came from: `i morse 07:42`, `i mötesanteckningarna`. */
+  context?: string
+  /** One quiet line under the quotation, for what is worth adding about it. */
+  footer?: string
+}
+
 /** Whether an event is going ahead. */
 export type CalendarEventStatus = 'confirmed' | 'tentative' | 'cancelled'