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

package/server/utils/build-populate.js

@@ -1,48 +0,0 @@
-"use strict";
-
-const set = require("lodash/set");
-
-const getPopulateObject = (keys) => {
-  const populate = {};
-  for (const key of keys) {
-    set(populate, key, "*");
-  }
-
-  return populate;
-};
-
-const buildPopulate = (models, modelUid) => {
-  const buildPopulateStep = (models, modelUid, prefix = "") => {
-    const model = models.find((model) => model.uid === modelUid);
-
-    if (!model || !model.attributes) {
-      return getPopulateObject(keys);
-    }
-
-    for (const [attributeName, attribute] of Object.entries(model.attributes)) {
-      if (attribute.type === "component") {
-        const key = prefix
-          ? `${prefix}.${attributeName}.populate`
-          : `${attributeName}.populate`;
-        keys.push(key);
-        const newPrefix = prefix
-          ? `${prefix}.${attributeName}`
-          : `${attributeName}`;
-        const innerModelUid = attribute.component;
-        buildPopulateStep(models, innerModelUid, newPrefix);
-      } else if (attribute.type === "dynamiczone") {
-        const key = prefix
-          ? `${prefix}.${attributeName}.populate`
-          : `${attributeName}.populate`;
-        keys.push(key);
-      }
-    }
-
-    return getPopulateObject(keys);
-  };
-  const keys = ["populate"];
-
-  return buildPopulateStep(models, modelUid);
-};
-
-module.exports = buildPopulate;

package/server/utils/delay.js

@@ -1,6 +0,0 @@
-"use strict";
-
-// eslint-disable-next-line no-promise-executor-return
-const delay = (ms = 150) => new Promise((resolve) => setTimeout(resolve, ms));
-
-module.exports = delay;

package/server/utils/flatten-object.js

@@ -1,61 +0,0 @@
-"use strict";
-
-const flattenObject = (object, prefix = "") => {
-  const result = {};
-
-  if (typeof object === "string" || typeof object === "number" || typeof object === "boolean") {
-    return object;
-  }
-
-  for (const objectKey in object) {
-    if (objectKey === "id") {
-      continue;
-    }
-
-    if (typeof object[objectKey] !== "object") {
-      const key = prefix ? `${prefix}.${objectKey}` : objectKey;
-      // Simple leaf (e.g. string or number)
-      result[key] = object[objectKey];
-    } else {
-      // Recursive call down to flattened object
-      let flatObject;
-
-      // If it is an array then turn it into an object with the correct keys
-      if (Array.isArray(object[objectKey])) {
-        // Reduce each item into the right key
-        const flattenedArray = object[objectKey].reduce(
-          (accumulator, item, index) => {
-            // No id should use the index of the array item
-            let key = `${objectKey}[${item?.id || index}]`;
-            // is Dynamic Zone
-            if (item?.id && item?.__component) {
-              key = `${objectKey}[${item.id};${item.__component}]`;
-            }
-
-            accumulator[key] = flattenObject(item);
-            return accumulator;
-          },
-          {}
-        );
-
-        // Then flatten it
-        flatObject = flattenObject(flattenedArray);
-      } else {
-        // Otherwise it is a complex object so you want to flatten that
-        // but with the prefix of this current object key
-        const suffix = object[objectKey]?.id
-          ? `${objectKey}[${object[objectKey].id}]`
-          : objectKey;
-        flatObject = flattenObject(object[objectKey], suffix);
-      }
-
-      for (const flatObjectKey in flatObject) {
-        const key = prefix ? `${prefix}.${flatObjectKey}` : flatObjectKey;
-        result[`${key}`] = flatObject[flatObjectKey];
-      }
-    }
-  }
-  return result;
-};
-
-module.exports = flattenObject;

package/server/utils/generate-random-id.js

@@ -1,3 +0,0 @@
-const generateRandomId = (length = 16) => `_${Math.random().toString(36).substr(2, length)}`;
-
-module.exports = generateRandomId;

package/server/utils/get-full-populate-object.js

@@ -1,66 +0,0 @@
-// is taken from
-// https://github.com/Barelydead/strapi-plugin-populate-deep
-// based on the issue
-// https://github.com/strapi/strapi/issues/11836
-
-const isEmpty = require("lodash/isEmpty");
-const merge = require("lodash/merge");
-const DEFAULT_MAX_POPULATE_DEPTH = 10;
-const DEFAULT_POPULATE_DEPTH = 5;
-
-const getModelPopulationAttributes = (model) => {
-  if (model.uid === "plugin::upload.file") {
-    const { related, ...attributes } = model.attributes;
-    return attributes;
-  }
-
-  return model.attributes;
-};
-
-const getFullPopulateObject = (modelUid, depth = DEFAULT_POPULATE_DEPTH) => {
-  let localDepth = depth;
-  if (localDepth <= 1) {
-    return true;
-  }
-  if (modelUid === "admin::user") {
-    return undefined;
-  }
-  const populateMaxDepth = strapi.plugin("localazy")?.config("populateMaxDepth") ?? DEFAULT_MAX_POPULATE_DEPTH;
-  if (Number.isInteger(populateMaxDepth) && localDepth > populateMaxDepth) {
-    localDepth = populateMaxDepth;
-  }
-
-  const populate = {};
-  const model = strapi.getModel(modelUid);
-  for (const [key, value] of Object.entries(
-    getModelPopulationAttributes(model)
-  )) {
-    if (value) {
-      if (value.type === "component") {
-        populate[key] = getFullPopulateObject(value.component, localDepth - 1);
-      } else if (value.type === "dynamiczone") {
-        const dynamicPopulate = value.components.reduce((prev, cur) => {
-          const curPopulate = getFullPopulateObject(cur, localDepth - 1);
-          return curPopulate === true ? prev : merge(prev, curPopulate);
-        }, {});
-        populate[key] = isEmpty(dynamicPopulate) ? true : dynamicPopulate;
-      } else if (value.type === "relation") {
-        const relationPopulate = getFullPopulateObject(
-          value.target,
-          localDepth - 1
-        );
-        if (relationPopulate) {
-          populate[key] = relationPopulate;
-        }
-      } else if (value.type === "media") {
-        populate[key] = true;
-      }
-    }
-  }
-  return isEmpty(populate) ? true : { populate };
-};
-
-module.exports = {
-  getFullPopulateObject,
-  DEFAULT_POPULATE_DEPTH
-};

package/server/utils/get-main-keys-of-nested-array-objects.js

@@ -1,5 +0,0 @@
-"use strict";
-
-module.exports = (array) => {
-  return array.map((item) => Object.keys(item)[0]);
-};

package/server/utils/get-models-tree.js

@@ -1,47 +0,0 @@
-"use strict";
-
-const SUPPORTED_CONTENT_TYPE_FIELDS = require("../models/supported-content-type-fields");
-const SUPPORTED_CUSTOM_FIELD_PLUGINS = require("../models/supported-custom-field-plugins");
-
-const getModelTree = (attributes, models) => {
-  const currentModelTree = {};
-  for (const attribute in attributes) {
-    if (attributes[attribute].type === "component") {
-      const nestedModel = models.find(
-        (model) => model.uid === attributes[attribute].component
-      );
-
-      currentModelTree[attribute] = {
-        ...getModelTree(nestedModel.__schema__.attributes, models),
-      };
-    } else if (
-      SUPPORTED_CONTENT_TYPE_FIELDS.includes(attributes[attribute].type)
-      || (attributes[attribute].type === "customField" && SUPPORTED_CUSTOM_FIELD_PLUGINS.includes(attributes[attribute].customField))
-    ) {
-      currentModelTree[attribute] = false;
-    } else {
-      currentModelTree[attribute] = null;
-    }
-  }
-
-  return currentModelTree;
-};
-
-/**
- * Kinds of models ["collectionType", "singleType"] are expected by the function.
- */
-const getModelsTree = (models) => {
-  const modelsTree = [];
-  for (const model of models) {
-    const modelTree = {
-      [model.__schema__.collectionName]: {
-        __model__: true,
-        ...getModelTree(model.__schema__.attributes, models),
-      },
-    };
-    modelsTree.push(modelTree);
-  }
-  return modelsTree;
-};
-
-module.exports = getModelsTree;

package/server/utils/get-picked-flatten-keys-for-hook-entry.js

@@ -1,270 +0,0 @@
-"use strict";
-
-const { isoStrapiToLocalazy } = require("./iso-locales-utils");
-const config = require("../config").default;
-const omitDeep = require("./omit-deep");
-const flattenObject = require("./flatten-object");
-const pickEntries = require("./pick-entries");
-const {
-  findSetupModelByCollectionName,
-  getPickPaths
-} = require("./transfer-setup-utils");
-const PluginSettingsServiceHelper = require('../services/helpers/plugin-settings-service-helper');
-
-/**
- *
- * @param {*} contentTransferSetup
- * @param {*} eventModel
- * @returns `undefined` if such model is not model eligible for transfer or `boolean` setup
- */
-const shouldProcessEntry = (contentTransferSetup, eventModel) => {
-  let key;
-  const modelContentTransferSetup = contentTransferSetup.setup
-    .find((model) => {
-      key = Object.keys(model)[0];
-      return key === eventModel;
-    });
-
-  // might be undefined as it's called on any Content-Type
-  if (!modelContentTransferSetup) {
-    return undefined;
-  }
-  return !!modelContentTransferSetup[key].__model__;
-}
-
-const getEventEntries = async (event) => {
-  switch (event.action) {
-    case 'afterCreate':
-    case 'afterUpdate': {
-      const entry = [await strapi.entityService.findOne(
-        event.model.uid,
-        event.result.id,
-        {
-          populate: "deep",
-        })];
-      return entry;
-    }
-    case "beforeDelete": {
-      const entry = [await strapi.entityService.findOne(
-        event.model.uid,
-        event.params.where.id,
-        {
-          populate: "deep",
-        })];
-      return entry;
-    }
-    case "beforeDeleteMany": {
-      /**
-       * Strapi sets the locale to the default one, so passing the ids won't help (won't fetch the entries in the correct locale)
-       * And therefore because of Strapi being Strapi, we need to get one id from the filter and fetch it's language
-       * And then pass the locale parameter to the findMany method
-       */
-      // const entry = await strapi.entityService.findOne(
-      //   event.model.uid,
-      //   event.params.where.$and[0].id.$in[0],
-      //   {
-      //     populate: "deep",
-      //   });
-      // const locale = entry.locale;
-      // const entries = await strapi.entityService.findMany(
-      //   event.model.uid,
-      //   {
-      //     filters: {
-      //       id: event.params.where.$and[0].id.$in,
-      //     },
-      //     locale,
-      //     populate: "deep",
-      //   });
-
-      /**
-       * If deletion of other than default locale is requested, `entries` will be an empty array
-       * If deletion of default locale is requested, `entries` will contain requested entries, and we can proceed with the deprecation process
-       */
-      const entries = await strapi.entityService.findMany(
-        event.model.uid,
-        {
-          filters: event.params.where,
-          populate: "deep",
-        });
-
-      if (entries.length === 0) {
-        strapi.log.info(`Localazy Plugin: No entries in source language for ${event.action} found; the operation won't proceed`);
-      }
-      return entries;
-    }
-    default: {
-      throw new Error("Unhandled event action");
-    }
-  }
-}
-
-const shouldSkipAction = async (event) => {
-  const pluginSettingsServiceHelper = new PluginSettingsServiceHelper(strapi);
-  await pluginSettingsServiceHelper.setup();
-
-  switch (event.action) {
-    case 'afterCreate': {
-      if (!pluginSettingsServiceHelper.shouldAllowAutomatedCreatedTrigger()) {
-        strapi.log.info(`Localazy Plugin: Skipping ${event.action} hook because automated created trigger is disabled.`)
-        return true;
-      }
-      return false;
-    }
-    case 'afterUpdate': {
-      if (!pluginSettingsServiceHelper.shouldAllowAutomatedUpdatedTrigger()) {
-        strapi.log.info(`Localazy Plugin: Skipping ${event.action} hook because automated update trigger is disabled.`)
-        return true;
-      }
-      return false;
-    }
-    case "beforeDelete":
-    case "beforeDeleteMany": {
-      if (!pluginSettingsServiceHelper.shouldAllowDeprecateOnDeletion()) {
-        strapi.log.info(`Localazy Plugin: Skipping ${event.action} hook because deprecate on deletion is disabled.`)
-        return true;
-      }
-      return false;
-    }
-    default: {
-      throw new Error("Unhandled event action");
-    }
-  }
-}
-
-module.exports = async (event) => {
-  // Docs: https://docs.strapi.io/developer-docs/latest/development/backend-customization/models.html#hook-event-object
-  // this should respect the content transfer setup
-  // there read it and compare with the model property
-  const LocalazyUserService = strapi
-    .plugin("localazy")
-    .service("localazyUserService");
-  const LocalazyPubApiService = strapi
-    .plugin("localazy")
-    .service("localazyPubApiService");
-  const StrapiI18nService = strapi
-    .plugin("localazy")
-    .service("strapiI18nService");
-  const contentTransferSetup = await strapi
-    .plugin("localazy")
-    .service("pluginSettingsService")
-    .getContentTransferSetup();
-
-  const eventAction = event.action;
-  strapi.log.info(`${eventAction} triggered`);
-
-  // Content Transfer Setup not available yet; break execution
-  if (!contentTransferSetup.has_setup) {
-    strapi.log.warn("Localazy Plugin: Content Transfer Setup is not set up; the operation won't proceed");
-    return;
-  }
-
-  // entry model not supposed to be processed; break execution
-  const eventModel = event.model.tableName;
-  const shouldProcess = shouldProcessEntry(contentTransferSetup, eventModel);
-  if (typeof shouldProcess === 'undefined') {
-    return;
-  }
-  if (!shouldProcess) {
-    strapi.log.info("Localazy Plugin: The entry collection transfer is disabled");
-    return;
-  }
-
-  // if project not connected; break execution
-  const user = await LocalazyUserService.getUser();
-  const { accessToken } = user;
-  if (!accessToken) {
-    strapi.log.error("Localazy Plugin: Localazy user is not logged in; the operation won't proceed");
-    return;
-  }
-
-  if (await shouldSkipAction(event)) {
-    strapi.log.info("Localazy Plugin: Automated action skipped");
-    return;
-  }
-
-  const project = await LocalazyPubApiService.getProject(
-    user.project.id,
-    false,
-    true
-  );
-  const projectLanguages = project.languages;
-  const projectSourceLanguageId = project.sourceLanguage;
-  const sourceLanguage = projectLanguages.find(
-    (language) => language.id === projectSourceLanguageId
-  );
-  const projectSourceLanguageCode = sourceLanguage.code;
-
-  // Strapi default locale not compatible with project source language
-  const strapiLocales = await StrapiI18nService.getLocales();
-  const defaultLocale = strapiLocales.find((locale) => locale.isDefault);
-
-  const strapiDefaultLocale = defaultLocale
-    ? isoStrapiToLocalazy(defaultLocale.code)
-    : config.LOCALAZY_DEFAULT_LOCALE;
-  if (strapiDefaultLocale !== projectSourceLanguageCode) {
-    strapi.log.warn("Localazy Plugin: Source locales do not match; the operation won't proceed");
-    return;
-  }
-
-  /**
-     * Prepare the data structure and upload it to Localazy
-     */
-  const modelUid = event.model.uid;
-  const entries = await getEventEntries(event);
-
-  if (entries.length === 0) {
-    return;
-  }
-
-  // ? TODO: will always be valid?
-  const eventEntryLocale = entries[0].locale;
-
-  // event entry not in source language; break execution
-  if (isoStrapiToLocalazy(eventEntryLocale) !== projectSourceLanguageCode) {
-    strapi.log.info("Localazy Plugin: Entry language is not in Localazy source language; the operation won't proceed");
-    return;
-  }
-
-  const reducedEntries = omitDeep(entries, [
-    // "__component",
-    "locale",
-    "localizations",
-    "createdAt",
-    "createdBy",
-    "updatedAt",
-    "updatedBy",
-    "publishedAt",
-  ]);
-
-  const transferSetupModel = findSetupModelByCollectionName(
-    contentTransferSetup.setup,
-    eventModel
-  );
-  const currentTransferSetupModel = transferSetupModel[eventModel];
-  const pickPaths = getPickPaths(currentTransferSetupModel);
-  if (!pickPaths.length) {
-    strapi.log.warn(`No fields for collection ${eventModel} transfer are enabled.`);
-    return;
-  }
-  const pickPathsWithUid = pickPaths.map(
-    (pickPath) => `${modelUid}.${pickPath}`
-  );
-
-  // flatten Strapi content
-  let flatten = {};
-  for (const reducedEntry of reducedEntries) {
-    flatten = {
-      ...flatten,
-      ...flattenObject({
-        [modelUid]: reducedEntry,
-      }),
-    };
-  }
-  // get only enabled fields; "__component" will be filtered out inside of the function
-  const pickedFlatten = pickEntries(flatten, pickPathsWithUid, currentTransferSetupModel);
-
-  return {
-    pickedFlatten,
-    eventEntryLocale,
-  };
-}

package/server/utils/intl-display-name.js

@@ -1,4 +0,0 @@
-module.exports = (isoStrapi) => {
-  let languageNames = new Intl.DisplayNames(["en"], { type: "language" });
-  return languageNames.of(isoStrapi);
-};

package/server/utils/is-generally-applicable-content-type.js

@@ -1,33 +0,0 @@
-"use strict";
-
-const SUPPORTED_MODEL_TYPES = ["contentType", "component"];
-const UNSUPPORTED_UID_PREFIXES = [
-  "strapi::core",
-  "plugin::users-permissions.user",
-];
-
-module.exports = (model) => {
-  for (const prefix of UNSUPPORTED_UID_PREFIXES) {
-    if (model.uid.includes(prefix)) {
-      return false;
-    }
-  }
-
-  if (!SUPPORTED_MODEL_TYPES.includes(model.modelType)) {
-    return false;
-  }
-
-  // is not applicable
-  // eslint-disable-next-line no-underscore-dangle
-  if (!model.__schema__) {
-    return false;
-  }
-
-  if (model.pluginOptions) {
-    if (model.pluginOptions["content-type-builder"]) {
-      return model.pluginOptions["content-type-builder"].visible;
-    }
-  }
-
-  return true;
-};

package/server/utils/is-localazy-applicable-content-type.js

@@ -1,36 +0,0 @@
-"use strict";
-
-const isGenerallyApplicableContentType = require("./is-generally-applicable-content-type");
-
-module.exports = (model) => {
-  const isGenerallyApplicable = isGenerallyApplicableContentType(model);
-  if (!isGenerallyApplicable) {
-    return false;
-  }
-
-  // cannot be translatable
-  if (!model.pluginOptions) {
-    return false;
-  }
-
-  // cannot be translatable
-  if (!model.pluginOptions) {
-    return false;
-  }
-
-  if (model.pluginOptions) {
-    // cannot be translatable
-    if (!model.pluginOptions["i18n"]) {
-      return false;
-    }
-
-    // decide whether it is translatable
-    if (model.pluginOptions["i18n"]) {
-      return model.pluginOptions["i18n"].localized
-        ? model.pluginOptions["i18n"].localized
-        : false;
-    }
-  }
-
-  return true;
-};

package/server/utils/iso-locales-utils.js

@@ -1,60 +0,0 @@
-"use strict";
-
-const isoStrapiToLocalazy = (isoStrapi) => {
-  if (!isoStrapi) {
-    return null;
-  }
-
-  const split = isoStrapi.split("-");
-  const language = split[0];
-
-  const hasRegionAndScript = split.length === 3;
-  if (hasRegionAndScript) {
-    const script = split[1];
-    const region = split[2];
-    return `${language}_${region}#${script}`;
-  }
-
-  const hasPossiblyRegion = split.length === 2;
-  if (hasPossiblyRegion) {
-    const regionOrScript = split[1];
-
-    // is it script - the way Strapi resolves that
-    const isItRegion = regionOrScript.toUpperCase() === regionOrScript;
-
-    // it is region; otherwise it is script
-    return isItRegion ? `${language}_${regionOrScript}` : `${language}#${regionOrScript}`;
-  }
-
-  return isoStrapi.replace("-", "_");
-};
-
-const isoLocalazyToStrapi = (isoLocalazy) => {
-  if (!isoLocalazy) {
-    return null;
-  }
-
-  const scriptIndex = isoLocalazy.indexOf("#");
-  const hasScript = scriptIndex > -1;
-  if (hasScript) {
-    const script = isoLocalazy.substring(scriptIndex + 1);
-    const isoLocalazyWithoutScript = isoLocalazy.substring(0, scriptIndex);
-    const split = isoLocalazyWithoutScript.split("_");
-    const language = split[0];
-    const region = split[1];
-
-    if (!region) {
-      return `${language}-${script}`;
-    }
-
-    const isoStrapi = `${language}-${script}-${region.toUpperCase()}`;
-    return isoStrapi;
-  }
-
-  return isoLocalazy.replace("_", "-");
-};
-
-module.exports = {
-  isoStrapiToLocalazy,
-  isoLocalazyToStrapi,
-};

package/server/utils/localazy-api-client-factory.js

@@ -1,22 +0,0 @@
-"use strict";
-
-const ApiClient = require("@localazy/api-client").ApiClient;
-const { LOCALAZY_PUBLIC_API_URL } = require("../config").default;
-
-module.exports = async () => {
-  const user = await strapi
-    .plugin("localazy")
-    .service("localazyUserService")
-    .getUser();
-
-  const { accessToken } = user;
-  if (!accessToken) {
-    throw new Error("Localazy user is not logged in.");
-  }
-
-  const api = new ApiClient({
-    authToken: accessToken,
-    apiUrl: LOCALAZY_PUBLIC_API_URL,
-  });
-  return api;
-};

package/server/utils/localazy-generic-connector-client-factory.js

@@ -1,15 +0,0 @@
-"use strict";
-
-const GenericConnectorClient = require("@localazy/generic-connector-client").GenericConnectorClient;
-const config = require("../config");
-
-const ROOT_URL = config.default.LOCALAZY_PLUGIN_CONNECTOR_API_URL;
-const PLUGIN_ID = config.default.LOCALAZY_PLUGIN_ID;
-
-module.exports = async () => {
-  const api = new GenericConnectorClient({
-    pluginId: PLUGIN_ID,
-    genericConnectorUrl: ROOT_URL,
-  });
-  return api;
-};