@adobe/ccweb-add-on-manifest
Version:
Manifest models and validation rules for Adobe Creative Cloud Web Add-on.
51 lines (49 loc) • 2.62 kB
TypeScript
/********************************************************************************
* MIT License
* © Copyright 2023 Adobe. All rights reserved.
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
********************************************************************************/
import { ManifestVersion } from "../AddOnManifest.js";
import type { Command, EntrypointV1, EntrypointV2, CommandEntrypoint, LocalisedStrings, ManifestEntrypoint, Permissions, Size, EntrypointType } from "../AddOnManifestTypes.js";
interface ManifestEntrypointTypeMap {
[ManifestVersion.V1]: EntrypointV1;
[ManifestVersion.V2]: EntrypointV2 | CommandEntrypoint;
}
export type ManifestEntrypointType<T extends ManifestVersion> = ManifestEntrypointTypeMap[T];
/**
* Defines the getter methods for Manifest Entrypoint field
*/
export declare class AddOnManifestEntrypoint {
private _manifestVersion;
private _entrypoint;
constructor(_manifestVersion: number, _entrypoint: ManifestEntrypoint);
get type(): Readonly<EntrypointType>;
get id(): Readonly<string>;
get label(): Readonly<string | LocalisedStrings | undefined>;
get permissions(): Readonly<Permissions | undefined>;
get defaultSize(): Readonly<Size | undefined>;
get main(): Readonly<string>;
get entrypointProperties(): ManifestEntrypoint;
get documentSandbox(): Readonly<string> | undefined;
get hostDomain(): Readonly<string | undefined>;
get discoverable(): Readonly<boolean> | undefined;
get commands(): Command[] | undefined;
}
export {};
//# sourceMappingURL=AddOnManifestEntrypoint.d.ts.map