@proveanything/smartlinks 2.0.47 → 2.0.48

package/dist/openapi.yaml

@@ -74,8 +74,6 @@ tags:
     description: Product facet querying and aggregation.
   - name: form
     description: Form definitions and submissions.
-  - name: functions
-    description: functions API
   - name: integrations
     description: Third-party integration flows and imports.
   - name: interactions
@@ -10024,26 +10022,6 @@ paths:
           description: Unauthorized
         404:
           description: Not found
-  /functions:
-    get:
-      tags:
-        - functions
-      summary: List the public functions available for a collection (discovery).
-      operationId: functions_list
-      security: []
-      responses:
-        200:
-          description: Success
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/FunctionListResponse"
-        400:
-          description: Bad request
-        401:
-          description: Unauthorized
-        404:
-          description: Not found
   /platform/location:
     post:
       tags:
@@ -11360,6 +11338,40 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /public/collection/{collectionId}/comm/signup:
+    post:
+      tags:
+        - comms
+      summary: "Public: sign an email address up for topics (a newsletter, updates) — works signed out."
+      operationId: comms_signup
+      security: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: object
+                additionalProperties: true
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              additionalProperties: true
   /public/collection/{collectionId}/comm/sms/register:
     post:
       tags:
@@ -18888,8 +18900,24 @@ components:
         settings:
           type: object
           additionalProperties: true
+        styleSupport:
+          $ref: "#/components/schemas/WidgetStyleSupport"
       required:
         - name
+    WidgetStyleSupport:
+      type: object
+      properties:
+        accent:
+          type: boolean
+        text:
+          type: boolean
+        textAlign:
+          type: boolean
+        background:
+          type: string
+          enum:
+            - transparent
+            - own
     AppManifestWidgets:
       type: object
       properties:
@@ -23526,7 +23554,6 @@ components:
           type: object
           additionalProperties: true
       required:
-        - contactId
         - endpoint
         - keys
     CommsSettings:
@@ -23618,8 +23645,6 @@ components:
           $ref: "#/components/schemas/BroadcastChannel"
         token:
           type: string
-      required:
-        - contactId
     UnsubscribeResponse:
       type: object
       properties:
@@ -23628,6 +23653,27 @@ components:
           additionalProperties: true
       required:
         - ok
+    CommsSignupRequest:
+      type: object
+      properties:
+        email:
+          type: string
+        topics:
+          type: array
+          items:
+            type: string
+        firstName:
+          type: string
+      required:
+        - email
+    CommsSignupResponse:
+      type: object
+      properties:
+        ok:
+          type: object
+          additionalProperties: true
+      required:
+        - ok
     CommsConsentUpsertRequest:
       type: object
       properties:
@@ -23641,8 +23687,6 @@ components:
             type: boolean
         topicsByChannel:
           $ref: "#/components/schemas/BroadcastChannel"
-      required:
-        - contactId
     CommsPreferencesUpsertRequest:
       type: object
       properties:
@@ -23659,8 +23703,6 @@ components:
             type: boolean
         topicsByChannel:
           $ref: "#/components/schemas/BroadcastChannel"
-      required:
-        - contactId
     CommsSubscribeRequest:
       type: object
       properties:
@@ -23674,7 +23716,6 @@ components:
         source:
           type: string
       required:
-        - contactId
         - subject
         - subscribe
     CommsSubscribeResponse:
@@ -23697,7 +23738,6 @@ components:
         productId:
           type: string
       required:
-        - contactId
         - subjectType
         - subjectId
     CommsSubscriptionCheckResponse:
@@ -23715,8 +23755,6 @@ components:
           type: string
         type:
           $ref: "#/components/schemas/BroadcastChannel"
-      required:
-        - contactId
     CommsListMethodsResponse:
       type: object
       properties:

package/dist/types/appManifest.d.ts

@@ -53,6 +53,26 @@ export interface AppWidgetComponent {
     };
     /** JSON-Schema-style settings the widget accepts */
     settings?: Record<string, any>;
+    /**
+     * What styling this widget honours when a host places it (Link Page, Hub…). The host shows only
+     * these controls and sets the matching `--sl-widget-*` variables. Missing = layout controls only.
+     * See docs/widgets.md → "Style support".
+     */
+    styleSupport?: WidgetStyleSupport;
+}
+/** A widget's declared styling support — see {@link AppWidgetComponent.styleSupport}. */
+export interface WidgetStyleSupport {
+    /** Widget reads --sl-widget-accent / --sl-widget-accent-contrast for buttons, links, focus, active states. */
+    accent?: boolean;
+    /** Widget reads --sl-widget-text for its body text, titles and secondary text. */
+    text?: boolean;
+    /** Widget's titles and messages use `text-align: inherit`. */
+    textAlign?: boolean;
+    /**
+     * 'transparent' (recommended): the widget draws no background, so the host's Background shows.
+     * 'own': the widget paints its own card; the host hides Background (padding/border/radius stay).
+     */
+    background?: 'transparent' | 'own';
 }
 /** Widget bundle declaration in `app.manifest.json`. */
 export interface AppManifestWidgets {

package/dist/types/comms.d.ts

@@ -116,7 +116,8 @@ export interface PushSubscribeResponse {
     id: string;
 }
 export interface RegisterPushMethodRequest {
-    contactId: string;
+    /** Optional: defaults to the signed-in user's own contact. Only collection admins may name another contact. */
+    contactId?: string;
     endpoint: string;
     keys: {
         p256dh: string;
@@ -168,7 +169,8 @@ export interface CommsPublicTopicsResponse {
     topics: Record<string, TopicConfig>;
 }
 export interface UnsubscribeQuery {
-    contactId: string;
+    /** Optional: defaults to the signed-in user's own contact. Only collection admins may name another contact. */
+    contactId?: string;
     topic?: string;
     channel?: BroadcastChannel;
     token?: string;
@@ -180,16 +182,28 @@ export interface UnsubscribeResponse {
         topics?: Record<string, boolean>;
     };
 }
+export interface CommsSignupRequest {
+    email: string;
+    /** Topic ids from the collection's comm settings (e.g. ["newsletter"]). */
+    topics?: string[];
+    firstName?: string;
+}
+export interface CommsSignupResponse {
+    ok: true;
+    pending: true;
+}
 export type ConsentChannels = Partial<Record<BroadcastChannel, boolean>>;
 type SubjectType = import('./contact.js').SubjectType;
 export interface CommsConsentUpsertRequest {
-    contactId: string;
+    /** Optional: defaults to the signed-in user's own contact. Only collection admins may name another contact. */
+    contactId?: string;
     channels?: ConsentChannels;
     topics?: Record<string, boolean>;
     topicsByChannel?: Partial<Record<BroadcastChannel, Record<string, boolean>>>;
 }
 export interface CommsPreferencesUpsertRequest {
-    contactId: string;
+    /** Optional: defaults to the signed-in user's own contact. Only collection admins may name another contact. */
+    contactId?: string;
     subject?: {
         type: SubjectType;
         id: string;
@@ -200,7 +214,8 @@ export interface CommsPreferencesUpsertRequest {
     topicsByChannel?: Partial<Record<BroadcastChannel, Record<string, boolean>>>;
 }
 export interface CommsSubscribeRequest {
-    contactId: string;
+    /** Optional: defaults to the signed-in user's own contact. Only collection admins may name another contact. */
+    contactId?: string;
     subject: {
         type: SubjectType;
         id: string;
@@ -214,7 +229,8 @@ export interface CommsSubscribeResponse {
     subscriptionId: string;
 }
 export interface CommsSubscriptionCheckQuery {
-    contactId: string;
+    /** Optional: defaults to the signed-in user's own contact. Only collection admins may name another contact. */
+    contactId?: string;
     subjectType: SubjectType;
     subjectId: string;
     productId?: string;
@@ -224,7 +240,8 @@ export interface CommsSubscriptionCheckResponse {
     subscribed: boolean;
 }
 export interface CommsListMethodsQuery {
-    contactId: string;
+    /** Optional: defaults to the signed-in user's own contact. Only collection admins may name another contact. */
+    contactId?: string;
     type?: BroadcastChannel;
 }
 export interface CommsListMethodsResponse {

package/dist/widgetStyle.d.ts

@@ -0,0 +1,37 @@
+import type { WidgetStyleSupport } from './types/appManifest.js';
+/** The styling a person chose for one placed widget (host side). Colours are hex. */
+export interface WidgetStyling {
+    accent?: string;
+    text?: string;
+    /** Corner radius in px. */
+    radius?: number;
+}
+/** The CSS variables a host sets on a widget's box (only the ones chosen). */
+export declare const WIDGET_STYLE_VARS: {
+    readonly accent: "--sl-widget-accent";
+    readonly accentContrast: "--sl-widget-accent-contrast";
+    readonly text: "--sl-widget-text";
+    readonly radius: "--sl-widget-radius";
+};
+/** Readable text colour on a background: near-black or white, whichever contrasts more. */
+export declare function readableOn(hex: string): '#111111' | '#ffffff';
+/**
+ * Host helper: the `--sl-widget-*` variables for a widget's box, from the styling chosen — and,
+ * when `support` is given, only the ones that widget declared (a host shouldn't set what the widget
+ * ignores). The accent's readable text colour is computed here so every host agrees.
+ */
+export declare function widgetStyleVars(styling: WidgetStyling, support?: WidgetStyleSupport | null): Record<string, string>;
+/**
+ * Host helper: which styling controls to offer for a widget. Layout controls (width, alignment,
+ * padding, scale, radius, border) are always offered — the host owns the box. Colour controls only
+ * when the widget declared them; Background unless the widget paints its own card.
+ * `styleSupport` missing (older widgets) → layout only, and `colours: false` so the host can say
+ * "This widget doesn't offer colour customisation."
+ */
+export declare function widgetStyleControls(support?: WidgetStyleSupport | null): {
+    accent: boolean;
+    text: boolean;
+    textAlign: boolean;
+    background: boolean;
+    colours: boolean;
+};

package/dist/widgetStyle.js

@@ -0,0 +1,64 @@
+// Widget style support — the contract between a widget and the page it's dropped into (Link Page,
+// Hub, any host that places widgets). The widget declares what it supports in its manifest entry
+// (`widgets.components[].styleSupport`); the host shows only those styling controls and sets the
+// `--sl-widget-*` variables below on the widget's box. See docs/widgets.md → "Style support".
+/** The CSS variables a host sets on a widget's box (only the ones chosen). */
+export const WIDGET_STYLE_VARS = {
+    accent: '--sl-widget-accent',
+    accentContrast: '--sl-widget-accent-contrast',
+    text: '--sl-widget-text',
+    radius: '--sl-widget-radius',
+};
+function luminance(hex) {
+    const m = /^#?([0-9a-f]{3}|[0-9a-f]{6})$/i.exec(hex.trim());
+    if (!m)
+        return null;
+    const h = m[1].length === 3 ? m[1].split('').map((c) => c + c).join('') : m[1];
+    const [r, g, b] = [0, 2, 4].map((i) => parseInt(h.slice(i, i + 2), 16) / 255).map((c) => c <= 0.03928 ? c / 12.92 : Math.pow((c + 0.055) / 1.055, 2.4));
+    return 0.2126 * r + 0.7152 * g + 0.0722 * b;
+}
+/** Readable text colour on a background: near-black or white, whichever contrasts more. */
+export function readableOn(hex) {
+    const l = luminance(hex);
+    if (l == null)
+        return '#ffffff';
+    const contrastWhite = 1.05 / (l + 0.05);
+    const contrastDark = (l + 0.05) / (luminance('#111111') + 0.05);
+    return contrastDark >= contrastWhite ? '#111111' : '#ffffff';
+}
+/**
+ * Host helper: the `--sl-widget-*` variables for a widget's box, from the styling chosen — and,
+ * when `support` is given, only the ones that widget declared (a host shouldn't set what the widget
+ * ignores). The accent's readable text colour is computed here so every host agrees.
+ */
+export function widgetStyleVars(styling, support) {
+    const out = {};
+    const allows = (k) => !support || support[k] === true;
+    if (styling.accent && allows('accent')) {
+        out[WIDGET_STYLE_VARS.accent] = styling.accent;
+        out[WIDGET_STYLE_VARS.accentContrast] = readableOn(styling.accent);
+    }
+    if (styling.text && allows('text'))
+        out[WIDGET_STYLE_VARS.text] = styling.text;
+    if (typeof styling.radius === 'number' && Number.isFinite(styling.radius))
+        out[WIDGET_STYLE_VARS.radius] = `${styling.radius}px`;
+    return out;
+}
+/**
+ * Host helper: which styling controls to offer for a widget. Layout controls (width, alignment,
+ * padding, scale, radius, border) are always offered — the host owns the box. Colour controls only
+ * when the widget declared them; Background unless the widget paints its own card.
+ * `styleSupport` missing (older widgets) → layout only, and `colours: false` so the host can say
+ * "This widget doesn't offer colour customisation."
+ */
+export function widgetStyleControls(support) {
+    if (!support)
+        return { accent: false, text: false, textAlign: false, background: true, colours: false };
+    return {
+        accent: support.accent === true,
+        text: support.text === true,
+        textAlign: support.textAlign === true,
+        background: support.background !== 'own',
+        colours: support.accent === true || support.text === true,
+    };
+}