@examplary/schemas 0.0.1

package/.env

@@ -0,0 +1 @@
+SERVERLESS_ACCESS_KEY=AKaam9TxRjIdaDijtpL22kSIfgFP8UfuTiOeXjEWTvLqR

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@examplary/schemas",
+  "packageManager": "yarn@4.8.1",
+  "version": "0.0.1",
+  "description": "Schemas for the Examplary platform.",
+  "scripts": {
+    "build:schema": "tsx ./scripts/build.ts",
+    "build:tsc": "tsc ./src/index.ts --outDir dist --skipLibCheck --declaration",
+    "start": "yarn build:tsc --watch",
+    "build": "yarn build:tsc && yarn build:schema",
+    "deploy": "serverless deploy --verbose --stage ${STAGE:-dev}",
+    "release": "semantic-release -e semantic-release-monorepo"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "devDependencies": {
+    "serverless": "^4.17.2",
+    "serverless-lift": "^1.31.0",
+    "tsx": "^4.20.3",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "zod": "^4.0.10"
+  },
+  "homepage": "https://developers.examplary.ai",
+  "author": {
+    "name": "Examplary AI",
+    "email": "hi@examplary.ai"
+  }
+}

package/scripts/build.ts

@@ -0,0 +1,16 @@
+import { mkdir, writeFile } from "node:fs/promises";
+
+import * as z from "zod";
+
+import { QuestionTypeSchema } from "../src";
+
+(async () => {
+  await mkdir("./dist/schemas", { recursive: true });
+  await writeFile(
+    "./dist/schemas/question-type.json",
+    JSON.stringify(z.toJSONSchema(QuestionTypeSchema), null, 2),
+    "utf-8",
+  );
+
+  console.log("Schema built successfully!");
+})();

package/serverless.yml

@@ -0,0 +1,25 @@
+service: schemas
+
+params:
+  default:
+    domain: schemas-${sls:stage}.examplary.ai
+    certificateArn: arn:aws:acm:us-east-1:864899853846:certificate/98929ce6-38a5-41ec-ac3c-6abd2f46087f
+  production:
+    domain: schemas.examplary.ai
+    certificateArn: arn:aws:acm:us-east-1:864899853846:certificate/98929ce6-38a5-41ec-ac3c-6abd2f46087f
+
+provider:
+  name: aws
+  region: eu-central-1
+  stage: ${opt:stage, 'dev'}
+  deploymentMethod: direct
+
+plugins:
+  - serverless-lift
+
+constructs:
+  schemas:
+    type: static-website
+    path: dist/schemas
+    domain: ${param:domain}
+    certificate: ${param:certificateArn}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./question-type";
+export type * from "./question-type";

package/src/question-type.ts

@@ -0,0 +1,203 @@
+import { z } from "zod";
+
+// Translatable type - can be a simple string or translation object
+const Translatable = z.union([
+  z.string().describe("Simple string value"),
+  z
+    .record(
+      z.string().regex(/^[a-z]{2}(-[A-Z]{2})?$/, "Language code format"),
+      z.string(),
+    )
+    .refine(
+      (obj) => Object.keys(obj).length >= 1,
+      "Translation object must have at least one property",
+    )
+    .describe("Translation object with language codes as keys"),
+]);
+
+// Path or URL reference type
+const PathOrUrlReference = z
+  .string()
+  .regex(
+    /^(https?:\/\/|\.)([a-zA-Z0-9._~:/?#@!$&'()*+,;=%-]+)$/,
+    "Valid path or URL format",
+  );
+
+// Component reference type
+const ComponentReference = PathOrUrlReference.describe(
+  "Reference to a component, typically a file path or URL",
+);
+
+// Setting option for enum type settings
+const SettingOption = z
+  .object({
+    value: z.string().describe("Option value"),
+    label: Translatable.describe("Option label"),
+  })
+  .strict()
+  .describe("Setting option");
+
+// Setting configuration
+const Setting = z
+  .object({
+    id: z.string().describe("Unique identifier for the setting"),
+    name: Translatable.describe("Display name for the setting"),
+    type: z
+      .enum([
+        "enum",
+        "string",
+        "number",
+        "boolean",
+        "custom",
+        "scoring-criteria",
+        "question-type",
+      ])
+      .describe("Type of the setting"),
+    default: z.any().optional().describe("Default value for the setting"),
+    required: z
+      .boolean()
+      .optional()
+      .describe("Whether this setting is required"),
+    options: z
+      .array(SettingOption)
+      .optional()
+      .describe("Available options for enum type settings"),
+    placeholder: Translatable.optional().describe(
+      "Placeholder text for the setting",
+    ),
+    step: z.number().optional().describe("Step value for number type settings"),
+    min: z
+      .number()
+      .optional()
+      .describe("Minimum value for number type settings"),
+    max: z
+      .number()
+      .optional()
+      .describe("Maximum value for number type settings"),
+  })
+  .strict()
+  .describe("Setting configuration");
+
+// Components configuration
+const Components = z
+  .object({
+    assessment: ComponentReference.optional().describe(
+      "Path to the assessment component (question content)",
+    ),
+    print: ComponentReference.optional().describe(
+      "Path to the print component (for printing the question)",
+    ),
+    "settings-area": ComponentReference.optional().describe(
+      "Path to the settings area component (for configuring question settings)",
+    ),
+    results: ComponentReference.optional().describe(
+      "Path to the results component (for displaying answers)",
+    ),
+  })
+  .strict()
+  .describe("Paths to the components used by this question type");
+
+// Main question type schema
+export const QuestionTypeSchema = z
+  .object({
+    $schema: z.string().optional(),
+    id: z
+      .string()
+      .regex(
+        /^([a-z][a-z0-9-]*)(\.[a-z][a-z0-9-]*)+$/,
+        "Valid question type ID format",
+      )
+      .describe(
+        "Unique identifier for the question type (e.g. 'my-org.color-picker')",
+      ),
+    name: Translatable.describe(
+      "Display name for the question type, can be a simple string or translation object",
+    ),
+    description: Translatable.describe(
+      "Description of the question type, can be a simple string or translation object",
+    ),
+    icon: PathOrUrlReference.optional().describe(
+      "Path to the icon for this question type",
+    ),
+    shortcut: z
+      .string()
+      .max(1)
+      .optional()
+      .describe("Keyboard shortcut for quick access to this question type"),
+    canAutoGenerate: z
+      .boolean()
+      .optional()
+      .describe("Whether this question type can be automatically generated"),
+    timeEstimateMinutes: z
+      .number()
+      .min(1)
+      .optional()
+      .describe("Estimated time in minutes to complete this question type"),
+    isAi: z
+      .boolean()
+      .optional()
+      .describe("Whether this question type uses AI functionality"),
+    backgroundColor: z
+      .string()
+      .optional()
+      .describe("Background color for the question type"),
+    iconBackgroundColor: z
+      .string()
+      .optional()
+      .describe("Background color for the question type icon"),
+    enforcePosition: z
+      .enum(["start", "end"])
+      .optional()
+      .describe("Position enforcement for this question type"),
+    enforceTitle: Translatable.optional().describe(
+      "Enforced title for this question type",
+    ),
+    hideSettings: z
+      .boolean()
+      .optional()
+      .describe("Whether to hide settings for this question type"),
+    isPreviewRefreshable: z
+      .boolean()
+      .optional()
+      .describe("Whether the preview can be refreshed for this question type"),
+    hasSimpleScoring: z
+      .boolean()
+      .optional()
+      .describe("Whether this question type has simple scoring"),
+    titlePlaceholder: Translatable.optional().describe(
+      "Placeholder text for the title field",
+    ),
+    descriptionPlaceholder: Translatable.optional().describe(
+      "Placeholder text for the description field",
+    ),
+    untitledPlaceholder: Translatable.optional().describe(
+      "Placeholder text for untitled questions",
+    ),
+    components: Components.optional().describe(
+      "Paths to the components used by this question type",
+    ),
+    settings: z
+      .array(Setting)
+      .optional()
+      .describe("Configuration settings for the question type"),
+    public: z
+      .boolean()
+      .optional()
+      .describe(
+        "Whether this question type is public and can be used by all users",
+      ),
+    translations: z
+      .record(z.string(), Translatable)
+      .optional()
+      .describe("Custom translations for this question type"),
+    index: z.number().optional(),
+  })
+  .strict()
+  .describe("Schema for defining question types in the Examplary system");
+
+export type QuestionType = z.infer<typeof QuestionTypeSchema>;
+export type TranslatableType = z.infer<typeof Translatable>;
+export type ComponentReferenceType = z.infer<typeof ComponentReference>;
+export type SettingType = z.infer<typeof Setting>;
+export type SettingOptionType = z.infer<typeof SettingOption>;
+export type ComponentsType = z.infer<typeof Components>;