@frt-platform/report-core 1.0.0

package/dist/index.mjs

@@ -0,0 +1,197 @@
+// src/schema.ts
+import { z } from "zod";
+var REPORT_TEMPLATE_VERSION = 1;
+var REPORT_TEMPLATE_FIELD_TYPES = [
+  "shortText",
+  "longText",
+  "number",
+  "date",
+  "checkbox",
+  "singleSelect",
+  "multiSelect",
+  "starRating"
+];
+var ReportTemplateFieldSchema = z.object({
+  id: z.string().min(1).max(60).regex(/^[a-z0-9_-]+$/),
+  type: z.string(),
+  label: z.string().min(1).max(200),
+  required: z.boolean().optional(),
+  description: z.string().max(400).optional(),
+  placeholder: z.string().max(200).optional(),
+  options: z.array(z.string().min(1).max(120)).optional(),
+  allowOther: z.boolean().optional(),
+  defaultValue: z.union([
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(z.string()),
+    z.null()
+  ]).optional(),
+  minLength: z.number().int().min(0).optional(),
+  maxLength: z.number().int().min(0).optional(),
+  minValue: z.number().optional(),
+  maxValue: z.number().optional(),
+  step: z.number().nonnegative().optional(),
+  minSelections: z.number().int().min(0).optional(),
+  maxSelections: z.number().int().min(0).optional(),
+  dataClassification: z.enum(["none", "personal", "special"]).optional()
+});
+var ReportTemplateSectionSchema = z.object({
+  id: z.string().min(1).max(60).regex(/^[a-z0-9_-]+$/),
+  title: z.string().max(200).optional(),
+  description: z.string().max(500).optional(),
+  fields: z.array(ReportTemplateFieldSchema).default([])
+});
+var ReportTemplateSchemaValidator = z.object({
+  version: z.number().int().min(1).default(REPORT_TEMPLATE_VERSION),
+  title: z.string().max(200).optional(),
+  description: z.string().max(500).optional(),
+  sections: 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);
+}
+export {
+  CORE_FIELD_DEFAULTS,
+  DEFAULT_FIELD_LABEL,
+  REPORT_TEMPLATE_FIELD_TYPES,
+  REPORT_TEMPLATE_VERSION,
+  ReportTemplateFieldSchema,
+  ReportTemplateSchemaValidator,
+  ReportTemplateSectionSchema,
+  createUniqueId,
+  migrateLegacySchema,
+  normalizeReportTemplateSchema,
+  parseReportTemplateSchema,
+  parseReportTemplateSchemaFromString,
+  serializeReportTemplateSchema
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@frt-platform/report-core",
+  "version": "1.0.0",
+  "description": "Core report template engine: schema, validation, normalization, and migration.",
+  "author": "Sebastian Mostert",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "prepublishOnly": "npm run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.6.3"
+  }
+}