@strapi/core 0.0.0-experimental.020096d91bef5bab5a6c32b4216da5aeb9383d33

package/dist/utils/transform-content-types-to-models.js

@@ -0,0 +1,237 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const database = require("@strapi/database");
+const cuid2 = require("@paralleldrive/cuid2");
+const assert = require("node:assert");
+const _ = require("lodash/fp");
+const _interopDefault = (e) => e && e.__esModule ? e : { default: e };
+const assert__default = /* @__PURE__ */ _interopDefault(assert);
+const ___default = /* @__PURE__ */ _interopDefault(_);
+const { identifiers } = database.utils;
+const COMPONENT_JOIN_TABLE_SUFFIX = "components";
+const DZ_JOIN_TABLE_SUFFIX = "components";
+const COMPONENT_INVERSE_COLUMN_NAME = "component";
+const COMPONENT_TYPE_COLUMN = "component_type";
+const ENTITY = "entity";
+const getComponentJoinTableName = (collectionName) => identifiers.getTableName(collectionName, { suffix: COMPONENT_JOIN_TABLE_SUFFIX });
+const getDzJoinTableName = (collectionName) => identifiers.getTableName(collectionName, { suffix: DZ_JOIN_TABLE_SUFFIX });
+const { ID_COLUMN: id, FIELD_COLUMN: field, ORDER_COLUMN: order } = identifiers;
+const transformAttribute = (name, attribute, contentType) => {
+  switch (attribute.type) {
+    case "media": {
+      return {
+        type: "relation",
+        relation: attribute.multiple === true ? "morphMany" : "morphOne",
+        target: "plugin::upload.file",
+        morphBy: "related"
+      };
+    }
+    case "component": {
+      const joinTableName = getComponentJoinTableName(contentType.collectionName);
+      const joinColumnEntityName = identifiers.getJoinColumnAttributeIdName(ENTITY);
+      const joinColumnInverseName = identifiers.getJoinColumnAttributeIdName(
+        COMPONENT_INVERSE_COLUMN_NAME
+      );
+      return {
+        type: "relation",
+        relation: attribute.repeatable === true ? "oneToMany" : "oneToOne",
+        target: attribute.component,
+        // We need the join table name to be deterministic,
+        // We need to allow passing the join table name as an option
+        joinTable: {
+          name: joinTableName,
+          joinColumn: {
+            name: joinColumnEntityName,
+            referencedColumn: id
+          },
+          inverseJoinColumn: {
+            name: joinColumnInverseName,
+            referencedColumn: id
+          },
+          on: {
+            field: name
+          },
+          orderColumnName: order,
+          orderBy: {
+            order: "asc"
+          },
+          pivotColumns: [joinColumnEntityName, joinColumnInverseName, field, COMPONENT_TYPE_COLUMN]
+        }
+      };
+    }
+    case "dynamiczone": {
+      const joinTableName = getDzJoinTableName(contentType.collectionName);
+      const joinColumnEntityName = identifiers.getJoinColumnAttributeIdName(ENTITY);
+      const joinColumnInverseName = identifiers.getJoinColumnAttributeIdName(
+        COMPONENT_INVERSE_COLUMN_NAME
+      );
+      return {
+        type: "relation",
+        relation: "morphToMany",
+        // TODO: handle restrictions at some point
+        // target: attribute.components,
+        joinTable: {
+          name: joinTableName,
+          joinColumn: {
+            name: joinColumnEntityName,
+            referencedColumn: id
+          },
+          morphColumn: {
+            idColumn: {
+              name: joinColumnInverseName,
+              referencedColumn: id
+            },
+            typeColumn: {
+              name: COMPONENT_TYPE_COLUMN
+            },
+            typeField: "__component"
+          },
+          on: {
+            field: name
+          },
+          orderBy: {
+            order: "asc"
+          },
+          pivotColumns: [joinColumnEntityName, joinColumnInverseName, field, COMPONENT_TYPE_COLUMN]
+        }
+      };
+    }
+    default: {
+      return attribute;
+    }
+  }
+};
+const transformAttributes = (contentType) => {
+  return Object.keys(contentType.attributes || {}).reduce((attrs, attrName) => {
+    return {
+      ...attrs,
+      [attrName]: transformAttribute(attrName, contentType.attributes[attrName], contentType)
+    };
+  }, {});
+};
+const hasComponentsOrDz = (contentType) => {
+  return Object.values(contentType.attributes || {}).some(
+    ({ type }) => type === "dynamiczone" || type === "component"
+  );
+};
+const createDocumentId = cuid2.createId;
+const createCompoLinkModel = (contentType) => {
+  const name = getComponentJoinTableName(contentType.collectionName);
+  const entityId = identifiers.getJoinColumnAttributeIdName(ENTITY);
+  const componentId = identifiers.getJoinColumnAttributeIdName(COMPONENT_INVERSE_COLUMN_NAME);
+  const fkIndex = identifiers.getFkIndexName([contentType.collectionName, ENTITY]);
+  return {
+    // TODO: make sure there can't be any conflicts with a prefix
+    singularName: name,
+    uid: name,
+    tableName: name,
+    attributes: {
+      [id]: {
+        type: "increments"
+      },
+      [entityId]: {
+        type: "integer",
+        column: {
+          unsigned: true
+        }
+      },
+      [componentId]: {
+        type: "integer",
+        column: {
+          unsigned: true
+        }
+      },
+      [COMPONENT_TYPE_COLUMN]: {
+        type: "string"
+      },
+      [field]: {
+        type: "string"
+      },
+      [order]: {
+        type: "float",
+        column: {
+          unsigned: true,
+          defaultTo: null
+        }
+      }
+    },
+    indexes: [
+      {
+        name: identifiers.getIndexName([contentType.collectionName, field]),
+        columns: [field]
+      },
+      {
+        name: identifiers.getIndexName([contentType.collectionName, COMPONENT_TYPE_COLUMN]),
+        columns: [COMPONENT_TYPE_COLUMN]
+      },
+      {
+        name: fkIndex,
+        columns: [entityId]
+      },
+      {
+        // NOTE: since we don't include attribute names, we need to be careful not to create another unique index
+        name: identifiers.getUniqueIndexName([contentType.collectionName]),
+        columns: [entityId, componentId, field, COMPONENT_TYPE_COLUMN],
+        type: "unique"
+      }
+    ],
+    foreignKeys: [
+      {
+        name: fkIndex,
+        columns: [entityId],
+        referencedColumns: [id],
+        referencedTable: identifiers.getTableName(contentType.collectionName),
+        onDelete: "CASCADE"
+      }
+    ]
+  };
+};
+const transformContentTypesToModels = (contentTypes) => {
+  const models = [];
+  contentTypes.forEach((contentType) => {
+    assert__default.default(contentType.collectionName, 'Content type "collectionName" is required');
+    assert__default.default(contentType.modelName, 'Content type "modelName" is required');
+    assert__default.default(contentType.uid, 'Content type "uid" is required');
+    const documentIdAttribute = contentType.modelType === "contentType" ? { documentId: { type: "string", default: createDocumentId } } : {};
+    const reservedAttributeNames = ["document_id", id];
+    Object.keys(contentType.attributes || {}).forEach((attributeName) => {
+      const snakeCasedAttributeName = ___default.default.snakeCase(attributeName);
+      if (reservedAttributeNames.includes(snakeCasedAttributeName)) {
+        throw new Error(
+          `The attribute "${attributeName}" is reserved and cannot be used in a model. Please rename "${contentType.modelName}" attribute "${attributeName}" to something else.`
+        );
+      }
+    });
+    if (hasComponentsOrDz(contentType)) {
+      const compoLinkModel = createCompoLinkModel(contentType);
+      models.push(compoLinkModel);
+    }
+    const model = {
+      uid: contentType.uid,
+      singularName: contentType.modelName,
+      tableName: identifiers.getTableName(contentType.collectionName),
+      attributes: {
+        [id]: {
+          type: "increments"
+        },
+        ...documentIdAttribute,
+        ...transformAttributes(contentType)
+      }
+    };
+    models.push(model);
+  });
+  return models;
+};
+exports.COMPONENT_INVERSE_COLUMN_NAME = COMPONENT_INVERSE_COLUMN_NAME;
+exports.COMPONENT_JOIN_TABLE_SUFFIX = COMPONENT_JOIN_TABLE_SUFFIX;
+exports.COMPONENT_TYPE_COLUMN = COMPONENT_TYPE_COLUMN;
+exports.DZ_JOIN_TABLE_SUFFIX = DZ_JOIN_TABLE_SUFFIX;
+exports.ENTITY = ENTITY;
+exports.createDocumentId = createDocumentId;
+exports.getComponentJoinTableName = getComponentJoinTableName;
+exports.getDzJoinTableName = getDzJoinTableName;
+exports.hasComponentsOrDz = hasComponentsOrDz;
+exports.transformAttribute = transformAttribute;
+exports.transformAttributes = transformAttributes;
+exports.transformContentTypesToModels = transformContentTypesToModels;
+//# sourceMappingURL=transform-content-types-to-models.js.map

package/dist/utils/transform-content-types-to-models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-content-types-to-models.js","sources":["../../src/utils/transform-content-types-to-models.ts"],"sourcesContent":["import { type Model, utils } from '@strapi/database';\nimport { Schema, Attribute } from '@strapi/types';\nimport { createId } from '@paralleldrive/cuid2';\nimport assert from 'node:assert';\nimport _ from 'lodash/fp';\n\nconst { identifiers } = utils;\n\n/**\n * Because strapi/database models don't know about things like components or dynamic zones, we use this file to convert them\n * to a relations format that it recognizes\n *\n * Therefore we have to keep an additional set of helpers/extensions to the database naming methods\n */\n\nexport const COMPONENT_JOIN_TABLE_SUFFIX = 'components';\nexport const DZ_JOIN_TABLE_SUFFIX = 'components';\nexport const COMPONENT_INVERSE_COLUMN_NAME = 'component';\nexport const COMPONENT_TYPE_COLUMN = 'component_type';\nexport const ENTITY = 'entity';\n\nexport const getComponentJoinTableName = (collectionName: string) =>\n  identifiers.getTableName(collectionName, { suffix: COMPONENT_JOIN_TABLE_SUFFIX });\n\nexport const getDzJoinTableName = (collectionName: string) =>\n  identifiers.getTableName(collectionName, { suffix: DZ_JOIN_TABLE_SUFFIX });\n\nconst { ID_COLUMN: id, FIELD_COLUMN: field, ORDER_COLUMN: order } = identifiers;\n\nexport type LoadedContentTypeModel = Schema.ContentType &\n  Required<Pick<Schema.ContentType, 'collectionName' | 'uid' | 'modelName'>>;\n\n// Transforms an attribute (particularly for relation types) into the format that strapi/database accepts\nexport const transformAttribute = (\n  name: string,\n  attribute: Attribute.Any,\n  contentType: LoadedContentTypeModel\n) => {\n  switch (attribute.type) {\n    case 'media': {\n      return {\n        type: 'relation',\n        relation: attribute.multiple === true ? 'morphMany' : 'morphOne',\n        target: 'plugin::upload.file',\n        morphBy: 'related',\n      };\n    }\n    case 'component': {\n      const joinTableName = getComponentJoinTableName(contentType.collectionName);\n      const joinColumnEntityName = identifiers.getJoinColumnAttributeIdName(ENTITY);\n      const joinColumnInverseName = identifiers.getJoinColumnAttributeIdName(\n        COMPONENT_INVERSE_COLUMN_NAME\n      );\n\n      return {\n        type: 'relation',\n        relation: attribute.repeatable === true ? 'oneToMany' : 'oneToOne',\n        target: attribute.component,\n\n        // We need the join table name to be deterministic,\n        // We need to allow passing the join table name as an option\n        joinTable: {\n          name: joinTableName,\n          joinColumn: {\n            name: joinColumnEntityName,\n            referencedColumn: id,\n          },\n          inverseJoinColumn: {\n            name: joinColumnInverseName,\n            referencedColumn: id,\n          },\n          on: {\n            field: name,\n          },\n          orderColumnName: order,\n          orderBy: {\n            order: 'asc',\n          },\n          pivotColumns: [joinColumnEntityName, joinColumnInverseName, field, COMPONENT_TYPE_COLUMN],\n        },\n      };\n    }\n    case 'dynamiczone': {\n      const joinTableName = getDzJoinTableName(contentType.collectionName);\n      const joinColumnEntityName = identifiers.getJoinColumnAttributeIdName(ENTITY);\n      const joinColumnInverseName = identifiers.getJoinColumnAttributeIdName(\n        COMPONENT_INVERSE_COLUMN_NAME\n      );\n\n      return {\n        type: 'relation',\n        relation: 'morphToMany',\n        // TODO: handle restrictions at some point\n        // target: attribute.components,\n        joinTable: {\n          name: joinTableName,\n          joinColumn: {\n            name: joinColumnEntityName,\n            referencedColumn: id,\n          },\n          morphColumn: {\n            idColumn: {\n              name: joinColumnInverseName,\n              referencedColumn: id,\n            },\n            typeColumn: {\n              name: COMPONENT_TYPE_COLUMN,\n            },\n            typeField: '__component',\n          },\n          on: {\n            field: name,\n          },\n          orderBy: {\n            order: 'asc',\n          },\n          pivotColumns: [joinColumnEntityName, joinColumnInverseName, field, COMPONENT_TYPE_COLUMN],\n        },\n      };\n    }\n    default: {\n      return attribute;\n    }\n  }\n};\n\nexport const transformAttributes = (contentType: LoadedContentTypeModel) => {\n  return Object.keys(contentType.attributes! || {}).reduce((attrs, attrName) => {\n    return {\n      ...attrs,\n      [attrName]: transformAttribute(attrName, contentType.attributes[attrName]!, contentType),\n    };\n  }, {});\n};\n\nexport const hasComponentsOrDz = (\n  contentType: LoadedContentTypeModel\n): contentType is LoadedContentTypeModel & { type: 'dynamiczone' | 'component' } => {\n  return Object.values(contentType.attributes || {}).some(\n    ({ type }) => type === 'dynamiczone' || type === 'component'\n  );\n};\n\nexport const createDocumentId = createId;\n\n// Creates the\nconst createCompoLinkModel = (contentType: LoadedContentTypeModel): Model => {\n  const name = getComponentJoinTableName(contentType.collectionName);\n\n  const entityId = identifiers.getJoinColumnAttributeIdName(ENTITY);\n  const componentId = identifiers.getJoinColumnAttributeIdName(COMPONENT_INVERSE_COLUMN_NAME);\n  const fkIndex = identifiers.getFkIndexName([contentType.collectionName, ENTITY]);\n\n  return {\n    // TODO: make sure there can't be any conflicts with a prefix\n    singularName: name,\n    uid: name,\n    tableName: name,\n    attributes: {\n      [id]: {\n        type: 'increments',\n      },\n      [entityId]: {\n        type: 'integer',\n        column: {\n          unsigned: true,\n        },\n      },\n      [componentId]: {\n        type: 'integer',\n        column: {\n          unsigned: true,\n        },\n      },\n      [COMPONENT_TYPE_COLUMN]: {\n        type: 'string',\n      },\n      [field]: {\n        type: 'string',\n      },\n      [order]: {\n        type: 'float',\n        column: {\n          unsigned: true,\n          defaultTo: null,\n        },\n      },\n    },\n    indexes: [\n      {\n        name: identifiers.getIndexName([contentType.collectionName, field]),\n        columns: [field],\n      },\n      {\n        name: identifiers.getIndexName([contentType.collectionName, COMPONENT_TYPE_COLUMN]),\n        columns: [COMPONENT_TYPE_COLUMN],\n      },\n      {\n        name: fkIndex,\n        columns: [entityId],\n      },\n      {\n        // NOTE: since we don't include attribute names, we need to be careful not to create another unique index\n        name: identifiers.getUniqueIndexName([contentType.collectionName]),\n        columns: [entityId, componentId, field, COMPONENT_TYPE_COLUMN],\n        type: 'unique',\n      },\n    ],\n    foreignKeys: [\n      {\n        name: fkIndex,\n        columns: [entityId],\n        referencedColumns: [id],\n        referencedTable: identifiers.getTableName(contentType.collectionName),\n        onDelete: 'CASCADE',\n      },\n    ],\n  };\n};\n\nexport const transformContentTypesToModels = (contentTypes: LoadedContentTypeModel[]): Model[] => {\n  const models: Model[] = [];\n\n  contentTypes.forEach((contentType) => {\n    assert(contentType.collectionName, 'Content type \"collectionName\" is required');\n    assert(contentType.modelName, 'Content type \"modelName\" is required');\n    assert(contentType.uid, 'Content type \"uid\" is required');\n\n    // Add document id to content types\n    // as it is not documented\n    const documentIdAttribute: Record<string, Attribute.Any> =\n      contentType.modelType === 'contentType'\n        ? { documentId: { type: 'string', default: createDocumentId } }\n        : {};\n\n    // TODO: this needs to be combined with getReservedNames, we should not be maintaining two lists\n    // Prevent user from creating a documentId attribute\n    const reservedAttributeNames = ['document_id', id];\n    Object.keys(contentType.attributes || {}).forEach((attributeName) => {\n      const snakeCasedAttributeName = _.snakeCase(attributeName);\n      if (reservedAttributeNames.includes(snakeCasedAttributeName)) {\n        throw new Error(\n          `The attribute \"${attributeName}\" is reserved and cannot be used in a model. Please rename \"${contentType.modelName}\" attribute \"${attributeName}\" to something else.`\n        );\n      }\n    });\n\n    if (hasComponentsOrDz(contentType)) {\n      const compoLinkModel = createCompoLinkModel(contentType);\n      models.push(compoLinkModel);\n    }\n\n    const model: Model = {\n      uid: contentType.uid,\n      singularName: contentType.modelName,\n      tableName: identifiers.getTableName(contentType.collectionName),\n      attributes: {\n        [id]: {\n          type: 'increments',\n        },\n        ...documentIdAttribute,\n        ...transformAttributes(contentType),\n      },\n    };\n\n    models.push(model);\n  });\n\n  return models;\n};\n"],"names":["utils","createId","assert","_"],"mappings":";;;;;;;;;AAMA,MAAM,EAAE,YAAgB,IAAAA;AASjB,MAAM,8BAA8B;AACpC,MAAM,uBAAuB;AAC7B,MAAM,gCAAgC;AACtC,MAAM,wBAAwB;AAC9B,MAAM,SAAS;AAET,MAAA,4BAA4B,CAAC,mBACxC,YAAY,aAAa,gBAAgB,EAAE,QAAQ,6BAA6B;AAErE,MAAA,qBAAqB,CAAC,mBACjC,YAAY,aAAa,gBAAgB,EAAE,QAAQ,sBAAsB;AAE3E,MAAM,EAAE,WAAW,IAAI,cAAc,OAAO,cAAc,MAAU,IAAA;AAM7D,MAAM,qBAAqB,CAChC,MACA,WACA,gBACG;AACH,UAAQ,UAAU,MAAM;AAAA,IACtB,KAAK,SAAS;AACL,aAAA;AAAA,QACL,MAAM;AAAA,QACN,UAAU,UAAU,aAAa,OAAO,cAAc;AAAA,QACtD,QAAQ;AAAA,QACR,SAAS;AAAA,MAAA;AAAA,IAEb;AAAA,IACA,KAAK,aAAa;AACV,YAAA,gBAAgB,0BAA0B,YAAY,cAAc;AACpE,YAAA,uBAAuB,YAAY,6BAA6B,MAAM;AAC5E,YAAM,wBAAwB,YAAY;AAAA,QACxC;AAAA,MAAA;AAGK,aAAA;AAAA,QACL,MAAM;AAAA,QACN,UAAU,UAAU,eAAe,OAAO,cAAc;AAAA,QACxD,QAAQ,UAAU;AAAA;AAAA;AAAA,QAIlB,WAAW;AAAA,UACT,MAAM;AAAA,UACN,YAAY;AAAA,YACV,MAAM;AAAA,YACN,kBAAkB;AAAA,UACpB;AAAA,UACA,mBAAmB;AAAA,YACjB,MAAM;AAAA,YACN,kBAAkB;AAAA,UACpB;AAAA,UACA,IAAI;AAAA,YACF,OAAO;AAAA,UACT;AAAA,UACA,iBAAiB;AAAA,UACjB,SAAS;AAAA,YACP,OAAO;AAAA,UACT;AAAA,UACA,cAAc,CAAC,sBAAsB,uBAAuB,OAAO,qBAAqB;AAAA,QAC1F;AAAA,MAAA;AAAA,IAEJ;AAAA,IACA,KAAK,eAAe;AACZ,YAAA,gBAAgB,mBAAmB,YAAY,cAAc;AAC7D,YAAA,uBAAuB,YAAY,6BAA6B,MAAM;AAC5E,YAAM,wBAAwB,YAAY;AAAA,QACxC;AAAA,MAAA;AAGK,aAAA;AAAA,QACL,MAAM;AAAA,QACN,UAAU;AAAA;AAAA;AAAA,QAGV,WAAW;AAAA,UACT,MAAM;AAAA,UACN,YAAY;AAAA,YACV,MAAM;AAAA,YACN,kBAAkB;AAAA,UACpB;AAAA,UACA,aAAa;AAAA,YACX,UAAU;AAAA,cACR,MAAM;AAAA,cACN,kBAAkB;AAAA,YACpB;AAAA,YACA,YAAY;AAAA,cACV,MAAM;AAAA,YACR;AAAA,YACA,WAAW;AAAA,UACb;AAAA,UACA,IAAI;AAAA,YACF,OAAO;AAAA,UACT;AAAA,UACA,SAAS;AAAA,YACP,OAAO;AAAA,UACT;AAAA,UACA,cAAc,CAAC,sBAAsB,uBAAuB,OAAO,qBAAqB;AAAA,QAC1F;AAAA,MAAA;AAAA,IAEJ;AAAA,IACA,SAAS;AACA,aAAA;AAAA,IACT;AAAA,EACF;AACF;AAEa,MAAA,sBAAsB,CAAC,gBAAwC;AACnE,SAAA,OAAO,KAAK,YAAY,cAAe,CAAE,CAAA,EAAE,OAAO,CAAC,OAAO,aAAa;AACrE,WAAA;AAAA,MACL,GAAG;AAAA,MACH,CAAC,QAAQ,GAAG,mBAAmB,UAAU,YAAY,WAAW,QAAQ,GAAI,WAAW;AAAA,IAAA;AAAA,EAE3F,GAAG,CAAE,CAAA;AACP;AAEa,MAAA,oBAAoB,CAC/B,gBACkF;AAClF,SAAO,OAAO,OAAO,YAAY,cAAc,CAAA,CAAE,EAAE;AAAA,IACjD,CAAC,EAAE,KAAW,MAAA,SAAS,iBAAiB,SAAS;AAAA,EAAA;AAErD;AAEO,MAAM,mBAAmBC,MAAA;AAGhC,MAAM,uBAAuB,CAAC,gBAA+C;AACrE,QAAA,OAAO,0BAA0B,YAAY,cAAc;AAE3D,QAAA,WAAW,YAAY,6BAA6B,MAAM;AAC1D,QAAA,cAAc,YAAY,6BAA6B,6BAA6B;AAC1F,QAAM,UAAU,YAAY,eAAe,CAAC,YAAY,gBAAgB,MAAM,CAAC;AAExE,SAAA;AAAA;AAAA,IAEL,cAAc;AAAA,IACd,KAAK;AAAA,IACL,WAAW;AAAA,IACX,YAAY;AAAA,MACV,CAAC,EAAE,GAAG;AAAA,QACJ,MAAM;AAAA,MACR;AAAA,MACA,CAAC,QAAQ,GAAG;AAAA,QACV,MAAM;AAAA,QACN,QAAQ;AAAA,UACN,UAAU;AAAA,QACZ;AAAA,MACF;AAAA,MACA,CAAC,WAAW,GAAG;AAAA,QACb,MAAM;AAAA,QACN,QAAQ;AAAA,UACN,UAAU;AAAA,QACZ;AAAA,MACF;AAAA,MACA,CAAC,qBAAqB,GAAG;AAAA,QACvB,MAAM;AAAA,MACR;AAAA,MACA,CAAC,KAAK,GAAG;AAAA,QACP,MAAM;AAAA,MACR;AAAA,MACA,CAAC,KAAK,GAAG;AAAA,QACP,MAAM;AAAA,QACN,QAAQ;AAAA,UACN,UAAU;AAAA,UACV,WAAW;AAAA,QACb;AAAA,MACF;AAAA,IACF;AAAA,IACA,SAAS;AAAA,MACP;AAAA,QACE,MAAM,YAAY,aAAa,CAAC,YAAY,gBAAgB,KAAK,CAAC;AAAA,QAClE,SAAS,CAAC,KAAK;AAAA,MACjB;AAAA,MACA;AAAA,QACE,MAAM,YAAY,aAAa,CAAC,YAAY,gBAAgB,qBAAqB,CAAC;AAAA,QAClF,SAAS,CAAC,qBAAqB;AAAA,MACjC;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,SAAS,CAAC,QAAQ;AAAA,MACpB;AAAA,MACA;AAAA;AAAA,QAEE,MAAM,YAAY,mBAAmB,CAAC,YAAY,cAAc,CAAC;AAAA,QACjE,SAAS,CAAC,UAAU,aAAa,OAAO,qBAAqB;AAAA,QAC7D,MAAM;AAAA,MACR;AAAA,IACF;AAAA,IACA,aAAa;AAAA,MACX;AAAA,QACE,MAAM;AAAA,QACN,SAAS,CAAC,QAAQ;AAAA,QAClB,mBAAmB,CAAC,EAAE;AAAA,QACtB,iBAAiB,YAAY,aAAa,YAAY,cAAc;AAAA,QACpE,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EAAA;AAEJ;AAEa,MAAA,gCAAgC,CAAC,iBAAoD;AAChG,QAAM,SAAkB,CAAA;AAEX,eAAA,QAAQ,CAAC,gBAAgB;AAC7BC,oBAAAA,QAAA,YAAY,gBAAgB,2CAA2C;AACvEA,oBAAAA,QAAA,YAAY,WAAW,sCAAsC;AAC7DA,oBAAAA,QAAA,YAAY,KAAK,gCAAgC;AAIxD,UAAM,sBACJ,YAAY,cAAc,gBACtB,EAAE,YAAY,EAAE,MAAM,UAAU,SAAS,iBAAiB,EAAA,IAC1D,CAAA;AAIA,UAAA,yBAAyB,CAAC,eAAe,EAAE;AAC1C,WAAA,KAAK,YAAY,cAAc,CAAA,CAAE,EAAE,QAAQ,CAAC,kBAAkB;AAC7D,YAAA,0BAA0BC,WAAAA,QAAE,UAAU,aAAa;AACrD,UAAA,uBAAuB,SAAS,uBAAuB,GAAG;AAC5D,cAAM,IAAI;AAAA,UACR,kBAAkB,aAAa,+DAA+D,YAAY,SAAS,gBAAgB,aAAa;AAAA,QAAA;AAAA,MAEpJ;AAAA,IAAA,CACD;AAEG,QAAA,kBAAkB,WAAW,GAAG;AAC5B,YAAA,iBAAiB,qBAAqB,WAAW;AACvD,aAAO,KAAK,cAAc;AAAA,IAC5B;AAEA,UAAM,QAAe;AAAA,MACnB,KAAK,YAAY;AAAA,MACjB,cAAc,YAAY;AAAA,MAC1B,WAAW,YAAY,aAAa,YAAY,cAAc;AAAA,MAC9D,YAAY;AAAA,QACV,CAAC,EAAE,GAAG;AAAA,UACJ,MAAM;AAAA,QACR;AAAA,QACA,GAAG;AAAA,QACH,GAAG,oBAAoB,WAAW;AAAA,MACpC;AAAA,IAAA;AAGF,WAAO,KAAK,KAAK;AAAA,EAAA,CAClB;AAEM,SAAA;AACT;;;;;;;;;;;;;"}

package/dist/utils/transform-content-types-to-models.mjs

@@ -0,0 +1,234 @@
+import { utils } from "@strapi/database";
+import { createId } from "@paralleldrive/cuid2";
+import assert from "node:assert";
+import _ from "lodash/fp";
+const { identifiers } = utils;
+const COMPONENT_JOIN_TABLE_SUFFIX = "components";
+const DZ_JOIN_TABLE_SUFFIX = "components";
+const COMPONENT_INVERSE_COLUMN_NAME = "component";
+const COMPONENT_TYPE_COLUMN = "component_type";
+const ENTITY = "entity";
+const getComponentJoinTableName = (collectionName) => identifiers.getTableName(collectionName, { suffix: COMPONENT_JOIN_TABLE_SUFFIX });
+const getDzJoinTableName = (collectionName) => identifiers.getTableName(collectionName, { suffix: DZ_JOIN_TABLE_SUFFIX });
+const { ID_COLUMN: id, FIELD_COLUMN: field, ORDER_COLUMN: order } = identifiers;
+const transformAttribute = (name, attribute, contentType) => {
+  switch (attribute.type) {
+    case "media": {
+      return {
+        type: "relation",
+        relation: attribute.multiple === true ? "morphMany" : "morphOne",
+        target: "plugin::upload.file",
+        morphBy: "related"
+      };
+    }
+    case "component": {
+      const joinTableName = getComponentJoinTableName(contentType.collectionName);
+      const joinColumnEntityName = identifiers.getJoinColumnAttributeIdName(ENTITY);
+      const joinColumnInverseName = identifiers.getJoinColumnAttributeIdName(
+        COMPONENT_INVERSE_COLUMN_NAME
+      );
+      return {
+        type: "relation",
+        relation: attribute.repeatable === true ? "oneToMany" : "oneToOne",
+        target: attribute.component,
+        // We need the join table name to be deterministic,
+        // We need to allow passing the join table name as an option
+        joinTable: {
+          name: joinTableName,
+          joinColumn: {
+            name: joinColumnEntityName,
+            referencedColumn: id
+          },
+          inverseJoinColumn: {
+            name: joinColumnInverseName,
+            referencedColumn: id
+          },
+          on: {
+            field: name
+          },
+          orderColumnName: order,
+          orderBy: {
+            order: "asc"
+          },
+          pivotColumns: [joinColumnEntityName, joinColumnInverseName, field, COMPONENT_TYPE_COLUMN]
+        }
+      };
+    }
+    case "dynamiczone": {
+      const joinTableName = getDzJoinTableName(contentType.collectionName);
+      const joinColumnEntityName = identifiers.getJoinColumnAttributeIdName(ENTITY);
+      const joinColumnInverseName = identifiers.getJoinColumnAttributeIdName(
+        COMPONENT_INVERSE_COLUMN_NAME
+      );
+      return {
+        type: "relation",
+        relation: "morphToMany",
+        // TODO: handle restrictions at some point
+        // target: attribute.components,
+        joinTable: {
+          name: joinTableName,
+          joinColumn: {
+            name: joinColumnEntityName,
+            referencedColumn: id
+          },
+          morphColumn: {
+            idColumn: {
+              name: joinColumnInverseName,
+              referencedColumn: id
+            },
+            typeColumn: {
+              name: COMPONENT_TYPE_COLUMN
+            },
+            typeField: "__component"
+          },
+          on: {
+            field: name
+          },
+          orderBy: {
+            order: "asc"
+          },
+          pivotColumns: [joinColumnEntityName, joinColumnInverseName, field, COMPONENT_TYPE_COLUMN]
+        }
+      };
+    }
+    default: {
+      return attribute;
+    }
+  }
+};
+const transformAttributes = (contentType) => {
+  return Object.keys(contentType.attributes || {}).reduce((attrs, attrName) => {
+    return {
+      ...attrs,
+      [attrName]: transformAttribute(attrName, contentType.attributes[attrName], contentType)
+    };
+  }, {});
+};
+const hasComponentsOrDz = (contentType) => {
+  return Object.values(contentType.attributes || {}).some(
+    ({ type }) => type === "dynamiczone" || type === "component"
+  );
+};
+const createDocumentId = createId;
+const createCompoLinkModel = (contentType) => {
+  const name = getComponentJoinTableName(contentType.collectionName);
+  const entityId = identifiers.getJoinColumnAttributeIdName(ENTITY);
+  const componentId = identifiers.getJoinColumnAttributeIdName(COMPONENT_INVERSE_COLUMN_NAME);
+  const fkIndex = identifiers.getFkIndexName([contentType.collectionName, ENTITY]);
+  return {
+    // TODO: make sure there can't be any conflicts with a prefix
+    singularName: name,
+    uid: name,
+    tableName: name,
+    attributes: {
+      [id]: {
+        type: "increments"
+      },
+      [entityId]: {
+        type: "integer",
+        column: {
+          unsigned: true
+        }
+      },
+      [componentId]: {
+        type: "integer",
+        column: {
+          unsigned: true
+        }
+      },
+      [COMPONENT_TYPE_COLUMN]: {
+        type: "string"
+      },
+      [field]: {
+        type: "string"
+      },
+      [order]: {
+        type: "float",
+        column: {
+          unsigned: true,
+          defaultTo: null
+        }
+      }
+    },
+    indexes: [
+      {
+        name: identifiers.getIndexName([contentType.collectionName, field]),
+        columns: [field]
+      },
+      {
+        name: identifiers.getIndexName([contentType.collectionName, COMPONENT_TYPE_COLUMN]),
+        columns: [COMPONENT_TYPE_COLUMN]
+      },
+      {
+        name: fkIndex,
+        columns: [entityId]
+      },
+      {
+        // NOTE: since we don't include attribute names, we need to be careful not to create another unique index
+        name: identifiers.getUniqueIndexName([contentType.collectionName]),
+        columns: [entityId, componentId, field, COMPONENT_TYPE_COLUMN],
+        type: "unique"
+      }
+    ],
+    foreignKeys: [
+      {
+        name: fkIndex,
+        columns: [entityId],
+        referencedColumns: [id],
+        referencedTable: identifiers.getTableName(contentType.collectionName),
+        onDelete: "CASCADE"
+      }
+    ]
+  };
+};
+const transformContentTypesToModels = (contentTypes) => {
+  const models = [];
+  contentTypes.forEach((contentType) => {
+    assert(contentType.collectionName, 'Content type "collectionName" is required');
+    assert(contentType.modelName, 'Content type "modelName" is required');
+    assert(contentType.uid, 'Content type "uid" is required');
+    const documentIdAttribute = contentType.modelType === "contentType" ? { documentId: { type: "string", default: createDocumentId } } : {};
+    const reservedAttributeNames = ["document_id", id];
+    Object.keys(contentType.attributes || {}).forEach((attributeName) => {
+      const snakeCasedAttributeName = _.snakeCase(attributeName);
+      if (reservedAttributeNames.includes(snakeCasedAttributeName)) {
+        throw new Error(
+          `The attribute "${attributeName}" is reserved and cannot be used in a model. Please rename "${contentType.modelName}" attribute "${attributeName}" to something else.`
+        );
+      }
+    });
+    if (hasComponentsOrDz(contentType)) {
+      const compoLinkModel = createCompoLinkModel(contentType);
+      models.push(compoLinkModel);
+    }
+    const model = {
+      uid: contentType.uid,
+      singularName: contentType.modelName,
+      tableName: identifiers.getTableName(contentType.collectionName),
+      attributes: {
+        [id]: {
+          type: "increments"
+        },
+        ...documentIdAttribute,
+        ...transformAttributes(contentType)
+      }
+    };
+    models.push(model);
+  });
+  return models;
+};
+export {
+  COMPONENT_INVERSE_COLUMN_NAME,
+  COMPONENT_JOIN_TABLE_SUFFIX,
+  COMPONENT_TYPE_COLUMN,
+  DZ_JOIN_TABLE_SUFFIX,
+  ENTITY,
+  createDocumentId,
+  getComponentJoinTableName,
+  getDzJoinTableName,
+  hasComponentsOrDz,
+  transformAttribute,
+  transformAttributes,
+  transformContentTypesToModels
+};
+//# sourceMappingURL=transform-content-types-to-models.mjs.map

package/dist/utils/transform-content-types-to-models.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-content-types-to-models.mjs","sources":["../../src/utils/transform-content-types-to-models.ts"],"sourcesContent":["import { type Model, utils } from '@strapi/database';\nimport { Schema, Attribute } from '@strapi/types';\nimport { createId } from '@paralleldrive/cuid2';\nimport assert from 'node:assert';\nimport _ from 'lodash/fp';\n\nconst { identifiers } = utils;\n\n/**\n * Because strapi/database models don't know about things like components or dynamic zones, we use this file to convert them\n * to a relations format that it recognizes\n *\n * Therefore we have to keep an additional set of helpers/extensions to the database naming methods\n */\n\nexport const COMPONENT_JOIN_TABLE_SUFFIX = 'components';\nexport const DZ_JOIN_TABLE_SUFFIX = 'components';\nexport const COMPONENT_INVERSE_COLUMN_NAME = 'component';\nexport const COMPONENT_TYPE_COLUMN = 'component_type';\nexport const ENTITY = 'entity';\n\nexport const getComponentJoinTableName = (collectionName: string) =>\n  identifiers.getTableName(collectionName, { suffix: COMPONENT_JOIN_TABLE_SUFFIX });\n\nexport const getDzJoinTableName = (collectionName: string) =>\n  identifiers.getTableName(collectionName, { suffix: DZ_JOIN_TABLE_SUFFIX });\n\nconst { ID_COLUMN: id, FIELD_COLUMN: field, ORDER_COLUMN: order } = identifiers;\n\nexport type LoadedContentTypeModel = Schema.ContentType &\n  Required<Pick<Schema.ContentType, 'collectionName' | 'uid' | 'modelName'>>;\n\n// Transforms an attribute (particularly for relation types) into the format that strapi/database accepts\nexport const transformAttribute = (\n  name: string,\n  attribute: Attribute.Any,\n  contentType: LoadedContentTypeModel\n) => {\n  switch (attribute.type) {\n    case 'media': {\n      return {\n        type: 'relation',\n        relation: attribute.multiple === true ? 'morphMany' : 'morphOne',\n        target: 'plugin::upload.file',\n        morphBy: 'related',\n      };\n    }\n    case 'component': {\n      const joinTableName = getComponentJoinTableName(contentType.collectionName);\n      const joinColumnEntityName = identifiers.getJoinColumnAttributeIdName(ENTITY);\n      const joinColumnInverseName = identifiers.getJoinColumnAttributeIdName(\n        COMPONENT_INVERSE_COLUMN_NAME\n      );\n\n      return {\n        type: 'relation',\n        relation: attribute.repeatable === true ? 'oneToMany' : 'oneToOne',\n        target: attribute.component,\n\n        // We need the join table name to be deterministic,\n        // We need to allow passing the join table name as an option\n        joinTable: {\n          name: joinTableName,\n          joinColumn: {\n            name: joinColumnEntityName,\n            referencedColumn: id,\n          },\n          inverseJoinColumn: {\n            name: joinColumnInverseName,\n            referencedColumn: id,\n          },\n          on: {\n            field: name,\n          },\n          orderColumnName: order,\n          orderBy: {\n            order: 'asc',\n          },\n          pivotColumns: [joinColumnEntityName, joinColumnInverseName, field, COMPONENT_TYPE_COLUMN],\n        },\n      };\n    }\n    case 'dynamiczone': {\n      const joinTableName = getDzJoinTableName(contentType.collectionName);\n      const joinColumnEntityName = identifiers.getJoinColumnAttributeIdName(ENTITY);\n      const joinColumnInverseName = identifiers.getJoinColumnAttributeIdName(\n        COMPONENT_INVERSE_COLUMN_NAME\n      );\n\n      return {\n        type: 'relation',\n        relation: 'morphToMany',\n        // TODO: handle restrictions at some point\n        // target: attribute.components,\n        joinTable: {\n          name: joinTableName,\n          joinColumn: {\n            name: joinColumnEntityName,\n            referencedColumn: id,\n          },\n          morphColumn: {\n            idColumn: {\n              name: joinColumnInverseName,\n              referencedColumn: id,\n            },\n            typeColumn: {\n              name: COMPONENT_TYPE_COLUMN,\n            },\n            typeField: '__component',\n          },\n          on: {\n            field: name,\n          },\n          orderBy: {\n            order: 'asc',\n          },\n          pivotColumns: [joinColumnEntityName, joinColumnInverseName, field, COMPONENT_TYPE_COLUMN],\n        },\n      };\n    }\n    default: {\n      return attribute;\n    }\n  }\n};\n\nexport const transformAttributes = (contentType: LoadedContentTypeModel) => {\n  return Object.keys(contentType.attributes! || {}).reduce((attrs, attrName) => {\n    return {\n      ...attrs,\n      [attrName]: transformAttribute(attrName, contentType.attributes[attrName]!, contentType),\n    };\n  }, {});\n};\n\nexport const hasComponentsOrDz = (\n  contentType: LoadedContentTypeModel\n): contentType is LoadedContentTypeModel & { type: 'dynamiczone' | 'component' } => {\n  return Object.values(contentType.attributes || {}).some(\n    ({ type }) => type === 'dynamiczone' || type === 'component'\n  );\n};\n\nexport const createDocumentId = createId;\n\n// Creates the\nconst createCompoLinkModel = (contentType: LoadedContentTypeModel): Model => {\n  const name = getComponentJoinTableName(contentType.collectionName);\n\n  const entityId = identifiers.getJoinColumnAttributeIdName(ENTITY);\n  const componentId = identifiers.getJoinColumnAttributeIdName(COMPONENT_INVERSE_COLUMN_NAME);\n  const fkIndex = identifiers.getFkIndexName([contentType.collectionName, ENTITY]);\n\n  return {\n    // TODO: make sure there can't be any conflicts with a prefix\n    singularName: name,\n    uid: name,\n    tableName: name,\n    attributes: {\n      [id]: {\n        type: 'increments',\n      },\n      [entityId]: {\n        type: 'integer',\n        column: {\n          unsigned: true,\n        },\n      },\n      [componentId]: {\n        type: 'integer',\n        column: {\n          unsigned: true,\n        },\n      },\n      [COMPONENT_TYPE_COLUMN]: {\n        type: 'string',\n      },\n      [field]: {\n        type: 'string',\n      },\n      [order]: {\n        type: 'float',\n        column: {\n          unsigned: true,\n          defaultTo: null,\n        },\n      },\n    },\n    indexes: [\n      {\n        name: identifiers.getIndexName([contentType.collectionName, field]),\n        columns: [field],\n      },\n      {\n        name: identifiers.getIndexName([contentType.collectionName, COMPONENT_TYPE_COLUMN]),\n        columns: [COMPONENT_TYPE_COLUMN],\n      },\n      {\n        name: fkIndex,\n        columns: [entityId],\n      },\n      {\n        // NOTE: since we don't include attribute names, we need to be careful not to create another unique index\n        name: identifiers.getUniqueIndexName([contentType.collectionName]),\n        columns: [entityId, componentId, field, COMPONENT_TYPE_COLUMN],\n        type: 'unique',\n      },\n    ],\n    foreignKeys: [\n      {\n        name: fkIndex,\n        columns: [entityId],\n        referencedColumns: [id],\n        referencedTable: identifiers.getTableName(contentType.collectionName),\n        onDelete: 'CASCADE',\n      },\n    ],\n  };\n};\n\nexport const transformContentTypesToModels = (contentTypes: LoadedContentTypeModel[]): Model[] => {\n  const models: Model[] = [];\n\n  contentTypes.forEach((contentType) => {\n    assert(contentType.collectionName, 'Content type \"collectionName\" is required');\n    assert(contentType.modelName, 'Content type \"modelName\" is required');\n    assert(contentType.uid, 'Content type \"uid\" is required');\n\n    // Add document id to content types\n    // as it is not documented\n    const documentIdAttribute: Record<string, Attribute.Any> =\n      contentType.modelType === 'contentType'\n        ? { documentId: { type: 'string', default: createDocumentId } }\n        : {};\n\n    // TODO: this needs to be combined with getReservedNames, we should not be maintaining two lists\n    // Prevent user from creating a documentId attribute\n    const reservedAttributeNames = ['document_id', id];\n    Object.keys(contentType.attributes || {}).forEach((attributeName) => {\n      const snakeCasedAttributeName = _.snakeCase(attributeName);\n      if (reservedAttributeNames.includes(snakeCasedAttributeName)) {\n        throw new Error(\n          `The attribute \"${attributeName}\" is reserved and cannot be used in a model. Please rename \"${contentType.modelName}\" attribute \"${attributeName}\" to something else.`\n        );\n      }\n    });\n\n    if (hasComponentsOrDz(contentType)) {\n      const compoLinkModel = createCompoLinkModel(contentType);\n      models.push(compoLinkModel);\n    }\n\n    const model: Model = {\n      uid: contentType.uid,\n      singularName: contentType.modelName,\n      tableName: identifiers.getTableName(contentType.collectionName),\n      attributes: {\n        [id]: {\n          type: 'increments',\n        },\n        ...documentIdAttribute,\n        ...transformAttributes(contentType),\n      },\n    };\n\n    models.push(model);\n  });\n\n  return models;\n};\n"],"names":[],"mappings":";;;;AAMA,MAAM,EAAE,YAAgB,IAAA;AASjB,MAAM,8BAA8B;AACpC,MAAM,uBAAuB;AAC7B,MAAM,gCAAgC;AACtC,MAAM,wBAAwB;AAC9B,MAAM,SAAS;AAET,MAAA,4BAA4B,CAAC,mBACxC,YAAY,aAAa,gBAAgB,EAAE,QAAQ,6BAA6B;AAErE,MAAA,qBAAqB,CAAC,mBACjC,YAAY,aAAa,gBAAgB,EAAE,QAAQ,sBAAsB;AAE3E,MAAM,EAAE,WAAW,IAAI,cAAc,OAAO,cAAc,MAAU,IAAA;AAM7D,MAAM,qBAAqB,CAChC,MACA,WACA,gBACG;AACH,UAAQ,UAAU,MAAM;AAAA,IACtB,KAAK,SAAS;AACL,aAAA;AAAA,QACL,MAAM;AAAA,QACN,UAAU,UAAU,aAAa,OAAO,cAAc;AAAA,QACtD,QAAQ;AAAA,QACR,SAAS;AAAA,MAAA;AAAA,IAEb;AAAA,IACA,KAAK,aAAa;AACV,YAAA,gBAAgB,0BAA0B,YAAY,cAAc;AACpE,YAAA,uBAAuB,YAAY,6BAA6B,MAAM;AAC5E,YAAM,wBAAwB,YAAY;AAAA,QACxC;AAAA,MAAA;AAGK,aAAA;AAAA,QACL,MAAM;AAAA,QACN,UAAU,UAAU,eAAe,OAAO,cAAc;AAAA,QACxD,QAAQ,UAAU;AAAA;AAAA;AAAA,QAIlB,WAAW;AAAA,UACT,MAAM;AAAA,UACN,YAAY;AAAA,YACV,MAAM;AAAA,YACN,kBAAkB;AAAA,UACpB;AAAA,UACA,mBAAmB;AAAA,YACjB,MAAM;AAAA,YACN,kBAAkB;AAAA,UACpB;AAAA,UACA,IAAI;AAAA,YACF,OAAO;AAAA,UACT;AAAA,UACA,iBAAiB;AAAA,UACjB,SAAS;AAAA,YACP,OAAO;AAAA,UACT;AAAA,UACA,cAAc,CAAC,sBAAsB,uBAAuB,OAAO,qBAAqB;AAAA,QAC1F;AAAA,MAAA;AAAA,IAEJ;AAAA,IACA,KAAK,eAAe;AACZ,YAAA,gBAAgB,mBAAmB,YAAY,cAAc;AAC7D,YAAA,uBAAuB,YAAY,6BAA6B,MAAM;AAC5E,YAAM,wBAAwB,YAAY;AAAA,QACxC;AAAA,MAAA;AAGK,aAAA;AAAA,QACL,MAAM;AAAA,QACN,UAAU;AAAA;AAAA;AAAA,QAGV,WAAW;AAAA,UACT,MAAM;AAAA,UACN,YAAY;AAAA,YACV,MAAM;AAAA,YACN,kBAAkB;AAAA,UACpB;AAAA,UACA,aAAa;AAAA,YACX,UAAU;AAAA,cACR,MAAM;AAAA,cACN,kBAAkB;AAAA,YACpB;AAAA,YACA,YAAY;AAAA,cACV,MAAM;AAAA,YACR;AAAA,YACA,WAAW;AAAA,UACb;AAAA,UACA,IAAI;AAAA,YACF,OAAO;AAAA,UACT;AAAA,UACA,SAAS;AAAA,YACP,OAAO;AAAA,UACT;AAAA,UACA,cAAc,CAAC,sBAAsB,uBAAuB,OAAO,qBAAqB;AAAA,QAC1F;AAAA,MAAA;AAAA,IAEJ;AAAA,IACA,SAAS;AACA,aAAA;AAAA,IACT;AAAA,EACF;AACF;AAEa,MAAA,sBAAsB,CAAC,gBAAwC;AACnE,SAAA,OAAO,KAAK,YAAY,cAAe,CAAE,CAAA,EAAE,OAAO,CAAC,OAAO,aAAa;AACrE,WAAA;AAAA,MACL,GAAG;AAAA,MACH,CAAC,QAAQ,GAAG,mBAAmB,UAAU,YAAY,WAAW,QAAQ,GAAI,WAAW;AAAA,IAAA;AAAA,EAE3F,GAAG,CAAE,CAAA;AACP;AAEa,MAAA,oBAAoB,CAC/B,gBACkF;AAClF,SAAO,OAAO,OAAO,YAAY,cAAc,CAAA,CAAE,EAAE;AAAA,IACjD,CAAC,EAAE,KAAW,MAAA,SAAS,iBAAiB,SAAS;AAAA,EAAA;AAErD;AAEO,MAAM,mBAAmB;AAGhC,MAAM,uBAAuB,CAAC,gBAA+C;AACrE,QAAA,OAAO,0BAA0B,YAAY,cAAc;AAE3D,QAAA,WAAW,YAAY,6BAA6B,MAAM;AAC1D,QAAA,cAAc,YAAY,6BAA6B,6BAA6B;AAC1F,QAAM,UAAU,YAAY,eAAe,CAAC,YAAY,gBAAgB,MAAM,CAAC;AAExE,SAAA;AAAA;AAAA,IAEL,cAAc;AAAA,IACd,KAAK;AAAA,IACL,WAAW;AAAA,IACX,YAAY;AAAA,MACV,CAAC,EAAE,GAAG;AAAA,QACJ,MAAM;AAAA,MACR;AAAA,MACA,CAAC,QAAQ,GAAG;AAAA,QACV,MAAM;AAAA,QACN,QAAQ;AAAA,UACN,UAAU;AAAA,QACZ;AAAA,MACF;AAAA,MACA,CAAC,WAAW,GAAG;AAAA,QACb,MAAM;AAAA,QACN,QAAQ;AAAA,UACN,UAAU;AAAA,QACZ;AAAA,MACF;AAAA,MACA,CAAC,qBAAqB,GAAG;AAAA,QACvB,MAAM;AAAA,MACR;AAAA,MACA,CAAC,KAAK,GAAG;AAAA,QACP,MAAM;AAAA,MACR;AAAA,MACA,CAAC,KAAK,GAAG;AAAA,QACP,MAAM;AAAA,QACN,QAAQ;AAAA,UACN,UAAU;AAAA,UACV,WAAW;AAAA,QACb;AAAA,MACF;AAAA,IACF;AAAA,IACA,SAAS;AAAA,MACP;AAAA,QACE,MAAM,YAAY,aAAa,CAAC,YAAY,gBAAgB,KAAK,CAAC;AAAA,QAClE,SAAS,CAAC,KAAK;AAAA,MACjB;AAAA,MACA;AAAA,QACE,MAAM,YAAY,aAAa,CAAC,YAAY,gBAAgB,qBAAqB,CAAC;AAAA,QAClF,SAAS,CAAC,qBAAqB;AAAA,MACjC;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,SAAS,CAAC,QAAQ;AAAA,MACpB;AAAA,MACA;AAAA;AAAA,QAEE,MAAM,YAAY,mBAAmB,CAAC,YAAY,cAAc,CAAC;AAAA,QACjE,SAAS,CAAC,UAAU,aAAa,OAAO,qBAAqB;AAAA,QAC7D,MAAM;AAAA,MACR;AAAA,IACF;AAAA,IACA,aAAa;AAAA,MACX;AAAA,QACE,MAAM;AAAA,QACN,SAAS,CAAC,QAAQ;AAAA,QAClB,mBAAmB,CAAC,EAAE;AAAA,QACtB,iBAAiB,YAAY,aAAa,YAAY,cAAc;AAAA,QACpE,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EAAA;AAEJ;AAEa,MAAA,gCAAgC,CAAC,iBAAoD;AAChG,QAAM,SAAkB,CAAA;AAEX,eAAA,QAAQ,CAAC,gBAAgB;AAC7B,WAAA,YAAY,gBAAgB,2CAA2C;AACvE,WAAA,YAAY,WAAW,sCAAsC;AAC7D,WAAA,YAAY,KAAK,gCAAgC;AAIxD,UAAM,sBACJ,YAAY,cAAc,gBACtB,EAAE,YAAY,EAAE,MAAM,UAAU,SAAS,iBAAiB,EAAA,IAC1D,CAAA;AAIA,UAAA,yBAAyB,CAAC,eAAe,EAAE;AAC1C,WAAA,KAAK,YAAY,cAAc,CAAA,CAAE,EAAE,QAAQ,CAAC,kBAAkB;AAC7D,YAAA,0BAA0B,EAAE,UAAU,aAAa;AACrD,UAAA,uBAAuB,SAAS,uBAAuB,GAAG;AAC5D,cAAM,IAAI;AAAA,UACR,kBAAkB,aAAa,+DAA+D,YAAY,SAAS,gBAAgB,aAAa;AAAA,QAAA;AAAA,MAEpJ;AAAA,IAAA,CACD;AAEG,QAAA,kBAAkB,WAAW,GAAG;AAC5B,YAAA,iBAAiB,qBAAqB,WAAW;AACvD,aAAO,KAAK,cAAc;AAAA,IAC5B;AAEA,UAAM,QAAe;AAAA,MACnB,KAAK,YAAY;AAAA,MACjB,cAAc,YAAY;AAAA,MAC1B,WAAW,YAAY,aAAa,YAAY,cAAc;AAAA,MAC9D,YAAY;AAAA,QACV,CAAC,EAAE,GAAG;AAAA,UACJ,MAAM;AAAA,QACR;AAAA,QACA,GAAG;AAAA,QACH,GAAG,oBAAoB,WAAW;AAAA,MACpC;AAAA,IAAA;AAGF,WAAO,KAAK,KAAK;AAAA,EAAA,CAClB;AAEM,SAAA;AACT;"}

package/dist/utils/update-notifier/index.d.ts

@@ -0,0 +1,8 @@
+import type { Strapi } from '@strapi/types';
+export declare const createUpdateNotifier: (strapi: Strapi) => {
+    notify({ checkInterval, notifInterval }?: {
+        checkInterval?: number | undefined;
+        notifInterval?: number | undefined;
+    }): void;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/update-notifier/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/update-notifier/index.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AA0B5C,eAAO,MAAM,oBAAoB,WAAY,MAAM;;;;;CAqElD,CAAC"}

package/dist/utils/update-notifier/index.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const path = require("path");
+const packageJson = require("package-json");
+const Configstore = require("configstore");
+const semver = require("semver");
+const boxen = require("boxen");
+const chalk = require("chalk");
+const strapiUtils = require("@strapi/utils");
+const _interopDefault = (e) => e && e.__esModule ? e : { default: e };
+const path__default = /* @__PURE__ */ _interopDefault(path);
+const packageJson__default = /* @__PURE__ */ _interopDefault(packageJson);
+const Configstore__default = /* @__PURE__ */ _interopDefault(Configstore);
+const semver__default = /* @__PURE__ */ _interopDefault(semver);
+const boxen__default = /* @__PURE__ */ _interopDefault(boxen);
+const chalk__default = /* @__PURE__ */ _interopDefault(chalk);
+const pkg = require("../../../package.json");
+const CHECK_INTERVAL = 1e3 * 60 * 60 * 24 * 1;
+const NOTIF_INTERVAL = 1e3 * 60 * 60 * 24 * 7;
+const boxenOptions = {
+  padding: 1,
+  margin: 1,
+  align: "center",
+  borderColor: "yellow",
+  borderStyle: "round"
+};
+const getUpdateMessage = (newVersion, currentVersion) => {
+  const currentVersionLog = chalk__default.default.dim(currentVersion);
+  const newVersionLog = chalk__default.default.green(newVersion);
+  const releaseLink = chalk__default.default.bold("https://github.com/strapi/strapi/releases");
+  return `
+A new version of Strapi is available ${currentVersionLog} → ${newVersionLog}
+Check out the new releases at: ${releaseLink}
+`.trim();
+};
+const createUpdateNotifier = (strapi) => {
+  let config;
+  try {
+    config = new Configstore__default.default(
+      pkg.name,
+      {},
+      { configPath: path__default.default.join(strapi.dirs.app.root, ".strapi-updater.json") }
+    );
+  } catch {
+  }
+  const checkUpdate = async (checkInterval) => {
+    const now = Date.now();
+    const lastUpdateCheck = config.get("lastUpdateCheck") || 0;
+    if (lastUpdateCheck + checkInterval > now) {
+      return;
+    }
+    try {
+      const res = await packageJson__default.default(pkg.name);
+      if (res.version) {
+        config.set("latest", res.version);
+        config.set("lastUpdateCheck", now);
+      }
+    } catch {
+    }
+  };
+  const display = (notifInterval) => {
+    const now = Date.now();
+    const latestVersion = config.get("latest");
+    const lastNotification = config.get("lastNotification") || 0;
+    if (!process.stdout.isTTY || lastNotification + notifInterval > now || !semver__default.default.valid(latestVersion) || !semver__default.default.valid(pkg.version) || semver__default.default.lte(latestVersion, pkg.version)) {
+      return;
+    }
+    const message = boxen__default.default(getUpdateMessage(latestVersion, pkg.version), boxenOptions);
+    config.set("lastNotification", now);
+    console.log(message);
+  };
+  return {
+    notify({ checkInterval = CHECK_INTERVAL, notifInterval = NOTIF_INTERVAL } = {}) {
+      if (strapiUtils.env.bool("STRAPI_DISABLE_UPDATE_NOTIFICATION", false)) {
+        strapi.log.warn(
+          "STRAPI_DISABLE_UPDATE_NOTIFICATION is no longer supported. Instead, set logger.updates.enabled to false in your server configuration."
+        );
+      }
+      if (!strapi.config.get("server.logger.updates.enabled") || !config) {
+        return;
+      }
+      display(notifInterval);
+      checkUpdate(checkInterval);
+    }
+  };
+};
+exports.createUpdateNotifier = createUpdateNotifier;
+//# sourceMappingURL=index.js.map

package/dist/utils/update-notifier/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../src/utils/update-notifier/index.ts"],"sourcesContent":["import path from 'path';\nimport packageJson from 'package-json';\nimport Configstore from 'configstore';\nimport semver from 'semver';\nimport boxen from 'boxen';\nimport chalk from 'chalk';\nimport { env } from '@strapi/utils';\nimport type { Strapi } from '@strapi/types';\n\n// eslint-disable-next-line @typescript-eslint/no-var-requires\nconst pkg = require('../../../package.json');\n\nconst CHECK_INTERVAL = 1000 * 60 * 60 * 24 * 1; // 1 day\nconst NOTIF_INTERVAL = 1000 * 60 * 60 * 24 * 7; // 1 week\nconst boxenOptions: boxen.Options = {\n  padding: 1,\n  margin: 1,\n  align: 'center',\n  borderColor: 'yellow',\n  borderStyle: 'round',\n};\n\nconst getUpdateMessage = (newVersion: string, currentVersion: string) => {\n  const currentVersionLog = chalk.dim(currentVersion);\n  const newVersionLog = chalk.green(newVersion);\n  const releaseLink = chalk.bold('https://github.com/strapi/strapi/releases');\n\n  return `\nA new version of Strapi is available ${currentVersionLog} → ${newVersionLog}\nCheck out the new releases at: ${releaseLink}\n`.trim();\n};\n\nexport const createUpdateNotifier = (strapi: Strapi) => {\n  let config: InstanceType<typeof Configstore>;\n\n  try {\n    config = new Configstore(\n      pkg.name,\n      {},\n      { configPath: path.join(strapi.dirs.app.root, '.strapi-updater.json') }\n    );\n  } catch {\n    // we don't have write access to the file system\n    // we silence the error\n  }\n\n  const checkUpdate = async (checkInterval: number) => {\n    const now = Date.now();\n    const lastUpdateCheck = config.get('lastUpdateCheck') || 0;\n    if (lastUpdateCheck + checkInterval > now) {\n      return;\n    }\n\n    try {\n      const res = await packageJson(pkg.name);\n      if (res.version) {\n        config.set('latest', res.version);\n        config.set('lastUpdateCheck', now);\n      }\n    } catch {\n      // silence error if offline\n    }\n  };\n\n  const display = (notifInterval: number) => {\n    const now = Date.now();\n    const latestVersion = config.get('latest');\n    const lastNotification = config.get('lastNotification') || 0;\n\n    if (\n      !process.stdout.isTTY ||\n      lastNotification + notifInterval > now ||\n      !semver.valid(latestVersion) ||\n      !semver.valid(pkg.version) ||\n      semver.lte(latestVersion, pkg.version)\n    ) {\n      return;\n    }\n\n    const message = boxen(getUpdateMessage(latestVersion, pkg.version), boxenOptions);\n    config.set('lastNotification', now);\n    console.log(message);\n  };\n\n  return {\n    notify({ checkInterval = CHECK_INTERVAL, notifInterval = NOTIF_INTERVAL } = {}) {\n      // TODO v6: Remove this warning\n      if (env.bool('STRAPI_DISABLE_UPDATE_NOTIFICATION', false)) {\n        strapi.log.warn(\n          'STRAPI_DISABLE_UPDATE_NOTIFICATION is no longer supported. Instead, set logger.updates.enabled to false in your server configuration.'\n        );\n      }\n\n      if (!strapi.config.get('server.logger.updates.enabled') || !config) {\n        return;\n      }\n\n      display(notifInterval);\n      checkUpdate(checkInterval); // doesn't need to await\n    },\n  };\n};\n"],"names":["chalk","Configstore","path","packageJson","semver","boxen","env"],"mappings":";;;;;;;;;;;;;;;;AAUA,MAAM,MAAM,QAAQ,uBAAuB;AAE3C,MAAM,iBAAiB,MAAO,KAAK,KAAK,KAAK;AAC7C,MAAM,iBAAiB,MAAO,KAAK,KAAK,KAAK;AAC7C,MAAM,eAA8B;AAAA,EAClC,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,OAAO;AAAA,EACP,aAAa;AAAA,EACb,aAAa;AACf;AAEA,MAAM,mBAAmB,CAAC,YAAoB,mBAA2B;AACjE,QAAA,oBAAoBA,eAAAA,QAAM,IAAI,cAAc;AAC5C,QAAA,gBAAgBA,eAAAA,QAAM,MAAM,UAAU;AACtC,QAAA,cAAcA,eAAAA,QAAM,KAAK,2CAA2C;AAEnE,SAAA;AAAA,uCAC8B,iBAAiB,MAAM,aAAa;AAAA,iCAC1C,WAAW;AAAA,EAC1C,KAAK;AACP;AAEa,MAAA,uBAAuB,CAAC,WAAmB;AAClD,MAAA;AAEA,MAAA;AACF,aAAS,IAAIC,qBAAA;AAAA,MACX,IAAI;AAAA,MACJ,CAAC;AAAA,MACD,EAAE,YAAYC,cAAK,QAAA,KAAK,OAAO,KAAK,IAAI,MAAM,sBAAsB,EAAE;AAAA,IAAA;AAAA,EACxE,QACM;AAAA,EAGR;AAEM,QAAA,cAAc,OAAO,kBAA0B;AAC7C,UAAA,MAAM,KAAK;AACjB,UAAM,kBAAkB,OAAO,IAAI,iBAAiB,KAAK;AACrD,QAAA,kBAAkB,gBAAgB,KAAK;AACzC;AAAA,IACF;AAEI,QAAA;AACF,YAAM,MAAM,MAAMC,qBAAAA,QAAY,IAAI,IAAI;AACtC,UAAI,IAAI,SAAS;AACR,eAAA,IAAI,UAAU,IAAI,OAAO;AACzB,eAAA,IAAI,mBAAmB,GAAG;AAAA,MACnC;AAAA,IAAA,QACM;AAAA,IAER;AAAA,EAAA;AAGI,QAAA,UAAU,CAAC,kBAA0B;AACnC,UAAA,MAAM,KAAK;AACX,UAAA,gBAAgB,OAAO,IAAI,QAAQ;AACzC,UAAM,mBAAmB,OAAO,IAAI,kBAAkB,KAAK;AAGzD,QAAA,CAAC,QAAQ,OAAO,SAChB,mBAAmB,gBAAgB,OACnC,CAACC,wBAAO,MAAM,aAAa,KAC3B,CAACA,wBAAO,MAAM,IAAI,OAAO,KACzBA,wBAAO,IAAI,eAAe,IAAI,OAAO,GACrC;AACA;AAAA,IACF;AAEA,UAAM,UAAUC,eAAM,QAAA,iBAAiB,eAAe,IAAI,OAAO,GAAG,YAAY;AACzE,WAAA,IAAI,oBAAoB,GAAG;AAClC,YAAQ,IAAI,OAAO;AAAA,EAAA;AAGd,SAAA;AAAA,IACL,OAAO,EAAE,gBAAgB,gBAAgB,gBAAgB,eAAe,IAAI,IAAI;AAE9E,UAAIC,gBAAI,KAAK,sCAAsC,KAAK,GAAG;AACzD,eAAO,IAAI;AAAA,UACT;AAAA,QAAA;AAAA,MAEJ;AAEA,UAAI,CAAC,OAAO,OAAO,IAAI,+BAA+B,KAAK,CAAC,QAAQ;AAClE;AAAA,MACF;AAEA,cAAQ,aAAa;AACrB,kBAAY,aAAa;AAAA,IAC3B;AAAA,EAAA;AAEJ;;"}