@crowdin/app-project-module 0.68.1 → 0.70.0

package/out/modules/workflow-step-type/handlers/step-settings-save.js

@@ -0,0 +1,80 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../../../util");
+const storage = __importStar(require("../../../storage"));
+const logger_1 = require("../../../util/logger");
+function handle(workflowStep) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        try {
+            const { organizationId, projectId, stepId, workflowId, settings } = req.body;
+            const context = req.crowdinContext;
+            if (workflowStep.onStepSettingsSave) {
+                yield workflowStep.onStepSettingsSave({
+                    projectId,
+                    organizationId,
+                    stepId,
+                    workflowId,
+                    settings,
+                    context: req.crowdinContext,
+                    client: req.crowdinApiClient,
+                });
+            }
+            else {
+                const workflowStepDataId = `form-data-${context.crowdinId}-${projectId}-${stepId}`;
+                const workflowStepSettings = Object.assign(Object.assign({}, settings), { context,
+                    stepId });
+                const existing = yield storage.getStorage().getMetadata(workflowStepDataId);
+                if (existing) {
+                    yield storage
+                        .getStorage()
+                        .updateMetadata(workflowStepDataId, workflowStepSettings, context.crowdinId);
+                }
+                else {
+                    yield storage
+                        .getStorage()
+                        .saveMetadata(workflowStepDataId, workflowStepSettings, context.crowdinId);
+                }
+            }
+            res.status(204).end();
+        }
+        catch (e) {
+            if (req.logError) {
+                req.logError(e);
+            }
+            res.send({ error: { message: (0, logger_1.getErrorMessage)(e) } });
+        }
+    }));
+}
+exports.default = handle;

package/out/modules/workflow-step-type/index.d.ts

@@ -0,0 +1,6 @@
+import { Config } from '../../types';
+import { Express } from 'express';
+export declare function register({ config, app }: {
+    config: Config;
+    app: Express;
+}): void;

package/out/modules/workflow-step-type/index.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.register = void 0;
+const ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
+const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-module"));
+const util_1 = require("./util");
+const crowdin_client_1 = __importDefault(require("../../middlewares/crowdin-client"));
+const step_settings_save_1 = __importDefault(require("./handlers/step-settings-save"));
+const delete_step_1 = __importDefault(require("./handlers/delete-step"));
+function register({ config, app }) {
+    if (!config.workflowStepType) {
+        return;
+    }
+    const workflowSteps = Array.isArray(config.workflowStepType) ? config.workflowStepType : [config.workflowStepType];
+    for (const workflowStep of workflowSteps) {
+        app.post((0, util_1.getWorkflowStepUrl)('/settings', workflowStep), (0, crowdin_client_1.default)({
+            config,
+            optional: true,
+            checkSubscriptionExpiration: false,
+            moduleKey: workflowStep.key,
+        }), (0, step_settings_save_1.default)(workflowStep));
+        app.delete((0, util_1.getWorkflowStepUrl)('/delete', workflowStep), (0, crowdin_client_1.default)({
+            config,
+            optional: true,
+            checkSubscriptionExpiration: false,
+            moduleKey: workflowStep.key,
+        }), (0, delete_step_1.default)(workflowStep));
+        if (workflowStep.settingsUiModule) {
+            app.use((0, util_1.getWorkflowStepUrl)('/workflow-step', workflowStep), (0, ui_module_1.default)({ config, moduleType: workflowStep.key }), (0, render_ui_module_1.default)(workflowStep.settingsUiModule));
+        }
+    }
+}
+exports.register = register;

package/out/modules/workflow-step-type/types.d.ts

@@ -0,0 +1,57 @@
+import { CrowdinContextInfo, ModuleKey, UiModule } from '../../types';
+import Crowdin from '@crowdin/crowdin-api-client';
+interface Boundaries {
+    input: Input;
+    outputs: Output[];
+}
+interface Input {
+    title: string;
+    ports: Port[];
+}
+interface Output {
+    title: string;
+    port: Port;
+}
+type Port = 'customCodeFalse' | 'customCodeTrue' | 'untranslated' | 'translated' | 'approved' | 'skipped' | 'all';
+export interface WorkflowStepTypeModule extends ModuleKey {
+    /**
+     * module name
+     */
+    name: string;
+    /**
+     * module description
+     */
+    description?: string;
+    /**
+     * settings UI module
+     */
+    settingsUiModule?: UiModule;
+    /**
+     * input and output boundaries for the module
+     */
+    boundaries: Boundaries;
+    /**
+     * function to save workflow step settings
+     */
+    onStepSettingsSave: ({ organizationId, projectId, stepId, workflowId, settings, context, client, }: {
+        organizationId: number;
+        projectId?: number;
+        stepId: number;
+        workflowId: number;
+        settings: any;
+        context: CrowdinContextInfo;
+        client: Crowdin;
+    }) => Promise<void>;
+    /**
+     * function for handling actions after a step has been deleted from the workflow
+     */
+    onDeleteStep: ({ organizationId, projectId, stepId, workflowId, context, client, }: {
+        organizationId: number;
+        projectId?: number;
+        stepId: number;
+        workflowId: number;
+        context: CrowdinContextInfo;
+        client: Crowdin;
+    }) => Promise<void>;
+}
+export {};

package/out/modules/workflow-step-type/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/out/modules/workflow-step-type/util/index.d.ts

@@ -0,0 +1,3 @@
+import { WorkflowStepTypeModule } from '../types';
+export declare function getWorkflowStepKey(workflowStep: WorkflowStepTypeModule): string;
+export declare function getWorkflowStepUrl(url: string, workflowStep: WorkflowStepTypeModule): string;

package/out/modules/workflow-step-type/util/index.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWorkflowStepUrl = exports.getWorkflowStepKey = void 0;
+const lodash_snakecase_1 = __importDefault(require("lodash.snakecase"));
+function getWorkflowStepKey(workflowStep) {
+    return (0, lodash_snakecase_1.default)(workflowStep.name);
+}
+exports.getWorkflowStepKey = getWorkflowStepKey;
+function getWorkflowStepUrl(url, workflowStep) {
+    const key = (0, lodash_snakecase_1.default)(workflowStep.key) || getWorkflowStepKey(workflowStep);
+    return `${url}/${key}`;
+}
+exports.getWorkflowStepUrl = getWorkflowStepUrl;