@beabee/beabee-common 1.17.1 → 1.18.0-alpha.2

package/dist/cjs/search/callouts.js

@@ -20,9 +20,11 @@ exports.calloutFilters = {
     },
     starts: {
         type: "date",
+        nullable: true,
     },
     expires: {
         type: "date",
+        nullable: true,
     },
     hidden: {
         type: "boolean",

package/dist/cjs/search/contacts.js

@@ -20,6 +20,7 @@ exports.contactFilters = {
     },
     contributionCancelled: {
         type: "date",
+        nullable: true,
     },
     contributionType: {
         type: "enum",

package/dist/cjs/utils/callouts.js

@@ -1,15 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringifyAnswer = exports.convertComponentsToFilters = exports.flattenComponents = void 0;
+exports.stringifyAnswer = exports.isFileUploadAnswer = exports.isAddressAnswer = exports.convertComponentsToFilters = exports.getCalloutComponents = exports.filterComponents = void 0;
 function isNestableComponent(component) {
-    return "components" in component;
+    // Addresses have embedded components we don't want to include
+    return "components" in component && component.type !== "address";
 }
+function filterComponents(components, filterFn) {
+    return components.filter(filterFn).map((component) => {
+        return {
+            ...component,
+            ...(isNestableComponent(component) && {
+                components: filterComponents(component.components, filterFn),
+            }),
+        };
+    });
+}
+exports.filterComponents = filterComponents;
 function flattenComponents(components) {
     return components.flatMap((component) => isNestableComponent(component)
         ? [component, ...flattenComponents(component.components)]
         : [component]);
 }
-exports.flattenComponents = flattenComponents;
+function getCalloutComponents(callout) {
+    return callout.slides.flatMap((slide) => flattenComponents(slide.components));
+}
+exports.getCalloutComponents = getCalloutComponents;
 function convertValuesToOptions(values) {
     return values.map(({ value, label }) => value);
 }
@@ -60,11 +75,29 @@ function getNiceAnswer(component, value) {
             return value;
     }
 }
+function isAddressAnswer(answer) {
+    return !!answer && typeof answer === "object" && "geometry" in answer;
+}
+exports.isAddressAnswer = isAddressAnswer;
+function isFileUploadAnswer(answer) {
+    return !!answer && typeof answer === "object" && "url" in answer;
+}
+exports.isFileUploadAnswer = isFileUploadAnswer;
 function stringifyAnswer(component, answer) {
-    if (!answer) {
+    if (Array.isArray(answer)) {
+        return answer.map((a) => stringifyAnswer(component, a)).join(", ");
+    }
+    else if (!answer) {
         return "";
     }
+    else if (isAddressAnswer(answer)) {
+        return answer.formatted_address;
+    }
+    else if (isFileUploadAnswer(answer)) {
+        return answer.url;
+    }
     else if (typeof answer === "object") {
+        // Checkboxes
         return Object.entries(answer)
             .filter(([, selected]) => selected)
             .map(([value]) => getNiceAnswer(component, value))

package/dist/esm/search/callouts.js

@@ -17,9 +17,11 @@ export const calloutFilters = {
     },
     starts: {
         type: "date",
+        nullable: true,
     },
     expires: {
         type: "date",
+        nullable: true,
     },
     hidden: {
         type: "boolean",

package/dist/esm/search/contacts.js

@@ -17,6 +17,7 @@ export const contactFilters = {
     },
     contributionCancelled: {
         type: "date",
+        nullable: true,
     },
     contributionType: {
         type: "enum",

package/dist/esm/utils/callouts.js

@@ -1,11 +1,25 @@
 function isNestableComponent(component) {
-    return "components" in component;
+    // Addresses have embedded components we don't want to include
+    return "components" in component && component.type !== "address";
 }
-export function flattenComponents(components) {
+export function filterComponents(components, filterFn) {
+    return components.filter(filterFn).map((component) => {
+        return {
+            ...component,
+            ...(isNestableComponent(component) && {
+                components: filterComponents(component.components, filterFn),
+            }),
+        };
+    });
+}
+function flattenComponents(components) {
     return components.flatMap((component) => isNestableComponent(component)
         ? [component, ...flattenComponents(component.components)]
         : [component]);
 }
+export function getCalloutComponents(callout) {
+    return callout.slides.flatMap((slide) => flattenComponents(slide.components));
+}
 function convertValuesToOptions(values) {
     return values.map(({ value, label }) => value);
 }
@@ -55,11 +69,27 @@ function getNiceAnswer(component, value) {
             return value;
     }
 }
+export function isAddressAnswer(answer) {
+    return !!answer && typeof answer === "object" && "geometry" in answer;
+}
+export function isFileUploadAnswer(answer) {
+    return !!answer && typeof answer === "object" && "url" in answer;
+}
 export function stringifyAnswer(component, answer) {
-    if (!answer) {
+    if (Array.isArray(answer)) {
+        return answer.map((a) => stringifyAnswer(component, a)).join(", ");
+    }
+    else if (!answer) {
         return "";
     }
+    else if (isAddressAnswer(answer)) {
+        return answer.formatted_address;
+    }
+    else if (isFileUploadAnswer(answer)) {
+        return answer.url;
+    }
     else if (typeof answer === "object") {
+        // Checkboxes
         return Object.entries(answer)
             .filter(([, selected]) => selected)
             .map(([value]) => getNiceAnswer(component, value))

package/dist/types/data/callouts.d.ts

@@ -2,8 +2,9 @@ export interface BaseCalloutComponentSchema {
     id: string;
     type: string;
     key: string;
-    label: string;
-    input: boolean;
+    label?: string;
+    input?: boolean;
+    adminOnly?: boolean;
     [key: string]: unknown;
 }
 export interface NestableCalloutComponentSchema extends BaseCalloutComponentSchema {
@@ -12,7 +13,7 @@ export interface NestableCalloutComponentSchema extends BaseCalloutComponentSche
     components: CalloutComponentSchema[];
 }
 export interface InputCalloutComponentSchema extends BaseCalloutComponentSchema {
-    type: "address" | "button" | "checkbox" | "email" | "number" | "password" | "textfield" | "textarea";
+    type: "address" | "button" | "checkbox" | "email" | "file" | "number" | "password" | "textfield" | "textarea";
     input: true;
 }
 export interface SelectCalloutComponentSchema extends BaseCalloutComponentSchema {
@@ -34,22 +35,30 @@ export interface RadioCalloutComponentSchema extends BaseCalloutComponentSchema
     }[];
 }
 export type CalloutComponentSchema = SelectCalloutComponentSchema | RadioCalloutComponentSchema | InputCalloutComponentSchema | NestableCalloutComponentSchema;
-export interface CalloutPageSchema extends NestableCalloutComponentSchema {
-    type: "panel";
-    title: string;
-    navigation: CalloutNavigationSchema;
-}
 export interface CalloutNavigationSchema {
-    showPrev: boolean;
-    showNext: boolean;
     prevText: string;
     nextText: string;
     nextSlideId: string;
     submitText: string;
 }
+export interface CalloutSlideSchema {
+    components: CalloutComponentSchema[];
+    navigation: CalloutNavigationSchema;
+}
 export interface CalloutFormSchema {
-    display?: "form" | "wizard";
-    components: CalloutPageSchema[];
+    slides: CalloutSlideSchema[];
+}
+export interface CalloutResponseAnswerAddress {
+    formatted_address: string;
+    geometry: {
+        location: {
+            lat: number;
+            lng: number;
+        };
+    };
+}
+export interface CalloutResponseAnswerFileUpload {
+    url: string;
 }
-export type CalloutResponseAnswer = string | boolean | number | null | undefined | Record<string, boolean>;
-export type CalloutResponseAnswers = Record<string, CalloutResponseAnswer>;
+export type CalloutResponseAnswer = string | boolean | number | null | undefined | Record<string, boolean> | CalloutResponseAnswerAddress | CalloutResponseAnswerFileUpload;
+export type CalloutResponseAnswers = Record<string, CalloutResponseAnswer | CalloutResponseAnswer[]>;

package/dist/types/search/callouts.d.ts

@@ -12,9 +12,11 @@ export declare const calloutFilters: {
     };
     readonly starts: {
         readonly type: "date";
+        readonly nullable: true;
     };
     readonly expires: {
         readonly type: "date";
+        readonly nullable: true;
     };
     readonly hidden: {
         readonly type: "boolean";

package/dist/types/search/contacts.d.ts

@@ -17,6 +17,7 @@ export declare const contactFilters: {
     };
     readonly contributionCancelled: {
         readonly type: "date";
+        readonly nullable: true;
     };
     readonly contributionType: {
         readonly type: "enum";

package/dist/types/utils/callouts.d.ts

@@ -1,7 +1,11 @@
-import { CalloutComponentSchema, CalloutResponseAnswer } from "../data/callouts";
+import { CalloutComponentSchema, CalloutFormSchema, CalloutResponseAnswer } from "../data/callouts";
 import { FilterArgs } from "../search";
-export declare function flattenComponents(components: CalloutComponentSchema[]): CalloutComponentSchema[];
+import { CalloutResponseAnswerAddress, CalloutResponseAnswerFileUpload } from "../data/callouts";
+export declare function filterComponents(components: CalloutComponentSchema[], filterFn: (component: CalloutComponentSchema) => boolean): CalloutComponentSchema[];
+export declare function getCalloutComponents(callout: CalloutFormSchema): CalloutComponentSchema[];
 export declare function convertComponentsToFilters(components: CalloutComponentSchema[]): Record<string, FilterArgs & {
     label: string;
 }>;
-export declare function stringifyAnswer(component: CalloutComponentSchema, answer: CalloutResponseAnswer): string;
+export declare function isAddressAnswer(answer: CalloutResponseAnswer): answer is CalloutResponseAnswerAddress;
+export declare function isFileUploadAnswer(answer: CalloutResponseAnswer): answer is CalloutResponseAnswerFileUpload;
+export declare function stringifyAnswer(component: CalloutComponentSchema, answer: CalloutResponseAnswer | CalloutResponseAnswer[]): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beabee/beabee-common",
-  "version": "1.17.1",
+  "version": "1.18.0-alpha.2",
   "description": "",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",