@encatch/schema 0.0.1

package/README.md

@@ -0,0 +1,7 @@
+# encatch-form-schema
+
+TypeScript schema definitions using Zod for validation and type inference of encatch form
+
+## License
+
+AGPL-3.0

package/dist/cjs/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.z = void 0;
+// Main entry point for encatch-typescript schemas
+__exportStar(require("./schemas/fields/field-schema"), exports);
+__exportStar(require("./schemas/fields/answer-schema"), exports);
+__exportStar(require("./schemas/fields/form-schema"), exports);
+__exportStar(require("./schemas/fields/form-properties-schema"), exports);
+__exportStar(require("./schemas/fields/other-screen-schema"), exports);
+__exportStar(require("./schemas/fields/theme-schema"), exports);
+__exportStar(require("./schemas/fields/translations-schema"), exports);
+__exportStar(require("./schemas/fields/auto-trigger-schema"), exports);
+// Re-export Zod for convenience (consumers should add zod to their dependencies)
+var zod_1 = require("zod");
+Object.defineProperty(exports, "z", { enumerable: true, get: function () { return zod_1.z; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,kDAAkD;AAClD,gEAA8C;AAC9C,iEAA+C;AAC/C,+DAA6C;AAC7C,0EAAwD;AACxD,uEAAqD;AACrD,gEAA8C;AAC9C,uEAAqD;AACrD,uEAAqD;AACrD,iFAAiF;AACjF,2BAAwB;AAAf,wFAAA,CAAC,OAAA"}

package/dist/cjs/schemas/fields/answer-schema.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnswerSchema = exports.TextAnswerSchema = exports.RankingAnswerSchema = exports.ContinuousSumAnswerSchema = exports.ScaleAnswerSchema = exports.MultipleChoiceAnswerSchema = exports.ChoiceAnswerSchema = exports.SimpleAnswerSchema = void 0;
+const zod_1 = require("zod");
+// Simple answer schema
+exports.SimpleAnswerSchema = zod_1.z
+    .object({
+    type: zod_1.z
+        .literal("simple")
+        .describe("Indicates this is a simple answer with a single value"),
+    value: zod_1.z
+        .union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean()])
+        .describe("The answer value - can be text, number, or boolean"),
+})
+    .describe("A simple answer containing a single value like text, number, or boolean");
+// Choice answer schema
+exports.ChoiceAnswerSchema = zod_1.z
+    .object({
+    type: zod_1.z
+        .literal("choice")
+        .describe("Indicates this is a single-choice answer"),
+    selectedOptionId: zod_1.z
+        .string()
+        .describe("The ID of the selected option from the available choices"),
+})
+    .describe("A single-choice answer where the user selects one option from a list");
+// Multiple choice answer schema
+exports.MultipleChoiceAnswerSchema = zod_1.z
+    .object({
+    type: zod_1.z
+        .literal("multiple_choice")
+        .describe("Indicates this is a multiple-choice answer"),
+    selectedOptionIds: zod_1.z
+        .array(zod_1.z.string())
+        .describe("Array of IDs for all selected options from the available choices"),
+})
+    .describe("A multiple-choice answer where the user can select multiple options from a list");
+// Scale answer schema
+exports.ScaleAnswerSchema = zod_1.z
+    .object({
+    type: zod_1.z
+        .literal("scale")
+        .describe("Indicates this is a scale/rating answer"),
+    value: zod_1.z
+        .number()
+        .describe("The numerical value representing the position on the scale (e.g., 1-5, 1-10)"),
+})
+    .describe("A scale answer where the user selects a numerical value on a scale");
+// Continuous sum answer schema
+exports.ContinuousSumAnswerSchema = zod_1.z
+    .object({
+    type: zod_1.z
+        .literal("continuous_sum")
+        .describe("Indicates this is a continuous sum answer"),
+    values: zod_1.z
+        .array(zod_1.z.object({
+        optionId: zod_1.z.string().describe("The ID of the option being rated"),
+        value: zod_1.z
+            .number()
+            .describe("The numerical value assigned to this option"),
+    }))
+        .describe("Array of option-value pairs where the sum of all values represents a total allocation"),
+})
+    .describe("A continuous sum answer where users distribute values across multiple options that add up to a total");
+// Ranking answer schema
+exports.RankingAnswerSchema = zod_1.z
+    .object({
+    type: zod_1.z.literal("ranking").describe("Indicates this is a ranking answer"),
+    ranks: zod_1.z
+        .array(zod_1.z.object({
+        optionId: zod_1.z.string().describe("The ID of the option being ranked"),
+        rank: zod_1.z
+            .number()
+            .describe("The rank position of this option (lower numbers indicate higher preference)"),
+    }))
+        .describe("Array of option-rank pairs showing the user's preference ordering"),
+})
+    .describe("A ranking answer where users order options by preference or priority");
+// Text answer schema
+exports.TextAnswerSchema = zod_1.z
+    .object({
+    type: zod_1.z.literal("text").describe("Indicates this is a text-based answer"),
+    values: zod_1.z
+        .array(zod_1.z.object({
+        fieldId: zod_1.z.string().describe("The ID of the text field"),
+        text: zod_1.z.string().describe("The text content entered by the user"),
+    }))
+        .describe("Array of field-text pairs for multiple text input fields"),
+})
+    .describe("A text answer containing responses to one or more text input fields");
+// Union schema for all answer types
+exports.AnswerSchema = zod_1.z
+    .discriminatedUnion("type", [
+    exports.SimpleAnswerSchema,
+    exports.ChoiceAnswerSchema,
+    exports.MultipleChoiceAnswerSchema,
+    exports.ScaleAnswerSchema,
+    exports.ContinuousSumAnswerSchema,
+    exports.RankingAnswerSchema,
+    exports.TextAnswerSchema,
+])
+    .describe("A union of all possible answer types discriminated by the 'type' field");
+//# sourceMappingURL=answer-schema.js.map

package/dist/cjs/schemas/fields/answer-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"answer-schema.js","sourceRoot":"","sources":["../../../../src/schemas/fields/answer-schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,uBAAuB;AACV,QAAA,kBAAkB,GAAG,OAAC;KAChC,MAAM,CAAC;IACN,IAAI,EAAE,OAAC;SACJ,OAAO,CAAC,QAAQ,CAAC;SACjB,QAAQ,CAAC,uDAAuD,CAAC;IACpE,KAAK,EAAE,OAAC;SACL,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC5C,QAAQ,CAAC,oDAAoD,CAAC;CAClE,CAAC;KACD,QAAQ,CACP,yEAAyE,CAC1E,CAAC;AAEJ,uBAAuB;AACV,QAAA,kBAAkB,GAAG,OAAC;KAChC,MAAM,CAAC;IACN,IAAI,EAAE,OAAC;SACJ,OAAO,CAAC,QAAQ,CAAC;SACjB,QAAQ,CAAC,0CAA0C,CAAC;IACvD,gBAAgB,EAAE,OAAC;SAChB,MAAM,EAAE;SACR,QAAQ,CAAC,0DAA0D,CAAC;CACxE,CAAC;KACD,QAAQ,CACP,sEAAsE,CACvE,CAAC;AAEJ,gCAAgC;AACnB,QAAA,0BAA0B,GAAG,OAAC;KACxC,MAAM,CAAC;IACN,IAAI,EAAE,OAAC;SACJ,OAAO,CAAC,iBAAiB,CAAC;SAC1B,QAAQ,CAAC,4CAA4C,CAAC;IACzD,iBAAiB,EAAE,OAAC;SACjB,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,CACP,kEAAkE,CACnE;CACJ,CAAC;KACD,QAAQ,CACP,iFAAiF,CAClF,CAAC;AAEJ,sBAAsB;AACT,QAAA,iBAAiB,GAAG,OAAC;KAC/B,MAAM,CAAC;IACN,IAAI,EAAE,OAAC;SACJ,OAAO,CAAC,OAAO,CAAC;SAChB,QAAQ,CAAC,yCAAyC,CAAC;IACtD,KAAK,EAAE,OAAC;SACL,MAAM,EAAE;SACR,QAAQ,CACP,8EAA8E,CAC/E;CACJ,CAAC;KACD,QAAQ,CACP,oEAAoE,CACrE,CAAC;AAEJ,+BAA+B;AAClB,QAAA,yBAAyB,GAAG,OAAC;KACvC,MAAM,CAAC;IACN,IAAI,EAAE,OAAC;SACJ,OAAO,CAAC,gBAAgB,CAAC;SACzB,QAAQ,CAAC,2CAA2C,CAAC;IACxD,MAAM,EAAE,OAAC;SACN,KAAK,CACJ,OAAC,CAAC,MAAM,CAAC;QACP,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;QACjE,KAAK,EAAE,OAAC;aACL,MAAM,EAAE;aACR,QAAQ,CAAC,6CAA6C,CAAC;KAC3D,CAAC,CACH;SACA,QAAQ,CACP,uFAAuF,CACxF;CACJ,CAAC;KACD,QAAQ,CACP,sGAAsG,CACvG,CAAC;AAEJ,wBAAwB;AACX,QAAA,mBAAmB,GAAG,OAAC;KACjC,MAAM,CAAC;IACN,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,oCAAoC,CAAC;IACzE,KAAK,EAAE,OAAC;SACL,KAAK,CACJ,OAAC,CAAC,MAAM,CAAC;QACP,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;QAClE,IAAI,EAAE,OAAC;aACJ,MAAM,EAAE;aACR,QAAQ,CACP,6EAA6E,CAC9E;KACJ,CAAC,CACH;SACA,QAAQ,CACP,mEAAmE,CACpE;CACJ,CAAC;KACD,QAAQ,CACP,sEAAsE,CACvE,CAAC;AAEJ,qBAAqB;AACR,QAAA,gBAAgB,GAAG,OAAC;KAC9B,MAAM,CAAC;IACN,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IACzE,MAAM,EAAE,OAAC;SACN,KAAK,CACJ,OAAC,CAAC,MAAM,CAAC;QACP,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC;QACxD,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC;KAClE,CAAC,CACH;SACA,QAAQ,CAAC,0DAA0D,CAAC;CACxE,CAAC;KACD,QAAQ,CACP,qEAAqE,CACtE,CAAC;AAEJ,oCAAoC;AACvB,QAAA,YAAY,GAAG,OAAC;KAC1B,kBAAkB,CAAC,MAAM,EAAE;IAC1B,0BAAkB;IAClB,0BAAkB;IAClB,kCAA0B;IAC1B,yBAAiB;IACjB,iCAAyB;IACzB,2BAAmB;IACnB,wBAAgB;CACjB,CAAC;KACD,QAAQ,CACP,wEAAwE,CACzE,CAAC"}

package/dist/cjs/schemas/fields/auto-trigger-schema.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.audienceTriggerPropertiesSchema = exports.audienceSegmentSchema = void 0;
+const zod_1 = require("zod");
+// Audience segment schema for targeting specific user groups
+exports.audienceSegmentSchema = zod_1.z
+    .object({
+    id: zod_1.z
+        .string()
+        .describe("Unique identifier for the audience segment"),
+    name: zod_1.z
+        .string()
+        .min(1)
+        .max(200)
+        .describe("Display name for the audience segment"),
+    isImportant: zod_1.z
+        .boolean()
+        .describe("Whether this segment is marked as important for targeting"),
+    when: zod_1.z
+        .string()
+        .describe("Timing condition for when to trigger the audience segment"),
+    who: zod_1.z
+        .string()
+        .describe("User criteria or conditions defining who belongs to this segment"),
+})
+    .describe("Schema defining an audience segment for targeting");
+// Audience trigger properties schema
+exports.audienceTriggerPropertiesSchema = zod_1.z
+    .object({
+    isAuto: zod_1.z
+        .boolean()
+        .describe("Whether automatic triggering is enabled for this audience"),
+    isManual: zod_1.z
+        .boolean()
+        .describe("Whether manual triggering is enabled for this audience"),
+    segments: zod_1.z
+        .array(exports.audienceSegmentSchema)
+        .min(0)
+        .describe("Array of audience segments for targeting conditions"),
+})
+    .refine((data) => {
+    // Ensure at least one of isAuto or isManual is true
+    return data.isAuto || data.isManual;
+}, {
+    message: "At least one of isAuto or isManual must be true",
+    path: ["isAuto"],
+})
+    .describe("Schema defining audience trigger properties for form targeting");
+//# sourceMappingURL=auto-trigger-schema.js.map

package/dist/cjs/schemas/fields/auto-trigger-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auto-trigger-schema.js","sourceRoot":"","sources":["../../../../src/schemas/fields/auto-trigger-schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,6DAA6D;AAChD,QAAA,qBAAqB,GAAG,OAAC;KACnC,MAAM,CAAC;IACN,EAAE,EAAE,OAAC;SACF,MAAM,EAAE;SACR,QAAQ,CAAC,4CAA4C,CAAC;IACzD,IAAI,EAAE,OAAC;SACJ,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,GAAG,CAAC;SACR,QAAQ,CAAC,uCAAuC,CAAC;IACpD,WAAW,EAAE,OAAC;SACX,OAAO,EAAE;SACT,QAAQ,CAAC,2DAA2D,CAAC;IACxE,IAAI,EAAE,OAAC;SACJ,MAAM,EAAE;SACR,QAAQ,CAAC,2DAA2D,CAAC;IACxE,GAAG,EAAE,OAAC;SACH,MAAM,EAAE;SACR,QAAQ,CAAC,kEAAkE,CAAC;CAChF,CAAC;KACD,QAAQ,CAAC,mDAAmD,CAAC,CAAC;AAEjE,qCAAqC;AACxB,QAAA,+BAA+B,GAAG,OAAC;KAC7C,MAAM,CAAC;IACN,MAAM,EAAE,OAAC;SACN,OAAO,EAAE;SACT,QAAQ,CAAC,2DAA2D,CAAC;IACxE,QAAQ,EAAE,OAAC;SACR,OAAO,EAAE;SACT,QAAQ,CAAC,wDAAwD,CAAC;IACrE,QAAQ,EAAE,OAAC;SACR,KAAK,CAAC,6BAAqB,CAAC;SAC5B,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,qDAAqD,CAAC;CACnE,CAAC;KACD,MAAM,CACL,CAAC,IAAI,EAAE,EAAE;IACP,oDAAoD;IACpD,OAAO,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC;AACtC,CAAC,EACD;IACE,OAAO,EAAE,iDAAiD;IAC1D,IAAI,EAAE,CAAC,QAAQ,CAAC;CACjB,CACF;KACA,QAAQ,CAAC,gEAAgE,CAAC,CAAC"}