payload 1.0.27 → 1.0.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. package/CHANGELOG.md +36 -4
  2. package/dist/admin/components/elements/Status/index.js +1 -1
  3. package/dist/admin/components/elements/ViewDescription/types.d.ts +1 -1
  4. package/dist/admin/components/elements/WhereBuilder/index.js +3 -1
  5. package/dist/admin/components/forms/field-types/Array/index.d.ts +3 -2
  6. package/dist/admin/components/forms/field-types/Array/index.js +201 -6
  7. package/dist/admin/components/forms/field-types/Blocks/index.d.ts +3 -2
  8. package/dist/admin/components/forms/field-types/Blocks/index.js +213 -6
  9. package/dist/admin/components/forms/field-types/Collapsible/index.js +2 -2
  10. package/dist/admin/components/forms/field-types/Row/index.js +2 -2
  11. package/dist/admin/components/forms/field-types/Tabs/index.js +2 -2
  12. package/dist/admin/components/forms/field-types/getFieldPath.d.ts +2 -0
  13. package/dist/admin/components/forms/field-types/getFieldPath.js +6 -0
  14. package/dist/admin/components/forms/field-types/index.d.ts +23 -23
  15. package/dist/admin/components/utilities/RenderCustomComponent/types.d.ts +2 -2
  16. package/dist/admin/components/views/collections/List/Cell/field-types/Relationship/index.js +1 -1
  17. package/dist/auth/operations/local/forgotPassword.js +3 -6
  18. package/dist/auth/operations/local/login.js +6 -9
  19. package/dist/auth/operations/local/resetPassword.js +4 -7
  20. package/dist/auth/operations/local/unlock.js +4 -7
  21. package/dist/collections/buildSchema.js +2 -1
  22. package/dist/collections/config/types.d.ts +2 -2
  23. package/dist/collections/dataloader.js +16 -8
  24. package/dist/collections/operations/local/create.d.ts +2 -2
  25. package/dist/collections/operations/local/create.js +11 -13
  26. package/dist/collections/operations/local/find.js +6 -10
  27. package/dist/collections/operations/local/findByID.js +6 -10
  28. package/dist/collections/operations/local/findVersionByID.js +6 -9
  29. package/dist/config/types.d.ts +13 -13
  30. package/dist/fields/config/sanitize.js +3 -3
  31. package/dist/fields/config/schema.js +3 -3
  32. package/dist/fields/config/types.d.ts +9 -9
  33. package/dist/fields/validations.js +43 -1
  34. package/dist/globals/config/types.d.ts +1 -1
  35. package/dist/mongoose/buildSchema.d.ts +1 -0
  36. package/dist/mongoose/buildSchema.js +3 -3
  37. package/dist/utilities/getIDType.d.ts +2 -0
  38. package/dist/utilities/getIDType.js +11 -0
  39. package/dist/utilities/isValidID.d.ts +1 -0
  40. package/dist/utilities/isValidID.js +16 -0
  41. package/docs/access-control/collections.mdx +21 -12
  42. package/docs/access-control/fields.mdx +5 -3
  43. package/docs/access-control/globals.mdx +8 -4
  44. package/docs/access-control/overview.mdx +1 -1
  45. package/docs/admin/components.mdx +29 -25
  46. package/docs/admin/customizing-css.mdx +2 -2
  47. package/docs/admin/overview.mdx +2 -2
  48. package/docs/admin/webpack.mdx +8 -7
  49. package/docs/authentication/config.mdx +14 -9
  50. package/docs/authentication/operations.mdx +22 -22
  51. package/docs/authentication/overview.mdx +8 -6
  52. package/docs/authentication/using-middleware.mdx +1 -1
  53. package/docs/configuration/collections.mdx +11 -7
  54. package/docs/configuration/globals.mdx +9 -5
  55. package/docs/configuration/localization.mdx +33 -31
  56. package/docs/configuration/overview.mdx +4 -7
  57. package/docs/email/overview.mdx +11 -7
  58. package/docs/fields/array.mdx +6 -5
  59. package/docs/fields/blocks.mdx +6 -4
  60. package/docs/fields/checkbox.mdx +6 -5
  61. package/docs/fields/code.mdx +6 -5
  62. package/docs/fields/collapsible.mdx +6 -5
  63. package/docs/fields/date.mdx +6 -5
  64. package/docs/fields/email.mdx +6 -5
  65. package/docs/fields/group.mdx +6 -5
  66. package/docs/fields/number.mdx +6 -5
  67. package/docs/fields/overview.mdx +40 -38
  68. package/docs/fields/point.mdx +6 -4
  69. package/docs/fields/radio.mdx +5 -3
  70. package/docs/fields/relationship.mdx +21 -21
  71. package/docs/fields/rich-text.mdx +9 -7
  72. package/docs/fields/row.mdx +5 -3
  73. package/docs/fields/select.mdx +4 -3
  74. package/docs/fields/tabs.mdx +5 -3
  75. package/docs/fields/text.mdx +5 -3
  76. package/docs/fields/textarea.mdx +5 -3
  77. package/docs/fields/ui.mdx +5 -3
  78. package/docs/fields/upload.mdx +5 -3
  79. package/docs/getting-started/concepts.mdx +1 -1
  80. package/docs/graphql/extending.mdx +1 -1
  81. package/docs/graphql/overview.mdx +8 -4
  82. package/docs/hooks/collections.mdx +62 -36
  83. package/docs/hooks/fields.mdx +5 -3
  84. package/docs/hooks/globals.mdx +25 -17
  85. package/docs/local-api/overview.mdx +27 -4
  86. package/docs/plugins/overview.mdx +3 -4
  87. package/docs/production/deployment.mdx +1 -1
  88. package/docs/queries/overview.mdx +4 -2
  89. package/docs/queries/pagination.mdx +1 -1
  90. package/docs/rest-api/overview.mdx +4 -2
  91. package/docs/upload/overview.mdx +35 -29
  92. package/docs/versions/autosave.mdx +4 -2
  93. package/docs/versions/drafts.mdx +8 -4
  94. package/docs/versions/overview.mdx +1 -1
  95. package/package.json +1 -1
  96. package/types.d.ts +21 -0
  97. package/dist/admin/components/forms/field-types/Array/Array.d.ts +0 -5
  98. package/dist/admin/components/forms/field-types/Array/Array.js +0 -201
  99. package/dist/admin/components/forms/field-types/Blocks/Blocks.d.ts +0 -5
  100. package/dist/admin/components/forms/field-types/Blocks/Blocks.js +0 -213
@@ -1,213 +0,0 @@
1
- import React, { useCallback, useEffect, useReducer, useState } from 'react';
2
- import { DragDropContext, Draggable, Droppable } from 'react-beautiful-dnd';
3
- import { useAuth } from '../../../utilities/Auth';
4
- import { usePreferences } from '../../../utilities/Preferences';
5
- import { useLocale } from '../../../utilities/Locale';
6
- import withCondition from '../../withCondition';
7
- import Button from '../../../elements/Button';
8
- import reducer from '../rowReducer';
9
- import { useDocumentInfo } from '../../../utilities/DocumentInfo';
10
- import { useForm } from '../../Form/context';
11
- import buildStateFromSchema from '../../Form/buildStateFromSchema';
12
- import Error from '../../Error';
13
- import useField from '../../useField';
14
- import Popup from '../../../elements/Popup';
15
- import BlockSelector from './BlockSelector';
16
- import { blocks as blocksValidator } from '../../../../../fields/validations';
17
- import Banner from '../../../elements/Banner';
18
- import FieldDescription from '../../FieldDescription';
19
- import { useOperation } from '../../../utilities/OperationProvider';
20
- import { Collapsible } from '../../../elements/Collapsible';
21
- import { ArrayAction } from '../../../elements/ArrayAction';
22
- import RenderFields from '../../RenderFields';
23
- import { fieldAffectsData } from '../../../../../fields/config/types';
24
- import SectionTitle from './SectionTitle';
25
- import Pill from '../../../elements/Pill';
26
- import { scrollToID } from '../../../../utilities/scrollToID';
27
- import HiddenInput from '../HiddenInput';
28
- import './index.scss';
29
- const baseClass = 'blocks-field';
30
- const labelDefaults = {
31
- singular: 'Block',
32
- plural: 'Blocks',
33
- };
34
- const Blocks = (props) => {
35
- const { label, name, path: pathFromProps, blocks, labels = labelDefaults, fieldTypes, maxRows, minRows, required, validate = blocksValidator, permissions, admin: { readOnly, description, condition, className, }, } = props;
36
- const path = pathFromProps || name;
37
- const { preferencesKey } = useDocumentInfo();
38
- const { getPreference } = usePreferences();
39
- const { setPreference } = usePreferences();
40
- const [rows, dispatchRows] = useReducer(reducer, undefined);
41
- const formContext = useForm();
42
- const { user } = useAuth();
43
- const { id } = useDocumentInfo();
44
- const locale = useLocale();
45
- const operation = useOperation();
46
- const { dispatchFields } = formContext;
47
- const memoizedValidate = useCallback((value, options) => {
48
- return validate(value, { ...options, minRows, maxRows, required });
49
- }, [maxRows, minRows, required, validate]);
50
- const [disableFormData, setDisableFormData] = useState(false);
51
- const [selectorIndexOpen, setSelectorIndexOpen] = useState();
52
- const { showError, errorMessage, value, setValue, } = useField({
53
- path,
54
- validate: memoizedValidate,
55
- disableFormData,
56
- condition,
57
- });
58
- const onAddPopupToggle = useCallback((open) => {
59
- if (!open) {
60
- setSelectorIndexOpen(undefined);
61
- }
62
- }, []);
63
- const addRow = useCallback(async (rowIndex, blockType) => {
64
- const block = blocks.find((potentialBlock) => potentialBlock.slug === blockType);
65
- const subFieldState = await buildStateFromSchema({ fieldSchema: block.fields, operation, id, user, locale });
66
- dispatchFields({ type: 'ADD_ROW', rowIndex, subFieldState, path, blockType });
67
- dispatchRows({ type: 'ADD', rowIndex, blockType });
68
- setValue(value + 1);
69
- setTimeout(() => {
70
- scrollToID(`${path}-row-${rowIndex + 1}`);
71
- }, 0);
72
- }, [path, setValue, value, blocks, dispatchFields, operation, id, user, locale]);
73
- const duplicateRow = useCallback(async (rowIndex, blockType) => {
74
- dispatchFields({ type: 'DUPLICATE_ROW', rowIndex, path });
75
- dispatchRows({ type: 'ADD', rowIndex, blockType });
76
- setValue(value + 1);
77
- setTimeout(() => {
78
- scrollToID(`${path}-row-${rowIndex + 1}`);
79
- }, 0);
80
- }, [dispatchRows, dispatchFields, path, setValue, value]);
81
- const removeRow = useCallback((rowIndex) => {
82
- dispatchRows({ type: 'REMOVE', rowIndex });
83
- dispatchFields({ type: 'REMOVE_ROW', rowIndex, path });
84
- setValue(value - 1);
85
- }, [path, setValue, value, dispatchFields]);
86
- const moveRow = useCallback((moveFromIndex, moveToIndex) => {
87
- dispatchRows({ type: 'MOVE', moveFromIndex, moveToIndex });
88
- dispatchFields({ type: 'MOVE_ROW', moveFromIndex, moveToIndex, path });
89
- }, [dispatchRows, dispatchFields, path]);
90
- const onDragEnd = useCallback((result) => {
91
- if (!result.destination)
92
- return;
93
- const sourceIndex = result.source.index;
94
- const destinationIndex = result.destination.index;
95
- moveRow(sourceIndex, destinationIndex);
96
- }, [moveRow]);
97
- const setCollapse = useCallback(async (rowID, collapsed) => {
98
- var _a, _b, _c;
99
- dispatchRows({ type: 'SET_COLLAPSE', id: rowID, collapsed });
100
- if (preferencesKey) {
101
- const preferencesToSet = await getPreference(preferencesKey) || { fields: {} };
102
- let newCollapsedState = ((_b = (_a = preferencesToSet === null || preferencesToSet === void 0 ? void 0 : preferencesToSet.fields) === null || _a === void 0 ? void 0 : _a[path]) === null || _b === void 0 ? void 0 : _b.collapsed.filter((filterID) => (rows.find((row) => row.id === filterID))))
103
- || [];
104
- if (!collapsed) {
105
- newCollapsedState = newCollapsedState.filter((existingID) => existingID !== rowID);
106
- }
107
- else {
108
- newCollapsedState.push(rowID);
109
- }
110
- setPreference(preferencesKey, {
111
- ...preferencesToSet,
112
- fields: {
113
- ...(preferencesToSet === null || preferencesToSet === void 0 ? void 0 : preferencesToSet.fields) || {},
114
- [path]: {
115
- ...(_c = preferencesToSet === null || preferencesToSet === void 0 ? void 0 : preferencesToSet.fields) === null || _c === void 0 ? void 0 : _c[path],
116
- collapsed: newCollapsedState,
117
- },
118
- },
119
- });
120
- }
121
- }, [preferencesKey, getPreference, path, setPreference, rows]);
122
- const toggleCollapseAll = useCallback(async (collapse) => {
123
- var _a;
124
- dispatchRows({ type: 'SET_ALL_COLLAPSED', collapse });
125
- if (preferencesKey) {
126
- const preferencesToSet = await getPreference(preferencesKey) || { fields: {} };
127
- setPreference(preferencesKey, {
128
- ...preferencesToSet,
129
- fields: {
130
- ...(preferencesToSet === null || preferencesToSet === void 0 ? void 0 : preferencesToSet.fields) || {},
131
- [path]: {
132
- ...(_a = preferencesToSet === null || preferencesToSet === void 0 ? void 0 : preferencesToSet.fields) === null || _a === void 0 ? void 0 : _a[path],
133
- collapsed: collapse ? rows.map(({ id: rowID }) => rowID) : [],
134
- },
135
- },
136
- });
137
- }
138
- }, [getPreference, path, preferencesKey, rows, setPreference]);
139
- // Set row count on mount and when form context is reset
140
- useEffect(() => {
141
- const initializeRowState = async () => {
142
- var _a, _b;
143
- const data = formContext.getDataByPath(path);
144
- const preferences = await getPreference(preferencesKey) || { fields: {} };
145
- dispatchRows({ type: 'SET_ALL', data: data || [], collapsedState: (_b = (_a = preferences === null || preferences === void 0 ? void 0 : preferences.fields) === null || _a === void 0 ? void 0 : _a[path]) === null || _b === void 0 ? void 0 : _b.collapsed });
146
- };
147
- initializeRowState();
148
- }, [formContext, path, getPreference, preferencesKey]);
149
- useEffect(() => {
150
- setValue((rows === null || rows === void 0 ? void 0 : rows.length) || 0, true);
151
- if ((rows === null || rows === void 0 ? void 0 : rows.length) === 0) {
152
- setDisableFormData(false);
153
- }
154
- else {
155
- setDisableFormData(true);
156
- }
157
- }, [rows, setValue]);
158
- const hasMaxRows = maxRows && (rows === null || rows === void 0 ? void 0 : rows.length) >= maxRows;
159
- const classes = [
160
- 'field-type',
161
- baseClass,
162
- className,
163
- ].filter(Boolean).join(' ');
164
- if (!rows)
165
- return null;
166
- return (React.createElement(DragDropContext, { onDragEnd: onDragEnd },
167
- React.createElement("div", { id: `field-${path.replace(/\./gi, '__')}`, className: classes },
168
- React.createElement("div", { className: `${baseClass}__error-wrap` },
169
- React.createElement(Error, { showError: showError, message: errorMessage })),
170
- React.createElement("header", { className: `${baseClass}__header` },
171
- React.createElement("div", { className: `${baseClass}__header-wrap` },
172
- React.createElement("h3", null, label),
173
- React.createElement("ul", { className: `${baseClass}__header-actions` },
174
- React.createElement("li", null,
175
- React.createElement("button", { type: "button", onClick: () => toggleCollapseAll(true), className: `${baseClass}__header-action` }, "Collapse All")),
176
- React.createElement("li", null,
177
- React.createElement("button", { type: "button", onClick: () => toggleCollapseAll(false), className: `${baseClass}__header-action` }, "Show All")))),
178
- React.createElement(FieldDescription, { value: value, description: description })),
179
- React.createElement(Droppable, { droppableId: "blocks-drop", isDropDisabled: readOnly }, (provided) => (React.createElement("div", { ref: provided.innerRef, ...provided.droppableProps },
180
- rows.length > 0 && rows.map((row, i) => {
181
- const { blockType } = row;
182
- const blockToRender = blocks.find((block) => block.slug === blockType);
183
- const rowNumber = i + 1;
184
- if (blockToRender) {
185
- return (React.createElement(Draggable, { key: row.id, draggableId: row.id, index: i, isDragDisabled: readOnly }, (providedDrag) => (React.createElement("div", { id: `${path}-row-${i}`, ref: providedDrag.innerRef, ...providedDrag.draggableProps },
186
- React.createElement(Collapsible, { collapsed: row.collapsed, onToggle: (collapsed) => setCollapse(row.id, collapsed), className: `${baseClass}__row`, key: row.id, dragHandleProps: providedDrag.dragHandleProps, header: (React.createElement("div", { className: `${baseClass}__block-header` },
187
- React.createElement("span", { className: `${baseClass}__block-number` }, rowNumber >= 10 ? rowNumber : `0${rowNumber}`),
188
- React.createElement(Pill, { pillStyle: "white", className: `${baseClass}__block-pill ${baseClass}__block-pill-${blockType}` }, blockToRender.labels.singular),
189
- React.createElement(SectionTitle, { path: `${path}.${i}.blockName`, readOnly: readOnly }))), actions: !readOnly ? (React.createElement(React.Fragment, null,
190
- React.createElement(Popup, { key: `${blockType}-${i}`, forceOpen: selectorIndexOpen === i, onToggleOpen: onAddPopupToggle, buttonType: "none", size: "large", horizontalAlign: "right", render: ({ close }) => (React.createElement(BlockSelector, { blocks: blocks, addRow: addRow, addRowIndex: i, close: close })) }),
191
- React.createElement(ArrayAction, { rowCount: rows.length, duplicateRow: () => duplicateRow(i, blockType), addRow: () => setSelectorIndexOpen(i), moveRow: moveRow, removeRow: removeRow, index: i }))) : undefined },
192
- React.createElement(HiddenInput, { name: `${path}.${i}.id`, value: row.id }),
193
- React.createElement(RenderFields, { className: `${baseClass}__fields`, forceRender: true, readOnly: readOnly, fieldTypes: fieldTypes, permissions: permissions === null || permissions === void 0 ? void 0 : permissions.fields, fieldSchema: blockToRender.fields.map((field) => ({
194
- ...field,
195
- path: `${path}.${i}${fieldAffectsData(field) ? `.${field.name}` : ''}`,
196
- })) }))))));
197
- }
198
- return null;
199
- }),
200
- (rows.length < minRows || (required && rows.length === 0)) && (React.createElement(Banner, { type: "error" },
201
- "This field requires at least",
202
- ' ',
203
- `${minRows || 1} ${minRows === 1 || typeof minRows === 'undefined' ? labels.singular : labels.plural}`)),
204
- (rows.length === 0 && readOnly) && (React.createElement(Banner, null,
205
- "This field has no",
206
- ' ',
207
- labels.plural,
208
- ".")),
209
- provided.placeholder))),
210
- (!readOnly && !hasMaxRows) && (React.createElement("div", { className: `${baseClass}__add-button-wrap` },
211
- React.createElement(Popup, { buttonType: "custom", size: "large", horizontalAlign: "left", button: (React.createElement(Button, { buttonStyle: "icon-label", icon: "plus", iconPosition: "left", iconStyle: "with-border" }, `Add ${labels.singular}`)), render: ({ close }) => (React.createElement(BlockSelector, { blocks: blocks, addRow: addRow, addRowIndex: value, close: close })) }))))));
212
- };
213
- export default withCondition(Blocks);