@memizy/oqse 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 memizy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,58 @@
+# OQSE SDK
+
+Official TypeScript SDK for the Open Quiz & Study Exchange ecosystem, published as @memizy/oqse.
+
+This repository contains:
+- Runtime validators built with Zod.
+- Manually authored TypeScript types for developer ergonomics.
+- Auto-generated JSON Schemas distributed with the package.
+- The human-readable specification in SPECIFICATION.md.
+
+## Package
+
+- Name: @memizy/oqse
+- Purpose: validate, parse, and type OQSE, OQSE Manifest, and OQSEP progress data.
+
+## Architecture & Single Source of Truth
+
+1. The specification markdown is for humans.
+   SPECIFICATION.md is the normative documentation for concepts, rules, and semantics.
+
+2. Zod schemas (*Validation.ts) are the absolute source of truth for code validation.
+   Runtime validation behavior is defined in src/oqseValidation.ts, src/manifestValidation.ts, and src/progressValidation.ts.
+
+3. TypeScript types (oqse.ts, manifest.ts, progress.ts) manually mirror the Zod schemas for better Developer Experience.
+   These files are intentionally hand-written to provide clearer interfaces, JSDoc, and IntelliSense quality.
+
+4. JSON schemas are strictly auto-generated using npm run generate:schemas and contributors MUST NOT edit them manually.
+   If validation behavior changes, update the Zod schemas first, then regenerate.
+
+## Development
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Build and regenerate schemas:
+
+```bash
+npm run build
+```
+
+Generate only JSON schemas:
+
+```bash
+npm run generate:schemas
+```
+
+Run tests:
+
+```bash
+npm test
+```
+
+## Contributing Rule
+
+Never edit files in schemas/ by hand. Always regenerate via npm run generate:schemas.