@localazy/strapi-plugin 0.2.13 → 1.0.0-beta.0

package/server/controllers/strapi-controller.js

@@ -1,27 +0,0 @@
-"use strict";
-
-module.exports = {
-  async getModels(ctx) {
-    ctx.body = await strapi
-      .plugin("localazy")
-      .service("strapiService")
-      .getModels();
-  },
-  async getLocalizableModels(ctx) {
-    ctx.body = await strapi
-      .plugin("localazy")
-      .service("strapiService")
-      .getLocalizableModels();
-  },
-  async postLifecycleLocalazyWebhooks(ctx) {
-    strapi.log("done");
-  },
-  async getPluginVersion(ctx) {
-    ctx.body = {
-      version: await strapi
-        .plugin("localazy")
-        .service("strapiService")
-        .getPluginVersion()
-    }
-  }
-};

package/server/db/model/content-transfer-setup.js

@@ -1,13 +0,0 @@
-"use strict";
-
-const KEY = "content-transfer-setup";
-
-const emptyContentTransferSetup = {
-  has_setup: false,
-  setup: [],
-};
-
-module.exports = {
-  KEY,
-  emptyContentTransferSetup,
-};

package/server/db/model/localazy-user.js

@@ -1,23 +0,0 @@
-"use strict";
-
-const KEY = "identity";
-
-const emptyIdentity = {
-  accessToken: "",
-  project: {
-    id: "",
-    image: "",
-    name: "",
-    url: "",
-  },
-  scope: "",
-  user: {
-    id: "",
-    name: "",
-  },
-};
-
-module.exports = {
-  KEY,
-  emptyIdentity,
-};

package/server/db/model/plugin-settings.js

@@ -1,13 +0,0 @@
-"use strict";
-
-const KEY = "plugin-settings";
-
-
-const emptyPluginSettings = {
-  defaultRoute: null,
-};
-
-module.exports = {
-  KEY,
-  emptyPluginSettings,
-};

package/server/db/model/utils/get-strapi-store.js

@@ -1,9 +0,0 @@
-"use strict";
-
-const pluginId = "localazy";
-module.exports = (strapi) =>
-  strapi.store({
-    environment: process.env.STRAPI_ADMIN_LOCALAZY_ENV,
-    type: "plugin",
-    name: pluginId,
-  });

package/server/destroy.js

@@ -1,5 +0,0 @@
-"use strict";
-
-module.exports = () => {
-  // destroy phase
-};

package/server/functions/should-set-downloaded-property.js

@@ -1,94 +0,0 @@
-const get = require("lodash/get");
-
-const getDynamicZoneKeySegment = (parsedKey) => {
-  return parsedKey.find((segment) => segment.includes(";"));
-};
-
-const isDynamicZone = (parsedKey) => {
-  return !!getDynamicZoneKeySegment(parsedKey);
-};
-
-const getComponentNameFromDynamicZoneKeySegment = (dynamicZoneKeySegment) => {
-  return dynamicZoneKeySegment.split(";")[1];
-};
-
-const getDynamicZoneKeySegmentIndex = (parsedKey) => {
-  return parsedKey.findIndex((segment) => segment.includes(";"));
-}
-
-const getDynamicZonePropertyName = (parsedKey) => {
-  const dynamicZoneKeySegmentIndex = getDynamicZoneKeySegmentIndex(parsedKey);
-
-  if (dynamicZoneKeySegmentIndex === -1) {
-    return undefined;
-  }
-
-  return parsedKey[dynamicZoneKeySegmentIndex - 1];
-};
-
-/**
- *
- * @param {*} modelContentTransferSetup
- * @param {*} parsedKeyRest
- * @returns "yes" | "no" | "json"
- */
-const shouldSetDownloadedProperty = (
-  modelContentTransferSetup,
-  parsedKeyRest,
-) => {
-  if (!modelContentTransferSetup.__model__) {
-    return false;
-  }
-
-  const dynamicZoneKeySegment = getDynamicZoneKeySegment(parsedKeyRest);
-  if (!!dynamicZoneKeySegment) {
-    const dynamicZonePropertyName = getDynamicZonePropertyName(parsedKeyRest);
-    const componentName = getComponentNameFromDynamicZoneKeySegment(dynamicZoneKeySegment);
-
-    const dzContentTransferSetupModel = get(modelContentTransferSetup, dynamicZonePropertyName);
-    const dzContentTransferSetupComponentModel = dzContentTransferSetupModel.find((c) => c.__component__ === componentName);
-
-    if (!dzContentTransferSetupComponentModel) {
-      return false;
-    }
-
-    const dynamicZoneKeySegmentIndex = getDynamicZoneKeySegmentIndex(parsedKeyRest);
-    const slicedParsedKeyRest = parsedKeyRest.slice(dynamicZoneKeySegmentIndex + 1);
-    const filteredSlicedParsedKeyRest = slicedParsedKeyRest.filter((segment) => isNaN(parseInt(segment)));
-
-    if(get(dzContentTransferSetupComponentModel, filteredSlicedParsedKeyRest) === true) {
-      return "yes";
-    }
-
-    // json fields
-    while(filteredSlicedParsedKeyRest.length > 0) {
-      // last segment out
-      filteredSlicedParsedKeyRest.pop();
-      if(get(dzContentTransferSetupComponentModel, filteredSlicedParsedKeyRest) === true) {
-        return "json";
-      }
-    }
-
-    return "no";
-  } else {
-    const filteredParsedKeyRest = parsedKeyRest
-      .filter((partialKey) => isNaN(parseInt(partialKey)));
-
-    if(get(modelContentTransferSetup, filteredParsedKeyRest) === true) {
-      return "yes";
-    }
-
-    // json fields
-    while(filteredParsedKeyRest.length > 0) {
-      // last segment out
-      filteredParsedKeyRest.pop();
-      if(get(modelContentTransferSetup, filteredParsedKeyRest) === true) {
-        return "json";
-      }
-    }
-
-    return "no";
-  }
-};
-
-module.exports = shouldSetDownloadedProperty;

package/server/index.js

@@ -1,25 +0,0 @@
-"use strict";
-
-const register = require("./register");
-const bootstrap = require("./bootstrap");
-const destroy = require("./destroy");
-const config = require("./config");
-const contentTypes = require("./content-types");
-const controllers = require("./controllers");
-const routes = require("./routes");
-const middlewares = require("./middlewares");
-const policies = require("./policies");
-const services = require("./services");
-
-module.exports = {
-  register,
-  bootstrap,
-  destroy,
-  config,
-  controllers,
-  routes,
-  services,
-  contentTypes,
-  policies,
-  middlewares,
-};

package/server/lifecycles/deep-populate-hook.js

@@ -1,12 +0,0 @@
-const { getFullPopulateObject, DEFAULT_POPULATE_DEPTH } = require('../utils/get-full-populate-object');
-
-module.exports = (event) => {
-  const populate = event.params?.populate;
-
-  if (populate && populate[0] === 'deep') {
-    const populateDefaultDepth = strapi.plugin("localazy")?.config('populateDefaultDepth') ?? DEFAULT_POPULATE_DEPTH;
-    const depth = populate[1] ?? populateDefaultDepth;
-    const modelObject = getFullPopulateObject(event.model.uid, depth);
-    event.params.populate = modelObject.populate;
-  }
-}

package/server/lifecycles/deprecate-event-entry-in-localazy-hook.js

@@ -1,73 +0,0 @@
-"use strict";
-
-const getPickedFlattenKeysForHookEntry = require('../utils/get-picked-flatten-keys-for-hook-entry');
-const config = require("../config").default;
-const localazyApiClientFactory = require("../utils/localazy-api-client-factory");
-const delay = require("../utils/delay");
-
-module.exports = async (event) => {
-  const pickedFlattedResult = await getPickedFlattenKeysForHookEntry(event);
-
-  if (typeof pickedFlattedResult === "undefined") {
-    return;
-  }
-
-  const { pickedFlatten, eventEntryLocale } = pickedFlattedResult;
-
-  const LocalazyUserService = strapi
-    .plugin("localazy")
-    .service("localazyUserService");
-  const LocalazyPubApiService = strapi
-    .plugin("localazy")
-    .service("localazyPubApiService");
-
-  const user = await LocalazyUserService.getUser();
-
-  /**
-   * Get Strapi File
-   */
-  const strapiFile = await LocalazyPubApiService.getStrapiFile(
-    user.project.id
-  );
-  if (!strapiFile) {
-    strapi.log.error(`File ${config.LOCALAZY_DEFAULT_FILE_NAME} not found`);
-    return;
-  }
-
-  const LocalazyApi = await localazyApiClientFactory();
-  const projectKeys = await LocalazyApi.files.listKeys({
-    project: user.project.id,
-    file: strapiFile.id,
-    lang: eventEntryLocale,
-  });
-
-  if(!projectKeys) {
-    strapi.log.error(`Keys not found for file ${strapiFile.id}`);
-    return {
-      success: false,
-    };
-  }
-
-  const pickedFlattenKeys = Object.keys(pickedFlatten);
-  const filteredProjectKeysIds = projectKeys
-    .filter((key) => pickedFlattenKeys.includes(key.key[0]))
-    .map((key) => key.id);
-
-  // call in a loop in a sequence, to avoid hitting PubAPI limits
-  for (const filteredProjectKeysId of filteredProjectKeysIds) {
-    try {
-      await LocalazyApi.keys.update({
-        project: user.project.id,
-        key: filteredProjectKeysId,
-        deprecated: 0,
-      });
-      await delay();
-    } catch (e) {
-      strapi.log.error(e.message);
-    }
-  }
-
-  return {
-    success: true,
-  };
-}

package/server/lifecycles/upload-event-entry-to-localazy-hook.js

@@ -1,36 +0,0 @@
-"use strict";
-
-const getPickedFlattenKeysForHookEntry = require('../utils/get-picked-flatten-keys-for-hook-entry');
-const config = require("../config").default;
-
-module.exports = async (event) => {
-  const pickedFlattedResult = await getPickedFlattenKeysForHookEntry(event);
-
-  if (typeof pickedFlattedResult === "undefined") {
-    return;
-  }
-
-  const { pickedFlatten, eventEntryLocale } = pickedFlattedResult;
-
-  // Localazy Upload Service
-  const LocalazyUploadService = strapi
-    .plugin("localazy")
-    .service("localazyUploadService");
-
-  const importFile = LocalazyUploadService.createImportFileRepresentation(
-    eventEntryLocale,
-    pickedFlatten
-  );
-
-  const uploadConfig = {
-    contentOptions: {
-      type: config.LOCALAZY_DEFAULT_FILE_EXTENSION,
-    },
-    fileOptions: {
-      name: config.LOCALAZY_DEFAULT_FILE_NAME,
-      path: config.LOCALAZY_DEFAULT_FILE_PATH,
-    }
-  };
-  const result = await LocalazyUploadService.upload(importFile, uploadConfig);
-  return result;
-}

package/server/middlewares/index.js

@@ -1,7 +0,0 @@
-"use strict";
-
-const verifyWebhook = require("./verify-webhook");
-
-module.exports = {
-  verifyWebhook
-};

package/server/middlewares/verify-webhook.js

@@ -1,76 +0,0 @@
-"use strict";
-
-const crypto = require("crypto");
-const PluginSettingsServiceHelper = require('../services/helpers/plugin-settings-service-helper');
-
-module.exports = (config, { strapi }) => {
-  return async (ctx, next) => {
-    try {
-      const pluginSettingsServiceHelper = new PluginSettingsServiceHelper(strapi);
-      await pluginSettingsServiceHelper.setup();
-
-      if (!pluginSettingsServiceHelper.shouldAllowWebhookDownloadProcess()) {
-        throw new Error("Localazy Plugin: Webhook download process is disabled; terminating execution");
-      }
-
-      const requestBody = ctx.request.body;
-      strapi.log.info(`Localazy Plugin: Webhook of type '${requestBody.type}' procedure started`);
-
-      const LocalazyPubApiService = strapi
-        .plugin("localazy")
-        .service("localazyPubApiService");
-      const LocalazyUserService = strapi
-        .plugin("localazy")
-        .service("localazyUserService");
-      const user = await LocalazyUserService.getUser();
-
-      const secret = await LocalazyPubApiService.getWebhooksSecret(user.project.id);
-
-      const xLocalazyHmac = ctx.request.header["x-localazy-hmac"];
-      const xLocalazyTimestamp = ctx.request.header["x-localazy-timestamp"];
-
-      // if older than 15 mins - do not process
-      const THRESHOLD = 900000; // 15 mins = 900000ms
-
-      const intXLocalazyTimestamp = parseInt(xLocalazyTimestamp);
-      if (Number.isNaN(intXLocalazyTimestamp)) {
-        throw new Error("Localazy Plugin: Webhook request invalid timestamp provided; terminating execution");
-      }
-
-      if ((intXLocalazyTimestamp * 1000 + THRESHOLD) < Date.now()) {
-        throw new Error("Localazy Plugin: Webhook request is older than threshold; terminating execution");
-      }
-
-      const strapiHmac = crypto.createHmac("sha256", secret);
-      const signedMessage = strapiHmac.update(`${xLocalazyTimestamp}-${JSON.stringify(requestBody)}`).digest("hex");
-
-      if (xLocalazyHmac !== signedMessage) {
-        throw new Error("Localazy Plugin: Webhook verification did not pass; terminating execution");
-      }
-
-      /**
-       * When further actions are called by a webhook, then there's no user assigned to the operation
-       * It's needed to assign the user ID to the operation (requested e.g. for adding a new locale)
-       */
-      if (!ctx.state.user) {
-        const webhookAuthorId = pluginSettingsServiceHelper.getWebhookAuthorId();
-        if (Number.isNaN(webhookAuthorId)) {
-          throw new Error("Localazy Plugin: Webhook author is not set; terminating execution");
-        }
-        ctx.state.user = {
-          id: webhookAuthorId,
-        };
-      }
-
-      await next(); // proceed with the request; await for the response
-
-      strapi.log.info(`Localazy Plugin: Webhook of type '${requestBody.type}' procedure finished`);
-    } catch (e) {
-      strapi.log.warn(e.message);
-      ctx.body = {
-        success: false,
-        message: e.message,
-      };
-    }
-  }
-}

package/server/models/supported-content-type-fields.js

@@ -1,9 +0,0 @@
-const SUPPORTED_CONTENT_TYPE_FIELDS = [
-  "string",
-  "text",
-  "richtext",
-  "email",
-  "json",
-];
-
-module.exports = SUPPORTED_CONTENT_TYPE_FIELDS;

package/server/models/supported-custom-field-plugins.js

@@ -1,6 +0,0 @@
-const SUPPORTED_CUSTOM_FIELD_PLUGINS = [
-  "plugin::ckeditor.CKEditor",
-  "plugin::ckeditor5.CKEditor",
-];
-
-module.exports = SUPPORTED_CUSTOM_FIELD_PLUGINS;

package/server/policies/index.js

@@ -1,3 +0,0 @@
-"use strict";
-
-module.exports = {};

package/server/register.js

@@ -1,5 +0,0 @@
-"use strict";
-
-module.exports = () => {
-  // registeration phase
-};

package/server/routes/index.js

@@ -1,28 +0,0 @@
-"use strict";
-
-const localazyUserRoutes = require("./localazy-user");
-const localazyAuthRoutes = require("./localazy-auth");
-const pluginSettingsRoutes = require("./plugin-settings");
-const strapiRoutes = require("./strapi");
-const localazyTransferRoutes = require("./localazy-transfer");
-const localazyProjectRoutes = require("./localazy-project");
-const localazyPublicTransferRoutes = require("./localazy-public-transfer");
-
-module.exports = {
-  "content-api": {
-    type: "content-api",
-    routes: [...strapiRoutes],
-  },
-  admin: {
-    type: "admin",
-    routes: [
-      ...localazyAuthRoutes,
-      ...localazyUserRoutes,
-      ...pluginSettingsRoutes,
-      ...strapiRoutes,
-      ...localazyTransferRoutes,
-      ...localazyProjectRoutes,
-    ],
-  },
-  localazyPublicTransferRoutes,
-};

package/server/routes/localazy-auth.js

@@ -1,22 +0,0 @@
-"use strict";
-
-const ROUTE_PREFIX = "/auth";
-
-module.exports = [
-  {
-    method: "GET",
-    path: `${ROUTE_PREFIX}/generate-keys`,
-    handler: "localazyAuthController.generateKeys",
-    config: {
-      policies: [],
-    },
-  },
-  {
-    method: "GET",
-    path: `${ROUTE_PREFIX}/continuous-poll`,
-    handler: "localazyAuthController.continuousPoll",
-    config: {
-      policies: [],
-    },
-  },
-];

package/server/routes/localazy-project.js

@@ -1,14 +0,0 @@
-"use strict";
-
-const ROUTE_PREFIX = "/project";
-
-module.exports = [
-  {
-    method: "GET",
-    path: `${ROUTE_PREFIX}`,
-    handler: "localazyProjectController.getConnectedProject",
-    config: {
-      policies: [],
-    },
-  },
-];

package/server/routes/localazy-public-transfer.js

@@ -1,20 +0,0 @@
-"use strict";
-
-const ROUTE_PREFIX = "/public/transfer";
-
-module.exports = {
-  routes: [
-    {
-      method: "POST",
-      path: `${ROUTE_PREFIX}/download`,
-      handler: "localazyTransferController.download",
-      config: {
-        policies: [],
-        auth: false, // make the route public
-        middlewares: [
-          "plugin::localazy.verifyWebhook"
-        ]
-      },
-    },
-  ]
-};

package/server/routes/localazy-transfer.js

@@ -1,22 +0,0 @@
-"use strict";
-
-const ROUTE_PREFIX = "/transfer";
-
-module.exports = [
-  {
-    method: "POST",
-    path: `${ROUTE_PREFIX}/upload`,
-    handler: "localazyTransferController.upload",
-    config: {
-      policies: [],
-    },
-  },
-  {
-    method: "POST",
-    path: `${ROUTE_PREFIX}/download`,
-    handler: "localazyTransferController.download",
-    config: {
-      policies: [],
-    },
-  },
-];

package/server/routes/localazy-user.js

@@ -1,30 +0,0 @@
-"use strict";
-
-const ROUTE_PREFIX = "/user";
-
-module.exports = [
-  {
-    method: "GET",
-    path: `${ROUTE_PREFIX}`,
-    handler: "localazyUserController.getUser",
-    config: {
-      policies: [],
-    },
-  },
-  {
-    method: "PUT",
-    path: `${ROUTE_PREFIX}`,
-    handler: "localazyUserController.updateUser",
-    config: {
-      policies: [],
-    },
-  },
-  {
-    method: "DELETE",
-    path: `${ROUTE_PREFIX}`,
-    handler: "localazyUserController.deleteUser",
-    config: {
-      policies: [],
-    },
-  },
-];

package/server/routes/plugin-settings.js

@@ -1,38 +0,0 @@
-"use strict";
-
-const ROUTE_PREFIX = "/plugin-settings";
-
-module.exports = [
-  {
-    method: "GET",
-    path: `${ROUTE_PREFIX}/content-transfer-setup`,
-    handler: "pluginSettingsController.getContentTransferSetup",
-    config: {
-      policies: [],
-    },
-  },
-  {
-    method: "PUT",
-    path: `${ROUTE_PREFIX}/content-transfer-setup`,
-    handler: "pluginSettingsController.updateContentTransferSetup",
-    config: {
-      policies: [],
-    },
-  },
-  {
-    method: "GET",
-    path: `${ROUTE_PREFIX}/plugin-settings`,
-    handler: "pluginSettingsController.getPluginSettings",
-    config: {
-      policies: [],
-    },
-  },
-  {
-    method: "PUT",
-    path: `${ROUTE_PREFIX}/plugin-settings`,
-    handler: "pluginSettingsController.updatePluginSettings",
-    config: {
-      policies: [],
-    },
-  }
-];

package/server/routes/strapi.js

@@ -1,38 +0,0 @@
-"use strict";
-
-const ROUTE_PREFIX = "/strapi";
-
-module.exports = [
-  {
-    method: "GET",
-    path: `${ROUTE_PREFIX}/models`,
-    handler: "strapiController.getModels",
-    config: {
-      policies: [],
-    },
-  },
-  {
-    method: "GET",
-    path: `${ROUTE_PREFIX}/localizable-models`,
-    handler: "strapiController.getLocalizableModels",
-    config: {
-      policies: [],
-    },
-  },
-  {
-    method: "POST",
-    path: `${ROUTE_PREFIX}/lifecycle/localazy-webhooks`,
-    handler: "strapiController.postLifecycleLocalazyWebhooks",
-    config: {
-      policies: [],
-    },
-  },
-  {
-    method: "GET",
-    path: `${ROUTE_PREFIX}/version`,
-    handler: "strapiController.getPluginVersion",
-    config: {
-      policies: [],
-    },
-  },
-];