@strapi/content-manager 5.61.0 → 5.62.0

package/dist/admin/hooks/useDocument.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"useDocument.mjs","sources":["../../../admin/src/hooks/useDocument.ts"],"sourcesContent":["/**\n * This hook doesn't use a context provider because we fetch directly from the server,\n * this sounds expensive but actually, it's really not. Because we have redux-toolkit-query\n * being a cache layer so if nothing invalidates the cache, we don't fetch again.\n *\n * The network is deduplicated, but the work done inside the hook is not: it can be mounted\n * by hundreds of fields at once, so anything expensive it derives must be cached outside of\n * the hook instance (see `getValidationSchema`).\n */\n\nimport * as React from 'react';\n\nimport {\n  useNotification,\n  useAPIErrorHandler,\n  useQueryParams,\n  FormErrors,\n  getYupValidationErrors,\n  useForm,\n} from '@strapi/admin/strapi-admin';\nimport { useIntl } from 'react-intl';\nimport { useParams } from 'react-router-dom';\nimport { ValidationError } from 'yup';\n\nimport { SINGLE_TYPES } from '../constants/collections';\nimport { type AnyData, transformDocument } from '../pages/EditView/utils/data';\nimport { createDefaultForm } from '../pages/EditView/utils/forms';\nimport { useGetDocumentQuery } from '../services/documents';\nimport { buildValidParams } from '../utils/api';\nimport { createYupSchema } from '../utils/validation';\n\nimport { useContentTypeSchema, ComponentsDictionary } from './useContentTypeSchema';\nimport { useDocumentLayout } from './useDocumentLayout';\n\nimport type { FindOne } from '../../../shared/contracts/collection-types';\nimport type { ContentType } from '../../../shared/contracts/content-types';\nimport type { Modules } from '@strapi/types';\n\ninterface UseDocumentArgs {\n  collectionType: string;\n  model: string;\n  documentId?: string;\n  params?: object;\n}\n\ntype UseDocumentOpts = Parameters<typeof useGetDocumentQuery>[1];\n\ntype Document = FindOne.Response['data'];\n\ntype Schema = ContentType;\n\ntype ValidationSchema = ReturnType<typeof createYupSchema>;\n\n// Building the yup schema of a model clones a schema for every nested component and dynamic\n// zone: on large models it takes seconds and gigabytes. `schema` and `components` identities\n// are shared across hook instances (see `useContentTypeSchema`), so build it once per pair,\n// and only when something actually validates.\nconst validationSchemaCache = new WeakMap<\n  Schema,\n  WeakMap<ComponentsDictionary, ValidationSchema>\n>();\n\nconst getValidationSchema = (schema: Schema, components: ComponentsDictionary) => {\n  let byComponents = validationSchemaCache.get(schema);\n\n  if (!byComponents) {\n    byComponents = new WeakMap();\n    validationSchemaCache.set(schema, byComponents);\n  }\n\n  let validationSchema = byComponents.get(components);\n\n  if (!validationSchema) {\n    validationSchema = createYupSchema(schema.attributes, components);\n    byComponents.set(components, validationSchema);\n  }\n\n  return validationSchema;\n};\n\ntype UseDocument = (\n  args: UseDocumentArgs,\n  opts?: UseDocumentOpts\n) => {\n  /**\n   * These are the schemas of the components used in the content type, organised\n   * by their uid.\n   */\n  components: ComponentsDictionary;\n  document?: Document;\n  meta?: FindOne.Response['meta'];\n  isLoading: boolean;\n  /**\n   * This is the schema of the content type, it is not the same as the layout.\n   */\n  schema?: Schema;\n  schemas?: Schema[];\n  hasError?: boolean;\n  refetch: () => void;\n  validate: (document: Document) => null | FormErrors;\n  /**\n   * Get the document's title\n   */\n  getTitle: (mainField: string) => string;\n  /**\n   * Get the initial form values for the document\n   */\n  getInitialFormValues: (isCreatingDocument?: boolean) => AnyData | undefined;\n};\n\n/**\n * Mirrors the server's `isLocalizedAttribute` in\n * `packages/plugins/i18n/server/src/services/content-types.ts`: an attribute\n * counts as localized only when `pluginOptions.i18n.localized` is explicitly\n * `true`. Both `false` and `undefined` mean \"non-localized\" — important here\n * because attributes created without the i18n plugin omit the field entirely,\n * and we still want them inherited when creating a new locale draft.\n */\nconst isLocalizedAttribute = (attribute: { pluginOptions?: object }): boolean => {\n  // `pluginOptions` on the base attribute is typed as `object`, so we have to\n  // narrow it to the i18n-specific shape here.\n  const i18nOptions = attribute.pluginOptions as { i18n?: { localized?: boolean } } | undefined;\n  return i18nOptions?.i18n?.localized === true;\n};\n\n/* -------------------------------------------------------------------------------------------------\n * useDocument\n * -----------------------------------------------------------------------------------------------*/\n\n/**\n * @alpha\n * @public\n * @description Returns a document based on the model, collection type & id passed as arguments.\n * Also extracts its schema from the redux cache to be used for creating a validation schema.\n * @example\n * ```tsx\n * const { id, model, collectionType } = useParams<{ id: string; model: string; collectionType: string }>();\n *\n * if(!model || !collectionType) return null;\n *\n * const { document, isLoading, validate } = useDocument({ documentId: id, model, collectionType, params: { locale: 'en-GB' } })\n * const { update } = useDocumentActions()\n *\n * const onSubmit = async (document: Document) => {\n *  const errors = validate(document);\n *\n *  if(errors) {\n *      // handle errors\n *  }\n *\n *  await update({ collectionType, model, id }, document)\n * }\n * ```\n *\n */\nconst useDocument: UseDocument = (args, opts) => {\n  const { toggleNotification } = useNotification();\n  const { _unstableFormatAPIError: formatAPIError } = useAPIErrorHandler();\n  const { formatMessage } = useIntl();\n\n  const {\n    currentData: data,\n    isLoading: isLoadingDocument,\n    isFetching: isFetchingDocument,\n    error,\n    refetch,\n  } = useGetDocumentQuery(args, {\n    ...opts,\n    skip: (!args.documentId && args.collectionType !== SINGLE_TYPES) || opts?.skip,\n  });\n  const document = data?.data;\n  const meta = data?.meta;\n\n  const {\n    components,\n    schema,\n    schemas,\n    isLoading: isLoadingSchema,\n  } = useContentTypeSchema(args.model);\n  const isSingleType = schema?.kind === 'singleType';\n\n  const getTitle = React.useCallback(\n    (mainField: string) => {\n      // Always use mainField if it's not an id\n      if (mainField !== 'id' && document?.[mainField]) {\n        return document[mainField];\n      }\n\n      // When it's a singleType without a mainField, use the contentType displayName\n      if (schema?.kind === 'singleType' && schema.info.displayName) {\n        return formatMessage({\n          id: schema.info.displayName,\n          defaultMessage: schema.info.displayName,\n        });\n      }\n\n      // Otherwise, use a fallback\n      return formatMessage({\n        id: 'content-manager.containers.untitled',\n        defaultMessage: 'Untitled',\n      });\n    },\n    [document, formatMessage, schema]\n  );\n\n  React.useEffect(() => {\n    if (error) {\n      toggleNotification({\n        type: 'danger',\n        message: formatAPIError(error),\n      });\n    }\n  }, [toggleNotification, error, formatAPIError, args.collectionType]);\n\n  const validate = React.useCallback(\n    (document: Modules.Documents.AnyDocument): FormErrors | null => {\n      if (!schema) {\n        throw new Error(\n          'There is no validation schema generated, this is likely due to the schema not being loaded yet.'\n        );\n      }\n\n      const validationSchema = getValidationSchema(schema, components);\n\n      try {\n        validationSchema.validateSync(document, { abortEarly: false, strict: true });\n        return null;\n      } catch (error) {\n        if (error instanceof ValidationError) {\n          return getYupValidationErrors(error);\n        }\n\n        throw error;\n      }\n    },\n    [schema, components]\n  );\n\n  /**\n   * Schema attributes that should be inherited from a sibling locale when\n   * creating a new locale draft.\n   *\n   * Scope intentionally matches what the server populates into\n   * `meta.availableLocales` (see `packages/core/content-manager/server/src/services/document-metadata.ts`):\n   *   - non-localized — `isLocalizedAttribute` semantics, so attributes whose\n   *     `pluginOptions.i18n.localized` is `undefined` count as non-localized\n   *     (an attribute created without the i18n plugin has no i18n options at\n   *     all but is still inherited at save by `copyNonLocalizedFields`).\n   *   - scalar or media — `component` / `dynamiczone` / `relation` are excluded\n   *     because the server doesn't populate them in `availableLocales` either,\n   *     so there'd be nothing to copy from.\n   */\n  const nonLocalizedScalarAndMediaFields = React.useMemo(() => {\n    if (!schema?.attributes) {\n      return [];\n    }\n\n    return Object.keys(schema.attributes).filter((name) => {\n      const attribute = schema.attributes[name];\n\n      if (isLocalizedAttribute(attribute)) {\n        return false;\n      }\n\n      return (\n        attribute.type !== 'component' &&\n        attribute.type !== 'dynamiczone' &&\n        attribute.type !== 'relation'\n      );\n    });\n  }, [schema]);\n\n  /**\n   * Here we prepare the form for editing, we need to:\n   * - remove prohibited fields from the document (passwords | ADD YOURS WHEN THERES A NEW ONE)\n   * - swap out count objects on relations for empty arrays\n   * - set __temp_key__ on array objects for drag & drop\n   *\n   * We also prepare the form for new documents, so we need to:\n   * - set default values on fields\n   * - inherit non-localized scalar/media values from a sibling locale.\n   *   Scope is intentionally limited to scalars and media — that is exactly\n   *   what the server populates into `meta.availableLocales` (see\n   *   `packages/core/content-manager/server/src/services/document-metadata.ts`).\n   *   Components, dynamic zones, and relations are not in that payload; the\n   *   server fills them at save time via `copyNonLocalizedFields` (in\n   *   `packages/core/core/src/services/document-service/internationalization.ts`)\n   *   when the new locale row is first created.\n   *   Baking the inheritance into `initialValues` here is what lets it survive\n   *   `<Form>` re-inits: the `SET_INITIAL_VALUES` effect in\n   *   `packages/core/admin/admin/src/components/Form.tsx` re-applies these\n   *   values whenever `initialValues` changes (e.g. after a locale switch),\n   *   which the previous side-effect-based prefill in `LocalePickerAction`\n   *   could not survive on revisits.\n   */\n  const getInitialFormValues = React.useCallback(\n    (isCreatingDocument: boolean = false) => {\n      if ((!document && !isCreatingDocument && !isSingleType) || !schema) {\n        return undefined;\n      }\n\n      /**\n       * Check that we have an ID so we know the\n       * document has been created in some way.\n       */\n      if (document?.id) {\n        return transformDocument(schema, components)(document);\n      }\n\n      let form: AnyData = createDefaultForm(schema, components);\n\n      // Intentionally use `availableLocales[0]`:\n      // - The server sorts `getAvailableLocales` with the default locale first\n      //   (see `document-metadata.ts`), so index 0 is the canonical inheritance\n      //   source. Sibling locales can drift on non-localized fields because the\n      //   server only syncs them at locale-creation time, not on subsequent\n      //   updates — preferring the default keeps the surfaced values stable.\n      // - Avoids coupling this hook to `useGetLocalesQuery` just to find the\n      //   default locale.\n      const sibling = meta?.availableLocales?.[0] as Record<string, unknown> | undefined;\n      if (sibling && nonLocalizedScalarAndMediaFields.length > 0) {\n        const inherited = nonLocalizedScalarAndMediaFields.reduce<AnyData>((acc, name) => {\n          if (name in sibling) {\n            acc[name] = sibling[name];\n          }\n          return acc;\n        }, {});\n\n        form = { ...form, ...inherited };\n      }\n\n      return transformDocument(schema, components)(form);\n    },\n    [\n      document,\n      isSingleType,\n      schema,\n      components,\n      meta?.availableLocales,\n      nonLocalizedScalarAndMediaFields,\n    ]\n  );\n\n  const isLoading = isLoadingDocument || isFetchingDocument || isLoadingSchema;\n  const hasError = !!error;\n\n  return React.useMemo(\n    () =>\n      ({\n        components,\n        document,\n        meta,\n        isLoading,\n        hasError,\n        schema,\n        schemas,\n        validate,\n        getTitle,\n        getInitialFormValues,\n        refetch,\n      }) satisfies ReturnType<UseDocument>,\n    [\n      components,\n      document,\n      meta,\n      isLoading,\n      hasError,\n      schema,\n      schemas,\n      validate,\n      getTitle,\n      getInitialFormValues,\n      refetch,\n    ]\n  );\n};\n\n/* -------------------------------------------------------------------------------------------------\n * useDoc\n * -----------------------------------------------------------------------------------------------*/\n\n/**\n * @internal this hook uses the router to extract the model, collection type & id from the url.\n * therefore, it shouldn't be used outside of the content-manager because it won't work as intended.\n */\nconst useDoc = (opts?: UseDocumentOpts) => {\n  const { id, slug, collectionType, origin } = useParams<{\n    id: string;\n    origin: string;\n    slug: string;\n    collectionType: string;\n  }>();\n  const [{ query }] = useQueryParams();\n  const params = React.useMemo(() => buildValidParams(query), [query]);\n\n  if (!collectionType) {\n    throw new Error('Could not find collectionType in url params');\n  }\n\n  if (!slug) {\n    throw new Error('Could not find model in url params');\n  }\n\n  const document = useDocument(\n    { documentId: origin || id, model: slug, collectionType, params },\n    {\n      ...opts,\n      skip: id === 'create' || (!origin && !id && collectionType !== SINGLE_TYPES) || opts?.skip,\n    }\n  );\n\n  const returnId = origin || (id === 'create' ? undefined : id);\n\n  return {\n    collectionType,\n    model: slug,\n    id: returnId,\n    ...document,\n  };\n};\n\n/**\n * @public\n * @experimental\n * Content manager context hooks for plugin development.\n * Make sure to use this hook inside the content manager.\n */\nconst useContentManagerContext = () => {\n  const {\n    collectionType,\n    model,\n    id,\n    components,\n    isLoading: isLoadingDoc,\n    schema,\n    schemas,\n  } = useDoc();\n\n  const layout = useDocumentLayout(model);\n\n  const form = useForm<unknown>('useContentManagerContext', (state) => state);\n\n  const isSingleType = collectionType === SINGLE_TYPES;\n  const slug = model;\n  const isCreatingEntry = id === 'create';\n\n  useContentTypeSchema();\n\n  const isLoading = isLoadingDoc || layout.isLoading;\n  const error = layout.error;\n\n  return {\n    error,\n    isLoading,\n\n    // Base metadata\n    model,\n    collectionType,\n    id,\n    slug,\n    isCreatingEntry,\n    isSingleType,\n    hasDraftAndPublish: schema?.options?.draftAndPublish ?? false,\n\n    // All schema infos\n    components,\n    contentType: schema,\n    contentTypes: schemas,\n\n    // Form state\n    form,\n\n    // layout infos\n    layout,\n  };\n};\n\nexport { useDocument, useDoc, useContentManagerContext };\nexport type { UseDocument, UseDocumentArgs, Document, Schema, ComponentsDictionary };\n"],"names":["validationSchemaCache","WeakMap","getValidationSchema","schema","components","byComponents","get","set","validationSchema","createYupSchema","attributes","isLocalizedAttribute","attribute","i18nOptions","pluginOptions","i18n","localized","useDocument","args","opts","toggleNotification","useNotification","_unstableFormatAPIError","formatAPIError","useAPIErrorHandler","formatMessage","useIntl","currentData","data","isLoading","isLoadingDocument","isFetching","isFetchingDocument","error","refetch","useGetDocumentQuery","skip","documentId","collectionType","SINGLE_TYPES","document","meta","schemas","isLoadingSchema","useContentTypeSchema","model","isSingleType","kind","getTitle","React","useCallback","mainField","info","displayName","id","defaultMessage","useEffect","type","message","validate","Error","validateSync","abortEarly","strict","ValidationError","getYupValidationErrors","nonLocalizedScalarAndMediaFields","useMemo","Object","keys","filter","name","getInitialFormValues","isCreatingDocument","undefined","transformDocument","form","createDefaultForm","sibling","availableLocales","length","inherited","reduce","acc","hasError","useDoc","slug","origin","useParams","query","useQueryParams","params","buildValidParams","returnId","useContentManagerContext","isLoadingDoc","layout","useDocumentLayout","useForm","state","isCreatingEntry","hasDraftAndPublish","options","draftAndPublish","contentType","contentTypes"],"mappings":";;;;;;;;;;;;;;AAqDA;AACA;AACA;AACA;AACA,MAAMA,wBAAwB,IAAIC,OAAAA,EAAAA;AAKlC,MAAMC,mBAAAA,GAAsB,CAACC,MAAAA,EAAgBC,UAAAA,GAAAA;IAC3C,IAAIC,YAAAA,GAAeL,qBAAAA,CAAsBM,GAAG,CAACH,MAAAA,CAAAA;AAE7C,IAAA,IAAI,CAACE,YAAAA,EAAc;AACjBA,QAAAA,YAAAA,GAAe,IAAIJ,OAAAA,EAAAA;QACnBD,qBAAAA,CAAsBO,GAAG,CAACJ,MAAAA,EAAQE,YAAAA,CAAAA;AACpC,IAAA;IAEA,IAAIG,gBAAAA,GAAmBH,YAAAA,CAAaC,GAAG,CAACF,UAAAA,CAAAA;AAExC,IAAA,IAAI,CAACI,gBAAAA,EAAkB;QACrBA,gBAAAA,GAAmBC,eAAAA,CAAgBN,MAAAA,CAAOO,UAAU,EAAEN,UAAAA,CAAAA;QACtDC,YAAAA,CAAaE,GAAG,CAACH,UAAAA,EAAYI,gBAAAA,CAAAA;AAC/B,IAAA;IAEA,OAAOA,gBAAAA;AACT,CAAA;AAgCA;;;;;;;IAQA,MAAMG,uBAAuB,CAACC,SAAAA,GAAAA;;;IAG5B,MAAMC,WAAAA,GAAcD,UAAUE,aAAa;IAC3C,OAAOD,WAAAA,EAAaE,MAAMC,SAAAA,KAAc,IAAA;AAC1C,CAAA;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;IA8BA,MAAMC,WAAAA,GAA2B,CAACC,IAAAA,EAAMC,IAAAA,GAAAA;IACtC,MAAM,EAAEC,kBAAkB,EAAE,GAAGC,eAAAA,EAAAA;AAC/B,IAAA,MAAM,EAAEC,uBAAAA,EAAyBC,cAAc,EAAE,GAAGC,kBAAAA,EAAAA;IACpD,MAAM,EAAEC,aAAa,EAAE,GAAGC,OAAAA,EAAAA;AAE1B,IAAA,MAAM,EACJC,WAAAA,EAAaC,IAAI,EACjBC,SAAAA,EAAWC,iBAAiB,EAC5BC,UAAAA,EAAYC,kBAAkB,EAC9BC,KAAK,EACLC,OAAO,EACR,GAAGC,oBAAoBjB,IAAAA,EAAM;AAC5B,QAAA,GAAGC,IAAI;QACPiB,IAAAA,EAAO,CAAClB,IAAAA,CAAKmB,UAAU,IAAInB,IAAAA,CAAKoB,cAAc,KAAKC,YAAAA,IAAiBpB,IAAAA,EAAMiB;AAC5E,KAAA,CAAA;AACA,IAAA,MAAMI,WAAWZ,IAAAA,EAAMA,IAAAA;AACvB,IAAA,MAAMa,OAAOb,IAAAA,EAAMa,IAAAA;AAEnB,IAAA,MAAM,EACJrC,UAAU,EACVD,MAAM,EACNuC,OAAO,EACPb,SAAAA,EAAWc,eAAe,EAC3B,GAAGC,oBAAAA,CAAqB1B,KAAK2B,KAAK,CAAA;IACnC,MAAMC,YAAAA,GAAe3C,QAAQ4C,IAAAA,KAAS,YAAA;AAEtC,IAAA,MAAMC,QAAAA,GAAWC,KAAAA,CAAMC,WAAW,CAChC,CAACC,SAAAA,GAAAA;;AAEC,QAAA,IAAIA,SAAAA,KAAc,IAAA,IAAQX,QAAAA,GAAWW,UAAU,EAAE;YAC/C,OAAOX,QAAQ,CAACW,SAAAA,CAAU;AAC5B,QAAA;;AAGA,QAAA,IAAIhD,QAAQ4C,IAAAA,KAAS,YAAA,IAAgB5C,OAAOiD,IAAI,CAACC,WAAW,EAAE;AAC5D,YAAA,OAAO5B,aAAAA,CAAc;gBACnB6B,EAAAA,EAAInD,MAAAA,CAAOiD,IAAI,CAACC,WAAW;gBAC3BE,cAAAA,EAAgBpD,MAAAA,CAAOiD,IAAI,CAACC;AAC9B,aAAA,CAAA;AACF,QAAA;;AAGA,QAAA,OAAO5B,aAAAA,CAAc;YACnB6B,EAAAA,EAAI,qCAAA;YACJC,cAAAA,EAAgB;AAClB,SAAA,CAAA;IACF,CAAA,EACA;AAACf,QAAAA,QAAAA;AAAUf,QAAAA,aAAAA;AAAetB,QAAAA;AAAO,KAAA,CAAA;AAGnC8C,IAAAA,KAAAA,CAAMO,SAAS,CAAC,IAAA;AACd,QAAA,IAAIvB,KAAAA,EAAO;YACTb,kBAAAA,CAAmB;gBACjBqC,IAAAA,EAAM,QAAA;AACNC,gBAAAA,OAAAA,EAASnC,cAAAA,CAAeU,KAAAA;AAC1B,aAAA,CAAA;AACF,QAAA;IACF,CAAA,EAAG;AAACb,QAAAA,kBAAAA;AAAoBa,QAAAA,KAAAA;AAAOV,QAAAA,cAAAA;AAAgBL,QAAAA,IAAAA,CAAKoB;AAAe,KAAA,CAAA;AAEnE,IAAA,MAAMqB,QAAAA,GAAWV,KAAAA,CAAMC,WAAW,CAChC,CAACV,QAAAA,GAAAA;AACC,QAAA,IAAI,CAACrC,MAAAA,EAAQ;AACX,YAAA,MAAM,IAAIyD,KAAAA,CACR,iGAAA,CAAA;AAEJ,QAAA;QAEA,MAAMpD,gBAAAA,GAAmBN,oBAAoBC,MAAAA,EAAQC,UAAAA,CAAAA;QAErD,IAAI;YACFI,gBAAAA,CAAiBqD,YAAY,CAACrB,QAAAA,EAAU;gBAAEsB,UAAAA,EAAY,KAAA;gBAAOC,MAAAA,EAAQ;AAAK,aAAA,CAAA;YAC1E,OAAO,IAAA;AACT,QAAA,CAAA,CAAE,OAAO9B,KAAAA,EAAO;AACd,YAAA,IAAIA,iBAAiB+B,eAAAA,EAAiB;AACpC,gBAAA,OAAOC,sBAAAA,CAAuBhC,KAAAA,CAAAA;AAChC,YAAA;YAEA,MAAMA,KAAAA;AACR,QAAA;IACF,CAAA,EACA;AAAC9B,QAAAA,MAAAA;AAAQC,QAAAA;AAAW,KAAA,CAAA;AAGtB;;;;;;;;;;;;;AAaC,MACD,MAAM8D,gCAAAA,GAAmCjB,KAAAA,CAAMkB,OAAO,CAAC,IAAA;QACrD,IAAI,CAAChE,QAAQO,UAAAA,EAAY;AACvB,YAAA,OAAO,EAAE;AACX,QAAA;QAEA,OAAO0D,MAAAA,CAAOC,IAAI,CAAClE,MAAAA,CAAOO,UAAU,CAAA,CAAE4D,MAAM,CAAC,CAACC,IAAAA,GAAAA;AAC5C,YAAA,MAAM3D,SAAAA,GAAYT,MAAAA,CAAOO,UAAU,CAAC6D,IAAAA,CAAK;AAEzC,YAAA,IAAI5D,qBAAqBC,SAAAA,CAAAA,EAAY;gBACnC,OAAO,KAAA;AACT,YAAA;YAEA,OACEA,SAAAA,CAAU6C,IAAI,KAAK,WAAA,IACnB7C,SAAAA,CAAU6C,IAAI,KAAK,aAAA,IACnB7C,SAAAA,CAAU6C,IAAI,KAAK,UAAA;AAEvB,QAAA,CAAA,CAAA;IACF,CAAA,EAAG;AAACtD,QAAAA;AAAO,KAAA,CAAA;AAEX;;;;;;;;;;;;;;;;;;;;;;AAsBC,MACD,MAAMqE,oBAAAA,GAAuBvB,KAAAA,CAAMC,WAAW,CAC5C,CAACuB,qBAA8B,KAAK,GAAA;QAClC,IAAK,CAACjC,QAAAA,IAAY,CAACiC,sBAAsB,CAAC3B,YAAAA,IAAiB,CAAC3C,MAAAA,EAAQ;YAClE,OAAOuE,SAAAA;AACT,QAAA;AAEA;;;UAIA,IAAIlC,UAAUc,EAAAA,EAAI;YAChB,OAAOqB,iBAAAA,CAAkBxE,QAAQC,UAAAA,CAAAA,CAAYoC,QAAAA,CAAAA;AAC/C,QAAA;QAEA,IAAIoC,IAAAA,GAAgBC,kBAAkB1E,MAAAA,EAAQC,UAAAA,CAAAA;;;;;;;;;AAU9C,QAAA,MAAM0E,OAAAA,GAAUrC,IAAAA,EAAMsC,gBAAAA,GAAmB,CAAA,CAAE;AAC3C,QAAA,IAAID,OAAAA,IAAWZ,gCAAAA,CAAiCc,MAAM,GAAG,CAAA,EAAG;AAC1D,YAAA,MAAMC,SAAAA,GAAYf,gCAAAA,CAAiCgB,MAAM,CAAU,CAACC,GAAAA,EAAKZ,IAAAA,GAAAA;AACvE,gBAAA,IAAIA,QAAQO,OAAAA,EAAS;AACnBK,oBAAAA,GAAG,CAACZ,IAAAA,CAAK,GAAGO,OAAO,CAACP,IAAAA,CAAK;AAC3B,gBAAA;gBACA,OAAOY,GAAAA;AACT,YAAA,CAAA,EAAG,EAAC,CAAA;YAEJP,IAAAA,GAAO;AAAE,gBAAA,GAAGA,IAAI;AAAE,gBAAA,GAAGK;AAAU,aAAA;AACjC,QAAA;QAEA,OAAON,iBAAAA,CAAkBxE,QAAQC,UAAAA,CAAAA,CAAYwE,IAAAA,CAAAA;IAC/C,CAAA,EACA;AACEpC,QAAAA,QAAAA;AACAM,QAAAA,YAAAA;AACA3C,QAAAA,MAAAA;AACAC,QAAAA,UAAAA;QACAqC,IAAAA,EAAMsC,gBAAAA;AACNb,QAAAA;AACD,KAAA,CAAA;IAGH,MAAMrC,SAAAA,GAAYC,qBAAqBE,kBAAAA,IAAsBW,eAAAA;IAC7D,MAAMyC,QAAAA,GAAW,CAAC,CAACnD,KAAAA;AAEnB,IAAA,OAAOgB,KAAAA,CAAMkB,OAAO,CAClB,KACG;AACC/D,YAAAA,UAAAA;AACAoC,YAAAA,QAAAA;AACAC,YAAAA,IAAAA;AACAZ,YAAAA,SAAAA;AACAuD,YAAAA,QAAAA;AACAjF,YAAAA,MAAAA;AACAuC,YAAAA,OAAAA;AACAiB,YAAAA,QAAAA;AACAX,YAAAA,QAAAA;AACAwB,YAAAA,oBAAAA;AACAtC,YAAAA;AACF,SAAA,CAAA,EACF;AACE9B,QAAAA,UAAAA;AACAoC,QAAAA,QAAAA;AACAC,QAAAA,IAAAA;AACAZ,QAAAA,SAAAA;AACAuD,QAAAA,QAAAA;AACAjF,QAAAA,MAAAA;AACAuC,QAAAA,OAAAA;AACAiB,QAAAA,QAAAA;AACAX,QAAAA,QAAAA;AACAwB,QAAAA,oBAAAA;AACAtC,QAAAA;AACD,KAAA,CAAA;AAEL;AAEA;;;;;IAQA,MAAMmD,SAAS,CAAClE,IAAAA,GAAAA;IACd,MAAM,EAAEmC,EAAE,EAAEgC,IAAI,EAAEhD,cAAc,EAAEiD,MAAM,EAAE,GAAGC,SAAAA,EAAAA;AAM7C,IAAA,MAAM,CAAC,EAAEC,KAAK,EAAE,CAAC,GAAGC,cAAAA,EAAAA;AACpB,IAAA,MAAMC,SAAS1C,KAAAA,CAAMkB,OAAO,CAAC,IAAMyB,iBAAiBH,KAAAA,CAAAA,EAAQ;AAACA,QAAAA;AAAM,KAAA,CAAA;AAEnE,IAAA,IAAI,CAACnD,cAAAA,EAAgB;AACnB,QAAA,MAAM,IAAIsB,KAAAA,CAAM,6CAAA,CAAA;AAClB,IAAA;AAEA,IAAA,IAAI,CAAC0B,IAAAA,EAAM;AACT,QAAA,MAAM,IAAI1B,KAAAA,CAAM,oCAAA,CAAA;AAClB,IAAA;AAEA,IAAA,MAAMpB,WAAWvB,WAAAA,CACf;AAAEoB,QAAAA,UAAAA,EAAYkD,MAAAA,IAAUjC,EAAAA;QAAIT,KAAAA,EAAOyC,IAAAA;AAAMhD,QAAAA,cAAAA;AAAgBqD,QAAAA;KAAO,EAChE;AACE,QAAA,GAAGxE,IAAI;QACPiB,IAAAA,EAAMkB,EAAAA,KAAO,YAAa,CAACiC,MAAAA,IAAU,CAACjC,EAAAA,IAAMhB,cAAAA,KAAmBC,gBAAiBpB,IAAAA,EAAMiB;AACxF,KAAA,CAAA;AAGF,IAAA,MAAMyD,WAAWN,MAAAA,KAAWjC,EAAAA,KAAO,QAAA,GAAWoB,YAAYpB,EAAC,CAAA;IAE3D,OAAO;AACLhB,QAAAA,cAAAA;QACAO,KAAAA,EAAOyC,IAAAA;QACPhC,EAAAA,EAAIuC,QAAAA;AACJ,QAAA,GAAGrD;AACL,KAAA;AACF;AAEA;;;;;AAKC,UACKsD,wBAAAA,GAA2B,IAAA;AAC/B,IAAA,MAAM,EACJxD,cAAc,EACdO,KAAK,EACLS,EAAE,EACFlD,UAAU,EACVyB,SAAAA,EAAWkE,YAAY,EACvB5F,MAAM,EACNuC,OAAO,EACR,GAAG2C,MAAAA,EAAAA;AAEJ,IAAA,MAAMW,SAASC,iBAAAA,CAAkBpD,KAAAA,CAAAA;AAEjC,IAAA,MAAM+B,IAAAA,GAAOsB,OAAAA,CAAiB,0BAAA,EAA4B,CAACC,KAAAA,GAAUA,KAAAA,CAAAA;AAErE,IAAA,MAAMrD,eAAeR,cAAAA,KAAmBC,YAAAA;AACxC,IAAA,MAAM+C,IAAAA,GAAOzC,KAAAA;AACb,IAAA,MAAMuD,kBAAkB9C,EAAAA,KAAO,QAAA;AAE/BV,IAAAA,oBAAAA,EAAAA;IAEA,MAAMf,SAAAA,GAAYkE,YAAAA,IAAgBC,MAAAA,CAAOnE,SAAS;IAClD,MAAMI,KAAAA,GAAQ+D,OAAO/D,KAAK;IAE1B,OAAO;AACLA,QAAAA,KAAAA;AACAJ,QAAAA,SAAAA;;AAGAgB,QAAAA,KAAAA;AACAP,QAAAA,cAAAA;AACAgB,QAAAA,EAAAA;AACAgC,QAAAA,IAAAA;AACAc,QAAAA,eAAAA;AACAtD,QAAAA,YAAAA;QACAuD,kBAAAA,EAAoBlG,MAAAA,EAAQmG,SAASC,eAAAA,IAAmB,KAAA;;AAGxDnG,QAAAA,UAAAA;QACAoG,WAAAA,EAAarG,MAAAA;QACbsG,YAAAA,EAAc/D,OAAAA;;AAGdkC,QAAAA,IAAAA;;AAGAoB,QAAAA;AACF,KAAA;AACF;;;;"}
+{"version":3,"file":"useDocument.mjs","sources":["../../../admin/src/hooks/useDocument.ts"],"sourcesContent":["/**\n * This hook doesn't use a context provider because we fetch directly from the server,\n * this sounds expensive but actually, it's really not. Because we have redux-toolkit-query\n * being a cache layer so if nothing invalidates the cache, we don't fetch again.\n *\n * The network is deduplicated, but the work done inside the hook is not: it can be mounted\n * by hundreds of fields at once, so anything expensive it derives must be cached outside of\n * the hook instance (see `getValidationSchema`).\n */\n\nimport * as React from 'react';\n\nimport {\n  useNotification,\n  useAPIErrorHandler,\n  useQueryParams,\n  FormErrors,\n  getYupValidationErrors,\n  useForm,\n} from '@strapi/admin/strapi-admin';\nimport { useIntl } from 'react-intl';\nimport { useParams } from 'react-router-dom';\nimport { ValidationError } from 'yup';\n\nimport { SINGLE_TYPES } from '../constants/collections';\nimport { type AnyData, transformDocument } from '../pages/EditView/utils/data';\nimport { createDefaultForm } from '../pages/EditView/utils/forms';\nimport { useGetDocumentQuery } from '../services/documents';\nimport { buildValidParams } from '../utils/api';\nimport { createYupSchema } from '../utils/validation';\n\nimport { useContentTypeSchema, ComponentsDictionary } from './useContentTypeSchema';\nimport { useDocumentLayout } from './useDocumentLayout';\n\nimport type { FindOne } from '../../../shared/contracts/collection-types';\nimport type { ContentType } from '../../../shared/contracts/content-types';\nimport type { Modules } from '@strapi/types';\n\ninterface UseDocumentArgs {\n  collectionType: string;\n  model: string;\n  documentId?: string;\n  params?: object;\n}\n\ntype UseDocumentOpts = Parameters<typeof useGetDocumentQuery>[1];\n\ntype Document = FindOne.Response['data'];\n\ntype Schema = ContentType;\n\ntype ValidationSchema = ReturnType<typeof createYupSchema>;\n\n// Building the yup schema of a model clones a schema for every nested component and dynamic\n// zone: on large models it takes seconds and gigabytes. `schema` and `components` identities\n// are shared across hook instances (see `useContentTypeSchema`), so build it once per pair,\n// and only when something actually validates.\nconst validationSchemaCache = new WeakMap<\n  Schema,\n  WeakMap<ComponentsDictionary, ValidationSchema>\n>();\n\nconst getValidationSchema = (schema: Schema, components: ComponentsDictionary) => {\n  let byComponents = validationSchemaCache.get(schema);\n\n  if (!byComponents) {\n    byComponents = new WeakMap();\n    validationSchemaCache.set(schema, byComponents);\n  }\n\n  let validationSchema = byComponents.get(components);\n\n  if (!validationSchema) {\n    validationSchema = createYupSchema(schema.attributes, components);\n    byComponents.set(components, validationSchema);\n  }\n\n  return validationSchema;\n};\n\ntype UseDocument = (\n  args: UseDocumentArgs,\n  opts?: UseDocumentOpts\n) => {\n  /**\n   * These are the schemas of the components used in the content type, organised\n   * by their uid.\n   */\n  components: ComponentsDictionary;\n  document?: Document;\n  meta?: FindOne.Response['meta'];\n  isLoading: boolean;\n  /**\n   * This is the schema of the content type, it is not the same as the layout.\n   */\n  schema?: Schema;\n  schemas?: Schema[];\n  hasError?: boolean;\n  refetch: () => void;\n  validate: (document: Document) => null | FormErrors;\n  /**\n   * Get the document's title\n   */\n  getTitle: (mainField: string) => string;\n  /**\n   * Get the initial form values for the document\n   */\n  getInitialFormValues: (isCreatingDocument?: boolean) => AnyData | undefined;\n};\n\n/**\n * Mirrors the server's `isLocalizedAttribute` in\n * `packages/plugins/i18n/server/src/services/content-types.ts`: an attribute\n * counts as localized only when `pluginOptions.i18n.localized` is explicitly\n * `true`. Both `false` and `undefined` mean \"non-localized\" — important here\n * because attributes created without the i18n plugin omit the field entirely,\n * and we still want them inherited when creating a new locale draft.\n */\nconst isLocalizedAttribute = (attribute: { pluginOptions?: object }): boolean => {\n  // `pluginOptions` on the base attribute is typed as `object`, so we have to\n  // narrow it to the i18n-specific shape here.\n  const i18nOptions = attribute.pluginOptions as { i18n?: { localized?: boolean } } | undefined;\n  return i18nOptions?.i18n?.localized === true;\n};\n\n/* -------------------------------------------------------------------------------------------------\n * useDocument\n * -----------------------------------------------------------------------------------------------*/\n\n/**\n * @alpha\n * @public\n * @description Returns a document based on the model, collection type & id passed as arguments.\n * Also extracts its schema from the redux cache to be used for creating a validation schema.\n * @example\n * ```tsx\n * const { id, model, collectionType } = useParams<{ id: string; model: string; collectionType: string }>();\n *\n * if(!model || !collectionType) return null;\n *\n * const { document, isLoading, validate } = useDocument({ documentId: id, model, collectionType, params: { locale: 'en-GB' } })\n * const { update } = useDocumentActions()\n *\n * const onSubmit = async (document: Document) => {\n *  const errors = validate(document);\n *\n *  if(errors) {\n *      // handle errors\n *  }\n *\n *  await update({ collectionType, model, id }, document)\n * }\n * ```\n *\n */\nconst useDocument: UseDocument = (args, opts) => {\n  const { toggleNotification } = useNotification();\n  const { _unstableFormatAPIError: formatAPIError } = useAPIErrorHandler();\n  const { formatMessage } = useIntl();\n\n  const {\n    currentData: data,\n    isLoading: isLoadingDocument,\n    isFetching: isFetchingDocument,\n    error,\n    refetch,\n  } = useGetDocumentQuery(args, {\n    ...opts,\n    skip: (!args.documentId && args.collectionType !== SINGLE_TYPES) || opts?.skip,\n  });\n  const document = data?.data;\n  const meta = data?.meta;\n\n  const {\n    components,\n    schema,\n    schemas,\n    isLoading: isLoadingSchema,\n  } = useContentTypeSchema(args.model);\n  const isSingleType = schema?.kind === 'singleType';\n\n  const getTitle = React.useCallback(\n    (mainField: string) => {\n      // Always use mainField if it's not an id\n      if (mainField !== 'id' && document?.[mainField]) {\n        return document[mainField];\n      }\n\n      // When it's a singleType without a mainField, use the contentType displayName\n      if (schema?.kind === 'singleType' && schema.info.displayName) {\n        return formatMessage({\n          id: schema.info.displayName,\n          defaultMessage: schema.info.displayName,\n        });\n      }\n\n      // Otherwise, use a fallback\n      return formatMessage({\n        id: 'content-manager.containers.untitled',\n        defaultMessage: 'Untitled',\n      });\n    },\n    [document, formatMessage, schema]\n  );\n\n  React.useEffect(() => {\n    if (error) {\n      toggleNotification({\n        type: 'danger',\n        message: formatAPIError(error),\n      });\n    }\n  }, [toggleNotification, error, formatAPIError, args.collectionType]);\n\n  const validate = React.useCallback(\n    (document: Modules.Documents.AnyDocument): FormErrors | null => {\n      if (!schema) {\n        throw new Error(\n          'There is no validation schema generated, this is likely due to the schema not being loaded yet.'\n        );\n      }\n\n      const validationSchema = getValidationSchema(schema, components);\n\n      try {\n        validationSchema.validateSync(document, { abortEarly: false, strict: true });\n        return null;\n      } catch (error) {\n        if (error instanceof ValidationError) {\n          return getYupValidationErrors(error);\n        }\n\n        throw error;\n      }\n    },\n    [schema, components]\n  );\n\n  /**\n   * Schema attributes that should be inherited from a sibling locale when\n   * creating a new locale draft.\n   *\n   * Scope intentionally matches what the server populates into\n   * `meta.availableLocales` (see `packages/core/content-manager/server/src/services/document-metadata.ts`):\n   *   - non-localized — `isLocalizedAttribute` semantics, so attributes whose\n   *     `pluginOptions.i18n.localized` is `undefined` count as non-localized\n   *     (an attribute created without the i18n plugin has no i18n options at\n   *     all but is still inherited at save by `copyNonLocalizedFields`).\n   *   - scalar, media, component, or dynamic zone — relations are excluded\n   *     because the server doesn't populate them in `availableLocales` either.\n   */\n  const nonLocalizedFieldsToInherit = React.useMemo(() => {\n    if (!schema?.attributes) {\n      return [];\n    }\n\n    return Object.keys(schema.attributes).filter((name) => {\n      const attribute = schema.attributes[name];\n\n      if (isLocalizedAttribute(attribute)) {\n        return false;\n      }\n\n      return attribute.type !== 'relation';\n    });\n  }, [schema]);\n\n  /**\n   * Here we prepare the form for editing, we need to:\n   * - remove prohibited fields from the document (passwords | ADD YOURS WHEN THERES A NEW ONE)\n   * - swap out count objects on relations for empty arrays\n   * - set __temp_key__ on array objects for drag & drop\n   *\n   * We also prepare the form for new documents, so we need to:\n   * - set default values on fields\n   * - inherit non-localized scalar/media/component/dynamic-zone values from a sibling locale.\n   *   Scope matches what the server populates into `meta.availableLocales` (see\n   *   `packages/core/content-manager/server/src/services/document-metadata.ts`).\n   *   Relations are not in that payload; the server fills them at save time via\n   *   `copyNonLocalizedFields` (in\n   *   `packages/core/core/src/services/document-service/internationalization.ts`)\n   *   when the new locale row is first created.\n   *   Baking the inheritance into `initialValues` here is what lets it survive\n   *   `<Form>` re-inits: the `SET_INITIAL_VALUES` effect in\n   *   `packages/core/admin/admin/src/components/Form.tsx` re-applies these\n   *   values whenever `initialValues` changes (e.g. after a locale switch),\n   *   which the previous side-effect-based prefill in `LocalePickerAction`\n   *   could not survive on revisits.\n   */\n  const getInitialFormValues = React.useCallback(\n    (isCreatingDocument: boolean = false) => {\n      if ((!document && !isCreatingDocument && !isSingleType) || !schema) {\n        return undefined;\n      }\n\n      /**\n       * Check that we have an ID so we know the\n       * document has been created in some way.\n       */\n      if (document?.id) {\n        return transformDocument(schema, components)(document);\n      }\n\n      let form: AnyData = createDefaultForm(schema, components);\n\n      // Intentionally use `availableLocales[0]`:\n      // - The server sorts `getAvailableLocales` with the default locale first\n      //   (see `document-metadata.ts`), so index 0 is the canonical inheritance\n      //   source. Sibling locales can drift on non-localized fields because the\n      //   server only syncs them at locale-creation time, not on subsequent\n      //   updates — preferring the default keeps the surfaced values stable.\n      // - Avoids coupling this hook to `useGetLocalesQuery` just to find the\n      //   default locale.\n      const sibling = meta?.availableLocales?.[0] as Record<string, unknown> | undefined;\n      if (sibling && nonLocalizedFieldsToInherit.length > 0) {\n        const inherited = nonLocalizedFieldsToInherit.reduce<AnyData>((acc, name) => {\n          if (name in sibling) {\n            acc[name] = sibling[name];\n          }\n          return acc;\n        }, {});\n\n        form = { ...form, ...inherited };\n      }\n\n      return transformDocument(schema, components)(form);\n    },\n    [\n      document,\n      isSingleType,\n      schema,\n      components,\n      meta?.availableLocales,\n      nonLocalizedFieldsToInherit,\n    ]\n  );\n\n  const isLoading = isLoadingDocument || isFetchingDocument || isLoadingSchema;\n  const hasError = !!error;\n\n  return React.useMemo(\n    () =>\n      ({\n        components,\n        document,\n        meta,\n        isLoading,\n        hasError,\n        schema,\n        schemas,\n        validate,\n        getTitle,\n        getInitialFormValues,\n        refetch,\n      }) satisfies ReturnType<UseDocument>,\n    [\n      components,\n      document,\n      meta,\n      isLoading,\n      hasError,\n      schema,\n      schemas,\n      validate,\n      getTitle,\n      getInitialFormValues,\n      refetch,\n    ]\n  );\n};\n\n/* -------------------------------------------------------------------------------------------------\n * useDoc\n * -----------------------------------------------------------------------------------------------*/\n\n/**\n * @internal this hook uses the router to extract the model, collection type & id from the url.\n * therefore, it shouldn't be used outside of the content-manager because it won't work as intended.\n */\nconst useDoc = (opts?: UseDocumentOpts) => {\n  const { id, slug, collectionType, origin } = useParams<{\n    id: string;\n    origin: string;\n    slug: string;\n    collectionType: string;\n  }>();\n  const [{ query }] = useQueryParams();\n  const params = React.useMemo(() => buildValidParams(query), [query]);\n\n  if (!collectionType) {\n    throw new Error('Could not find collectionType in url params');\n  }\n\n  if (!slug) {\n    throw new Error('Could not find model in url params');\n  }\n\n  const document = useDocument(\n    { documentId: origin || id, model: slug, collectionType, params },\n    {\n      ...opts,\n      skip: id === 'create' || (!origin && !id && collectionType !== SINGLE_TYPES) || opts?.skip,\n    }\n  );\n\n  const returnId = origin || (id === 'create' ? undefined : id);\n\n  return {\n    collectionType,\n    model: slug,\n    id: returnId,\n    ...document,\n  };\n};\n\n/**\n * @public\n * @experimental\n * Content manager context hooks for plugin development.\n * Make sure to use this hook inside the content manager.\n */\nconst useContentManagerContext = () => {\n  const {\n    collectionType,\n    model,\n    id,\n    components,\n    isLoading: isLoadingDoc,\n    schema,\n    schemas,\n  } = useDoc();\n\n  const layout = useDocumentLayout(model);\n\n  const form = useForm<unknown>('useContentManagerContext', (state) => state);\n\n  const isSingleType = collectionType === SINGLE_TYPES;\n  const slug = model;\n  const isCreatingEntry = id === 'create';\n\n  useContentTypeSchema();\n\n  const isLoading = isLoadingDoc || layout.isLoading;\n  const error = layout.error;\n\n  return {\n    error,\n    isLoading,\n\n    // Base metadata\n    model,\n    collectionType,\n    id,\n    slug,\n    isCreatingEntry,\n    isSingleType,\n    hasDraftAndPublish: schema?.options?.draftAndPublish ?? false,\n\n    // All schema infos\n    components,\n    contentType: schema,\n    contentTypes: schemas,\n\n    // Form state\n    form,\n\n    // layout infos\n    layout,\n  };\n};\n\nexport { useDocument, useDoc, useContentManagerContext };\nexport type { UseDocument, UseDocumentArgs, Document, Schema, ComponentsDictionary };\n"],"names":["validationSchemaCache","WeakMap","getValidationSchema","schema","components","byComponents","get","set","validationSchema","createYupSchema","attributes","isLocalizedAttribute","attribute","i18nOptions","pluginOptions","i18n","localized","useDocument","args","opts","toggleNotification","useNotification","_unstableFormatAPIError","formatAPIError","useAPIErrorHandler","formatMessage","useIntl","currentData","data","isLoading","isLoadingDocument","isFetching","isFetchingDocument","error","refetch","useGetDocumentQuery","skip","documentId","collectionType","SINGLE_TYPES","document","meta","schemas","isLoadingSchema","useContentTypeSchema","model","isSingleType","kind","getTitle","React","useCallback","mainField","info","displayName","id","defaultMessage","useEffect","type","message","validate","Error","validateSync","abortEarly","strict","ValidationError","getYupValidationErrors","nonLocalizedFieldsToInherit","useMemo","Object","keys","filter","name","getInitialFormValues","isCreatingDocument","undefined","transformDocument","form","createDefaultForm","sibling","availableLocales","length","inherited","reduce","acc","hasError","useDoc","slug","origin","useParams","query","useQueryParams","params","buildValidParams","returnId","useContentManagerContext","isLoadingDoc","layout","useDocumentLayout","useForm","state","isCreatingEntry","hasDraftAndPublish","options","draftAndPublish","contentType","contentTypes"],"mappings":";;;;;;;;;;;;;;AAqDA;AACA;AACA;AACA;AACA,MAAMA,wBAAwB,IAAIC,OAAAA,EAAAA;AAKlC,MAAMC,mBAAAA,GAAsB,CAACC,MAAAA,EAAgBC,UAAAA,GAAAA;IAC3C,IAAIC,YAAAA,GAAeL,qBAAAA,CAAsBM,GAAG,CAACH,MAAAA,CAAAA;AAE7C,IAAA,IAAI,CAACE,YAAAA,EAAc;AACjBA,QAAAA,YAAAA,GAAe,IAAIJ,OAAAA,EAAAA;QACnBD,qBAAAA,CAAsBO,GAAG,CAACJ,MAAAA,EAAQE,YAAAA,CAAAA;AACpC,IAAA;IAEA,IAAIG,gBAAAA,GAAmBH,YAAAA,CAAaC,GAAG,CAACF,UAAAA,CAAAA;AAExC,IAAA,IAAI,CAACI,gBAAAA,EAAkB;QACrBA,gBAAAA,GAAmBC,eAAAA,CAAgBN,MAAAA,CAAOO,UAAU,EAAEN,UAAAA,CAAAA;QACtDC,YAAAA,CAAaE,GAAG,CAACH,UAAAA,EAAYI,gBAAAA,CAAAA;AAC/B,IAAA;IAEA,OAAOA,gBAAAA;AACT,CAAA;AAgCA;;;;;;;IAQA,MAAMG,uBAAuB,CAACC,SAAAA,GAAAA;;;IAG5B,MAAMC,WAAAA,GAAcD,UAAUE,aAAa;IAC3C,OAAOD,WAAAA,EAAaE,MAAMC,SAAAA,KAAc,IAAA;AAC1C,CAAA;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;IA8BA,MAAMC,WAAAA,GAA2B,CAACC,IAAAA,EAAMC,IAAAA,GAAAA;IACtC,MAAM,EAAEC,kBAAkB,EAAE,GAAGC,eAAAA,EAAAA;AAC/B,IAAA,MAAM,EAAEC,uBAAAA,EAAyBC,cAAc,EAAE,GAAGC,kBAAAA,EAAAA;IACpD,MAAM,EAAEC,aAAa,EAAE,GAAGC,OAAAA,EAAAA;AAE1B,IAAA,MAAM,EACJC,WAAAA,EAAaC,IAAI,EACjBC,SAAAA,EAAWC,iBAAiB,EAC5BC,UAAAA,EAAYC,kBAAkB,EAC9BC,KAAK,EACLC,OAAO,EACR,GAAGC,oBAAoBjB,IAAAA,EAAM;AAC5B,QAAA,GAAGC,IAAI;QACPiB,IAAAA,EAAO,CAAClB,IAAAA,CAAKmB,UAAU,IAAInB,IAAAA,CAAKoB,cAAc,KAAKC,YAAAA,IAAiBpB,IAAAA,EAAMiB;AAC5E,KAAA,CAAA;AACA,IAAA,MAAMI,WAAWZ,IAAAA,EAAMA,IAAAA;AACvB,IAAA,MAAMa,OAAOb,IAAAA,EAAMa,IAAAA;AAEnB,IAAA,MAAM,EACJrC,UAAU,EACVD,MAAM,EACNuC,OAAO,EACPb,SAAAA,EAAWc,eAAe,EAC3B,GAAGC,oBAAAA,CAAqB1B,KAAK2B,KAAK,CAAA;IACnC,MAAMC,YAAAA,GAAe3C,QAAQ4C,IAAAA,KAAS,YAAA;AAEtC,IAAA,MAAMC,QAAAA,GAAWC,KAAAA,CAAMC,WAAW,CAChC,CAACC,SAAAA,GAAAA;;AAEC,QAAA,IAAIA,SAAAA,KAAc,IAAA,IAAQX,QAAAA,GAAWW,UAAU,EAAE;YAC/C,OAAOX,QAAQ,CAACW,SAAAA,CAAU;AAC5B,QAAA;;AAGA,QAAA,IAAIhD,QAAQ4C,IAAAA,KAAS,YAAA,IAAgB5C,OAAOiD,IAAI,CAACC,WAAW,EAAE;AAC5D,YAAA,OAAO5B,aAAAA,CAAc;gBACnB6B,EAAAA,EAAInD,MAAAA,CAAOiD,IAAI,CAACC,WAAW;gBAC3BE,cAAAA,EAAgBpD,MAAAA,CAAOiD,IAAI,CAACC;AAC9B,aAAA,CAAA;AACF,QAAA;;AAGA,QAAA,OAAO5B,aAAAA,CAAc;YACnB6B,EAAAA,EAAI,qCAAA;YACJC,cAAAA,EAAgB;AAClB,SAAA,CAAA;IACF,CAAA,EACA;AAACf,QAAAA,QAAAA;AAAUf,QAAAA,aAAAA;AAAetB,QAAAA;AAAO,KAAA,CAAA;AAGnC8C,IAAAA,KAAAA,CAAMO,SAAS,CAAC,IAAA;AACd,QAAA,IAAIvB,KAAAA,EAAO;YACTb,kBAAAA,CAAmB;gBACjBqC,IAAAA,EAAM,QAAA;AACNC,gBAAAA,OAAAA,EAASnC,cAAAA,CAAeU,KAAAA;AAC1B,aAAA,CAAA;AACF,QAAA;IACF,CAAA,EAAG;AAACb,QAAAA,kBAAAA;AAAoBa,QAAAA,KAAAA;AAAOV,QAAAA,cAAAA;AAAgBL,QAAAA,IAAAA,CAAKoB;AAAe,KAAA,CAAA;AAEnE,IAAA,MAAMqB,QAAAA,GAAWV,KAAAA,CAAMC,WAAW,CAChC,CAACV,QAAAA,GAAAA;AACC,QAAA,IAAI,CAACrC,MAAAA,EAAQ;AACX,YAAA,MAAM,IAAIyD,KAAAA,CACR,iGAAA,CAAA;AAEJ,QAAA;QAEA,MAAMpD,gBAAAA,GAAmBN,oBAAoBC,MAAAA,EAAQC,UAAAA,CAAAA;QAErD,IAAI;YACFI,gBAAAA,CAAiBqD,YAAY,CAACrB,QAAAA,EAAU;gBAAEsB,UAAAA,EAAY,KAAA;gBAAOC,MAAAA,EAAQ;AAAK,aAAA,CAAA;YAC1E,OAAO,IAAA;AACT,QAAA,CAAA,CAAE,OAAO9B,KAAAA,EAAO;AACd,YAAA,IAAIA,iBAAiB+B,eAAAA,EAAiB;AACpC,gBAAA,OAAOC,sBAAAA,CAAuBhC,KAAAA,CAAAA;AAChC,YAAA;YAEA,MAAMA,KAAAA;AACR,QAAA;IACF,CAAA,EACA;AAAC9B,QAAAA,MAAAA;AAAQC,QAAAA;AAAW,KAAA,CAAA;AAGtB;;;;;;;;;;;;AAYC,MACD,MAAM8D,2BAAAA,GAA8BjB,KAAAA,CAAMkB,OAAO,CAAC,IAAA;QAChD,IAAI,CAAChE,QAAQO,UAAAA,EAAY;AACvB,YAAA,OAAO,EAAE;AACX,QAAA;QAEA,OAAO0D,MAAAA,CAAOC,IAAI,CAAClE,MAAAA,CAAOO,UAAU,CAAA,CAAE4D,MAAM,CAAC,CAACC,IAAAA,GAAAA;AAC5C,YAAA,MAAM3D,SAAAA,GAAYT,MAAAA,CAAOO,UAAU,CAAC6D,IAAAA,CAAK;AAEzC,YAAA,IAAI5D,qBAAqBC,SAAAA,CAAAA,EAAY;gBACnC,OAAO,KAAA;AACT,YAAA;YAEA,OAAOA,SAAAA,CAAU6C,IAAI,KAAK,UAAA;AAC5B,QAAA,CAAA,CAAA;IACF,CAAA,EAAG;AAACtD,QAAAA;AAAO,KAAA,CAAA;AAEX;;;;;;;;;;;;;;;;;;;;;AAqBC,MACD,MAAMqE,oBAAAA,GAAuBvB,KAAAA,CAAMC,WAAW,CAC5C,CAACuB,qBAA8B,KAAK,GAAA;QAClC,IAAK,CAACjC,QAAAA,IAAY,CAACiC,sBAAsB,CAAC3B,YAAAA,IAAiB,CAAC3C,MAAAA,EAAQ;YAClE,OAAOuE,SAAAA;AACT,QAAA;AAEA;;;UAIA,IAAIlC,UAAUc,EAAAA,EAAI;YAChB,OAAOqB,iBAAAA,CAAkBxE,QAAQC,UAAAA,CAAAA,CAAYoC,QAAAA,CAAAA;AAC/C,QAAA;QAEA,IAAIoC,IAAAA,GAAgBC,kBAAkB1E,MAAAA,EAAQC,UAAAA,CAAAA;;;;;;;;;AAU9C,QAAA,MAAM0E,OAAAA,GAAUrC,IAAAA,EAAMsC,gBAAAA,GAAmB,CAAA,CAAE;AAC3C,QAAA,IAAID,OAAAA,IAAWZ,2BAAAA,CAA4Bc,MAAM,GAAG,CAAA,EAAG;AACrD,YAAA,MAAMC,SAAAA,GAAYf,2BAAAA,CAA4BgB,MAAM,CAAU,CAACC,GAAAA,EAAKZ,IAAAA,GAAAA;AAClE,gBAAA,IAAIA,QAAQO,OAAAA,EAAS;AACnBK,oBAAAA,GAAG,CAACZ,IAAAA,CAAK,GAAGO,OAAO,CAACP,IAAAA,CAAK;AAC3B,gBAAA;gBACA,OAAOY,GAAAA;AACT,YAAA,CAAA,EAAG,EAAC,CAAA;YAEJP,IAAAA,GAAO;AAAE,gBAAA,GAAGA,IAAI;AAAE,gBAAA,GAAGK;AAAU,aAAA;AACjC,QAAA;QAEA,OAAON,iBAAAA,CAAkBxE,QAAQC,UAAAA,CAAAA,CAAYwE,IAAAA,CAAAA;IAC/C,CAAA,EACA;AACEpC,QAAAA,QAAAA;AACAM,QAAAA,YAAAA;AACA3C,QAAAA,MAAAA;AACAC,QAAAA,UAAAA;QACAqC,IAAAA,EAAMsC,gBAAAA;AACNb,QAAAA;AACD,KAAA,CAAA;IAGH,MAAMrC,SAAAA,GAAYC,qBAAqBE,kBAAAA,IAAsBW,eAAAA;IAC7D,MAAMyC,QAAAA,GAAW,CAAC,CAACnD,KAAAA;AAEnB,IAAA,OAAOgB,KAAAA,CAAMkB,OAAO,CAClB,KACG;AACC/D,YAAAA,UAAAA;AACAoC,YAAAA,QAAAA;AACAC,YAAAA,IAAAA;AACAZ,YAAAA,SAAAA;AACAuD,YAAAA,QAAAA;AACAjF,YAAAA,MAAAA;AACAuC,YAAAA,OAAAA;AACAiB,YAAAA,QAAAA;AACAX,YAAAA,QAAAA;AACAwB,YAAAA,oBAAAA;AACAtC,YAAAA;AACF,SAAA,CAAA,EACF;AACE9B,QAAAA,UAAAA;AACAoC,QAAAA,QAAAA;AACAC,QAAAA,IAAAA;AACAZ,QAAAA,SAAAA;AACAuD,QAAAA,QAAAA;AACAjF,QAAAA,MAAAA;AACAuC,QAAAA,OAAAA;AACAiB,QAAAA,QAAAA;AACAX,QAAAA,QAAAA;AACAwB,QAAAA,oBAAAA;AACAtC,QAAAA;AACD,KAAA,CAAA;AAEL;AAEA;;;;;IAQA,MAAMmD,SAAS,CAAClE,IAAAA,GAAAA;IACd,MAAM,EAAEmC,EAAE,EAAEgC,IAAI,EAAEhD,cAAc,EAAEiD,MAAM,EAAE,GAAGC,SAAAA,EAAAA;AAM7C,IAAA,MAAM,CAAC,EAAEC,KAAK,EAAE,CAAC,GAAGC,cAAAA,EAAAA;AACpB,IAAA,MAAMC,SAAS1C,KAAAA,CAAMkB,OAAO,CAAC,IAAMyB,iBAAiBH,KAAAA,CAAAA,EAAQ;AAACA,QAAAA;AAAM,KAAA,CAAA;AAEnE,IAAA,IAAI,CAACnD,cAAAA,EAAgB;AACnB,QAAA,MAAM,IAAIsB,KAAAA,CAAM,6CAAA,CAAA;AAClB,IAAA;AAEA,IAAA,IAAI,CAAC0B,IAAAA,EAAM;AACT,QAAA,MAAM,IAAI1B,KAAAA,CAAM,oCAAA,CAAA;AAClB,IAAA;AAEA,IAAA,MAAMpB,WAAWvB,WAAAA,CACf;AAAEoB,QAAAA,UAAAA,EAAYkD,MAAAA,IAAUjC,EAAAA;QAAIT,KAAAA,EAAOyC,IAAAA;AAAMhD,QAAAA,cAAAA;AAAgBqD,QAAAA;KAAO,EAChE;AACE,QAAA,GAAGxE,IAAI;QACPiB,IAAAA,EAAMkB,EAAAA,KAAO,YAAa,CAACiC,MAAAA,IAAU,CAACjC,EAAAA,IAAMhB,cAAAA,KAAmBC,gBAAiBpB,IAAAA,EAAMiB;AACxF,KAAA,CAAA;AAGF,IAAA,MAAMyD,WAAWN,MAAAA,KAAWjC,EAAAA,KAAO,QAAA,GAAWoB,YAAYpB,EAAC,CAAA;IAE3D,OAAO;AACLhB,QAAAA,cAAAA;QACAO,KAAAA,EAAOyC,IAAAA;QACPhC,EAAAA,EAAIuC,QAAAA;AACJ,QAAA,GAAGrD;AACL,KAAA;AACF;AAEA;;;;;AAKC,UACKsD,wBAAAA,GAA2B,IAAA;AAC/B,IAAA,MAAM,EACJxD,cAAc,EACdO,KAAK,EACLS,EAAE,EACFlD,UAAU,EACVyB,SAAAA,EAAWkE,YAAY,EACvB5F,MAAM,EACNuC,OAAO,EACR,GAAG2C,MAAAA,EAAAA;AAEJ,IAAA,MAAMW,SAASC,iBAAAA,CAAkBpD,KAAAA,CAAAA;AAEjC,IAAA,MAAM+B,IAAAA,GAAOsB,OAAAA,CAAiB,0BAAA,EAA4B,CAACC,KAAAA,GAAUA,KAAAA,CAAAA;AAErE,IAAA,MAAMrD,eAAeR,cAAAA,KAAmBC,YAAAA;AACxC,IAAA,MAAM+C,IAAAA,GAAOzC,KAAAA;AACb,IAAA,MAAMuD,kBAAkB9C,EAAAA,KAAO,QAAA;AAE/BV,IAAAA,oBAAAA,EAAAA;IAEA,MAAMf,SAAAA,GAAYkE,YAAAA,IAAgBC,MAAAA,CAAOnE,SAAS;IAClD,MAAMI,KAAAA,GAAQ+D,OAAO/D,KAAK;IAE1B,OAAO;AACLA,QAAAA,KAAAA;AACAJ,QAAAA,SAAAA;;AAGAgB,QAAAA,KAAAA;AACAP,QAAAA,cAAAA;AACAgB,QAAAA,EAAAA;AACAgC,QAAAA,IAAAA;AACAc,QAAAA,eAAAA;AACAtD,QAAAA,YAAAA;QACAuD,kBAAAA,EAAoBlG,MAAAA,EAAQmG,SAASC,eAAAA,IAAmB,KAAA;;AAGxDnG,QAAAA,UAAAA;QACAoG,WAAAA,EAAarG,MAAAA;QACbsG,YAAAA,EAAc/D,OAAAA;;AAGdkC,QAAAA,IAAAA;;AAGAoB,QAAAA;AACF,KAAA;AACF;;;;"}

package/dist/admin/hooks/useI18nFieldLock.js

@@ -0,0 +1,169 @@
+'use strict';
+
+var React = require('react');
+var strapiAdmin = require('@strapi/admin/strapi-admin');
+var isEqual = require('lodash/isEqual');
+var I18nSharedFieldsLock = require('../features/I18nSharedFieldsLock.js');
+var documents = require('../services/documents.js');
+var useDocumentContext = require('./useDocumentContext.js');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var React__namespace = /*#__PURE__*/_interopNamespace(React);
+var isEqual__default = /*#__PURE__*/_interopDefault(isEqual);
+
+/**
+ * @internal
+ * Whether the Content Manager edit view is on the i18n default locale.
+ *
+ * Returns `true` when i18n is not enabled on the content type, when the active
+ * or default locale cannot be determined yet, or when they match.
+ *
+ * Prefers `meta.defaultLocale` from the document metadata response — NOT
+ * `availableLocales[0]`. That list excludes the currently viewed locale, so
+ * when editing the default locale `[0]` is a sibling and would incorrectly
+ * report "not default" and lock shared fields.
+ *
+ * On create (`/create?locale=`), document metadata is not fetched, so
+ * `meta.defaultLocale` is missing. Fall back to the i18n locales list to tell
+ * whether the active locale is the default. Locking still requires a
+ * default-locale document entry (`useHasDefaultLocaleEntry`).
+ */ const useIsEditingDefaultLocale = ()=>{
+    const [{ query }] = strapiAdmin.useQueryParams();
+    const { currentDocument } = useDocumentContext.useDocumentContext('useIsEditingDefaultLocale');
+    const contentTypeLocalized = currentDocument.schema?.pluginOptions?.i18n?.localized === true;
+    const currentLocale = query?.plugins?.i18n?.locale ?? currentDocument.document?.locale;
+    const metaDefaultLocale = currentDocument.meta?.defaultLocale;
+    const { data: locales } = documents.useGetI18nLocalesQuery(undefined, {
+        skip: !contentTypeLocalized || Boolean(metaDefaultLocale)
+    });
+    if (!contentTypeLocalized) {
+        return true;
+    }
+    const localesDefault = Array.isArray(locales) ? locales.find((locale)=>locale.isDefault)?.code : undefined;
+    const defaultLocale = metaDefaultLocale || localesDefault;
+    if (!currentLocale || !defaultLocale) {
+        return true;
+    }
+    return currentLocale === defaultLocale;
+};
+/**
+ * @alpha
+ * @public
+ * Whether the document being edited has a default-locale entry.
+ *
+ * `availableLocales` excludes the locale currently open, so a match is a sibling
+ * in the default locale. Brand-new creates have no document metadata. A document
+ * that exists only in a secondary locale has none either. Shared fields stay
+ * editable in both cases: there is no default-locale entry to edit them in.
+ */ const useHasDefaultLocaleEntry = ()=>{
+    const { currentDocument } = useDocumentContext.useDocumentContext('useHasDefaultLocaleEntry');
+    const meta = currentDocument.meta;
+    const contentTypeLocalized = currentDocument.schema?.pluginOptions?.i18n?.localized === true;
+    const { data: locales } = documents.useGetI18nLocalesQuery(undefined, {
+        skip: !contentTypeLocalized || Boolean(meta?.defaultLocale)
+    });
+    if (!meta) {
+        return false;
+    }
+    const localesDefault = Array.isArray(locales) ? locales.find((locale)=>locale.isDefault)?.code : undefined;
+    const defaultLocale = meta.defaultLocale || localesDefault;
+    if (!defaultLocale) {
+        return false;
+    }
+    return (meta.availableLocales ?? []).some((entry)=>entry.locale === defaultLocale);
+};
+/**
+ * @alpha
+ * @public
+ * Whether an attribute holds a value shared by every locale of the entry.
+ */ const isSharedI18nAttribute = (attribute)=>{
+    if (!attribute) {
+        return false;
+    }
+    // Match server `isLocalizedAttribute`: relations and uids are always locale-specific
+    // even when they omit `pluginOptions.i18n.localized` (CTB never offers that checkbox).
+    if (attribute.type === 'relation' || attribute.type === 'uid') {
+        return false;
+    }
+    const i18nOptions = attribute.pluginOptions;
+    // Only explicit `localized: true` is localizable for other attribute types.
+    return i18nOptions?.i18n?.localized !== true;
+};
+/**
+ * Whether shared fields are locked for the document being edited: a non-default
+ * locale of a document that already has a default-locale entry. The editor can
+ * still unlock them (see `I18nSharedFieldsLock`).
+ */ const useIsSharedFieldsLockActive = ()=>{
+    const isDefaultLocale = useIsEditingDefaultLocale();
+    const hasDefaultLocaleEntry = useHasDefaultLocaleEntry();
+    return !isDefaultLocale && hasDefaultLocaleEntry;
+};
+/**
+ * @internal
+ * True when a field should be locked because it is not locale-specific and the
+ * editor is on a non-default locale that already has a default-locale entry.
+ * Root-level only — nested component fields inherit disable from their parent
+ * component input.
+ */ const useShouldLockNonLocalizedField = (attribute, options = {})=>{
+    const isLockActive = useIsSharedFieldsLockActive();
+    const isUnlocked = I18nSharedFieldsLock.useI18nSharedFieldsLock('useShouldLockNonLocalizedField', (state)=>state.isUnlocked);
+    if (!isLockActive || isUnlocked || options.isInsideComponent) {
+        return false;
+    }
+    return isSharedI18nAttribute(attribute);
+};
+/**
+ * @internal
+ * Returns a function that removes locked shared fields from the payload that
+ * creates a missing locale, so the server copies them whole from the default
+ * locale. The form only holds a prefilled copy of them, and relations nested
+ * in components or dynamic zones are not carried in that copy. Once the editor
+ * unlocks shared fields, the ones they changed are kept.
+ */ const useOmitLockedSharedFieldsOnLocaleCreate = ()=>{
+    const { currentDocument } = useDocumentContext.useDocumentContext('useOmitLockedSharedFieldsOnLocaleCreate');
+    const isLockActive = useIsSharedFieldsLockActive();
+    const isUnlocked = I18nSharedFieldsLock.useI18nSharedFieldsLock('useOmitLockedSharedFieldsOnLocaleCreate', (state)=>state.isUnlocked);
+    const values = strapiAdmin.useForm('useOmitLockedSharedFieldsOnLocaleCreate', (state)=>state.values);
+    const initialValues = strapiAdmin.useForm('useOmitLockedSharedFieldsOnLocaleCreate', (state)=>state.initialValues);
+    const isCreatingLocale = !currentDocument.document?.id;
+    const attributes = currentDocument.schema?.attributes;
+    return React__namespace.useCallback((data)=>{
+        if (!isLockActive || !isCreatingLocale || !attributes) {
+            return data;
+        }
+        return Object.fromEntries(Object.entries(data).filter(([name])=>!isSharedI18nAttribute(attributes[name]) || isUnlocked && !isEqual__default.default(values?.[name], initialValues?.[name])));
+    }, [
+        attributes,
+        initialValues,
+        isCreatingLocale,
+        isLockActive,
+        isUnlocked,
+        values
+    ]);
+};
+
+exports.isSharedI18nAttribute = isSharedI18nAttribute;
+exports.useHasDefaultLocaleEntry = useHasDefaultLocaleEntry;
+exports.useIsEditingDefaultLocale = useIsEditingDefaultLocale;
+exports.useOmitLockedSharedFieldsOnLocaleCreate = useOmitLockedSharedFieldsOnLocaleCreate;
+exports.useShouldLockNonLocalizedField = useShouldLockNonLocalizedField;
+//# sourceMappingURL=useI18nFieldLock.js.map

package/dist/admin/hooks/useI18nFieldLock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useI18nFieldLock.js","sources":["../../../admin/src/hooks/useI18nFieldLock.ts"],"sourcesContent":["import * as React from 'react';\n\nimport { useForm, useQueryParams } from '@strapi/admin/strapi-admin';\nimport isEqual from 'lodash/isEqual';\n\nimport { useI18nSharedFieldsLock } from '../features/I18nSharedFieldsLock';\nimport { useGetI18nLocalesQuery } from '../services/documents';\n\nimport { useDocumentContext } from './useDocumentContext';\n\n/**\n * @internal\n * Whether the Content Manager edit view is on the i18n default locale.\n *\n * Returns `true` when i18n is not enabled on the content type, when the active\n * or default locale cannot be determined yet, or when they match.\n *\n * Prefers `meta.defaultLocale` from the document metadata response — NOT\n * `availableLocales[0]`. That list excludes the currently viewed locale, so\n * when editing the default locale `[0]` is a sibling and would incorrectly\n * report \"not default\" and lock shared fields.\n *\n * On create (`/create?locale=`), document metadata is not fetched, so\n * `meta.defaultLocale` is missing. Fall back to the i18n locales list to tell\n * whether the active locale is the default. Locking still requires a\n * default-locale document entry (`useHasDefaultLocaleEntry`).\n */\nconst useIsEditingDefaultLocale = (): boolean => {\n  const [{ query }] = useQueryParams<{\n    plugins?: { i18n?: { locale?: string } };\n  }>();\n  const { currentDocument } = useDocumentContext('useIsEditingDefaultLocale');\n\n  const contentTypeLocalized =\n    (currentDocument.schema?.pluginOptions as { i18n?: { localized?: boolean } } | undefined)?.i18n\n      ?.localized === true;\n\n  const currentLocale = query?.plugins?.i18n?.locale ?? currentDocument.document?.locale;\n  const metaDefaultLocale = (currentDocument.meta as { defaultLocale?: string | null } | undefined)\n    ?.defaultLocale;\n\n  const { data: locales } = useGetI18nLocalesQuery(undefined, {\n    skip: !contentTypeLocalized || Boolean(metaDefaultLocale),\n  });\n\n  if (!contentTypeLocalized) {\n    return true;\n  }\n\n  const localesDefault = Array.isArray(locales)\n    ? locales.find((locale) => locale.isDefault)?.code\n    : undefined;\n  const defaultLocale = metaDefaultLocale || localesDefault;\n\n  if (!currentLocale || !defaultLocale) {\n    return true;\n  }\n\n  return currentLocale === defaultLocale;\n};\n\ntype DocumentMetaForLock = {\n  availableLocales?: Array<{ locale?: string | null }>;\n  defaultLocale?: string | null;\n};\n\n/**\n * @alpha\n * @public\n * Whether the document being edited has a default-locale entry.\n *\n * `availableLocales` excludes the locale currently open, so a match is a sibling\n * in the default locale. Brand-new creates have no document metadata. A document\n * that exists only in a secondary locale has none either. Shared fields stay\n * editable in both cases: there is no default-locale entry to edit them in.\n */\nconst useHasDefaultLocaleEntry = (): boolean => {\n  const { currentDocument } = useDocumentContext('useHasDefaultLocaleEntry');\n  const meta = currentDocument.meta as DocumentMetaForLock | undefined;\n\n  const contentTypeLocalized =\n    (currentDocument.schema?.pluginOptions as { i18n?: { localized?: boolean } } | undefined)?.i18n\n      ?.localized === true;\n\n  const { data: locales } = useGetI18nLocalesQuery(undefined, {\n    skip: !contentTypeLocalized || Boolean(meta?.defaultLocale),\n  });\n\n  if (!meta) {\n    return false;\n  }\n\n  const localesDefault = Array.isArray(locales)\n    ? locales.find((locale) => locale.isDefault)?.code\n    : undefined;\n  const defaultLocale = meta.defaultLocale || localesDefault;\n\n  if (!defaultLocale) {\n    return false;\n  }\n\n  return (meta.availableLocales ?? []).some((entry) => entry.locale === defaultLocale);\n};\n\n/**\n * @alpha\n * @public\n * Whether an attribute holds a value shared by every locale of the entry.\n */\nconst isSharedI18nAttribute = (\n  attribute: { pluginOptions?: object; type?: string } | undefined\n): boolean => {\n  if (!attribute) {\n    return false;\n  }\n\n  // Match server `isLocalizedAttribute`: relations and uids are always locale-specific\n  // even when they omit `pluginOptions.i18n.localized` (CTB never offers that checkbox).\n  if (attribute.type === 'relation' || attribute.type === 'uid') {\n    return false;\n  }\n\n  const i18nOptions = attribute.pluginOptions as { i18n?: { localized?: boolean } } | undefined;\n\n  // Only explicit `localized: true` is localizable for other attribute types.\n  return i18nOptions?.i18n?.localized !== true;\n};\n\n/**\n * Whether shared fields are locked for the document being edited: a non-default\n * locale of a document that already has a default-locale entry. The editor can\n * still unlock them (see `I18nSharedFieldsLock`).\n */\nconst useIsSharedFieldsLockActive = (): boolean => {\n  const isDefaultLocale = useIsEditingDefaultLocale();\n  const hasDefaultLocaleEntry = useHasDefaultLocaleEntry();\n\n  return !isDefaultLocale && hasDefaultLocaleEntry;\n};\n\n/**\n * @internal\n * True when a field should be locked because it is not locale-specific and the\n * editor is on a non-default locale that already has a default-locale entry.\n * Root-level only — nested component fields inherit disable from their parent\n * component input.\n */\nconst useShouldLockNonLocalizedField = (\n  attribute: { pluginOptions?: object; type?: string } | undefined,\n  options: { isInsideComponent?: boolean } = {}\n): boolean => {\n  const isLockActive = useIsSharedFieldsLockActive();\n  const isUnlocked = useI18nSharedFieldsLock(\n    'useShouldLockNonLocalizedField',\n    (state) => state.isUnlocked\n  );\n\n  if (!isLockActive || isUnlocked || options.isInsideComponent) {\n    return false;\n  }\n\n  return isSharedI18nAttribute(attribute);\n};\n\n/**\n * @internal\n * Returns a function that removes locked shared fields from the payload that\n * creates a missing locale, so the server copies them whole from the default\n * locale. The form only holds a prefilled copy of them, and relations nested\n * in components or dynamic zones are not carried in that copy. Once the editor\n * unlocks shared fields, the ones they changed are kept.\n */\nconst useOmitLockedSharedFieldsOnLocaleCreate = () => {\n  const { currentDocument } = useDocumentContext('useOmitLockedSharedFieldsOnLocaleCreate');\n  const isLockActive = useIsSharedFieldsLockActive();\n  const isUnlocked = useI18nSharedFieldsLock(\n    'useOmitLockedSharedFieldsOnLocaleCreate',\n    (state) => state.isUnlocked\n  );\n  const values = useForm(\n    'useOmitLockedSharedFieldsOnLocaleCreate',\n    (state) => state.values as Record<string, unknown>\n  );\n  const initialValues = useForm(\n    'useOmitLockedSharedFieldsOnLocaleCreate',\n    (state) => state.initialValues as Record<string, unknown>\n  );\n  const isCreatingLocale = !currentDocument.document?.id;\n  const attributes = currentDocument.schema?.attributes;\n\n  return React.useCallback(\n    <TData extends Record<string, unknown>>(data: TData): TData => {\n      if (!isLockActive || !isCreatingLocale || !attributes) {\n        return data;\n      }\n\n      return Object.fromEntries(\n        Object.entries(data).filter(\n          ([name]) =>\n            !isSharedI18nAttribute(attributes[name]) ||\n            (isUnlocked && !isEqual(values?.[name], initialValues?.[name]))\n        )\n      ) as TData;\n    },\n    [attributes, initialValues, isCreatingLocale, isLockActive, isUnlocked, values]\n  );\n};\n\nexport {\n  isSharedI18nAttribute,\n  useHasDefaultLocaleEntry,\n  useIsEditingDefaultLocale,\n  useOmitLockedSharedFieldsOnLocaleCreate,\n  useShouldLockNonLocalizedField,\n};\n"],"names":["useIsEditingDefaultLocale","query","useQueryParams","currentDocument","useDocumentContext","contentTypeLocalized","schema","pluginOptions","i18n","localized","currentLocale","plugins","locale","document","metaDefaultLocale","meta","defaultLocale","data","locales","useGetI18nLocalesQuery","undefined","skip","Boolean","localesDefault","Array","isArray","find","isDefault","code","useHasDefaultLocaleEntry","availableLocales","some","entry","isSharedI18nAttribute","attribute","type","i18nOptions","useIsSharedFieldsLockActive","isDefaultLocale","hasDefaultLocaleEntry","useShouldLockNonLocalizedField","options","isLockActive","isUnlocked","useI18nSharedFieldsLock","state","isInsideComponent","useOmitLockedSharedFieldsOnLocaleCreate","values","useForm","initialValues","isCreatingLocale","id","attributes","React","useCallback","Object","fromEntries","entries","filter","name","isEqual"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAUA;;;;;;;;;;;;;;;;AAgBC,UACKA,yBAAAA,GAA4B,IAAA;AAChC,IAAA,MAAM,CAAC,EAAEC,KAAK,EAAE,CAAC,GAAGC,0BAAAA,EAAAA;AAGpB,IAAA,MAAM,EAAEC,eAAe,EAAE,GAAGC,qCAAAA,CAAmB,2BAAA,CAAA;AAE/C,IAAA,MAAMC,uBACJ,eAACF,CAAgBG,MAAM,EAAEC,aAAAA,EAAkEC,MACvFC,SAAAA,KAAc,IAAA;AAEpB,IAAA,MAAMC,gBAAgBT,KAAAA,EAAOU,OAAAA,EAASH,MAAMI,MAAAA,IAAUT,eAAAA,CAAgBU,QAAQ,EAAED,MAAAA;IAChF,MAAME,iBAAAA,GAAqBX,eAAAA,CAAgBY,IAAI,EAC3CC,aAAAA;AAEJ,IAAA,MAAM,EAAEC,IAAAA,EAAMC,OAAO,EAAE,GAAGC,iCAAuBC,SAAAA,EAAW;QAC1DC,IAAAA,EAAM,CAAChB,wBAAwBiB,OAAAA,CAAQR,iBAAAA;AACzC,KAAA,CAAA;AAEA,IAAA,IAAI,CAACT,oBAAAA,EAAsB;QACzB,OAAO,IAAA;AACT,IAAA;AAEA,IAAA,MAAMkB,cAAAA,GAAiBC,KAAAA,CAAMC,OAAO,CAACP,OAAAA,CAAAA,GACjCA,OAAAA,CAAQQ,IAAI,CAAC,CAACd,MAAAA,GAAWA,MAAAA,CAAOe,SAAS,GAAGC,IAAAA,GAC5CR,SAAAA;AACJ,IAAA,MAAMJ,gBAAgBF,iBAAAA,IAAqBS,cAAAA;IAE3C,IAAI,CAACb,aAAAA,IAAiB,CAACM,aAAAA,EAAe;QACpC,OAAO,IAAA;AACT,IAAA;AAEA,IAAA,OAAON,aAAAA,KAAkBM,aAAAA;AAC3B;AAOA;;;;;;;;;AASC,UACKa,wBAAAA,GAA2B,IAAA;AAC/B,IAAA,MAAM,EAAE1B,eAAe,EAAE,GAAGC,qCAAAA,CAAmB,0BAAA,CAAA;IAC/C,MAAMW,IAAAA,GAAOZ,gBAAgBY,IAAI;AAEjC,IAAA,MAAMV,uBACJ,eAACF,CAAgBG,MAAM,EAAEC,aAAAA,EAAkEC,MACvFC,SAAAA,KAAc,IAAA;AAEpB,IAAA,MAAM,EAAEQ,IAAAA,EAAMC,OAAO,EAAE,GAAGC,iCAAuBC,SAAAA,EAAW;QAC1DC,IAAAA,EAAM,CAAChB,oBAAAA,IAAwBiB,OAAAA,CAAQP,IAAAA,EAAMC,aAAAA;AAC/C,KAAA,CAAA;AAEA,IAAA,IAAI,CAACD,IAAAA,EAAM;QACT,OAAO,KAAA;AACT,IAAA;AAEA,IAAA,MAAMQ,cAAAA,GAAiBC,KAAAA,CAAMC,OAAO,CAACP,OAAAA,CAAAA,GACjCA,OAAAA,CAAQQ,IAAI,CAAC,CAACd,MAAAA,GAAWA,MAAAA,CAAOe,SAAS,GAAGC,IAAAA,GAC5CR,SAAAA;IACJ,MAAMJ,aAAAA,GAAgBD,IAAAA,CAAKC,aAAa,IAAIO,cAAAA;AAE5C,IAAA,IAAI,CAACP,aAAAA,EAAe;QAClB,OAAO,KAAA;AACT,IAAA;AAEA,IAAA,OAAO,CAACD,IAAAA,CAAKe,gBAAgB,IAAI,EAAC,EAAGC,IAAI,CAAC,CAACC,KAAAA,GAAUA,KAAAA,CAAMpB,MAAM,KAAKI,aAAAA,CAAAA;AACxE;AAEA;;;;IAKA,MAAMiB,wBAAwB,CAC5BC,SAAAA,GAAAA;AAEA,IAAA,IAAI,CAACA,SAAAA,EAAW;QACd,OAAO,KAAA;AACT,IAAA;;;AAIA,IAAA,IAAIA,UAAUC,IAAI,KAAK,cAAcD,SAAAA,CAAUC,IAAI,KAAK,KAAA,EAAO;QAC7D,OAAO,KAAA;AACT,IAAA;IAEA,MAAMC,WAAAA,GAAcF,UAAU3B,aAAa;;IAG3C,OAAO6B,WAAAA,EAAa5B,MAAMC,SAAAA,KAAc,IAAA;AAC1C;AAEA;;;;AAIC,IACD,MAAM4B,2BAAAA,GAA8B,IAAA;AAClC,IAAA,MAAMC,eAAAA,GAAkBtC,yBAAAA,EAAAA;AACxB,IAAA,MAAMuC,qBAAAA,GAAwBV,wBAAAA,EAAAA;AAE9B,IAAA,OAAO,CAACS,eAAAA,IAAmBC,qBAAAA;AAC7B,CAAA;AAEA;;;;;;AAMC,UACKC,8BAAAA,GAAiC,CACrCN,SAAAA,EACAO,OAAAA,GAA2C,EAAE,GAAA;AAE7C,IAAA,MAAMC,YAAAA,GAAeL,2BAAAA,EAAAA;AACrB,IAAA,MAAMM,aAAaC,4CAAAA,CACjB,gCAAA,EACA,CAACC,KAAAA,GAAUA,MAAMF,UAAU,CAAA;AAG7B,IAAA,IAAI,CAACD,YAAAA,IAAgBC,UAAAA,IAAcF,OAAAA,CAAQK,iBAAiB,EAAE;QAC5D,OAAO,KAAA;AACT,IAAA;AAEA,IAAA,OAAOb,qBAAAA,CAAsBC,SAAAA,CAAAA;AAC/B;AAEA;;;;;;;AAOC,UACKa,uCAAAA,GAA0C,IAAA;AAC9C,IAAA,MAAM,EAAE5C,eAAe,EAAE,GAAGC,qCAAAA,CAAmB,yCAAA,CAAA;AAC/C,IAAA,MAAMsC,YAAAA,GAAeL,2BAAAA,EAAAA;AACrB,IAAA,MAAMM,aAAaC,4CAAAA,CACjB,yCAAA,EACA,CAACC,KAAAA,GAAUA,MAAMF,UAAU,CAAA;AAE7B,IAAA,MAAMK,SAASC,mBAAAA,CACb,yCAAA,EACA,CAACJ,KAAAA,GAAUA,MAAMG,MAAM,CAAA;AAEzB,IAAA,MAAME,gBAAgBD,mBAAAA,CACpB,yCAAA,EACA,CAACJ,KAAAA,GAAUA,MAAMK,aAAa,CAAA;AAEhC,IAAA,MAAMC,gBAAAA,GAAmB,CAAChD,eAAAA,CAAgBU,QAAQ,EAAEuC,EAAAA;IACpD,MAAMC,UAAAA,GAAalD,eAAAA,CAAgBG,MAAM,EAAE+C,UAAAA;IAE3C,OAAOC,gBAAAA,CAAMC,WAAW,CACtB,CAAwCtC,IAAAA,GAAAA;AACtC,QAAA,IAAI,CAACyB,YAAAA,IAAgB,CAACS,gBAAAA,IAAoB,CAACE,UAAAA,EAAY;YACrD,OAAOpC,IAAAA;AACT,QAAA;AAEA,QAAA,OAAOuC,MAAAA,CAAOC,WAAW,CACvBD,MAAAA,CAAOE,OAAO,CAACzC,IAAAA,CAAAA,CAAM0C,MAAM,CACzB,CAAC,CAACC,IAAAA,CAAK,GACL,CAAC3B,qBAAAA,CAAsBoB,UAAU,CAACO,IAAAA,CAAK,CAAA,IACtCjB,UAAAA,IAAc,CAACkB,wBAAAA,CAAQb,MAAAA,GAASY,IAAAA,CAAK,EAAEV,aAAAA,GAAgBU,IAAAA,CAAK,CAAA,CAAA,CAAA;IAGrE,CAAA,EACA;AAACP,QAAAA,UAAAA;AAAYH,QAAAA,aAAAA;AAAeC,QAAAA,gBAAAA;AAAkBT,QAAAA,YAAAA;AAAcC,QAAAA,UAAAA;AAAYK,QAAAA;AAAO,KAAA,CAAA;AAEnF;;;;;;;;"}

package/dist/admin/hooks/useI18nFieldLock.mjs

@@ -0,0 +1,140 @@
+import * as React from 'react';
+import { useQueryParams, useForm } from '@strapi/admin/strapi-admin';
+import isEqual from 'lodash/isEqual';
+import { useI18nSharedFieldsLock } from '../features/I18nSharedFieldsLock.mjs';
+import { useGetI18nLocalesQuery } from '../services/documents.mjs';
+import { useDocumentContext } from './useDocumentContext.mjs';
+
+/**
+ * @internal
+ * Whether the Content Manager edit view is on the i18n default locale.
+ *
+ * Returns `true` when i18n is not enabled on the content type, when the active
+ * or default locale cannot be determined yet, or when they match.
+ *
+ * Prefers `meta.defaultLocale` from the document metadata response — NOT
+ * `availableLocales[0]`. That list excludes the currently viewed locale, so
+ * when editing the default locale `[0]` is a sibling and would incorrectly
+ * report "not default" and lock shared fields.
+ *
+ * On create (`/create?locale=`), document metadata is not fetched, so
+ * `meta.defaultLocale` is missing. Fall back to the i18n locales list to tell
+ * whether the active locale is the default. Locking still requires a
+ * default-locale document entry (`useHasDefaultLocaleEntry`).
+ */ const useIsEditingDefaultLocale = ()=>{
+    const [{ query }] = useQueryParams();
+    const { currentDocument } = useDocumentContext('useIsEditingDefaultLocale');
+    const contentTypeLocalized = currentDocument.schema?.pluginOptions?.i18n?.localized === true;
+    const currentLocale = query?.plugins?.i18n?.locale ?? currentDocument.document?.locale;
+    const metaDefaultLocale = currentDocument.meta?.defaultLocale;
+    const { data: locales } = useGetI18nLocalesQuery(undefined, {
+        skip: !contentTypeLocalized || Boolean(metaDefaultLocale)
+    });
+    if (!contentTypeLocalized) {
+        return true;
+    }
+    const localesDefault = Array.isArray(locales) ? locales.find((locale)=>locale.isDefault)?.code : undefined;
+    const defaultLocale = metaDefaultLocale || localesDefault;
+    if (!currentLocale || !defaultLocale) {
+        return true;
+    }
+    return currentLocale === defaultLocale;
+};
+/**
+ * @alpha
+ * @public
+ * Whether the document being edited has a default-locale entry.
+ *
+ * `availableLocales` excludes the locale currently open, so a match is a sibling
+ * in the default locale. Brand-new creates have no document metadata. A document
+ * that exists only in a secondary locale has none either. Shared fields stay
+ * editable in both cases: there is no default-locale entry to edit them in.
+ */ const useHasDefaultLocaleEntry = ()=>{
+    const { currentDocument } = useDocumentContext('useHasDefaultLocaleEntry');
+    const meta = currentDocument.meta;
+    const contentTypeLocalized = currentDocument.schema?.pluginOptions?.i18n?.localized === true;
+    const { data: locales } = useGetI18nLocalesQuery(undefined, {
+        skip: !contentTypeLocalized || Boolean(meta?.defaultLocale)
+    });
+    if (!meta) {
+        return false;
+    }
+    const localesDefault = Array.isArray(locales) ? locales.find((locale)=>locale.isDefault)?.code : undefined;
+    const defaultLocale = meta.defaultLocale || localesDefault;
+    if (!defaultLocale) {
+        return false;
+    }
+    return (meta.availableLocales ?? []).some((entry)=>entry.locale === defaultLocale);
+};
+/**
+ * @alpha
+ * @public
+ * Whether an attribute holds a value shared by every locale of the entry.
+ */ const isSharedI18nAttribute = (attribute)=>{
+    if (!attribute) {
+        return false;
+    }
+    // Match server `isLocalizedAttribute`: relations and uids are always locale-specific
+    // even when they omit `pluginOptions.i18n.localized` (CTB never offers that checkbox).
+    if (attribute.type === 'relation' || attribute.type === 'uid') {
+        return false;
+    }
+    const i18nOptions = attribute.pluginOptions;
+    // Only explicit `localized: true` is localizable for other attribute types.
+    return i18nOptions?.i18n?.localized !== true;
+};
+/**
+ * Whether shared fields are locked for the document being edited: a non-default
+ * locale of a document that already has a default-locale entry. The editor can
+ * still unlock them (see `I18nSharedFieldsLock`).
+ */ const useIsSharedFieldsLockActive = ()=>{
+    const isDefaultLocale = useIsEditingDefaultLocale();
+    const hasDefaultLocaleEntry = useHasDefaultLocaleEntry();
+    return !isDefaultLocale && hasDefaultLocaleEntry;
+};
+/**
+ * @internal
+ * True when a field should be locked because it is not locale-specific and the
+ * editor is on a non-default locale that already has a default-locale entry.
+ * Root-level only — nested component fields inherit disable from their parent
+ * component input.
+ */ const useShouldLockNonLocalizedField = (attribute, options = {})=>{
+    const isLockActive = useIsSharedFieldsLockActive();
+    const isUnlocked = useI18nSharedFieldsLock('useShouldLockNonLocalizedField', (state)=>state.isUnlocked);
+    if (!isLockActive || isUnlocked || options.isInsideComponent) {
+        return false;
+    }
+    return isSharedI18nAttribute(attribute);
+};
+/**
+ * @internal
+ * Returns a function that removes locked shared fields from the payload that
+ * creates a missing locale, so the server copies them whole from the default
+ * locale. The form only holds a prefilled copy of them, and relations nested
+ * in components or dynamic zones are not carried in that copy. Once the editor
+ * unlocks shared fields, the ones they changed are kept.
+ */ const useOmitLockedSharedFieldsOnLocaleCreate = ()=>{
+    const { currentDocument } = useDocumentContext('useOmitLockedSharedFieldsOnLocaleCreate');
+    const isLockActive = useIsSharedFieldsLockActive();
+    const isUnlocked = useI18nSharedFieldsLock('useOmitLockedSharedFieldsOnLocaleCreate', (state)=>state.isUnlocked);
+    const values = useForm('useOmitLockedSharedFieldsOnLocaleCreate', (state)=>state.values);
+    const initialValues = useForm('useOmitLockedSharedFieldsOnLocaleCreate', (state)=>state.initialValues);
+    const isCreatingLocale = !currentDocument.document?.id;
+    const attributes = currentDocument.schema?.attributes;
+    return React.useCallback((data)=>{
+        if (!isLockActive || !isCreatingLocale || !attributes) {
+            return data;
+        }
+        return Object.fromEntries(Object.entries(data).filter(([name])=>!isSharedI18nAttribute(attributes[name]) || isUnlocked && !isEqual(values?.[name], initialValues?.[name])));
+    }, [
+        attributes,
+        initialValues,
+        isCreatingLocale,
+        isLockActive,
+        isUnlocked,
+        values
+    ]);
+};
+
+export { isSharedI18nAttribute, useHasDefaultLocaleEntry, useIsEditingDefaultLocale, useOmitLockedSharedFieldsOnLocaleCreate, useShouldLockNonLocalizedField };
+//# sourceMappingURL=useI18nFieldLock.mjs.map

package/dist/admin/hooks/useI18nFieldLock.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useI18nFieldLock.mjs","sources":["../../../admin/src/hooks/useI18nFieldLock.ts"],"sourcesContent":["import * as React from 'react';\n\nimport { useForm, useQueryParams } from '@strapi/admin/strapi-admin';\nimport isEqual from 'lodash/isEqual';\n\nimport { useI18nSharedFieldsLock } from '../features/I18nSharedFieldsLock';\nimport { useGetI18nLocalesQuery } from '../services/documents';\n\nimport { useDocumentContext } from './useDocumentContext';\n\n/**\n * @internal\n * Whether the Content Manager edit view is on the i18n default locale.\n *\n * Returns `true` when i18n is not enabled on the content type, when the active\n * or default locale cannot be determined yet, or when they match.\n *\n * Prefers `meta.defaultLocale` from the document metadata response — NOT\n * `availableLocales[0]`. That list excludes the currently viewed locale, so\n * when editing the default locale `[0]` is a sibling and would incorrectly\n * report \"not default\" and lock shared fields.\n *\n * On create (`/create?locale=`), document metadata is not fetched, so\n * `meta.defaultLocale` is missing. Fall back to the i18n locales list to tell\n * whether the active locale is the default. Locking still requires a\n * default-locale document entry (`useHasDefaultLocaleEntry`).\n */\nconst useIsEditingDefaultLocale = (): boolean => {\n  const [{ query }] = useQueryParams<{\n    plugins?: { i18n?: { locale?: string } };\n  }>();\n  const { currentDocument } = useDocumentContext('useIsEditingDefaultLocale');\n\n  const contentTypeLocalized =\n    (currentDocument.schema?.pluginOptions as { i18n?: { localized?: boolean } } | undefined)?.i18n\n      ?.localized === true;\n\n  const currentLocale = query?.plugins?.i18n?.locale ?? currentDocument.document?.locale;\n  const metaDefaultLocale = (currentDocument.meta as { defaultLocale?: string | null } | undefined)\n    ?.defaultLocale;\n\n  const { data: locales } = useGetI18nLocalesQuery(undefined, {\n    skip: !contentTypeLocalized || Boolean(metaDefaultLocale),\n  });\n\n  if (!contentTypeLocalized) {\n    return true;\n  }\n\n  const localesDefault = Array.isArray(locales)\n    ? locales.find((locale) => locale.isDefault)?.code\n    : undefined;\n  const defaultLocale = metaDefaultLocale || localesDefault;\n\n  if (!currentLocale || !defaultLocale) {\n    return true;\n  }\n\n  return currentLocale === defaultLocale;\n};\n\ntype DocumentMetaForLock = {\n  availableLocales?: Array<{ locale?: string | null }>;\n  defaultLocale?: string | null;\n};\n\n/**\n * @alpha\n * @public\n * Whether the document being edited has a default-locale entry.\n *\n * `availableLocales` excludes the locale currently open, so a match is a sibling\n * in the default locale. Brand-new creates have no document metadata. A document\n * that exists only in a secondary locale has none either. Shared fields stay\n * editable in both cases: there is no default-locale entry to edit them in.\n */\nconst useHasDefaultLocaleEntry = (): boolean => {\n  const { currentDocument } = useDocumentContext('useHasDefaultLocaleEntry');\n  const meta = currentDocument.meta as DocumentMetaForLock | undefined;\n\n  const contentTypeLocalized =\n    (currentDocument.schema?.pluginOptions as { i18n?: { localized?: boolean } } | undefined)?.i18n\n      ?.localized === true;\n\n  const { data: locales } = useGetI18nLocalesQuery(undefined, {\n    skip: !contentTypeLocalized || Boolean(meta?.defaultLocale),\n  });\n\n  if (!meta) {\n    return false;\n  }\n\n  const localesDefault = Array.isArray(locales)\n    ? locales.find((locale) => locale.isDefault)?.code\n    : undefined;\n  const defaultLocale = meta.defaultLocale || localesDefault;\n\n  if (!defaultLocale) {\n    return false;\n  }\n\n  return (meta.availableLocales ?? []).some((entry) => entry.locale === defaultLocale);\n};\n\n/**\n * @alpha\n * @public\n * Whether an attribute holds a value shared by every locale of the entry.\n */\nconst isSharedI18nAttribute = (\n  attribute: { pluginOptions?: object; type?: string } | undefined\n): boolean => {\n  if (!attribute) {\n    return false;\n  }\n\n  // Match server `isLocalizedAttribute`: relations and uids are always locale-specific\n  // even when they omit `pluginOptions.i18n.localized` (CTB never offers that checkbox).\n  if (attribute.type === 'relation' || attribute.type === 'uid') {\n    return false;\n  }\n\n  const i18nOptions = attribute.pluginOptions as { i18n?: { localized?: boolean } } | undefined;\n\n  // Only explicit `localized: true` is localizable for other attribute types.\n  return i18nOptions?.i18n?.localized !== true;\n};\n\n/**\n * Whether shared fields are locked for the document being edited: a non-default\n * locale of a document that already has a default-locale entry. The editor can\n * still unlock them (see `I18nSharedFieldsLock`).\n */\nconst useIsSharedFieldsLockActive = (): boolean => {\n  const isDefaultLocale = useIsEditingDefaultLocale();\n  const hasDefaultLocaleEntry = useHasDefaultLocaleEntry();\n\n  return !isDefaultLocale && hasDefaultLocaleEntry;\n};\n\n/**\n * @internal\n * True when a field should be locked because it is not locale-specific and the\n * editor is on a non-default locale that already has a default-locale entry.\n * Root-level only — nested component fields inherit disable from their parent\n * component input.\n */\nconst useShouldLockNonLocalizedField = (\n  attribute: { pluginOptions?: object; type?: string } | undefined,\n  options: { isInsideComponent?: boolean } = {}\n): boolean => {\n  const isLockActive = useIsSharedFieldsLockActive();\n  const isUnlocked = useI18nSharedFieldsLock(\n    'useShouldLockNonLocalizedField',\n    (state) => state.isUnlocked\n  );\n\n  if (!isLockActive || isUnlocked || options.isInsideComponent) {\n    return false;\n  }\n\n  return isSharedI18nAttribute(attribute);\n};\n\n/**\n * @internal\n * Returns a function that removes locked shared fields from the payload that\n * creates a missing locale, so the server copies them whole from the default\n * locale. The form only holds a prefilled copy of them, and relations nested\n * in components or dynamic zones are not carried in that copy. Once the editor\n * unlocks shared fields, the ones they changed are kept.\n */\nconst useOmitLockedSharedFieldsOnLocaleCreate = () => {\n  const { currentDocument } = useDocumentContext('useOmitLockedSharedFieldsOnLocaleCreate');\n  const isLockActive = useIsSharedFieldsLockActive();\n  const isUnlocked = useI18nSharedFieldsLock(\n    'useOmitLockedSharedFieldsOnLocaleCreate',\n    (state) => state.isUnlocked\n  );\n  const values = useForm(\n    'useOmitLockedSharedFieldsOnLocaleCreate',\n    (state) => state.values as Record<string, unknown>\n  );\n  const initialValues = useForm(\n    'useOmitLockedSharedFieldsOnLocaleCreate',\n    (state) => state.initialValues as Record<string, unknown>\n  );\n  const isCreatingLocale = !currentDocument.document?.id;\n  const attributes = currentDocument.schema?.attributes;\n\n  return React.useCallback(\n    <TData extends Record<string, unknown>>(data: TData): TData => {\n      if (!isLockActive || !isCreatingLocale || !attributes) {\n        return data;\n      }\n\n      return Object.fromEntries(\n        Object.entries(data).filter(\n          ([name]) =>\n            !isSharedI18nAttribute(attributes[name]) ||\n            (isUnlocked && !isEqual(values?.[name], initialValues?.[name]))\n        )\n      ) as TData;\n    },\n    [attributes, initialValues, isCreatingLocale, isLockActive, isUnlocked, values]\n  );\n};\n\nexport {\n  isSharedI18nAttribute,\n  useHasDefaultLocaleEntry,\n  useIsEditingDefaultLocale,\n  useOmitLockedSharedFieldsOnLocaleCreate,\n  useShouldLockNonLocalizedField,\n};\n"],"names":["useIsEditingDefaultLocale","query","useQueryParams","currentDocument","useDocumentContext","contentTypeLocalized","schema","pluginOptions","i18n","localized","currentLocale","plugins","locale","document","metaDefaultLocale","meta","defaultLocale","data","locales","useGetI18nLocalesQuery","undefined","skip","Boolean","localesDefault","Array","isArray","find","isDefault","code","useHasDefaultLocaleEntry","availableLocales","some","entry","isSharedI18nAttribute","attribute","type","i18nOptions","useIsSharedFieldsLockActive","isDefaultLocale","hasDefaultLocaleEntry","useShouldLockNonLocalizedField","options","isLockActive","isUnlocked","useI18nSharedFieldsLock","state","isInsideComponent","useOmitLockedSharedFieldsOnLocaleCreate","values","useForm","initialValues","isCreatingLocale","id","attributes","React","useCallback","Object","fromEntries","entries","filter","name","isEqual"],"mappings":";;;;;;;AAUA;;;;;;;;;;;;;;;;AAgBC,UACKA,yBAAAA,GAA4B,IAAA;AAChC,IAAA,MAAM,CAAC,EAAEC,KAAK,EAAE,CAAC,GAAGC,cAAAA,EAAAA;AAGpB,IAAA,MAAM,EAAEC,eAAe,EAAE,GAAGC,kBAAAA,CAAmB,2BAAA,CAAA;AAE/C,IAAA,MAAMC,uBACJ,eAACF,CAAgBG,MAAM,EAAEC,aAAAA,EAAkEC,MACvFC,SAAAA,KAAc,IAAA;AAEpB,IAAA,MAAMC,gBAAgBT,KAAAA,EAAOU,OAAAA,EAASH,MAAMI,MAAAA,IAAUT,eAAAA,CAAgBU,QAAQ,EAAED,MAAAA;IAChF,MAAME,iBAAAA,GAAqBX,eAAAA,CAAgBY,IAAI,EAC3CC,aAAAA;AAEJ,IAAA,MAAM,EAAEC,IAAAA,EAAMC,OAAO,EAAE,GAAGC,uBAAuBC,SAAAA,EAAW;QAC1DC,IAAAA,EAAM,CAAChB,wBAAwBiB,OAAAA,CAAQR,iBAAAA;AACzC,KAAA,CAAA;AAEA,IAAA,IAAI,CAACT,oBAAAA,EAAsB;QACzB,OAAO,IAAA;AACT,IAAA;AAEA,IAAA,MAAMkB,cAAAA,GAAiBC,KAAAA,CAAMC,OAAO,CAACP,OAAAA,CAAAA,GACjCA,OAAAA,CAAQQ,IAAI,CAAC,CAACd,MAAAA,GAAWA,MAAAA,CAAOe,SAAS,GAAGC,IAAAA,GAC5CR,SAAAA;AACJ,IAAA,MAAMJ,gBAAgBF,iBAAAA,IAAqBS,cAAAA;IAE3C,IAAI,CAACb,aAAAA,IAAiB,CAACM,aAAAA,EAAe;QACpC,OAAO,IAAA;AACT,IAAA;AAEA,IAAA,OAAON,aAAAA,KAAkBM,aAAAA;AAC3B;AAOA;;;;;;;;;AASC,UACKa,wBAAAA,GAA2B,IAAA;AAC/B,IAAA,MAAM,EAAE1B,eAAe,EAAE,GAAGC,kBAAAA,CAAmB,0BAAA,CAAA;IAC/C,MAAMW,IAAAA,GAAOZ,gBAAgBY,IAAI;AAEjC,IAAA,MAAMV,uBACJ,eAACF,CAAgBG,MAAM,EAAEC,aAAAA,EAAkEC,MACvFC,SAAAA,KAAc,IAAA;AAEpB,IAAA,MAAM,EAAEQ,IAAAA,EAAMC,OAAO,EAAE,GAAGC,uBAAuBC,SAAAA,EAAW;QAC1DC,IAAAA,EAAM,CAAChB,oBAAAA,IAAwBiB,OAAAA,CAAQP,IAAAA,EAAMC,aAAAA;AAC/C,KAAA,CAAA;AAEA,IAAA,IAAI,CAACD,IAAAA,EAAM;QACT,OAAO,KAAA;AACT,IAAA;AAEA,IAAA,MAAMQ,cAAAA,GAAiBC,KAAAA,CAAMC,OAAO,CAACP,OAAAA,CAAAA,GACjCA,OAAAA,CAAQQ,IAAI,CAAC,CAACd,MAAAA,GAAWA,MAAAA,CAAOe,SAAS,GAAGC,IAAAA,GAC5CR,SAAAA;IACJ,MAAMJ,aAAAA,GAAgBD,IAAAA,CAAKC,aAAa,IAAIO,cAAAA;AAE5C,IAAA,IAAI,CAACP,aAAAA,EAAe;QAClB,OAAO,KAAA;AACT,IAAA;AAEA,IAAA,OAAO,CAACD,IAAAA,CAAKe,gBAAgB,IAAI,EAAC,EAAGC,IAAI,CAAC,CAACC,KAAAA,GAAUA,KAAAA,CAAMpB,MAAM,KAAKI,aAAAA,CAAAA;AACxE;AAEA;;;;IAKA,MAAMiB,wBAAwB,CAC5BC,SAAAA,GAAAA;AAEA,IAAA,IAAI,CAACA,SAAAA,EAAW;QACd,OAAO,KAAA;AACT,IAAA;;;AAIA,IAAA,IAAIA,UAAUC,IAAI,KAAK,cAAcD,SAAAA,CAAUC,IAAI,KAAK,KAAA,EAAO;QAC7D,OAAO,KAAA;AACT,IAAA;IAEA,MAAMC,WAAAA,GAAcF,UAAU3B,aAAa;;IAG3C,OAAO6B,WAAAA,EAAa5B,MAAMC,SAAAA,KAAc,IAAA;AAC1C;AAEA;;;;AAIC,IACD,MAAM4B,2BAAAA,GAA8B,IAAA;AAClC,IAAA,MAAMC,eAAAA,GAAkBtC,yBAAAA,EAAAA;AACxB,IAAA,MAAMuC,qBAAAA,GAAwBV,wBAAAA,EAAAA;AAE9B,IAAA,OAAO,CAACS,eAAAA,IAAmBC,qBAAAA;AAC7B,CAAA;AAEA;;;;;;AAMC,UACKC,8BAAAA,GAAiC,CACrCN,SAAAA,EACAO,OAAAA,GAA2C,EAAE,GAAA;AAE7C,IAAA,MAAMC,YAAAA,GAAeL,2BAAAA,EAAAA;AACrB,IAAA,MAAMM,aAAaC,uBAAAA,CACjB,gCAAA,EACA,CAACC,KAAAA,GAAUA,MAAMF,UAAU,CAAA;AAG7B,IAAA,IAAI,CAACD,YAAAA,IAAgBC,UAAAA,IAAcF,OAAAA,CAAQK,iBAAiB,EAAE;QAC5D,OAAO,KAAA;AACT,IAAA;AAEA,IAAA,OAAOb,qBAAAA,CAAsBC,SAAAA,CAAAA;AAC/B;AAEA;;;;;;;AAOC,UACKa,uCAAAA,GAA0C,IAAA;AAC9C,IAAA,MAAM,EAAE5C,eAAe,EAAE,GAAGC,kBAAAA,CAAmB,yCAAA,CAAA;AAC/C,IAAA,MAAMsC,YAAAA,GAAeL,2BAAAA,EAAAA;AACrB,IAAA,MAAMM,aAAaC,uBAAAA,CACjB,yCAAA,EACA,CAACC,KAAAA,GAAUA,MAAMF,UAAU,CAAA;AAE7B,IAAA,MAAMK,SAASC,OAAAA,CACb,yCAAA,EACA,CAACJ,KAAAA,GAAUA,MAAMG,MAAM,CAAA;AAEzB,IAAA,MAAME,gBAAgBD,OAAAA,CACpB,yCAAA,EACA,CAACJ,KAAAA,GAAUA,MAAMK,aAAa,CAAA;AAEhC,IAAA,MAAMC,gBAAAA,GAAmB,CAAChD,eAAAA,CAAgBU,QAAQ,EAAEuC,EAAAA;IACpD,MAAMC,UAAAA,GAAalD,eAAAA,CAAgBG,MAAM,EAAE+C,UAAAA;IAE3C,OAAOC,KAAAA,CAAMC,WAAW,CACtB,CAAwCtC,IAAAA,GAAAA;AACtC,QAAA,IAAI,CAACyB,YAAAA,IAAgB,CAACS,gBAAAA,IAAoB,CAACE,UAAAA,EAAY;YACrD,OAAOpC,IAAAA;AACT,QAAA;AAEA,QAAA,OAAOuC,MAAAA,CAAOC,WAAW,CACvBD,MAAAA,CAAOE,OAAO,CAACzC,IAAAA,CAAAA,CAAM0C,MAAM,CACzB,CAAC,CAACC,IAAAA,CAAK,GACL,CAAC3B,qBAAAA,CAAsBoB,UAAU,CAACO,IAAAA,CAAK,CAAA,IACtCjB,UAAAA,IAAc,CAACkB,OAAAA,CAAQb,MAAAA,GAASY,IAAAA,CAAK,EAAEV,aAAAA,GAAgBU,IAAAA,CAAK,CAAA,CAAA,CAAA;IAGrE,CAAA,EACA;AAACP,QAAAA,UAAAA;AAAYH,QAAAA,aAAAA;AAAeC,QAAAA,gBAAAA;AAAkBT,QAAAA,YAAAA;AAAcC,QAAAA,UAAAA;AAAYK,QAAAA;AAAO,KAAA,CAAA;AAEnF;;;;"}

package/dist/admin/hooks/usePersistentQueryParams.js

@@ -4,6 +4,8 @@ var React = require('react');
 var strapiAdmin = require('@strapi/admin/strapi-admin');
 var get = require('lodash/get');
 var set = require('lodash/set');
+var qs = require('qs');
+var reactRouterDom = require('react-router-dom');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
@@ -30,7 +32,9 @@ const normalizeConfigEntry = (key, entry, scope)=>{
 };
 const usePersistentPartialQueryParams = (config)=>{
     const scope = strapiAdmin.usePersistentStateScope();
-    const [{ query }, setQuery] = strapiAdmin.useQueryParams();
+    const [{ query }] = strapiAdmin.useQueryParams();
+    const location = reactRouterDom.useLocation();
+    const navigate = reactRouterDom.useNavigate();
     const clonedConfig = JSON.stringify(config);
     const [isHydrated, setIsHydrated] = React.useState(false);
     // load query params from local storge
@@ -56,13 +60,22 @@ const usePersistentPartialQueryParams = (config)=>{
                 ...query
             };
             if (nextQuery.filters !== undefined) {
-                //`setQuery` never encodes the values, and it cannot be fixed as it would introduce breaking changes.
+                // The URL is written without encoding, as `setQuery` does everywhere, and that cannot change without breaking changes.
                 // This ensures that, when reading the persisted values and writing them in the URI, they are encoded properly.
                 // We are only encoding the filters because we know they can hold values with special characters. We didn't bother
                 // with the other query params because as of today, they are not expected to hold such values.
                 nextQuery.filters = strapiAdmin.deepEncodeQueryValues(nextQuery.filters);
             }
-            setQuery(nextQuery, 'push', true);
+            // What `setQuery(nextQuery, 'push', true)` does, but keeping the history entry's state: a page
+            // opened with state (e.g. `forceValidation` from Content Releases) must still find it there.
+            navigate({
+                search: qs.stringify(nextQuery, {
+                    encode: false
+                })
+            }, {
+                replace: true,
+                state: location.state
+            });
         }
         setIsHydrated(true);
     // eslint-disable-next-line react-hooks/exhaustive-deps

package/dist/admin/hooks/usePersistentQueryParams.js.map

@@ -1 +1 @@
-{"version":3,"file":"usePersistentQueryParams.js","sources":["../../../admin/src/hooks/usePersistentQueryParams.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\nimport {\n  deepEncodeQueryValues,\n  usePersistentStateScope,\n  useQueryParams,\n} from '@strapi/admin/strapi-admin';\nimport get from 'lodash/get';\nimport set from 'lodash/set';\n\ntype PropertyPath = Parameters<typeof get>[1];\n\ninterface PersistentQueryConfigEntry {\n  paths: PropertyPath[];\n  scoped?: boolean;\n}\n\nconst filterObjectKeys = (obj: object, keys: PropertyPath[]) => {\n  const result: Record<string, unknown> = {};\n\n  for (const path of keys) {\n    const value = get(obj, path);\n\n    if (value !== undefined) {\n      set(result, path, value);\n    }\n  }\n\n  return result;\n};\n\nexport type PersistentQueryConfig = Record<string, PersistentQueryConfigEntry>;\n\nconst normalizeConfigEntry = (\n  key: string,\n  entry: PersistentQueryConfigEntry,\n  scope: string | false | undefined\n) => {\n  const { paths } = entry;\n  const isScoped = entry.scoped === true && !!scope;\n\n  return {\n    key: isScoped ? `${key}:${scope}` : key,\n    paths,\n  };\n};\n\nexport const usePersistentPartialQueryParams = (config: PersistentQueryConfig) => {\n  const scope = usePersistentStateScope();\n  const [{ query }, setQuery] = useQueryParams();\n  const clonedConfig = JSON.stringify(config);\n  const [isHydrated, setIsHydrated] = useState(false);\n\n  // load query params from local storge\n  useEffect(() => {\n    const mergedFilteredQuery: Record<string, unknown> = {};\n\n    for (const [keyPrefix, entry] of Object.entries(config)) {\n      const { key, paths } = normalizeConfigEntry(keyPrefix, entry, scope);\n\n      const savedQueryParams = window.localStorage.getItem(key);\n      if (!savedQueryParams) continue;\n\n      let parsedSavedParams: Record<string, unknown>;\n      try {\n        parsedSavedParams = JSON.parse(savedQueryParams);\n      } catch {\n        continue;\n      }\n      if (Object.keys(parsedSavedParams).length === 0) continue;\n\n      const filteredQuery = filterObjectKeys(parsedSavedParams, paths);\n      Object.assign(mergedFilteredQuery, filteredQuery);\n    }\n\n    if (Object.keys(mergedFilteredQuery).length > 0) {\n      const nextQuery: Record<string, unknown> = { ...mergedFilteredQuery, ...query };\n\n      if (nextQuery.filters !== undefined) {\n        //`setQuery` never encodes the values, and it cannot be fixed as it would introduce breaking changes.\n        // This ensures that, when reading the persisted values and writing them in the URI, they are encoded properly.\n        // We are only encoding the filters because we know they can hold values with special characters. We didn't bother\n        // with the other query params because as of today, they are not expected to hold such values.\n        nextQuery.filters = deepEncodeQueryValues(nextQuery.filters);\n      }\n\n      setQuery(nextQuery, 'push', true);\n    }\n    setIsHydrated(true);\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [clonedConfig, scope]);\n\n  // update local storage\n  useEffect(() => {\n    for (const [keyPrefix, entry] of Object.entries(config)) {\n      const { key, paths } = normalizeConfigEntry(keyPrefix, entry, scope);\n\n      const paramsToPersist = filterObjectKeys(query, paths);\n      if (Object.keys(paramsToPersist).length === 0) {\n        window.localStorage.removeItem(key);\n        continue;\n      }\n\n      window.localStorage.setItem(key, JSON.stringify(paramsToPersist));\n    }\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [query, clonedConfig, scope]);\n\n  return { isHydrated };\n};\n"],"names":["filterObjectKeys","obj","keys","result","path","value","get","undefined","set","normalizeConfigEntry","key","entry","scope","paths","isScoped","scoped","usePersistentPartialQueryParams","config","usePersistentStateScope","query","setQuery","useQueryParams","clonedConfig","JSON","stringify","isHydrated","setIsHydrated","useState","useEffect","mergedFilteredQuery","keyPrefix","Object","entries","savedQueryParams","window","localStorage","getItem","parsedSavedParams","parse","length","filteredQuery","assign","nextQuery","filters","deepEncodeQueryValues","paramsToPersist","removeItem","setItem"],"mappings":";;;;;;;;;;;;AAiBA,MAAMA,gBAAAA,GAAmB,CAACC,GAAAA,EAAaC,IAAAA,GAAAA;AACrC,IAAA,MAAMC,SAAkC,EAAC;IAEzC,KAAK,MAAMC,QAAQF,IAAAA,CAAM;QACvB,MAAMG,KAAAA,GAAQC,qBAAIL,GAAAA,EAAKG,IAAAA,CAAAA;AAEvB,QAAA,IAAIC,UAAUE,SAAAA,EAAW;AACvBC,YAAAA,oBAAAA,CAAIL,QAAQC,IAAAA,EAAMC,KAAAA,CAAAA;AACpB,QAAA;AACF,IAAA;IAEA,OAAOF,MAAAA;AACT,CAAA;AAIA,MAAMM,oBAAAA,GAAuB,CAC3BC,GAAAA,EACAC,KAAAA,EACAC,KAAAA,GAAAA;IAEA,MAAM,EAAEC,KAAK,EAAE,GAAGF,KAAAA;AAClB,IAAA,MAAMG,WAAWH,KAAAA,CAAMI,MAAM,KAAK,IAAA,IAAQ,CAAC,CAACH,KAAAA;IAE5C,OAAO;AACLF,QAAAA,GAAAA,EAAKI,WAAW,CAAA,EAAGJ,GAAAA,CAAI,CAAC,EAAEE,OAAO,GAAGF,GAAAA;AACpCG,QAAAA;AACF,KAAA;AACF,CAAA;AAEO,MAAMG,kCAAkC,CAACC,MAAAA,GAAAA;AAC9C,IAAA,MAAML,KAAAA,GAAQM,mCAAAA,EAAAA;AACd,IAAA,MAAM,CAAC,EAAEC,KAAK,EAAE,EAAEC,SAAS,GAAGC,0BAAAA,EAAAA;IAC9B,MAAMC,YAAAA,GAAeC,IAAAA,CAAKC,SAAS,CAACP,MAAAA,CAAAA;AACpC,IAAA,MAAM,CAACQ,UAAAA,EAAYC,aAAAA,CAAc,GAAGC,cAAAA,CAAS,KAAA,CAAA;;IAG7CC,eAAAA,CAAU,IAAA;AACR,QAAA,MAAMC,sBAA+C,EAAC;QAEtD,KAAK,MAAM,CAACC,SAAAA,EAAWnB,KAAAA,CAAM,IAAIoB,MAAAA,CAAOC,OAAO,CAACf,MAAAA,CAAAA,CAAS;YACvD,MAAM,EAAEP,GAAG,EAAEG,KAAK,EAAE,GAAGJ,oBAAAA,CAAqBqB,WAAWnB,KAAAA,EAAOC,KAAAA,CAAAA;AAE9D,YAAA,MAAMqB,gBAAAA,GAAmBC,MAAAA,CAAOC,YAAY,CAACC,OAAO,CAAC1B,GAAAA,CAAAA;AACrD,YAAA,IAAI,CAACuB,gBAAAA,EAAkB;YAEvB,IAAII,iBAAAA;YACJ,IAAI;gBACFA,iBAAAA,GAAoBd,IAAAA,CAAKe,KAAK,CAACL,gBAAAA,CAAAA;AACjC,YAAA,CAAA,CAAE,OAAM;AACN,gBAAA;AACF,YAAA;AACA,YAAA,IAAIF,OAAO7B,IAAI,CAACmC,iBAAAA,CAAAA,CAAmBE,MAAM,KAAK,CAAA,EAAG;YAEjD,MAAMC,aAAAA,GAAgBxC,iBAAiBqC,iBAAAA,EAAmBxB,KAAAA,CAAAA;YAC1DkB,MAAAA,CAAOU,MAAM,CAACZ,mBAAAA,EAAqBW,aAAAA,CAAAA;AACrC,QAAA;AAEA,QAAA,IAAIT,OAAO7B,IAAI,CAAC2B,mBAAAA,CAAAA,CAAqBU,MAAM,GAAG,CAAA,EAAG;AAC/C,YAAA,MAAMG,SAAAA,GAAqC;AAAE,gBAAA,GAAGb,mBAAmB;AAAE,gBAAA,GAAGV;AAAM,aAAA;YAE9E,IAAIuB,SAAAA,CAAUC,OAAO,KAAKpC,SAAAA,EAAW;;;;;AAKnCmC,gBAAAA,SAAAA,CAAUC,OAAO,GAAGC,iCAAAA,CAAsBF,SAAAA,CAAUC,OAAO,CAAA;AAC7D,YAAA;AAEAvB,YAAAA,QAAAA,CAASsB,WAAW,MAAA,EAAQ,IAAA,CAAA;AAC9B,QAAA;QACAhB,aAAAA,CAAc,IAAA,CAAA;;IAEhB,CAAA,EAAG;AAACJ,QAAAA,YAAAA;AAAcV,QAAAA;AAAM,KAAA,CAAA;;IAGxBgB,eAAAA,CAAU,IAAA;QACR,KAAK,MAAM,CAACE,SAAAA,EAAWnB,KAAAA,CAAM,IAAIoB,MAAAA,CAAOC,OAAO,CAACf,MAAAA,CAAAA,CAAS;YACvD,MAAM,EAAEP,GAAG,EAAEG,KAAK,EAAE,GAAGJ,oBAAAA,CAAqBqB,WAAWnB,KAAAA,EAAOC,KAAAA,CAAAA;YAE9D,MAAMiC,eAAAA,GAAkB7C,iBAAiBmB,KAAAA,EAAON,KAAAA,CAAAA;AAChD,YAAA,IAAIkB,OAAO7B,IAAI,CAAC2C,eAAAA,CAAAA,CAAiBN,MAAM,KAAK,CAAA,EAAG;gBAC7CL,MAAAA,CAAOC,YAAY,CAACW,UAAU,CAACpC,GAAAA,CAAAA;AAC/B,gBAAA;AACF,YAAA;AAEAwB,YAAAA,MAAAA,CAAOC,YAAY,CAACY,OAAO,CAACrC,GAAAA,EAAKa,IAAAA,CAAKC,SAAS,CAACqB,eAAAA,CAAAA,CAAAA;AAClD,QAAA;;IAEF,CAAA,EAAG;AAAC1B,QAAAA,KAAAA;AAAOG,QAAAA,YAAAA;AAAcV,QAAAA;AAAM,KAAA,CAAA;IAE/B,OAAO;AAAEa,QAAAA;AAAW,KAAA;AACtB;;;;"}
+{"version":3,"file":"usePersistentQueryParams.js","sources":["../../../admin/src/hooks/usePersistentQueryParams.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\nimport {\n  deepEncodeQueryValues,\n  usePersistentStateScope,\n  useQueryParams,\n} from '@strapi/admin/strapi-admin';\nimport get from 'lodash/get';\nimport set from 'lodash/set';\nimport { stringify } from 'qs';\nimport { useLocation, useNavigate } from 'react-router-dom';\n\ntype PropertyPath = Parameters<typeof get>[1];\n\ninterface PersistentQueryConfigEntry {\n  paths: PropertyPath[];\n  scoped?: boolean;\n}\n\nconst filterObjectKeys = (obj: object, keys: PropertyPath[]) => {\n  const result: Record<string, unknown> = {};\n\n  for (const path of keys) {\n    const value = get(obj, path);\n\n    if (value !== undefined) {\n      set(result, path, value);\n    }\n  }\n\n  return result;\n};\n\nexport type PersistentQueryConfig = Record<string, PersistentQueryConfigEntry>;\n\nconst normalizeConfigEntry = (\n  key: string,\n  entry: PersistentQueryConfigEntry,\n  scope: string | false | undefined\n) => {\n  const { paths } = entry;\n  const isScoped = entry.scoped === true && !!scope;\n\n  return {\n    key: isScoped ? `${key}:${scope}` : key,\n    paths,\n  };\n};\n\nexport const usePersistentPartialQueryParams = (config: PersistentQueryConfig) => {\n  const scope = usePersistentStateScope();\n  const [{ query }] = useQueryParams();\n  const location = useLocation();\n  const navigate = useNavigate();\n  const clonedConfig = JSON.stringify(config);\n  const [isHydrated, setIsHydrated] = useState(false);\n\n  // load query params from local storge\n  useEffect(() => {\n    const mergedFilteredQuery: Record<string, unknown> = {};\n\n    for (const [keyPrefix, entry] of Object.entries(config)) {\n      const { key, paths } = normalizeConfigEntry(keyPrefix, entry, scope);\n\n      const savedQueryParams = window.localStorage.getItem(key);\n      if (!savedQueryParams) continue;\n\n      let parsedSavedParams: Record<string, unknown>;\n      try {\n        parsedSavedParams = JSON.parse(savedQueryParams);\n      } catch {\n        continue;\n      }\n      if (Object.keys(parsedSavedParams).length === 0) continue;\n\n      const filteredQuery = filterObjectKeys(parsedSavedParams, paths);\n      Object.assign(mergedFilteredQuery, filteredQuery);\n    }\n\n    if (Object.keys(mergedFilteredQuery).length > 0) {\n      const nextQuery: Record<string, unknown> = { ...mergedFilteredQuery, ...query };\n\n      if (nextQuery.filters !== undefined) {\n        // The URL is written without encoding, as `setQuery` does everywhere, and that cannot change without breaking changes.\n        // This ensures that, when reading the persisted values and writing them in the URI, they are encoded properly.\n        // We are only encoding the filters because we know they can hold values with special characters. We didn't bother\n        // with the other query params because as of today, they are not expected to hold such values.\n        nextQuery.filters = deepEncodeQueryValues(nextQuery.filters);\n      }\n\n      // What `setQuery(nextQuery, 'push', true)` does, but keeping the history entry's state: a page\n      // opened with state (e.g. `forceValidation` from Content Releases) must still find it there.\n      navigate(\n        { search: stringify(nextQuery, { encode: false }) },\n        { replace: true, state: location.state }\n      );\n    }\n    setIsHydrated(true);\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [clonedConfig, scope]);\n\n  // update local storage\n  useEffect(() => {\n    for (const [keyPrefix, entry] of Object.entries(config)) {\n      const { key, paths } = normalizeConfigEntry(keyPrefix, entry, scope);\n\n      const paramsToPersist = filterObjectKeys(query, paths);\n      if (Object.keys(paramsToPersist).length === 0) {\n        window.localStorage.removeItem(key);\n        continue;\n      }\n\n      window.localStorage.setItem(key, JSON.stringify(paramsToPersist));\n    }\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [query, clonedConfig, scope]);\n\n  return { isHydrated };\n};\n"],"names":["filterObjectKeys","obj","keys","result","path","value","get","undefined","set","normalizeConfigEntry","key","entry","scope","paths","isScoped","scoped","usePersistentPartialQueryParams","config","usePersistentStateScope","query","useQueryParams","location","useLocation","navigate","useNavigate","clonedConfig","JSON","stringify","isHydrated","setIsHydrated","useState","useEffect","mergedFilteredQuery","keyPrefix","Object","entries","savedQueryParams","window","localStorage","getItem","parsedSavedParams","parse","length","filteredQuery","assign","nextQuery","filters","deepEncodeQueryValues","search","encode","replace","state","paramsToPersist","removeItem","setItem"],"mappings":";;;;;;;;;;;;;;AAmBA,MAAMA,gBAAAA,GAAmB,CAACC,GAAAA,EAAaC,IAAAA,GAAAA;AACrC,IAAA,MAAMC,SAAkC,EAAC;IAEzC,KAAK,MAAMC,QAAQF,IAAAA,CAAM;QACvB,MAAMG,KAAAA,GAAQC,qBAAIL,GAAAA,EAAKG,IAAAA,CAAAA;AAEvB,QAAA,IAAIC,UAAUE,SAAAA,EAAW;AACvBC,YAAAA,oBAAAA,CAAIL,QAAQC,IAAAA,EAAMC,KAAAA,CAAAA;AACpB,QAAA;AACF,IAAA;IAEA,OAAOF,MAAAA;AACT,CAAA;AAIA,MAAMM,oBAAAA,GAAuB,CAC3BC,GAAAA,EACAC,KAAAA,EACAC,KAAAA,GAAAA;IAEA,MAAM,EAAEC,KAAK,EAAE,GAAGF,KAAAA;AAClB,IAAA,MAAMG,WAAWH,KAAAA,CAAMI,MAAM,KAAK,IAAA,IAAQ,CAAC,CAACH,KAAAA;IAE5C,OAAO;AACLF,QAAAA,GAAAA,EAAKI,WAAW,CAAA,EAAGJ,GAAAA,CAAI,CAAC,EAAEE,OAAO,GAAGF,GAAAA;AACpCG,QAAAA;AACF,KAAA;AACF,CAAA;AAEO,MAAMG,kCAAkC,CAACC,MAAAA,GAAAA;AAC9C,IAAA,MAAML,KAAAA,GAAQM,mCAAAA,EAAAA;AACd,IAAA,MAAM,CAAC,EAAEC,KAAK,EAAE,CAAC,GAAGC,0BAAAA,EAAAA;AACpB,IAAA,MAAMC,QAAAA,GAAWC,0BAAAA,EAAAA;AACjB,IAAA,MAAMC,QAAAA,GAAWC,0BAAAA,EAAAA;IACjB,MAAMC,YAAAA,GAAeC,IAAAA,CAAKC,SAAS,CAACV,MAAAA,CAAAA;AACpC,IAAA,MAAM,CAACW,UAAAA,EAAYC,aAAAA,CAAc,GAAGC,cAAAA,CAAS,KAAA,CAAA;;IAG7CC,eAAAA,CAAU,IAAA;AACR,QAAA,MAAMC,sBAA+C,EAAC;QAEtD,KAAK,MAAM,CAACC,SAAAA,EAAWtB,KAAAA,CAAM,IAAIuB,MAAAA,CAAOC,OAAO,CAAClB,MAAAA,CAAAA,CAAS;YACvD,MAAM,EAAEP,GAAG,EAAEG,KAAK,EAAE,GAAGJ,oBAAAA,CAAqBwB,WAAWtB,KAAAA,EAAOC,KAAAA,CAAAA;AAE9D,YAAA,MAAMwB,gBAAAA,GAAmBC,MAAAA,CAAOC,YAAY,CAACC,OAAO,CAAC7B,GAAAA,CAAAA;AACrD,YAAA,IAAI,CAAC0B,gBAAAA,EAAkB;YAEvB,IAAII,iBAAAA;YACJ,IAAI;gBACFA,iBAAAA,GAAoBd,IAAAA,CAAKe,KAAK,CAACL,gBAAAA,CAAAA;AACjC,YAAA,CAAA,CAAE,OAAM;AACN,gBAAA;AACF,YAAA;AACA,YAAA,IAAIF,OAAOhC,IAAI,CAACsC,iBAAAA,CAAAA,CAAmBE,MAAM,KAAK,CAAA,EAAG;YAEjD,MAAMC,aAAAA,GAAgB3C,iBAAiBwC,iBAAAA,EAAmB3B,KAAAA,CAAAA;YAC1DqB,MAAAA,CAAOU,MAAM,CAACZ,mBAAAA,EAAqBW,aAAAA,CAAAA;AACrC,QAAA;AAEA,QAAA,IAAIT,OAAOhC,IAAI,CAAC8B,mBAAAA,CAAAA,CAAqBU,MAAM,GAAG,CAAA,EAAG;AAC/C,YAAA,MAAMG,SAAAA,GAAqC;AAAE,gBAAA,GAAGb,mBAAmB;AAAE,gBAAA,GAAGb;AAAM,aAAA;YAE9E,IAAI0B,SAAAA,CAAUC,OAAO,KAAKvC,SAAAA,EAAW;;;;;AAKnCsC,gBAAAA,SAAAA,CAAUC,OAAO,GAAGC,iCAAAA,CAAsBF,SAAAA,CAAUC,OAAO,CAAA;AAC7D,YAAA;;;YAIAvB,QAAAA,CACE;AAAEyB,gBAAAA,MAAAA,EAAQrB,aAAUkB,SAAAA,EAAW;oBAAEI,MAAAA,EAAQ;AAAM,iBAAA;aAAG,EAClD;gBAAEC,OAAAA,EAAS,IAAA;AAAMC,gBAAAA,KAAAA,EAAO9B,SAAS8B;AAAM,aAAA,CAAA;AAE3C,QAAA;QACAtB,aAAAA,CAAc,IAAA,CAAA;;IAEhB,CAAA,EAAG;AAACJ,QAAAA,YAAAA;AAAcb,QAAAA;AAAM,KAAA,CAAA;;IAGxBmB,eAAAA,CAAU,IAAA;QACR,KAAK,MAAM,CAACE,SAAAA,EAAWtB,KAAAA,CAAM,IAAIuB,MAAAA,CAAOC,OAAO,CAAClB,MAAAA,CAAAA,CAAS;YACvD,MAAM,EAAEP,GAAG,EAAEG,KAAK,EAAE,GAAGJ,oBAAAA,CAAqBwB,WAAWtB,KAAAA,EAAOC,KAAAA,CAAAA;YAE9D,MAAMwC,eAAAA,GAAkBpD,iBAAiBmB,KAAAA,EAAON,KAAAA,CAAAA;AAChD,YAAA,IAAIqB,OAAOhC,IAAI,CAACkD,eAAAA,CAAAA,CAAiBV,MAAM,KAAK,CAAA,EAAG;gBAC7CL,MAAAA,CAAOC,YAAY,CAACe,UAAU,CAAC3C,GAAAA,CAAAA;AAC/B,gBAAA;AACF,YAAA;AAEA2B,YAAAA,MAAAA,CAAOC,YAAY,CAACgB,OAAO,CAAC5C,GAAAA,EAAKgB,IAAAA,CAAKC,SAAS,CAACyB,eAAAA,CAAAA,CAAAA;AAClD,QAAA;;IAEF,CAAA,EAAG;AAACjC,QAAAA,KAAAA;AAAOM,QAAAA,YAAAA;AAAcb,QAAAA;AAAM,KAAA,CAAA;IAE/B,OAAO;AAAEgB,QAAAA;AAAW,KAAA;AACtB;;;;"}

package/dist/admin/hooks/usePersistentQueryParams.mjs

@@ -2,6 +2,8 @@ import { useState, useEffect } from 'react';
 import { usePersistentStateScope, useQueryParams, deepEncodeQueryValues } from '@strapi/admin/strapi-admin';
 import get from 'lodash/get';
 import set from 'lodash/set';
+import { stringify } from 'qs';
+import { useLocation, useNavigate } from 'react-router-dom';
 
 const filterObjectKeys = (obj, keys)=>{
     const result = {};
@@ -23,7 +25,9 @@ const normalizeConfigEntry = (key, entry, scope)=>{
 };
 const usePersistentPartialQueryParams = (config)=>{
     const scope = usePersistentStateScope();
-    const [{ query }, setQuery] = useQueryParams();
+    const [{ query }] = useQueryParams();
+    const location = useLocation();
+    const navigate = useNavigate();
     const clonedConfig = JSON.stringify(config);
     const [isHydrated, setIsHydrated] = useState(false);
     // load query params from local storge
@@ -49,13 +53,22 @@ const usePersistentPartialQueryParams = (config)=>{
                 ...query
             };
             if (nextQuery.filters !== undefined) {
-                //`setQuery` never encodes the values, and it cannot be fixed as it would introduce breaking changes.
+                // The URL is written without encoding, as `setQuery` does everywhere, and that cannot change without breaking changes.
                 // This ensures that, when reading the persisted values and writing them in the URI, they are encoded properly.
                 // We are only encoding the filters because we know they can hold values with special characters. We didn't bother
                 // with the other query params because as of today, they are not expected to hold such values.
                 nextQuery.filters = deepEncodeQueryValues(nextQuery.filters);
             }
-            setQuery(nextQuery, 'push', true);
+            // What `setQuery(nextQuery, 'push', true)` does, but keeping the history entry's state: a page
+            // opened with state (e.g. `forceValidation` from Content Releases) must still find it there.
+            navigate({
+                search: stringify(nextQuery, {
+                    encode: false
+                })
+            }, {
+                replace: true,
+                state: location.state
+            });
         }
         setIsHydrated(true);
     // eslint-disable-next-line react-hooks/exhaustive-deps