@teacharium/widget 0.1.0 → 0.2.0

package/dist/main.d.ts

@@ -0,0 +1,5 @@
+export * from './teacharium-widget';
+export * from './teacharium-widget-api';
+export * from './teacharium-custom-fields';
+export * from './standard-layout-options';
+export declare const hi = "world";

package/dist/standard-layout-options.d.ts

@@ -0,0 +1,11 @@
+import { PuckComponent } from '@measured/puck';
+import { TeachariumComponentConfig } from './teacharium-widget';
+import { React } from 'next/dist/server/route-modules/app-page/vendored/rsc/entrypoints';
+type StandardLayoutProps = {
+    margin: number;
+};
+export declare const LayoutContainer: PuckComponent<StandardLayoutProps & {
+    children: React.ReactNode;
+}>;
+export declare const addStandardLayoutOptions: <T>(config: TeachariumComponentConfig<T>) => TeachariumComponentConfig<T & StandardLayoutProps>;
+export {};

package/dist/teacharium-custom-fields.d.ts

@@ -0,0 +1,34 @@
+import { BaseField } from '@measured/puck';
+export interface ImageMediaField extends BaseField {
+    type: "imageMedia";
+    label: string;
+}
+export interface VideoMediaField extends BaseField {
+    type: "videoMedia";
+    label: string;
+}
+export interface AudioMediaField extends BaseField {
+    type: "audioMedia";
+    label: string;
+}
+export interface ActionField extends BaseField {
+    type: "action";
+    label: string;
+}
+export interface VariableField extends BaseField {
+    type: "variable";
+    label: string;
+}
+export interface NumericExpressionField extends BaseField {
+    type: "numericExpression";
+    label: string;
+}
+export interface StringExpressionField extends BaseField {
+    type: "stringExpression";
+    label: string;
+}
+export interface ConditionField extends BaseField {
+    type: "condition";
+    label: string;
+}
+export type TeachariumCustomFields = ImageMediaField | VideoMediaField | AudioMediaField | ActionField | VariableField | NumericExpressionField | StringExpressionField | ConditionField;

package/dist/teacharium-widget-api.d.ts

@@ -0,0 +1,115 @@
+import { default as React } from 'react';
+export declare const EVENT_SOURCE_PLAYER = "player";
+export declare const EVENT_SOURCE_FOOTER = "footer";
+type EventListener<T = any> = (event: T) => void;
+export interface BaseEvent {
+    type: string;
+    timestamp?: string;
+    emittedBy?: string;
+}
+export type VariableValue = string | number | boolean;
+export interface UseNumberExpression {
+    (expression: string, defaultValue: number): number;
+    (expression: string): number | null;
+}
+export interface UseStringExpression {
+    (expression: string, defaultValue?: string): string;
+}
+export interface UseVariableValue {
+    (name: string): VariableValue | undefined;
+}
+export interface UseVariableValues {
+    (names: string[]): (VariableValue | undefined)[];
+}
+export interface UseUpdateVariable {
+    (newValue: VariableValue): void;
+}
+export interface UseMediaUrl {
+    (src: string, expiresIn?: number): {
+        data: string | undefined;
+        error: Error | null;
+        isError: boolean;
+        isLoading: boolean;
+        isLoadingError: boolean;
+    };
+}
+export interface ConditionValue {
+    leftOperand: string;
+    operator: string;
+    rightOperand: string;
+    type: "string" | "number";
+}
+export interface UseConditionEvaluationResult {
+    result: boolean | null;
+    hasError: boolean;
+}
+export interface UseConditionEvaluation {
+    (condition: ConditionValue): UseConditionEvaluationResult;
+}
+export interface ItemOptions {
+    correctVariableName: string;
+    feedbackVariableName?: string;
+    attemptedVariableName?: string;
+}
+export interface UseIsItem {
+    (widgetId: string, options: ItemOptions): void;
+}
+export interface ItemData {
+    widgetId: string;
+    correctVariableName: string;
+    feedbackVariableName?: string;
+    attemptedVariableName?: string;
+}
+export interface ItemsContextValue {
+    items: Map<string, ItemData>;
+    registerItem: (widgetId: string, options: ItemOptions) => void;
+    unregisterItem: (widgetId: string) => void;
+    getItems: () => ItemData[];
+}
+export interface UseItemsContext {
+    (): ItemsContextValue;
+}
+export interface UseLessonEventEmitter {
+    (): <T extends BaseEvent = BaseEvent>(event: T) => void;
+}
+export interface UseLessonEventSubscription {
+    <T = any>(eventType: string, listener: EventListener<T>, priority?: number, deps?: React.DependencyList): void;
+}
+export interface TeachariumWidgetApi {
+    isEditing: boolean;
+    playerMode: "editing" | "preview" | "playbook";
+    events: {
+        /**
+         * Emit an event with type and params
+         * Example: api.events.emit({ type: "nextStep", params: {} })
+         */
+        emit<T extends BaseEvent = BaseEvent>(event: T): void;
+        subscribe<T extends BaseEvent = BaseEvent>(eventType: string, listener: EventListener<T>): () => void;
+        unsubscribe(eventType: string, listener: EventListener): void;
+    };
+    React: any;
+    hooks: {
+        useNumberExpression: UseNumberExpression;
+        useStringExpression: UseStringExpression;
+        useVariableValue: UseVariableValue;
+        useVariableValues: UseVariableValues;
+        useUpdateVariable: (variableName: string) => UseUpdateVariable;
+        useMediaUrl: UseMediaUrl;
+        useConditionEvaluation: UseConditionEvaluation;
+        useIsItem: UseIsItem;
+        useItemsContext: UseItemsContext;
+        useLessonEventEmitter: UseLessonEventEmitter;
+        useLessonEventSubscription: UseLessonEventSubscription;
+    };
+    /**
+     * Create a transient variable that exists only during runtime
+     * Automatically prefixes the variable name with the widget ID
+     * Example: addVariable('selectedAnswer', 0) might create 'mcwidget1_selectedAnswer'
+     * @param name - Base name for the variable (will be prefixed with widget ID)
+     * @param initialValue - Initial value for the variable
+     * @param type - Optional type specification (auto-inferred if not provided)
+     * @returns The full variable name that was created
+     */
+    addVariable: (name: string, initialValue: VariableValue, type?: "string" | "number" | "boolean") => string;
+}
+export {};

package/dist/teacharium-widget.d.ts

@@ -0,0 +1,24 @@
+import { DefaultComponentProps, Fields, PuckComponent } from '@measured/puck';
+import { TeachariumWidgetApi } from './teacharium-widget-api';
+import { TeachariumCustomFields } from './teacharium-custom-fields';
+interface TeachariumComponentProps {
+    api: TeachariumWidgetApi;
+}
+export interface TeachariumComponentConfig<T = {}> {
+    fields: Fields<DefaultComponentProps, TeachariumCustomFields>;
+    defaultProps: DefaultComponentProps;
+    render: PuckComponent<T & TeachariumComponentProps>;
+}
+export interface TeachariumWidget<T> {
+    name: string;
+    category: string;
+    config: TeachariumComponentConfig<T>;
+}
+export declare const registerWidget: (widget: TeachariumWidget<any>) => void;
+export declare const getWidgets: () => TeachariumWidget<any>[];
+declare global {
+    interface Window {
+        TeachariumComponents?: Record<string, TeachariumWidget<any>>;
+    }
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teacharium/widget",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "files": [
     "dist"