@jumoo/usync 0.0.0-stage → 18.2.0

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

@@ -0,0 +1,565 @@
+export type ClientOptions = {
+    baseUrl: 'https://localhost:44304/' | (string & {});
+};
+export declare enum ChangeDetailType {
+    NO_CHANGE = "NoChange",
+    CREATE = "Create",
+    UPDATE = "Update",
+    DELETE = "Delete",
+    ERROR = "Error",
+    WARNING = "Warning"
+}
+export declare enum ChangeType {
+    NO_CHANGE = "NoChange",
+    CREATE = "Create",
+    IMPORT = "Import",
+    EXPORT = "Export",
+    UPDATE = "Update",
+    DELETE = "Delete",
+    WILL_CHANGE = "WillChange",
+    INFORMATION = "Information",
+    ROLLEDBACK = "Rolledback",
+    FAIL = "Fail",
+    IMPORT_FAIL = "ImportFail",
+    MISMATCH = "Mismatch",
+    PARENT_MISSING = "ParentMissing",
+    HIDDEN = "Hidden",
+    CLEAN = "Clean",
+    REMOVED = "Removed"
+}
+export type EntityTagHeaderValue = {
+    tag: StringSegment;
+    isWeak: boolean;
+};
+export type FileContentResult = {
+    fileContents: string;
+    contentType: null | string;
+    fileDownloadName: null | string;
+    lastModified?: null | string;
+    entityTag?: null | EntityTagHeaderValue;
+    enableRangeProcessing: boolean;
+};
+export type HandlerSettings = {
+    enabled: boolean;
+    actions: Array<string>;
+    useFlatStructure: boolean;
+    guidNames: boolean;
+    failOnMissingParent: boolean;
+    group: string;
+    createClean: boolean;
+    fullFileOnDifference: boolean;
+    settings: {
+        [key: string]: unknown;
+    };
+};
+export declare enum HandlerStatus {
+    PENDING = "Pending",
+    PROCESSING = "Processing",
+    COMPLETE = "Complete",
+    ERROR = "Error"
+}
+export type PerformActionRequest = {
+    requestId: string;
+    action: string;
+    stepNumber: number | string;
+    options?: null | USyncOptions;
+    username?: null | string;
+};
+export type PerformActionResponse = {
+    requestId: string;
+    status?: null | Array<SyncHandlerSummary>;
+    actions?: null | Array<USyncActionView>;
+    complete: boolean;
+    inBackground: boolean;
+    operationId?: null | string;
+    message?: null | string;
+};
+export type StringSegment = {
+    buffer?: null | string;
+    offset: number | string;
+    length: number | string;
+    value?: null | string;
+    hasValue: boolean;
+};
+export type SyncActionButton = {
+    key: string;
+    label: string;
+    look: string;
+    color: string;
+    force: boolean;
+    clean: boolean;
+    file: boolean;
+    children: Array<SyncActionButton>;
+};
+export type SyncActionGroup = {
+    key: string;
+    icon: string;
+    groupName: string;
+    buttons: Array<SyncActionButton>;
+    lastSync?: null | string;
+};
+export type SyncFileVersionCheckResult = {
+    isCurrent: boolean;
+    formatVersion?: null | string;
+    hmacMatch: boolean;
+};
+export declare enum SyncFolderMode {
+    NORMAL = "Normal",
+    ROOT = "Root",
+    PRODUCTION = "Production"
+}
+export type SyncHandlerSummary = {
+    icon: string;
+    name: string;
+    status: HandlerStatus;
+    changes: number | string;
+    inError: boolean;
+};
+export type SyncLegacyCheckResponse = {
+    hasLegacy: boolean;
+    legacyFolder?: null | string;
+    legacyTypes: Array<string>;
+    latestFolder: string;
+    latestVersion: string;
+};
+export type SyncOperationStatusResponse = {
+    operationId: string;
+    requestId?: null | string;
+    action?: null | string;
+    operationStatus: string;
+    complete: boolean;
+    status?: null | Array<SyncHandlerSummary>;
+    actions?: null | Array<USyncActionView>;
+    message?: null | string;
+};
+export declare enum SyncProcessingMode {
+    NORMAL = "Normal",
+    BACKGROUND = "Background"
+}
+export type SyncRunningOperationResponse = {
+    operationId?: null | string;
+    requestId?: null | string;
+    action?: null | string;
+};
+export type SyncSelectableSet = {
+    name: string;
+    settings: USyncHandlerSetSettings;
+};
+export type UploadImportResult = {
+    success: boolean;
+    errors: Array<string>;
+};
+export type USyncActionView = {
+    key: string;
+    name: string;
+    handler: string;
+    itemType: string;
+    change: ChangeType;
+    success: boolean;
+    details: Array<USyncChange>;
+    message?: null | string;
+};
+export type USyncAddonInfo = {
+    version: string;
+};
+export type USyncAddonSplash = {
+    [key: string]: unknown;
+};
+export type USyncChange = {
+    success: boolean;
+    name: string;
+    path: string;
+    oldValue: string;
+    newValue: string;
+    change: ChangeDetailType;
+};
+export type USyncHandlerSetSettings = {
+    enabled: boolean;
+    handlerGroups: Array<string>;
+    disabledHandlers: Array<string>;
+    handlerDefaults: HandlerSettings;
+    handlers: {
+        [key: string]: HandlerSettings;
+    };
+    isSelectable: boolean;
+};
+export type USyncOptions = {
+    clientId: string;
+    force: boolean;
+    clean: boolean;
+    files: boolean;
+    group: string;
+    set: string;
+};
+export type USyncSettings = {
+    rootFolder: string;
+    folders: Array<string>;
+    legacyFolder: string;
+    isRootSite: boolean;
+    lockRoot: boolean;
+    stopFile: string;
+    onceFile: string;
+    ignoreStopIfOnceExists: boolean;
+    lockRootTypes: Array<string>;
+    backgroundStartup: boolean;
+    defaultSet: string;
+    importAtStartup: string;
+    exportAtStartup: string;
+    exportOnSave: string;
+    uiEnabledGroups: string;
+    reportDebug: boolean;
+    addOnPing: boolean;
+    rebuildCacheOnCompletion: boolean;
+    failOnMissingParent: boolean;
+    failOnDuplicates: boolean;
+    cacheFolderKeys: boolean;
+    cacheImportState: boolean;
+    showVersionCheckWarning: boolean;
+    enableHistory: boolean;
+    defaultExtension: string;
+    importOnFirstBoot: boolean;
+    firstBootGroup: string;
+    disableDashboard: boolean;
+    summaryDashboard: boolean;
+    summaryLimit: number | string;
+    hideAddOns: string;
+    disableNotificationSuppression: boolean;
+    backgroundNotifications: boolean;
+    moveToSection: boolean;
+    folderMode: SyncFolderMode;
+    processingMode: SyncProcessingMode;
+    productionFolder: string;
+    additionalBadNames: Array<string>;
+    includeWindowsReservedNames: boolean;
+};
+export type GetActionsBySetData = {
+    body?: never;
+    path?: never;
+    query?: {
+        setName?: string;
+    };
+    url: '/umbraco/usync/api/v1/ActionsBySet';
+};
+export type GetActionsBySetErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type GetActionsBySetResponses = {
+    /**
+     * OK
+     */
+    200: Array<SyncActionGroup>;
+};
+export type GetActionsBySetResponse = GetActionsBySetResponses[keyof GetActionsBySetResponses];
+export type PostDownloadData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/Download';
+};
+export type PostDownloadErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type PostDownloadResponses = {
+    /**
+     * OK
+     */
+    200: FileContentResult;
+};
+export type PostDownloadResponse = PostDownloadResponses[keyof PostDownloadResponses];
+export type PostImportData = {
+    body: USyncActionView;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/Import';
+};
+export type PostImportErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type PostImportResponses = {
+    /**
+     * OK
+     */
+    200: USyncActionView;
+};
+export type PostImportResponse = PostImportResponses[keyof PostImportResponses];
+export type PostPerformData = {
+    body: PerformActionRequest;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/Perform';
+};
+export type PostPerformErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type PostPerformResponses = {
+    /**
+     * OK
+     */
+    200: PerformActionResponse;
+};
+export type PostPerformResponse = PostPerformResponses[keyof PostPerformResponses];
+export type PostProcessUploadData = {
+    body?: never;
+    path?: never;
+    query?: {
+        tempKey?: string;
+    };
+    url: '/umbraco/usync/api/v1/ProcessUpload';
+};
+export type PostProcessUploadErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type PostProcessUploadResponses = {
+    /**
+     * OK
+     */
+    200: UploadImportResult;
+};
+export type PostProcessUploadResponse = PostProcessUploadResponses[keyof PostProcessUploadResponses];
+export type GetRunningData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/Running';
+};
+export type GetRunningErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type GetRunningResponses = {
+    /**
+     * OK
+     */
+    200: SyncRunningOperationResponse;
+};
+export type GetRunningResponse = GetRunningResponses[keyof GetRunningResponses];
+export type GetStatusData = {
+    body?: never;
+    path?: never;
+    query?: {
+        operationId?: string;
+    };
+    url: '/umbraco/usync/api/v1/Status';
+};
+export type GetStatusErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type GetStatusResponses = {
+    /**
+     * OK
+     */
+    200: SyncOperationStatusResponse;
+};
+export type GetStatusResponse = GetStatusResponses[keyof GetStatusResponses];
+export type GetSyncFileInfoData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/SyncFileInfo';
+};
+export type GetSyncFileInfoErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type GetSyncFileInfoResponses = {
+    /**
+     * OK
+     */
+    200: SyncFileVersionCheckResult;
+};
+export type GetSyncFileInfoResponse = GetSyncFileInfoResponses[keyof GetSyncFileInfoResponses];
+export type PostMergeExportData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/MergeExport';
+};
+export type PostMergeExportErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type PostMergeExportResponses = {
+    /**
+     * OK
+     */
+    200: number | string;
+};
+export type PostMergeExportResponse = PostMergeExportResponses[keyof PostMergeExportResponses];
+export type GetCheckLegacyData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/CheckLegacy';
+};
+export type GetCheckLegacyErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type GetCheckLegacyResponses = {
+    /**
+     * OK
+     */
+    200: SyncLegacyCheckResponse;
+};
+export type GetCheckLegacyResponse = GetCheckLegacyResponses[keyof GetCheckLegacyResponses];
+export type PostCopyLegacyData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/CopyLegacy';
+};
+export type PostCopyLegacyErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type PostCopyLegacyResponses = {
+    /**
+     * OK
+     */
+    200: boolean;
+};
+export type PostCopyLegacyResponse = PostCopyLegacyResponses[keyof PostCopyLegacyResponses];
+export type PostIgnoreLegacyData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/IgnoreLegacy';
+};
+export type PostIgnoreLegacyErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type PostIgnoreLegacyResponses = {
+    /**
+     * OK
+     */
+    200: boolean;
+};
+export type PostIgnoreLegacyResponse = PostIgnoreLegacyResponses[keyof PostIgnoreLegacyResponses];
+export type GetAddOnsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/AddOns';
+};
+export type GetAddOnsErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type GetAddOnsResponses = {
+    /**
+     * OK
+     */
+    200: USyncAddonInfo;
+};
+export type GetAddOnsResponse = GetAddOnsResponses[keyof GetAddOnsResponses];
+export type GetAddOnSplashData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/AddOnSplash';
+};
+export type GetAddOnSplashErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type GetAddOnSplashResponses = {
+    /**
+     * OK
+     */
+    200: USyncAddonSplash;
+};
+export type GetAddOnSplashResponse = GetAddOnSplashResponses[keyof GetAddOnSplashResponses];
+export type GetHandlerSettingsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        id?: string;
+    };
+    url: '/umbraco/usync/api/v1/HandlerSettings';
+};
+export type GetHandlerSettingsErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type GetHandlerSettingsResponses = {
+    /**
+     * OK
+     */
+    200: USyncHandlerSetSettings;
+};
+export type GetHandlerSettingsResponse = GetHandlerSettingsResponses[keyof GetHandlerSettingsResponses];
+export type GetSetsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/Sets';
+};
+export type GetSetsErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type GetSetsResponses = {
+    /**
+     * OK
+     */
+    200: Array<SyncSelectableSet>;
+};
+export type GetSetsResponse = GetSetsResponses[keyof GetSetsResponses];
+export type GetSettingsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/usync/api/v1/Settings';
+};
+export type GetSettingsErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type GetSettingsResponses = {
+    /**
+     * OK
+     */
+    200: USyncSettings;
+};
+export type GetSettingsResponse = GetSettingsResponses[keyof GetSettingsResponses];

package/dist/api/types.gen.js

@@ -0,0 +1,47 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export var ChangeDetailType;
+(function (ChangeDetailType) {
+    ChangeDetailType["NO_CHANGE"] = "NoChange";
+    ChangeDetailType["CREATE"] = "Create";
+    ChangeDetailType["UPDATE"] = "Update";
+    ChangeDetailType["DELETE"] = "Delete";
+    ChangeDetailType["ERROR"] = "Error";
+    ChangeDetailType["WARNING"] = "Warning";
+})(ChangeDetailType || (ChangeDetailType = {}));
+export var ChangeType;
+(function (ChangeType) {
+    ChangeType["NO_CHANGE"] = "NoChange";
+    ChangeType["CREATE"] = "Create";
+    ChangeType["IMPORT"] = "Import";
+    ChangeType["EXPORT"] = "Export";
+    ChangeType["UPDATE"] = "Update";
+    ChangeType["DELETE"] = "Delete";
+    ChangeType["WILL_CHANGE"] = "WillChange";
+    ChangeType["INFORMATION"] = "Information";
+    ChangeType["ROLLEDBACK"] = "Rolledback";
+    ChangeType["FAIL"] = "Fail";
+    ChangeType["IMPORT_FAIL"] = "ImportFail";
+    ChangeType["MISMATCH"] = "Mismatch";
+    ChangeType["PARENT_MISSING"] = "ParentMissing";
+    ChangeType["HIDDEN"] = "Hidden";
+    ChangeType["CLEAN"] = "Clean";
+    ChangeType["REMOVED"] = "Removed";
+})(ChangeType || (ChangeType = {}));
+export var HandlerStatus;
+(function (HandlerStatus) {
+    HandlerStatus["PENDING"] = "Pending";
+    HandlerStatus["PROCESSING"] = "Processing";
+    HandlerStatus["COMPLETE"] = "Complete";
+    HandlerStatus["ERROR"] = "Error";
+})(HandlerStatus || (HandlerStatus = {}));
+export var SyncFolderMode;
+(function (SyncFolderMode) {
+    SyncFolderMode["NORMAL"] = "Normal";
+    SyncFolderMode["ROOT"] = "Root";
+    SyncFolderMode["PRODUCTION"] = "Production";
+})(SyncFolderMode || (SyncFolderMode = {}));
+export var SyncProcessingMode;
+(function (SyncProcessingMode) {
+    SyncProcessingMode["NORMAL"] = "Normal";
+    SyncProcessingMode["BACKGROUND"] = "Background";
+})(SyncProcessingMode || (SyncProcessingMode = {}));

package/dist/components/events.d.ts

@@ -0,0 +1,11 @@
+import { USyncActionView } from '../api';
+export declare const USYNC_SHOW_DETAIL_EVENT = "show-detail";
+export declare class uSyncShowDetailEvent extends Event {
+    constructor(action: USyncActionView);
+    action: USyncActionView;
+}
+declare global {
+    interface GlobalEventHandlersEventMap {
+        [USYNC_SHOW_DETAIL_EVENT]: uSyncShowDetailEvent;
+    }
+}

package/dist/components/events.js

@@ -0,0 +1,11 @@
+export const USYNC_SHOW_DETAIL_EVENT = 'show-detail';
+export class uSyncShowDetailEvent extends Event {
+    constructor(action) {
+        super(USYNC_SHOW_DETAIL_EVENT, {
+            bubbles: true,
+            composed: true,
+            cancelable: false,
+        });
+        this.action = action;
+    }
+}

package/dist/components/index.d.ts

@@ -0,0 +1,8 @@
+export * from './usync-action-box.js';
+export * from './usync-progress-box.js';
+export * from './usync-results-view.js';
+export * from './usync-change-view.js';
+export * from './usync-change-detail.js';
+export * from './usync-results-group-view.js';
+export * from './usync-result-row.js';
+export * from './usync-sync-file-info-view.js';

package/dist/components/index.js

@@ -0,0 +1,9 @@
+// component exports.
+export * from './usync-action-box.js';
+export * from './usync-progress-box.js';
+export * from './usync-results-view.js';
+export * from './usync-change-view.js';
+export * from './usync-change-detail.js';
+export * from './usync-results-group-view.js';
+export * from './usync-result-row.js';
+export * from './usync-sync-file-info-view.js';

package/dist/components/usync-action-box.d.ts

@@ -0,0 +1,22 @@
+import { SyncActionGroup } from '@jumoo/uSync';
+import { UUIButtonState } from '@umbraco-cms/backoffice/external/uui';
+import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
+/**
+ * displays the action buttons for a given group
+ */
+export declare class uSyncActionBox extends UmbLitElement {
+    #private;
+    /**
+     * Collection of buttons to display.
+     */
+    group: SyncActionGroup;
+    /**
+     * state to display on buttons
+     */
+    state?: UUIButtonState;
+    disabled: boolean;
+    render(): import("lit-html").TemplateResult<1>;
+    getLastSyncDate(): string;
+    static styles: import("lit").CSSResult;
+}
+export default uSyncActionBox;