@umbraco-cms/backoffice 14.0.0--preview004-7a741834 → 14.0.0--preview004-e1502383

package/dist-cms/packages/core/data-type/repository/detail/data-type-detail.repository.d.ts

@@ -1,25 +1,8 @@
 import { UmbDataTypeDetailModel } from '../../types.js';
 import { type UmbControllerHost } from '../../../../../libs/controller-api/index.js';
-import { UmbRepositoryBase } from '../../../repository/index.js';
-export declare class UmbDataTypeDetailRepository extends UmbRepositoryBase {
+import { UmbDetailRepositoryBase } from '../../../repository/index.js';
+export declare class UmbDataTypeDetailRepository extends UmbDetailRepositoryBase<UmbDataTypeDetailModel> {
     #private;
     constructor(host: UmbControllerHost);
-    createScaffold(parentUnique: string | null): Promise<import("../../../repository/index.js").DataSourceResponse<UmbDataTypeDetailModel>>;
-    requestByUnique(unique: string): Promise<{
-        data: UmbDataTypeDetailModel | undefined;
-        error: import("../../../../../external/backend-api/index.js").ApiError | import("../../../../../external/backend-api/index.js").CancelError | undefined;
-        asObservable: () => import("rxjs").Observable<UmbDataTypeDetailModel | undefined>;
-    }>;
-    byUnique(unique: string): Promise<import("rxjs").Observable<UmbDataTypeDetailModel | undefined>>;
-    byPropertyEditorUiAlias(propertyEditorUiAlias: string): Promise<import("rxjs").Observable<UmbDataTypeDetailModel[]>>;
-    create(dataType: UmbDataTypeDetailModel): Promise<{
-        error: import("../../../../../external/backend-api/index.js").ApiError | import("../../../../../external/backend-api/index.js").CancelError | undefined;
-    }>;
-    save(dataType: UmbDataTypeDetailModel): Promise<{
-        data: UmbDataTypeDetailModel | undefined;
-        error: import("../../../../../external/backend-api/index.js").ApiError | import("../../../../../external/backend-api/index.js").CancelError | undefined;
-    }>;
-    delete(unique: string): Promise<{
-        error: import("../../../../../external/backend-api/index.js").ApiError | import("../../../../../external/backend-api/index.js").CancelError | undefined;
-    }>;
+    byPropertyEditorUiAlias(propertyEditorUiAlias: string): Promise<import("rxjs").Observable<any[]>>;
 }

package/dist-cms/packages/core/data-type/repository/detail/data-type-detail.repository.js

@@ -1,89 +1,21 @@
 import { UmbDataTypeServerDataSource } from './data-type-detail.server.data-source.js';
 import { UMB_DATA_TYPE_DETAIL_STORE_CONTEXT } from './data-type-detail.store.js';
-import { UmbRepositoryBase } from '../../../repository/index.js';
-import { UMB_NOTIFICATION_CONTEXT_TOKEN } from '../../../notification/index.js';
-export class UmbDataTypeDetailRepository extends UmbRepositoryBase {
+import { UmbDetailRepositoryBase } from '../../../repository/index.js';
+export class UmbDataTypeDetailRepository extends UmbDetailRepositoryBase {
     #init;
     #detailStore;
-    #detailSource;
-    #notificationContext;
     constructor(host) {
-        super(host);
-        this.#detailSource = new UmbDataTypeServerDataSource(host);
+        super(host, UmbDataTypeServerDataSource, UMB_DATA_TYPE_DETAIL_STORE_CONTEXT);
         this.#init = Promise.all([
             this.consumeContext(UMB_DATA_TYPE_DETAIL_STORE_CONTEXT, (instance) => {
                 this.#detailStore = instance;
             }).asPromise(),
-            this.consumeContext(UMB_NOTIFICATION_CONTEXT_TOKEN, (instance) => {
-                this.#notificationContext = instance;
-            }).asPromise(),
         ]);
     }
-    async createScaffold(parentUnique) {
-        if (parentUnique === undefined)
-            throw new Error('Parent unique is missing');
-        return this.#detailSource.createScaffold(parentUnique);
-    }
-    async requestByUnique(unique) {
-        if (!unique)
-            throw new Error('Key is missing');
-        await this.#init;
-        const { data, error } = await this.#detailSource.read(unique);
-        if (data) {
-            this.#detailStore.append(data);
-        }
-        return { data, error, asObservable: () => this.#detailStore.byUnique(unique) };
-    }
-    async byUnique(unique) {
-        if (!unique)
-            throw new Error('Unique is missing');
-        await this.#init;
-        return this.#detailStore.byUnique(unique);
-    }
     async byPropertyEditorUiAlias(propertyEditorUiAlias) {
         if (!propertyEditorUiAlias)
             throw new Error('propertyEditorUiAlias is missing');
         await this.#init;
         return this.#detailStore.withPropertyEditorUiAlias(propertyEditorUiAlias);
     }
-    async create(dataType) {
-        if (!dataType)
-            throw new Error('Data Type is missing');
-        if (!dataType.unique)
-            throw new Error('Data Type unique is missing');
-        await this.#init;
-        const { error } = await this.#detailSource.create(dataType);
-        if (!error) {
-            this.#detailStore?.append(dataType);
-            const notification = { data: { message: `Data Type created` } };
-            this.#notificationContext.peek('positive', notification);
-        }
-        return { error };
-    }
-    async save(dataType) {
-        if (!dataType)
-            throw new Error('Data Type is missing');
-        if (!dataType.unique)
-            throw new Error('Data Type unique is missing');
-        await this.#init;
-        const { data, error } = await this.#detailSource.update(dataType);
-        if (data) {
-            this.#detailStore.updateItem(data.unique, data);
-            const notification = { data: { message: `Data Type saved` } };
-            this.#notificationContext.peek('positive', notification);
-        }
-        return { data, error };
-    }
-    async delete(unique) {
-        if (!unique)
-            throw new Error('Data Type unique is missing');
-        await this.#init;
-        const { error } = await this.#detailSource.delete(unique);
-        if (!error) {
-            this.#detailStore.removeItem(unique);
-            const notification = { data: { message: `Data Type deleted` } };
-            this.#notificationContext.peek('positive', notification);
-        }
-        return { error };
-    }
 }

package/dist-cms/packages/core/data-type/repository/detail/data-type-detail.store.d.ts

@@ -1,26 +1,20 @@
 import { UmbDataTypeDetailModel } from '../../types.js';
 import { UmbContextToken } from '../../../../../libs/context-api/index.js';
-import { UmbStoreBase } from '../../../store/index.js';
+import { UmbDetailStoreBase } from '../../../store/index.js';
 import { UmbControllerHostElement } from '../../../../../libs/controller-api/index.js';
-export declare const UMB_DATA_TYPE_DETAIL_STORE_CONTEXT: UmbContextToken<UmbDataTypeDetailStore, UmbDataTypeDetailStore>;
 /**
  * @export
  * @class UmbDataTypeDetailStore
  * @extends {UmbStoreBase}
  * @description - Data Store for Data Type Details
  */
-export declare class UmbDataTypeDetailStore extends UmbStoreBase<UmbDataTypeDetailModel> {
+export declare class UmbDataTypeDetailStore extends UmbDetailStoreBase<UmbDataTypeDetailModel> {
     /**
      * Creates an instance of UmbDataTypeDetailStore.
      * @param {UmbControllerHostElement} host
      * @memberof UmbDataTypeDetailStore
      */
     constructor(host: UmbControllerHostElement);
-    /**
-     * Retrieve a data-type from the store
-     * @param {unique} string unique
-     * @memberof UmbDataTypeDetailStore
-     */
-    byUnique(unique: UmbDataTypeDetailModel['unique']): import("rxjs").Observable<UmbDataTypeDetailModel | undefined>;
-    withPropertyEditorUiAlias(propertyEditorUiAlias: string): import("rxjs").Observable<UmbDataTypeDetailModel[]>;
+    withPropertyEditorUiAlias(propertyEditorUiAlias: string): import("rxjs").Observable<any[]>;
 }
+export declare const UMB_DATA_TYPE_DETAIL_STORE_CONTEXT: UmbContextToken<UmbDataTypeDetailStore, UmbDataTypeDetailStore>;

package/dist-cms/packages/core/data-type/repository/detail/data-type-detail.store.js

@@ -1,32 +1,23 @@
 import { UmbContextToken } from '../../../../../libs/context-api/index.js';
-import { UmbArrayState } from '../../../../../libs/observable-api/index.js';
-import { UmbStoreBase } from '../../../store/index.js';
-export const UMB_DATA_TYPE_DETAIL_STORE_CONTEXT = new UmbContextToken('UmbDataTypeDetailStore');
+import { UmbDetailStoreBase } from '../../../store/index.js';
 /**
  * @export
  * @class UmbDataTypeDetailStore
  * @extends {UmbStoreBase}
  * @description - Data Store for Data Type Details
  */
-export class UmbDataTypeDetailStore extends UmbStoreBase {
+export class UmbDataTypeDetailStore extends UmbDetailStoreBase {
     /**
      * Creates an instance of UmbDataTypeDetailStore.
      * @param {UmbControllerHostElement} host
      * @memberof UmbDataTypeDetailStore
      */
     constructor(host) {
-        super(host, UMB_DATA_TYPE_DETAIL_STORE_CONTEXT.toString(), new UmbArrayState([], (x) => x.unique));
-    }
-    /**
-     * Retrieve a data-type from the store
-     * @param {unique} string unique
-     * @memberof UmbDataTypeDetailStore
-     */
-    byUnique(unique) {
-        return this._data.asObservablePart((x) => x.find((y) => y.unique === unique));
+        super(host, UMB_DATA_TYPE_DETAIL_STORE_CONTEXT.toString());
     }
     withPropertyEditorUiAlias(propertyEditorUiAlias) {
         // TODO: Use a model for the data-type tree items: ^^Most likely it should be parsed to the UmbEntityTreeStore as a generic type.
         return this._data.asObservablePart((items) => items.filter((item) => item.propertyEditorUiAlias === propertyEditorUiAlias));
     }
 }
+export const UMB_DATA_TYPE_DETAIL_STORE_CONTEXT = new UmbContextToken('UmbDataTypeDetailStore');

package/dist-cms/packages/core/repository/data-source/data-source.interface.d.ts

@@ -6,10 +6,3 @@ export interface UmbDataSource<CreateRequestType, CreateResponseType, UpdateRequ
     update(unique: string, data: UpdateRequestType): Promise<DataSourceResponse<ResponseType>>;
     delete(unique: string): Promise<DataSourceResponse>;
 }
-export interface UmbDetailDataSource<DetailType> {
-    createScaffold(parentUnique: string | null, preset?: Partial<DetailType>): Promise<DataSourceResponse<DetailType>>;
-    create(data: DetailType): Promise<DataSourceResponse<DetailType>>;
-    read(unique: string): Promise<DataSourceResponse<DetailType>>;
-    update(data: DetailType): Promise<DataSourceResponse<DetailType>>;
-    delete(unique: string): Promise<DataSourceResponse>;
-}

package/dist-cms/packages/core/repository/detail/detail-data-source.interface.d.ts

@@ -0,0 +1,12 @@
+import { DataSourceResponse } from '../data-source/index.js';
+import { UmbControllerHost } from '../../../../libs/controller-api/index.js';
+export interface UmbDetailDataSourceConstructor<DetailType = any> {
+    new (host: UmbControllerHost): UmbDetailDataSource<DetailType>;
+}
+export interface UmbDetailDataSource<DetailType> {
+    createScaffold(parentUnique: string | null, preset?: Partial<DetailType>): Promise<DataSourceResponse<DetailType>>;
+    create(data: DetailType): Promise<DataSourceResponse<DetailType>>;
+    read(unique: string): Promise<DataSourceResponse<DetailType>>;
+    update(data: DetailType): Promise<DataSourceResponse<DetailType>>;
+    delete(unique: string): Promise<DataSourceResponse>;
+}

package/dist-cms/packages/core/repository/detail/detail-data-source.interface.js

@@ -0,0 +1 @@
+export {};

package/dist-cms/packages/core/repository/detail/detail-repository-base.d.ts

@@ -0,0 +1,63 @@
+import { UmbRepositoryBase } from '../repository-base.js';
+import { UmbDetailDataSourceConstructor } from './detail-data-source.interface.js';
+import { type UmbControllerHost } from '../../../../libs/controller-api/index.js';
+import { UmbContextToken } from '../../../../libs/context-api/index.js';
+export declare abstract class UmbDetailRepositoryBase<DetailModelType extends {
+    unique: string;
+}> extends UmbRepositoryBase {
+    #private;
+    constructor(host: UmbControllerHost, detailSource: UmbDetailDataSourceConstructor<DetailModelType>, itemStoreContextAlias: string | UmbContextToken<any, any>);
+    /**
+     * Creates a scaffold
+     * @param {(string | null)} parentUnique
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    createScaffold(parentUnique: string | null): Promise<import("../index.js").DataSourceResponse<DetailModelType>>;
+    /**
+     * Requests the detail for the given unique
+     * @param {string} unique
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    requestByUnique(unique: string): Promise<{
+        data: DetailModelType | undefined;
+        error: import("../../../../external/backend-api/index.js").ApiError | import("../../../../external/backend-api/index.js").CancelError | undefined;
+        asObservable: () => import("rxjs").Observable<DetailModelType>;
+    }>;
+    /**
+     * Returns a promise with an observable of the detail for the given unique
+     * @param {string} unique
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    create(data: DetailModelType): Promise<{
+        error: import("../../../../external/backend-api/index.js").ApiError | import("../../../../external/backend-api/index.js").CancelError | undefined;
+    }>;
+    /**
+     * Saves the given data
+     * @param {DetailModelType} data
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    save(data: DetailModelType): Promise<{
+        data: DetailModelType;
+        error: import("../../../../external/backend-api/index.js").ApiError | import("../../../../external/backend-api/index.js").CancelError | undefined;
+    }>;
+    /**
+     * Deletes the detail for the given unique
+     * @param {string} unique
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    delete(unique: string): Promise<{
+        error: import("../../../../external/backend-api/index.js").ApiError | import("../../../../external/backend-api/index.js").CancelError | undefined;
+    }>;
+    /**
+     * Returns a promise with an observable of the detail for the given unique
+     * @param {string} unique
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    byUnique(unique: string): Promise<import("rxjs").Observable<DetailModelType>>;
+}

package/dist-cms/packages/core/repository/detail/detail-repository-base.js

@@ -0,0 +1,120 @@
+import { UmbRepositoryBase } from '../repository-base.js';
+import { UMB_NOTIFICATION_CONTEXT_TOKEN } from '../../notification/index.js';
+export class UmbDetailRepositoryBase extends UmbRepositoryBase {
+    #init;
+    #detailStore;
+    #detailSource;
+    #notificationContext;
+    constructor(host, detailSource, itemStoreContextAlias) {
+        super(host);
+        this.#detailSource = new detailSource(host);
+        this.#init = Promise.all([
+            this.consumeContext(itemStoreContextAlias, (instance) => {
+                this.#detailStore = instance;
+            }).asPromise(),
+            this.consumeContext(UMB_NOTIFICATION_CONTEXT_TOKEN, (instance) => {
+                this.#notificationContext = instance;
+            }).asPromise(),
+        ]);
+    }
+    /**
+     * Creates a scaffold
+     * @param {(string | null)} parentUnique
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    async createScaffold(parentUnique) {
+        if (parentUnique === undefined)
+            throw new Error('Parent unique is missing');
+        return this.#detailSource.createScaffold(parentUnique);
+    }
+    /**
+     * Requests the detail for the given unique
+     * @param {string} unique
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    async requestByUnique(unique) {
+        if (!unique)
+            throw new Error('Key is missing');
+        await this.#init;
+        const { data, error } = await this.#detailSource.read(unique);
+        if (data) {
+            this.#detailStore.append(data);
+        }
+        return { data, error, asObservable: () => this.#detailStore.byUnique(unique) };
+    }
+    /**
+     * Returns a promise with an observable of the detail for the given unique
+     * @param {string} unique
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    async create(data) {
+        if (!data)
+            throw new Error('Data is missing');
+        if (!data.unique)
+            throw new Error('Unique is missing');
+        await this.#init;
+        const { data: createdData, error } = await this.#detailSource.create(data);
+        if (createdData) {
+            this.#detailStore?.append(createdData);
+            // TODO: how do we handle generic notifications? Is this the correct place to do it?
+            const notification = { data: { message: `Created` } };
+            this.#notificationContext.peek('positive', notification);
+        }
+        return { error };
+    }
+    /**
+     * Saves the given data
+     * @param {DetailModelType} data
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    async save(data) {
+        if (!data)
+            throw new Error('Data is missing');
+        if (!data.unique)
+            throw new Error('Unique is missing');
+        await this.#init;
+        const { data: updatedData, error } = await this.#detailSource.update(data);
+        if (updatedData) {
+            this.#detailStore.updateItem(data.unique, updatedData);
+            // TODO: how do we handle generic notifications? Is this the correct place to do it?
+            const notification = { data: { message: `Saved` } };
+            this.#notificationContext.peek('positive', notification);
+        }
+        return { data, error };
+    }
+    /**
+     * Deletes the detail for the given unique
+     * @param {string} unique
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    async delete(unique) {
+        if (!unique)
+            throw new Error('Unique is missing');
+        await this.#init;
+        const { error } = await this.#detailSource.delete(unique);
+        if (!error) {
+            this.#detailStore.removeItem(unique);
+            // TODO: how do we handle generic notifications? Is this the correct place to do it?
+            const notification = { data: { message: `Deleted` } };
+            this.#notificationContext.peek('positive', notification);
+        }
+        return { error };
+    }
+    /**
+     * Returns a promise with an observable of the detail for the given unique
+     * @param {string} unique
+     * @return {*}
+     * @memberof UmbDetailRepositoryBase
+     */
+    async byUnique(unique) {
+        if (!unique)
+            throw new Error('Unique is missing');
+        await this.#init;
+        return this.#detailStore.byUnique(unique);
+    }
+}

package/dist-cms/packages/core/repository/detail/index.d.ts

@@ -0,0 +1,2 @@
+export type { UmbDetailDataSource, UmbDetailDataSourceConstructor } from './detail-data-source.interface.js';
+export { UmbDetailRepositoryBase } from './detail-repository-base.js';

package/dist-cms/packages/core/repository/detail/index.js

@@ -0,0 +1 @@
+export { UmbDetailRepositoryBase } from './detail-repository-base.js';

package/dist-cms/packages/core/repository/index.d.ts

@@ -7,3 +7,4 @@ export * from './copy-repository.interface.js';
 export * from './repository-items.manager.js';
 export * from './repository-base.js';
 export * from './item/index.js';
+export * from './detail/index.js';

package/dist-cms/packages/core/repository/index.js

@@ -7,3 +7,4 @@ export * from './copy-repository.interface.js';
 export * from './repository-items.manager.js';
 export * from './repository-base.js';
 export * from './item/index.js';
+export * from './detail/index.js';

package/dist-cms/packages/core/repository/repository-base.d.ts

@@ -1,4 +1,4 @@
 import { UmbBaseController, UmbControllerHost } from '../../../libs/controller-api/index.js';
-export declare class UmbRepositoryBase extends UmbBaseController {
+export declare abstract class UmbRepositoryBase extends UmbBaseController {
     constructor(host: UmbControllerHost);
 }

package/dist-cms/packages/core/repository/repository-base.js

@@ -1,4 +1,5 @@
 import { UmbBaseController } from '../../../libs/controller-api/index.js';
+// TODO: Revisit if constructor method should be omitted
 export class UmbRepositoryBase extends UmbBaseController {
     constructor(host) {
         super(host);

package/dist-cms/packages/core/store/detail-store-base.d.ts

@@ -0,0 +1,25 @@
+import { UmbDetailStore } from './detail-store.interface.js';
+import { UmbControllerHost } from '../../../libs/controller-api/index.js';
+import { UmbStoreBase } from './index.js';
+/**
+ * @export
+ * @class UmbDetailStoreBase
+ * @extends {UmbStoreBase}
+ * @description - Data Store for Data Type items
+ */
+export declare abstract class UmbDetailStoreBase<T extends {
+    unique: string;
+}> extends UmbStoreBase implements UmbDetailStore<T> {
+    /**
+     * Creates an instance of UmbDetailStoreBase.
+     * @param {UmbControllerHost} host
+     * @memberof UmbDetailStoreBase
+     */
+    constructor(host: UmbControllerHost, storeAlias: string);
+    /**
+     * Retrieve a detail model from the store
+     * @param {unique} string unique
+     * @memberof UmbDetailStoreBase
+     */
+    byUnique(unique: string): import("rxjs").Observable<any>;
+}

package/dist-cms/packages/core/store/detail-store-base.js

@@ -0,0 +1,26 @@
+import { UmbStoreBase } from './index.js';
+import { UmbArrayState } from '../../../libs/observable-api/index.js';
+/**
+ * @export
+ * @class UmbDetailStoreBase
+ * @extends {UmbStoreBase}
+ * @description - Data Store for Data Type items
+ */
+export class UmbDetailStoreBase extends UmbStoreBase {
+    /**
+     * Creates an instance of UmbDetailStoreBase.
+     * @param {UmbControllerHost} host
+     * @memberof UmbDetailStoreBase
+     */
+    constructor(host, storeAlias) {
+        super(host, storeAlias, new UmbArrayState([], (x) => x.unique));
+    }
+    /**
+     * Retrieve a detail model from the store
+     * @param {unique} string unique
+     * @memberof UmbDetailStoreBase
+     */
+    byUnique(unique) {
+        return this._data.asObservablePart((x) => x.find((y) => y.unique === unique));
+    }
+}

package/dist-cms/packages/core/store/detail-store.interface.d.ts

@@ -0,0 +1,8 @@
+import { UmbStore } from './store.interface.js';
+import type { Observable } from '../../../external/rxjs/index.js';
+import type { UmbApi } from '../../../libs/extension-api/index.js';
+export interface UmbDetailStore<T extends {
+    unique: string;
+}> extends UmbStore<T>, UmbApi {
+    byUnique: (unique: string) => Observable<T>;
+}

package/dist-cms/packages/core/store/detail-store.interface.js

@@ -0,0 +1 @@
+export {};

package/dist-cms/packages/core/store/index.d.ts

@@ -5,3 +5,5 @@ export * from './store.js';
 export * from './entity-item.store.js';
 export * from './file-system-item.store.js';
 export { UmbStoreConnector } from './store-connector.js';
+export { UmbDetailStoreBase } from './detail-store-base.js';
+export type { UmbDetailStore } from './detail-store.interface.js';

package/dist-cms/packages/core/store/index.js

@@ -5,3 +5,4 @@ export * from './store.js';
 export * from './entity-item.store.js';
 export * from './file-system-item.store.js';
 export { UmbStoreConnector } from './store-connector.js';
+export { UmbDetailStoreBase } from './detail-store-base.js';