@strapi/content-manager 5.60.0 → 5.61.0

package/dist/server/custom-order/services/custom-order.mjs

@@ -0,0 +1,284 @@
+import { errors } from '@strapi/utils';
+import storeUtils from '../../services/utils/store.mjs';
+import { POSITION_ATTRIBUTE, ENABLED_CACHE_TTL_MS } from '../constants.mjs';
+import { createDocumentMiddleware } from './document-middleware.mjs';
+import { computeMove } from './utils.mjs';
+
+/**
+ * Core store key of the list view settings of a content type, see `services/utils/store.ts`.
+ */ const CONFIGURATION_KEY_PREFIX = 'plugin_content_manager_configuration_content_types::';
+const createCustomOrderService = ({ strapi })=>{
+    const state = {
+        enabled: new Set(),
+        loadedAt: 0,
+        refreshId: 0,
+        isRefreshing: false,
+        isInitialized: false
+    };
+    /**
+   * Only the content types that received the position attribute at register can be ordered.
+   */ const isOrderable = (uid)=>{
+        const model = strapi.getModel(uid);
+        return model?.attributes?.[POSITION_ATTRIBUTE] !== undefined;
+    };
+    /**
+   * Reads which content types have custom order turned on in their list view settings.
+   * The setting lives in the database and can be changed at runtime, possibly from
+   * another instance, so it can't be read once and trusted forever.
+   */ const refresh = async ()=>{
+        state.refreshId += 1;
+        const refreshId = state.refreshId;
+        const configurations = await storeUtils.getAllConfigurations();
+        // A more recent refresh has started in the meantime, its result is the one to keep
+        if (refreshId !== state.refreshId) {
+            return;
+        }
+        state.enabled = new Set(configurations.flatMap(({ uid, settings })=>uid && settings?.customOrder === true && isOrderable(uid) ? [
+                uid
+            ] : []));
+        state.loadedAt = Date.now();
+    };
+    const refreshInBackgroundIfStale = ()=>{
+        if (state.isRefreshing || Date.now() - state.loadedAt < ENABLED_CACHE_TTL_MS) {
+            return;
+        }
+        state.isRefreshing = true;
+        refresh().then(()=>healMissingPositions()).catch((error)=>{
+            strapi.log.warn('[custom-order] Could not refresh the list of ordered content types', {
+                error
+            });
+        }).finally(()=>{
+            state.isRefreshing = false;
+        });
+    };
+    const getTable = (uid)=>{
+        const { tableName, attributes } = strapi.db.metadata.get(uid);
+        const columnOf = (attributeName)=>{
+            const attribute = attributes[attributeName];
+            return 'columnName' in attribute && attribute.columnName ? attribute.columnName : attributeName;
+        };
+        return {
+            tableName,
+            positionColumn: columnOf(POSITION_ATTRIBUTE),
+            documentIdColumn: columnOf('documentId')
+        };
+    };
+    const toPosition = (value)=>value === null || value === undefined ? undefined : Number(value);
+    /**
+   * Takes the lock on the order of a content type until the current transaction ends.
+   *
+   * The position of a new document and a move both read positions before writing them. Two
+   * of them at the same time would give two documents the same position, and nothing could
+   * tell those two apart afterwards. The lock is the row holding the list view settings of
+   * the content type, which exists whenever custom order is on. `FOR UPDATE` holds it until
+   * the transaction ends on PostgreSQL and MySQL. SQLite ignores it, its single connection
+   * serializes writers anyway.
+   */ const lockOrder = async (uid)=>{
+        await strapi.db.queryBuilder('strapi::core-store').select([
+            'id'
+        ]).where({
+            key: `${CONFIGURATION_KEY_PREFIX}${uid}`
+        }).forUpdate().first().execute();
+    };
+    /**
+   * Runs `fn` in a transaction, as the only writer of the order of a content type.
+   */ const withOrderLock = async (uid, fn)=>{
+        const result = await strapi.db.transaction(async ()=>{
+            await lockOrder(uid);
+            return fn();
+        });
+        return result;
+    };
+    const hasRowWithoutPosition = async (uid)=>{
+        const row = await strapi.db.queryBuilder(uid).select([
+            'id'
+        ]).where({
+            [POSITION_ATTRIBUTE]: {
+                $null: true
+            }
+        }).first().execute();
+        return row !== undefined && row !== null;
+    };
+    /**
+   * Position of a document, or undefined if it has none (or does not exist).
+   */ const getPosition = async (uid, documentId)=>{
+        const row = await strapi.db.queryBuilder(uid).select([
+            POSITION_ATTRIBUTE
+        ]).where({
+            documentId,
+            [POSITION_ATTRIBUTE]: {
+                $notNull: true
+            }
+        }).first().execute();
+        return toPosition(row?.[POSITION_ATTRIBUTE]);
+    };
+    /**
+   * Position that puts a document before every other one.
+   */ const getTopPosition = async (uid)=>{
+        const row = await strapi.db.queryBuilder(uid).min(POSITION_ATTRIBUTE).first().execute();
+        const min = toPosition(row?.min);
+        return min === undefined ? 0 : min - 1;
+    };
+    /**
+   * Gives a position to every row that has none.
+   *
+   * - Rows of a document that already has a position (e.g. a locale created outside of the
+   *   Document Service) take that position.
+   * - If nothing is ordered yet, documents are ordered by creation, which is the order the
+   *   API returned so far.
+   * - Otherwise the remaining documents were created while custom order was off: like any
+   *   new entry they go on top, the most recent first.
+   */ const assignMissingPositions = async (uid)=>{
+        // Checked before taking the lock: this runs in the background on every refresh
+        if (!await hasRowWithoutPosition(uid)) {
+            return;
+        }
+        const { tableName, positionColumn, documentIdColumn } = getTable(uid);
+        const knex = strapi.db.connection;
+        await strapi.db.transaction(async ({ trx })=>{
+            await lockOrder(uid);
+            const table = ()=>strapi.db.getConnection(tableName).transacting(trx);
+            // Another writer may have given the positions in the meantime
+            const rowWithoutPosition = await table().whereNull(positionColumn).first('id');
+            if (!rowWithoutPosition) {
+                return;
+            }
+            // The updated table can't be read directly in a sub query of its own update on MySQL,
+            // the aggregated derived tables below are what make these statements portable.
+            const documentIdOfUpdatedRow = knex.ref(`${tableName}.${documentIdColumn}`);
+            const topRow = await table().min({
+                min: positionColumn
+            }).first();
+            const top = toPosition(topRow?.min);
+            if (top !== undefined) {
+                const knownPositions = strapi.db.getConnection(tableName).select({
+                    d: documentIdColumn
+                }).max({
+                    p: positionColumn
+                }).whereNotNull(positionColumn).groupBy(documentIdColumn).as('x');
+                const positionOfDocument = knex.queryBuilder().select('x.p').from(knownPositions).where('x.d', documentIdOfUpdatedRow);
+                await table().whereNull(positionColumn).update({
+                    [positionColumn]: knex.raw('(?)', [
+                        positionOfDocument
+                    ])
+                });
+            }
+            const firstRowIds = strapi.db.getConnection(tableName).select({
+                d: documentIdColumn
+            }).min({
+                m: 'id'
+            }).groupBy(documentIdColumn).as('x');
+            const firstRowIdOfDocument = knex.queryBuilder().select('x.m').from(firstRowIds).where('x.d', documentIdOfUpdatedRow);
+            await table().whereNull(positionColumn).update({
+                [positionColumn]: top === undefined ? knex.raw('(?)', [
+                    firstRowIdOfDocument
+                ]) : knex.raw('? - (?)', [
+                    top,
+                    firstRowIdOfDocument
+                ])
+            });
+        });
+    };
+    /**
+   * Rows written outside of the Document Service (an import, a raw query) have no position.
+   * Until they get one they sit at one end of the list, which end depends on the database,
+   * so they get one at the next refresh rather than at the next move.
+   */ const healMissingPositions = async ()=>{
+        for (const uid of state.enabled){
+            await assignMissingPositions(uid);
+        }
+    };
+    const service = {
+        isOrderable,
+        refresh,
+        withOrderLock,
+        /**
+     * Whether the entries of a content type currently follow a custom order.
+     */ isEnabled (uid) {
+            refreshInBackgroundIfStale();
+            return state.enabled.has(uid);
+        },
+        async bootstrap () {
+            // Prevent initializing the service twice
+            if (state.isInitialized) {
+                return;
+            }
+            state.isInitialized = true;
+            await refresh();
+            await healMissingPositions();
+            strapi.documents.use(createDocumentMiddleware(service));
+        },
+        /**
+     * To call after the list view settings of a content type have been saved.
+     */ async applySettings (uid, settings) {
+            if (settings?.customOrder === true && isOrderable(uid)) {
+                await assignMissingPositions(uid);
+            }
+            await refresh();
+        },
+        getTopPosition,
+        assignMissingPositions,
+        /**
+     * Makes sure every row of a document shares the document's position. Needed when a row
+     * is created for an existing document, typically a new locale.
+     */ async syncDocumentPosition (uid, documentId) {
+            await withOrderLock(uid, async ()=>{
+                const position = await getPosition(uid, documentId) ?? await getTopPosition(uid);
+                await strapi.db.queryBuilder(uid).update({
+                    [POSITION_ATTRIBUTE]: position
+                }).where({
+                    documentId,
+                    [POSITION_ATTRIBUTE]: {
+                        $null: true
+                    }
+                }).execute();
+            });
+        },
+        /**
+     * Places a document right before or after another one.
+     *
+     * Writes go through the query builder on purpose: the position is not content, so
+     * moving a document must not run lifecycles nor touch `updatedAt`, which would flag
+     * every shifted entry as modified.
+     */ async move ({ uid, documentId, anchorId, placement }) {
+            const { positionColumn } = getTable(uid);
+            await withOrderLock(uid, async ()=>{
+                await assignMissingPositions(uid);
+                const from = await getPosition(uid, documentId);
+                const anchor = await getPosition(uid, anchorId);
+                if (from === undefined || anchor === undefined) {
+                    throw new errors.NotFoundError('Document not found');
+                }
+                const plan = computeMove({
+                    from,
+                    anchor,
+                    placement
+                });
+                if (!plan) {
+                    return;
+                }
+                if (plan.shift) {
+                    const { from: start, to: end, by } = plan.shift;
+                    const shiftedRows = strapi.db.queryBuilder(uid).where({
+                        [POSITION_ATTRIBUTE]: end === null ? {
+                            $gte: start
+                        } : {
+                            $gte: start,
+                            $lte: end
+                        }
+                    });
+                    await (by === 1 ? shiftedRows.increment(positionColumn) : shiftedRows.decrement(positionColumn)).execute();
+                }
+                await strapi.db.queryBuilder(uid).update({
+                    [POSITION_ATTRIBUTE]: plan.position
+                }).where({
+                    documentId
+                }).execute();
+            });
+        }
+    };
+    return service;
+};
+
+export { createCustomOrderService };
+//# sourceMappingURL=custom-order.mjs.map

package/dist/server/custom-order/services/custom-order.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-order.mjs","sources":["../../../../server/src/custom-order/services/custom-order.ts"],"sourcesContent":["import type { Core, UID } from '@strapi/types';\nimport { errors } from '@strapi/utils';\n\nimport storeUtils from '../../services/utils/store';\nimport { ENABLED_CACHE_TTL_MS, POSITION_ATTRIBUTE } from '../constants';\nimport { createDocumentMiddleware } from './document-middleware';\nimport { computeMove, type Placement } from './utils';\n\ninterface StoredConfiguration {\n  uid?: string;\n  settings?: { customOrder?: boolean };\n}\n\ntype PositionRow = { [POSITION_ATTRIBUTE]: number | string | null };\n\n/**\n * Core store key of the list view settings of a content type, see `services/utils/store.ts`.\n */\nconst CONFIGURATION_KEY_PREFIX = 'plugin_content_manager_configuration_content_types::';\n\nconst createCustomOrderService = ({ strapi }: { strapi: Core.Strapi }) => {\n  const state: {\n    enabled: Set<string>;\n    loadedAt: number;\n    refreshId: number;\n    isRefreshing: boolean;\n    isInitialized: boolean;\n  } = {\n    enabled: new Set(),\n    loadedAt: 0,\n    refreshId: 0,\n    isRefreshing: false,\n    isInitialized: false,\n  };\n\n  /**\n   * Only the content types that received the position attribute at register can be ordered.\n   */\n  const isOrderable = (uid: string) => {\n    const model = strapi.getModel(uid as UID.ContentType);\n\n    return model?.attributes?.[POSITION_ATTRIBUTE] !== undefined;\n  };\n\n  /**\n   * Reads which content types have custom order turned on in their list view settings.\n   * The setting lives in the database and can be changed at runtime, possibly from\n   * another instance, so it can't be read once and trusted forever.\n   */\n  const refresh = async () => {\n    state.refreshId += 1;\n    const refreshId = state.refreshId;\n\n    const configurations: StoredConfiguration[] = await storeUtils.getAllConfigurations();\n\n    // A more recent refresh has started in the meantime, its result is the one to keep\n    if (refreshId !== state.refreshId) {\n      return;\n    }\n\n    state.enabled = new Set(\n      configurations.flatMap(({ uid, settings }) =>\n        uid && settings?.customOrder === true && isOrderable(uid) ? [uid] : []\n      )\n    );\n    state.loadedAt = Date.now();\n  };\n\n  const refreshInBackgroundIfStale = () => {\n    if (state.isRefreshing || Date.now() - state.loadedAt < ENABLED_CACHE_TTL_MS) {\n      return;\n    }\n\n    state.isRefreshing = true;\n\n    refresh()\n      .then(() => healMissingPositions())\n      .catch((error: unknown) => {\n        strapi.log.warn('[custom-order] Could not refresh the list of ordered content types', {\n          error,\n        });\n      })\n      .finally(() => {\n        state.isRefreshing = false;\n      });\n  };\n\n  const getTable = (uid: UID.ContentType) => {\n    const { tableName, attributes } = strapi.db.metadata.get(uid);\n\n    const columnOf = (attributeName: string) => {\n      const attribute = attributes[attributeName];\n\n      return 'columnName' in attribute && attribute.columnName\n        ? attribute.columnName\n        : attributeName;\n    };\n\n    return {\n      tableName,\n      positionColumn: columnOf(POSITION_ATTRIBUTE),\n      documentIdColumn: columnOf('documentId'),\n    };\n  };\n\n  const toPosition = (value: number | string | null | undefined) =>\n    value === null || value === undefined ? undefined : Number(value);\n\n  /**\n   * Takes the lock on the order of a content type until the current transaction ends.\n   *\n   * The position of a new document and a move both read positions before writing them. Two\n   * of them at the same time would give two documents the same position, and nothing could\n   * tell those two apart afterwards. The lock is the row holding the list view settings of\n   * the content type, which exists whenever custom order is on. `FOR UPDATE` holds it until\n   * the transaction ends on PostgreSQL and MySQL. SQLite ignores it, its single connection\n   * serializes writers anyway.\n   */\n  const lockOrder = async (uid: UID.ContentType) => {\n    await strapi.db\n      .queryBuilder('strapi::core-store')\n      .select(['id'])\n      .where({ key: `${CONFIGURATION_KEY_PREFIX}${uid}` })\n      .forUpdate()\n      .first()\n      .execute();\n  };\n\n  /**\n   * Runs `fn` in a transaction, as the only writer of the order of a content type.\n   */\n  const withOrderLock = async <T>(uid: UID.ContentType, fn: () => Promise<T>): Promise<T> => {\n    const result: T = await strapi.db.transaction(async () => {\n      await lockOrder(uid);\n\n      return fn();\n    });\n\n    return result;\n  };\n\n  const hasRowWithoutPosition = async (uid: UID.ContentType) => {\n    const row = await strapi.db\n      .queryBuilder(uid)\n      .select(['id'])\n      .where({ [POSITION_ATTRIBUTE]: { $null: true } })\n      .first()\n      .execute<{ id: number } | undefined>();\n\n    return row !== undefined && row !== null;\n  };\n\n  /**\n   * Position of a document, or undefined if it has none (or does not exist).\n   */\n  const getPosition = async (uid: UID.ContentType, documentId: string) => {\n    const row = await strapi.db\n      .queryBuilder(uid)\n      .select([POSITION_ATTRIBUTE])\n      .where({ documentId, [POSITION_ATTRIBUTE]: { $notNull: true } })\n      .first()\n      .execute<PositionRow | undefined>();\n\n    return toPosition(row?.[POSITION_ATTRIBUTE]);\n  };\n\n  /**\n   * Position that puts a document before every other one.\n   */\n  const getTopPosition = async (uid: UID.ContentType) => {\n    const row = await strapi.db\n      .queryBuilder(uid)\n      .min(POSITION_ATTRIBUTE)\n      .first()\n      .execute<{ min: number | string | null } | undefined>();\n\n    const min = toPosition(row?.min);\n\n    return min === undefined ? 0 : min - 1;\n  };\n\n  /**\n   * Gives a position to every row that has none.\n   *\n   * - Rows of a document that already has a position (e.g. a locale created outside of the\n   *   Document Service) take that position.\n   * - If nothing is ordered yet, documents are ordered by creation, which is the order the\n   *   API returned so far.\n   * - Otherwise the remaining documents were created while custom order was off: like any\n   *   new entry they go on top, the most recent first.\n   */\n  const assignMissingPositions = async (uid: UID.ContentType) => {\n    // Checked before taking the lock: this runs in the background on every refresh\n    if (!(await hasRowWithoutPosition(uid))) {\n      return;\n    }\n\n    const { tableName, positionColumn, documentIdColumn } = getTable(uid);\n    const knex = strapi.db.connection;\n\n    await strapi.db.transaction(async ({ trx }) => {\n      await lockOrder(uid);\n\n      const table = () => strapi.db.getConnection(tableName).transacting(trx);\n\n      // Another writer may have given the positions in the meantime\n      const rowWithoutPosition = await table().whereNull(positionColumn).first('id');\n\n      if (!rowWithoutPosition) {\n        return;\n      }\n\n      // The updated table can't be read directly in a sub query of its own update on MySQL,\n      // the aggregated derived tables below are what make these statements portable.\n      const documentIdOfUpdatedRow = knex.ref(`${tableName}.${documentIdColumn}`);\n\n      const topRow: { min: number | string | null } | undefined = await table()\n        .min({ min: positionColumn })\n        .first();\n      const top = toPosition(topRow?.min);\n\n      if (top !== undefined) {\n        const knownPositions = strapi.db\n          .getConnection(tableName)\n          .select({ d: documentIdColumn })\n          .max({ p: positionColumn })\n          .whereNotNull(positionColumn)\n          .groupBy(documentIdColumn)\n          .as('x');\n\n        const positionOfDocument = knex\n          .queryBuilder()\n          .select('x.p')\n          .from(knownPositions)\n          .where('x.d', documentIdOfUpdatedRow);\n\n        await table()\n          .whereNull(positionColumn)\n          .update({ [positionColumn]: knex.raw('(?)', [positionOfDocument]) });\n      }\n\n      const firstRowIds = strapi.db\n        .getConnection(tableName)\n        .select({ d: documentIdColumn })\n        .min({ m: 'id' })\n        .groupBy(documentIdColumn)\n        .as('x');\n\n      const firstRowIdOfDocument = knex\n        .queryBuilder()\n        .select('x.m')\n        .from(firstRowIds)\n        .where('x.d', documentIdOfUpdatedRow);\n\n      await table()\n        .whereNull(positionColumn)\n        .update({\n          [positionColumn]:\n            top === undefined\n              ? knex.raw('(?)', [firstRowIdOfDocument])\n              : knex.raw('? - (?)', [top, firstRowIdOfDocument]),\n        });\n    });\n  };\n\n  /**\n   * Rows written outside of the Document Service (an import, a raw query) have no position.\n   * Until they get one they sit at one end of the list, which end depends on the database,\n   * so they get one at the next refresh rather than at the next move.\n   */\n  const healMissingPositions = async () => {\n    for (const uid of state.enabled) {\n      await assignMissingPositions(uid as UID.ContentType);\n    }\n  };\n\n  const service = {\n    isOrderable,\n\n    refresh,\n\n    withOrderLock,\n\n    /**\n     * Whether the entries of a content type currently follow a custom order.\n     */\n    isEnabled(uid: string) {\n      refreshInBackgroundIfStale();\n\n      return state.enabled.has(uid);\n    },\n\n    async bootstrap() {\n      // Prevent initializing the service twice\n      if (state.isInitialized) {\n        return;\n      }\n\n      state.isInitialized = true;\n\n      await refresh();\n      await healMissingPositions();\n\n      strapi.documents.use(createDocumentMiddleware(service));\n    },\n\n    /**\n     * To call after the list view settings of a content type have been saved.\n     */\n    async applySettings(uid: UID.ContentType, settings?: { customOrder?: boolean } | null) {\n      if (settings?.customOrder === true && isOrderable(uid)) {\n        await assignMissingPositions(uid);\n      }\n\n      await refresh();\n    },\n\n    getTopPosition,\n\n    assignMissingPositions,\n\n    /**\n     * Makes sure every row of a document shares the document's position. Needed when a row\n     * is created for an existing document, typically a new locale.\n     */\n    async syncDocumentPosition(uid: UID.ContentType, documentId: string) {\n      await withOrderLock(uid, async () => {\n        const position = (await getPosition(uid, documentId)) ?? (await getTopPosition(uid));\n\n        await strapi.db\n          .queryBuilder(uid)\n          .update({ [POSITION_ATTRIBUTE]: position })\n          .where({ documentId, [POSITION_ATTRIBUTE]: { $null: true } })\n          .execute();\n      });\n    },\n\n    /**\n     * Places a document right before or after another one.\n     *\n     * Writes go through the query builder on purpose: the position is not content, so\n     * moving a document must not run lifecycles nor touch `updatedAt`, which would flag\n     * every shifted entry as modified.\n     */\n    async move({\n      uid,\n      documentId,\n      anchorId,\n      placement,\n    }: {\n      uid: UID.ContentType;\n      documentId: string;\n      anchorId: string;\n      placement: Placement;\n    }) {\n      const { positionColumn } = getTable(uid);\n\n      await withOrderLock(uid, async () => {\n        await assignMissingPositions(uid);\n\n        const from = await getPosition(uid, documentId);\n        const anchor = await getPosition(uid, anchorId);\n\n        if (from === undefined || anchor === undefined) {\n          throw new errors.NotFoundError('Document not found');\n        }\n\n        const plan = computeMove({ from, anchor, placement });\n\n        if (!plan) {\n          return;\n        }\n\n        if (plan.shift) {\n          const { from: start, to: end, by } = plan.shift;\n\n          const shiftedRows = strapi.db.queryBuilder(uid).where({\n            [POSITION_ATTRIBUTE]: end === null ? { $gte: start } : { $gte: start, $lte: end },\n          });\n\n          await (\n            by === 1 ? shiftedRows.increment(positionColumn) : shiftedRows.decrement(positionColumn)\n          ).execute();\n        }\n\n        await strapi.db\n          .queryBuilder(uid)\n          .update({ [POSITION_ATTRIBUTE]: plan.position })\n          .where({ documentId })\n          .execute();\n      });\n    },\n  };\n\n  return service;\n};\n\nexport type CustomOrderService = ReturnType<typeof createCustomOrderService>;\n\nexport { createCustomOrderService };\n"],"names":["CONFIGURATION_KEY_PREFIX","createCustomOrderService","strapi","state","enabled","Set","loadedAt","refreshId","isRefreshing","isInitialized","isOrderable","uid","model","getModel","attributes","POSITION_ATTRIBUTE","undefined","refresh","configurations","storeUtils","getAllConfigurations","flatMap","settings","customOrder","Date","now","refreshInBackgroundIfStale","ENABLED_CACHE_TTL_MS","then","healMissingPositions","catch","error","log","warn","finally","getTable","tableName","db","metadata","get","columnOf","attributeName","attribute","columnName","positionColumn","documentIdColumn","toPosition","value","Number","lockOrder","queryBuilder","select","where","key","forUpdate","first","execute","withOrderLock","fn","result","transaction","hasRowWithoutPosition","row","$null","getPosition","documentId","$notNull","getTopPosition","min","assignMissingPositions","knex","connection","trx","table","getConnection","transacting","rowWithoutPosition","whereNull","documentIdOfUpdatedRow","ref","topRow","top","knownPositions","d","max","p","whereNotNull","groupBy","as","positionOfDocument","from","update","raw","firstRowIds","m","firstRowIdOfDocument","service","isEnabled","has","bootstrap","documents","use","createDocumentMiddleware","applySettings","syncDocumentPosition","position","move","anchorId","placement","anchor","errors","NotFoundError","plan","computeMove","shift","start","to","end","by","shiftedRows","$gte","$lte","increment","decrement"],"mappings":";;;;;;AAeA;;AAEC,IACD,MAAMA,wBAAAA,GAA2B,sDAAA;AAEjC,MAAMC,wBAAAA,GAA2B,CAAC,EAAEC,MAAM,EAA2B,GAAA;AACnE,IAAA,MAAMC,KAAAA,GAMF;AACFC,QAAAA,OAAAA,EAAS,IAAIC,GAAAA,EAAAA;QACbC,QAAAA,EAAU,CAAA;QACVC,SAAAA,EAAW,CAAA;QACXC,YAAAA,EAAc,KAAA;QACdC,aAAAA,EAAe;AACjB,KAAA;AAEA;;MAGA,MAAMC,cAAc,CAACC,GAAAA,GAAAA;QACnB,MAAMC,KAAAA,GAAQV,MAAAA,CAAOW,QAAQ,CAACF,GAAAA,CAAAA;AAE9B,QAAA,OAAOC,KAAAA,EAAOE,UAAAA,GAAaC,kBAAAA,CAAmB,KAAKC,SAAAA;AACrD,IAAA,CAAA;AAEA;;;;AAIC,MACD,MAAMC,OAAAA,GAAU,UAAA;AACdd,QAAAA,KAAAA,CAAMI,SAAS,IAAI,CAAA;QACnB,MAAMA,SAAAA,GAAYJ,MAAMI,SAAS;QAEjC,MAAMW,cAAAA,GAAwC,MAAMC,UAAAA,CAAWC,oBAAoB,EAAA;;QAGnF,IAAIb,SAAAA,KAAcJ,KAAAA,CAAMI,SAAS,EAAE;AACjC,YAAA;AACF,QAAA;AAEAJ,QAAAA,KAAAA,CAAMC,OAAO,GAAG,IAAIC,IAClBa,cAAAA,CAAeG,OAAO,CAAC,CAAC,EAAEV,GAAG,EAAEW,QAAQ,EAAE,GACvCX,GAAAA,IAAOW,UAAUC,WAAAA,KAAgB,IAAA,IAAQb,YAAYC,GAAAA,CAAAA,GAAO;AAACA,gBAAAA;AAAI,aAAA,GAAG,EAAE,CAAA,CAAA;QAG1ER,KAAAA,CAAMG,QAAQ,GAAGkB,IAAAA,CAAKC,GAAG,EAAA;AAC3B,IAAA,CAAA;AAEA,IAAA,MAAMC,0BAAAA,GAA6B,IAAA;QACjC,IAAIvB,KAAAA,CAAMK,YAAY,IAAIgB,IAAAA,CAAKC,GAAG,EAAA,GAAKtB,KAAAA,CAAMG,QAAQ,GAAGqB,oBAAAA,EAAsB;AAC5E,YAAA;AACF,QAAA;AAEAxB,QAAAA,KAAAA,CAAMK,YAAY,GAAG,IAAA;AAErBS,QAAAA,OAAAA,EAAAA,CACGW,IAAI,CAAC,IAAMC,oBAAAA,EAAAA,CAAAA,CACXC,KAAK,CAAC,CAACC,KAAAA,GAAAA;AACN7B,YAAAA,MAAAA,CAAO8B,GAAG,CAACC,IAAI,CAAC,oEAAA,EAAsE;AACpFF,gBAAAA;AACF,aAAA,CAAA;AACF,QAAA,CAAA,CAAA,CACCG,OAAO,CAAC,IAAA;AACP/B,YAAAA,KAAAA,CAAMK,YAAY,GAAG,KAAA;AACvB,QAAA,CAAA,CAAA;AACJ,IAAA,CAAA;AAEA,IAAA,MAAM2B,WAAW,CAACxB,GAAAA,GAAAA;AAChB,QAAA,MAAM,EAAEyB,SAAS,EAAEtB,UAAU,EAAE,GAAGZ,MAAAA,CAAOmC,EAAE,CAACC,QAAQ,CAACC,GAAG,CAAC5B,GAAAA,CAAAA;AAEzD,QAAA,MAAM6B,WAAW,CAACC,aAAAA,GAAAA;YAChB,MAAMC,SAAAA,GAAY5B,UAAU,CAAC2B,aAAAA,CAAc;AAE3C,YAAA,OAAO,gBAAgBC,SAAAA,IAAaA,SAAAA,CAAUC,UAAU,GACpDD,SAAAA,CAAUC,UAAU,GACpBF,aAAAA;AACN,QAAA,CAAA;QAEA,OAAO;AACLL,YAAAA,SAAAA;AACAQ,YAAAA,cAAAA,EAAgBJ,QAAAA,CAASzB,kBAAAA,CAAAA;AACzB8B,YAAAA,gBAAAA,EAAkBL,QAAAA,CAAS,YAAA;AAC7B,SAAA;AACF,IAAA,CAAA;IAEA,MAAMM,UAAAA,GAAa,CAACC,KAAAA,GAClBA,KAAAA,KAAU,QAAQA,KAAAA,KAAU/B,SAAAA,GAAYA,YAAYgC,MAAAA,CAAOD,KAAAA,CAAAA;AAE7D;;;;;;;;;MAUA,MAAME,YAAY,OAAOtC,GAAAA,GAAAA;AACvB,QAAA,MAAMT,OAAOmC,EAAE,CACZa,YAAY,CAAC,oBAAA,CAAA,CACbC,MAAM,CAAC;AAAC,YAAA;AAAK,SAAA,CAAA,CACbC,KAAK,CAAC;YAAEC,GAAAA,EAAK,CAAA,EAAGrD,2BAA2BW,GAAAA,CAAAA;AAAM,SAAA,CAAA,CACjD2C,SAAS,EAAA,CACTC,KAAK,EAAA,CACLC,OAAO,EAAA;AACZ,IAAA,CAAA;AAEA;;MAGA,MAAMC,aAAAA,GAAgB,OAAU9C,GAAAA,EAAsB+C,EAAAA,GAAAA;AACpD,QAAA,MAAMC,SAAY,MAAMzD,MAAAA,CAAOmC,EAAE,CAACuB,WAAW,CAAC,UAAA;AAC5C,YAAA,MAAMX,SAAAA,CAAUtC,GAAAA,CAAAA;YAEhB,OAAO+C,EAAAA,EAAAA;AACT,QAAA,CAAA,CAAA;QAEA,OAAOC,MAAAA;AACT,IAAA,CAAA;AAEA,IAAA,MAAME,wBAAwB,OAAOlD,GAAAA,GAAAA;QACnC,MAAMmD,GAAAA,GAAM,MAAM5D,MAAAA,CAAOmC,EAAE,CACxBa,YAAY,CAACvC,GAAAA,CAAAA,CACbwC,MAAM,CAAC;AAAC,YAAA;AAAK,SAAA,CAAA,CACbC,KAAK,CAAC;AAAE,YAAA,CAACrC,qBAAqB;gBAAEgD,KAAAA,EAAO;AAAK;SAAE,CAAA,CAC9CR,KAAK,GACLC,OAAO,EAAA;QAEV,OAAOM,GAAAA,KAAQ9C,aAAa8C,GAAAA,KAAQ,IAAA;AACtC,IAAA,CAAA;AAEA;;MAGA,MAAME,WAAAA,GAAc,OAAOrD,GAAAA,EAAsBsD,UAAAA,GAAAA;QAC/C,MAAMH,GAAAA,GAAM,MAAM5D,MAAAA,CAAOmC,EAAE,CACxBa,YAAY,CAACvC,GAAAA,CAAAA,CACbwC,MAAM,CAAC;AAACpC,YAAAA;AAAmB,SAAA,CAAA,CAC3BqC,KAAK,CAAC;AAAEa,YAAAA,UAAAA;AAAY,YAAA,CAAClD,qBAAqB;gBAAEmD,QAAAA,EAAU;AAAK;SAAE,CAAA,CAC7DX,KAAK,GACLC,OAAO,EAAA;QAEV,OAAOV,UAAAA,CAAWgB,GAAAA,GAAM/C,kBAAAA,CAAmB,CAAA;AAC7C,IAAA,CAAA;AAEA;;MAGA,MAAMoD,iBAAiB,OAAOxD,GAAAA,GAAAA;AAC5B,QAAA,MAAMmD,GAAAA,GAAM,MAAM5D,MAAAA,CAAOmC,EAAE,CACxBa,YAAY,CAACvC,GAAAA,CAAAA,CACbyD,GAAG,CAACrD,kBAAAA,CAAAA,CACJwC,KAAK,GACLC,OAAO,EAAA;QAEV,MAAMY,GAAAA,GAAMtB,WAAWgB,GAAAA,EAAKM,GAAAA,CAAAA;QAE5B,OAAOA,GAAAA,KAAQpD,SAAAA,GAAY,CAAA,GAAIoD,GAAAA,GAAM,CAAA;AACvC,IAAA,CAAA;AAEA;;;;;;;;;MAUA,MAAMC,yBAAyB,OAAO1D,GAAAA,GAAAA;;QAEpC,IAAI,CAAE,MAAMkD,qBAAAA,CAAsBlD,GAAAA,CAAAA,EAAO;AACvC,YAAA;AACF,QAAA;QAEA,MAAM,EAAEyB,SAAS,EAAEQ,cAAc,EAAEC,gBAAgB,EAAE,GAAGV,QAAAA,CAASxB,GAAAA,CAAAA;AACjE,QAAA,MAAM2D,IAAAA,GAAOpE,MAAAA,CAAOmC,EAAE,CAACkC,UAAU;QAEjC,MAAMrE,MAAAA,CAAOmC,EAAE,CAACuB,WAAW,CAAC,OAAO,EAAEY,GAAG,EAAE,GAAA;AACxC,YAAA,MAAMvB,SAAAA,CAAUtC,GAAAA,CAAAA;YAEhB,MAAM8D,KAAAA,GAAQ,IAAMvE,MAAAA,CAAOmC,EAAE,CAACqC,aAAa,CAACtC,SAAAA,CAAAA,CAAWuC,WAAW,CAACH,GAAAA,CAAAA;;AAGnE,YAAA,MAAMI,qBAAqB,MAAMH,KAAAA,EAAAA,CAAQI,SAAS,CAACjC,cAAAA,CAAAA,CAAgBW,KAAK,CAAC,IAAA,CAAA;AAEzE,YAAA,IAAI,CAACqB,kBAAAA,EAAoB;AACvB,gBAAA;AACF,YAAA;;;YAIA,MAAME,sBAAAA,GAAyBR,KAAKS,GAAG,CAAC,GAAG3C,SAAAA,CAAU,CAAC,EAAES,gBAAAA,CAAAA,CAAkB,CAAA;AAE1E,YAAA,MAAMmC,MAAAA,GAAsD,MAAMP,KAAAA,EAAAA,CAC/DL,GAAG,CAAC;gBAAEA,GAAAA,EAAKxB;AAAe,aAAA,CAAA,CAC1BW,KAAK,EAAA;YACR,MAAM0B,GAAAA,GAAMnC,WAAWkC,MAAAA,EAAQZ,GAAAA,CAAAA;AAE/B,YAAA,IAAIa,QAAQjE,SAAAA,EAAW;gBACrB,MAAMkE,cAAAA,GAAiBhF,OAAOmC,EAAE,CAC7BqC,aAAa,CAACtC,SAAAA,CAAAA,CACde,MAAM,CAAC;oBAAEgC,CAAAA,EAAGtC;AAAiB,iBAAA,CAAA,CAC7BuC,GAAG,CAAC;oBAAEC,CAAAA,EAAGzC;AAAe,iBAAA,CAAA,CACxB0C,YAAY,CAAC1C,cAAAA,CAAAA,CACb2C,OAAO,CAAC1C,gBAAAA,CAAAA,CACR2C,EAAE,CAAC,GAAA,CAAA;AAEN,gBAAA,MAAMC,kBAAAA,GAAqBnB,IAAAA,CACxBpB,YAAY,EAAA,CACZC,MAAM,CAAC,KAAA,CAAA,CACPuC,IAAI,CAACR,cAAAA,CAAAA,CACL9B,KAAK,CAAC,KAAA,EAAO0B,sBAAAA,CAAAA;AAEhB,gBAAA,MAAML,KAAAA,EAAAA,CACHI,SAAS,CAACjC,cAAAA,CAAAA,CACV+C,MAAM,CAAC;AAAE,oBAAA,CAAC/C,cAAAA,GAAiB0B,IAAAA,CAAKsB,GAAG,CAAC,KAAA,EAAO;AAACH,wBAAAA;AAAmB,qBAAA;AAAE,iBAAA,CAAA;AACtE,YAAA;YAEA,MAAMI,WAAAA,GAAc3F,OAAOmC,EAAE,CAC1BqC,aAAa,CAACtC,SAAAA,CAAAA,CACde,MAAM,CAAC;gBAAEgC,CAAAA,EAAGtC;AAAiB,aAAA,CAAA,CAC7BuB,GAAG,CAAC;gBAAE0B,CAAAA,EAAG;AAAK,aAAA,CAAA,CACdP,OAAO,CAAC1C,gBAAAA,CAAAA,CACR2C,EAAE,CAAC,GAAA,CAAA;AAEN,YAAA,MAAMO,oBAAAA,GAAuBzB,IAAAA,CAC1BpB,YAAY,EAAA,CACZC,MAAM,CAAC,KAAA,CAAA,CACPuC,IAAI,CAACG,WAAAA,CAAAA,CACLzC,KAAK,CAAC,KAAA,EAAO0B,sBAAAA,CAAAA;AAEhB,YAAA,MAAML,KAAAA,EAAAA,CACHI,SAAS,CAACjC,cAAAA,CAAAA,CACV+C,MAAM,CAAC;AACN,gBAAA,CAAC/C,iBACCqC,GAAAA,KAAQjE,YACJsD,IAAAA,CAAKsB,GAAG,CAAC,KAAA,EAAO;AAACG,oBAAAA;iBAAqB,CAAA,GACtCzB,IAAAA,CAAKsB,GAAG,CAAC,SAAA,EAAW;AAACX,oBAAAA,GAAAA;AAAKc,oBAAAA;AAAqB,iBAAA;AACvD,aAAA,CAAA;AACJ,QAAA,CAAA,CAAA;AACF,IAAA,CAAA;AAEA;;;;AAIC,MACD,MAAMlE,oBAAAA,GAAuB,UAAA;AAC3B,QAAA,KAAK,MAAMlB,GAAAA,IAAOR,KAAAA,CAAMC,OAAO,CAAE;AAC/B,YAAA,MAAMiE,sBAAAA,CAAuB1D,GAAAA,CAAAA;AAC/B,QAAA;AACF,IAAA,CAAA;AAEA,IAAA,MAAMqF,OAAAA,GAAU;AACdtF,QAAAA,WAAAA;AAEAO,QAAAA,OAAAA;AAEAwC,QAAAA,aAAAA;AAEA;;AAEC,QACDwC,WAAUtF,GAAW,EAAA;AACnBe,YAAAA,0BAAAA,EAAAA;AAEA,YAAA,OAAOvB,KAAAA,CAAMC,OAAO,CAAC8F,GAAG,CAACvF,GAAAA,CAAAA;AAC3B,QAAA,CAAA;QAEA,MAAMwF,SAAAA,CAAAA,GAAAA;;YAEJ,IAAIhG,KAAAA,CAAMM,aAAa,EAAE;AACvB,gBAAA;AACF,YAAA;AAEAN,YAAAA,KAAAA,CAAMM,aAAa,GAAG,IAAA;YAEtB,MAAMQ,OAAAA,EAAAA;YACN,MAAMY,oBAAAA,EAAAA;AAEN3B,YAAAA,MAAAA,CAAOkG,SAAS,CAACC,GAAG,CAACC,wBAAAA,CAAyBN,OAAAA,CAAAA,CAAAA;AAChD,QAAA,CAAA;AAEA;;AAEC,QACD,MAAMO,aAAAA,CAAAA,CAAc5F,GAAoB,EAAEW,QAA2C,EAAA;AACnF,YAAA,IAAIA,QAAAA,EAAUC,WAAAA,KAAgB,IAAA,IAAQb,WAAAA,CAAYC,GAAAA,CAAAA,EAAM;AACtD,gBAAA,MAAM0D,sBAAAA,CAAuB1D,GAAAA,CAAAA;AAC/B,YAAA;YAEA,MAAMM,OAAAA,EAAAA;AACR,QAAA,CAAA;AAEAkD,QAAAA,cAAAA;AAEAE,QAAAA,sBAAAA;AAEA;;;AAGC,QACD,MAAMmC,oBAAAA,CAAAA,CAAqB7F,GAAoB,EAAEsD,UAAkB,EAAA;AACjE,YAAA,MAAMR,cAAc9C,GAAAA,EAAK,UAAA;AACvB,gBAAA,MAAM8F,WAAW,MAAOzC,YAAYrD,GAAAA,EAAKsD,UAAAA,CAAAA,IAAiB,MAAME,cAAAA,CAAexD,GAAAA,CAAAA;AAE/E,gBAAA,MAAMT,OAAOmC,EAAE,CACZa,YAAY,CAACvC,GAAAA,CAAAA,CACbgF,MAAM,CAAC;AAAE,oBAAA,CAAC5E,qBAAqB0F;AAAS,iBAAA,CAAA,CACxCrD,KAAK,CAAC;AAAEa,oBAAAA,UAAAA;AAAY,oBAAA,CAAClD,qBAAqB;wBAAEgD,KAAAA,EAAO;AAAK;AAAE,iBAAA,CAAA,CAC1DP,OAAO,EAAA;AACZ,YAAA,CAAA,CAAA;AACF,QAAA,CAAA;AAEA;;;;;;QAOA,MAAMkD,IAAAA,CAAAA,CAAK,EACT/F,GAAG,EACHsD,UAAU,EACV0C,QAAQ,EACRC,SAAS,EAMV,EAAA;AACC,YAAA,MAAM,EAAEhE,cAAc,EAAE,GAAGT,QAAAA,CAASxB,GAAAA,CAAAA;AAEpC,YAAA,MAAM8C,cAAc9C,GAAAA,EAAK,UAAA;AACvB,gBAAA,MAAM0D,sBAAAA,CAAuB1D,GAAAA,CAAAA;gBAE7B,MAAM+E,IAAAA,GAAO,MAAM1B,WAAAA,CAAYrD,GAAAA,EAAKsD,UAAAA,CAAAA;gBACpC,MAAM4C,MAAAA,GAAS,MAAM7C,WAAAA,CAAYrD,GAAAA,EAAKgG,QAAAA,CAAAA;gBAEtC,IAAIjB,IAAAA,KAAS1E,SAAAA,IAAa6F,MAAAA,KAAW7F,SAAAA,EAAW;oBAC9C,MAAM,IAAI8F,MAAAA,CAAOC,aAAa,CAAC,oBAAA,CAAA;AACjC,gBAAA;AAEA,gBAAA,MAAMC,OAAOC,WAAAA,CAAY;AAAEvB,oBAAAA,IAAAA;AAAMmB,oBAAAA,MAAAA;AAAQD,oBAAAA;AAAU,iBAAA,CAAA;AAEnD,gBAAA,IAAI,CAACI,IAAAA,EAAM;AACT,oBAAA;AACF,gBAAA;gBAEA,IAAIA,IAAAA,CAAKE,KAAK,EAAE;oBACd,MAAM,EAAExB,IAAAA,EAAMyB,KAAK,EAAEC,EAAAA,EAAIC,GAAG,EAAEC,EAAE,EAAE,GAAGN,IAAAA,CAAKE,KAAK;oBAE/C,MAAMK,WAAAA,GAAcrH,OAAOmC,EAAE,CAACa,YAAY,CAACvC,GAAAA,CAAAA,CAAKyC,KAAK,CAAC;wBACpD,CAACrC,kBAAAA,GAAqBsG,GAAAA,KAAQ,IAAA,GAAO;4BAAEG,IAAAA,EAAML;yBAAM,GAAI;4BAAEK,IAAAA,EAAML,KAAAA;4BAAOM,IAAAA,EAAMJ;AAAI;AAClF,qBAAA,CAAA;AAEA,oBAAA,MAAM,CACJC,EAAAA,KAAO,CAAA,GAAIC,WAAAA,CAAYG,SAAS,CAAC9E,cAAAA,CAAAA,GAAkB2E,WAAAA,CAAYI,SAAS,CAAC/E,cAAAA,CAAc,EACvFY,OAAO,EAAA;AACX,gBAAA;AAEA,gBAAA,MAAMtD,OAAOmC,EAAE,CACZa,YAAY,CAACvC,GAAAA,CAAAA,CACbgF,MAAM,CAAC;oBAAE,CAAC5E,kBAAAA,GAAqBiG,IAAAA,CAAKP;AAAS,iBAAA,CAAA,CAC7CrD,KAAK,CAAC;AAAEa,oBAAAA;AAAW,iBAAA,CAAA,CACnBT,OAAO,EAAA;AACZ,YAAA,CAAA,CAAA;AACF,QAAA;AACF,KAAA;IAEA,OAAOwC,OAAAA;AACT;;;;"}

package/dist/server/custom-order/services/document-middleware.js

@@ -0,0 +1,83 @@
+'use strict';
+
+var _ = require('lodash');
+var constants = require('../constants.js');
+var utils = require('./utils.js');
+
+const setParams = (context, params)=>{
+    Object.assign(context, {
+        params
+    });
+};
+const DEFAULT_SORT = {
+    [constants.POSITION_ATTRIBUTE]: 'asc'
+};
+/**
+ * Keeps the Document Service in line with the custom order of a content type:
+ * documents come back in that order unless a sort is requested, new documents go on top,
+ * and the position can only be changed by moving a document.
+ */ const createDocumentMiddleware = (customOrder)=>async (context, next)=>{
+        if (!customOrder.isOrderable(context.uid)) {
+            return next();
+        }
+        let params = context.params ?? {};
+        // The position is not content: whatever a client puts in the data is dropped, whether
+        // custom order is on for the content type or not. A value written while it is off would
+        // otherwise be taken for a real position once it is turned on.
+        if (params.data && constants.POSITION_ATTRIBUTE in params.data) {
+            params = {
+                ...params,
+                data: _.omit(params.data, constants.POSITION_ATTRIBUTE)
+            };
+            setParams(context, params);
+        }
+        if (!customOrder.isEnabled(context.uid)) {
+            return next();
+        }
+        switch(context.action){
+            case 'findMany':
+            case 'findFirst':
+                {
+                    const sort = utils.withTieBreaker(utils.isEmptySort(params.sort) ? DEFAULT_SORT : params.sort);
+                    if (sort !== params.sort) {
+                        setParams(context, {
+                            ...params,
+                            sort
+                        });
+                    }
+                    return next();
+                }
+            case 'create':
+            case 'clone':
+                {
+                    // The top position is read then written with the document: under the lock, so that
+                    // two new documents can't get the same one, and in one transaction with the insert.
+                    return customOrder.withOrderLock(context.uid, async ()=>{
+                        const position = await customOrder.getTopPosition(context.uid);
+                        setParams(context, {
+                            ...params,
+                            data: {
+                                ...params.data,
+                                [constants.POSITION_ATTRIBUTE]: position
+                            }
+                        });
+                        return next();
+                    });
+                }
+            case 'update':
+                {
+                    const result = await next();
+                    const entry = result;
+                    // Updating a locale that does not exist yet creates a row without position
+                    if (entry && params.documentId && (entry[constants.POSITION_ATTRIBUTE] ?? null) === null) {
+                        await customOrder.syncDocumentPosition(context.uid, params.documentId);
+                    }
+                    return result;
+                }
+            default:
+                return next();
+        }
+    };
+
+exports.createDocumentMiddleware = createDocumentMiddleware;
+//# sourceMappingURL=document-middleware.js.map

package/dist/server/custom-order/services/document-middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-middleware.js","sources":["../../../../server/src/custom-order/services/document-middleware.ts"],"sourcesContent":["import type { Modules, UID } from '@strapi/types';\nimport { omit } from 'lodash';\n\nimport { POSITION_ATTRIBUTE } from '../constants';\nimport { isEmptySort, withTieBreaker } from './utils';\n\ntype Context = Modules.Documents.Middleware.Context;\n\ninterface Params {\n  sort?: unknown;\n  data?: Record<string, unknown>;\n  documentId?: string;\n}\n\ninterface CustomOrder {\n  isOrderable(uid: string): boolean;\n  isEnabled(uid: string): boolean;\n  getTopPosition(uid: UID.ContentType): Promise<number>;\n  syncDocumentPosition(uid: UID.ContentType, documentId: string): Promise<void>;\n  withOrderLock<T>(uid: UID.ContentType, fn: () => Promise<T>): Promise<T>;\n}\n\nconst setParams = (context: Context, params: Params) => {\n  Object.assign(context, { params });\n};\n\nconst DEFAULT_SORT = { [POSITION_ATTRIBUTE]: 'asc' };\n\n/**\n * Keeps the Document Service in line with the custom order of a content type:\n * documents come back in that order unless a sort is requested, new documents go on top,\n * and the position can only be changed by moving a document.\n */\nconst createDocumentMiddleware =\n  (customOrder: CustomOrder): Modules.Documents.Middleware.Middleware =>\n  async (context, next) => {\n    if (!customOrder.isOrderable(context.uid)) {\n      return next();\n    }\n\n    let params = (context.params ?? {}) as Params;\n\n    // The position is not content: whatever a client puts in the data is dropped, whether\n    // custom order is on for the content type or not. A value written while it is off would\n    // otherwise be taken for a real position once it is turned on.\n    if (params.data && POSITION_ATTRIBUTE in params.data) {\n      params = { ...params, data: omit(params.data, POSITION_ATTRIBUTE) };\n      setParams(context, params);\n    }\n\n    if (!customOrder.isEnabled(context.uid)) {\n      return next();\n    }\n\n    switch (context.action) {\n      case 'findMany':\n      case 'findFirst': {\n        const sort = withTieBreaker(isEmptySort(params.sort) ? DEFAULT_SORT : params.sort);\n\n        if (sort !== params.sort) {\n          setParams(context, { ...params, sort });\n        }\n\n        return next();\n      }\n\n      case 'create':\n      case 'clone': {\n        // The top position is read then written with the document: under the lock, so that\n        // two new documents can't get the same one, and in one transaction with the insert.\n        return customOrder.withOrderLock(context.uid, async () => {\n          const position = await customOrder.getTopPosition(context.uid);\n\n          setParams(context, {\n            ...params,\n            data: { ...params.data, [POSITION_ATTRIBUTE]: position },\n          });\n\n          return next();\n        });\n      }\n\n      case 'update': {\n        const result = await next();\n        const entry = result as Record<string, unknown> | null | undefined;\n\n        // Updating a locale that does not exist yet creates a row without position\n        if (entry && params.documentId && (entry[POSITION_ATTRIBUTE] ?? null) === null) {\n          await customOrder.syncDocumentPosition(context.uid, params.documentId);\n        }\n\n        return result;\n      }\n\n      default:\n        return next();\n    }\n  };\n\nexport { createDocumentMiddleware };\n"],"names":["setParams","context","params","Object","assign","DEFAULT_SORT","POSITION_ATTRIBUTE","createDocumentMiddleware","customOrder","next","isOrderable","uid","data","omit","isEnabled","action","sort","withTieBreaker","isEmptySort","withOrderLock","position","getTopPosition","result","entry","documentId","syncDocumentPosition"],"mappings":";;;;;;AAsBA,MAAMA,SAAAA,GAAY,CAACC,OAAAA,EAAkBC,MAAAA,GAAAA;IACnCC,MAAAA,CAAOC,MAAM,CAACH,OAAAA,EAAS;AAAEC,QAAAA;AAAO,KAAA,CAAA;AAClC,CAAA;AAEA,MAAMG,YAAAA,GAAe;AAAE,IAAA,CAACC,+BAAqB;AAAM,CAAA;AAEnD;;;;AAIC,IACD,MAAMC,wBAAAA,GACJ,CAACC,WAAAA,GACD,OAAOP,OAAAA,EAASQ,IAAAA,GAAAA;AACd,QAAA,IAAI,CAACD,WAAAA,CAAYE,WAAW,CAACT,OAAAA,CAAQU,GAAG,CAAA,EAAG;YACzC,OAAOF,IAAAA,EAAAA;AACT,QAAA;AAEA,QAAA,IAAIP,MAAAA,GAAUD,OAAAA,CAAQC,MAAM,IAAI,EAAC;;;;AAKjC,QAAA,IAAIA,OAAOU,IAAI,IAAIN,4BAAAA,IAAsBJ,MAAAA,CAAOU,IAAI,EAAE;YACpDV,MAAAA,GAAS;AAAE,gBAAA,GAAGA,MAAM;gBAAEU,IAAAA,EAAMC,MAAAA,CAAKX,MAAAA,CAAOU,IAAI,EAAEN,4BAAAA;AAAoB,aAAA;AAClEN,YAAAA,SAAAA,CAAUC,OAAAA,EAASC,MAAAA,CAAAA;AACrB,QAAA;AAEA,QAAA,IAAI,CAACM,WAAAA,CAAYM,SAAS,CAACb,OAAAA,CAAQU,GAAG,CAAA,EAAG;YACvC,OAAOF,IAAAA,EAAAA;AACT,QAAA;AAEA,QAAA,OAAQR,QAAQc,MAAM;YACpB,KAAK,UAAA;YACL,KAAK,WAAA;AAAa,gBAAA;oBAChB,MAAMC,IAAAA,GAAOC,qBAAeC,iBAAAA,CAAYhB,MAAAA,CAAOc,IAAI,CAAA,GAAIX,YAAAA,GAAeH,OAAOc,IAAI,CAAA;oBAEjF,IAAIA,IAAAA,KAASd,MAAAA,CAAOc,IAAI,EAAE;AACxBhB,wBAAAA,SAAAA,CAAUC,OAAAA,EAAS;AAAE,4BAAA,GAAGC,MAAM;AAAEc,4BAAAA;AAAK,yBAAA,CAAA;AACvC,oBAAA;oBAEA,OAAOP,IAAAA,EAAAA;AACT,gBAAA;YAEA,KAAK,QAAA;YACL,KAAK,OAAA;AAAS,gBAAA;;;AAGZ,oBAAA,OAAOD,WAAAA,CAAYW,aAAa,CAAClB,OAAAA,CAAQU,GAAG,EAAE,UAAA;AAC5C,wBAAA,MAAMS,WAAW,MAAMZ,WAAAA,CAAYa,cAAc,CAACpB,QAAQU,GAAG,CAAA;AAE7DX,wBAAAA,SAAAA,CAAUC,OAAAA,EAAS;AACjB,4BAAA,GAAGC,MAAM;4BACTU,IAAAA,EAAM;AAAE,gCAAA,GAAGV,OAAOU,IAAI;AAAE,gCAAA,CAACN,+BAAqBc;AAAS;AACzD,yBAAA,CAAA;wBAEA,OAAOX,IAAAA,EAAAA;AACT,oBAAA,CAAA,CAAA;AACF,gBAAA;YAEA,KAAK,QAAA;AAAU,gBAAA;AACb,oBAAA,MAAMa,SAAS,MAAMb,IAAAA,EAAAA;AACrB,oBAAA,MAAMc,KAAAA,GAAQD,MAAAA;;AAGd,oBAAA,IAAIC,KAAAA,IAASrB,MAAAA,CAAOsB,UAAU,IAAI,CAACD,KAAK,CAACjB,4BAAAA,CAAmB,IAAI,IAAG,MAAO,IAAA,EAAM;AAC9E,wBAAA,MAAME,YAAYiB,oBAAoB,CAACxB,QAAQU,GAAG,EAAET,OAAOsB,UAAU,CAAA;AACvE,oBAAA;oBAEA,OAAOF,MAAAA;AACT,gBAAA;AAEA,YAAA;gBACE,OAAOb,IAAAA,EAAAA;AACX;AACF,IAAA;;;;"}

package/dist/server/custom-order/services/document-middleware.mjs

@@ -0,0 +1,81 @@
+import { omit } from 'lodash';
+import { POSITION_ATTRIBUTE } from '../constants.mjs';
+import { withTieBreaker, isEmptySort } from './utils.mjs';
+
+const setParams = (context, params)=>{
+    Object.assign(context, {
+        params
+    });
+};
+const DEFAULT_SORT = {
+    [POSITION_ATTRIBUTE]: 'asc'
+};
+/**
+ * Keeps the Document Service in line with the custom order of a content type:
+ * documents come back in that order unless a sort is requested, new documents go on top,
+ * and the position can only be changed by moving a document.
+ */ const createDocumentMiddleware = (customOrder)=>async (context, next)=>{
+        if (!customOrder.isOrderable(context.uid)) {
+            return next();
+        }
+        let params = context.params ?? {};
+        // The position is not content: whatever a client puts in the data is dropped, whether
+        // custom order is on for the content type or not. A value written while it is off would
+        // otherwise be taken for a real position once it is turned on.
+        if (params.data && POSITION_ATTRIBUTE in params.data) {
+            params = {
+                ...params,
+                data: omit(params.data, POSITION_ATTRIBUTE)
+            };
+            setParams(context, params);
+        }
+        if (!customOrder.isEnabled(context.uid)) {
+            return next();
+        }
+        switch(context.action){
+            case 'findMany':
+            case 'findFirst':
+                {
+                    const sort = withTieBreaker(isEmptySort(params.sort) ? DEFAULT_SORT : params.sort);
+                    if (sort !== params.sort) {
+                        setParams(context, {
+                            ...params,
+                            sort
+                        });
+                    }
+                    return next();
+                }
+            case 'create':
+            case 'clone':
+                {
+                    // The top position is read then written with the document: under the lock, so that
+                    // two new documents can't get the same one, and in one transaction with the insert.
+                    return customOrder.withOrderLock(context.uid, async ()=>{
+                        const position = await customOrder.getTopPosition(context.uid);
+                        setParams(context, {
+                            ...params,
+                            data: {
+                                ...params.data,
+                                [POSITION_ATTRIBUTE]: position
+                            }
+                        });
+                        return next();
+                    });
+                }
+            case 'update':
+                {
+                    const result = await next();
+                    const entry = result;
+                    // Updating a locale that does not exist yet creates a row without position
+                    if (entry && params.documentId && (entry[POSITION_ATTRIBUTE] ?? null) === null) {
+                        await customOrder.syncDocumentPosition(context.uid, params.documentId);
+                    }
+                    return result;
+                }
+            default:
+                return next();
+        }
+    };
+
+export { createDocumentMiddleware };
+//# sourceMappingURL=document-middleware.mjs.map

package/dist/server/custom-order/services/document-middleware.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-middleware.mjs","sources":["../../../../server/src/custom-order/services/document-middleware.ts"],"sourcesContent":["import type { Modules, UID } from '@strapi/types';\nimport { omit } from 'lodash';\n\nimport { POSITION_ATTRIBUTE } from '../constants';\nimport { isEmptySort, withTieBreaker } from './utils';\n\ntype Context = Modules.Documents.Middleware.Context;\n\ninterface Params {\n  sort?: unknown;\n  data?: Record<string, unknown>;\n  documentId?: string;\n}\n\ninterface CustomOrder {\n  isOrderable(uid: string): boolean;\n  isEnabled(uid: string): boolean;\n  getTopPosition(uid: UID.ContentType): Promise<number>;\n  syncDocumentPosition(uid: UID.ContentType, documentId: string): Promise<void>;\n  withOrderLock<T>(uid: UID.ContentType, fn: () => Promise<T>): Promise<T>;\n}\n\nconst setParams = (context: Context, params: Params) => {\n  Object.assign(context, { params });\n};\n\nconst DEFAULT_SORT = { [POSITION_ATTRIBUTE]: 'asc' };\n\n/**\n * Keeps the Document Service in line with the custom order of a content type:\n * documents come back in that order unless a sort is requested, new documents go on top,\n * and the position can only be changed by moving a document.\n */\nconst createDocumentMiddleware =\n  (customOrder: CustomOrder): Modules.Documents.Middleware.Middleware =>\n  async (context, next) => {\n    if (!customOrder.isOrderable(context.uid)) {\n      return next();\n    }\n\n    let params = (context.params ?? {}) as Params;\n\n    // The position is not content: whatever a client puts in the data is dropped, whether\n    // custom order is on for the content type or not. A value written while it is off would\n    // otherwise be taken for a real position once it is turned on.\n    if (params.data && POSITION_ATTRIBUTE in params.data) {\n      params = { ...params, data: omit(params.data, POSITION_ATTRIBUTE) };\n      setParams(context, params);\n    }\n\n    if (!customOrder.isEnabled(context.uid)) {\n      return next();\n    }\n\n    switch (context.action) {\n      case 'findMany':\n      case 'findFirst': {\n        const sort = withTieBreaker(isEmptySort(params.sort) ? DEFAULT_SORT : params.sort);\n\n        if (sort !== params.sort) {\n          setParams(context, { ...params, sort });\n        }\n\n        return next();\n      }\n\n      case 'create':\n      case 'clone': {\n        // The top position is read then written with the document: under the lock, so that\n        // two new documents can't get the same one, and in one transaction with the insert.\n        return customOrder.withOrderLock(context.uid, async () => {\n          const position = await customOrder.getTopPosition(context.uid);\n\n          setParams(context, {\n            ...params,\n            data: { ...params.data, [POSITION_ATTRIBUTE]: position },\n          });\n\n          return next();\n        });\n      }\n\n      case 'update': {\n        const result = await next();\n        const entry = result as Record<string, unknown> | null | undefined;\n\n        // Updating a locale that does not exist yet creates a row without position\n        if (entry && params.documentId && (entry[POSITION_ATTRIBUTE] ?? null) === null) {\n          await customOrder.syncDocumentPosition(context.uid, params.documentId);\n        }\n\n        return result;\n      }\n\n      default:\n        return next();\n    }\n  };\n\nexport { createDocumentMiddleware };\n"],"names":["setParams","context","params","Object","assign","DEFAULT_SORT","POSITION_ATTRIBUTE","createDocumentMiddleware","customOrder","next","isOrderable","uid","data","omit","isEnabled","action","sort","withTieBreaker","isEmptySort","withOrderLock","position","getTopPosition","result","entry","documentId","syncDocumentPosition"],"mappings":";;;;AAsBA,MAAMA,SAAAA,GAAY,CAACC,OAAAA,EAAkBC,MAAAA,GAAAA;IACnCC,MAAAA,CAAOC,MAAM,CAACH,OAAAA,EAAS;AAAEC,QAAAA;AAAO,KAAA,CAAA;AAClC,CAAA;AAEA,MAAMG,YAAAA,GAAe;AAAE,IAAA,CAACC,qBAAqB;AAAM,CAAA;AAEnD;;;;AAIC,IACD,MAAMC,wBAAAA,GACJ,CAACC,WAAAA,GACD,OAAOP,OAAAA,EAASQ,IAAAA,GAAAA;AACd,QAAA,IAAI,CAACD,WAAAA,CAAYE,WAAW,CAACT,OAAAA,CAAQU,GAAG,CAAA,EAAG;YACzC,OAAOF,IAAAA,EAAAA;AACT,QAAA;AAEA,QAAA,IAAIP,MAAAA,GAAUD,OAAAA,CAAQC,MAAM,IAAI,EAAC;;;;AAKjC,QAAA,IAAIA,OAAOU,IAAI,IAAIN,kBAAAA,IAAsBJ,MAAAA,CAAOU,IAAI,EAAE;YACpDV,MAAAA,GAAS;AAAE,gBAAA,GAAGA,MAAM;gBAAEU,IAAAA,EAAMC,IAAAA,CAAKX,MAAAA,CAAOU,IAAI,EAAEN,kBAAAA;AAAoB,aAAA;AAClEN,YAAAA,SAAAA,CAAUC,OAAAA,EAASC,MAAAA,CAAAA;AACrB,QAAA;AAEA,QAAA,IAAI,CAACM,WAAAA,CAAYM,SAAS,CAACb,OAAAA,CAAQU,GAAG,CAAA,EAAG;YACvC,OAAOF,IAAAA,EAAAA;AACT,QAAA;AAEA,QAAA,OAAQR,QAAQc,MAAM;YACpB,KAAK,UAAA;YACL,KAAK,WAAA;AAAa,gBAAA;oBAChB,MAAMC,IAAAA,GAAOC,eAAeC,WAAAA,CAAYhB,MAAAA,CAAOc,IAAI,CAAA,GAAIX,YAAAA,GAAeH,OAAOc,IAAI,CAAA;oBAEjF,IAAIA,IAAAA,KAASd,MAAAA,CAAOc,IAAI,EAAE;AACxBhB,wBAAAA,SAAAA,CAAUC,OAAAA,EAAS;AAAE,4BAAA,GAAGC,MAAM;AAAEc,4BAAAA;AAAK,yBAAA,CAAA;AACvC,oBAAA;oBAEA,OAAOP,IAAAA,EAAAA;AACT,gBAAA;YAEA,KAAK,QAAA;YACL,KAAK,OAAA;AAAS,gBAAA;;;AAGZ,oBAAA,OAAOD,WAAAA,CAAYW,aAAa,CAAClB,OAAAA,CAAQU,GAAG,EAAE,UAAA;AAC5C,wBAAA,MAAMS,WAAW,MAAMZ,WAAAA,CAAYa,cAAc,CAACpB,QAAQU,GAAG,CAAA;AAE7DX,wBAAAA,SAAAA,CAAUC,OAAAA,EAAS;AACjB,4BAAA,GAAGC,MAAM;4BACTU,IAAAA,EAAM;AAAE,gCAAA,GAAGV,OAAOU,IAAI;AAAE,gCAAA,CAACN,qBAAqBc;AAAS;AACzD,yBAAA,CAAA;wBAEA,OAAOX,IAAAA,EAAAA;AACT,oBAAA,CAAA,CAAA;AACF,gBAAA;YAEA,KAAK,QAAA;AAAU,gBAAA;AACb,oBAAA,MAAMa,SAAS,MAAMb,IAAAA,EAAAA;AACrB,oBAAA,MAAMc,KAAAA,GAAQD,MAAAA;;AAGd,oBAAA,IAAIC,KAAAA,IAASrB,MAAAA,CAAOsB,UAAU,IAAI,CAACD,KAAK,CAACjB,kBAAAA,CAAmB,IAAI,IAAG,MAAO,IAAA,EAAM;AAC9E,wBAAA,MAAME,YAAYiB,oBAAoB,CAACxB,QAAQU,GAAG,EAAET,OAAOsB,UAAU,CAAA;AACvE,oBAAA;oBAEA,OAAOF,MAAAA;AACT,gBAAA;AAEA,YAAA;gBACE,OAAOb,IAAAA,EAAAA;AACX;AACF,IAAA;;;;"}

package/dist/server/custom-order/services/index.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var customOrder = require('./custom-order.js');
+
+const services = {
+    'custom-order': customOrder.createCustomOrderService
+};
+
+exports.services = services;
+//# sourceMappingURL=index.js.map

package/dist/server/custom-order/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../../server/src/custom-order/services/index.ts"],"sourcesContent":["import type { Plugin } from '@strapi/types';\nimport { createCustomOrderService } from './custom-order';\n\nexport const services = {\n  'custom-order': createCustomOrderService,\n} satisfies Plugin.LoadedPlugin['services'];\n"],"names":["services","createCustomOrderService"],"mappings":";;;;MAGaA,QAAAA,GAAW;IACtB,cAAA,EAAgBC;AAClB;;;;"}

package/dist/server/custom-order/services/index.mjs

@@ -0,0 +1,8 @@
+import { createCustomOrderService } from './custom-order.mjs';
+
+const services = {
+    'custom-order': createCustomOrderService
+};
+
+export { services };
+//# sourceMappingURL=index.mjs.map

package/dist/server/custom-order/services/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../../../../server/src/custom-order/services/index.ts"],"sourcesContent":["import type { Plugin } from '@strapi/types';\nimport { createCustomOrderService } from './custom-order';\n\nexport const services = {\n  'custom-order': createCustomOrderService,\n} satisfies Plugin.LoadedPlugin['services'];\n"],"names":["services","createCustomOrderService"],"mappings":";;MAGaA,QAAAA,GAAW;IACtB,cAAA,EAAgBC;AAClB;;;;"}