@frt-platform/report-core 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,350 @@
+import { z } from 'zod';
+
+declare const REPORT_TEMPLATE_VERSION = 1;
+declare const REPORT_TEMPLATE_FIELD_TYPES: readonly ["shortText", "longText", "number", "date", "checkbox", "singleSelect", "multiSelect", "starRating"];
+type ReportTemplateFieldType = (typeof REPORT_TEMPLATE_FIELD_TYPES)[number];
+declare const ReportTemplateFieldSchema: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodString;
+    label: z.ZodString;
+    required: z.ZodOptional<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+    placeholder: z.ZodOptional<z.ZodString>;
+    options: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    allowOther: z.ZodOptional<z.ZodBoolean>;
+    defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodString, "many">, z.ZodNull]>>;
+    minLength: z.ZodOptional<z.ZodNumber>;
+    maxLength: z.ZodOptional<z.ZodNumber>;
+    minValue: z.ZodOptional<z.ZodNumber>;
+    maxValue: z.ZodOptional<z.ZodNumber>;
+    step: z.ZodOptional<z.ZodNumber>;
+    minSelections: z.ZodOptional<z.ZodNumber>;
+    maxSelections: z.ZodOptional<z.ZodNumber>;
+    dataClassification: z.ZodOptional<z.ZodEnum<["none", "personal", "special"]>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    type: string;
+    label: string;
+    required?: boolean | undefined;
+    description?: string | undefined;
+    placeholder?: string | undefined;
+    options?: string[] | undefined;
+    allowOther?: boolean | undefined;
+    defaultValue?: string | number | boolean | string[] | null | undefined;
+    minLength?: number | undefined;
+    maxLength?: number | undefined;
+    minValue?: number | undefined;
+    maxValue?: number | undefined;
+    step?: number | undefined;
+    minSelections?: number | undefined;
+    maxSelections?: number | undefined;
+    dataClassification?: "none" | "personal" | "special" | undefined;
+}, {
+    id: string;
+    type: string;
+    label: string;
+    required?: boolean | undefined;
+    description?: string | undefined;
+    placeholder?: string | undefined;
+    options?: string[] | undefined;
+    allowOther?: boolean | undefined;
+    defaultValue?: string | number | boolean | string[] | null | undefined;
+    minLength?: number | undefined;
+    maxLength?: number | undefined;
+    minValue?: number | undefined;
+    maxValue?: number | undefined;
+    step?: number | undefined;
+    minSelections?: number | undefined;
+    maxSelections?: number | undefined;
+    dataClassification?: "none" | "personal" | "special" | undefined;
+}>;
+type ReportTemplateField = z.infer<typeof ReportTemplateFieldSchema>;
+declare const ReportTemplateSectionSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    fields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodString;
+        label: z.ZodString;
+        required: z.ZodOptional<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+        placeholder: z.ZodOptional<z.ZodString>;
+        options: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        allowOther: z.ZodOptional<z.ZodBoolean>;
+        defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodString, "many">, z.ZodNull]>>;
+        minLength: z.ZodOptional<z.ZodNumber>;
+        maxLength: z.ZodOptional<z.ZodNumber>;
+        minValue: z.ZodOptional<z.ZodNumber>;
+        maxValue: z.ZodOptional<z.ZodNumber>;
+        step: z.ZodOptional<z.ZodNumber>;
+        minSelections: z.ZodOptional<z.ZodNumber>;
+        maxSelections: z.ZodOptional<z.ZodNumber>;
+        dataClassification: z.ZodOptional<z.ZodEnum<["none", "personal", "special"]>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        type: string;
+        label: string;
+        required?: boolean | undefined;
+        description?: string | undefined;
+        placeholder?: string | undefined;
+        options?: string[] | undefined;
+        allowOther?: boolean | undefined;
+        defaultValue?: string | number | boolean | string[] | null | undefined;
+        minLength?: number | undefined;
+        maxLength?: number | undefined;
+        minValue?: number | undefined;
+        maxValue?: number | undefined;
+        step?: number | undefined;
+        minSelections?: number | undefined;
+        maxSelections?: number | undefined;
+        dataClassification?: "none" | "personal" | "special" | undefined;
+    }, {
+        id: string;
+        type: string;
+        label: string;
+        required?: boolean | undefined;
+        description?: string | undefined;
+        placeholder?: string | undefined;
+        options?: string[] | undefined;
+        allowOther?: boolean | undefined;
+        defaultValue?: string | number | boolean | string[] | null | undefined;
+        minLength?: number | undefined;
+        maxLength?: number | undefined;
+        minValue?: number | undefined;
+        maxValue?: number | undefined;
+        step?: number | undefined;
+        minSelections?: number | undefined;
+        maxSelections?: number | undefined;
+        dataClassification?: "none" | "personal" | "special" | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    fields: {
+        id: string;
+        type: string;
+        label: string;
+        required?: boolean | undefined;
+        description?: string | undefined;
+        placeholder?: string | undefined;
+        options?: string[] | undefined;
+        allowOther?: boolean | undefined;
+        defaultValue?: string | number | boolean | string[] | null | undefined;
+        minLength?: number | undefined;
+        maxLength?: number | undefined;
+        minValue?: number | undefined;
+        maxValue?: number | undefined;
+        step?: number | undefined;
+        minSelections?: number | undefined;
+        maxSelections?: number | undefined;
+        dataClassification?: "none" | "personal" | "special" | undefined;
+    }[];
+    description?: string | undefined;
+    title?: string | undefined;
+}, {
+    id: string;
+    description?: string | undefined;
+    title?: string | undefined;
+    fields?: {
+        id: string;
+        type: string;
+        label: string;
+        required?: boolean | undefined;
+        description?: string | undefined;
+        placeholder?: string | undefined;
+        options?: string[] | undefined;
+        allowOther?: boolean | undefined;
+        defaultValue?: string | number | boolean | string[] | null | undefined;
+        minLength?: number | undefined;
+        maxLength?: number | undefined;
+        minValue?: number | undefined;
+        maxValue?: number | undefined;
+        step?: number | undefined;
+        minSelections?: number | undefined;
+        maxSelections?: number | undefined;
+        dataClassification?: "none" | "personal" | "special" | undefined;
+    }[] | undefined;
+}>;
+type ReportTemplateSection = z.infer<typeof ReportTemplateSectionSchema>;
+declare const ReportTemplateSchemaValidator: z.ZodObject<{
+    version: z.ZodDefault<z.ZodNumber>;
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    sections: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        fields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            type: z.ZodString;
+            label: z.ZodString;
+            required: z.ZodOptional<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+            placeholder: z.ZodOptional<z.ZodString>;
+            options: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            allowOther: z.ZodOptional<z.ZodBoolean>;
+            defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodString, "many">, z.ZodNull]>>;
+            minLength: z.ZodOptional<z.ZodNumber>;
+            maxLength: z.ZodOptional<z.ZodNumber>;
+            minValue: z.ZodOptional<z.ZodNumber>;
+            maxValue: z.ZodOptional<z.ZodNumber>;
+            step: z.ZodOptional<z.ZodNumber>;
+            minSelections: z.ZodOptional<z.ZodNumber>;
+            maxSelections: z.ZodOptional<z.ZodNumber>;
+            dataClassification: z.ZodOptional<z.ZodEnum<["none", "personal", "special"]>>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            type: string;
+            label: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            placeholder?: string | undefined;
+            options?: string[] | undefined;
+            allowOther?: boolean | undefined;
+            defaultValue?: string | number | boolean | string[] | null | undefined;
+            minLength?: number | undefined;
+            maxLength?: number | undefined;
+            minValue?: number | undefined;
+            maxValue?: number | undefined;
+            step?: number | undefined;
+            minSelections?: number | undefined;
+            maxSelections?: number | undefined;
+            dataClassification?: "none" | "personal" | "special" | undefined;
+        }, {
+            id: string;
+            type: string;
+            label: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            placeholder?: string | undefined;
+            options?: string[] | undefined;
+            allowOther?: boolean | undefined;
+            defaultValue?: string | number | boolean | string[] | null | undefined;
+            minLength?: number | undefined;
+            maxLength?: number | undefined;
+            minValue?: number | undefined;
+            maxValue?: number | undefined;
+            step?: number | undefined;
+            minSelections?: number | undefined;
+            maxSelections?: number | undefined;
+            dataClassification?: "none" | "personal" | "special" | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        fields: {
+            id: string;
+            type: string;
+            label: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            placeholder?: string | undefined;
+            options?: string[] | undefined;
+            allowOther?: boolean | undefined;
+            defaultValue?: string | number | boolean | string[] | null | undefined;
+            minLength?: number | undefined;
+            maxLength?: number | undefined;
+            minValue?: number | undefined;
+            maxValue?: number | undefined;
+            step?: number | undefined;
+            minSelections?: number | undefined;
+            maxSelections?: number | undefined;
+            dataClassification?: "none" | "personal" | "special" | undefined;
+        }[];
+        description?: string | undefined;
+        title?: string | undefined;
+    }, {
+        id: string;
+        description?: string | undefined;
+        title?: string | undefined;
+        fields?: {
+            id: string;
+            type: string;
+            label: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            placeholder?: string | undefined;
+            options?: string[] | undefined;
+            allowOther?: boolean | undefined;
+            defaultValue?: string | number | boolean | string[] | null | undefined;
+            minLength?: number | undefined;
+            maxLength?: number | undefined;
+            minValue?: number | undefined;
+            maxValue?: number | undefined;
+            step?: number | undefined;
+            minSelections?: number | undefined;
+            maxSelections?: number | undefined;
+            dataClassification?: "none" | "personal" | "special" | undefined;
+        }[] | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    version: number;
+    sections: {
+        id: string;
+        fields: {
+            id: string;
+            type: string;
+            label: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            placeholder?: string | undefined;
+            options?: string[] | undefined;
+            allowOther?: boolean | undefined;
+            defaultValue?: string | number | boolean | string[] | null | undefined;
+            minLength?: number | undefined;
+            maxLength?: number | undefined;
+            minValue?: number | undefined;
+            maxValue?: number | undefined;
+            step?: number | undefined;
+            minSelections?: number | undefined;
+            maxSelections?: number | undefined;
+            dataClassification?: "none" | "personal" | "special" | undefined;
+        }[];
+        description?: string | undefined;
+        title?: string | undefined;
+    }[];
+    description?: string | undefined;
+    title?: string | undefined;
+}, {
+    description?: string | undefined;
+    title?: string | undefined;
+    version?: number | undefined;
+    sections?: {
+        id: string;
+        description?: string | undefined;
+        title?: string | undefined;
+        fields?: {
+            id: string;
+            type: string;
+            label: string;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            placeholder?: string | undefined;
+            options?: string[] | undefined;
+            allowOther?: boolean | undefined;
+            defaultValue?: string | number | boolean | string[] | null | undefined;
+            minLength?: number | undefined;
+            maxLength?: number | undefined;
+            minValue?: number | undefined;
+            maxValue?: number | undefined;
+            step?: number | undefined;
+            minSelections?: number | undefined;
+            maxSelections?: number | undefined;
+            dataClassification?: "none" | "personal" | "special" | undefined;
+        }[] | undefined;
+    }[] | undefined;
+}>;
+type ReportTemplateSchema = z.infer<typeof ReportTemplateSchemaValidator>;
+
+declare const DEFAULT_FIELD_LABEL = "Untitled question";
+declare const CORE_FIELD_DEFAULTS: Record<ReportTemplateFieldType, Record<string, unknown>>;
+
+declare function createUniqueId(prefix: string, existing: Iterable<string>): string;
+
+declare function parseReportTemplateSchema(raw: unknown): ReportTemplateSchema;
+declare function normalizeReportTemplateSchema(schema: ReportTemplateSchema): ReportTemplateSchema;
+declare function parseReportTemplateSchemaFromString(raw: string): ReportTemplateSchema;
+declare function serializeReportTemplateSchema(schema: ReportTemplateSchema): string;
+
+declare function migrateLegacySchema(raw: unknown): unknown;
+
+export { CORE_FIELD_DEFAULTS, DEFAULT_FIELD_LABEL, REPORT_TEMPLATE_FIELD_TYPES, REPORT_TEMPLATE_VERSION, type ReportTemplateField, ReportTemplateFieldSchema, type ReportTemplateFieldType, type ReportTemplateSchema, ReportTemplateSchemaValidator, type ReportTemplateSection, ReportTemplateSectionSchema, createUniqueId, migrateLegacySchema, normalizeReportTemplateSchema, parseReportTemplateSchema, parseReportTemplateSchemaFromString, serializeReportTemplateSchema };

package/dist/index.js

@@ -0,0 +1,236 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  CORE_FIELD_DEFAULTS: () => CORE_FIELD_DEFAULTS,
+  DEFAULT_FIELD_LABEL: () => DEFAULT_FIELD_LABEL,
+  REPORT_TEMPLATE_FIELD_TYPES: () => REPORT_TEMPLATE_FIELD_TYPES,
+  REPORT_TEMPLATE_VERSION: () => REPORT_TEMPLATE_VERSION,
+  ReportTemplateFieldSchema: () => ReportTemplateFieldSchema,
+  ReportTemplateSchemaValidator: () => ReportTemplateSchemaValidator,
+  ReportTemplateSectionSchema: () => ReportTemplateSectionSchema,
+  createUniqueId: () => createUniqueId,
+  migrateLegacySchema: () => migrateLegacySchema,
+  normalizeReportTemplateSchema: () => normalizeReportTemplateSchema,
+  parseReportTemplateSchema: () => parseReportTemplateSchema,
+  parseReportTemplateSchemaFromString: () => parseReportTemplateSchemaFromString,
+  serializeReportTemplateSchema: () => serializeReportTemplateSchema
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/schema.ts
+var import_zod = require("zod");
+var REPORT_TEMPLATE_VERSION = 1;
+var REPORT_TEMPLATE_FIELD_TYPES = [
+  "shortText",
+  "longText",
+  "number",
+  "date",
+  "checkbox",
+  "singleSelect",
+  "multiSelect",
+  "starRating"
+];
+var ReportTemplateFieldSchema = import_zod.z.object({
+  id: import_zod.z.string().min(1).max(60).regex(/^[a-z0-9_-]+$/),
+  type: import_zod.z.string(),
+  label: import_zod.z.string().min(1).max(200),
+  required: import_zod.z.boolean().optional(),
+  description: import_zod.z.string().max(400).optional(),
+  placeholder: import_zod.z.string().max(200).optional(),
+  options: import_zod.z.array(import_zod.z.string().min(1).max(120)).optional(),
+  allowOther: import_zod.z.boolean().optional(),
+  defaultValue: import_zod.z.union([
+    import_zod.z.string(),
+    import_zod.z.number(),
+    import_zod.z.boolean(),
+    import_zod.z.array(import_zod.z.string()),
+    import_zod.z.null()
+  ]).optional(),
+  minLength: import_zod.z.number().int().min(0).optional(),
+  maxLength: import_zod.z.number().int().min(0).optional(),
+  minValue: import_zod.z.number().optional(),
+  maxValue: import_zod.z.number().optional(),
+  step: import_zod.z.number().nonnegative().optional(),
+  minSelections: import_zod.z.number().int().min(0).optional(),
+  maxSelections: import_zod.z.number().int().min(0).optional(),
+  dataClassification: import_zod.z.enum(["none", "personal", "special"]).optional()
+});
+var ReportTemplateSectionSchema = import_zod.z.object({
+  id: import_zod.z.string().min(1).max(60).regex(/^[a-z0-9_-]+$/),
+  title: import_zod.z.string().max(200).optional(),
+  description: import_zod.z.string().max(500).optional(),
+  fields: import_zod.z.array(ReportTemplateFieldSchema).default([])
+});
+var ReportTemplateSchemaValidator = import_zod.z.object({
+  version: import_zod.z.number().int().min(1).default(REPORT_TEMPLATE_VERSION),
+  title: import_zod.z.string().max(200).optional(),
+  description: import_zod.z.string().max(500).optional(),
+  sections: import_zod.z.array(ReportTemplateSectionSchema).max(25).default([])
+});
+
+// src/fields.ts
+var DEFAULT_FIELD_LABEL = "Untitled question";
+var CORE_FIELD_DEFAULTS = {
+  shortText: { label: DEFAULT_FIELD_LABEL, placeholder: "Short answer text" },
+  longText: { label: DEFAULT_FIELD_LABEL, placeholder: "Long answer text" },
+  number: { label: DEFAULT_FIELD_LABEL, placeholder: "123" },
+  date: { label: DEFAULT_FIELD_LABEL },
+  checkbox: { label: DEFAULT_FIELD_LABEL, placeholder: "Check to confirm" },
+  singleSelect: {
+    label: DEFAULT_FIELD_LABEL,
+    options: ["Option 1", "Option 2", "Option 3"]
+  },
+  multiSelect: {
+    label: DEFAULT_FIELD_LABEL,
+    options: ["Option 1", "Option 2", "Option 3"],
+    allowOther: false
+  },
+  starRating: {
+    label: DEFAULT_FIELD_LABEL,
+    minValue: 1,
+    maxValue: 5
+  }
+};
+
+// src/ids.ts
+function createUniqueId(prefix, existing) {
+  const used = new Set(existing);
+  let attempt = used.size + 1;
+  let candidate = `${prefix}-${attempt}`;
+  while (used.has(candidate)) {
+    attempt++;
+    candidate = `${prefix}-${attempt}`;
+  }
+  return candidate;
+}
+
+// src/migrate.ts
+var LEGACY_FIELD_TYPE_MAP = {
+  shorttext: "shortText",
+  text: "shortText",
+  longtext: "longText",
+  textarea: "longText",
+  number: "number",
+  numeric: "number",
+  date: "date",
+  checkbox: "checkbox",
+  boolean: "checkbox",
+  select: "singleSelect",
+  dropdown: "singleSelect",
+  radio: "singleSelect",
+  multiselect: "multiSelect",
+  checkboxes: "multiSelect"
+};
+function migrateLegacySchema(raw) {
+  if (!raw || typeof raw !== "object") return raw;
+  const obj = structuredClone(raw);
+  if (obj.fields) {
+    obj.sections = [
+      {
+        id: "section-1",
+        title: obj.title,
+        description: obj.description,
+        fields: obj.fields.map((f, i) => ({
+          ...f,
+          id: f.id || `field-${i + 1}`,
+          type: LEGACY_FIELD_TYPE_MAP[f.type?.toLowerCase()] ?? f.type
+        }))
+      }
+    ];
+    delete obj.fields;
+    return obj;
+  }
+  if (Array.isArray(obj.sections)) {
+    obj.sections = obj.sections.map((sec, i) => ({
+      ...sec,
+      id: sec.id || `section-${i + 1}`,
+      fields: (sec.fields || []).map((f, idx) => ({
+        ...f,
+        id: f.id || `field-${idx + 1}`,
+        type: LEGACY_FIELD_TYPE_MAP[f.type?.toLowerCase()] ?? f.type
+      }))
+    }));
+  }
+  return obj;
+}
+
+// src/normalize.ts
+function parseReportTemplateSchema(raw) {
+  const migrated = migrateLegacySchema(raw);
+  const parsed = ReportTemplateSchemaValidator.parse(migrated);
+  return normalizeReportTemplateSchema(parsed);
+}
+function normalizeReportTemplateSchema(schema) {
+  const sections = schema.sections.length > 0 ? schema.sections : [
+    {
+      id: "section-1",
+      title: "",
+      description: "",
+      fields: []
+    }
+  ];
+  const normalizedSections = sections.map((sec, i) => {
+    const seen = /* @__PURE__ */ new Set();
+    const safeSectionId = sec.id.trim() || `section-${i + 1}`;
+    const fields = sec.fields.map((field, idx) => {
+      const trimmed = field.id.trim() || `field-${idx + 1}`;
+      const safeId = seen.has(trimmed) ? `field-${idx + 1}` : trimmed;
+      seen.add(safeId);
+      return {
+        ...field,
+        id: safeId
+      };
+    });
+    return {
+      ...sec,
+      id: safeSectionId,
+      fields
+    };
+  });
+  return {
+    ...schema,
+    sections: normalizedSections
+  };
+}
+function parseReportTemplateSchemaFromString(raw) {
+  const obj = JSON.parse(raw);
+  return parseReportTemplateSchema(obj);
+}
+function serializeReportTemplateSchema(schema) {
+  return JSON.stringify(schema, null, 2);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CORE_FIELD_DEFAULTS,
+  DEFAULT_FIELD_LABEL,
+  REPORT_TEMPLATE_FIELD_TYPES,
+  REPORT_TEMPLATE_VERSION,
+  ReportTemplateFieldSchema,
+  ReportTemplateSchemaValidator,
+  ReportTemplateSectionSchema,
+  createUniqueId,
+  migrateLegacySchema,
+  normalizeReportTemplateSchema,
+  parseReportTemplateSchema,
+  parseReportTemplateSchemaFromString,
+  serializeReportTemplateSchema
+});