@media-quest/builder 0.0.39 → 0.0.41

package/src/builder-compiler.ts

@@ -1,20 +1,14 @@
-import { SchemaDto } from "@media-quest/engine";
-import { Codebook } from "./code-book/codebook";
-import { SchemaConfig } from "./schema-config";
-
-export interface CompilerOutput {
-  schema: SchemaDto;
-  codebook: Codebook;
-  schemaConfig: SchemaConfig;
-}
-
-export interface CompilerOption {
-  blockAutoplayQuestion: boolean;
-  blockAutoplayVideo: boolean;
-  mediaAssets: {
-    audioFilesBaseUrl: string;
-    videoFilesBaseUrl: string;
-    imageFilesBaseUrl: string;
-    fileNameStrategy: "id" | "newFileName" | "originalFileName" | "relativePath";
-  } | null;
-}
+import { SchemaDto } from "@media-quest/engine";
+import { Codebook } from "./code-book/codebook";
+import { SchemaConfig } from "./schema-config";
+
+export interface CompilerOutput {
+  schema: SchemaDto;
+  codebook: Codebook;
+  schemaConfig: SchemaConfig;
+}
+
+export interface CompilerOption {
+  blockAutoplayQuestion: boolean;
+  blockAutoplayVideo: boolean;
+}

package/src/code-book/codebook-variable.ts

@@ -1,27 +1,27 @@
-import { PageID } from "../primitives/ID";
-import { SumScoreVariableDto } from "../sum-score/sum-score-variable";
-
-/**
- * Interface representing a code book question sum-score.
- *
- * @interface
- */
-export interface CodeBookQuestionVariable {
-  readonly kind: "codebook-question-variable";
-  readonly label: string;
-  readonly varId: string;
-  readonly pageId: PageID;
-  readonly pagePrefix: string;
-  readonly modulePrefix: string;
-  readonly pagePosition: number;
-  readonly options: ReadonlyArray<{ label: string; value: number }>;
-  readonly includedInSumScores: ReadonlyArray<SumScoreVariableDto>;
-}
-
-export interface CodebookPredefinedVariable {
-  readonly kind: "codebook-predefined-variable";
-  readonly modulePrefix: string;
-  readonly moduleID: string;
-  defaultValue: number;
-  options: Array<{ label: string; value: number }>;
-}
+import { PageID } from "../primitives/ID";
+import { SumScoreVariableDto } from "../sum-score/sum-score-variable";
+
+/**
+ * Interface representing a code book question sum-score.
+ *
+ * @interface
+ */
+export interface CodeBookQuestionVariable {
+  readonly kind: "codebook-question-variable";
+  readonly label: string;
+  readonly varId: string;
+  readonly pageId: PageID;
+  readonly pagePrefix: string;
+  readonly modulePrefix: string;
+  readonly pagePosition: number;
+  readonly options: ReadonlyArray<{ label: string; value: number }>;
+  readonly includedInSumScores: ReadonlyArray<SumScoreVariableDto>;
+}
+
+export interface CodebookPredefinedVariable {
+  readonly kind: "codebook-predefined-variable";
+  readonly modulePrefix: string;
+  readonly moduleID: string;
+  defaultValue: number;
+  options: Array<{ label: string; value: number }>;
+}

package/src/code-book/codebook.ts

@@ -1,89 +1,89 @@
-import { BuilderPageDto } from "../page/Builder-page";
-import { CodeBookQuestionVariable, CodebookPredefinedVariable } from "./codebook-variable";
-import { SumScoreVariableDto } from "../sum-score/sum-score-variable";
-import { BuilderSchemaDto } from "../Builder-schema-dto";
-
-export interface Codebook {
-  readonly predefinedVariables: ReadonlyArray<CodebookPredefinedVariable>;
-  readonly pageVariables: ReadonlyArray<CodeBookQuestionVariable>;
-}
-
-const fromPage = (
-  page: BuilderPageDto,
-  sumScoreVariables: ReadonlyArray<SumScoreVariableDto>,
-  pagePosition: number,
-  modulePrefix: string,
-): CodeBookQuestionVariable[] => {
-  const variables: CodeBookQuestionVariable[] = [];
-
-  if (page._type !== "question") {
-    // TODO Implement form field variables
-    return [];
-  }
-
-  const options: CodeBookQuestionVariable["options"] = page.defaultQuestion.options.map((o) => {
-    return { value: o.value, label: o.label };
-  });
-
-  const varId = modulePrefix + "_" + page.prefix;
-  const pageIncludedInSumScoresArray = page.includedInSumScores ?? [];
-
-  const includedInSumScores: SumScoreVariableDto[] = [];
-  pageIncludedInSumScoresArray.forEach((p) => {
-    sumScoreVariables.forEach((ssv) => {
-      if (p.sumScoreVariableId === ssv.id) {
-        includedInSumScores.push(ssv);
-      }
-    });
-  });
-
-  const variable: CodeBookQuestionVariable = {
-    kind: "codebook-question-variable",
-    label: page.mainText.text,
-    pageId: page.id,
-    pagePrefix: page.prefix,
-    options,
-    modulePrefix,
-    pagePosition,
-    varId,
-    includedInSumScores,
-  };
-
-  variables.push(variable);
-
-  return variables;
-};
-
-/**
- * Converts a list of pages into a list of question-variables
- * @param pages
- * @param sumScoreVariables
- * @param modulePrefix
- */
-const getPageVariablesFromPages = (
-  pages: ReadonlyArray<BuilderPageDto>,
-  sumScoreVariables: ReadonlyArray<SumScoreVariableDto>,
-  modulePrefix: string,
-): CodeBookQuestionVariable[] => {
-  const variables: CodeBookQuestionVariable[] = [];
-  pages.forEach((page, index) => {
-    const pageVariables = fromPage(page, sumScoreVariables, index, modulePrefix);
-    variables.push(...pageVariables);
-  });
-  return variables;
-};
-
-const fromSchema = (schema: BuilderSchemaDto): Codebook => {
-  const modulePrefix = schema.prefix;
-  const sumScoreVariables = schema.sumScoreVariables ?? [];
-  const pageVariables = getPageVariablesFromPages(schema.pages, sumScoreVariables, modulePrefix);
-  const vs = schema.predefinedVariables;
-  const predefinedVariables: CodebookPredefinedVariable[] = vs ? [...vs] : [];
-  return { pageVariables, predefinedVariables };
-};
-
-export const _CodeBook = {
-  fromSchema,
-} as const;
-
-export const CodeBook = Object.freeze(_CodeBook);
+import { BuilderPageDto } from "../page/Builder-page";
+import { BuilderSchemaDto } from "../Builder-schema";
+import { CodeBookQuestionVariable, CodebookPredefinedVariable } from "./codebook-variable";
+import { SumScoreVariableDto } from "../sum-score/sum-score-variable";
+
+export interface Codebook {
+  readonly predefinedVariables: ReadonlyArray<CodebookPredefinedVariable>;
+  readonly pageVariables: ReadonlyArray<CodeBookQuestionVariable>;
+}
+
+const fromPage = (
+  page: BuilderPageDto,
+  sumScoreVariables: ReadonlyArray<SumScoreVariableDto>,
+  pagePosition: number,
+  modulePrefix: string,
+): CodeBookQuestionVariable[] => {
+  const variables: CodeBookQuestionVariable[] = [];
+
+  if (page._type !== "question") {
+    // TODO Implement form field variables
+    return [];
+  }
+
+  const options: CodeBookQuestionVariable["options"] = page.defaultQuestion.options.map((o) => {
+    return { value: o.value, label: o.label };
+  });
+
+  const varId = modulePrefix + "_" + page.prefix;
+  const pageIncludedInSumScoresArray = page.includedInSumScores ?? [];
+
+  const includedInSumScores: SumScoreVariableDto[] = [];
+  pageIncludedInSumScoresArray.forEach((p) => {
+    sumScoreVariables.forEach((ssv) => {
+      if (p.sumScoreVariableId === ssv.id) {
+        includedInSumScores.push(ssv);
+      }
+    });
+  });
+
+  const variable: CodeBookQuestionVariable = {
+    kind: "codebook-question-variable",
+    label: page.mainText.text,
+    pageId: page.id,
+    pagePrefix: page.prefix,
+    options,
+    modulePrefix,
+    pagePosition,
+    varId,
+    includedInSumScores,
+  };
+
+  variables.push(variable);
+
+  return variables;
+};
+
+/**
+ * Converts a list of pages into a list of question-variables
+ * @param pages
+ * @param sumScoreVariables
+ * @param modulePrefix
+ */
+const getPageVariablesFromPages = (
+  pages: ReadonlyArray<BuilderPageDto>,
+  sumScoreVariables: ReadonlyArray<SumScoreVariableDto>,
+  modulePrefix: string,
+): CodeBookQuestionVariable[] => {
+  const variables: CodeBookQuestionVariable[] = [];
+  pages.forEach((page, index) => {
+    const pageVariables = fromPage(page, sumScoreVariables, index, modulePrefix);
+    variables.push(...pageVariables);
+  });
+  return variables;
+};
+
+const fromSchema = (schema: BuilderSchemaDto): Codebook => {
+  const modulePrefix = schema.prefix;
+  const sumScoreVariables = schema.sumScoreVariables ?? [];
+  const pageVariables = getPageVariablesFromPages(schema.pages, sumScoreVariables, modulePrefix);
+  const vs = schema.predefinedVariables;
+  const predefinedVariables: CodebookPredefinedVariable[] = vs ? [...vs] : [];
+  return { pageVariables, predefinedVariables };
+};
+
+export const _CodeBook = {
+  fromSchema,
+} as const;
+
+export const CodeBook = Object.freeze(_CodeBook);

package/src/media-files.ts

@@ -1,32 +1,28 @@
-export interface AudioFile {
-  readonly kind: "audio-file";
-  readonly id: string;
-  downloadUrl: string;
-  readonly duration: number;
-  readonly originalFileName: string;
-  readonly name: string;
-  readonly size: number;
-  readonly relativePath?: string;
-}
-
-export interface VideoFile {
-  readonly kind: "video-file";
-  readonly id: string;
-  downloadUrl: string;
-  readonly duration: number;
-  readonly name: string;
-  readonly size: number;
-  readonly type: string;
-  readonly originalFileName: string;
-  readonly relativePath?: string;
-}
-export interface ImageFile {
-  readonly kind: "image-file";
-  readonly id: string;
-  downloadUrl: string;
-  readonly name: string;
-  readonly size: number;
-  readonly type: string;
-  readonly originalFileName?: string;
-  readonly relativePath?: string;
-}
+export interface AudioFile {
+    readonly kind: "audio-file";
+    readonly id: string;
+    readonly downloadUrl: string;
+    readonly duration: number;
+    readonly originalFileName: string;
+    readonly name: string;
+    readonly size: number;
+}
+
+export interface VideoFile {
+    readonly kind: "video-file";
+    readonly id: string;
+    readonly downloadUrl: string;
+    readonly duration: number;
+    readonly name: string;
+    readonly size: number;
+    readonly type: string;
+    readonly originalFileName: string;
+}
+export interface ImageFile {
+    readonly kind: "image-file";
+    readonly id: string;
+    readonly downloadUrl: string;
+    readonly name: string;
+    readonly size: number;
+    readonly type: string;
+}