@pie-qti/element-schemas 1.0.0-beta.0 → 1.0.0-beta.2

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @pie-qti/element-schemas
+ *
+ * PIE element JSON schemas for validation
+ */
+/**
+ * Available PIE element schemas
+ */
+export declare const AVAILABLE_SCHEMAS: readonly ["multiple-choice", "extended-text-entry", "placement-ordering", "match", "explicit-constructed-response", "select-text", "inline-dropdown", "drag-in-the-blank", "ebsr", "hotspot", "image-cloze-association", "match-list", "passage"];
+export type ElementType = typeof AVAILABLE_SCHEMAS[number];
+/**
+ * Load a PIE element schema
+ * @param elementType - Element type (e.g., 'multiple-choice')
+ * @returns JSON schema object
+ */
+export declare function loadSchema(elementType: ElementType): Promise<object>;
+/**
+ * Load all available schemas
+ * @returns Map of element type to schema
+ */
+export declare function loadAllSchemas(): Promise<Map<string, object>>;
+/**
+ * Get schema synchronously (must be loaded first)
+ * @param elementType - Element type
+ * @returns Cached schema or undefined
+ */
+export declare function getSchema(elementType: ElementType): object | undefined;
+/**
+ * Check if a schema is available
+ * @param elementType - Element type to check
+ */
+export declare function hasSchema(elementType: string): elementType is ElementType;

package/dist/index.js

@@ -0,0 +1,80 @@
+/**
+ * @pie-qti/element-schemas
+ *
+ * PIE element JSON schemas for validation
+ */
+import { readFile } from 'node:fs/promises';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+const __dirname = dirname(fileURLToPath(import.meta.url));
+/**
+ * Available PIE element schemas
+ */
+export const AVAILABLE_SCHEMAS = [
+    'multiple-choice',
+    'extended-text-entry',
+    'placement-ordering',
+    'match',
+    'explicit-constructed-response',
+    'select-text',
+    'inline-dropdown',
+    'drag-in-the-blank',
+    'ebsr',
+    'hotspot',
+    'image-cloze-association',
+    'match-list',
+    'passage',
+];
+/**
+ * Schema cache
+ */
+const schemaCache = new Map();
+/**
+ * Load a PIE element schema
+ * @param elementType - Element type (e.g., 'multiple-choice')
+ * @returns JSON schema object
+ */
+export async function loadSchema(elementType) {
+    // Check cache first
+    if (schemaCache.has(elementType)) {
+        return schemaCache.get(elementType);
+    }
+    const schemaPath = resolve(__dirname, `schemas/${elementType}.json`);
+    try {
+        const content = await readFile(schemaPath, 'utf-8');
+        const schema = JSON.parse(content);
+        schemaCache.set(elementType, schema);
+        return schema;
+    }
+    catch (error) {
+        throw new Error(`Failed to load schema for ${elementType}: ${error.message}`);
+    }
+}
+/**
+ * Load all available schemas
+ * @returns Map of element type to schema
+ */
+export async function loadAllSchemas() {
+    const schemas = new Map();
+    for (const elementType of AVAILABLE_SCHEMAS) {
+        const schema = await loadSchema(elementType);
+        schemas.set(`@pie-element/${elementType}`, schema);
+    }
+    return schemas;
+}
+/**
+ * Get schema synchronously (must be loaded first)
+ * @param elementType - Element type
+ * @returns Cached schema or undefined
+ */
+export function getSchema(elementType) {
+    return schemaCache.get(elementType);
+}
+/**
+ * Check if a schema is available
+ * @param elementType - Element type to check
+ */
+export function hasSchema(elementType) {
+    return AVAILABLE_SCHEMAS.includes(elementType);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,iBAAiB;IACjB,qBAAqB;IACrB,oBAAoB;IACpB,OAAO;IACP,+BAA+B;IAC/B,aAAa;IACb,iBAAiB;IACjB,mBAAmB;IACnB,MAAM;IACN,SAAS;IACT,yBAAyB;IACzB,YAAY;IACZ,SAAS;CACD,CAAC;AAIX;;GAEG;AACH,MAAM,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;AAE9C;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,WAAwB;IACvD,oBAAoB;IACpB,IAAI,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QACjC,OAAO,WAAW,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC;IACvC,CAAC;IAED,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,EAAE,WAAW,WAAW,OAAO,CAAC,CAAC;IAErE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACnC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,6BAA6B,WAAW,KAAM,KAAe,CAAC,OAAO,EAAE,CACxE,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE1C,KAAK,MAAM,WAAW,IAAI,iBAAiB,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,gBAAgB,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,WAAwB;IAChD,OAAO,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AACtC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,WAAmB;IAC3C,OAAO,iBAAiB,CAAC,QAAQ,CAAC,WAA0B,CAAC,CAAC;AAChE,CAAC","sourcesContent":["/**\n * @pie-qti/element-schemas\n *\n * PIE element JSON schemas for validation\n */\n\nimport { readFile } from 'node:fs/promises';\nimport { dirname, resolve } from 'node:path';\nimport { fileURLToPath } from 'node:url';\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\n/**\n * Available PIE element schemas\n */\nexport const AVAILABLE_SCHEMAS = [\n  'multiple-choice',\n  'extended-text-entry',\n  'placement-ordering',\n  'match',\n  'explicit-constructed-response',\n  'select-text',\n  'inline-dropdown',\n  'drag-in-the-blank',\n  'ebsr',\n  'hotspot',\n  'image-cloze-association',\n  'match-list',\n  'passage',\n] as const;\n\nexport type ElementType = typeof AVAILABLE_SCHEMAS[number];\n\n/**\n * Schema cache\n */\nconst schemaCache = new Map<string, object>();\n\n/**\n * Load a PIE element schema\n * @param elementType - Element type (e.g., 'multiple-choice')\n * @returns JSON schema object\n */\nexport async function loadSchema(elementType: ElementType): Promise<object> {\n  // Check cache first\n  if (schemaCache.has(elementType)) {\n    return schemaCache.get(elementType)!;\n  }\n\n  const schemaPath = resolve(__dirname, `schemas/${elementType}.json`);\n\n  try {\n    const content = await readFile(schemaPath, 'utf-8');\n    const schema = JSON.parse(content);\n    schemaCache.set(elementType, schema);\n    return schema;\n  } catch (error) {\n    throw new Error(\n      `Failed to load schema for ${elementType}: ${(error as Error).message}`\n    );\n  }\n}\n\n/**\n * Load all available schemas\n * @returns Map of element type to schema\n */\nexport async function loadAllSchemas(): Promise<Map<string, object>> {\n  const schemas = new Map<string, object>();\n\n  for (const elementType of AVAILABLE_SCHEMAS) {\n    const schema = await loadSchema(elementType);\n    schemas.set(`@pie-element/${elementType}`, schema);\n  }\n\n  return schemas;\n}\n\n/**\n * Get schema synchronously (must be loaded first)\n * @param elementType - Element type\n * @returns Cached schema or undefined\n */\nexport function getSchema(elementType: ElementType): object | undefined {\n  return schemaCache.get(elementType);\n}\n\n/**\n * Check if a schema is available\n * @param elementType - Element type to check\n */\nexport function hasSchema(elementType: string): elementType is ElementType {\n  return AVAILABLE_SCHEMAS.includes(elementType as ElementType);\n}\n"]}