@aastrika/ai-elements 0.4.0 → 0.4.1

package/CHANGELOG.md

@@ -6,6 +6,29 @@ see at a glance what to expect when they upgrade.
 Versions follow semver: a **minor** adds something, a **patch** fixes something,
 and neither removes anything a host was using.
 
+## 0.4.1
+
+**Fixed**
+- This page now renders on npm. The architecture diagram was mermaid, which npm
+  shows as raw source, and the callouts used GitHub alert syntax. No code change
+
+## 0.4.0
+
+**Changed**
+- Generating a quiz now starts the work and polls for it, instead of waiting on
+  one long request. Nothing to change in your code — same tag, same inputs, same
+  `assessmentReady` firing once with the finished set
+
+**Why it matters**
+- No 60-second ceiling: gateways and proxies commonly close a request at one
+  minute, which capped how many languages could be asked for at once
+- The progress shown is the server's own, not an estimate
+- Closing the tab no longer loses the work
+
+**Notes for integrators**
+- Upgrade the service and the package together. A 0.3.0 element cannot read what
+  a 0.4.0 service answers, and the reverse leaves the element waiting
+
 ## 0.3.0
 
 **Added**

package/README.md

@@ -56,7 +56,6 @@ same questions, same answer key, ready to download.
 
 </div>
 
-> [!IMPORTANT]
 > **You also need gateway access.** This package authenticates nobody — your
 > gateway decides. See [Access](#access) for the groups each feature needs.
 
@@ -67,7 +66,6 @@ same questions, same answer key, ready to download.
 | | |
 |---|---|
 | **[The three features](#the-three-features)** | What each element actually does |
-| **[Setup](#setup)** | Install · access · configure · mount |
 | **[Configuration](#configuration)** | The three values, and why two are functions |
 | **[Access](#access)** | Which gateway groups each feature needs |
 | **[Inputs and events](#inputs-and-events)** | Open the form set up, act on the result |
@@ -133,7 +131,6 @@ fixes wording in place; the correct option is shared, so it is set once.
 Totals for videos, assessments, people and estimated spend, split by tool, with
 a searchable table of creators.
 
-> [!WARNING]
 > **Needs `contentAdmin`, and most consumers should not have it.** Spend figures
 > are not for a partner's ordinary users. The service applies no role check of
 > its own — the gateway's ACL is the only thing keeping them apart.
@@ -142,20 +139,6 @@ a searchable table of creators.
 
 ---
 
-## Setup
-
-The [Quick start](#ship-it-in-three-steps) above is the whole integration. What each step
-is actually doing:
-
-| | Step | Notes |
-|---|---|---|
-| **1** | `npm i @aastrika/ai-elements` | No peer dependencies, no framework to match. Any bundler, or none |
-| **2** | Get gateway access | The package authenticates nobody — your gateway decides. See [Access](#access), then ask the Aastrika platform team |
-| **3** | `configure({ ... })` | Once, before the first element renders. Two of the three values are **functions** — see [Configuration](#configuration) |
-| **4** | Write the tag | Registration happens on import, so there is no third step |
-
----
-
 <details>
 <summary><b>React · Angular · Vue · plain HTML</b></summary>
 
@@ -264,40 +247,19 @@ calling it, as above, prevents both.
 
 ## How it fits together
 
-```mermaid
-flowchart LR
-    subgraph host["Your application"]
-        cfg["configure()"]
-        tag["&lt;aastrika-content-studio&gt;"]
-    end
-
-    subgraph pkg["@aastrika/ai-elements"]
-        el["Custom element"]
-        int["Interceptor"]
-    end
-
-    subgraph svc["Aastrika"]
-        gw["Gateway<br/>checks the token"]
-        api["AI service"]
-    end
-
-    cfg -.->|apiBase · auth · creator| int
-    tag --> el
-    el --> int
-    int -->|"Authorization<br/>creator in the body"| gw
-    gw --> api
-    api -.->|JSON| el
-    el -.->|onError| cfg
-
-    classDef a fill:#0F766E,stroke:none,color:#fff
-    classDef b fill:#f1f5f4,stroke:#cbd5d3,color:#16181d
-    class el,int a
-    class cfg,tag,gw,api b
+```
+  Your application                 @aastrika/ai-elements              Aastrika
+  ────────────────                 ─────────────────────              ────────
+  configure() ─────── apiBase ───▶ interceptor ─── Authorization ───▶ gateway
+                      auth              ▲          creator in body       │
+                      creator           │                                ▼
+  <aastrika-… >  ────────────────▶ element ◀────────── JSON ────────  AI service
+                      ▲                 │
+                      └──── onError ────┘
 ```
 
-**Your application supplies three values. The package does the rest** — builds
-every request from `apiBase`, calls your two functions on each one, and renders
-into your page, styled through CSS custom properties.
+Your application supplies three values. The package builds every request from
+`apiBase`, calls your two functions on each one, and renders into your page.
 
 ---
 
@@ -325,7 +287,6 @@ getAuthHeaders: async () => ({ Authorization: `Bearer ${await auth.token()}` }),
 The same goes for `creator`: a function lets you switch user without reloading
 the page.
 
-> [!NOTE]
 > **`creator` is attribution, not identity.** It is recorded against whatever
 > the call creates and the usage report groups by it. Nothing verifies it — the
 > gateway decides whether the call is allowed at all.
@@ -348,7 +309,6 @@ needs:
 Deleting anything needs `contentAdmin` as well. Without `contentUpdate` the
 features still work, but the revise step returns 403.
 
-> [!CAUTION]
 > **`generate-video` is the only call that spends real money**, and it sits on a
 > deliberately low rate limit. Users see a cost estimate before triggering it.
 
@@ -434,21 +394,7 @@ All are **starting values** the user can still change.
 </aastrika-content-studio>
 ```
 
-### One quiz, several languages
-
-`default-translate-into` produces the **same** questions in other languages —
-same order, same options, same answer key — so one answer key marks every
-language and scores compare across them.
-
-```html
-<aastrika-assessment default-language="hi" default-translate-into="en,mr">
-</aastrika-assessment>
-```
-
-The reviewer gets a tab per language. Excel holds every language, one sheet
-each; CSV holds one language at a time.
-
-`assessmentReady` reports what came back:
+### Translations, in the event
 
 ```js
 el.addEventListener('assessmentReady', (e) => {
@@ -459,8 +405,8 @@ el.addEventListener('assessmentReady', (e) => {
 
 `languages` can be shorter than what was asked for. A translation is checked for
 question count, ids, answer key, clinical numbers and script; one that fails is
-dropped rather than stored wrong. What is **not** checked is whether the
-translation reads well — that still needs someone who speaks the language.
+dropped rather than stored wrong. What is **not** checked is whether it reads
+well — that still needs someone who speaks the language.
 
 ### Events
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aastrika/ai-elements",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "AI Content Studio, Assessment and Reports as custom elements. Works in React, Vue, Angular or plain HTML.",
   "type": "module",
   "main": "./aastrika-elements.js",