@pie-players/pie-tool-sign-language 0.3.74 → 1.0.0-beta.0

package/README.md

@@ -5,11 +5,10 @@ of an item, docked beside its content.
 
 This package is also the worked example of a capability contributed entirely from
 outside the player. It is authored against
-`@pie-players/pie-assessment-toolkit/tools/internal` — the same entry point the
+`@pie-players/pie-assessment-toolkit/tools/registration` — the same entry point the
 packaged registrations use — and `@pie-players/pie-section-player` reaches it only
-through `ToolRegistry.getToolsBySurface("content-media")`. No package in the player
-names signing, the `signLanguage` support id, the `sign-language` catalog type or
-this package.
+through `ToolRegistry.getToolsBySurface("content-media")`. No package renders the
+`sign-language` catalog type except this tool.
 
 ## Opting in
 
@@ -56,15 +55,15 @@ for every learner when the markup could not be parsed.
 ASL, BSL and LSF are not interchangeable. Handing an ASL learner a BSL recording
 is worse than handing them nothing. `resolveSignLanguageAlternate` scans the
 owner snapshot for an exact requested-language match first, then permits an
-unlabelled card as the only fallback. A card labelled with another sign language
+unlabeled card as the only fallback. A card labeled with another sign language
 is never substituted.
 
 ## The element
 
 `<pie-tool-sign-language>` — open shadow root, mounted by the registration's
-`renderSurface`, never authored directly. Props are `media` (a resolved
-alternate) and `ttsService`; signing playback and read-aloud pause each other, and
-the action the learner just took wins.
+`renderSurface`, never authored directly. Its prop is `media` (a resolved
+alternate); read-aloud comes from the toolkit runtime context. Signing playback and
+read-aloud pause each other, and the action the learner just took wins.
 
 Sizing is driven by the recording's own frame shape, because signing needs height
 for hands and face. Host overrides:
@@ -75,11 +74,14 @@ for hands and face. Host overrides:
 | `--pie-section-player-item-media-min-height` | `220px` |
 | `--pie-section-player-item-media-max-height` | `60vh` |
 
+All three are registered `component-public` tokens.
+
 The region's share of the card width, the drag-to-resize handle and the stacking
 breakpoint belong to the host: that is the card's layout, not the capability's.
 
 ## Related
 
-- [`docs/prds/sign-language-asl-support.md`](../../docs/prds/sign-language-asl-support.md)
-- [`docs/TOOL_REGISTRY.md`](../assessment-toolkit/docs/TOOL_REGISTRY.md) — host
+- [Tool registry](../assessment-toolkit/docs/TOOL_REGISTRY.md): host
   surfaces and content dependencies
+- [Sign language support](../../docs/prds/sign-language-asl-support.md): the
+  design record

package/custom-elements.json

@@ -0,0 +1,65 @@
+{
+	"schemaVersion": "2.1.0",
+	"modules": [
+		{
+			"kind": "javascript-module",
+			"path": "dist/tool-sign-language.js",
+			"declarations": [
+				{
+					"kind": "class",
+					"description": "Signed translation of one item or passage, shown in the host's content-media surface. The sign-language registration's `renderSurface` mounts it and sets `media` to a resolved catalog card; it plays that recording muted with native controls, held to the card's authored time slice, under a caption naming the sign language. Its playback and read-aloud through the toolkit runtime context's TTS service pause each other.",
+					"name": "SignLanguageMediaRegion",
+					"tagName": "pie-tool-sign-language",
+					"customElement": true,
+					"members": [
+						{
+							"kind": "field",
+							"name": "media",
+							"type": {
+								"text": "ResolvedSignLanguageAlternate | null"
+							},
+							"default": "null",
+							"attribute": "media"
+						}
+					],
+					"attributes": [
+						{
+							"name": "media",
+							"type": {
+								"text": "ResolvedSignLanguageAlternate | null"
+							},
+							"default": "null",
+							"fieldName": "media"
+						}
+					],
+					"cssProperties": [
+						{
+							"name": "--pie-section-player-item-media-aspect-ratio",
+							"description": "Public sizing hook for the item card media region; defaults to 3 / 4 because signed content needs height for hands and face. Geometry-only, but hosts must keep signing legible when overriding."
+						},
+						{
+							"name": "--pie-section-player-item-media-max-height",
+							"description": "Public ceiling for the item card media region; defaults to 60vh so a tall recording cannot push question content off screen. Geometry-only."
+						},
+						{
+							"name": "--pie-section-player-item-media-min-height",
+							"description": "Public legibility floor for the item card media region; defaults to 220px so a narrow content column cannot crush signed content. Geometry-only."
+						}
+					],
+					"x-pie": {
+						"shadow": "open"
+					}
+				}
+			],
+			"exports": [
+				{
+					"kind": "custom-element-definition",
+					"name": "pie-tool-sign-language",
+					"declaration": {
+						"name": "SignLanguageMediaRegion"
+					}
+				}
+			]
+		}
+	]
+}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { CONTENT_MEDIA_SURFACE, SIGN_LANGUAGE_ELEMENT_TAG, signLanguageRegistration, } from './src/sign-language-registration.js';
+export { CONTENT_MEDIA_SURFACE, SIGN_LANGUAGE_ELEMENT_TAG, SIGN_LANGUAGE_TOOL_TAG_MAP, signLanguageRegistration, } from './src/sign-language-registration.js';
 export type { SignLanguageMedia } from './src/sign-language-cards.js';
 export { AMERICAN_SIGN_LANGUAGE, describeSignLanguage, isSignLanguageCard, matchesRequestedSignLanguage, resolveSignLanguageMedia, SIGN_LANGUAGE_CATALOG_TYPE, } from './src/sign-language-cards.js';
 export type { ResolvedSignLanguageAlternate, SignLanguageLookupArgs, } from './src/sign-language-content.js';

package/dist/src/sign-language-content.d.ts

@@ -1,4 +1,4 @@
-import { CatalogOwnerSnapshot, ToolContentDependencyContext } from '@pie-players/pie-assessment-toolkit/tools/internal';
+import { CatalogOwnerSnapshot, ToolContentDependencyContext } from '@pie-players/pie-assessment-toolkit/tools/registration';
 import { SignLanguageMedia } from './sign-language-cards.js';
 /** QTI 3.0 / AfA support id gating signed alternates. */
 export declare const SIGN_LANGUAGE_FEATURE_ID = "signLanguage";
@@ -25,7 +25,7 @@ export declare function resolveSignLanguageAlternate(args: SignLanguageLookupArg
 /**
  * Which sign language the learner is entitled to.
  *
- * Read from the feature's policy parameters (`toolParameters` / `toolConfigs`),
+ * Read from the feature's policy parameters (`toolParameters`),
  * never inferred from the item's content language — a Spanish item's signed
  * alternate is LSM, not ASL.
  */

package/dist/src/sign-language-registration.d.ts

@@ -1,4 +1,4 @@
-import { ToolRegistration } from '@pie-players/pie-assessment-toolkit/tools/internal';
+import { ToolRegistration } from '@pie-players/pie-assessment-toolkit/tools/registration';
 /**
  * Host surface this capability docks into: media beside a card's content.
  *
@@ -9,4 +9,10 @@ import { ToolRegistration } from '@pie-players/pie-assessment-toolkit/tools/inte
 export declare const CONTENT_MEDIA_SURFACE = "content-media";
 /** Element tag this package registers. A host may substitute its own. */
 export declare const SIGN_LANGUAGE_ELEMENT_TAG = "pie-tool-sign-language";
+/**
+ * The tag mapping for this capability, in the shape `setComponentOverrides`
+ * takes. The registration falls back to it, so installing it is optional; a
+ * host `toolTagMap` entry for the same id wins.
+ */
+export declare const SIGN_LANGUAGE_TOOL_TAG_MAP: Readonly<Record<string, string>>;
 export declare const signLanguageRegistration: ToolRegistration;

package/dist/src/sign-language-warnings.d.ts

@@ -0,0 +1,2 @@
+/** Warn once per key for the life of the page. */
+export declare function warnSignLanguageOnce(key: string, message: string): void;