kt-forpro-tools 1.0.24 → 1.1.0

package/package.json

@@ -1,30 +1,30 @@
-{
-    "name": "kt-forpro-tools",
-    "version": "1.0.24",
-    "description": "",
-    "author": "Miguel de Mendoza",
-    "main": "src/index.ts",
-    "license": "MIT",
-    "scripts": {
-        "build": "kt-build",
-        "build-tests": "kt-build build-tests",
-        "debug-build-tests": "kt-build debug-build-tests"
-    },
-    "files": [
-        "src",
-        "tsconfig.json"
-    ],
-    "dependencies": {
-        "kt-ae-is-checkers": "^1.0.7",
-        "kt-ae-tools-layers": "^1.0.0",
-        "kt-ae-tools-project": "^1.0.5",
-        "kt-core": "*",
-        "kt-io": "^1.1.0"
-    },
-    "devDependencies": {
-        "kt-extendscript-builder": "*",
-        "kt-testing-suite-ae": "*",
-        "kt-testing-suite-core": "^1.7.7",
-        "prettier": "^3.6.2"
-    }
-}
+{
+    "name": "kt-forpro-tools",
+    "version": "1.1.0",
+    "description": "",
+    "author": "Miguel de Mendoza",
+    "main": "src/index.ts",
+    "license": "MIT",
+    "scripts": {
+        "build": "kt-build",
+        "build-tests": "kt-build build-tests",
+        "debug-build-tests": "kt-build debug-build-tests"
+    },
+    "files": [
+        "src",
+        "tsconfig.json"
+    ],
+    "dependencies": {
+        "kt-ae-is-checkers": "^1.0.7",
+        "kt-ae-tools-layers": "^1.0.0",
+        "kt-ae-tools-project": "^1.0.5",
+        "kt-core": "*",
+        "kt-io": "^1.1.0"
+    },
+    "devDependencies": {
+        "kt-extendscript-builder": "*",
+        "kt-testing-suite-ae": "*",
+        "kt-testing-suite-core": "^1.7.7",
+        "prettier": "^3.6.2"
+    }
+}

package/src/freeze.ts

@@ -1,17 +1,12 @@
-import { KT_Project } from "kt-ae-tools-project";
+import { KTSlidesFreezeConfig } from "./maps";
 
 class __KT_SlidesFreeze {
-    courseTitle = KT_Project.find.comps("titulo-curso")[0];
-    professorPastilla = KT_Project.find.comps("profesor-pastilla")[0];
-    logo_in = KT_Project.find.comps("Logotipo")[0];
-    logosCartela = KT_Project.find.comps("Logotipos-cartela")[0];
-    logo_out = KT_Project.find.comps("logo_out")[0];
-    chyrons = KT_Project.find.comps("chyrons")[0];
-    //find comps named with only two digits
-    lessons: CompItem[] = KT_Project.find.comps(/^\d{2}$/);
-    init = () => {
-        $.writeln("Dummy method to force transpilation");
-    };
+    private config: KTSlidesFreezeConfig | null = null;
+
+    init(map: KTSlidesFreezeConfig) {
+        this.config = map;
+    }
+
     private frezzeExpression(property: Property) {
         if (property.canSetExpression && property.expressionEnabled) {
             const value = property.value;
@@ -26,27 +21,13 @@ class __KT_SlidesFreeze {
         }
     }
 
-    private findProperties() {
-        const properties: Property[] = [
-            (this.courseTitle.layers.byName("titulo") as TextLayer).text.sourceText,
-            (this.professorPastilla.layers.byName("profesor") as TextLayer).text.sourceText,
-            (this.logosCartela.layers[1] as AVLayer).transform.opacity,
-            (this.logosCartela.layers[2] as AVLayer).transform.opacity,
-            (this.logo_in.layers[1] as AVLayer).transform.opacity,
-            (this.logo_in.layers[2] as AVLayer).transform.opacity,
-            (this.logo_out.layers[1] as AVLayer).transform.opacity,
-            (this.logo_out.layers[2] as AVLayer).transform.opacity,
-            (this.chyrons.layers.byName("profesor") as TextLayer).text.sourceText,
-            (this.chyrons.layers.byName("titulo") as TextLayer).text.sourceText,
-            (this.logo_out.layers.byName("logo-cat") as AVLayer).transform.opacity,
-            (this.logo_out.layers.byName("logo-esp") as AVLayer).transform.opacity,
-        ];
-
-        this.lessons.forEach((comp) => {
-            properties.push((comp.layers.byName("leccion") as TextLayer).text.sourceText);
-        });
-
-        return properties;
+    private findProperties(): Property[] {
+        if (!this.config) {
+            throw new Error(
+                "KT_SlidesFreeze: call init(map) before using freeze/unfreeze/checkFrozen",
+            );
+        }
+        return this.config.properties;
     }
 
     freeze() {
@@ -76,4 +57,5 @@ class __KT_SlidesFreeze {
         return allFrozen;
     }
 }
+
 export const KT_SlidesFreeze = new __KT_SlidesFreeze();

package/src/index.ts

@@ -3,5 +3,14 @@ import { KT_ForproTools } from "./KT_ForproTools";
 import { KT_Slides } from "./slides";
 import { type KT_SlidesOptions } from "./slides";
 import { KT_SlidesFreeze } from "./freeze";
+import { KTSlidesFreezeConfig, DefaultSlidesFreezeMap, OBMap } from "./maps";
 
-export { KT_ForproTools, KT_Slides, type KT_SlidesOptions, KT_SlidesFreeze };
+export {
+    KT_ForproTools,
+    KT_Slides,
+    type KT_SlidesOptions,
+    KT_SlidesFreeze,
+    KTSlidesFreezeConfig,
+    DefaultSlidesFreezeMap,
+    OBMap,
+};

package/src/maps/index.ts

@@ -0,0 +1,53 @@
+import { KT_Project } from "kt-ae-tools-project";
+
+export abstract class KTSlidesFreezeConfig {
+    abstract properties: Property[];
+}
+
+export class DefaultSlidesFreezeMap extends KTSlidesFreezeConfig {
+    properties: Property[] = [];
+    courseTitle = KT_Project.find.comps("titulo-curso")[0];
+    professorPastilla = KT_Project.find.comps("profesor-pastilla")[0];
+    logo_in = KT_Project.find.comps("Logotipo")[0];
+    logosCartela = KT_Project.find.comps("Logotipos-cartela")[0];
+    logo_out = KT_Project.find.comps("logo_out")[0];
+    chyrons = KT_Project.find.comps("chyrons")[0];
+    lessons: CompItem[] = KT_Project.find.comps(/^\d{2}$/);
+
+    constructor() {
+        super();
+        this.properties = [
+            (this.courseTitle.layers.byName("titulo") as TextLayer).text.sourceText,
+            (this.professorPastilla.layers.byName("profesor") as TextLayer).text.sourceText,
+            (this.logosCartela.layers[1] as AVLayer).transform.opacity,
+            (this.logosCartela.layers[2] as AVLayer).transform.opacity,
+            (this.logo_in.layers[1] as AVLayer).transform.opacity,
+            (this.logo_in.layers[2] as AVLayer).transform.opacity,
+            (this.logo_out.layers[1] as AVLayer).transform.opacity,
+            (this.logo_out.layers[2] as AVLayer).transform.opacity,
+            (this.chyrons.layers.byName("profesor") as TextLayer).text.sourceText,
+            (this.chyrons.layers.byName("titulo") as TextLayer).text.sourceText,
+            (this.logo_out.layers.byName("logo-cat") as AVLayer).transform.opacity,
+            (this.logo_out.layers.byName("logo-esp") as AVLayer).transform.opacity,
+        ];
+
+        this.lessons.forEach((comp) => {
+            this.properties.push((comp.layers.byName("leccion") as TextLayer).text.sourceText);
+        });
+    }
+}
+
+export class OBMap extends KTSlidesFreezeConfig {
+    properties: Property[] = [];
+    lesons: CompItem[] = KT_Project.find.comps(/^\d{2}$/);
+    chyrons: CompItem = KT_Project.find.comps("chyrons_base")[0];
+    constructor() {
+        super();
+        this.properties = [(this.chyrons.layers.byName("profesor") as TextLayer).text.sourceText];
+        this.lesons.forEach((comp) => {
+            this.properties.push((comp.layers.byName("profesor") as TextLayer).text.sourceText);
+            this.properties.push((comp.layers.byName("lesson-title") as TextLayer).text.sourceText);
+            this.properties.push((comp.layers.byName("course-title") as TextLayer).text.sourceText);
+        });
+    }
+}

package/src/tests/freezer.test.ts

@@ -0,0 +1,14 @@
+import { expect, describe, it } from "kt-testing-suite-core";
+import { KT_SlidesFreeze } from "../index";
+import { OBMap } from "../index";
+
+describe("KTSlidesFreeze Tests", () => {
+    it("should initialize and freeze slides", () => {
+        const map = new OBMap();
+        KT_SlidesFreeze.init(map);
+        KT_SlidesFreeze.freeze();
+        expect(KT_SlidesFreeze.checkFrozen()).toBe(true);
+        KT_SlidesFreeze.unfreeze();
+        expect(KT_SlidesFreeze.checkFrozen()).toBe(false);
+    });
+});

package/src/tests/index.test.ts

@@ -9,18 +9,14 @@ import {
     afterEach,
 } from "kt-testing-suite-core";
 import { KT_Slides, KT_ForproTools, KT_SlidesFreeze } from "../index";
-
+import "./freezer.test";
 describe("KtForproTools Tests", () => {
     it("should import the slides module", () => {
         const duration = 30;
         const slideMultiplier = 16;
         const width = 3840;
         const height = 2160;
-        KT_SlidesFreeze.init();
-        KT_SlidesFreeze.freeze();
-        expect(KT_SlidesFreeze.checkFrozen()).toBe(true);
-        KT_SlidesFreeze.unfreeze();
-        expect(KT_SlidesFreeze.checkFrozen()).toBe(false);
+
         // KT_ForproTools.Cleanup();
         // KT_ForproTools.utils.cleanNamePrecomp();
         // KT_ForproTools.utils.sendCleanupToMediaEncoder(["esp", "cat"]);