@strapi/core 0.0.0-experimental.3f7b2587c5e3d548262671895cf11d8bf8c

package/dist/services/cron.mjs

@@ -0,0 +1,64 @@
+import { Job } from "node-schedule";
+import { isFunction } from "lodash/fp";
+const createCronService = () => {
+  let jobsSpecs = [];
+  let running = false;
+  return {
+    add(tasks = {}) {
+      for (const taskExpression of Object.keys(tasks)) {
+        const taskValue = tasks[taskExpression];
+        let fn;
+        let options;
+        let taskName;
+        if (isFunction(taskValue)) {
+          taskName = null;
+          fn = taskValue.bind(tasks);
+          options = taskExpression;
+        } else if (isFunction(taskValue.task)) {
+          taskName = taskExpression;
+          fn = taskValue.task.bind(taskValue);
+          options = taskValue.options;
+        } else {
+          throw new Error(
+            `Could not schedule a cron job for "${taskExpression}": no function found.`
+          );
+        }
+        const fnWithStrapi = (...args) => fn({ strapi }, ...args);
+        const job = new Job(fnWithStrapi);
+        jobsSpecs.push({ job, options, name: taskName });
+        if (running) {
+          job.schedule(options);
+        }
+      }
+      return this;
+    },
+    remove(name) {
+      if (!name) {
+        throw new Error("You must provide a name to remove a cron job.");
+      }
+      jobsSpecs.filter(({ name: jobSpecName }) => jobSpecName === name).forEach(({ job }) => job.cancel());
+      jobsSpecs = jobsSpecs.filter(({ name: jobSpecName }) => jobSpecName !== name);
+      return this;
+    },
+    start() {
+      jobsSpecs.forEach(({ job, options }) => job.schedule(options));
+      running = true;
+      return this;
+    },
+    stop() {
+      jobsSpecs.forEach(({ job }) => job.cancel());
+      running = false;
+      return this;
+    },
+    destroy() {
+      this.stop();
+      jobsSpecs = [];
+      return this;
+    },
+    jobs: jobsSpecs
+  };
+};
+export {
+  createCronService as default
+};
+//# sourceMappingURL=cron.mjs.map

package/dist/services/cron.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cron.mjs","sources":["../../src/services/cron.ts"],"sourcesContent":["import { Job } from 'node-schedule';\nimport { isFunction } from 'lodash/fp';\nimport type { Strapi } from '@strapi/types';\n\ninterface JobSpec {\n  job: Job;\n  options: string | number | Date;\n  name: string | null;\n}\n\ntype TaskFn = ({ strapi }: { strapi: Strapi }, ...args: unknown[]) => Promise<unknown>;\n\ntype Task =\n  | TaskFn\n  | {\n      task: TaskFn;\n      options: string;\n    };\n\ninterface Tasks {\n  [key: string]: Task;\n}\n\nconst createCronService = () => {\n  let jobsSpecs: JobSpec[] = [];\n  let running = false;\n\n  return {\n    add(tasks: Tasks = {}) {\n      for (const taskExpression of Object.keys(tasks)) {\n        const taskValue = tasks[taskExpression];\n\n        let fn: TaskFn;\n        let options: string | number | Date;\n        let taskName: string | null;\n        if (isFunction(taskValue)) {\n          // don't use task name if key is the rule\n          taskName = null;\n          fn = taskValue.bind(tasks);\n          options = taskExpression;\n        } else if (isFunction(taskValue.task)) {\n          // set task name if key is not the rule\n          taskName = taskExpression;\n          fn = taskValue.task.bind(taskValue);\n          options = taskValue.options;\n        } else {\n          throw new Error(\n            `Could not schedule a cron job for \"${taskExpression}\": no function found.`\n          );\n        }\n\n        const fnWithStrapi = (...args: unknown[]) => fn({ strapi }, ...args);\n\n        // const job = new Job(null, fnWithStrapi);\n        const job = new Job(fnWithStrapi);\n        jobsSpecs.push({ job, options, name: taskName });\n\n        if (running) {\n          job.schedule(options);\n        }\n      }\n      return this;\n    },\n\n    remove(name: string) {\n      if (!name) {\n        throw new Error('You must provide a name to remove a cron job.');\n      }\n\n      jobsSpecs\n        .filter(({ name: jobSpecName }) => jobSpecName === name)\n        .forEach(({ job }) => job.cancel());\n\n      jobsSpecs = jobsSpecs.filter(({ name: jobSpecName }) => jobSpecName !== name);\n      return this;\n    },\n\n    start() {\n      jobsSpecs.forEach(({ job, options }) => job.schedule(options));\n      running = true;\n      return this;\n    },\n\n    stop() {\n      jobsSpecs.forEach(({ job }) => job.cancel());\n      running = false;\n      return this;\n    },\n\n    destroy() {\n      this.stop();\n      jobsSpecs = [];\n      return this;\n    },\n    jobs: jobsSpecs,\n  };\n};\n\nexport default createCronService;\n"],"names":[],"mappings":";;AAuBA,MAAM,oBAAoB,MAAM;AAC9B,MAAI,YAAuB,CAAA;AAC3B,MAAI,UAAU;AAEP,SAAA;AAAA,IACL,IAAI,QAAe,IAAI;AACrB,iBAAW,kBAAkB,OAAO,KAAK,KAAK,GAAG;AACzC,cAAA,YAAY,MAAM,cAAc;AAElC,YAAA;AACA,YAAA;AACA,YAAA;AACA,YAAA,WAAW,SAAS,GAAG;AAEd,qBAAA;AACN,eAAA,UAAU,KAAK,KAAK;AACf,oBAAA;AAAA,QACD,WAAA,WAAW,UAAU,IAAI,GAAG;AAE1B,qBAAA;AACN,eAAA,UAAU,KAAK,KAAK,SAAS;AAClC,oBAAU,UAAU;AAAA,QAAA,OACf;AACL,gBAAM,IAAI;AAAA,YACR,sCAAsC,cAAc;AAAA,UAAA;AAAA,QAExD;AAEM,cAAA,eAAe,IAAI,SAAoB,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI;AAG7D,cAAA,MAAM,IAAI,IAAI,YAAY;AAChC,kBAAU,KAAK,EAAE,KAAK,SAAS,MAAM,UAAU;AAE/C,YAAI,SAAS;AACX,cAAI,SAAS,OAAO;AAAA,QACtB;AAAA,MACF;AACO,aAAA;AAAA,IACT;AAAA,IAEA,OAAO,MAAc;AACnB,UAAI,CAAC,MAAM;AACH,cAAA,IAAI,MAAM,+CAA+C;AAAA,MACjE;AAEA,gBACG,OAAO,CAAC,EAAE,MAAM,YAAA,MAAkB,gBAAgB,IAAI,EACtD,QAAQ,CAAC,EAAE,IAAA,MAAU,IAAI,OAAQ,CAAA;AAExB,kBAAA,UAAU,OAAO,CAAC,EAAE,MAAM,YAAY,MAAM,gBAAgB,IAAI;AACrE,aAAA;AAAA,IACT;AAAA,IAEA,QAAQ;AACI,gBAAA,QAAQ,CAAC,EAAE,KAAK,QAAc,MAAA,IAAI,SAAS,OAAO,CAAC;AACnD,gBAAA;AACH,aAAA;AAAA,IACT;AAAA,IAEA,OAAO;AACL,gBAAU,QAAQ,CAAC,EAAE,IAAU,MAAA,IAAI,QAAQ;AACjC,gBAAA;AACH,aAAA;AAAA,IACT;AAAA,IAEA,UAAU;AACR,WAAK,KAAK;AACV,kBAAY,CAAA;AACL,aAAA;AAAA,IACT;AAAA,IACA,MAAM;AAAA,EAAA;AAEV;"}

package/dist/services/custom-fields.d.ts

@@ -0,0 +1,4 @@
+import type { Strapi, CustomFields } from '@strapi/types';
+declare const createCustomFields: (strapi: Strapi) => CustomFields.CustomFields;
+export default createCustomFields;
+//# sourceMappingURL=custom-fields.d.ts.map

package/dist/services/custom-fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.d.ts","sourceRoot":"","sources":["../../src/services/custom-fields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE1D,QAAA,MAAM,kBAAkB,WAAY,MAAM,KAAG,yBAM5C,CAAC;AAEF,eAAe,kBAAkB,CAAC"}

package/dist/services/custom-fields.js

@@ -0,0 +1,10 @@
+"use strict";
+const createCustomFields = (strapi) => {
+  return {
+    register(customField) {
+      strapi.get("custom-fields").add(customField);
+    }
+  };
+};
+module.exports = createCustomFields;
+//# sourceMappingURL=custom-fields.js.map

package/dist/services/custom-fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.js","sources":["../../src/services/custom-fields.ts"],"sourcesContent":["import type { Strapi, CustomFields } from '@strapi/types';\n\nconst createCustomFields = (strapi: Strapi): CustomFields.CustomFields => {\n  return {\n    register(customField) {\n      strapi.get('custom-fields').add(customField);\n    },\n  };\n};\n\nexport default createCustomFields;\n"],"names":[],"mappings":";AAEM,MAAA,qBAAqB,CAAC,WAA8C;AACjE,SAAA;AAAA,IACL,SAAS,aAAa;AACpB,aAAO,IAAI,eAAe,EAAE,IAAI,WAAW;AAAA,IAC7C;AAAA,EAAA;AAEJ;;"}

package/dist/services/custom-fields.mjs

@@ -0,0 +1,11 @@
+const createCustomFields = (strapi) => {
+  return {
+    register(customField) {
+      strapi.get("custom-fields").add(customField);
+    }
+  };
+};
+export {
+  createCustomFields as default
+};
+//# sourceMappingURL=custom-fields.mjs.map

package/dist/services/custom-fields.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.mjs","sources":["../../src/services/custom-fields.ts"],"sourcesContent":["import type { Strapi, CustomFields } from '@strapi/types';\n\nconst createCustomFields = (strapi: Strapi): CustomFields.CustomFields => {\n  return {\n    register(customField) {\n      strapi.get('custom-fields').add(customField);\n    },\n  };\n};\n\nexport default createCustomFields;\n"],"names":[],"mappings":"AAEM,MAAA,qBAAqB,CAAC,WAA8C;AACjE,SAAA;AAAA,IACL,SAAS,aAAa;AACpB,aAAO,IAAI,eAAe,EAAE,IAAI,WAAW;AAAA,IAC7C;AAAA,EAAA;AAEJ;"}

package/dist/services/document-service/components.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=components.d.ts.map

package/dist/services/document-service/components.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../../src/services/document-service/components.ts"],"names":[],"mappings":""}

package/dist/services/document-service/document-engine.d.ts

@@ -0,0 +1,8 @@
+import type { Database } from '@strapi/database';
+import type { Documents, Strapi } from '@strapi/types';
+declare const _default: (ctx: {
+    strapi: Strapi;
+    db: Database;
+}) => Documents.Engine;
+export default _default;
+//# sourceMappingURL=document-engine.d.ts.map

package/dist/services/document-service/document-engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-engine.d.ts","sourceRoot":"","sources":["../../../src/services/document-service/document-engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAU,SAAS,EAAkB,MAAM,EAAE,MAAM,eAAe,CAAC;8BA2S1D;IAAE,QAAQ,MAAM,CAAC;IAAC,EAAE,EAAE,QAAQ,CAAA;CAAE,KAAG,UAAU,MAAM;AAAxE,wBAKE"}

package/dist/services/document-service/document-engine.js

@@ -0,0 +1,200 @@
+"use strict";
+const strapiUtils = require("@strapi/utils");
+const _ = require("lodash/fp");
+const uploadFiles = require("../utils/upload-files.js");
+const components = require("../entity-service/components.js");
+const transformContentTypesToModels = require("../../utils/transform-content-types-to-models.js");
+const index$1 = require("../entity-service/attributes/index.js");
+const index = require("../entity-validator/index.js");
+const params = require("../entity-service/params.js");
+const { transformParamsToQuery } = strapiUtils.convertQueryParams;
+const createPipeline = (data, context) => {
+  return index$1.applyTransforms(data, context);
+};
+const updatePipeline = (data, context) => {
+  return index$1.applyTransforms(data, context);
+};
+const createDocumentEngine = ({
+  strapi,
+  db
+}) => ({
+  uploadFiles,
+  async findMany(uid, params2) {
+    const { kind } = strapi.getModel(uid);
+    const query = transformParamsToQuery(uid, params2 || {});
+    query.where = { ...params2?.lookup, ...query.where };
+    if (kind === "singleType") {
+      return db.query(uid).findOne(query);
+    }
+    return db.query(uid).findMany(query);
+  },
+  async findFirst(uid, params2) {
+    const query = transformParamsToQuery(uid, params2 || {});
+    return db.query(uid).findOne({ ...query, where: { ...params2?.lookup, ...query.where } });
+  },
+  async findOne(uid, documentId, params2) {
+    const query = transformParamsToQuery(uid, params2 || {});
+    return db.query(uid).findOne({ ...query, where: { ...params2?.lookup, ...query.where, documentId } });
+  },
+  async delete(uid, documentId, params2 = {}) {
+    const query = transformParamsToQuery(uid, params2);
+    if (params2.status === "draft") {
+      throw new Error("Cannot delete a draft document");
+    }
+    const entriesToDelete = await db.query(uid).findMany({
+      ...query,
+      where: {
+        ...params2.lookup,
+        ...query?.where,
+        documentId
+      }
+    });
+    await strapiUtils.mapAsync(entriesToDelete, async (entryToDelete) => {
+      const componentsToDelete = await components.getComponents(uid, entryToDelete);
+      await db.query(uid).delete({ where: { id: entryToDelete.id } });
+      await components.deleteComponents(uid, componentsToDelete, { loadComponents: false });
+    });
+    return { versions: entriesToDelete };
+  },
+  // TODO: should we provide two separate methods?
+  async deleteMany(uid, paramsOrIds) {
+    let queryParams;
+    if (_.isArray(paramsOrIds)) {
+      queryParams = { filter: { documentID: { $in: paramsOrIds } } };
+    } else {
+      queryParams = paramsOrIds;
+    }
+    const query = transformParamsToQuery(uid, queryParams || {});
+    return db.query(uid).deleteMany(query);
+  },
+  async create(uid, params$1) {
+    const { data } = params$1;
+    if (!data) {
+      throw new Error("Create requires data attribute");
+    }
+    const model = strapi.getModel(uid);
+    const validData = await index.validateEntityCreation(model, data, {
+      isDraft: true,
+      locale: params$1?.locale
+    });
+    const componentData = await components.createComponents(uid, validData);
+    const entryData = createPipeline(
+      Object.assign(components.omitComponentData(model, validData), componentData),
+      {
+        contentType: model
+      }
+    );
+    const query = transformParamsToQuery(uid, params.pickSelectionParams(params$1));
+    return db.query(uid).create({ ...query, data: entryData });
+  },
+  // NOTE: What happens if user doesn't provide specific publications state and locale to update?
+  async update(uid, documentId, params$1) {
+    const { data } = params$1 || {};
+    const model = strapi.getModel(uid);
+    const query = transformParamsToQuery(uid, params.pickSelectionParams(params$1 || {}));
+    const entryToUpdate = await db.query(uid).findOne({ ...query, where: { ...params$1?.lookup, ...query?.where, documentId } });
+    if (!entryToUpdate) {
+      return null;
+    }
+    const validData = await index.validateEntityUpdate(
+      model,
+      data,
+      {
+        isDraft: true,
+        // Always update the draft version
+        locale: params$1?.locale
+      },
+      entryToUpdate
+    );
+    const componentData = await components.updateComponents(uid, entryToUpdate, validData);
+    const entryData = updatePipeline(
+      Object.assign(components.omitComponentData(model, validData), componentData),
+      { contentType: model }
+    );
+    return db.query(uid).update({ ...query, where: { id: entryToUpdate.id }, data: entryData });
+  },
+  async count(uid, params2 = void 0) {
+    const query = transformParamsToQuery(uid, params2 || {});
+    query.where = { ...params2?.lookup, ...query.where };
+    return db.query(uid).count(query);
+  },
+  async clone(uid, documentId, params$1) {
+    const { data = {} } = params$1;
+    const model = strapi.getModel(uid);
+    const query = transformParamsToQuery(uid, params.pickSelectionParams(params$1));
+    const entries = await db.query(uid).findMany({
+      ...query,
+      where: { ...params$1?.lookup, ...query.where, documentId }
+    });
+    if (!entries.length) {
+      return null;
+    }
+    const newDocumentId = transformContentTypesToModels.createDocumentId();
+    const versions = await strapiUtils.mapAsync(entries, async (entryToClone) => {
+      const isDraft = strapiUtils.contentTypes.isDraft(data);
+      const validData = await index.validateEntityUpdate(
+        model,
+        // Omit id fields, the cloned entity id will be generated by the database
+        _.omit(["id"], data),
+        { isDraft, ...params$1?.lookup },
+        entryToClone
+      );
+      const componentData = await components.cloneComponents(uid, entryToClone, validData);
+      const entityData = createPipeline(
+        Object.assign(components.omitComponentData(model, validData), componentData),
+        { contentType: model }
+      );
+      return db.query(uid).clone(entryToClone.id, {
+        ...query,
+        // Allows entityData to override the documentId (e.g. when publishing)
+        data: { documentId: newDocumentId, ...entityData, locale: entryToClone.locale }
+      });
+    });
+    return { id: newDocumentId, versions };
+  },
+  // TODO: Handle relations so they target the published version
+  async publish(uid, documentId, params2) {
+    await this.delete(uid, documentId, {
+      ...params2,
+      lookup: { ...params2?.lookup, publishedAt: { $ne: null } }
+    });
+    const clonedDocuments = await this.clone(uid, documentId, {
+      ...params2 || {},
+      // @ts-expect-error - Generic type does not have publishedAt attribute by default
+      data: { documentId, publishedAt: /* @__PURE__ */ new Date() }
+    });
+    return { versions: clonedDocuments?.versions || [] };
+  },
+  async unpublish(uid, documentId, params2) {
+    return this.delete(uid, documentId, {
+      ...params2,
+      lookup: { ...params2?.lookup, publishedAt: { $ne: null } }
+    });
+  },
+  /**
+   * Steps:
+   * - Delete the matching draft versions (publishedAt = null)
+   * - Clone the matching published versions into draft versions
+   */
+  async discardDraft(uid, documentId, params2) {
+    await this.delete(uid, documentId, {
+      ...params2,
+      // Delete all drafts that match query
+      lookup: { ...params2?.lookup, publishedAt: null }
+    });
+    const clonedDocuments = await this.clone(uid, documentId, {
+      ...params2 || {},
+      // Clone only published versions
+      lookup: { ...params2?.lookup, publishedAt: { $ne: null } },
+      // @ts-expect-error - Generic type does not have publishedAt attribute by default
+      data: { documentId, publishedAt: null }
+    });
+    return { versions: clonedDocuments?.versions || [] };
+  }
+});
+const createDocumentRepository = (ctx) => {
+  const implementation = createDocumentEngine(ctx);
+  return implementation;
+};
+module.exports = createDocumentRepository;
+//# sourceMappingURL=document-engine.js.map

package/dist/services/document-service/document-engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-engine.js","sources":["../../../src/services/document-service/document-engine.ts"],"sourcesContent":["import type { Database } from '@strapi/database';\nimport type { Common, Documents, Schema, Shared, Strapi } from '@strapi/types';\nimport { contentTypes as contentTypesUtils, convertQueryParams, mapAsync } from '@strapi/utils';\n\nimport { isArray, omit } from 'lodash/fp';\nimport uploadFiles from '../utils/upload-files';\n\nimport {\n  cloneComponents,\n  createComponents,\n  deleteComponents,\n  getComponents,\n  omitComponentData,\n  updateComponents,\n} from '../entity-service/components';\n\nimport { createDocumentId } from '../../utils/transform-content-types-to-models';\nimport { applyTransforms } from '../entity-service/attributes';\nimport entityValidator from '../entity-validator';\nimport { pickSelectionParams } from './params';\n\nconst { transformParamsToQuery } = convertQueryParams;\n\n/**\n * TODO: Sanitization / validation built-in\n * TODO: i18n - Move logic to i18n package\n * TODO: Webhooks\n * TODO: Audit logs\n * TODO: Entity Validation - Uniqueness across same locale and publication status\n * TODO: File upload\n * TODO: replace 'any'\n * TODO: availableLocales\n *\n */\ntype Context = {\n  contentType: Schema.ContentType;\n};\n\nconst createPipeline = (data: Record<string, unknown>, context: Context) => {\n  return applyTransforms(data, context);\n};\n\nconst updatePipeline = (data: Record<string, unknown>, context: Context) => {\n  return applyTransforms(data, context);\n};\n\nconst createDocumentEngine = ({\n  strapi,\n  db,\n}: {\n  strapi: Strapi;\n  db: Database;\n}): Documents.Engine => ({\n  uploadFiles,\n\n  async findMany(uid, params) {\n    const { kind } = strapi.getModel(uid);\n\n    const query = transformParamsToQuery(uid, params || ({} as any));\n    query.where = { ...params?.lookup, ...query.where };\n\n    if (kind === 'singleType') {\n      return db.query(uid).findOne(query);\n    }\n\n    return db.query(uid).findMany(query);\n  },\n\n  async findFirst(uid, params) {\n    const query = transformParamsToQuery(uid, params || ({} as any));\n\n    return db.query(uid).findOne({ ...query, where: { ...params?.lookup, ...query.where } });\n  },\n\n  async findOne(uid, documentId, params) {\n    const query = transformParamsToQuery(uid, params || ({} as any));\n    return db\n      .query(uid)\n      .findOne({ ...query, where: { ...params?.lookup, ...query.where, documentId } });\n  },\n\n  async delete(uid, documentId, params = {} as any) {\n    const query = transformParamsToQuery(uid, params as any);\n\n    if (params.status === 'draft') {\n      throw new Error('Cannot delete a draft document');\n    }\n\n    const entriesToDelete = await db.query(uid).findMany({\n      ...query,\n      where: {\n        ...params.lookup,\n        ...query?.where,\n        documentId,\n      },\n    });\n\n    // Delete all matched entries and its components\n    await mapAsync(entriesToDelete, async (entryToDelete: any) => {\n      const componentsToDelete = await getComponents(uid, entryToDelete);\n      await db.query(uid).delete({ where: { id: entryToDelete.id } });\n      await deleteComponents(uid, componentsToDelete as any, { loadComponents: false });\n    });\n\n    // TODO: Change return value to actual count\n    return { versions: entriesToDelete };\n  },\n\n  // TODO: should we provide two separate methods?\n  async deleteMany(uid, paramsOrIds) {\n    let queryParams;\n    if (isArray(paramsOrIds)) {\n      queryParams = { filter: { documentID: { $in: paramsOrIds } } };\n    } else {\n      queryParams = paramsOrIds;\n    }\n\n    const query = transformParamsToQuery(uid, queryParams || ({} as any));\n\n    return db.query(uid).deleteMany(query);\n  },\n\n  async create(uid, params) {\n    // TODO: Entity validator.\n    // TODO: File upload - Probably in the lifecycles?\n    const { data } = params;\n\n    if (!data) {\n      throw new Error('Create requires data attribute');\n    }\n\n    const model = strapi.getModel(uid) as Shared.ContentTypes[Common.UID.ContentType];\n\n    const validData = await entityValidator.validateEntityCreation(model, data, {\n      isDraft: true,\n      locale: params?.locale,\n    });\n\n    const componentData = await createComponents(uid, validData);\n    const entryData = createPipeline(\n      Object.assign(omitComponentData(model, validData), componentData),\n      {\n        contentType: model,\n      }\n    );\n\n    // select / populate\n    const query = transformParamsToQuery(uid, pickSelectionParams(params) as any);\n\n    return db.query(uid).create({ ...query, data: entryData });\n  },\n\n  // NOTE: What happens if user doesn't provide specific publications state and locale to update?\n  async update(uid, documentId, params) {\n    // TODO: Prevent updating a published document\n    // TODO: Entity validator.\n    // TODO: File upload\n    const { data } = params || {};\n    const model = strapi.getModel(uid) as Shared.ContentTypes[Common.UID.ContentType];\n\n    const query = transformParamsToQuery(uid, pickSelectionParams(params || {}) as any);\n\n    // Find all locales of the document\n    const entryToUpdate = await db\n      .query(uid)\n      .findOne({ ...query, where: { ...params?.lookup, ...query?.where, documentId } });\n\n    // Document does not exist\n    if (!entryToUpdate) {\n      return null;\n    }\n\n    const validData = await entityValidator.validateEntityUpdate(\n      model,\n      data,\n      {\n        isDraft: true, // Always update the draft version\n        locale: params?.locale,\n      },\n      entryToUpdate\n    );\n\n    const componentData = await updateComponents(uid, entryToUpdate, validData);\n    const entryData = updatePipeline(\n      Object.assign(omitComponentData(model, validData), componentData),\n      { contentType: model }\n    );\n\n    return db.query(uid).update({ ...query, where: { id: entryToUpdate.id }, data: entryData });\n  },\n\n  async count(uid, params = undefined) {\n    const query = transformParamsToQuery(uid, params || ({} as any));\n    query.where = { ...params?.lookup, ...query.where };\n\n    return db.query(uid).count(query);\n  },\n\n  async clone(uid, documentId, params) {\n    // TODO: File upload\n    // TODO: Entity validator.\n    const { data = {} as any } = params!;\n\n    const model = strapi.getModel(uid);\n    const query = transformParamsToQuery(uid, pickSelectionParams(params) as any);\n\n    // Find all locales of the document\n    const entries = await db.query(uid).findMany({\n      ...query,\n      where: { ...params?.lookup, ...query.where, documentId },\n    });\n\n    // Document does not exist\n    if (!entries.length) {\n      return null;\n    }\n\n    const newDocumentId = createDocumentId();\n\n    const versions = await mapAsync(entries, async (entryToClone: any) => {\n      const isDraft = contentTypesUtils.isDraft(data);\n      // Todo: Merge data with entry to clone\n      const validData = await entityValidator.validateEntityUpdate(\n        model,\n        // Omit id fields, the cloned entity id will be generated by the database\n        omit(['id'], data),\n        { isDraft, ...params?.lookup },\n        entryToClone\n      );\n\n      const componentData = await cloneComponents(uid, entryToClone, validData);\n      const entityData = createPipeline(\n        Object.assign(omitComponentData(model, validData), componentData),\n        { contentType: model }\n      );\n\n      // TODO: Transform params to query\n      return db.query(uid).clone(entryToClone.id, {\n        ...query,\n        // Allows entityData to override the documentId (e.g. when publishing)\n        data: { documentId: newDocumentId, ...entityData, locale: entryToClone.locale },\n      });\n    });\n\n    return { id: newDocumentId, versions };\n  },\n\n  // TODO: Handle relations so they target the published version\n  async publish(uid, documentId, params) {\n    // Delete already published versions that match the locales to be published\n    await this.delete(uid, documentId, {\n      ...params,\n      lookup: { ...params?.lookup, publishedAt: { $ne: null } },\n    });\n\n    // Clone every draft version to be published\n    const clonedDocuments = (await this.clone(uid, documentId, {\n      ...(params || {}),\n      // @ts-expect-error - Generic type does not have publishedAt attribute by default\n      data: { documentId, publishedAt: new Date() },\n    })) as any;\n\n    // TODO: Return actual count\n    return { versions: clonedDocuments?.versions || [] };\n  },\n\n  async unpublish(uid, documentId, params) {\n    // Delete all published versions\n    return this.delete(uid, documentId, {\n      ...params,\n      lookup: { ...params?.lookup, publishedAt: { $ne: null } },\n    }) as any;\n  },\n\n  /**\n   * Steps:\n   * - Delete the matching draft versions (publishedAt = null)\n   * - Clone the matching published versions into draft versions\n   */\n  async discardDraft(uid, documentId, params) {\n    // Delete draft versions, clone published versions into draft versions\n    await this.delete(uid, documentId, {\n      ...params,\n      // Delete all drafts that match query\n      lookup: { ...params?.lookup, publishedAt: null },\n    });\n\n    // Clone published versions into draft versions\n    const clonedDocuments = (await this.clone(uid, documentId, {\n      ...(params || {}),\n      // Clone only published versions\n      lookup: { ...params?.lookup, publishedAt: { $ne: null } },\n      // @ts-expect-error - Generic type does not have publishedAt attribute by default\n      data: { documentId, publishedAt: null },\n    })) as any;\n\n    return { versions: clonedDocuments?.versions || [] };\n  },\n});\n\nexport default (ctx: { strapi: Strapi; db: Database }): Documents.Engine => {\n  const implementation = createDocumentEngine(ctx);\n\n  // TODO: Wrap with database error handling\n  return implementation;\n};\n"],"names":["convertQueryParams","applyTransforms","params","mapAsync","getComponents","deleteComponents","isArray","entityValidator","createComponents","omitComponentData","pickSelectionParams","updateComponents","createDocumentId","contentTypesUtils","omit","cloneComponents"],"mappings":";;;;;;;;;AAqBA,MAAM,EAAE,uBAA2B,IAAAA;AAiBnC,MAAM,iBAAiB,CAAC,MAA+B,YAAqB;AACnE,SAAAC,QAAA,gBAAgB,MAAM,OAAO;AACtC;AAEA,MAAM,iBAAiB,CAAC,MAA+B,YAAqB;AACnE,SAAAA,QAAA,gBAAgB,MAAM,OAAO;AACtC;AAEA,MAAM,uBAAuB,CAAC;AAAA,EAC5B;AAAA,EACA;AACF,OAGyB;AAAA,EACvB;AAAA,EAEA,MAAM,SAAS,KAAKC,SAAQ;AAC1B,UAAM,EAAE,KAAS,IAAA,OAAO,SAAS,GAAG;AAEpC,UAAM,QAAQ,uBAAuB,KAAKA,WAAW,CAAU,CAAA;AAC/D,UAAM,QAAQ,EAAE,GAAGA,SAAQ,QAAQ,GAAG,MAAM;AAE5C,QAAI,SAAS,cAAc;AACzB,aAAO,GAAG,MAAM,GAAG,EAAE,QAAQ,KAAK;AAAA,IACpC;AAEA,WAAO,GAAG,MAAM,GAAG,EAAE,SAAS,KAAK;AAAA,EACrC;AAAA,EAEA,MAAM,UAAU,KAAKA,SAAQ;AAC3B,UAAM,QAAQ,uBAAuB,KAAKA,WAAW,CAAU,CAAA;AAE/D,WAAO,GAAG,MAAM,GAAG,EAAE,QAAQ,EAAE,GAAG,OAAO,OAAO,EAAE,GAAGA,SAAQ,QAAQ,GAAG,MAAM,SAAS;AAAA,EACzF;AAAA,EAEA,MAAM,QAAQ,KAAK,YAAYA,SAAQ;AACrC,UAAM,QAAQ,uBAAuB,KAAKA,WAAW,CAAU,CAAA;AAC/D,WAAO,GACJ,MAAM,GAAG,EACT,QAAQ,EAAE,GAAG,OAAO,OAAO,EAAE,GAAGA,SAAQ,QAAQ,GAAG,MAAM,OAAO,cAAc;AAAA,EACnF;AAAA,EAEA,MAAM,OAAO,KAAK,YAAYA,UAAS,CAAA,GAAW;AAC1C,UAAA,QAAQ,uBAAuB,KAAKA,OAAa;AAEnD,QAAAA,QAAO,WAAW,SAAS;AACvB,YAAA,IAAI,MAAM,gCAAgC;AAAA,IAClD;AAEA,UAAM,kBAAkB,MAAM,GAAG,MAAM,GAAG,EAAE,SAAS;AAAA,MACnD,GAAG;AAAA,MACH,OAAO;AAAA,QACL,GAAGA,QAAO;AAAA,QACV,GAAG,OAAO;AAAA,QACV;AAAA,MACF;AAAA,IAAA,CACD;AAGK,UAAAC,YAAA,SAAS,iBAAiB,OAAO,kBAAuB;AAC5D,YAAM,qBAAqB,MAAMC,WAAAA,cAAc,KAAK,aAAa;AACjE,YAAM,GAAG,MAAM,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,cAAc,GAAG,EAAG,CAAA;AAC9D,YAAMC,WAAAA,iBAAiB,KAAK,oBAA2B,EAAE,gBAAgB,OAAO;AAAA,IAAA,CACjF;AAGM,WAAA,EAAE,UAAU;EACrB;AAAA;AAAA,EAGA,MAAM,WAAW,KAAK,aAAa;AAC7B,QAAA;AACA,QAAAC,EAAAA,QAAQ,WAAW,GAAG;AACV,oBAAA,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK;IAAgB,OACxD;AACS,oBAAA;AAAA,IAChB;AAEA,UAAM,QAAQ,uBAAuB,KAAK,eAAgB,CAAU,CAAA;AAEpE,WAAO,GAAG,MAAM,GAAG,EAAE,WAAW,KAAK;AAAA,EACvC;AAAA,EAEA,MAAM,OAAO,KAAKJ,UAAQ;AAGlB,UAAA,EAAE,KAAS,IAAAA;AAEjB,QAAI,CAAC,MAAM;AACH,YAAA,IAAI,MAAM,gCAAgC;AAAA,IAClD;AAEM,UAAA,QAAQ,OAAO,SAAS,GAAG;AAEjC,UAAM,YAAY,MAAMK,MAAgB,uBAAuB,OAAO,MAAM;AAAA,MAC1E,SAAS;AAAA,MACT,QAAQL,UAAQ;AAAA,IAAA,CACjB;AAED,UAAM,gBAAgB,MAAMM,WAAAA,iBAAiB,KAAK,SAAS;AAC3D,UAAM,YAAY;AAAA,MAChB,OAAO,OAAOC,WAAA,kBAAkB,OAAO,SAAS,GAAG,aAAa;AAAA,MAChE;AAAA,QACE,aAAa;AAAA,MACf;AAAA,IAAA;AAIF,UAAM,QAAQ,uBAAuB,KAAKC,OAAAA,oBAAoBR,QAAM,CAAQ;AAErE,WAAA,GAAG,MAAM,GAAG,EAAE,OAAO,EAAE,GAAG,OAAO,MAAM,UAAA,CAAW;AAAA,EAC3D;AAAA;AAAA,EAGA,MAAM,OAAO,KAAK,YAAYA,UAAQ;AAIpC,UAAM,EAAE,KAAA,IAASA,YAAU;AACrB,UAAA,QAAQ,OAAO,SAAS,GAAG;AAEjC,UAAM,QAAQ,uBAAuB,KAAKQ,2BAAoBR,YAAU,CAAE,CAAA,CAAQ;AAG5E,UAAA,gBAAgB,MAAM,GACzB,MAAM,GAAG,EACT,QAAQ,EAAE,GAAG,OAAO,OAAO,EAAE,GAAGA,UAAQ,QAAQ,GAAG,OAAO,OAAO,cAAc;AAGlF,QAAI,CAAC,eAAe;AACX,aAAA;AAAA,IACT;AAEM,UAAA,YAAY,MAAMK,MAAgB;AAAA,MACtC;AAAA,MACA;AAAA,MACA;AAAA,QACE,SAAS;AAAA;AAAA,QACT,QAAQL,UAAQ;AAAA,MAClB;AAAA,MACA;AAAA,IAAA;AAGF,UAAM,gBAAgB,MAAMS,WAAiB,iBAAA,KAAK,eAAe,SAAS;AAC1E,UAAM,YAAY;AAAA,MAChB,OAAO,OAAOF,WAAA,kBAAkB,OAAO,SAAS,GAAG,aAAa;AAAA,MAChE,EAAE,aAAa,MAAM;AAAA,IAAA;AAGvB,WAAO,GAAG,MAAM,GAAG,EAAE,OAAO,EAAE,GAAG,OAAO,OAAO,EAAE,IAAI,cAAc,GAAM,GAAA,MAAM,WAAW;AAAA,EAC5F;AAAA,EAEA,MAAM,MAAM,KAAKP,UAAS,QAAW;AACnC,UAAM,QAAQ,uBAAuB,KAAKA,WAAW,CAAU,CAAA;AAC/D,UAAM,QAAQ,EAAE,GAAGA,SAAQ,QAAQ,GAAG,MAAM;AAE5C,WAAO,GAAG,MAAM,GAAG,EAAE,MAAM,KAAK;AAAA,EAClC;AAAA,EAEA,MAAM,MAAM,KAAK,YAAYA,UAAQ;AAGnC,UAAM,EAAE,OAAO,GAAc,IAAAA;AAEvB,UAAA,QAAQ,OAAO,SAAS,GAAG;AACjC,UAAM,QAAQ,uBAAuB,KAAKQ,OAAAA,oBAAoBR,QAAM,CAAQ;AAG5E,UAAM,UAAU,MAAM,GAAG,MAAM,GAAG,EAAE,SAAS;AAAA,MAC3C,GAAG;AAAA,MACH,OAAO,EAAE,GAAGA,UAAQ,QAAQ,GAAG,MAAM,OAAO,WAAW;AAAA,IAAA,CACxD;AAGG,QAAA,CAAC,QAAQ,QAAQ;AACZ,aAAA;AAAA,IACT;AAEA,UAAM,gBAAgBU,8BAAAA;AAEtB,UAAM,WAAW,MAAMT,YAAAA,SAAS,SAAS,OAAO,iBAAsB;AAC9D,YAAA,UAAUU,YAAAA,aAAkB,QAAQ,IAAI;AAExC,YAAA,YAAY,MAAMN,MAAgB;AAAA,QACtC;AAAA;AAAA,QAEAO,OAAK,CAAC,IAAI,GAAG,IAAI;AAAA,QACjB,EAAE,SAAS,GAAGZ,UAAQ,OAAO;AAAA,QAC7B;AAAA,MAAA;AAGF,YAAM,gBAAgB,MAAMa,WAAgB,gBAAA,KAAK,cAAc,SAAS;AACxE,YAAM,aAAa;AAAA,QACjB,OAAO,OAAON,WAAA,kBAAkB,OAAO,SAAS,GAAG,aAAa;AAAA,QAChE,EAAE,aAAa,MAAM;AAAA,MAAA;AAIvB,aAAO,GAAG,MAAM,GAAG,EAAE,MAAM,aAAa,IAAI;AAAA,QAC1C,GAAG;AAAA;AAAA,QAEH,MAAM,EAAE,YAAY,eAAe,GAAG,YAAY,QAAQ,aAAa,OAAO;AAAA,MAAA,CAC/E;AAAA,IAAA,CACF;AAEM,WAAA,EAAE,IAAI,eAAe;EAC9B;AAAA;AAAA,EAGA,MAAM,QAAQ,KAAK,YAAYP,SAAQ;AAE/B,UAAA,KAAK,OAAO,KAAK,YAAY;AAAA,MACjC,GAAGA;AAAA,MACH,QAAQ,EAAE,GAAGA,SAAQ,QAAQ,aAAa,EAAE,KAAK,OAAO;AAAA,IAAA,CACzD;AAGD,UAAM,kBAAmB,MAAM,KAAK,MAAM,KAAK,YAAY;AAAA,MACzD,GAAIA,WAAU,CAAC;AAAA;AAAA,MAEf,MAAM,EAAE,YAAY,aAAa,oBAAI,OAAO;AAAA,IAAA,CAC7C;AAGD,WAAO,EAAE,UAAU,iBAAiB,YAAY,CAAG,EAAA;AAAA,EACrD;AAAA,EAEA,MAAM,UAAU,KAAK,YAAYA,SAAQ;AAEhC,WAAA,KAAK,OAAO,KAAK,YAAY;AAAA,MAClC,GAAGA;AAAA,MACH,QAAQ,EAAE,GAAGA,SAAQ,QAAQ,aAAa,EAAE,KAAK,OAAO;AAAA,IAAA,CACzD;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,aAAa,KAAK,YAAYA,SAAQ;AAEpC,UAAA,KAAK,OAAO,KAAK,YAAY;AAAA,MACjC,GAAGA;AAAA;AAAA,MAEH,QAAQ,EAAE,GAAGA,SAAQ,QAAQ,aAAa,KAAK;AAAA,IAAA,CAChD;AAGD,UAAM,kBAAmB,MAAM,KAAK,MAAM,KAAK,YAAY;AAAA,MACzD,GAAIA,WAAU,CAAC;AAAA;AAAA,MAEf,QAAQ,EAAE,GAAGA,SAAQ,QAAQ,aAAa,EAAE,KAAK,OAAO;AAAA;AAAA,MAExD,MAAM,EAAE,YAAY,aAAa,KAAK;AAAA,IAAA,CACvC;AAED,WAAO,EAAE,UAAU,iBAAiB,YAAY,CAAG,EAAA;AAAA,EACrD;AACF;AAEA,MAAe,2BAAA,CAAC,QAA4D;AACpE,QAAA,iBAAiB,qBAAqB,GAAG;AAGxC,SAAA;AACT;;"}

package/dist/services/document-service/document-engine.mjs

@@ -0,0 +1,201 @@
+import { mapAsync, contentTypes, convertQueryParams } from "@strapi/utils";
+import { isArray, omit } from "lodash/fp";
+import uploadFile from "../utils/upload-files.mjs";
+import { getComponents, deleteComponents, createComponents, omitComponentData, updateComponents, cloneComponents } from "../entity-service/components.mjs";
+import { createDocumentId } from "../../utils/transform-content-types-to-models.mjs";
+import { applyTransforms } from "../entity-service/attributes/index.mjs";
+import entityValidator from "../entity-validator/index.mjs";
+import { pickSelectionParams } from "../entity-service/params.mjs";
+const { transformParamsToQuery } = convertQueryParams;
+const createPipeline = (data, context) => {
+  return applyTransforms(data, context);
+};
+const updatePipeline = (data, context) => {
+  return applyTransforms(data, context);
+};
+const createDocumentEngine = ({
+  strapi,
+  db
+}) => ({
+  uploadFiles: uploadFile,
+  async findMany(uid, params) {
+    const { kind } = strapi.getModel(uid);
+    const query = transformParamsToQuery(uid, params || {});
+    query.where = { ...params?.lookup, ...query.where };
+    if (kind === "singleType") {
+      return db.query(uid).findOne(query);
+    }
+    return db.query(uid).findMany(query);
+  },
+  async findFirst(uid, params) {
+    const query = transformParamsToQuery(uid, params || {});
+    return db.query(uid).findOne({ ...query, where: { ...params?.lookup, ...query.where } });
+  },
+  async findOne(uid, documentId, params) {
+    const query = transformParamsToQuery(uid, params || {});
+    return db.query(uid).findOne({ ...query, where: { ...params?.lookup, ...query.where, documentId } });
+  },
+  async delete(uid, documentId, params = {}) {
+    const query = transformParamsToQuery(uid, params);
+    if (params.status === "draft") {
+      throw new Error("Cannot delete a draft document");
+    }
+    const entriesToDelete = await db.query(uid).findMany({
+      ...query,
+      where: {
+        ...params.lookup,
+        ...query?.where,
+        documentId
+      }
+    });
+    await mapAsync(entriesToDelete, async (entryToDelete) => {
+      const componentsToDelete = await getComponents(uid, entryToDelete);
+      await db.query(uid).delete({ where: { id: entryToDelete.id } });
+      await deleteComponents(uid, componentsToDelete, { loadComponents: false });
+    });
+    return { versions: entriesToDelete };
+  },
+  // TODO: should we provide two separate methods?
+  async deleteMany(uid, paramsOrIds) {
+    let queryParams;
+    if (isArray(paramsOrIds)) {
+      queryParams = { filter: { documentID: { $in: paramsOrIds } } };
+    } else {
+      queryParams = paramsOrIds;
+    }
+    const query = transformParamsToQuery(uid, queryParams || {});
+    return db.query(uid).deleteMany(query);
+  },
+  async create(uid, params) {
+    const { data } = params;
+    if (!data) {
+      throw new Error("Create requires data attribute");
+    }
+    const model = strapi.getModel(uid);
+    const validData = await entityValidator.validateEntityCreation(model, data, {
+      isDraft: true,
+      locale: params?.locale
+    });
+    const componentData = await createComponents(uid, validData);
+    const entryData = createPipeline(
+      Object.assign(omitComponentData(model, validData), componentData),
+      {
+        contentType: model
+      }
+    );
+    const query = transformParamsToQuery(uid, pickSelectionParams(params));
+    return db.query(uid).create({ ...query, data: entryData });
+  },
+  // NOTE: What happens if user doesn't provide specific publications state and locale to update?
+  async update(uid, documentId, params) {
+    const { data } = params || {};
+    const model = strapi.getModel(uid);
+    const query = transformParamsToQuery(uid, pickSelectionParams(params || {}));
+    const entryToUpdate = await db.query(uid).findOne({ ...query, where: { ...params?.lookup, ...query?.where, documentId } });
+    if (!entryToUpdate) {
+      return null;
+    }
+    const validData = await entityValidator.validateEntityUpdate(
+      model,
+      data,
+      {
+        isDraft: true,
+        // Always update the draft version
+        locale: params?.locale
+      },
+      entryToUpdate
+    );
+    const componentData = await updateComponents(uid, entryToUpdate, validData);
+    const entryData = updatePipeline(
+      Object.assign(omitComponentData(model, validData), componentData),
+      { contentType: model }
+    );
+    return db.query(uid).update({ ...query, where: { id: entryToUpdate.id }, data: entryData });
+  },
+  async count(uid, params = void 0) {
+    const query = transformParamsToQuery(uid, params || {});
+    query.where = { ...params?.lookup, ...query.where };
+    return db.query(uid).count(query);
+  },
+  async clone(uid, documentId, params) {
+    const { data = {} } = params;
+    const model = strapi.getModel(uid);
+    const query = transformParamsToQuery(uid, pickSelectionParams(params));
+    const entries = await db.query(uid).findMany({
+      ...query,
+      where: { ...params?.lookup, ...query.where, documentId }
+    });
+    if (!entries.length) {
+      return null;
+    }
+    const newDocumentId = createDocumentId();
+    const versions = await mapAsync(entries, async (entryToClone) => {
+      const isDraft = contentTypes.isDraft(data);
+      const validData = await entityValidator.validateEntityUpdate(
+        model,
+        // Omit id fields, the cloned entity id will be generated by the database
+        omit(["id"], data),
+        { isDraft, ...params?.lookup },
+        entryToClone
+      );
+      const componentData = await cloneComponents(uid, entryToClone, validData);
+      const entityData = createPipeline(
+        Object.assign(omitComponentData(model, validData), componentData),
+        { contentType: model }
+      );
+      return db.query(uid).clone(entryToClone.id, {
+        ...query,
+        // Allows entityData to override the documentId (e.g. when publishing)
+        data: { documentId: newDocumentId, ...entityData, locale: entryToClone.locale }
+      });
+    });
+    return { id: newDocumentId, versions };
+  },
+  // TODO: Handle relations so they target the published version
+  async publish(uid, documentId, params) {
+    await this.delete(uid, documentId, {
+      ...params,
+      lookup: { ...params?.lookup, publishedAt: { $ne: null } }
+    });
+    const clonedDocuments = await this.clone(uid, documentId, {
+      ...params || {},
+      // @ts-expect-error - Generic type does not have publishedAt attribute by default
+      data: { documentId, publishedAt: /* @__PURE__ */ new Date() }
+    });
+    return { versions: clonedDocuments?.versions || [] };
+  },
+  async unpublish(uid, documentId, params) {
+    return this.delete(uid, documentId, {
+      ...params,
+      lookup: { ...params?.lookup, publishedAt: { $ne: null } }
+    });
+  },
+  /**
+   * Steps:
+   * - Delete the matching draft versions (publishedAt = null)
+   * - Clone the matching published versions into draft versions
+   */
+  async discardDraft(uid, documentId, params) {
+    await this.delete(uid, documentId, {
+      ...params,
+      // Delete all drafts that match query
+      lookup: { ...params?.lookup, publishedAt: null }
+    });
+    const clonedDocuments = await this.clone(uid, documentId, {
+      ...params || {},
+      // Clone only published versions
+      lookup: { ...params?.lookup, publishedAt: { $ne: null } },
+      // @ts-expect-error - Generic type does not have publishedAt attribute by default
+      data: { documentId, publishedAt: null }
+    });
+    return { versions: clonedDocuments?.versions || [] };
+  }
+});
+const createDocumentRepository = (ctx) => {
+  const implementation = createDocumentEngine(ctx);
+  return implementation;
+};
+export {
+  createDocumentRepository as default
+};
+//# sourceMappingURL=document-engine.mjs.map

package/dist/services/document-service/document-engine.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-engine.mjs","sources":["../../../src/services/document-service/document-engine.ts"],"sourcesContent":["import type { Database } from '@strapi/database';\nimport type { Common, Documents, Schema, Shared, Strapi } from '@strapi/types';\nimport { contentTypes as contentTypesUtils, convertQueryParams, mapAsync } from '@strapi/utils';\n\nimport { isArray, omit } from 'lodash/fp';\nimport uploadFiles from '../utils/upload-files';\n\nimport {\n  cloneComponents,\n  createComponents,\n  deleteComponents,\n  getComponents,\n  omitComponentData,\n  updateComponents,\n} from '../entity-service/components';\n\nimport { createDocumentId } from '../../utils/transform-content-types-to-models';\nimport { applyTransforms } from '../entity-service/attributes';\nimport entityValidator from '../entity-validator';\nimport { pickSelectionParams } from './params';\n\nconst { transformParamsToQuery } = convertQueryParams;\n\n/**\n * TODO: Sanitization / validation built-in\n * TODO: i18n - Move logic to i18n package\n * TODO: Webhooks\n * TODO: Audit logs\n * TODO: Entity Validation - Uniqueness across same locale and publication status\n * TODO: File upload\n * TODO: replace 'any'\n * TODO: availableLocales\n *\n */\ntype Context = {\n  contentType: Schema.ContentType;\n};\n\nconst createPipeline = (data: Record<string, unknown>, context: Context) => {\n  return applyTransforms(data, context);\n};\n\nconst updatePipeline = (data: Record<string, unknown>, context: Context) => {\n  return applyTransforms(data, context);\n};\n\nconst createDocumentEngine = ({\n  strapi,\n  db,\n}: {\n  strapi: Strapi;\n  db: Database;\n}): Documents.Engine => ({\n  uploadFiles,\n\n  async findMany(uid, params) {\n    const { kind } = strapi.getModel(uid);\n\n    const query = transformParamsToQuery(uid, params || ({} as any));\n    query.where = { ...params?.lookup, ...query.where };\n\n    if (kind === 'singleType') {\n      return db.query(uid).findOne(query);\n    }\n\n    return db.query(uid).findMany(query);\n  },\n\n  async findFirst(uid, params) {\n    const query = transformParamsToQuery(uid, params || ({} as any));\n\n    return db.query(uid).findOne({ ...query, where: { ...params?.lookup, ...query.where } });\n  },\n\n  async findOne(uid, documentId, params) {\n    const query = transformParamsToQuery(uid, params || ({} as any));\n    return db\n      .query(uid)\n      .findOne({ ...query, where: { ...params?.lookup, ...query.where, documentId } });\n  },\n\n  async delete(uid, documentId, params = {} as any) {\n    const query = transformParamsToQuery(uid, params as any);\n\n    if (params.status === 'draft') {\n      throw new Error('Cannot delete a draft document');\n    }\n\n    const entriesToDelete = await db.query(uid).findMany({\n      ...query,\n      where: {\n        ...params.lookup,\n        ...query?.where,\n        documentId,\n      },\n    });\n\n    // Delete all matched entries and its components\n    await mapAsync(entriesToDelete, async (entryToDelete: any) => {\n      const componentsToDelete = await getComponents(uid, entryToDelete);\n      await db.query(uid).delete({ where: { id: entryToDelete.id } });\n      await deleteComponents(uid, componentsToDelete as any, { loadComponents: false });\n    });\n\n    // TODO: Change return value to actual count\n    return { versions: entriesToDelete };\n  },\n\n  // TODO: should we provide two separate methods?\n  async deleteMany(uid, paramsOrIds) {\n    let queryParams;\n    if (isArray(paramsOrIds)) {\n      queryParams = { filter: { documentID: { $in: paramsOrIds } } };\n    } else {\n      queryParams = paramsOrIds;\n    }\n\n    const query = transformParamsToQuery(uid, queryParams || ({} as any));\n\n    return db.query(uid).deleteMany(query);\n  },\n\n  async create(uid, params) {\n    // TODO: Entity validator.\n    // TODO: File upload - Probably in the lifecycles?\n    const { data } = params;\n\n    if (!data) {\n      throw new Error('Create requires data attribute');\n    }\n\n    const model = strapi.getModel(uid) as Shared.ContentTypes[Common.UID.ContentType];\n\n    const validData = await entityValidator.validateEntityCreation(model, data, {\n      isDraft: true,\n      locale: params?.locale,\n    });\n\n    const componentData = await createComponents(uid, validData);\n    const entryData = createPipeline(\n      Object.assign(omitComponentData(model, validData), componentData),\n      {\n        contentType: model,\n      }\n    );\n\n    // select / populate\n    const query = transformParamsToQuery(uid, pickSelectionParams(params) as any);\n\n    return db.query(uid).create({ ...query, data: entryData });\n  },\n\n  // NOTE: What happens if user doesn't provide specific publications state and locale to update?\n  async update(uid, documentId, params) {\n    // TODO: Prevent updating a published document\n    // TODO: Entity validator.\n    // TODO: File upload\n    const { data } = params || {};\n    const model = strapi.getModel(uid) as Shared.ContentTypes[Common.UID.ContentType];\n\n    const query = transformParamsToQuery(uid, pickSelectionParams(params || {}) as any);\n\n    // Find all locales of the document\n    const entryToUpdate = await db\n      .query(uid)\n      .findOne({ ...query, where: { ...params?.lookup, ...query?.where, documentId } });\n\n    // Document does not exist\n    if (!entryToUpdate) {\n      return null;\n    }\n\n    const validData = await entityValidator.validateEntityUpdate(\n      model,\n      data,\n      {\n        isDraft: true, // Always update the draft version\n        locale: params?.locale,\n      },\n      entryToUpdate\n    );\n\n    const componentData = await updateComponents(uid, entryToUpdate, validData);\n    const entryData = updatePipeline(\n      Object.assign(omitComponentData(model, validData), componentData),\n      { contentType: model }\n    );\n\n    return db.query(uid).update({ ...query, where: { id: entryToUpdate.id }, data: entryData });\n  },\n\n  async count(uid, params = undefined) {\n    const query = transformParamsToQuery(uid, params || ({} as any));\n    query.where = { ...params?.lookup, ...query.where };\n\n    return db.query(uid).count(query);\n  },\n\n  async clone(uid, documentId, params) {\n    // TODO: File upload\n    // TODO: Entity validator.\n    const { data = {} as any } = params!;\n\n    const model = strapi.getModel(uid);\n    const query = transformParamsToQuery(uid, pickSelectionParams(params) as any);\n\n    // Find all locales of the document\n    const entries = await db.query(uid).findMany({\n      ...query,\n      where: { ...params?.lookup, ...query.where, documentId },\n    });\n\n    // Document does not exist\n    if (!entries.length) {\n      return null;\n    }\n\n    const newDocumentId = createDocumentId();\n\n    const versions = await mapAsync(entries, async (entryToClone: any) => {\n      const isDraft = contentTypesUtils.isDraft(data);\n      // Todo: Merge data with entry to clone\n      const validData = await entityValidator.validateEntityUpdate(\n        model,\n        // Omit id fields, the cloned entity id will be generated by the database\n        omit(['id'], data),\n        { isDraft, ...params?.lookup },\n        entryToClone\n      );\n\n      const componentData = await cloneComponents(uid, entryToClone, validData);\n      const entityData = createPipeline(\n        Object.assign(omitComponentData(model, validData), componentData),\n        { contentType: model }\n      );\n\n      // TODO: Transform params to query\n      return db.query(uid).clone(entryToClone.id, {\n        ...query,\n        // Allows entityData to override the documentId (e.g. when publishing)\n        data: { documentId: newDocumentId, ...entityData, locale: entryToClone.locale },\n      });\n    });\n\n    return { id: newDocumentId, versions };\n  },\n\n  // TODO: Handle relations so they target the published version\n  async publish(uid, documentId, params) {\n    // Delete already published versions that match the locales to be published\n    await this.delete(uid, documentId, {\n      ...params,\n      lookup: { ...params?.lookup, publishedAt: { $ne: null } },\n    });\n\n    // Clone every draft version to be published\n    const clonedDocuments = (await this.clone(uid, documentId, {\n      ...(params || {}),\n      // @ts-expect-error - Generic type does not have publishedAt attribute by default\n      data: { documentId, publishedAt: new Date() },\n    })) as any;\n\n    // TODO: Return actual count\n    return { versions: clonedDocuments?.versions || [] };\n  },\n\n  async unpublish(uid, documentId, params) {\n    // Delete all published versions\n    return this.delete(uid, documentId, {\n      ...params,\n      lookup: { ...params?.lookup, publishedAt: { $ne: null } },\n    }) as any;\n  },\n\n  /**\n   * Steps:\n   * - Delete the matching draft versions (publishedAt = null)\n   * - Clone the matching published versions into draft versions\n   */\n  async discardDraft(uid, documentId, params) {\n    // Delete draft versions, clone published versions into draft versions\n    await this.delete(uid, documentId, {\n      ...params,\n      // Delete all drafts that match query\n      lookup: { ...params?.lookup, publishedAt: null },\n    });\n\n    // Clone published versions into draft versions\n    const clonedDocuments = (await this.clone(uid, documentId, {\n      ...(params || {}),\n      // Clone only published versions\n      lookup: { ...params?.lookup, publishedAt: { $ne: null } },\n      // @ts-expect-error - Generic type does not have publishedAt attribute by default\n      data: { documentId, publishedAt: null },\n    })) as any;\n\n    return { versions: clonedDocuments?.versions || [] };\n  },\n});\n\nexport default (ctx: { strapi: Strapi; db: Database }): Documents.Engine => {\n  const implementation = createDocumentEngine(ctx);\n\n  // TODO: Wrap with database error handling\n  return implementation;\n};\n"],"names":["uploadFiles","contentTypesUtils"],"mappings":";;;;;;;;AAqBA,MAAM,EAAE,uBAA2B,IAAA;AAiBnC,MAAM,iBAAiB,CAAC,MAA+B,YAAqB;AACnE,SAAA,gBAAgB,MAAM,OAAO;AACtC;AAEA,MAAM,iBAAiB,CAAC,MAA+B,YAAqB;AACnE,SAAA,gBAAgB,MAAM,OAAO;AACtC;AAEA,MAAM,uBAAuB,CAAC;AAAA,EAC5B;AAAA,EACA;AACF,OAGyB;AAAA,EAAA,aACvBA;AAAAA,EAEA,MAAM,SAAS,KAAK,QAAQ;AAC1B,UAAM,EAAE,KAAS,IAAA,OAAO,SAAS,GAAG;AAEpC,UAAM,QAAQ,uBAAuB,KAAK,UAAW,CAAU,CAAA;AAC/D,UAAM,QAAQ,EAAE,GAAG,QAAQ,QAAQ,GAAG,MAAM;AAE5C,QAAI,SAAS,cAAc;AACzB,aAAO,GAAG,MAAM,GAAG,EAAE,QAAQ,KAAK;AAAA,IACpC;AAEA,WAAO,GAAG,MAAM,GAAG,EAAE,SAAS,KAAK;AAAA,EACrC;AAAA,EAEA,MAAM,UAAU,KAAK,QAAQ;AAC3B,UAAM,QAAQ,uBAAuB,KAAK,UAAW,CAAU,CAAA;AAE/D,WAAO,GAAG,MAAM,GAAG,EAAE,QAAQ,EAAE,GAAG,OAAO,OAAO,EAAE,GAAG,QAAQ,QAAQ,GAAG,MAAM,SAAS;AAAA,EACzF;AAAA,EAEA,MAAM,QAAQ,KAAK,YAAY,QAAQ;AACrC,UAAM,QAAQ,uBAAuB,KAAK,UAAW,CAAU,CAAA;AAC/D,WAAO,GACJ,MAAM,GAAG,EACT,QAAQ,EAAE,GAAG,OAAO,OAAO,EAAE,GAAG,QAAQ,QAAQ,GAAG,MAAM,OAAO,cAAc;AAAA,EACnF;AAAA,EAEA,MAAM,OAAO,KAAK,YAAY,SAAS,CAAA,GAAW;AAC1C,UAAA,QAAQ,uBAAuB,KAAK,MAAa;AAEnD,QAAA,OAAO,WAAW,SAAS;AACvB,YAAA,IAAI,MAAM,gCAAgC;AAAA,IAClD;AAEA,UAAM,kBAAkB,MAAM,GAAG,MAAM,GAAG,EAAE,SAAS;AAAA,MACnD,GAAG;AAAA,MACH,OAAO;AAAA,QACL,GAAG,OAAO;AAAA,QACV,GAAG,OAAO;AAAA,QACV;AAAA,MACF;AAAA,IAAA,CACD;AAGK,UAAA,SAAS,iBAAiB,OAAO,kBAAuB;AAC5D,YAAM,qBAAqB,MAAM,cAAc,KAAK,aAAa;AACjE,YAAM,GAAG,MAAM,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,cAAc,GAAG,EAAG,CAAA;AAC9D,YAAM,iBAAiB,KAAK,oBAA2B,EAAE,gBAAgB,OAAO;AAAA,IAAA,CACjF;AAGM,WAAA,EAAE,UAAU;EACrB;AAAA;AAAA,EAGA,MAAM,WAAW,KAAK,aAAa;AAC7B,QAAA;AACA,QAAA,QAAQ,WAAW,GAAG;AACV,oBAAA,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK;IAAgB,OACxD;AACS,oBAAA;AAAA,IAChB;AAEA,UAAM,QAAQ,uBAAuB,KAAK,eAAgB,CAAU,CAAA;AAEpE,WAAO,GAAG,MAAM,GAAG,EAAE,WAAW,KAAK;AAAA,EACvC;AAAA,EAEA,MAAM,OAAO,KAAK,QAAQ;AAGlB,UAAA,EAAE,KAAS,IAAA;AAEjB,QAAI,CAAC,MAAM;AACH,YAAA,IAAI,MAAM,gCAAgC;AAAA,IAClD;AAEM,UAAA,QAAQ,OAAO,SAAS,GAAG;AAEjC,UAAM,YAAY,MAAM,gBAAgB,uBAAuB,OAAO,MAAM;AAAA,MAC1E,SAAS;AAAA,MACT,QAAQ,QAAQ;AAAA,IAAA,CACjB;AAED,UAAM,gBAAgB,MAAM,iBAAiB,KAAK,SAAS;AAC3D,UAAM,YAAY;AAAA,MAChB,OAAO,OAAO,kBAAkB,OAAO,SAAS,GAAG,aAAa;AAAA,MAChE;AAAA,QACE,aAAa;AAAA,MACf;AAAA,IAAA;AAIF,UAAM,QAAQ,uBAAuB,KAAK,oBAAoB,MAAM,CAAQ;AAErE,WAAA,GAAG,MAAM,GAAG,EAAE,OAAO,EAAE,GAAG,OAAO,MAAM,UAAA,CAAW;AAAA,EAC3D;AAAA;AAAA,EAGA,MAAM,OAAO,KAAK,YAAY,QAAQ;AAIpC,UAAM,EAAE,KAAA,IAAS,UAAU;AACrB,UAAA,QAAQ,OAAO,SAAS,GAAG;AAEjC,UAAM,QAAQ,uBAAuB,KAAK,oBAAoB,UAAU,CAAE,CAAA,CAAQ;AAG5E,UAAA,gBAAgB,MAAM,GACzB,MAAM,GAAG,EACT,QAAQ,EAAE,GAAG,OAAO,OAAO,EAAE,GAAG,QAAQ,QAAQ,GAAG,OAAO,OAAO,cAAc;AAGlF,QAAI,CAAC,eAAe;AACX,aAAA;AAAA,IACT;AAEM,UAAA,YAAY,MAAM,gBAAgB;AAAA,MACtC;AAAA,MACA;AAAA,MACA;AAAA,QACE,SAAS;AAAA;AAAA,QACT,QAAQ,QAAQ;AAAA,MAClB;AAAA,MACA;AAAA,IAAA;AAGF,UAAM,gBAAgB,MAAM,iBAAiB,KAAK,eAAe,SAAS;AAC1E,UAAM,YAAY;AAAA,MAChB,OAAO,OAAO,kBAAkB,OAAO,SAAS,GAAG,aAAa;AAAA,MAChE,EAAE,aAAa,MAAM;AAAA,IAAA;AAGvB,WAAO,GAAG,MAAM,GAAG,EAAE,OAAO,EAAE,GAAG,OAAO,OAAO,EAAE,IAAI,cAAc,GAAM,GAAA,MAAM,WAAW;AAAA,EAC5F;AAAA,EAEA,MAAM,MAAM,KAAK,SAAS,QAAW;AACnC,UAAM,QAAQ,uBAAuB,KAAK,UAAW,CAAU,CAAA;AAC/D,UAAM,QAAQ,EAAE,GAAG,QAAQ,QAAQ,GAAG,MAAM;AAE5C,WAAO,GAAG,MAAM,GAAG,EAAE,MAAM,KAAK;AAAA,EAClC;AAAA,EAEA,MAAM,MAAM,KAAK,YAAY,QAAQ;AAGnC,UAAM,EAAE,OAAO,GAAc,IAAA;AAEvB,UAAA,QAAQ,OAAO,SAAS,GAAG;AACjC,UAAM,QAAQ,uBAAuB,KAAK,oBAAoB,MAAM,CAAQ;AAG5E,UAAM,UAAU,MAAM,GAAG,MAAM,GAAG,EAAE,SAAS;AAAA,MAC3C,GAAG;AAAA,MACH,OAAO,EAAE,GAAG,QAAQ,QAAQ,GAAG,MAAM,OAAO,WAAW;AAAA,IAAA,CACxD;AAGG,QAAA,CAAC,QAAQ,QAAQ;AACZ,aAAA;AAAA,IACT;AAEA,UAAM,gBAAgB;AAEtB,UAAM,WAAW,MAAM,SAAS,SAAS,OAAO,iBAAsB;AAC9D,YAAA,UAAUC,aAAkB,QAAQ,IAAI;AAExC,YAAA,YAAY,MAAM,gBAAgB;AAAA,QACtC;AAAA;AAAA,QAEA,KAAK,CAAC,IAAI,GAAG,IAAI;AAAA,QACjB,EAAE,SAAS,GAAG,QAAQ,OAAO;AAAA,QAC7B;AAAA,MAAA;AAGF,YAAM,gBAAgB,MAAM,gBAAgB,KAAK,cAAc,SAAS;AACxE,YAAM,aAAa;AAAA,QACjB,OAAO,OAAO,kBAAkB,OAAO,SAAS,GAAG,aAAa;AAAA,QAChE,EAAE,aAAa,MAAM;AAAA,MAAA;AAIvB,aAAO,GAAG,MAAM,GAAG,EAAE,MAAM,aAAa,IAAI;AAAA,QAC1C,GAAG;AAAA;AAAA,QAEH,MAAM,EAAE,YAAY,eAAe,GAAG,YAAY,QAAQ,aAAa,OAAO;AAAA,MAAA,CAC/E;AAAA,IAAA,CACF;AAEM,WAAA,EAAE,IAAI,eAAe;EAC9B;AAAA;AAAA,EAGA,MAAM,QAAQ,KAAK,YAAY,QAAQ;AAE/B,UAAA,KAAK,OAAO,KAAK,YAAY;AAAA,MACjC,GAAG;AAAA,MACH,QAAQ,EAAE,GAAG,QAAQ,QAAQ,aAAa,EAAE,KAAK,OAAO;AAAA,IAAA,CACzD;AAGD,UAAM,kBAAmB,MAAM,KAAK,MAAM,KAAK,YAAY;AAAA,MACzD,GAAI,UAAU,CAAC;AAAA;AAAA,MAEf,MAAM,EAAE,YAAY,aAAa,oBAAI,OAAO;AAAA,IAAA,CAC7C;AAGD,WAAO,EAAE,UAAU,iBAAiB,YAAY,CAAG,EAAA;AAAA,EACrD;AAAA,EAEA,MAAM,UAAU,KAAK,YAAY,QAAQ;AAEhC,WAAA,KAAK,OAAO,KAAK,YAAY;AAAA,MAClC,GAAG;AAAA,MACH,QAAQ,EAAE,GAAG,QAAQ,QAAQ,aAAa,EAAE,KAAK,OAAO;AAAA,IAAA,CACzD;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,aAAa,KAAK,YAAY,QAAQ;AAEpC,UAAA,KAAK,OAAO,KAAK,YAAY;AAAA,MACjC,GAAG;AAAA;AAAA,MAEH,QAAQ,EAAE,GAAG,QAAQ,QAAQ,aAAa,KAAK;AAAA,IAAA,CAChD;AAGD,UAAM,kBAAmB,MAAM,KAAK,MAAM,KAAK,YAAY;AAAA,MACzD,GAAI,UAAU,CAAC;AAAA;AAAA,MAEf,QAAQ,EAAE,GAAG,QAAQ,QAAQ,aAAa,EAAE,KAAK,OAAO;AAAA;AAAA,MAExD,MAAM,EAAE,YAAY,aAAa,KAAK;AAAA,IAAA,CACvC;AAED,WAAO,EAAE,UAAU,iBAAiB,YAAY,CAAG,EAAA;AAAA,EACrD;AACF;AAEA,MAAe,2BAAA,CAAC,QAA4D;AACpE,QAAA,iBAAiB,qBAAqB,GAAG;AAGxC,SAAA;AACT;"}

package/dist/services/document-service/document-service.d.ts

@@ -0,0 +1,21 @@
+import { Strapi, Documents } from '@strapi/types';
+/**
+ * Repository to :
+ * - Access documents via actions (findMany, findOne, create, update, delete, ...)
+ * - Execute middlewares on document actions
+ * - Apply default parameters to document actions
+ *
+ * @param strapi
+ * @param options.defaults - Default parameters to apply to all actions
+ * @param options.parent - Parent repository, used when creating a new repository with .with()
+ * @returns DocumentService
+ *
+ * @example Access documents
+ * const article = strapi.documents('api::article.article').create(params)
+ * const allArticles = strapi.documents('api::article.article').findMany(params)
+ *
+ */
+export declare const createDocumentService: (strapi: Strapi, { defaults }?: {
+    defaults?: any;
+}) => Documents.Service;
+//# sourceMappingURL=document-service.d.ts.map

package/dist/services/document-service/document-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-service.d.ts","sourceRoot":"","sources":["../../../src/services/document-service/document-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAU,SAAS,EAAE,MAAM,eAAe,CAAC;AAK1D;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,qBAAqB,WACxB,MAAM;eACkB,GAAG;MAClC,UAAU,OAsIZ,CAAC"}