@project-sunbird/collection-editor-react 0.1.17 → 0.1.19

package/dist/components/SparkMetaForm/hooks/emitTransform.d.ts

@@ -0,0 +1,17 @@
+export declare const EMIT_OMIT_KEYS: readonly ["allowECM", "levels", "setPeriod", "instances"];
+export declare function createLevels(levels: unknown[]): Record<string, {
+    label: unknown;
+}>;
+/**
+ * Transform the full form value object before it is written to the node /
+ * emitted — used for batch / cascade writes (Angular emits the whole `data`).
+ */
+export declare function transformEmit(values: Record<string, unknown>, opts?: {
+    isReview?: boolean;
+    nodeTitle?: string;
+}): Record<string, unknown>;
+/**
+ * Transform a single changed field into the patch to persist. Returns null
+ * when the field is UI-only and must not be written (allowECM / setPeriod).
+ */
+export declare function transformFieldPatch(changedField: string, value: unknown): Record<string, unknown> | null;

package/dist/components/SparkMetaForm/hooks/emitTransform.test.d.ts

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

package/dist/components/SparkMetaForm/hooks/useCascade.d.ts

@@ -5,10 +5,18 @@ export type { IFieldConfig } from './useFieldPrepare';
 /**
  * useCascade
  *
- * Resets a child field's value whenever one of its parent fields (declared via
- * `depends`) changes. The child's *options* are recomputed reactively in
- * useFieldPrepare (filtered by the parent's selected value via term
- * associations), so this hook only has to clear the now-stale child value.
+ * When a parent field changes, clear every field that depends on it —
+ * TRANSITIVELY, in a single pass (board → clears medium → grade → subject all
+ * at once). Mirrors Angular's `resetDependents` (spark-meta-form.component.ts:
+ * 449-465), which walks the full `depends` graph rather than relying on the
+ * RHF watch ripple to clear one level per microtask.
+ *
+ * The child's *options* are recomputed reactively in useFieldPrepare (filtered
+ * by the parent's selected value via term associations), so this hook only has
+ * to clear the now-stale child values.
+ *
+ * A re-entrancy guard stops the setValue calls we make here from re-triggering
+ * the watch callback and clearing the same fields again.
  *
  * @param form   react-hook-form UseFormReturn instance.
  * @param fields Prepared field list (carries the `depends` graph).

package/dist/components/SparkMetaForm/hooks/useFieldPrepare.d.ts

@@ -40,4 +40,36 @@ export interface IFieldConfig extends PreparedField {
         identifier: string;
     }>;
 }
-export declare function useFieldPrepare(formConfig: Array<Record<string, unknown>>, nodeMetadata: Record<string, unknown>, frameworkDetails: IFrameworkDetails, isRoot: boolean): PreparedField[];
+/**
+ * Extra context the form needs to seed defaults / ranges and to decide
+ * per-field editability — mirrors the data Angular reads from EditorService,
+ * HelperService.channelInfo and ConfigService inside `prepareFields` /
+ * `ifFieldIsEditable`. All fields optional so existing callers keep working.
+ */
+export interface IPrepareContext {
+    editorMode?: string;
+    /** editorConfig.config.editableFields — { review: ['name', …], … }. */
+    editableFields?: Record<string, string[]>;
+    /** editorConfig.config.objectType — picks the channel additionalCategories source. */
+    objectType?: string;
+    setDefaultCopyRight?: boolean;
+    /** editorConfig.context.defaultLicense */
+    defaultLicense?: string;
+    /** editorConfig.context.additionalCategories (fallback). */
+    contextAdditionalCategories?: string[];
+    /** editorConfig.context.user.fullName */
+    userFullName?: string;
+    /** channelInfo.name — used as default copyright when setDefaultCopyRight. */
+    channelName?: string;
+    /** channelInfo.collectionAdditionalCategories */
+    collectionAdditionalCategories?: string[];
+    /** channelInfo.contentAdditionalCategories */
+    contentAdditionalCategories?: string[];
+    /** Count of the active node's direct children — feeds maxQuestions range. */
+    childCount?: number;
+}
+export declare function useFieldPrepare(formConfig: Array<Record<string, unknown>>, nodeMetadata: Record<string, unknown>, frameworkDetails: IFrameworkDetails, isRoot: boolean, ctx?: IPrepareContext): PreparedField[];
+export declare function __computeFieldOptionsForTest(field: Record<string, unknown>, fw: IFrameworkDetails, nodeMetadata: Record<string, unknown>, siblingFields?: Array<Record<string, unknown>>): Array<{
+    label: string;
+    value: string;
+}> | undefined;

package/dist/components/SparkMetaForm/hooks/useFieldPrepare.defaults.test.d.ts

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

package/dist/components/SparkMetaForm/hooks/useFieldPrepare.test.d.ts

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

package/dist/hooks/useFrameworkOptions.d.ts

@@ -0,0 +1,20 @@
+interface ChannelFramework {
+    identifier: string;
+    name: string;
+    type?: string;
+}
+/**
+ * Build the option list for the `framework` (Course Type) field.
+ *
+ * Mirrors Angular's getFrameworkDetails (editor.component.ts:277-318):
+ *  - Start from the channel's frameworks.
+ *  - If the category definition declares `orgFWType`, restrict to frameworks of
+ *    those types; for any declared type the channel does NOT cover, fetch the
+ *    system-default frameworks of that type via composite search and merge them.
+ *  - With no `orgFWType`, fall back to all channel frameworks.
+ */
+export declare function useFrameworkOptions(channelFrameworks: ChannelFramework[] | undefined, orgFWType: string[] | undefined, channel: string | undefined): Array<{
+    label: string;
+    value: string;
+}>;
+export {};

package/dist/hooks/useQumlContent.d.ts

@@ -0,0 +1,16 @@
+import { UseQueryResult } from '@tanstack/react-query';
+
+interface UseQumlContentOptions {
+    enabled?: boolean;
+}
+/**
+ * Fetches and assembles the QuestionSet metadata a QuML player needs.
+ *  - reads the questionset hierarchy
+ *  - collects all question identifiers from the tree
+ *  - fetches full question bodies via /question/v2/list
+ *  - replaces question stubs in the hierarchy with the full data
+ *  - backfills outcomeDeclaration.maxScore where missing
+ * The result is passed straight to <sunbird-quml-player> as `metadata`.
+ */
+export declare function useQumlContent(questionSetId: string, options?: UseQumlContentOptions): UseQueryResult<Record<string, unknown>, Error>;
+export {};