@memizy/oqse 0.1.0

package/dist/src/oqseValidation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/progress.d.ts

@@ -0,0 +1,42 @@
+/**
+ * OQSEP v0.1 Type Definitions
+ * (Open Quiz & Study Exchange - Progress)
+ *
+ * @see /SPECIFICATION.md#25-user-progress-portability-oqsep
+ */
+/** Aggregate performance statistics for a single item. */
+export interface StatsObject {
+    attempts: number;
+    incorrect: number;
+    streak: number;
+}
+/** Last answer details for a single item interaction. */
+export interface LastAnswerObject {
+    isCorrect: boolean;
+    confidence?: 1 | 2 | 3 | 4;
+    answeredAt: string;
+    timeSpent?: number;
+    hintsUsed?: number;
+    isSkipped?: boolean;
+}
+/** Progress state for one item from the linked OQSE set. */
+export interface ProgressRecord {
+    bucket: 0 | 1 | 2 | 3 | 4;
+    nextReviewAt?: string;
+    stats: StatsObject;
+    lastAnswer?: LastAnswerObject;
+    appSpecific?: Record<string, unknown>;
+}
+/** OQSEP metadata describing origin and export context. */
+export interface ProgressMeta {
+    setId: string;
+    exportedAt: string;
+    algorithm?: string;
+}
+/** Root OQSEP payload for one user and one study set. */
+export interface OQSEPFile {
+    $schema?: string;
+    version: string;
+    meta: ProgressMeta;
+    records: Record<string, ProgressRecord>;
+}

package/dist/src/progressValidation.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { LastAnswerObject, OQSEPFile, ProgressMeta, ProgressRecord, StatsObject } from './progress';
+export declare const StatsObjectSchema: z.ZodType<StatsObject>;
+export declare const LastAnswerObjectSchema: z.ZodType<LastAnswerObject>;
+export declare const ProgressRecordSchema: z.ZodType<ProgressRecord>;
+export declare const ProgressMetaSchema: z.ZodType<ProgressMeta>;
+export declare const OQSEPFileSchema: z.ZodType<OQSEPFile>;
+export declare function validateOQSEPFile(data: unknown): OQSEPFile;
+export declare function safeValidateOQSEPFile(data: unknown): ReturnType<typeof OQSEPFileSchema.safeParse>;

package/dist/src/progressValidation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/utils.d.ts

@@ -0,0 +1,3 @@
+export type UUID = string;
+export declare function isValidUUID(id: string): boolean;
+export declare function generateUUID(): UUID;

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@memizy/oqse",
+  "version": "0.1.0",
+  "description": "TypeScript SDK and Zod validators for the OQSE specification.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "schemas",
+    "README.md",
+    "SPECIFICATION.md"
+  ],
+  "scripts": {
+    "dev": "vite build --watch",
+    "generate:schemas": "tsx scripts/generate-schemas.ts",
+    "build": "npm run generate:schemas && tsc && vite build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "tsx": "^4.21.0",
+    "typescript": "~6.0.2",
+    "vite": "^8.0.4",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.1.4"
+  },
+  "dependencies": {
+    "zod": "^4.3.6"
+  }
+}

package/schemas/README.md

@@ -0,0 +1 @@
+# Generated JSON schemas

package/schemas/oqse-manifest-v0.1.json

@@ -0,0 +1,256 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[a-z0-9-]+(\\.[a-z0-9-]+)*$"
+    },
+    "appName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+$"
+    },
+    "pluginVersion": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+$"
+    },
+    "minOqseVersion": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+$"
+    },
+    "maxOqseVersion": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+$"
+    },
+    "capabilities": {
+      "type": "object",
+      "properties": {
+        "features": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "latexPackages": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "itemProperties": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "metaProperties": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "actions": {
+          "minItems": 1,
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "types": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": [
+                {
+                  "type": "string",
+                  "const": "*"
+                }
+              ]
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "assets": {
+          "type": "object",
+          "properties": {
+            "image": {
+              "anyOf": [
+                {
+                  "type": "array",
+                  "items": [
+                    {
+                      "type": "string",
+                      "const": "*"
+                    }
+                  ]
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "audio": {
+              "anyOf": [
+                {
+                  "type": "array",
+                  "items": [
+                    {
+                      "type": "string",
+                      "const": "*"
+                    }
+                  ]
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "video": {
+              "anyOf": [
+                {
+                  "type": "array",
+                  "items": [
+                    {
+                      "type": "string",
+                      "const": "*"
+                    }
+                  ]
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "model": {
+              "anyOf": [
+                {
+                  "type": "array",
+                  "items": [
+                    {
+                      "type": "string",
+                      "const": "*"
+                    }
+                  ]
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "actions"
+      ],
+      "additionalProperties": false
+    },
+    "author": {
+      "type": "string",
+      "maxLength": 100
+    },
+    "authorUrl": {
+      "type": "string",
+      "format": "uri"
+    },
+    "locales": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 500
+    },
+    "emoji": {
+      "type": "string"
+    },
+    "tags": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "studyMode": {
+      "type": "string",
+      "enum": [
+        "game",
+        "fun",
+        "drill"
+      ]
+    },
+    "questionDensity": {
+      "type": "string",
+      "enum": [
+        "low",
+        "medium",
+        "high"
+      ]
+    },
+    "appSpecific": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    }
+  },
+  "required": [
+    "id",
+    "appName",
+    "version",
+    "capabilities"
+  ],
+  "additionalProperties": false
+}