@contello/extension 8.21.0 → 8.21.2

package/dist/index.d.ts

@@ -1,263 +1,247 @@
-declare class ContelloClient<D, O extends ContelloClientChildMethods, R extends ContelloClientParentMethods> {
-    protected channel: ExtensionChannel<O, R>;
-    protected projectId: string;
-    private resizeObserver?;
-    private targetOrigin;
-    data?: D;
-    private dialogs;
-    constructor(targetOrigin: string, channelId: string, projectId: string, debug: boolean);
-    connect(): Promise<void>;
-    ready(): Promise<R["ready"][1]>;
-    getAuthToken(): Promise<string>;
-    createProjectUrl(): string;
-    private createEntityEntryUrl;
-    createSingletonEntityUrl(referenceName: string): string;
-    createEntityDetailUrl(referenceName: string, params: ContelloEntityDetailParams): string;
-    /**
-     * @deprecated Use createEntityDetailUrl instead
-     */
-    createEntityUrl(referenceName: string, entityId: string): string;
-    createExtensionUrl(referenceName: string, params?: {
-        path?: string[];
-        query?: {
-            [prop: string]: string;
-        };
-    }): string;
-    navigate(url: string): Promise<R["navigate"][1]>;
-    displayNotification(type: 'success' | 'error', message: string): Promise<R["displayNotification"][1]>;
-    openDialog<D, T>(options: ContelloDialogOptions<D>): ContelloDialogRef<D, T>;
-    private listenForResize;
-    private getWindowHeight;
-    private getDialogController;
-}
-
-export declare interface ContelloClientChildMethods extends ContelloMethods {
-    dialogConnect: [{
-        id: string;
-    }, void];
-    dialogReady: [{
-        id: string;
-    }, void];
-    dialogComplete: [{
-        id: string;
-        value: any;
-    }, void];
-}
-
-export declare interface ContelloClientParentMethods extends ContelloMethods {
-    connect: [void, {
-        connected: boolean;
-        data: any;
-    }];
-    resize: [{
-        height: number;
-    }, void];
-    ready: [{
-        height: number;
-    }, void];
-    getAuthToken: [void, {
-        token: string;
-    }];
-    navigate: [{
-        url: string;
-    }, void];
-    displayNotification: [{
-        message: string;
-        type: 'success' | 'error';
-    }, void];
-    openDialog: [{
-        url: string;
-        width: number;
-        data: any;
-    }, {
-        id: string;
-    }];
-    closeDialog: [{
-        id: string;
-    }, void];
-    complete: [{
-        value: any;
-    }, void];
-}
-
-export declare class ContelloCustomProperty extends ContelloClient<void, ContelloCustomPropertyChildMethods, ContelloCustomPropertyParentMethods> {
-    static connect(options: ContelloCustomPropertyOptions): Promise<ContelloCustomProperty>;
-    validate: () => boolean;
-    newValue: (value: string) => void;
-    constructor(targetOrigin: string, channelId: string, applicationId: string, debug: boolean);
-    getValue(): Promise<string>;
-    setValue(value: string): Promise<void>;
-    getValueByPath(path: string): Promise<any>;
-    setValueByPath(path: string, value: any): Promise<void>;
-}
-
-export declare interface ContelloCustomPropertyChildMethods extends ContelloClientChildMethods {
-    validate: [void, {
-        valid: boolean;
-    }];
-    newValue: [{
-        value: string;
-    }, void];
-}
-
-declare interface ContelloCustomPropertyOptions {
-    trustedOrigins: string[];
-    validator?: () => boolean;
-    newValue?: (value: any) => void;
-}
-
-export declare interface ContelloCustomPropertyParentMethods extends ContelloClientParentMethods {
-    getValue: [void, {
-        value: string;
-    }];
-    setValue: [{
-        value: string;
-        valid: boolean;
-    }, void];
-    getValueByPath: [{
-        path: string;
-    }, {
-        value: any;
-    }];
-    setValueByPath: [{
-        path: string;
-        value: any;
-    }, void];
-}
-
-export declare class ContelloDialog<D, T> extends ContelloClient<D, any, any> {
-    static connect<D, T>({ trustedOrigins }: {
-        trustedOrigins: string[];
-    }): Promise<ContelloDialog<D, T>>;
-    constructor(targetOrigin: string, channelId: string, applicationId: string, debug: boolean);
-    close(value?: T): Promise<any>;
-}
-
-declare interface ContelloDialogOptions<D> {
-    url: string;
-    width?: number;
-    data?: D;
-}
-
-declare interface ContelloDialogParams<D, T> {
-    channel: ExtensionChannel<any, any>;
-    options: ContelloDialogOptions<D>;
-    controller: {
-        connected: Deferred<void>;
-        ready: Deferred<void>;
-        complete: Deferred<T>;
-        close: () => void;
-    };
-}
-
-export declare class ContelloDialogRef<D, T> {
-    private _id?;
-    readonly open: Promise<void>;
-    readonly connected: Promise<void>;
-    readonly ready: Promise<void>;
-    readonly complete: Promise<T>;
-    readonly close: () => void;
-    constructor({ channel, options, controller }: ContelloDialogParams<D, T>);
-    get id(): string | undefined;
-}
-
-declare type ContelloEntityDetailParams = {
-    mode: 'create';
-} | {
-    mode: 'edit';
-    id: string;
-} | {
-    mode: 'clone';
-    id: string;
-};
-
-export declare class ContelloExtension extends ContelloClient<void, ContelloExtensionChildMethods, ContelloExtensionParentMethods> {
-    static connect({ trustedOrigins }: ContelloExtensionOptions): Promise<ContelloExtension>;
-    constructor(targetOrigin: string, channelId: string, applicationId: string, debug: boolean);
-    getUrlData(): Promise<{
-        path: ContelloExtensionPath;
-        query: ContelloExtensionQuery;
-    }>;
-    setBreadcrumbs(breadcrumbs: ContelloExtensionBreadcrumb[]): Promise<void>;
-}
-
-export declare interface ContelloExtensionBreadcrumb {
-    label: string;
-    url?: string;
-}
-
-export declare type ContelloExtensionChildMethods = ContelloClientChildMethods;
-
-declare interface ContelloExtensionOptions {
-    trustedOrigins: string[];
-}
-
-export declare interface ContelloExtensionParentMethods extends ContelloClientParentMethods {
-    getUrlData: [void, {
-        path: ContelloExtensionPath;
-        query: ContelloExtensionQuery;
-    }];
-    setBreadcrumbs: [{
-        breadcrumbs: ContelloExtensionBreadcrumb[];
-    }, void];
-}
-
-export declare type ContelloExtensionPath = string[];
-
-export declare interface ContelloExtensionQuery {
-    [prop: string]: string;
-}
-
-export declare interface ContelloMethods {
-    [prop: string]: [unknown, unknown];
-}
-
-declare class Deferred<T> {
-    resolve: (value?: T) => void;
-    reject: (reason?: any) => void;
-    promise: Promise<T>;
-}
-
-export declare class ExtensionChannel<OWN extends ContelloMethods, REMOTE extends ContelloMethods> {
-    private params;
-    handlers: Map<any, any>;
-    listeners: Map<string, Handler<any, any>>;
-    private targetWindow;
-    private channelId;
-    private targetOrigin;
-    private isParent;
-    constructor(params: {
-        debug: boolean;
-    });
-    populateChannelId(): string;
-    connectParent(targetOrigin: string, channelId: string): void;
-    connectChild(targetWindow: Window): void;
-    getChannelId(): string;
-    getIsDebug(): boolean;
-    getTargetOrigin(): string;
-    getTargetWindow(): Window;
-    private connect;
-    disconnect(): void;
-    private handler;
-    respond(request: ExtensionEvent, payload: ExtensionEventPayload): void;
-    respondError(request: ExtensionEvent, error: any): void;
-    on<M extends keyof OWN>(method: M, handler: Handler<OWN[M][0], OWN[M][1]>): void;
-    call<M extends keyof REMOTE>(method: M, message?: REMOTE[M][0]): Promise<REMOTE[M][1]>;
-    send(data: ExtensionEvent): void;
-    private createChannelId;
-    private createRequestId;
-}
-
-declare interface ExtensionEvent<T extends ExtensionEventPayload = ExtensionEventPayload> {
-    channelId: string;
-    requestId: string;
-    method: string;
-    payload?: T;
-    error?: string;
-}
-
-declare type ExtensionEventPayload = object;
-
-declare type Handler<REQ, RES> = (msg: REQ) => RES | Promise<RES>;
-
-export { }
+interface ContelloMethods {
+    [prop: string]: [unknown, unknown];
+}
+interface ContelloClientParentMethods extends ContelloMethods {
+    connect: [void, {
+        connected: boolean;
+        data: any;
+    }];
+    resize: [{
+        height: number;
+    }, void];
+    ready: [{
+        height: number;
+    }, void];
+    getAuthToken: [void, {
+        token: string;
+    }];
+    navigate: [{
+        url: string;
+    }, void];
+    displayNotification: [{
+        message: string;
+        type: 'success' | 'error';
+    }, void];
+    openDialog: [{
+        url: string;
+        width: number;
+        data: any;
+    }, {
+        id: string;
+    }];
+    closeDialog: [{
+        id: string;
+    }, void];
+    complete: [{
+        value: any;
+    }, void];
+}
+interface ContelloCustomPropertyParentMethods extends ContelloClientParentMethods {
+    getValue: [void, {
+        value: string;
+    }];
+    setValue: [{
+        value: string;
+        valid: boolean;
+    }, void];
+    getValueByPath: [{
+        path: string;
+    }, {
+        value: any;
+    }];
+    setValueByPath: [{
+        path: string;
+        value: any;
+    }, void];
+}
+type ContelloExtensionPath = string[];
+interface ContelloExtensionQuery {
+    [prop: string]: string;
+}
+interface ContelloExtensionBreadcrumb {
+    label: string;
+    url?: string;
+}
+interface ContelloExtensionParentMethods extends ContelloClientParentMethods {
+    getUrlData: [void, {
+        path: ContelloExtensionPath;
+        query: ContelloExtensionQuery;
+    }];
+    setBreadcrumbs: [{
+        breadcrumbs: ContelloExtensionBreadcrumb[];
+    }, void];
+}
+interface ContelloClientChildMethods extends ContelloMethods {
+    dialogConnect: [{
+        id: string;
+    }, void];
+    dialogReady: [{
+        id: string;
+    }, void];
+    dialogComplete: [{
+        id: string;
+        value: any;
+    }, void];
+}
+interface ContelloCustomPropertyChildMethods extends ContelloClientChildMethods {
+    validate: [void, {
+        valid: boolean;
+    }];
+    newValue: [{
+        value: string;
+    }, void];
+}
+type ContelloExtensionChildMethods = ContelloClientChildMethods;
+
+type ExtensionEventPayload = object;
+interface ExtensionEvent<T extends ExtensionEventPayload = ExtensionEventPayload> {
+    channelId: string;
+    requestId: string;
+    method: string;
+    payload?: T;
+    error?: string;
+}
+
+type Handler<REQ, RES> = (msg: REQ) => RES | Promise<RES>;
+declare class ExtensionChannel<OWN extends ContelloMethods, REMOTE extends ContelloMethods> {
+    private params;
+    handlers: Map<any, any>;
+    listeners: Map<string, Handler<any, any>>;
+    private targetWindow;
+    private channelId;
+    private targetOrigin;
+    private isParent;
+    constructor(params: {
+        debug: boolean;
+    });
+    populateChannelId(): string;
+    connectParent(targetOrigin: string, channelId: string): void;
+    connectChild(targetWindow: Window): void;
+    getChannelId(): string;
+    getIsDebug(): boolean;
+    getTargetOrigin(): string;
+    getTargetWindow(): Window;
+    private connect;
+    disconnect(): void;
+    private handler;
+    respond(request: ExtensionEvent, payload: ExtensionEventPayload): void;
+    respondError(request: ExtensionEvent, error: any): void;
+    on<M extends keyof OWN>(method: M, handler: Handler<OWN[M][0], OWN[M][1]>): void;
+    call<M extends keyof REMOTE>(method: M, message?: REMOTE[M][0]): Promise<REMOTE[M][1]>;
+    send(data: ExtensionEvent): void;
+    private createChannelId;
+    private createRequestId;
+}
+
+declare class Deferred<T> {
+    resolve: (value?: T) => void;
+    reject: (reason?: any) => void;
+    promise: Promise<T>;
+}
+
+interface ContelloDialogParams<D, T> {
+    channel: ExtensionChannel<any, any>;
+    options: ContelloDialogOptions<D>;
+    controller: {
+        connected: Deferred<void>;
+        ready: Deferred<void>;
+        complete: Deferred<T>;
+        close: () => void;
+    };
+}
+interface ContelloDialogOptions<D> {
+    url: string;
+    width?: number;
+    data?: D;
+}
+declare class ContelloDialogRef<D, T> {
+    private _id?;
+    readonly open: Promise<void>;
+    readonly connected: Promise<void>;
+    readonly ready: Promise<void>;
+    readonly complete: Promise<T>;
+    readonly close: () => void;
+    constructor({ channel, options, controller }: ContelloDialogParams<D, T>);
+    get id(): string | undefined;
+}
+
+type ContelloEntityDetailParams = {
+    mode: 'create';
+} | {
+    mode: 'edit';
+    id: string;
+} | {
+    mode: 'clone';
+    id: string;
+};
+declare class ContelloClient<D, O extends ContelloClientChildMethods, R extends ContelloClientParentMethods> {
+    protected channel: ExtensionChannel<O, R>;
+    protected projectId: string;
+    private resizeObserver?;
+    private targetOrigin;
+    data?: D;
+    private dialogs;
+    constructor(targetOrigin: string, channelId: string, projectId: string, debug: boolean);
+    connect(): Promise<void>;
+    ready(): Promise<R["ready"][1]>;
+    getAuthToken(): Promise<string>;
+    createProjectUrl(): string;
+    private createEntityEntryUrl;
+    createSingletonEntityUrl(referenceName: string): string;
+    createEntityDetailUrl(referenceName: string, params: ContelloEntityDetailParams): string;
+    /**
+     * @deprecated Use createEntityDetailUrl instead
+     */
+    createEntityUrl(referenceName: string, entityId: string): string;
+    createExtensionUrl(referenceName: string, params?: {
+        path?: string[];
+        query?: {
+            [prop: string]: string;
+        };
+    }): string;
+    navigate(url: string): Promise<R["navigate"][1]>;
+    displayNotification(type: 'success' | 'error', message: string): Promise<R["displayNotification"][1]>;
+    openDialog<D, T>(options: ContelloDialogOptions<D>): ContelloDialogRef<D, T>;
+    private listenForResize;
+    private getWindowHeight;
+    private getDialogController;
+}
+
+interface ContelloCustomPropertyOptions {
+    trustedOrigins: string[];
+    validator?: () => boolean;
+    newValue?: (value: any) => void;
+}
+declare class ContelloCustomProperty extends ContelloClient<void, ContelloCustomPropertyChildMethods, ContelloCustomPropertyParentMethods> {
+    static connect(options: ContelloCustomPropertyOptions): Promise<ContelloCustomProperty>;
+    validate: () => boolean;
+    newValue: (value: string) => void;
+    constructor(targetOrigin: string, channelId: string, applicationId: string, debug: boolean);
+    getValue(): Promise<string>;
+    setValue(value: string): Promise<void>;
+    getValueByPath(path: string): Promise<any>;
+    setValueByPath(path: string, value: any): Promise<void>;
+}
+
+declare class ContelloDialog<D, T> extends ContelloClient<D, any, any> {
+    static connect<D, T>({ trustedOrigins }: {
+        trustedOrigins: string[];
+    }): Promise<ContelloDialog<D, T>>;
+    constructor(targetOrigin: string, channelId: string, applicationId: string, debug: boolean);
+    close(value?: T): Promise<any>;
+}
+
+interface ContelloExtensionOptions {
+    trustedOrigins: string[];
+}
+declare class ContelloExtension extends ContelloClient<void, ContelloExtensionChildMethods, ContelloExtensionParentMethods> {
+    static connect({ trustedOrigins }: ContelloExtensionOptions): Promise<ContelloExtension>;
+    constructor(targetOrigin: string, channelId: string, applicationId: string, debug: boolean);
+    getUrlData(): Promise<{
+        path: ContelloExtensionPath;
+        query: ContelloExtensionQuery;
+    }>;
+    setBreadcrumbs(breadcrumbs: ContelloExtensionBreadcrumb[]): Promise<void>;
+}
+
+export { type ContelloClientChildMethods, type ContelloClientParentMethods, ContelloCustomProperty, type ContelloCustomPropertyChildMethods, type ContelloCustomPropertyParentMethods, ContelloDialog, ContelloDialogRef, ContelloExtension, type ContelloExtensionBreadcrumb, type ContelloExtensionChildMethods, type ContelloExtensionParentMethods, type ContelloExtensionPath, type ContelloExtensionQuery, type ContelloMethods, ExtensionChannel };