@pacem/pacem-cms 1.0.0-abel

package/typings/index.d.ts

@@ -0,0 +1,511 @@
+import { Components as Components_2 } from '@pacem/pacem-scaffolding';
+import { Components as Components_3 } from '@pacem/pacem-core';
+import { Components as Components_4 } from '@pacem/pacem-ui';
+import { ItemsContainer } from '@pacem/pacem-core';
+import { Net } from '@pacem/pacem-core';
+import { PacemEventTarget } from '@pacem/pacem-core';
+import { PropertyConverter } from '@pacem/pacem-core';
+import { Scaffolding } from '@pacem/pacem-scaffolding';
+import { Storage as Storage_2 } from '@pacem/pacem-core';
+
+declare const ACCESS_TOKEN_METADATA: Scaffolding.PropertyMetadata;
+
+declare function buildWidgetMetadata(metadata?: Scaffolding.TypeMetadata): Scaffolding.TypeMetadata;
+
+declare type Claims = {
+    [name: string]: string[];
+};
+
+export declare namespace Cms {
+    export {
+        OpenApi,
+        Permission,
+        PermissionEditEventName,
+        PermissionEditEvent,
+        Permissible,
+        Claims,
+        DataColumn,
+        DATACOLUMNS_METADATA_TYPE,
+        PacemDataColumnElement,
+        PacemDataColumnsElement
+    }
+}
+
+export declare namespace Components {
+    export {
+        Functions,
+        EXPRESSION_METADATA_TYPE,
+        PacemElementPickerElementBase,
+        PacemElementPickerElement,
+        ExpressionSource,
+        PacemExpressionElement,
+        gridifyMetadata,
+        buildWidgetMetadata,
+        DEFAULT_METADATA,
+        EXPRESSION_WIDGET_METADATA_EXTRA,
+        Widget,
+        PacemWidgetToolbarElement,
+        PacemWidgetElement,
+        FETCH_CREDENTIALS_METADATA,
+        ACCESS_TOKEN_METADATA,
+        PacemBearerWidgetElement,
+        PacemWidgetTranslatorElement,
+        PacemWidgetDataElement,
+        PacemWidgetClockElement,
+        PacemWidgetApiManifestElement,
+        PacemWidgetFetchParameterElement,
+        PacemWidgetFetchElement,
+        PacemUiWidgetElement,
+        CompositeWidget,
+        WidgetRegisterEventName,
+        WidgetUnregisterEventName,
+        LayoutChangeEventName,
+        WidgetRegisterEvent,
+        WidgetUnregisterEvent,
+        PacemCompositeWidgetElement,
+        PacemWidgetTextElement,
+        PacemWidgetPickerElement,
+        GRID_COLUMNS,
+        PacemGridWidgetElement,
+        PacemWidgetDataGridElement,
+        DataColumn,
+        DATACOLUMNS_METADATA_TYPE,
+        PacemDataColumnElement,
+        PacemDataColumnsElement
+    }
+}
+
+declare interface CompositeWidget extends ItemsContainer<PacemUiWidgetElement> {
+    readonly itemsElement: Element;
+    register(item: PacemUiWidgetElement): boolean;
+    unregister(item: PacemUiWidgetElement): boolean;
+}
+
+declare interface DataColumn {
+    header: string;
+    /** expression, constant, ... */
+    content: string;
+    width?: number | 'auto';
+}
+
+/** Default metadata ('expression' field) 'type' factory. */
+declare const DATACOLUMNS_METADATA_TYPE: (host: Components_2.Scaffolding.PacemFormFieldElement, hostRef?: string, hostEntityRef?: string) => {
+    tagName: string;
+    attrs: {
+        [name: string]: string;
+    };
+};
+
+declare const DEFAULT_METADATA: Scaffolding.TypeMetadata;
+
+/** Default metadata ('expression' field) 'type' factory. */
+declare const EXPRESSION_METADATA_TYPE: (host: Components_2.Scaffolding.PacemFormFieldElement, hostRef?: string, hostEntityRef?: string) => {
+    tagName: string;
+    attrs: {
+        [name: string]: string;
+    };
+};
+
+/** Default metadata ('expression' field) 'extra' object. */
+declare const EXPRESSION_WIDGET_METADATA_EXTRA: {
+    selector: string;
+    labeler: (e: Widget) => string;
+};
+
+declare enum ExpressionSource {
+    Constant = "const",
+    PropertyReference = "property",
+    Expression = "expr"
+}
+
+declare const FETCH_CREDENTIALS_METADATA: Scaffolding.PropertyMetadata;
+
+/** Function container proxy (used in metadata) */
+declare const Functions: {
+    [key: string]: Function;
+};
+
+declare const GRID_COLUMNS = 12;
+
+declare function gridifyMetadata(metadata?: Scaffolding.TypeMetadata): Scaffolding.TypeMetadata;
+
+declare const LayoutChangeEventName = "layoutchange";
+
+export declare namespace OpenApi {
+    export {
+        SwaggerCmsParser
+    }
+}
+
+declare abstract class PacemBearerWidgetElement extends PacemWidgetElement implements Net.OAuthFetchable {
+    fetchCredentials: RequestCredentials;
+    fetchHeaders: {
+        [key: string]: string;
+    };
+    accessToken: {
+        [key: string]: string;
+    };
+    fetching: boolean;
+    propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
+}
+
+declare abstract class PacemCompositeWidgetElement extends PacemUiWidgetElement implements CompositeWidget {
+    items: PacemUiWidgetElement[];
+    get itemsElement(): this;
+    protected validate(item: PacemUiWidgetElement): boolean;
+    viewActivatedCallback(): void;
+    /**
+     * Appends a child Element to this CompositeWidget's itemsElement.
+     * @param item New child element
+     */
+    appendItem(item: Element): void;
+    /**
+     * Registers a new item among the items.
+     * @param item {PacemUiWidgetElement} Item to be enrolled
+     */
+    register(item: PacemUiWidgetElement): boolean;
+    /**
+     * Removes an existing element from the items.
+     * @param item {PacemUiWidgetElement} Item to be removed
+     */
+    unregister(item: PacemUiWidgetElement): boolean;
+}
+
+declare class PacemDataColumnElement extends Components_3.PacemElement {
+    header: string;
+    content: string;
+    contentExpression: string;
+    private _form;
+    propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
+    viewActivatedCallback(): void;
+}
+
+declare class PacemDataColumnsElement extends Components_2.Scaffolding.PacemBaseElement {
+    private _repeater;
+    private _propDragger;
+    private _colDragger;
+    private _dropTarget;
+    properties: Partial<Scaffolding.PropertyMetadata>[];
+    protected get inputFields(): HTMLElement[];
+    protected toggleReadonlyView(readonly: boolean): void;
+    protected onChange(evt?: Event): PromiseLike<any>;
+    protected acceptValue(val: any): void;
+    protected getViewValue(value: any): string;
+    protected convertValueAttributeToProperty(attr: string): any;
+    private _dropHandler;
+    viewActivatedCallback(): void;
+    disconnectedCallback(): void;
+    private _columnifyMetadata;
+}
+
+declare class PacemElementPickerElement extends PacemElementPickerElementBase {
+    protected get inputFields(): HTMLElement[];
+    protected toggleReadonlyView(readonly: boolean): void;
+    protected onChange(_?: Event): PromiseLike<any>;
+    protected acceptValue(val: any): void;
+    protected getViewValue(value: any): string;
+    protected convertValueAttributeToProperty(attr: string): any;
+    private _select;
+    viewActivatedCallback(): void;
+    propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
+    private _databind;
+}
+
+declare abstract class PacemElementPickerElementBase extends Components_2.Scaffolding.PacemBaseElement {
+    selector: string;
+    filter: (e: Element) => boolean;
+    labeler: (e: Element) => string;
+}
+
+declare class PacemExpressionElement extends PacemElementPickerElementBase {
+    converter: PropertyConverter;
+    private _editing;
+    private _source;
+    private _sourceRef;
+    private _propRef;
+    private _picker;
+    private _editor;
+    private _view;
+    private _eval;
+    propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
+    protected get inputFields(): HTMLElement[];
+    protected toggleReadonlyView(readonly: boolean): void;
+    setPristine(): void;
+    protected onChange(_?: Event): PromiseLike<any>;
+    protected acceptValue(val: any): void;
+    private _setFeedbackText;
+    protected getViewValue(value: any): string;
+    protected convertValueAttributeToProperty(attr: string): string;
+    private _reverseStructure;
+}
+
+declare class PacemGridWidgetElement extends PacemCompositeWidgetElement {
+    constructor();
+    register(item: PacemUiWidgetElement): boolean;
+    unregister(item: PacemUiWidgetElement): boolean;
+    private _widgetPropertyChange;
+    unit: number;
+    marginTop: number;
+    marginBottom: number;
+    columns: number;
+    rows: number;
+    minRowheight: number | 'string';
+    rowheight: number | 'string';
+    rowGap: number;
+    columnGap: number;
+    private _dragDrop;
+    private _rescaler;
+    private _initState;
+    private _dragDropHandler;
+    private _resizeHandler;
+    private _intersects;
+    connectedCallback(): void;
+    viewActivatedCallback(): void;
+    propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
+    disconnectedCallback(): void;
+    private _normalize;
+    protected unitPixels(qty: number): number;
+    protected adapt(): void;
+    private _gridBoxes;
+    private _setGridLines;
+}
+
+declare abstract class PacemUiWidgetElement extends PacemWidgetElement {
+    constructor(metadata: Scaffolding.TypeMetadata, colspan?: number, role?: string);
+    connectedCallback(): void;
+    propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
+    private _container;
+    protected get container(): PacemCompositeWidgetElement;
+    /** @overridable */
+    protected findContainer(): PacemCompositeWidgetElement;
+    viewActivatedCallback(): void;
+    disconnectedCallback(): void;
+    /** Default configuration (grid) */
+    column: number;
+    row: number;
+    colspan: number;
+    rowspan: number;
+    borders: boolean;
+    corners: boolean;
+}
+
+declare class PacemWidgetApiManifestElement extends PacemBearerWidgetElement {
+    private _openapi;
+    private _cache;
+    constructor(_openapi?: SwaggerCmsParser, _cache?: Storage_2);
+    url: string;
+    usecache: boolean;
+    manifest: Scaffolding.OpenApi.ApiManifest;
+    propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
+    viewActivatedCallback(): void;
+    private _scaffold;
+}
+
+declare class PacemWidgetClockElement extends PacemWidgetElement {
+    constructor();
+    interval: number;
+    time: number;
+}
+
+declare class PacemWidgetDataElement extends PacemWidgetElement {
+    constructor();
+    model: any;
+}
+
+declare class PacemWidgetDataGridElement extends PacemUiWidgetElement {
+    constructor();
+    columns: DataColumn[];
+    datasource: any[];
+    datarowMetadata: Partial<Scaffolding.PropertyMetadata>[];
+    _datatable: HTMLElement;
+    _template: HTMLTemplateElement;
+    _repeater: Components_3.PacemRepeaterElement;
+    private _gridify;
+    propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
+    viewActivatedCallback(): void;
+    private _seekArray;
+    private _builtUponDatasource;
+    private _extractMetadataJustInCase;
+}
+
+declare abstract class PacemWidgetElement extends Components_3.PacemElement implements Widget {
+    constructor(metadata: Scaffolding.TypeMetadata, role?: string);
+    connectedCallback(): void;
+    propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
+    viewActivatedCallback(): void;
+    disconnectedCallback(): void;
+    private _assignIcon;
+    private _balloon;
+    private _ensureBalloon;
+    private _disposeBalloon;
+    /** Gets or sets whether the widget is currently in editing mode. */
+    editing: boolean;
+    editable: boolean;
+    tag: string;
+    permissions: Permission[];
+    metadata: Scaffolding.TypeMetadata;
+    permissionMetadata: Scaffolding.TypeMetadata;
+}
+
+declare class PacemWidgetFetchElement extends PacemBearerWidgetElement {
+    constructor();
+    manifest: Scaffolding.OpenApi.ApiManifest;
+    endpoint: Scaffolding.OpenApi.ApiEndpoint;
+    url: string;
+    method: Net.HttpMethod;
+    fields: Scaffolding.TypeMetadata | Scaffolding.PropertyMetadata[];
+    parameters: any[];
+    result: any[];
+    fetching: boolean;
+    success: boolean;
+    failure: boolean;
+    private _fetcher;
+    private _itemsElement;
+    private _onerror;
+    private _onsuccess;
+    private _onresult;
+    get _parameters(): PacemWidgetFetchParameterElement[];
+    fetch(): Promise<Response>;
+    viewActivatedCallback(): void;
+    propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
+    private _mergeEndpoint;
+}
+
+declare class PacemWidgetFetchParameterElement extends PacemEventTarget {
+    private _fetcher;
+    required: boolean;
+    name: string;
+    value: any;
+    propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
+    viewActivatedCallback(): void;
+}
+
+/**
+ * UI widget container that eases dragdrop-based enrollment into composite widgets.
+ */
+declare class PacemWidgetPickerElement extends PacemCompositeWidgetElement {
+    register(item: PacemUiWidgetElement): boolean;
+    private _dragDrop;
+}
+
+declare class PacemWidgetTextElement extends PacemUiWidgetElement {
+    constructor();
+    text: string;
+}
+
+declare class PacemWidgetToolbarElement extends Components_3.PacemElement {
+    target: PacemWidgetElement;
+    private _toolbar;
+    private _btnEdit;
+    private _btnPerms;
+    private _btnRemove;
+    private _proxy;
+    /** Gets the toolbar's edit button. */
+    get editButton(): Components_4.UI.PacemButtonElement;
+    /** Gets the toolbar's permimssions button. */
+    get permissionsButton(): Components_4.UI.PacemButtonElement;
+    /** Gets the toolbar's remove button. */
+    get removeButton(): Components_4.UI.PacemButtonElement;
+    private _edit;
+    private _editPermissions;
+    private _popoutJustInCase;
+}
+
+declare class PacemWidgetTranslatorElement extends PacemWidgetElement {
+}
+
+declare interface Permissible {
+    permissions: Permission[];
+}
+
+declare class Permissible {
+    static canEdit(claims: Claims, resource: Permissible): boolean;
+    static canRead(claims: Claims, resource: Permissible): boolean;
+    static canAdd(claims: Claims, resource: Permissible): boolean;
+    static canDelete(claims: Claims, resource: Permissible): boolean;
+    static canTranslate(claims: Claims, resource: Permissible): boolean;
+    private static _canDoSomethingToResource;
+}
+
+declare interface Permission {
+    claimType: string;
+    claimValue: string;
+    translate: boolean;
+    read: boolean;
+    update: boolean;
+    create: boolean;
+    delete: boolean;
+}
+
+declare class PermissionEditEvent extends CustomEvent<Permissible> {
+    constructor(permissible: Permissible);
+}
+
+declare const PermissionEditEventName = "permissionedit";
+
+declare interface StorageCache {
+    getPropertyValue: (name: string) => any;
+    setPropertyValue: (name: string, value: any, persistent?: boolean) => void;
+    removeProperty: (name: string) => void;
+}
+
+declare class SwaggerCmsParser {
+    private _openApi;
+    constructor(_openApi?: Scaffolding.OpenApi.OpenApiParser);
+    cache: StorageCache;
+    load(url: string, headers?: {
+        [name: string]: string;
+    }): Promise<Scaffolding.OpenApi.ApiManifest>;
+    private _enrichSchemas;
+    private _cachedMetadataUrls;
+    clearCache(): void;
+    /**
+     *
+     * @param def1
+     * @param headers HTTP headers for API fetching
+     */
+    private _fetchMetadata;
+}
+
+declare interface Widget extends Permissible {
+    metadata: Scaffolding.TypeMetadata;
+    permissionMetadata: Scaffolding.TypeMetadata;
+    /** Gets or sets whether the widget is currently in editing mode. */
+    editing: boolean;
+    /** Gets or sets whether thet widget might be edited or not. */
+    editable: boolean;
+    tag: string;
+    readonly id: string;
+}
+
+declare class Widget {
+    /**
+     * Utility method for widget gathering.
+     * @param predicate Predicate for filtering
+     */
+    static findAll(predicate?: (w: PacemWidgetElement) => boolean): PacemWidgetElement[];
+}
+
+declare class WidgetRegisterEvent extends CustomEvent<PacemWidgetElement> {
+    constructor(item: PacemWidgetElement, eventInit?: EventInit);
+}
+
+declare const WidgetRegisterEventName = "widgetregister";
+
+declare class WidgetUnregisterEvent extends CustomEvent<PacemWidgetElement> {
+    constructor(item: PacemWidgetElement, eventInit?: EventInit);
+}
+
+declare const WidgetUnregisterEventName = "widgetunregister";
+
+
+
+declare global {
+    namespace Pacem {
+        export {
+            Cms,
+            Components,
+            OpenApi
+        };
+    }
+}