@adobe/ccweb-add-on-manifest 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+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.

package/README.md

@@ -0,0 +1,11 @@
+# @adobe/ccweb-add-on-manifest
+
+[![Version](https://img.shields.io/npm/v/@adobe/ccweb-add-on-manifest.svg)](https://npmjs.org/package/@adobe/ccweb-add-on-manifest)
+[![Downloads/week](https://img.shields.io/npm/dw/@adobe/ccweb-add-on-manifest.svg)](https://npmjs.org/package/@adobe/ccweb-add-on-manifest)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit)
+
+## Description
+
+This package contains the models and validation rules for the `manifest.json` file in an Adobe Express add-on.
+
+For more information about developing Adobe Express add-ons, check out the [documentation](https://developer.adobe.com/express/add-ons/).

package/dist/AddOnManifest.d.ts

@@ -0,0 +1,86 @@
+/********************************************************************************
+ * 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 { AddOnInfo, AddOnLogAction, AddOnLogLevel, AuthorInfo, EntrypointV1, EntrypointV2, IconType, LocalisedStrings, ManifestValidationResult, RequirementsV1, RequirementsV2 } from "./AddOnManifestTypes.js";
+import { AddOnManifestEntrypoint } from "./manifest-field/AddOnManifestEntrypoint.js";
+import { AddOnManifestRequirement } from "./manifest-field/AddOnManifestRequirement.js";
+/**
+ *  Specifies the metadata and configuration information for Add-Ons
+ *  More details on the schema and fields are present here:
+ *  https://wiki.corp.adobe.com/display/WXP/Add-in+Manifest+and+Structure
+ */
+export declare type AddOnManifestV1 = {
+    readonly id: string;
+    readonly name: string | LocalisedStrings;
+    readonly version: string;
+    readonly manifestVersion: number;
+    readonly requirements: RequirementsV1;
+    readonly icon: IconType | readonly IconType[];
+    readonly entryPoints: readonly EntrypointV1[];
+    readonly authorInfo?: AuthorInfo;
+};
+export declare type AddOnManifestV2 = {
+    readonly testId?: string;
+    readonly name?: string;
+    readonly version: string;
+    readonly manifestVersion: number;
+    readonly requirements: RequirementsV2;
+    readonly entryPoints: readonly EntrypointV2[];
+};
+export declare enum ManifestVersion {
+    V1 = 1,
+    V2 = 2
+}
+interface AddOnManifestTypeMap {
+    [ManifestVersion.V1]: AddOnManifestV1;
+    [ManifestVersion.V2]: AddOnManifestV2;
+}
+export declare type AddOnManifestType<T extends ManifestVersion> = AddOnManifestTypeMap[T];
+export declare type CreateManifestResult = {
+    manifestValidationResult: ManifestValidationResult;
+    manifest?: AddOnManifest;
+};
+/**
+ * Defines the getter methods for AddOn manifest fields
+ */
+export declare class AddOnManifest {
+    private _requirement;
+    private _entrypoints;
+    private readonly _manifest;
+    static createManifest(addOnInfo: AddOnInfo, addOnLogger?: Map<AddOnLogLevel, AddOnLogAction>): CreateManifestResult;
+    /**
+     * TODO: [WXP-1583] Updated the response type in [AddOnInfoApi.manifest] and remove the getter
+     */
+    get manifestProperties(): Record<string, unknown>;
+    private constructor();
+    get id(): Readonly<string>;
+    get name(): Readonly<string | LocalisedStrings | undefined>;
+    get version(): Readonly<string>;
+    get manifestVersion(): Readonly<ManifestVersion>;
+    get requirements(): Readonly<AddOnManifestRequirement>;
+    get icon(): Readonly<IconType | IconType[] | undefined>;
+    get entryPoints(): Readonly<AddOnManifestEntrypoint[]>;
+    get authorInfo(): Readonly<AuthorInfo | undefined>;
+}
+export {};
+//# sourceMappingURL=AddOnManifest.d.ts.map

package/dist/AddOnManifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AddOnManifest.d.ts","sourceRoot":"","sources":["../src/AddOnManifest.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,EACH,SAAS,EACT,cAAc,EACd,aAAa,EACb,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,gBAAgB,EAChB,wBAAwB,EACxB,cAAc,EACd,cAAc,EACjB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AAExF;;;;GAIG;AAGH,oBAAY,eAAe,GAAG;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC;IACzC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,YAAY,EAAE,cAAc,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,QAAQ,EAAE,CAAC;IAC9C,QAAQ,CAAC,WAAW,EAAE,SAAS,YAAY,EAAE,CAAC;IAC9C,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;CACpC,CAAC;AAEF,oBAAY,eAAe,GAAG;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,YAAY,EAAE,cAAc,CAAC;IACtC,QAAQ,CAAC,WAAW,EAAE,SAAS,YAAY,EAAE,CAAC;CACjD,CAAC;AAEF,oBAAY,eAAe;IACvB,EAAE,IAAI;IACN,EAAE,IAAI;CACT;AAED,UAAU,oBAAoB;IAC1B,CAAC,eAAe,CAAC,EAAE,CAAC,EAAE,eAAe,CAAC;IACtC,CAAC,eAAe,CAAC,EAAE,CAAC,EAAE,eAAe,CAAC;CACzC;AAGD,oBAAY,iBAAiB,CAAC,CAAC,SAAS,eAAe,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAEnF,oBAAY,oBAAoB,GAAG;IAC/B,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,qBAAa,aAAa;IACtB,OAAO,CAAC,YAAY,CAAuC;IAC3D,OAAO,CAAC,YAAY,CAAiC;IACrD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IAErC,MAAM,CAAC,cAAc,CACjB,SAAS,EAAE,SAAS,EACpB,WAAW,CAAC,EAAE,GAAG,CAAC,aAAa,EAAE,cAAc,CAAC,GACjD,oBAAoB;IAoBvB;;OAEG;IACH,IAAI,kBAAkB,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEhD;IAED,OAAO;IAaP,IAAI,EAAE,IAAI,QAAQ,CAAC,MAAM,CAAC,CAUzB;IAED,IAAI,IAAI,IAAI,QAAQ,CAAC,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC,CAU1D;IAED,IAAI,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAE9B;IAED,IAAI,eAAe,IAAI,QAAQ,CAAC,eAAe,CAAC,CAE/C;IAED,IAAI,YAAY,IAAI,QAAQ,CAAC,wBAAwB,CAAC,CAQrD;IAED,IAAI,IAAI,IAAI,QAAQ,CAAC,QAAQ,GAAG,QAAQ,EAAE,GAAG,SAAS,CAAC,CAUtD;IAED,IAAI,WAAW,IAAI,QAAQ,CAAC,uBAAuB,EAAE,CAAC,CAOrD;IAED,IAAI,UAAU,IAAI,QAAQ,CAAC,UAAU,GAAG,SAAS,CAAC,CAUjD;CACJ"}

package/dist/AddOnManifest.js

@@ -0,0 +1,140 @@
+/********************************************************************************
+ * 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 { AddOnManifestValidator } from "./AddOnManifestValidator.js";
+import { AddOnManifestEntrypoint } from "./manifest-field/AddOnManifestEntrypoint.js";
+import { AddOnManifestRequirement } from "./manifest-field/AddOnManifestRequirement.js";
+export var ManifestVersion;
+(function (ManifestVersion) {
+    ManifestVersion[ManifestVersion["V1"] = 1] = "V1";
+    ManifestVersion[ManifestVersion["V2"] = 2] = "V2";
+})(ManifestVersion || (ManifestVersion = {}));
+/**
+ * Defines the getter methods for AddOn manifest fields
+ */
+export class AddOnManifest {
+    _requirement;
+    _entrypoints = [];
+    _manifest;
+    static createManifest(addOnInfo, addOnLogger) {
+        // validate the manifest here and if rejected return
+        const manifestValidator = new AddOnManifestValidator(addOnLogger);
+        const schemaValidation = manifestValidator.validateManifestSchema(addOnInfo.manifest, addOnInfo.additionalInfo);
+        let manifestValidationResult = { success: true };
+        if (!schemaValidation.success) {
+            manifestValidationResult = {
+                success: false,
+                errorDetails: schemaValidation.errorDetails,
+                warningDetails: schemaValidation.warningDetails
+            };
+            return { manifestValidationResult };
+        }
+        return {
+            manifestValidationResult,
+            manifest: new AddOnManifest({ ...addOnInfo.manifest })
+        };
+    }
+    /**
+     * TODO: [WXP-1583] Updated the response type in [AddOnInfoApi.manifest] and remove the getter
+     */
+    get manifestProperties() {
+        return this._manifest;
+    }
+    constructor(manifest) {
+        const manifestVersion = manifest.manifestVersion;
+        switch (manifestVersion) {
+            case ManifestVersion.V1: {
+                this._manifest = manifest;
+                break;
+            }
+            default: {
+                this._manifest = manifest;
+            }
+        }
+    }
+    get id() {
+        switch (this._manifest.manifestVersion) {
+            case ManifestVersion.V1: {
+                const { id } = this._manifest;
+                return id;
+            }
+            default: {
+                return "";
+            }
+        }
+    }
+    get name() {
+        switch (this._manifest.manifestVersion) {
+            case ManifestVersion.V1: {
+                const { name } = this._manifest;
+                return name;
+            }
+            default: {
+                return undefined;
+            }
+        }
+    }
+    get version() {
+        return this._manifest.version;
+    }
+    get manifestVersion() {
+        return this._manifest.manifestVersion || ManifestVersion.V1;
+    }
+    get requirements() {
+        if (!this._requirement) {
+            this._requirement = new AddOnManifestRequirement(this._manifest.manifestVersion, this._manifest.requirements);
+        }
+        return this._requirement;
+    }
+    get icon() {
+        switch (this._manifest.manifestVersion) {
+            case ManifestVersion.V1: {
+                const { icon } = this._manifest;
+                return icon;
+            }
+            default: {
+                return undefined;
+            }
+        }
+    }
+    get entryPoints() {
+        if (!this._entrypoints.length) {
+            this._manifest.entryPoints.forEach(entrypoint => {
+                this._entrypoints.push(new AddOnManifestEntrypoint(this._manifest.manifestVersion, entrypoint));
+            });
+        }
+        return this._entrypoints;
+    }
+    get authorInfo() {
+        switch (this._manifest.manifestVersion) {
+            case ManifestVersion.V1: {
+                const { authorInfo } = this._manifest;
+                return authorInfo;
+            }
+            default: {
+                return undefined;
+            }
+        }
+    }
+}
+//# sourceMappingURL=AddOnManifest.js.map

package/dist/AddOnManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AddOnManifest.js","sourceRoot":"","sources":["../src/AddOnManifest.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAelF,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AA6BxF,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACvB,iDAAM,CAAA;IACN,iDAAM,CAAA;AACV,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AAeD;;GAEG;AACH,MAAM,OAAO,aAAa;IACd,YAAY,CAAuC;IACnD,YAAY,GAA8B,EAAE,CAAC;IACpC,SAAS,CAAW;IAErC,MAAM,CAAC,cAAc,CACjB,SAAoB,EACpB,WAAgD;QAEhD,oDAAoD;QACpD,MAAM,iBAAiB,GAAG,IAAI,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAClE,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,sBAAsB,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;QAChH,IAAI,wBAAwB,GAA6B,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAC3E,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE;YAC3B,wBAAwB,GAAG;gBACvB,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,gBAAgB,CAAC,YAAY;gBAC3C,cAAc,EAAE,gBAAgB,CAAC,cAAc;aAClD,CAAC;YACF,OAAO,EAAE,wBAAwB,EAAE,CAAC;SACvC;QAED,OAAO;YACH,wBAAwB;YACxB,QAAQ,EAAE,IAAI,aAAa,CAAC,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;SACzD,CAAC;IACN,CAAC;IAED;;OAEG;IACH,IAAI,kBAAkB;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,YAAoB,QAAuC;QACvD,MAAM,eAAe,GAAG,QAAQ,CAAC,eAAe,CAAC;QACjD,QAAQ,eAAe,EAAE;YACrB,KAAK,eAAe,CAAC,EAAE,CAAC,CAAC;gBACrB,IAAI,CAAC,SAAS,GAAG,QAAiD,CAAC;gBACnE,MAAM;aACT;YACD,OAAO,CAAC,CAAC;gBACL,IAAI,CAAC,SAAS,GAAG,QAAiD,CAAC;aACtE;SACJ;IACL,CAAC;IAED,IAAI,EAAE;QACF,QAAQ,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE;YACpC,KAAK,eAAe,CAAC,EAAE,CAAC,CAAC;gBACrB,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,SAAkD,CAAC;gBACvE,OAAO,EAAE,CAAC;aACb;YACD,OAAO,CAAC,CAAC;gBACL,OAAO,EAAE,CAAC;aACb;SACJ;IACL,CAAC;IAED,IAAI,IAAI;QACJ,QAAQ,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE;YACpC,KAAK,eAAe,CAAC,EAAE,CAAC,CAAC;gBACrB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,SAAkD,CAAC;gBACzE,OAAO,IAAI,CAAC;aACf;YACD,OAAO,CAAC,CAAC;gBACL,OAAO,SAAS,CAAC;aACpB;SACJ;IACL,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,IAAI,eAAe,CAAC,EAAE,CAAC;IAChE,CAAC;IAED,IAAI,YAAY;QACZ,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACpB,IAAI,CAAC,YAAY,GAAG,IAAI,wBAAwB,CAC5C,IAAI,CAAC,SAAS,CAAC,eAAe,EAC9B,IAAI,CAAC,SAAS,CAAC,YAAY,CAC9B,CAAC;SACL;QACD,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,IAAI,IAAI;QACJ,QAAQ,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE;YACpC,KAAK,eAAe,CAAC,EAAE,CAAC,CAAC;gBACrB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,SAAkD,CAAC;gBACzE,OAAO,IAAI,CAAC;aACf;YACD,OAAO,CAAC,CAAC;gBACL,OAAO,SAAS,CAAC;aACpB;SACJ;IACL,CAAC;IAED,IAAI,WAAW;QACX,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YAC3B,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;gBAC5C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC;YACpG,CAAC,CAAC,CAAC;SACN;QACD,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,IAAI,UAAU;QACV,QAAQ,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE;YACpC,KAAK,eAAe,CAAC,EAAE,CAAC,CAAC;gBACrB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,SAAkD,CAAC;gBAC/E,OAAO,UAAU,CAAC;aACrB;YACD,OAAO,CAAC,CAAC;gBACL,OAAO,SAAS,CAAC;aACpB;SACJ;IACL,CAAC;CACJ"}

package/dist/AddOnManifestTypes.d.ts

@@ -0,0 +1,165 @@
+/********************************************************************************
+ * 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.
+ ********************************************************************************/
+/**
+ *  More details on the schema here and the fiels are present here:
+ *  https://wiki.corp.adobe.com/display/WXP/Add-in+Manifest+and+Structure
+ */
+export declare type RequirementsV1 = {
+    readonly apps: string[];
+    readonly experimentalApis?: boolean;
+};
+export declare type App = {
+    readonly name: string;
+    readonly apiVersion: number;
+    readonly supportedDeviceClass?: string[];
+};
+export declare type RequirementsV2 = {
+    readonly apps: readonly App[];
+    readonly experimentalApis?: boolean;
+    readonly supportsTouch?: boolean;
+    readonly renditionPreview?: boolean;
+    readonly privilegedApis?: boolean;
+    readonly _blessedPartnerAccess?: string;
+};
+export declare type IconType = {
+    /** * icon width */
+    readonly width?: number;
+    /** * icon height */
+    readonly height?: number;
+    /** * icon file href */
+    readonly href: string;
+    /** * icon theme ex. ["all","light"] */
+    readonly theme?: readonly string[];
+};
+export declare type Size = {
+    readonly width: number;
+    readonly height: number;
+};
+export declare type Resizing = {
+    readonly prefersConstrainedResize: boolean;
+    readonly maxHeight?: number;
+    readonly maxWidth?: number;
+    readonly minHeight?: number;
+    readonly minWidth?: number;
+};
+export declare type LocalisedStrings = {
+    readonly default: string;
+    readonly [k: string]: string;
+};
+export declare type Position = {
+    readonly x: number;
+    readonly y: number;
+};
+export declare type Permissions = {
+    readonly sandbox?: string[];
+    readonly oauth?: string[];
+    readonly camera?: string;
+    readonly microphone?: string;
+    readonly analytics?: boolean;
+    readonly clipboard?: string[];
+};
+export declare type EntrypointV1 = {
+    readonly type: string;
+    readonly id: string;
+    readonly label: string | LocalisedStrings;
+    readonly permissions?: Permissions;
+    readonly defaultSize?: Size;
+    readonly main: string;
+};
+export declare type EntrypointV2 = Omit<EntrypointV1, "defaultSize" | "label"> & {
+    readonly script?: string;
+};
+export declare type ManifestEntrypoint = EntrypointV1 | EntrypointV2;
+export declare type ManifestRequirements = RequirementsV1 | RequirementsV2;
+/**
+ * Note: This enum expects values wrt manifest permission properties to support iframe allow permissions.
+ */
+export declare enum Allow {
+    camera = "camera",
+    microphone = "microphone",
+    clipboard = "clipboard"
+}
+export declare enum EntrypointType {
+    WIDGET = "widget",
+    COMMAND = "command",
+    PANEL = "panel"
+}
+export declare type AuthorInfo = {
+    /** Author name */
+    readonly name: string;
+    /** Author email address */
+    readonly email: string;
+    /** Author profile url */
+    readonly url?: string;
+};
+/**
+ * instancePath: JSON Pointer to the location in the data instance (e.g., `"/prop/1/subProp"`).
+ * keyword: Validation keyword.
+ * params: Params property is the object with the additional information about error
+ * message: Error message for the failure
+ */
+export declare type ManifestError = {
+    instancePath?: string;
+    keyword?: string;
+    params?: unknown;
+    message?: string;
+};
+declare type ManifestErrorType = {
+    [key: string]: ManifestError;
+};
+/**
+ * Defines the Error Type other than avj libray validations for the Manifest
+ */
+export declare const OTHER_MANIFEST_ERRORS: ManifestErrorType;
+/**
+ * success: check if AddOn has been registered successfully or not.
+ * errorDetails: contains all error logs from validation
+ * warningDetails: contains all warning logs from validation
+ */
+export declare type ManifestValidationResult = {
+    success: boolean;
+    errorDetails?: ManifestError[];
+    warningDetails?: ManifestError[];
+};
+export interface AdditionalAddOnInfo {
+    sourceId: string;
+    privileged: boolean;
+    isDeveloperAddOn: boolean;
+    id?: string;
+    name?: string;
+    icon?: IconType;
+    visibility?: string;
+}
+export interface AddOnInfo {
+    manifest: ReturnType<typeof JSON.parse>;
+    additionalInfo: AdditionalAddOnInfo;
+}
+export declare enum AddOnLogLevel {
+    information = "information",
+    warning = "warning",
+    error = "error"
+}
+export declare type AddOnLogAction = (...args: unknown[]) => unknown;
+export {};
+//# sourceMappingURL=AddOnManifestTypes.d.ts.map

package/dist/AddOnManifestTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AddOnManifestTypes.d.ts","sourceRoot":"","sources":["../src/AddOnManifestTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF;;;GAGG;AAEH,oBAAY,cAAc,GAAG;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CACvC,CAAC;AAEF,oBAAY,GAAG,GAAG;IACd,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5C,CAAC;AAEF,oBAAY,cAAc,GAAG;IACzB,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,CAAC;IAC9B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IACpC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IACpC,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAC3C,CAAC;AAEF,oBAAY,QAAQ,GAAG;IACnB,mBAAmB;IACnB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB;IACpB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,uBAAuB;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,uCAAuC;IACvC,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC,CAAC;AAEF,oBAAY,IAAI,GAAG;IACf,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,oBAAY,QAAQ,GAAG;IACnB,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC;IAC3C,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,oBAAY,gBAAgB,GAAG;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAChC,CAAC;AAEF,oBAAY,QAAQ,GAAG;IACnB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,oBAAY,WAAW,GAAG;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACjC,CAAC;AAEF,oBAAY,YAAY,GAAG;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAC1C,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC;IACnC,QAAQ,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,oBAAY,YAAY,GAAG,IAAI,CAAC,YAAY,EAAE,aAAa,GAAG,OAAO,CAAC,GAAG;IACrE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,oBAAY,kBAAkB,GAAG,YAAY,GAAG,YAAY,CAAC;AAC7D,oBAAY,oBAAoB,GAAG,cAAc,GAAG,cAAc,CAAC;AAEnE;;GAEG;AACH,oBAAY,KAAK;IACb,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,SAAS,cAAc;CAC1B;AAED,oBAAY,cAAc;IACtB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,KAAK,UAAU;CAClB;AAED,oBAAY,UAAU,GAAG;IACrB,kBAAkB;IAClB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,2BAA2B;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,yBAAyB;IACzB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,aAAa,GAAG;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,aAAK,iBAAiB,GAAG;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,iBAiCnC,CAAC;AAEF;;;;GAIG;AACH,oBAAY,wBAAwB,GAAG;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,aAAa,EAAE,CAAC;IAC/B,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;CACpC,CAAC;AAEF,MAAM,WAAW,mBAAmB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACtB,QAAQ,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,cAAc,EAAE,mBAAmB,CAAC;CACvC;AAED,oBAAY,aAAa;IACrB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,KAAK,UAAU;CAClB;AAED,oBAAY,cAAc,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC"}

package/dist/AddOnManifestTypes.js

@@ -0,0 +1,82 @@
+/********************************************************************************
+ * 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.
+ ********************************************************************************/
+/**
+ * Note: This enum expects values wrt manifest permission properties to support iframe allow permissions.
+ */
+export var Allow;
+(function (Allow) {
+    Allow["camera"] = "camera";
+    Allow["microphone"] = "microphone";
+    Allow["clipboard"] = "clipboard";
+})(Allow || (Allow = {}));
+export var EntrypointType;
+(function (EntrypointType) {
+    EntrypointType["WIDGET"] = "widget";
+    EntrypointType["COMMAND"] = "command";
+    EntrypointType["PANEL"] = "panel";
+})(EntrypointType || (EntrypointType = {}));
+/**
+ * Defines the Error Type other than avj libray validations for the Manifest
+ */
+export const OTHER_MANIFEST_ERRORS = {
+    ManifestVersionType: {
+        instancePath: "/manifestVersion",
+        message: "Manifest version should be a number"
+    },
+    InvalidManifestVersion: {
+        instancePath: "/manifestVersion",
+        message: "Invalid manifest version"
+    },
+    EmptyEntrypoint: {
+        instancePath: "/entryPoints",
+        message: "At least one entrypoint should be defined"
+    },
+    EmptyIcon: {
+        instancePath: "/icon",
+        message: "At least one icon should be defined"
+    },
+    TestIdRequired: {
+        instancePath: "/testId",
+        message: "testId should be defined in manifest for developer workflow"
+    },
+    InvalidClipboardPermission: {
+        instancePath: "/entryPoints/permissions/clipboard",
+        message: "Clipboard read permission is not allowed for this AddOn"
+    },
+    RestrictedPrivilegedApis: {
+        instancePath: "/requirements/privilegedApis",
+        message: "Privileged apis are not allowed for this add-on"
+    },
+    AdditionPropertyExperimentalApis: {
+        instancePath: "/requirements/experimentalApis",
+        message: "Experimental apis are not supported for production add-ons"
+    }
+};
+export var AddOnLogLevel;
+(function (AddOnLogLevel) {
+    AddOnLogLevel["information"] = "information";
+    AddOnLogLevel["warning"] = "warning";
+    AddOnLogLevel["error"] = "error";
+})(AddOnLogLevel || (AddOnLogLevel = {}));
+//# sourceMappingURL=AddOnManifestTypes.js.map

package/dist/AddOnManifestTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AddOnManifestTypes.js","sourceRoot":"","sources":["../src/AddOnManifestTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAsFlF;;GAEG;AACH,MAAM,CAAN,IAAY,KAIX;AAJD,WAAY,KAAK;IACb,0BAAiB,CAAA;IACjB,kCAAyB,CAAA;IACzB,gCAAuB,CAAA;AAC3B,CAAC,EAJW,KAAK,KAAL,KAAK,QAIhB;AAED,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACtB,mCAAiB,CAAA;IACjB,qCAAmB,CAAA;IACnB,iCAAe,CAAA;AACnB,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AA4BD;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAsB;IACpD,mBAAmB,EAAE;QACjB,YAAY,EAAE,kBAAkB;QAChC,OAAO,EAAE,qCAAqC;KACjD;IACD,sBAAsB,EAAE;QACpB,YAAY,EAAE,kBAAkB;QAChC,OAAO,EAAE,0BAA0B;KACtC;IACD,eAAe,EAAE;QACb,YAAY,EAAE,cAAc;QAC5B,OAAO,EAAE,2CAA2C;KACvD;IACD,SAAS,EAAE;QACP,YAAY,EAAE,OAAO;QACrB,OAAO,EAAE,qCAAqC;KACjD;IACD,cAAc,EAAE;QACZ,YAAY,EAAE,SAAS;QACvB,OAAO,EAAE,6DAA6D;KACzE;IACD,0BAA0B,EAAE;QACxB,YAAY,EAAE,oCAAoC;QAClD,OAAO,EAAE,yDAAyD;KACrE;IACD,wBAAwB,EAAE;QACtB,YAAY,EAAE,8BAA8B;QAC5C,OAAO,EAAE,iDAAiD;KAC7D;IACD,gCAAgC,EAAE;QAC9B,YAAY,EAAE,gCAAgC;QAC9C,OAAO,EAAE,4DAA4D;KACxE;CACJ,CAAC;AA4BF,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACrB,4CAA2B,CAAA;IAC3B,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACnB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB"}

package/dist/AddOnManifestValidator.d.ts

@@ -0,0 +1,38 @@
+/********************************************************************************
+ * 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 { AddOnLogAction, AddOnLogLevel, AdditionalAddOnInfo, ManifestValidationResult } from "./AddOnManifestTypes.js";
+export declare class AddOnManifestValidator {
+    private readonly _addOnLogger?;
+    private readonly _logError;
+    private readonly _logWarn;
+    private _manifestVersion;
+    constructor(_addOnLogger?: Map<AddOnLogLevel, AddOnLogAction> | undefined);
+    private _commonAdditionalValidations;
+    private _verifyAdditionalDeveloperValidations;
+    validateDeveloperSchema(manifest: ReturnType<typeof JSON.parse>, additionalInfo: AdditionalAddOnInfo): ManifestValidationResult;
+    private _verifyAdditionalValidations;
+    private _validateSchema;
+    validateManifestSchema(manifest: ReturnType<typeof JSON.parse>, additionalInfo: AdditionalAddOnInfo): ManifestValidationResult;
+}
+//# sourceMappingURL=AddOnManifestValidator.d.ts.map

package/dist/AddOnManifestValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AddOnManifestValidator.d.ts","sourceRoot":"","sources":["../src/AddOnManifestValidator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAIlF,OAAO,EACH,cAAc,EACd,aAAa,EACb,mBAAmB,EAEnB,wBAAwB,EAG3B,MAAM,yBAAyB,CAAC;AAOjC,qBAAa,sBAAsB;IAKnB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;IAJ1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAiB;IAC1C,OAAO,CAAC,gBAAgB,CAAU;gBAEL,YAAY,CAAC,gDAAoC;IAa9E,OAAO,CAAC,4BAA4B;IAqCpC,OAAO,CAAC,qCAAqC;IAqC7C,uBAAuB,CACnB,QAAQ,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,EACvC,cAAc,EAAE,mBAAmB,GACpC,wBAAwB;IAmB3B,OAAO,CAAC,4BAA4B;IAiCpC,OAAO,CAAC,eAAe;IAqBvB,sBAAsB,CAClB,QAAQ,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,EACvC,cAAc,EAAE,mBAAmB,GACpC,wBAAwB;CAkB9B"}