@timeback/qti 0.1.4 → 0.1.5-beta.20260219190739

package/dist/errors.js

@@ -884,6 +884,28 @@ var BEYONDAI_PATHS = {
   },
   powerpath: {
     base: "/powerpath"
+  },
+  clr: {
+    credentials: "/ims/clr/v2p0/credentials",
+    discovery: "/ims/clr/v2p0/discovery"
+  },
+  case: {
+    base: "/ims/case/v1p1"
+  },
+  webhooks: {
+    webhookList: "/webhooks/",
+    webhookGet: "/webhooks/{id}",
+    webhookCreate: "/webhooks/",
+    webhookUpdate: "/webhooks/{id}",
+    webhookDelete: "/webhooks/{id}",
+    webhookActivate: "/webhooks/{id}/activate",
+    webhookDeactivate: "/webhooks/{id}/deactivate",
+    webhookFilterList: "/webhook-filters/",
+    webhookFilterGet: "/webhook-filters/{id}",
+    webhookFilterCreate: "/webhook-filters/",
+    webhookFilterUpdate: "/webhook-filters/{id}",
+    webhookFilterDelete: "/webhook-filters/{id}",
+    webhookFiltersByWebhook: "/webhook-filters/webhook/{webhookId}"
   }
 };
 var LEARNWITHAI_PATHS = {
@@ -899,8 +921,11 @@ var LEARNWITHAI_PATHS = {
     gradebook: "/gradebook/1.0",
     resources: "/resources/1.0"
   },
+  webhooks: null,
   edubridge: null,
-  powerpath: null
+  powerpath: null,
+  clr: null,
+  case: null
 };
 var PLATFORM_PATHS = {
   BEYOND_AI: BEYONDAI_PATHS,
@@ -922,8 +947,11 @@ function resolvePathProfiles(pathProfile, customPaths) {
   return {
     caliper: customPaths?.caliper ?? basePaths.caliper,
     oneroster: customPaths?.oneroster ?? basePaths.oneroster,
+    webhooks: customPaths?.webhooks ?? basePaths.webhooks,
     edubridge: customPaths?.edubridge ?? basePaths.edubridge,
-    powerpath: customPaths?.powerpath ?? basePaths.powerpath
+    powerpath: customPaths?.powerpath ?? basePaths.powerpath,
+    clr: customPaths?.clr ?? basePaths.clr,
+    case: customPaths?.case ?? basePaths.case
   };
 }
 
@@ -963,10 +991,22 @@ class TimebackProvider {
           baseUrl: platformEndpoints.api[env],
           authUrl: this.authUrl
         },
+        clr: {
+          baseUrl: platformEndpoints.api[env],
+          authUrl: this.authUrl
+        },
+        case: {
+          baseUrl: platformEndpoints.api[env],
+          authUrl: this.authUrl
+        },
         caliper: {
           baseUrl: platformEndpoints.caliper[env],
           authUrl: this.authUrl
         },
+        webhooks: {
+          baseUrl: platformEndpoints.caliper[env],
+          authUrl: this.authUrl
+        },
         qti: {
           baseUrl: platformEndpoints.qti[env],
           authUrl: this.authUrl
@@ -980,7 +1020,10 @@ class TimebackProvider {
         oneroster: { baseUrl: config.baseUrl, authUrl: this.authUrl },
         edubridge: { baseUrl: config.baseUrl, authUrl: this.authUrl },
         powerpath: { baseUrl: config.baseUrl, authUrl: this.authUrl },
+        clr: { baseUrl: config.baseUrl, authUrl: this.authUrl },
+        case: { baseUrl: config.baseUrl, authUrl: this.authUrl },
         caliper: { baseUrl: config.baseUrl, authUrl: this.authUrl },
+        webhooks: { baseUrl: config.baseUrl, authUrl: this.authUrl },
         qti: { baseUrl: config.baseUrl, authUrl: this.authUrl }
       };
     } else if (isServicesConfig(config)) {
@@ -999,10 +1042,19 @@ class TimebackProvider {
     } else {
       throw new Error("Invalid provider configuration");
     }
+    for (const service of Object.keys(this.pathProfiles)) {
+      if (this.pathProfiles[service] === null) {
+        delete this.endpoints[service];
+      }
+    }
   }
   getEndpoint(service) {
     const endpoint = this.endpoints[service];
     if (!endpoint) {
+      const pathKey = service;
+      if (pathKey in this.pathProfiles && this.pathProfiles[pathKey] === null) {
+        throw new Error(`Service "${service}" is not supported on ${this.platform ?? "this"} platform.`);
+      }
       throw new Error(`Service "${service}" is not configured in this provider`);
     }
     return endpoint;

package/dist/index.d.ts

@@ -642,7 +642,26 @@ declare const QtiPaginationParams = z
 // ASSESSMENT ITEMS (REQUEST INPUTS)
 // ═══════════════════════════════════════════════════════════════════════════════
 
-declare const QtiAssessmentItemCreateInput = z
+/**
+ * XML-format creation input.
+ *
+ * The preferred way to create assessment items — send raw QTI 3.0 XML and the
+ * server validates it against IMS QTI XSDs.
+ */
+declare const QtiAssessmentItemXmlCreateInput = z
+	.object({
+		format: z.string().pipe(z.literal('xml')),
+		xml: z.string().min(1),
+		metadata: QtiItemMetadata.optional(),
+	})
+	.strict()
+
+/**
+ * JSON-format creation input (experimental on the server side).
+ *
+ * Sends a structured/parsed representation of a QTI item.
+ */
+declare const QtiAssessmentItemJsonCreateInput = z
 	.object({
 		identifier: z.string().min(1),
 		title: z.string().min(1),
@@ -660,6 +679,17 @@ declare const QtiAssessmentItemCreateInput = z
 	})
 	.strict()
 
+/**
+ * Union of XML and JSON creation inputs for assessment items.
+ *
+ * Accepts either `{ format: 'xml', xml, metadata? }` or the structured JSON
+ * shape with `{ identifier, title, type, ... }`.
+ */
+declare const QtiAssessmentItemCreateInput = z.union([
+	QtiAssessmentItemXmlCreateInput,
+	QtiAssessmentItemJsonCreateInput,
+])
+
 declare const QtiAssessmentItemUpdateInput = z
 	.object({
 		identifier: z.string().min(1).optional(),
@@ -713,9 +743,9 @@ declare const QtiAssessmentSection = z
 declare const QtiTestPart = z
 	.object({
 		identifier: z.string().min(1),
-		navigationMode: QtiNavigationMode,
-		submissionMode: QtiSubmissionMode,
-		'qti-assessment-section': z.union([QtiAssessmentSection, z.array(QtiAssessmentSection)]),
+		navigationMode: z.string().pipe(QtiNavigationMode),
+		submissionMode: z.string().pipe(QtiSubmissionMode),
+		'qti-assessment-section': z.array(QtiAssessmentSection),
 	})
 	.strict()
 
@@ -742,7 +772,7 @@ declare const QtiAssessmentTestCreateInput = z
 		maxAttempts: z.number().optional(),
 		toolsEnabled: z.record(z.string(), z.boolean()).optional(),
 		metadata: z.record(z.string(), z.unknown()).optional(),
-		'qti-test-part': QtiTestPart,
+		'qti-test-part': z.array(QtiTestPart),
 		'qti-outcome-declaration': z.array(QtiTestOutcomeDeclaration).optional(),
 	})
 	.strict()
@@ -758,7 +788,7 @@ declare const QtiAssessmentTestUpdateInput = z
 		maxAttempts: z.number().optional(),
 		toolsEnabled: z.record(z.string(), z.boolean()).optional(),
 		metadata: z.record(z.string(), z.unknown()).optional(),
-		'qti-test-part': QtiTestPart,
+		'qti-test-part': z.array(QtiTestPart),
 		'qti-outcome-declaration': z.array(QtiTestOutcomeDeclaration).optional(),
 	})
 	.strict()
@@ -847,6 +877,8 @@ type UpdateSectionRequest = input<typeof QtiAssessmentSection>
 type AddItemRequest = input<typeof QtiAssessmentItemRef>
 type ReorderItemsRequest = input<typeof QtiReorderItemsInput>
 
+type CreateAssessmentItemXmlRequest = input<typeof QtiAssessmentItemXmlCreateInput>
+type CreateAssessmentItemJsonRequest = input<typeof QtiAssessmentItemJsonCreateInput>
 type CreateAssessmentItemRequest = input<typeof QtiAssessmentItemCreateInput>
 type UpdateAssessmentItemRequest = input<typeof QtiAssessmentItemUpdateInput>
 type ProcessResponseRequest = input<typeof QtiAssessmentItemProcessResponseInput>
@@ -933,6 +965,25 @@ declare class AssessmentItemsResource {
      * @returns Score and feedback
      */
     processResponse(identifier: string, body: Omit<ProcessResponseRequest, 'identifier'>): Promise<ProcessResponseResult>;
+    /**
+     * Create an assessment item from raw QTI 3.0 XML.
+     *
+     * This is the preferred creation method — the server validates the XML
+     * against IMS QTI XSDs. Optionally include metadata (subject, grade, etc.).
+     *
+     * @param body - XML string and optional metadata
+     * @returns The created assessment item
+     *
+     * @example
+     * ```typescript
+     * const item = await client.assessmentItems.createFromXml({
+     *   format: 'xml',
+     *   xml: '<qti-assessment-item ...>...</qti-assessment-item>',
+     *   metadata: { subject: 'Math', difficulty: 'easy' },
+     * })
+     * ```
+     */
+    createFromXml(body: CreateAssessmentItemXmlRequest): Promise<AssessmentItem>;
     /**
      * Create an assessment item from metadata.
      *
@@ -941,7 +992,7 @@ declare class AssessmentItemsResource {
      * @param body - Assessment item metadata
      * @returns The created assessment item
      */
-    createFromMetadata(body: CreateAssessmentItemRequest): Promise<AssessmentItem>;
+    createFromMetadata(body: CreateAssessmentItemJsonRequest): Promise<AssessmentItem>;
 }
 
 /**