@memberjunction/ng-explorer-core 2.7.0 → 2.8.0

package/dist/lib/resource-browser/resource-browser.component.d.ts

@@ -0,0 +1,170 @@
+import { EventEmitter } from '@angular/core';
+import { Item } from '../../generic/Item.types';
+import { ResourceTypeEntity } from '@memberjunction/core-entities';
+import { CellClickEvent } from '@progress/kendo-angular-grid';
+import { SharedService } from '@memberjunction/ng-shared';
+import * as i0 from "@angular/core";
+export declare class NewItemOption {
+    Text: string;
+    Description?: string;
+    Icon?: string;
+    Action?: () => void;
+}
+export declare class ResourceBrowserComponent {
+    sharedService: SharedService;
+    /*******************************************************************************************
+     * PROPERTIES
+     *******************************************************************************************/
+    private _ResourceTypeName;
+    /**
+     * The name of the type of resource to display, cannot be changed after it is initially set
+     */
+    get ResourceTypeName(): string | null;
+    set ResourceTypeName(value: string);
+    /**
+     * Whether or not to enable categories, if set to false, categories will be ignored and not displayed
+     */
+    EnableCategories: boolean;
+    /**
+     * This property determines if the UI will include a button on items in the display to edit. The button will only be shown if the user has edit permissions, but this is a global setting to turn on/off the button even if the user has permissions. Default is true.
+     */
+    EnableItemEdit: boolean;
+    /**
+     * This property determines if the UI will include a button on items in the display to delete. The button will only be shown if the user has delete permissions, but this is a global setting to turn on/off the button even if the user has permissions. Default is true.
+     */
+    EnableItemDelete: boolean;
+    /**
+     * This proprerty determines if the UI will include a button on items in the display to unlink/remove a link to a shared resource (owned by another user).
+     * The button will only be shown if the user has permissions, but this is a global setting to turn on/off the button even if the user has permissions. Default is true.
+     */
+    EnableRemoveLink: boolean;
+    /**
+     * The title to display, by default if not provided, we will use the ResourceType's Entity Name
+     */
+    Title?: string;
+    /**
+     * Optional, a SQL Where clause filter to apply to Items being loaded into the browser
+     */
+    ItemFilter?: string;
+    /**
+     * Optional, a valid expression to place into the RunView OrderBy property (don't include the keywords ORDER BY, just what is after ORDER BY)
+     */
+    OrderBy?: string;
+    /**
+     * Array of NewItemOption objects that will be displayed in the Create New dropdown. Defaults to having a single entry for creating a new folder, you can remove this or add to it.
+     */
+    NewItemOptions: NewItemOption[];
+    /**
+     * If set, this will set the current Category/Folder for the display. Not all Resource Types support Categories, so if the Resource Type in question does not have a CategoryEntityID specified, this property will be ignored.
+     */
+    CurrentCategoryID?: string;
+    /**
+     * The visual display mode for this component, tile will show the contents in tiles that are spaced and wrapped based on the viewport, list will show the details of the items in a list, and tree will show the items in a tree view - tree view NOT implemented yet
+     */
+    DisplayMode: 'Tile' | 'List' | 'Tree';
+    /**
+     * Fires whenever a resource/item is selected within the component
+     */
+    ResourceSelected: EventEmitter<Item>;
+    /*******************************************************************************************
+     * EVENTS
+     *******************************************************************************************/
+    /**
+     * Fires whenever the category (e.g. the folder) the user is currently viewing changes. This can happen when a user creates a new folder and navigates to it, navigates to an existing folder, goes "up" in the folder hierarchy, etc.
+     */
+    CategoryChanged: EventEmitter<string>;
+    /**
+     * Fires whenever the user changes the display mode of the component
+     */
+    DisplayModeChanged: EventEmitter<'Grid' | 'List' | 'Tree'>;
+    /**
+     * The current Resource Type (BaseEntity derived class), automatically is populated after init based on the ResourceType string
+     */
+    ResourceType: ResourceTypeEntity;
+    private _isLoading;
+    /**
+     * This property will be true whenever the component is in the process of loading data
+     */
+    get IsLoading(): boolean;
+    private _CategoryIDFieldName;
+    /**
+     * This is the field name in the Resource Type's Entity that is used to store the CategoryID (e.g. the Folder ID) for the resource.
+     * Not all entities in resource types support a CategoryID concept, so this can be null. This property is read only and
+     * is auto-populated during the configuration of the component.
+     */
+    get CategoryIDFieldName(): string | undefined;
+    private _CategoryParentIDFieldName;
+    /**
+     * This is the field name in the Resource type's Category Entity, if a Category Entity was provided, that has the recursive/self-referencing foreign key to the parent category.
+     * This field is read only and is auto-populated during the configuration of the component.
+     */
+    get CategoryParentIDFieldName(): string | undefined;
+    private _UserIDFieldName;
+    /**
+     * This is the field name in the Resource Type's Entity that is used to store the UserID of the user that OWNS the resource. Commonly, but not always a field called UserID, but can be
+     * any field in the Resource Type's entity that is a foreign key to the Users entity. This property is read only and is auto-populated during the configuration of the component.
+     */
+    get UserIDFieldName(): string | undefined;
+    private _items;
+    /**
+     * The current list of items being displayed in the browser, DO NOT MODIFY THIS! This is read only and is auto-populated by the component.
+     */
+    get Items(): Item[];
+    private _filterDebounceTime;
+    private filterItemsSubject;
+    private filter;
+    private sourceItems;
+    selectedItem: Item | null;
+    deleteDialogOpened: boolean;
+    copyFromDialogOpened: boolean;
+    createFolderDialogOpened: boolean;
+    private newFolderText;
+    private _allResourceTypes;
+    private createNewRecordName;
+    entityObjectName: string;
+    /**
+     * Options for the create button dropdown
+     */
+    dropdownOptions: {
+        text: string;
+    }[];
+    constructor(sharedService: SharedService);
+    ngOnInit(): Promise<void>;
+    /**
+     * Refresh the component from the database based on other current state variables.
+     */
+    Refresh(): Promise<void>;
+    onCellItemClicked(event: CellClickEvent): void;
+    itemClick(item: any): void;
+    backButtonClicked(): void;
+    addResourceButtonClicked(): Promise<void>;
+    createFolder(): Promise<void>;
+    unlinkItem(item: Item): Promise<void>;
+    private _currentDeleteOrUnlinkState;
+    deleteOrUnlink(item: Item, bDelete: boolean): Promise<void>;
+    goToParent(): void;
+    deleteItem(item: Item): Promise<void>;
+    onConfirmDeleteItem(shouldDelete: boolean): Promise<void>;
+    private deleteFolder;
+    private deleteResource;
+    private unlinkResource;
+    private doesFolderHaveChildren;
+    private showNotification;
+    private TryGetID;
+    changeViewMode(mode: 'grid' | 'list'): void;
+    onKeyup(Value: any): void;
+    onCreateFolderKeyup(value: string): void;
+    private filterItems;
+    SetFavoriteStatus(item: any): Promise<void>;
+    editItem(item: Item): void;
+    onDropdownItemClick(data: {
+        text: string;
+    }): Promise<void>;
+    toggleCopyFromView(): void;
+    getCopyFromTitle(): string;
+    toggleCreateFolderView(visible?: boolean): void;
+    getIconForResourceType(item: Item): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ResourceBrowserComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ResourceBrowserComponent, "mj-resource-browser", never, { "ResourceTypeName": { "alias": "ResourceTypeName"; "required": true; }; "EnableCategories": { "alias": "EnableCategories"; "required": false; }; "EnableItemEdit": { "alias": "EnableItemEdit"; "required": false; }; "EnableItemDelete": { "alias": "EnableItemDelete"; "required": false; }; "EnableRemoveLink": { "alias": "EnableRemoveLink"; "required": false; }; "Title": { "alias": "Title"; "required": false; }; "ItemFilter": { "alias": "ItemFilter"; "required": false; }; "OrderBy": { "alias": "OrderBy"; "required": false; }; "NewItemOptions": { "alias": "NewItemOptions"; "required": false; }; "CurrentCategoryID": { "alias": "CurrentCategoryID"; "required": false; }; "DisplayMode": { "alias": "DisplayMode"; "required": false; }; }, { "ResourceSelected": "ResourceSelected"; "CategoryChanged": "CategoryChanged"; "DisplayModeChanged": "DisplayModeChanged"; }, never, never, false, never>;
+}
+//# sourceMappingURL=resource-browser.component.d.ts.map

package/dist/lib/resource-browser/resource-browser.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-browser.component.d.ts","sourceRoot":"","sources":["../../../src/lib/resource-browser/resource-browser.component.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,YAAY,EAAiB,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,IAAI,EAAY,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAGnE,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;;AAE1D,qBAAa,aAAa;IACxB,IAAI,EAAG,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,qBAKa,wBAAwB;IA8KhB,aAAa,EAAE,aAAa;IA7K/C;;iGAE6F;IAC7F,OAAO,CAAC,iBAAiB,CAAuB;IAChD;;OAEG;IACH,IAAoC,gBAAgB,IAAI,MAAM,GAAG,IAAI,CAEpE;IACD,IAAW,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAQxC;IAED;;OAEG;IACM,gBAAgB,EAAE,OAAO,CAAQ;IAE1C;;OAEG;IACM,cAAc,EAAE,OAAO,CAAQ;IACxC;;OAEG;IACM,gBAAgB,EAAE,OAAO,CAAQ;IAE1C;;;OAGG;IACM,gBAAgB,EAAE,OAAO,CAAQ;IAE1C;;OAEG;IACM,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACM,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACM,OAAO,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACM,cAAc,EAAE,aAAa,EAAE,CAOrC;IAEH;;OAEG;IACM,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACM,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAU;IAExD;;OAEG;IACO,gBAAgB,EAAE,YAAY,CAAC,IAAI,CAAC,CAA4B;IAI1E;;iGAE6F;IAC7F;;OAEG;IACO,eAAe,EAAE,YAAY,CAAC,MAAM,CAAC,CAA8B;IAE7E;;OAEG;IACO,kBAAkB,EAAE,YAAY,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAgD;IAKpH;;OAEG;IACI,YAAY,EAAG,kBAAkB,CAAC;IAEzC,OAAO,CAAC,UAAU,CAAkB;IACpC;;OAEG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAGD,OAAO,CAAC,oBAAoB,CAAqB;IACjD;;;;OAIG;IACH,IAAW,mBAAmB,IAAI,MAAM,GAAG,SAAS,CAEnD;IAED,OAAO,CAAC,0BAA0B,CAAiC;IACnE;;;OAGG;IACH,IAAW,yBAAyB,IAAI,MAAM,GAAG,SAAS,CAEzD;IAED,OAAO,CAAC,gBAAgB,CAAiC;IACzD;;;OAGG;IACH,IAAW,eAAe,IAAI,MAAM,GAAG,SAAS,CAE/C;IAED,OAAO,CAAC,MAAM,CAAc;IAC5B;;OAEG;IACH,IAAW,KAAK,IAAI,IAAI,EAAE,CAEzB;IAID,OAAO,CAAC,mBAAmB,CAAe;IAC1C,OAAO,CAAC,kBAAkB,CAA+B;IACzD,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,WAAW,CAAuB;IACnC,YAAY,EAAE,IAAI,GAAG,IAAI,CAAQ;IACjC,kBAAkB,EAAE,OAAO,CAAS;IACpC,oBAAoB,EAAE,OAAO,CAAS;IACtC,wBAAwB,EAAE,OAAO,CAAS;IACjD,OAAO,CAAC,aAAa,CAA2B;IAChD,OAAO,CAAC,iBAAiB,CAA4B;IACrD,OAAO,CAAC,mBAAmB,CAAoB;IAExC,gBAAgB,EAAE,MAAM,CAAM;IAErC;;OAEG;IACI,eAAe;;QAEpB;gBAEiB,aAAa,EAAE,aAAa;IAMlC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IA4BtC;;OAEG;IACU,OAAO;IA8Bb,iBAAiB,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAI9C,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAQ1B,iBAAiB;IAIX,wBAAwB;IAgCxB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAiD7B,UAAU,CAAC,IAAI,EAAE,IAAI;IAIlC,OAAO,CAAC,2BAA2B,CAAkB;IACxC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO;IAwCjD,UAAU;IAIJ,UAAU,CAAC,IAAI,EAAE,IAAI;IAIrB,mBAAmB,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;YA+BxD,YAAY;YA4CZ,cAAc;YA0Cd,cAAc;YAiBd,sBAAsB;IAcpC,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,QAAQ;IAST,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAKpC,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,IAAI;IAKzB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI/C,OAAO,CAAC,WAAW;IAgBN,iBAAiB,CAAC,IAAI,EAAE,GAAG;IAYjC,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAuBpB,mBAAmB,CAAC,IAAI,EAAE;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B9D,kBAAkB,IAAI,IAAI;IAI1B,gBAAgB,IAAI,MAAM;IAI1B,sBAAsB,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI;IAS/C,sBAAsB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;yCAtpBtC,wBAAwB;2CAAxB,wBAAwB;CAwqBpC"}