@jumoo/usync 18.2.0 → 18.3.0

package/README.md

@@ -1,10 +1,16 @@
-## uSync ui library. 
-
-The uSync UI library ,is used by other uSync packages, to 
-show things like changes, and updates ,etc. 
-
-> [!IMPORTANT]
-> Most packages do not need to export thier client library
-as a npm package, unless your client library is also going
-to be used by child packages.
-
+## uSync ui library. 
+
+The uSync UI library ,is used by other uSync packages, to 
+show things like changes, and updates ,etc. 
+
+> [!IMPORTANT]
+> Most packages do not need to export thier client library
+as a npm package, unless your client library is also going
+to be used by child packages.
+
+### SignalR negotiation
+
+The uSync SignalR client respects `Umbraco:Cms:SignalR:ClientShouldSkipNegotiation`
+when exposed by Umbraco's server context. When enabled, the client connects using
+WebSockets without negotiation. When disabled, or on older Umbraco versions
+that do not expose the setting, negotiation and transport fallback remain enabled.

package/dist/api/index.d.ts

@@ -1,2 +1,2 @@
-export { getActionsBySet, getAddOns, getAddOnSplash, getCheckLegacy, getHandlerSettings, getRunning, getSets, getSettings, getStatus, getSyncFileInfo, type Options, postCopyLegacy, postDownload, postIgnoreLegacy, postImport, postMergeExport, postPerform, postProcessUpload } from './sdk.gen';
-export { ChangeDetailType, ChangeType, type ClientOptions, type EntityTagHeaderValue, type FileContentResult, type GetActionsBySetData, type GetActionsBySetErrors, type GetActionsBySetResponse, type GetActionsBySetResponses, type GetAddOnsData, type GetAddOnsErrors, type GetAddOnSplashData, type GetAddOnSplashErrors, type GetAddOnSplashResponse, type GetAddOnSplashResponses, type GetAddOnsResponse, type GetAddOnsResponses, type GetCheckLegacyData, type GetCheckLegacyErrors, type GetCheckLegacyResponse, type GetCheckLegacyResponses, type GetHandlerSettingsData, type GetHandlerSettingsErrors, type GetHandlerSettingsResponse, type GetHandlerSettingsResponses, type GetRunningData, type GetRunningErrors, type GetRunningResponse, type GetRunningResponses, type GetSetsData, type GetSetsErrors, type GetSetsResponse, type GetSetsResponses, type GetSettingsData, type GetSettingsErrors, type GetSettingsResponse, type GetSettingsResponses, type GetStatusData, type GetStatusErrors, type GetStatusResponse, type GetStatusResponses, type GetSyncFileInfoData, type GetSyncFileInfoErrors, type GetSyncFileInfoResponse, type GetSyncFileInfoResponses, type HandlerSettings, HandlerStatus, type PerformActionRequest, type PerformActionResponse, type PostCopyLegacyData, type PostCopyLegacyErrors, type PostCopyLegacyResponse, type PostCopyLegacyResponses, type PostDownloadData, type PostDownloadErrors, type PostDownloadResponse, type PostDownloadResponses, type PostIgnoreLegacyData, type PostIgnoreLegacyErrors, type PostIgnoreLegacyResponse, type PostIgnoreLegacyResponses, type PostImportData, type PostImportErrors, type PostImportResponse, type PostImportResponses, type PostMergeExportData, type PostMergeExportErrors, type PostMergeExportResponse, type PostMergeExportResponses, type PostPerformData, type PostPerformErrors, type PostPerformResponse, type PostPerformResponses, type PostProcessUploadData, type PostProcessUploadErrors, type PostProcessUploadResponse, type PostProcessUploadResponses, type StringSegment, type SyncActionButton, type SyncActionGroup, type SyncFileVersionCheckResult, SyncFolderMode, type SyncHandlerSummary, type SyncLegacyCheckResponse, type SyncOperationStatusResponse, SyncProcessingMode, type SyncRunningOperationResponse, type SyncSelectableSet, type UploadImportResult, type USyncActionView, type USyncAddonInfo, type USyncAddonSplash, type USyncChange, type USyncHandlerSetSettings, type USyncOptions, type USyncSettings } from './types.gen';
+export { getActionsBySet, getAddOns, getAddOnSplash, getCheckLegacy, getHandlerSettings, getPreview, getRunning, getSets, getSettings, getStatus, getSyncFileInfo, type Options, postCopyLegacy, postDownload, postIgnoreLegacy, postImport, postMergeExport, postPerform, postProcessUpload } from './sdk.gen';
+export { ChangeDetailType, ChangeType, type ClientOptions, type EntityTagHeaderValue, type FileContentResult, type GetActionsBySetData, type GetActionsBySetErrors, type GetActionsBySetResponse, type GetActionsBySetResponses, type GetAddOnsData, type GetAddOnsErrors, type GetAddOnSplashData, type GetAddOnSplashErrors, type GetAddOnSplashResponse, type GetAddOnSplashResponses, type GetAddOnsResponse, type GetAddOnsResponses, type GetCheckLegacyData, type GetCheckLegacyErrors, type GetCheckLegacyResponse, type GetCheckLegacyResponses, type GetHandlerSettingsData, type GetHandlerSettingsErrors, type GetHandlerSettingsResponse, type GetHandlerSettingsResponses, type GetPreviewData, type GetPreviewErrors, type GetPreviewResponse, type GetPreviewResponses, type GetRunningData, type GetRunningErrors, type GetRunningResponse, type GetRunningResponses, type GetSetsData, type GetSetsErrors, type GetSetsResponse, type GetSetsResponses, type GetSettingsData, type GetSettingsErrors, type GetSettingsResponse, type GetSettingsResponses, type GetStatusData, type GetStatusErrors, type GetStatusResponse, type GetStatusResponses, type GetSyncFileInfoData, type GetSyncFileInfoErrors, type GetSyncFileInfoResponse, type GetSyncFileInfoResponses, type HandlerSettings, HandlerStatus, type PerformActionRequest, type PerformActionResponse, type PostCopyLegacyData, type PostCopyLegacyErrors, type PostCopyLegacyResponse, type PostCopyLegacyResponses, type PostDownloadData, type PostDownloadErrors, type PostDownloadResponse, type PostDownloadResponses, type PostIgnoreLegacyData, type PostIgnoreLegacyErrors, type PostIgnoreLegacyResponse, type PostIgnoreLegacyResponses, type PostImportData, type PostImportErrors, type PostImportResponse, type PostImportResponses, type PostMergeExportData, type PostMergeExportErrors, type PostMergeExportResponse, type PostMergeExportResponses, type PostPerformData, type PostPerformErrors, type PostPerformResponse, type PostPerformResponses, type PostProcessUploadData, type PostProcessUploadErrors, type PostProcessUploadResponse, type PostProcessUploadResponses, type StringSegment, type SyncActionButton, type SyncActionGroup, type SyncFileVersionCheckResult, SyncFolderMode, type SyncHandlerSummary, type SyncItemPreviewResponse, type SyncLegacyCheckResponse, type SyncOperationStatusResponse, SyncProcessingMode, type SyncRunningOperationResponse, type SyncSelectableSet, type UploadImportResult, type USyncActionView, type USyncAddonInfo, type USyncAddonSplash, type USyncChange, type USyncHandlerSetSettings, type USyncOptions, type USyncSettings } from './types.gen';

package/dist/api/index.js

@@ -1,3 +1,3 @@
 // This file is auto-generated by @hey-api/openapi-ts
-export { getActionsBySet, getAddOns, getAddOnSplash, getCheckLegacy, getHandlerSettings, getRunning, getSets, getSettings, getStatus, getSyncFileInfo, postCopyLegacy, postDownload, postIgnoreLegacy, postImport, postMergeExport, postPerform, postProcessUpload } from './sdk.gen';
+export { getActionsBySet, getAddOns, getAddOnSplash, getCheckLegacy, getHandlerSettings, getPreview, getRunning, getSets, getSettings, getStatus, getSyncFileInfo, postCopyLegacy, postDownload, postIgnoreLegacy, postImport, postMergeExport, postPerform, postProcessUpload } from './sdk.gen';
 export { ChangeDetailType, ChangeType, HandlerStatus, SyncFolderMode, SyncProcessingMode } from './types.gen';

package/dist/api/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
-import type { GetActionsBySetData, GetActionsBySetErrors, GetActionsBySetResponses, GetAddOnsData, GetAddOnsErrors, GetAddOnSplashData, GetAddOnSplashErrors, GetAddOnSplashResponses, GetAddOnsResponses, GetCheckLegacyData, GetCheckLegacyErrors, GetCheckLegacyResponses, GetHandlerSettingsData, GetHandlerSettingsErrors, GetHandlerSettingsResponses, GetRunningData, GetRunningErrors, GetRunningResponses, GetSetsData, GetSetsErrors, GetSetsResponses, GetSettingsData, GetSettingsErrors, GetSettingsResponses, GetStatusData, GetStatusErrors, GetStatusResponses, GetSyncFileInfoData, GetSyncFileInfoErrors, GetSyncFileInfoResponses, PostCopyLegacyData, PostCopyLegacyErrors, PostCopyLegacyResponses, PostDownloadData, PostDownloadErrors, PostDownloadResponses, PostIgnoreLegacyData, PostIgnoreLegacyErrors, PostIgnoreLegacyResponses, PostImportData, PostImportErrors, PostImportResponses, PostMergeExportData, PostMergeExportErrors, PostMergeExportResponses, PostPerformData, PostPerformErrors, PostPerformResponses, PostProcessUploadData, PostProcessUploadErrors, PostProcessUploadResponses } from './types.gen';
+import type { GetActionsBySetData, GetActionsBySetErrors, GetActionsBySetResponses, GetAddOnsData, GetAddOnsErrors, GetAddOnSplashData, GetAddOnSplashErrors, GetAddOnSplashResponses, GetAddOnsResponses, GetCheckLegacyData, GetCheckLegacyErrors, GetCheckLegacyResponses, GetHandlerSettingsData, GetHandlerSettingsErrors, GetHandlerSettingsResponses, GetPreviewData, GetPreviewErrors, GetPreviewResponses, GetRunningData, GetRunningErrors, GetRunningResponses, GetSetsData, GetSetsErrors, GetSetsResponses, GetSettingsData, GetSettingsErrors, GetSettingsResponses, GetStatusData, GetStatusErrors, GetStatusResponses, GetSyncFileInfoData, GetSyncFileInfoErrors, GetSyncFileInfoResponses, PostCopyLegacyData, PostCopyLegacyErrors, PostCopyLegacyResponses, PostDownloadData, PostDownloadErrors, PostDownloadResponses, PostIgnoreLegacyData, PostIgnoreLegacyErrors, PostIgnoreLegacyResponses, PostImportData, PostImportErrors, PostImportResponses, PostMergeExportData, PostMergeExportErrors, PostMergeExportResponses, PostPerformData, PostPerformErrors, PostPerformResponses, PostProcessUploadData, PostProcessUploadErrors, PostProcessUploadResponses } from './types.gen';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -17,6 +17,7 @@ export declare const getActionsBySet: <ThrowOnError extends boolean = false>(opt
 export declare const postDownload: <ThrowOnError extends boolean = false>(options?: Options<PostDownloadData, ThrowOnError>) => RequestResult<PostDownloadResponses, PostDownloadErrors, ThrowOnError>;
 export declare const postImport: <ThrowOnError extends boolean = false>(options: Options<PostImportData, ThrowOnError>) => RequestResult<PostImportResponses, PostImportErrors, ThrowOnError>;
 export declare const postPerform: <ThrowOnError extends boolean = false>(options: Options<PostPerformData, ThrowOnError>) => RequestResult<PostPerformResponses, PostPerformErrors, ThrowOnError>;
+export declare const getPreview: <ThrowOnError extends boolean = false>(options?: Options<GetPreviewData, ThrowOnError>) => RequestResult<GetPreviewResponses, GetPreviewErrors, ThrowOnError>;
 export declare const postProcessUpload: <ThrowOnError extends boolean = false>(options?: Options<PostProcessUploadData, ThrowOnError>) => RequestResult<PostProcessUploadResponses, PostProcessUploadErrors, ThrowOnError>;
 export declare const getRunning: <ThrowOnError extends boolean = false>(options?: Options<GetRunningData, ThrowOnError>) => RequestResult<GetRunningResponses, GetRunningErrors, ThrowOnError>;
 export declare const getStatus: <ThrowOnError extends boolean = false>(options?: Options<GetStatusData, ThrowOnError>) => RequestResult<GetStatusResponses, GetStatusErrors, ThrowOnError>;

package/dist/api/sdk.gen.js

@@ -28,6 +28,11 @@ export const postPerform = (options) => (options.client ?? client).post({
         ...options.headers
     }
 });
+export const getPreview = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/umbraco/usync/api/v1/Preview',
+    ...options
+});
 export const postProcessUpload = (options) => (options?.client ?? client).post({
     security: [{ scheme: 'bearer', type: 'http' }],
     url: '/umbraco/usync/api/v1/ProcessUpload',

package/dist/api/types.gen.d.ts

@@ -115,6 +115,17 @@ export type SyncHandlerSummary = {
     changes: number | string;
     inError: boolean;
 };
+export type SyncItemPreviewResponse = {
+    key: string;
+    handler: string;
+    itemType: string;
+    entityType: string;
+    isDelete: boolean;
+    success: boolean;
+    message?: null | string;
+    preview?: unknown;
+    details: Array<USyncChange>;
+};
 export type SyncLegacyCheckResponse = {
     hasLegacy: boolean;
     legacyFolder?: null | string;
@@ -310,6 +321,32 @@ export type PostPerformResponses = {
     200: PerformActionResponse;
 };
 export type PostPerformResponse = PostPerformResponses[keyof PostPerformResponses];
+export type GetPreviewData = {
+    body?: never;
+    path?: never;
+    query?: {
+        handler?: string;
+        key?: string;
+    };
+    url: '/umbraco/usync/api/v1/Preview';
+};
+export type GetPreviewErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+    /**
+     * Not Found
+     */
+    404: unknown;
+};
+export type GetPreviewResponses = {
+    /**
+     * OK
+     */
+    200: SyncItemPreviewResponse;
+};
+export type GetPreviewResponse = GetPreviewResponses[keyof GetPreviewResponses];
 export type PostProcessUploadData = {
     body?: never;
     path?: never;

package/dist/components/usync-action-box.js

@@ -25,26 +25,26 @@ let uSyncActionBox = class uSyncActionBox extends UmbLitElement {
     }
     render() {
         const dropdownButtons = this.group.buttons.map((b) => {
-            return html `
-				<usync-action-button
-					.button=${b}
-					.disabled=${this.disabled}
-					state=${ifDefined(this.state)}
-					@usync-action-click=${(e) => __classPrivateFieldGet(this, _uSyncActionBox_instances, "m", _uSyncActionBox_onAction).call(this, e, this.group)}></usync-action-button>
+            return html `
+				<usync-action-button
+					.button=${b}
+					.disabled=${this.disabled}
+					state=${ifDefined(this.state)}
+					@usync-action-click=${(e) => __classPrivateFieldGet(this, _uSyncActionBox_instances, "m", _uSyncActionBox_onAction).call(this, e, this.group)}></usync-action-button>
 			`;
         });
-        return html `
-			<uui-box class="action-box ${this.disabled ? 'disabled' : ''}">
-				<div class="box-content">
-					<div class="box-heading">
-						<h2 class="box-heading" title=${this.getLastSyncDate()}>
-							${this.localize.termOrDefault(`uSync_group${this.group?.groupName}`, this.group?.groupName ?? '')}
-						</h2>
-						<umb-icon name=${this.group?.icon}></umb-icon>
-					</div>
-					<div class="box-buttons">${dropdownButtons}</div>
-				</div>
-			</uui-box>
+        return html `
+			<uui-box class="action-box ${this.disabled ? 'disabled' : ''}">
+				<div class="box-content">
+					<div class="box-heading">
+						<h2 class="box-heading" title=${this.getLastSyncDate()}>
+							${this.localize.termOrDefault(`uSync_group${this.group?.groupName}`, this.group?.groupName ?? '')}
+						</h2>
+						<umb-icon name=${this.group?.icon}></umb-icon>
+					</div>
+					<div class="box-buttons">${dropdownButtons}</div>
+				</div>
+			</uui-box>
 		`;
     }
     getLastSyncDate() {
@@ -59,59 +59,59 @@ _uSyncActionBox_onAction = function _uSyncActionBox_onAction(e, group) {
         return;
     this.dispatchEvent(new uSyncActionPerformEvent(group, e.button.key, e.button.force, e.button.clean, e.button.file));
 };
-uSyncActionBox.styles = css `
-		:host {
-			flex-grow: 1;
-		}
-
-		.action-box {
-			transition: opacity 0.2s ease-in-out;
-			--uui-box-default-padding: var(--uui-size-space-4) 0;
-		}
-
-		.box-content {
-			display: flex;
-			flex-direction: column;
-			align-items: center;
-		}
-
-		.box-heading {
-			font-size: var(--uui-type-h3-size);
-			cursor: help;
-			margin: var(--uui-size-space-3);
-		}
-
-		umb-icon {
-			margin: var(--uui-size-4) 0 var(--uui-size-4);
-			font-size: var(--uui-type-h2-size);
-			color: var(--uui-color-text-alt);
-		}
-
-		uui-button {
-			margin: 0 var(--uui-size-space-2);
-			font-size: var(--uui-size-6);
-		}
-
-		.box-buttons {
-			margin: var(--uui-size-space-2) 0;
-		}
-
-		.disabled {
-			opacity: 0.4;
-		}
-
-		.last-sync {
-			color: var(--uui-color-text-alt);
-			font-style: italic;
-			font-size: var(--uui-size-5);
-		}
-
-		.box-heading {
-			display: flex;
-			flex-direction: row-reverse;
-			gap: var(--uui-size-2);
-			align-items: center;
-		}
+uSyncActionBox.styles = css `
+		:host {
+			flex-grow: 1;
+		}
+
+		.action-box {
+			transition: opacity 0.2s ease-in-out;
+			--uui-box-default-padding: var(--uui-size-space-4) 0;
+		}
+
+		.box-content {
+			display: flex;
+			flex-direction: column;
+			align-items: center;
+		}
+
+		.box-heading {
+			font-size: var(--uui-type-h3-size);
+			cursor: help;
+			margin: var(--uui-size-space-3);
+		}
+
+		umb-icon {
+			margin: var(--uui-size-4) 0 var(--uui-size-4);
+			font-size: var(--uui-type-h2-size);
+			color: var(--uui-color-text-alt);
+		}
+
+		uui-button {
+			margin: 0 var(--uui-size-space-2);
+			font-size: var(--uui-size-6);
+		}
+
+		.box-buttons {
+			margin: var(--uui-size-space-2) 0;
+		}
+
+		.disabled {
+			opacity: 0.4;
+		}
+
+		.last-sync {
+			color: var(--uui-color-text-alt);
+			font-style: italic;
+			font-size: var(--uui-size-5);
+		}
+
+		.box-heading {
+			display: flex;
+			flex-direction: row-reverse;
+			gap: var(--uui-size-2);
+			align-items: center;
+		}
 	`;
 __decorate([
     property({ type: Object })