@api-client/ui 0.0.17 → 0.1.0

package/build/src/apps/activities/BrowseDataDomainActivity.d.ts

@@ -1,375 +0,0 @@
-import { CSSResult, type TemplateResult, nothing } from 'lit';
-import { type DomainEntity, type DomainModel, DomainNamespace, IFile, DataDomain } from '@api-client/core/browser.js';
-import { Intent } from '../../core/ActivityManager.js';
-import { ModalActivity } from '../../core/ModalActivity.js';
-import type { TabSelectionDetail } from '../../md/tabs/internals/Tabs.js';
-import FilesModel from '../../data/FilesModel.js';
-import '../../md/tabs/ui-tabs.js';
-import '../../md/tabs/ui-tab.js';
-import '../../md/icons/ui-icon.js';
-import '../../md/button/ui-filled-button.js';
-import '@material/web/progress/circular-progress.js';
-import '@material/web/list/list.js';
-import '@material/web/list/list-item.js';
-import '@material/web/button/filled-button.js';
-import '@material/web/iconbutton/icon-button.js';
-import '@material/web/icon/icon.js';
-import '@material/web/divider/divider.js';
-interface SelectedItem {
-    key: string;
-    kind: string;
-    isParent?: boolean;
-}
-interface BrowsingPartition {
-    /**
-     * The list of currently rendered items.
-     */
-    currentList: (DomainNamespace | DomainModel | DomainEntity)[];
-    /**
-     * The currently selected item.
-     */
-    selected?: SelectedItem;
-    /**
-     * The parent object, if any
-     */
-    parent?: DomainNamespace | DomainModel | IFile;
-    /**
-     * The source of the data.
-     */
-    root?: DataDomain;
-}
-interface RecentPartition {
-    /**
-     * The list of recently picked items.
-     */
-    currentList: RecentItem[];
-    /**
-     * The currently selected item.
-     */
-    selected?: SelectedItem;
-}
-/**
- * Items allowed to pick:
- *
- * - `entity` - allows to pick an entity from the local domain or external one
- *              when configured by the `withExternal` property.
- * - `data-model` - allows to pick a data model from the local domain or external one
- *                  when configured by the `withExternal` property.
- * - `data-namespace` - Only valid when `withExternal` is set.
- */
-type PickItem = 'entity' | 'data-model' | 'data-namespace';
-export interface BrowseDataDomainIntent {
-    /**
-     * The reason to open this dialog:
-     * - `pick` - to select a domain element specified in the `allowed` property.
-     * - `move` - Not yet implemented.
-     * - `link` - Not yet implemented.
-     */
-    reason: 'pick' | 'move' | 'link';
-    /**
-     * Specifies which items are allowed to select in the UI to return the result
-     * back to the application. By default all data domain items are allowed.
-     */
-    allowed?: PickItem[];
-    /**
-     * The key of the data namespace to render as "local" namespace.
-     * When not set, it will not render the "Local" tab.
-     */
-    namespaceKey?: string;
-    /**
-     * When set it render the "Browse" tab that allows to browse other than the "local"
-     * namespace for the pick result.
-     */
-    withExternal?: boolean;
-    /**
-     * When set, it presents the user with the list of recently picked
-     * values. This improves the user experience when the pick action
-     * happens multiple times in a workflow.
-     *
-     * Note, when `withExternal` is not set then it will filter out recent items
-     * belonging to other namespace.
-     */
-    withRecent?: boolean;
-}
-export interface BrowseDataDomainResult {
-    /**
-     * - `ok` - the user has picked the value.
-     * - `canceled` - the user has canceled the dialog.
-     */
-    result: 'ok' | 'canceled';
-    /**
-     * The key of the selected item.
-     *
-     * Only and always populated when the `result` is `ok`.
-     */
-    selected?: string;
-    /**
-     * The kind of the selected item.
-     *
-     * Only and always populated when the `result` is `ok`.
-     */
-    kind?: string;
-    /**
-     * The key of the parent data namespace.
-     * When `withExternal` is set then it might be different than the
-     * "local" namespace. Otherwise, it is always set to the "local"
-     * namespace.
-     *
-     * Only and always populated when the `result` is `ok`.
-     */
-    namespace?: string;
-}
-export interface RecentItem {
-    /**
-     * The key of the item.
-     */
-    key: string;
-    /**
-     * The kind of the item.
-     */
-    kind: string;
-    /**
-     * The label of the item.
-     */
-    label: string;
-    /**
-     * The namespace key of the item.
-     */
-    namespace: string;
-    /**
-     * The last time the item was picked represented as a timestamp.
-     * This is used to sort the items in the list.
-     * The most recent item is always at the top of the list.
-     */
-    used: number;
-}
-export interface RecentItems {
-    /**
-     * The list of recent items.
-     */
-    items: RecentItem[];
-    /**
-     * The last time the list was updated.
-     * It is the timestamp of the last time the list was saved to the local storage.
-     */
-    updated: number;
-}
-export declare const RECENT_ITEMS_KEY = "com.api-client.schema.recent.items";
-export declare const RECENT_ITEMS_MAX = 10;
-declare enum State {
-    /**
-     * When loading the data domain file.
-     */
-    loading = 0,
-    /**
-     * When the data domain file is loaded and ready to be used.
-     * This is the state when the dialog content is shown.
-     */
-    ready = 1,
-    /**
-     * A general error state.
-     */
-    error = 2
-}
-/**
- * A dialog activity that allows browsing data domains (data namespaces) and picking a domain element.
- * This dialog is used for selecting a data element for opening or saving.
- *
- * Depending on the intent configuration, it renders a different view.
- * For example, it can render the list of "recent" items picked by the user
- * in previous interactions.
- *
- * The activity should be initialized with a result. The activity makes no
- * sense if not called for a result.
- *
- * @class BrowseDataDomainActivity
- * @extends ModalActivity
- * @fires recent-error - Dispatched when there's an error saving a recent item.
- * @fires recent-updated - Dispatched when the recent items list is updated.
- */
-export default class BrowseDataDomainActivity extends ModalActivity {
-    #private;
-    /**
-     * The action name for this activity.
-     * @static
-     */
-    static action: string;
-    files?: FilesModel;
-    /**
-     * The styles for this activity.
-     * @static
-     */
-    static get styles(): CSSResult[];
-    /**
-     * The title of the dialog.
-     */
-    title: string;
-    /**
-     * Whether to include external namespaces in the browsing.
-     */
-    withExternal: boolean;
-    /**
-     * Whether to include recent items in the browsing.
-     */
-    withRecent: boolean;
-    /**
-     * The key of the "local" data namespace.
-     */
-    namespaceKey: string | undefined;
-    /**
-     * The reason for opening this dialog.
-     * @type {'pick' | 'move' | 'link'}
-     * @default 'pick'
-     */
-    reason: 'pick' | 'move' | 'link';
-    /**
-     * The types of items allowed to be picked.
-     * @type {PickItem[]}
-     * @default []
-     */
-    allowed: PickItem[];
-    /**
-     * The current state of the dialog.
-     * @type {State}
-     * @default State.loading
-     */
-    accessor readyState: State;
-    /**
-     * The local browsing partition state.
-     * @type {BrowsingPartition}
-     */
-    local: BrowsingPartition;
-    /**
-     * The recent browsing partition state.
-     * @type {RecentPartition}
-     */
-    recent: RecentPartition;
-    external: BrowsingPartition;
-    /**
-     * The error message to display.
-     * @type {string | undefined}
-     */
-    accessor errorMessage: string | undefined;
-    /**
-     * The error title to display.
-     * @type {string | undefined}
-     */
-    accessor errorTitle: string | undefined;
-    /**
-     * The currently selected tab.
-     * @type {'recent' | 'local' | 'external'}
-     * @default 'local'
-     */
-    accessor selectedTab: 'recent' | 'local' | 'external';
-    /**
-     * Whether there is an allowed selection.
-     */
-    accessor hasAllowedSelection: boolean;
-    /**
-     * Returns the active browsing partition based on the selected tab.
-     * @readonly
-     * @type {BrowsingPartition | RecentPartition}
-     */
-    get activePartition(): BrowsingPartition | RecentPartition;
-    onCreate(intent?: Intent): Promise<void>;
-    onNewIntent(intent: Intent): void | Promise<void>;
-    /**
-     * Sets the intent data for this activity.
-     * @private
-     * @param input - The intent data.
-     */
-    private setIntentData;
-    /**
-     * Computes the title of the dialog based on the `reason` and `allowed` properties.
-     * @private
-     */
-    private setTitle;
-    /**
-     * Prepares the data for the dialog.
-     * @async
-     */
-    prepareData(): Promise<void>;
-    /**
-     * Loads the local, meaning user opened, data domain.
-     * @private
-     * @async
-     * @param key - The key of the local data namespace.
-     */
-    private loadLocalDomain;
-    /**
-     * Loads the recent items.
-     * @private
-     * @async
-     */
-    private loadRecent;
-    private loadExternal;
-    /**
-     * Updates the current list of items in a partition.
-     * @private
-     * @param partition - The partition to update.
-     */
-    private updateCurrentList;
-    /**
-     * Handles the tab selection event.
-     * @param e - The tab selection event.
-     */
-    handleTabSelect(e: CustomEvent<TabSelectionDetail>): void;
-    /**
-     * Handles the click event on an item.
-     * @param e The click event.
-     */
-    handleItemClick(e: Event): void;
-    /**
-     * Sets up whether a selection is allowed based on the current state.
-     * @param partition - The partition to check.
-     */
-    setupAllowedSelection(partition: BrowsingPartition | RecentPartition): void;
-    /**
-     * Handles the click event to open a parent item.
-     *
-     * @param e - The click event.
-     */
-    handleOpenParent(e: Event): void;
-    handleOpenFileParent(e: Event): void;
-    /**
-     * Handles the click event to go back to the parent.
-     */
-    handleParentBack(): void;
-    /**
-     * Selects a parent item.
-     *
-     * @param partition - The partition to select the parent in.
-     * @param key - The key of the parent item.
-     * @param kind - The kind of the parent item.
-     * @throws {Error} If the root is not set or the item is not found.
-     */
-    selectParent(partition: BrowsingPartition, key: string, kind: string): void;
-    selectFileParent(key?: string): Promise<void>;
-    /**
-     * Checks if an item is selected.
-     * @param key The key of the item to check.
-     * @returns True if the item is selected, false otherwise.
-     */
-    isSelected(key: string): boolean;
-    /**
-     * Handles the negative action (cancel).
-     */
-    protected handleNegativeAction(): void;
-    /**
-     * Handles the positive action (choose).
-     */
-    protected handlePositiveAction(): void;
-    /**
-     * Saves a recent item.
-     * @async
-     * @param root - The root data namespace.
-     * @param key - The key of the item.
-     * @param kind - The kind of the item.
-     * @fires recent-error - Dispatched when there's an error saving a recent item.
-     * @fires recent-updated - Dispatched when the recent items list is updated.
-     */
-    saveRecent(root: DataDomain, key: string, kind: string): Promise<void>;
-    render(): TemplateResult | typeof nothing;
-}
-export {};
-//# sourceMappingURL=BrowseDataDomainActivity.d.ts.map

package/build/src/apps/activities/BrowseDataDomainActivity.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BrowseDataDomainActivity.d.ts","sourceRoot":"","sources":["../../../../src/apps/activities/BrowseDataDomainActivity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,cAAc,EAAQ,OAAO,EAAE,MAAM,KAAK,CAAA;AAEnE,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,eAAe,EAGf,KAAK,EAEL,UAAU,EAIX,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAAE,MAAM,EAAgB,MAAM,+BAA+B,CAAA;AAEpE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAG3D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAMzE,OAAO,UAAU,MAAM,0BAA0B,CAAA;AAGjD,OAAO,0BAA0B,CAAA;AACjC,OAAO,yBAAyB,CAAA;AAChC,OAAO,2BAA2B,CAAA;AAClC,OAAO,qCAAqC,CAAA;AAC5C,OAAO,6CAA6C,CAAA;AACpD,OAAO,4BAA4B,CAAA;AACnC,OAAO,iCAAiC,CAAA;AACxC,OAAO,uCAAuC,CAAA;AAC9C,OAAO,yCAAyC,CAAA;AAChD,OAAO,4BAA4B,CAAA;AACnC,OAAO,kCAAkC,CAAA;AAEzC,UAAU,YAAY;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,UAAU,iBAAiB;IACzB;;OAEG;IACH,WAAW,EAAE,CAAC,eAAe,GAAG,WAAW,GAAG,YAAY,CAAC,EAAE,CAAA;IAC7D;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,GAAG,WAAW,GAAG,KAAK,CAAA;IAC9C;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;CAClB;AAED,UAAU,eAAe;IACvB;;OAEG;IACH,WAAW,EAAE,UAAU,EAAE,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;CACxB;AAED;;;;;;;;GAQG;AACH,KAAK,QAAQ,GAAG,QAAQ,GAAG,YAAY,GAAG,gBAAgB,CAAA;AAE1D,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAA;IAKpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,MAAM,EAAE,IAAI,GAAG,UAAU,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,eAAO,MAAM,gBAAgB,uCAAuC,CAAA;AACpE,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAElC,aAAK,KAAK;IACR;;OAEG;IACH,OAAO,IAAA;IACP;;;OAGG;IACH,KAAK,IAAA;IACL;;OAEG;IACH,KAAK,IAAA;CACN;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,aAAa;;IACjE;;;OAGG;IACH,OAAgB,MAAM,SAAqB;IAE3C,KAAK,CAAC,EAAE,UAAU,CAAA;IAElB;;;OAGG;IAEH,MAAM,KAAK,MAAM,IAAI,SAAS,EAAE,CAE/B;IAED;;OAEG;IACH,KAAK,SAAuB;IAE5B;;OAEG;IACH,YAAY,UAAQ;IACpB;;OAEG;IACH,UAAU,UAAQ;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,SAAS,CAAA;IAEhC;;;;OAIG;IACH,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAS;IAEzC;;;;OAIG;IACH,OAAO,EAAE,QAAQ,EAAE,CAAK;IAExB;;;;OAIG;IACM,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAgB;IAEnD;;;OAGG;IACH,KAAK,EAAE,iBAAiB,CAEvB;IAED;;;OAGG;IACH,MAAM,EAAE,eAAe,CAEtB;IAED,QAAQ,EAAE,iBAAiB,CAE1B;IAED;;;OAGG;IACM,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAA;IAClD;;;OAGG;IACM,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAEhD;;;;OAIG;IACM,QAAQ,CAAC,WAAW,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAU;IAExE;;OAEG;IACM,QAAQ,CAAC,mBAAmB,UAAQ;IAE7C;;;;OAIG;IACH,IAAI,eAAe,IAAI,iBAAiB,GAAG,eAAe,CAQzD;IAEc,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY9C,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAS1D;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAuBrB;;;OAGG;IACH,OAAO,CAAC,QAAQ;IAsBhB;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IA8BlC;;;;;OAKG;YACW,eAAe;IA6B7B;;;;OAIG;YACW,UAAU;YA+BV,YAAY;IAa1B;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAuBzB;;;OAGG;IACH,eAAe,CAAC,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC,GAAG,IAAI;IAUzD;;;OAGG;IACH,eAAe,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAoB/B;;;OAGG;IACH,qBAAqB,CAAC,SAAS,EAAE,iBAAiB,GAAG,eAAe,GAAG,IAAI;IAgC3E;;;;OAIG;IACH,gBAAgB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAahC,oBAAoB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAYpC;;OAEG;IACH,gBAAgB,IAAI,IAAI;IAqBxB;;;;;;;OAOG;IACH,YAAY,CAAC,SAAS,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAerE,gBAAgB,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAcnD;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQhC;;OAEG;cACgB,oBAAoB,IAAI,IAAI;IAQ/C;;OAEG;cACgB,oBAAoB,IAAI,IAAI;IAqC/C;;;;;;;;OAQG;IACG,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA6CnE,MAAM,IAAI,cAAc,GAAG,OAAO,OAAO;CAiOnD"}