@examplary/schemas 1.7.0 → 1.10.0

package/.turbo/turbo-deploy.log

@@ -1,43 +0,0 @@
-
-Initializing
-Initializing
-Resolving variables
-Authenticating
-Resolving variables
-Checking AWS credentials
-Resolving variables
-Loading service details
-Deploying "schemas" to stage "production" (eu-central-1)
-[WARNING] aws-cdk-lib.aws_cloudfront_origins.S3Origin is deprecated.
-  Use `S3BucketOrigin` or `S3StaticWebsiteOrigin` instead.
-  This API will be removed in the next major release.
-[WARNING] aws-cdk-lib.aws_cloudfront_origins.S3Origin#bind is deprecated.
-  Use `S3BucketOrigin` or `S3StaticWebsiteOrigin` instead.
-  This API will be removed in the next major release.
-Packaging
-Packaging
-Retrieving AWS CloudFormation stack
-Uploading
-Uploading (0/0)
-Uploading CloudFormation file to S3
-Uploading State file to S3
-Updating AWS CloudFormation stack
-Fetching service information
-Updating
-Uploading directory 'dist/schemas' to bucket 'schemas-production-schemasbucketbe9e7d9f-q1aisqmk2pik'
-Uploading directory 'dist/schemas' to bucket 'schemas-production-schemasbucketbe9e7d9f-q1aisqmk2pik'
-Skipped uploading 1 unchanged files
-Removing old service artifacts from S3
-✔ Service deployed to stack schemas-production (12s)
-Stack Outputs:
-  schemasBucketName814EA6EC: schemas-production-schemasbucketbe9e7d9f-q1aisqmk2pik
-  schemasCloudFrontCName05CBFC31: djykovp21c0ec.cloudfront.net
-  schemasDistributionIdF843C7D9: E1Z7GHEM2TF0UN
-  schemasDomainC1437202: schemas.examplary.ai
-  ServerlessDeploymentBucketName: serverless-framework-deployments-eu-central-1-fe769196-9095
-
-schemas:
-  url: https://schemas.examplary.ai
-  cname: djykovp21c0ec.cloudfront.net
-
-Finalizing

package/scripts/build.ts

@@ -1,16 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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/question-type-components.ts

@@ -1,36 +0,0 @@
-import { z } from "zod";
-
-// Path or URL reference type
-export const PathOrUrlReference = z
-  .string()
-  .regex(
-    /^(https?:\/\/|\.)([a-zA-Z0-9._~:/?#@!$&'()*+,;=%-]+)$/,
-    "Valid path or URL format",
-  );
-
-// Component reference type
-export const ComponentReference = PathOrUrlReference.describe(
-  "Reference to a component, typically a file path or URL",
-);
-
-// Components configuration
-export const QuestionTypeComponents = 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");
-
-export type ComponentReferenceType = z.infer<typeof ComponentReference>;
-export type ComponentsType = z.infer<typeof QuestionTypeComponents>;

package/src/question-type-generation-options.ts

@@ -1,21 +0,0 @@
-import { z } from "zod";
-
-export const QuestionTypeGenerationOptions = z
-  .object({
-    enabled: z
-      .boolean()
-      .describe(
-        "Whether this question type can be automatically generated using AI (default to false)",
-      ),
-    instructions: z
-      .string()
-      .optional()
-      .describe(
-        "Optional instructions to guide AI in generating this question type",
-      ),
-  })
-  .describe("Options for AI question generation");
-
-export type QuestionTypeGenerationOptionsType = z.infer<
-  typeof QuestionTypeGenerationOptions
->;

package/src/question-type-grading-options.ts

@@ -1,21 +0,0 @@
-import { z } from "zod";
-
-export const QuestionTypeGradingOptions = z
-  .object({
-    enabled: z
-      .boolean()
-      .describe(
-        "Whether this question type can be automatically graded using AI (default to false)",
-      ),
-    instructions: z
-      .string()
-      .optional()
-      .describe(
-        "Optional instructions to guide AI in grading this question type",
-      ),
-  })
-  .describe("Options for AI question grading");
-
-export type QuestionTypeGradingOptionsType = z.infer<
-  typeof QuestionTypeGradingOptions
->;

package/src/question-type-qti3.ts

@@ -1,53 +0,0 @@
-import { z } from "zod";
-
-/**
- * A value that can either be a literal or a JSONata expression string.
- * JSONata expressions are evaluated at transform time against the question context.
- */
-const JsonataExpr = z
-  .union([z.string(), z.number(), z.boolean(), z.array(z.any()), z.object({})])
-  .describe("Literal or JSONata expression string starting with '='");
-
-/**
- * Supported QTI 3.0 interaction types
- */
-export const QtiInteractionType = z.enum([
-  "AssociateInteraction",
-  "ChoiceInteraction",
-  "DrawingInteraction",
-  "EndAttemptInteraction",
-  "ExtendedTextInteraction",
-  "GapMatchInteraction",
-  "GraphicAssociateInteraction",
-  "GraphicGapMatchInteraction",
-  "GraphicOrderInteraction",
-  "HotspotInteraction",
-  "HottextInteraction",
-  "InlineChoiceInteraction",
-  "MatchInteraction",
-  "MediaInteraction",
-  "OrderInteraction",
-  "PositionObjectInteraction",
-  "SelectPointInteraction",
-  "SliderInteraction",
-  "TextEntryInteraction",
-  "UploadInteraction",
-]);
-
-export type QtiInteractionType = z.infer<typeof QtiInteractionType>;
-
-/**
- * Complete QTI mapping configuration for a question type
- */
-export const Qti3Mapping = z
-  .object({
-    interaction: z.object({
-      type: QtiInteractionType.describe("The QTI interaction type to generate"),
-      options: z.record(z.string(), JsonataExpr).optional(),
-    }),
-  })
-  .describe(
-    "QTI 3.0 mapping configuration for transforming questions to QTI format",
-  );
-
-export type Qti3Mapping = z.infer<typeof Qti3Mapping>;

package/src/question-type-setting.ts

@@ -1,70 +0,0 @@
-import { z } from "zod";
-
-import { Translatable } from "./translatable";
-
-// Setting option for enum type settings
-export const QuestionTypeSettingOption = z
-  .object({
-    value: z.string().describe("Option value"),
-    label: Translatable.describe("Option label"),
-  })
-  .strict()
-  .describe("Setting option");
-
-// Setting configuration
-export const QuestionTypeSetting = z
-  .object({
-    id: z.string().describe("Unique identifier for the setting"),
-    name: Translatable.describe("Display name for the setting"),
-    helpText: Translatable.optional().describe("Help text for the setting"),
-    description: z
-      .string()
-      .optional()
-      .describe(
-        "Description to help AI agents auto-generate question settings",
-      ),
-    type: z
-      .enum([
-        "enum",
-        "string",
-        "string-array",
-        "number",
-        "boolean",
-        "custom",
-        "scoring-criteria",
-        "tags",
-        "question-type",
-      ])
-      .describe("Type of the setting"),
-    index: z.number().optional(),
-    hidden: z
-      .boolean()
-      .optional()
-      .describe("Whether the setting is hidden from the user"),
-    default: z.any().optional().describe("Default value for the setting"),
-    required: z
-      .boolean()
-      .optional()
-      .describe("Whether this setting is required"),
-    options: z
-      .array(QuestionTypeSettingOption)
-      .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");
-
-export type SettingType = z.infer<typeof QuestionTypeSetting>;
-export type SettingOptionType = z.infer<typeof QuestionTypeSettingOption>;

package/src/question-type.ts

@@ -1,119 +0,0 @@
-import { z } from "zod";
-
-import {
-  PathOrUrlReference,
-  QuestionTypeComponents,
-} from "./question-type-components";
-import { QuestionTypeGenerationOptions } from "./question-type-generation-options";
-import { QuestionTypeGradingOptions } from "./question-type-grading-options";
-import { Qti3Mapping } from "./question-type-qti3";
-import { QuestionTypeSetting } from "./question-type-setting";
-import { Translatable } from "./translatable";
-
-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"),
-    generation: QuestionTypeGenerationOptions.optional(),
-    grading: QuestionTypeGradingOptions.optional(),
-    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"),
-    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: QuestionTypeComponents.optional().describe(
-      "Paths to the components used by this question type",
-    ),
-    settings: z
-      .array(QuestionTypeSetting)
-      .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"),
-    export: z
-      .object({
-        qti3: Qti3Mapping.optional().describe(
-          "QTI 3.0 mapping configuration for transforming questions to QTI format",
-        ),
-      })
-      .optional()
-      .describe("Export configuration for various formats"),
-    stylesheet: z.url().optional(),
-    index: z.number().optional(),
-    metadata: z
-      .record(z.string(), z.any())
-      .optional()
-      .describe(
-        "Optional metadata for the question type, only used by external applications",
-      ),
-  })
-  .strict()
-  .describe("Schema for defining question types in the Examplary system");
-
-export type QuestionType = z.infer<typeof QuestionTypeSchema>;

package/src/translatable.ts

@@ -1,17 +0,0 @@
-import { z } from "zod";
-
-// Translatable type - can be a simple string or translation object
-export 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"),
-]);
-export type TranslatableType = z.infer<typeof Translatable>;