@chili-publish/studio-sdk 1.12.0 → 1.13.0

package/lib/src/utils/LocalConfigurationDecorator.d.ts

@@ -0,0 +1,23 @@
+import { WellKnownConfigurationKeys } from '../types/ConfigurationTypes';
+import { ConfigurationController } from '../controllers/ConfigurationController';
+import { EditorAPI } from '../types/CommonTypes';
+export declare class LocalConfigurationDecorator extends ConfigurationController {
+    #private;
+    /**
+     * @ignore
+     */
+    constructor(editorAPI: EditorAPI, localConfig: Map<string, string>);
+    /**
+     * This method returns the value for a given configuration key. If a value was not found in the configuration store,
+     * this method returns an error. The key cannot be null.
+     * @returns value for a given configuration key
+     */
+    getValue(key: WellKnownConfigurationKeys | string): Promise<import("../types/CommonTypes").EditorResponse<string>>;
+    /**
+     * This method sets or overrides the value for a given key.
+     * Null values are not allowed for both key and value,
+     * using them will result in an error.
+     * @returns
+     */
+    setValue(key: WellKnownConfigurationKeys | string, value: string): Promise<import("../types/CommonTypes").EditorResponse<null>>;
+}

package/lib/src/utils/LocalConfigurationDecorator.js

@@ -0,0 +1,76 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _LocalConfigurationDecorator_localConfig;
+import { getEditorResponseData } from './EditorResponseData';
+import { ConfigurationController } from '../controllers/ConfigurationController';
+export class LocalConfigurationDecorator extends ConfigurationController {
+    /**
+     * @ignore
+     */
+    constructor(editorAPI, localConfig) {
+        super(editorAPI);
+        /**
+         * @ignore
+         */
+        _LocalConfigurationDecorator_localConfig.set(this, void 0);
+        __classPrivateFieldSet(this, _LocalConfigurationDecorator_localConfig, localConfig, "f");
+    }
+    /**
+     * This method returns the value for a given configuration key. If a value was not found in the configuration store,
+     * this method returns an error. The key cannot be null.
+     * @returns value for a given configuration key
+     */
+    getValue(key) {
+        const _super = Object.create(null, {
+            getValue: { get: () => super.getValue }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            const value = __classPrivateFieldGet(this, _LocalConfigurationDecorator_localConfig, "f").get(key);
+            if (value != null) {
+                return getEditorResponseData({
+                    status: 200,
+                    success: true,
+                    parsedData: value,
+                    data: value,
+                }, false);
+            }
+            return _super.getValue.call(this, key);
+        });
+    }
+    /**
+     * This method sets or overrides the value for a given key.
+     * Null values are not allowed for both key and value,
+     * using them will result in an error.
+     * @returns
+     */
+    setValue(key, value) {
+        const _super = Object.create(null, {
+            setValue: { get: () => super.setValue }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = _super.setValue.call(this, key, value);
+            __classPrivateFieldGet(this, _LocalConfigurationDecorator_localConfig, "f").set(key, value);
+            return res;
+        });
+    }
+}
+_LocalConfigurationDecorator_localConfig = new WeakMap();
+//# sourceMappingURL=LocalConfigurationDecorator.js.map

package/lib/src/utils/LocalConfigurationDecorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalConfigurationDecorator.js","sourceRoot":"","sources":["../../../src/utils/LocalConfigurationDecorator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AAGjF,MAAM,OAAO,2BAA4B,SAAQ,uBAAuB;IAMpE;;OAEG;IACH,YAAY,SAAoB,EAAE,WAAgC;QAC9D,KAAK,CAAC,SAAS,CAAC,CAAC;QATrB;;WAEG;QACH,2DAAkC;QAO9B,uBAAA,IAAI,4CAAgB,WAAW,MAAA,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACG,QAAQ,CAAC,GAAwC;;;;;YACnD,MAAM,KAAK,GAAG,uBAAA,IAAI,gDAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACzC,IAAI,KAAK,IAAI,IAAI,EAAE;gBACf,OAAO,qBAAqB,CACxB;oBACI,MAAM,EAAE,GAAG;oBACX,OAAO,EAAE,IAAI;oBACb,UAAU,EAAE,KAAK;oBACjB,IAAI,EAAE,KAAK;iBACd,EACD,KAAK,CACR,CAAC;aACL;YAED,OAAO,OAAM,QAAQ,YAAC,GAAG,EAAE;QAC/B,CAAC;KAAA;IAED;;;;;OAKG;IACG,QAAQ,CAAC,GAAwC,EAAE,KAAa;;;;;YAClE,MAAM,GAAG,GAAG,OAAM,QAAQ,YAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACvC,uBAAA,IAAI,gDAAa,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAClC,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;CACJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chili-publish/studio-sdk",
-    "version": "1.12.0",
+    "version": "1.13.0",
     "description": "The sdk for the chili editor",
     "repository": {
         "type": "git",

package/lib/src/tests/controllers/ConfigurationConnectorController.test.js

@@ -1,54 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { ConfigurationController } from '../../controllers/ConfigurationController';
-import { defaultStudioOptions } from '../../types/ConfigurationTypes';
-import { getEditorResponseData, castToEditorResponse } from '../../utils/EditorResponseData';
-let mockedConfigurationController;
-const mockEditorApi = {
-    setConfigValue: () => __awaiter(void 0, void 0, void 0, function* () { return getEditorResponseData(castToEditorResponse(null)); }),
-    getConfigValue: () => __awaiter(void 0, void 0, void 0, function* () { return getEditorResponseData(castToEditorResponse(null)); }),
-    getEngineSessionId: () => __awaiter(void 0, void 0, void 0, function* () { return getEditorResponseData(castToEditorResponse(null)); }),
-    updateStudioOptions: () => __awaiter(void 0, void 0, void 0, function* () { return getEditorResponseData(castToEditorResponse(null)); }),
-};
-beforeEach(() => {
-    mockedConfigurationController = new ConfigurationController(mockEditorApi);
-    jest.spyOn(mockEditorApi, 'setConfigValue');
-    jest.spyOn(mockEditorApi, 'getConfigValue');
-    jest.spyOn(mockEditorApi, 'getEngineSessionId');
-    jest.spyOn(mockEditorApi, 'updateStudioOptions');
-});
-afterEach(() => {
-    jest.restoreAllMocks();
-});
-describe('ConfigurationController', () => {
-    const configKey = 'dam';
-    const configValue = 'm123';
-    it('Should call the setValue method', () => __awaiter(void 0, void 0, void 0, function* () {
-        yield mockedConfigurationController.setValue(configKey, configValue);
-        expect(mockEditorApi.setConfigValue).toHaveBeenCalledTimes(1);
-        expect(mockEditorApi.setConfigValue).toHaveBeenCalledWith(configKey, configValue);
-    }));
-    it('Should call the getValue method', () => __awaiter(void 0, void 0, void 0, function* () {
-        yield mockedConfigurationController.getValue(configKey);
-        expect(mockEditorApi.getConfigValue).toHaveBeenCalledTimes(1);
-        expect(mockEditorApi.getConfigValue).toHaveBeenCalledWith(configKey);
-    }));
-    it('Should call the getEngineSessionId method', () => __awaiter(void 0, void 0, void 0, function* () {
-        yield mockedConfigurationController.getEngineSessionId();
-        expect(mockEditorApi.getEngineSessionId).toHaveBeenCalledTimes(1);
-    }));
-    it('Should call the setStudioOptions method', () => __awaiter(void 0, void 0, void 0, function* () {
-        const options = defaultStudioOptions;
-        yield mockedConfigurationController.updateStudioOptions(options);
-        expect(mockEditorApi.updateStudioOptions).toHaveBeenCalledTimes(1);
-        expect(mockEditorApi.updateStudioOptions).toHaveBeenCalledWith(JSON.stringify(options));
-    }));
-});
-//# sourceMappingURL=ConfigurationConnectorController.test.js.map

package/lib/src/tests/controllers/ConfigurationConnectorController.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ConfigurationConnectorController.test.js","sourceRoot":"","sources":["../../../../src/tests/controllers/ConfigurationConnectorController.test.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAC;AAEpF,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAE7F,IAAI,6BAAsD,CAAC;AAE3D,MAAM,aAAa,GAAc;IAC7B,cAAc,EAAE,GAAS,EAAE,kDAAC,OAAA,qBAAqB,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA,GAAA;IAC7E,cAAc,EAAE,GAAS,EAAE,kDAAC,OAAA,qBAAqB,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA,GAAA;IAC7E,kBAAkB,EAAE,GAAS,EAAE,kDAAC,OAAA,qBAAqB,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA,GAAA;IACjF,mBAAmB,EAAE,GAAS,EAAE,kDAAC,OAAA,qBAAqB,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA,GAAA;CACrF,CAAC;AAEF,UAAU,CAAC,GAAG,EAAE;IACZ,6BAA6B,GAAG,IAAI,uBAAuB,CAAC,aAAa,CAAC,CAAC;IAC3E,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAC5C,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAC5C,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,oBAAoB,CAAC,CAAC;IAChD,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,qBAAqB,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC;AAEH,SAAS,CAAC,GAAG,EAAE;IACX,IAAI,CAAC,eAAe,EAAE,CAAC;AAC3B,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACrC,MAAM,SAAS,GAAG,KAAK,CAAC;IACxB,MAAM,WAAW,GAAG,MAAM,CAAC;IAC3B,EAAE,CAAC,iCAAiC,EAAE,GAAS,EAAE;QAC7C,MAAM,6BAA6B,CAAC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QACrE,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACtF,CAAC,CAAA,CAAC,CAAC;IACH,EAAE,CAAC,iCAAiC,EAAE,GAAS,EAAE;QAC7C,MAAM,6BAA6B,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACxD,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;IACzE,CAAC,CAAA,CAAC,CAAC;IACH,EAAE,CAAC,2CAA2C,EAAE,GAAS,EAAE;QACvD,MAAM,6BAA6B,CAAC,kBAAkB,EAAE,CAAC;QACzD,MAAM,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC,CAAA,CAAC,CAAC;IACH,EAAE,CAAC,yCAAyC,EAAE,GAAS,EAAE;QACrD,MAAM,OAAO,GAAG,oBAAoB,CAAC;QACrC,MAAM,6BAA6B,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACjE,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnE,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5F,CAAC,CAAA,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}