@sanity/document-internationalization 0.1.5 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v0.1.7
+* For base I18n documents the default "Delete" action will now be replaced with the Delete (incl. translations)" action. The default "Delete" action does not make sense for base documents in any scenario as it results in broken references.
+
+## v0.1.6
+* Fixed translation maintenance functionality
+
 ## v0.1.5
 * Don't override `child` resolver as it is not required anymore. This way it will correctly fallback on the Studio's structure definition
 

package/lib/actions/DeleteWithi18nAction.d.ts

@@ -1,16 +1,2 @@
-/// <reference types="react" />
-import { IResolverProps } from '../types';
-export declare const DeleteWithi18nAction: ({ id, type, onComplete }: IResolverProps) => {
-    onHandle: () => void;
-    color: string;
-    icon: any;
-    disabled: boolean;
-    title: any;
-    label: string;
-    dialog: false | {
-        type: string;
-        onClose: (() => void) | undefined;
-        title: string;
-        content: JSX.Element | null;
-    };
-};
+import type { DocumentActionComponent } from '@sanity/base';
+export declare const DeleteWithi18nAction: DocumentActionComponent;

package/lib/actions/DuplicateWithi18nAction.d.ts

@@ -1,8 +1,2 @@
-import { IResolverProps } from '../types';
-export declare const DuplicateWithi18nAction: (props: IResolverProps) => {
-    icon: any;
-    disabled: boolean;
-    title: any;
-    label: string;
-    onHandle: () => Promise<void>;
-};
+import type { DocumentActionComponent } from '@sanity/base';
+export declare const DuplicateWithi18nAction: DocumentActionComponent;

package/lib/actions/PublishWithi18nAction.d.ts

@@ -1,9 +1,2 @@
-import * as React from 'react';
-import { IResolverProps } from '../types';
-export declare const PublishWithi18nAction: ({ type, id, onComplete }: IResolverProps) => {
-    disabled: boolean;
-    label: string;
-    icon: React.ForwardRefExoticComponent<Pick<React.SVGProps<SVGSVGElement>, "string" | "fr" | "id" | "lang" | "name" | "path" | "type" | "ideographic" | "alphabetic" | "hanging" | "mathematical" | "className" | "color" | "height" | "max" | "media" | "method" | "min" | "style" | "target" | "width" | "role" | "tabIndex" | "crossOrigin" | "accentHeight" | "accumulate" | "additive" | "alignmentBaseline" | "allowReorder" | "amplitude" | "arabicForm" | "ascent" | "attributeName" | "attributeType" | "autoReverse" | "azimuth" | "baseFrequency" | "baselineShift" | "baseProfile" | "bbox" | "begin" | "bias" | "by" | "calcMode" | "capHeight" | "clip" | "clipPath" | "clipPathUnits" | "clipRule" | "colorInterpolation" | "colorInterpolationFilters" | "colorProfile" | "colorRendering" | "contentScriptType" | "contentStyleType" | "cursor" | "cx" | "cy" | "d" | "decelerate" | "descent" | "diffuseConstant" | "direction" | "display" | "divisor" | "dominantBaseline" | "dur" | "dx" | "dy" | "edgeMode" | "elevation" | "enableBackground" | "end" | "exponent" | "externalResourcesRequired" | "fill" | "fillOpacity" | "fillRule" | "filter" | "filterRes" | "filterUnits" | "floodColor" | "floodOpacity" | "focusable" | "fontFamily" | "fontSize" | "fontSizeAdjust" | "fontStretch" | "fontStyle" | "fontVariant" | "fontWeight" | "format" | "from" | "fx" | "fy" | "g1" | "g2" | "glyphName" | "glyphOrientationHorizontal" | "glyphOrientationVertical" | "glyphRef" | "gradientTransform" | "gradientUnits" | "horizAdvX" | "horizOriginX" | "href" | "imageRendering" | "in2" | "in" | "intercept" | "k1" | "k2" | "k3" | "k4" | "k" | "kernelMatrix" | "kernelUnitLength" | "kerning" | "keyPoints" | "keySplines" | "keyTimes" | "lengthAdjust" | "letterSpacing" | "lightingColor" | "limitingConeAngle" | "local" | "markerEnd" | "markerHeight" | "markerMid" | "markerStart" | "markerUnits" | "markerWidth" | "mask" | "maskContentUnits" | "maskUnits" | "mode" | "numOctaves" | "offset" | "opacity" | "operator" | "order" | "orient" | "orientation" | "origin" | "overflow" | "overlinePosition" | "overlineThickness" | "paintOrder" | "panose1" | "pathLength" | "patternContentUnits" | "patternTransform" | "patternUnits" | "pointerEvents" | "points" | "pointsAtX" | "pointsAtY" | "pointsAtZ" | "preserveAlpha" | "preserveAspectRatio" | "primitiveUnits" | "r" | "radius" | "refX" | "refY" | "renderingIntent" | "repeatCount" | "repeatDur" | "requiredExtensions" | "requiredFeatures" | "restart" | "result" | "rotate" | "rx" | "ry" | "scale" | "seed" | "shapeRendering" | "slope" | "spacing" | "specularConstant" | "specularExponent" | "speed" | "spreadMethod" | "startOffset" | "stdDeviation" | "stemh" | "stemv" | "stitchTiles" | "stopColor" | "stopOpacity" | "strikethroughPosition" | "strikethroughThickness" | "stroke" | "strokeDasharray" | "strokeDashoffset" | "strokeLinecap" | "strokeLinejoin" | "strokeMiterlimit" | "strokeOpacity" | "strokeWidth" | "surfaceScale" | "systemLanguage" | "tableValues" | "targetX" | "targetY" | "textAnchor" | "textDecoration" | "textLength" | "textRendering" | "to" | "transform" | "u1" | "u2" | "underlinePosition" | "underlineThickness" | "unicode" | "unicodeBidi" | "unicodeRange" | "unitsPerEm" | "vAlphabetic" | "values" | "vectorEffect" | "version" | "vertAdvY" | "vertOriginX" | "vertOriginY" | "vHanging" | "vIdeographic" | "viewBox" | "viewTarget" | "visibility" | "vMathematical" | "widths" | "wordSpacing" | "writingMode" | "x1" | "x2" | "x" | "xChannelSelector" | "xHeight" | "xlinkActuate" | "xlinkArcrole" | "xlinkHref" | "xlinkRole" | "xlinkShow" | "xlinkTitle" | "xlinkType" | "xmlBase" | "xmlLang" | "xmlns" | "xmlnsXlink" | "xmlSpace" | "y1" | "y2" | "y" | "yChannelSelector" | "z" | "zoomAndPan" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "key"> & React.RefAttributes<SVGSVGElement>>;
-    shortcut: string | null;
-    onHandle: () => void;
-};
+import type { DocumentActionComponent } from '@sanity/base';
+export declare const PublishWithi18nAction: DocumentActionComponent;

package/lib/actions/index.d.ts

@@ -1,8 +1,9 @@
 import 'regenerator-runtime';
+import type { DocumentActionComponent } from '@sanity/base';
 import { IResolverProps } from '../types';
 import { PublishWithi18nAction } from './PublishWithi18nAction';
 import { DeleteWithi18nAction } from './DeleteWithi18nAction';
 import { DuplicateWithi18nAction } from './DuplicateWithi18nAction';
 export { PublishWithi18nAction, DeleteWithi18nAction, DuplicateWithi18nAction };
-declare const _default: (props: IResolverProps) => any;
+declare const _default: (props: IResolverProps) => DocumentActionComponent[];
 export default _default;

package/lib/actions/index.js

@@ -3,20 +3,20 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var defaultResolve = require('part:@sanity/base/document-actions');
-var _asyncToGenerator = require('@babel/runtime/helpers/asyncToGenerator');
-var _slicedToArray = require('@babel/runtime/helpers/slicedToArray');
-var _regeneratorRuntime = require('@babel/runtime/regenerator');
-var React = require('react');
-var reactHooks = require('@sanity/react-hooks');
-var ui = require('@sanity/ui');
-var icons = require('@sanity/icons');
 var config = require('config:@sanity/document-internationalization');
 var schemas = require('part:@sanity/base/schema');
 var client = require('part:@sanity/base/client');
+var _asyncToGenerator = require('@babel/runtime/helpers/asyncToGenerator');
+var _regeneratorRuntime = require('@babel/runtime/regenerator');
 var languagesLoaderFn = require('part:@sanity/document-internationalization/languages/loader?');
 var _defineProperty = require('@babel/runtime/helpers/defineProperty');
 var _ = require('lodash');
 require('@sanity/types');
+var _slicedToArray = require('@babel/runtime/helpers/slicedToArray');
+var React = require('react');
+var reactHooks = require('@sanity/react-hooks');
+var ui = require('@sanity/ui');
+var icons = require('@sanity/icons');
 var TrashIcon = require('part:@sanity/base/trash-icon');
 var ConfirmDeleteDialog = require('@sanity/desk-tool/lib/components/confirmDeleteDialog/ConfirmDeleteDialog');
 var ContentCopyIcon = require('part:@sanity/base/content-copy-icon');
@@ -43,17 +43,17 @@ function _interopNamespace(e) {
 }
 
 var defaultResolve__default = /*#__PURE__*/_interopDefaultLegacy(defaultResolve);
-var _asyncToGenerator__default = /*#__PURE__*/_interopDefaultLegacy(_asyncToGenerator);
-var _slicedToArray__default = /*#__PURE__*/_interopDefaultLegacy(_slicedToArray);
-var _regeneratorRuntime__default = /*#__PURE__*/_interopDefaultLegacy(_regeneratorRuntime);
-var React__namespace = /*#__PURE__*/_interopNamespace(React);
-var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var config__default = /*#__PURE__*/_interopDefaultLegacy(config);
 var schemas__default = /*#__PURE__*/_interopDefaultLegacy(schemas);
 var client__default = /*#__PURE__*/_interopDefaultLegacy(client);
+var _asyncToGenerator__default = /*#__PURE__*/_interopDefaultLegacy(_asyncToGenerator);
+var _regeneratorRuntime__default = /*#__PURE__*/_interopDefaultLegacy(_regeneratorRuntime);
 var languagesLoaderFn__default = /*#__PURE__*/_interopDefaultLegacy(languagesLoaderFn);
 var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_defineProperty);
 var ___default = /*#__PURE__*/_interopDefaultLegacy(_);
+var _slicedToArray__default = /*#__PURE__*/_interopDefaultLegacy(_slicedToArray);
+var React__namespace = /*#__PURE__*/_interopNamespace(React);
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var TrashIcon__default = /*#__PURE__*/_interopDefaultLegacy(TrashIcon);
 var ContentCopyIcon__default = /*#__PURE__*/_interopDefaultLegacy(ContentCopyIcon);
 
@@ -2006,15 +2006,10 @@ function useDelayedFlag() {
   var delayedOn = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
   var delayedOff = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : true;
 
-  var _useState = React.useState(Date.now()),
-      _useState2 = _slicedToArray__default["default"](_useState, 2);
-      _useState2[0];
-      _useState2[1];
-
-  var _useState3 = React.useState(value),
-      _useState4 = _slicedToArray__default["default"](_useState3, 2),
-      flag = _useState4[0],
-      setFlag = _useState4[1];
+  var _useState = React.useState(value),
+      _useState2 = _slicedToArray__default["default"](_useState, 2),
+      flag = _useState2[0],
+      setFlag = _useState2[1];
 
   React.useEffect(function () {
     if (flag !== value) {
@@ -2026,9 +2021,9 @@ function useDelayedFlag() {
           return function () {
             return clearTimeout(timeoutId);
           };
-        } else {
-          setFlag(true);
         }
+
+        setFlag(true);
       } else if (!value) {
         if (delayedOff) {
           var _timeoutId = setTimeout(function () {
@@ -2038,11 +2033,13 @@ function useDelayedFlag() {
           return function () {
             return clearTimeout(_timeoutId);
           };
-        } else {
-          setFlag(false);
         }
+
+        setFlag(false);
       }
     }
+
+    return undefined;
   }, [value, timeout, delayedOn, delayedOff]);
   return flag;
 }
@@ -2053,6 +2050,7 @@ var PublishWithi18nAction = function PublishWithi18nAction(_ref) {
       onComplete = _ref.onComplete;
   var toast = ui.useToast();
   var baseDocumentId = getBaseIdFromId(id);
+  var updatingIntlFieldsPromiseRef = React__namespace.useRef(null);
 
   var _React$useState = React__namespace.useState(null),
       _React$useState2 = _slicedToArray__default["default"](_React$useState, 2),
@@ -2159,11 +2157,15 @@ var PublishWithi18nAction = function PublishWithi18nAction(_ref) {
   }, [publishState, draft]);
   React__namespace.useEffect(function () {
     if (publishState === 'published') {
-      doUpdateIntlFields().then(function () {
-        if (onComplete) onComplete();
-      });
+      if (!updatingIntlFieldsPromiseRef.current) {
+        updatingIntlFieldsPromiseRef.current = doUpdateIntlFields().then(function () {
+          return onComplete && onComplete();
+        })["finally"](function () {
+          return updatingIntlFieldsPromiseRef.current = null;
+        });
+      }
     }
-  }, [publishState]);
+  }, [publishState, onComplete, doUpdateIntlFields]);
   return {
     disabled: disabled,
     label: label,
@@ -2304,6 +2306,7 @@ var DeleteWithi18nAction = function DeleteWithi18nAction(_ref) {
     color: 'danger',
     icon: TrashIcon__default["default"],
     disabled: isDeleting || Boolean(deleteOp.disabled) || syncState.isSyncing || baseDocumentSyncState.isSyncing,
+    shortcut: 'CTRL+ALT+D',
     title: deleteOp.disabled && DISABLED_REASON_TITLE$1[deleteOp.disabled] || '',
     label: isDeleting ? UiMessages.deleteAll.deleting : UiMessages.deleteAll.buttonTitle,
     dialog: isConfirmDialogOpen && {
@@ -2325,13 +2328,17 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 var DISABLED_REASON_TITLE = {
   NOTHING_TO_DUPLICATE: "This document doesn't yet exist so there's nothing to duplicate"
 };
-var DuplicateWithi18nAction = function DuplicateWithi18nAction(props) {
+var DuplicateWithi18nAction = function DuplicateWithi18nAction(_ref) {
+  var id = _ref.id,
+      type = _ref.type,
+      draft = _ref.draft,
+      published = _ref.published;
   var toast = ui.useToast();
   var client = getSanityClient();
-  var baseDocumentId = getBaseIdFromId(props.id);
+  var baseDocumentId = getBaseIdFromId(id);
 
-  var _ref = reactHooks.useDocumentOperation(props.id, props.type),
-      duplicateOp = _ref.duplicate;
+  var _ref2 = reactHooks.useDocumentOperation(id, type),
+      duplicateOp = _ref2.duplicate;
 
   var _React$useState = React__default["default"].useState(false),
       _React$useState2 = _slicedToArray__default["default"](_React$useState, 2),
@@ -2339,8 +2346,7 @@ var DuplicateWithi18nAction = function DuplicateWithi18nAction(props) {
       setDuplicating = _React$useState2[1];
 
   var onDuplicate = React__default["default"].useCallback( /*#__PURE__*/_asyncToGenerator__default["default"]( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee() {
-    var _props$draft, dupeId, translations, transaction;
-
+    var dupeId, translations, transaction;
     return _regeneratorRuntime__default["default"].wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
@@ -2354,9 +2360,9 @@ var DuplicateWithi18nAction = function DuplicateWithi18nAction(props) {
           case 5:
             translations = _context.sent;
             transaction = client.transaction();
-            transaction.create(_objectSpread(_objectSpread({}, (_props$draft = props.draft) !== null && _props$draft !== void 0 ? _props$draft : props.published), {}, {
+            transaction.create(_objectSpread(_objectSpread({}, draft !== null && draft !== void 0 ? draft : published), {}, {
               _id: dupeId,
-              _type: props.type
+              _type: type
             }));
             translations.forEach(function (t) {
               var isDraft = t._id.startsWith('drafts.');
@@ -2388,7 +2394,7 @@ var DuplicateWithi18nAction = function DuplicateWithi18nAction(props) {
         }
       }
     }, _callee, null, [[1, 13]]);
-  })), [baseDocumentId, props.onComplete, props.type, props.draft, props.published]);
+  })), [client, toast, baseDocumentId, type, draft, published]);
   return {
     icon: ContentCopyIcon__default["default"],
     disabled: Boolean(duplicateOp.disabled) || isDuplicating,
@@ -2401,13 +2407,29 @@ var DuplicateWithi18nAction = function DuplicateWithi18nAction(props) {
 var index = (function (props) {
   var schema = getSchema(props.type);
   var isI18n = schema && schema.i18n;
-  var actions = defaultResolve__default["default"](props).map(function (Action) {
-    return Action === defaultResolve.PublishAction && isI18n ? PublishWithi18nAction : Action;
-  });
+  var isBase = props.id == getBaseIdFromId(props.id);
+  var actions = defaultResolve__default["default"](props);
+
+  if (isI18n) {
+    actions = actions.map(function (Action) {
+      var isPublishAction = Action === defaultResolve.PublishAction;
+      var isDeleteAction = Action === defaultResolve.DeleteAction; // replace default publish actions with i18n publish actions
+
+      if (isPublishAction) {
+        return PublishWithi18nAction;
+      } // replace base delete action with delete with i18n action
 
-  if (isI18n && props.id == getBaseIdFromId(props.id)) {
-    actions.push(DuplicateWithi18nAction);
-    actions.push(DeleteWithi18nAction);
+
+      if (isDeleteAction && isBase) {
+        return DeleteWithi18nAction;
+      }
+
+      return Action;
+    }); // push duplicate action
+
+    if (isBase) {
+      actions.push(DuplicateWithi18nAction);
+    }
   }
 
   return actions;