@adobe/ccweb-add-on-core 0.1.0

package/dist/utilities/index.js

@@ -0,0 +1,32 @@
+/********************************************************************************
+ * 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.
+ ********************************************************************************/
+export * from "./CLIPreferences.js";
+export * from "./CLIProcess.js";
+export * from "./ConsoleLogger.js";
+export * from "./Extensions.js";
+export * from "./Logger.js";
+export * from "./Preferences.js";
+export * from "./Process.js";
+export * from "./UncaughtExceptionHandler.js";
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,51 @@
+{
+	"name": "@adobe/ccweb-add-on-core",
+	"version": "0.1.0",
+	"author": "Adobe",
+	"license": "MIT",
+	"description": "Core libraries for Adobe Creative Cloud Web Add-on.",
+	"type": "module",
+	"main": "dist/index.js",
+	"repository": {
+		"url": "https://github.com/adobe/create-ccweb-add-on"
+	},
+	"dependencies": {
+		"@adobe/ccweb-add-on-manifest": "0.1.0",
+		"application-config-path": "0.1.0",
+		"chalk": "4.1.1",
+		"cross-spawn": "7.0.3",
+		"fs-extra": "10.0.1",
+		"hjson": "3.2.2",
+		"inversify": "6.0.1",
+		"reflect-metadata": "0.1.13",
+		"string-template": "1.0.0",
+		"tslib": "2.4.0"
+	},
+	"devDependencies": {
+		"@types/chai": "4.2.14",
+		"@types/cross-spawn": "6.0.2",
+		"@types/fs-extra": "9.0.13",
+		"@types/hjson": "2.4.3",
+		"@types/mocha": "9.1.1",
+		"@types/node": "16.11.62",
+		"@types/sinon": "9.0.8",
+		"@types/string-template": "1.0.2",
+		"c8": "7.7.2",
+		"chai": "4.3.4",
+		"mocha": "10.0.0",
+		"prettier": "2.8.0",
+		"regenerator-runtime": "0.13.9",
+		"rimraf": "3.0.2",
+		"sinon": "9.2.1",
+		"ts-node": "10.9.1",
+		"ts-sinon": "2.0.1",
+		"typescript": "4.8.4"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage",
+		"ibuild": "tsc",
+		"build": "rushx clean && rushx ibuild",
+		"build:release": "rushx build",
+		"test": "c8 mocha && c8 check-coverage --lines 100 --functions 100 --branches 100"
+	}
+}

package/src/config/index.ts

@@ -0,0 +1,26 @@
+/********************************************************************************
+ * 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.
+ ********************************************************************************/
+
+export * from "./inversify.config.js";
+export * from "./inversify.types.js";

package/src/config/inversify.config.ts

@@ -0,0 +1,39 @@
+/********************************************************************************
+ * 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 { Container } from "inversify";
+import "reflect-metadata";
+import type { Logger, Preferences, Process } from "../utilities/index.js";
+import { CLIPreferences, CLIProcess, ConsoleLogger } from "../utilities/index.js";
+import { ITypes } from "./inversify.types.js";
+
+const container = new Container();
+
+container.bind<Logger>(ITypes.Logger).to(ConsoleLogger).inTransientScope();
+
+container.bind<Process>(ITypes.Process).to(CLIProcess).inSingletonScope();
+
+container.bind<Preferences>(ITypes.Preferences).to(CLIPreferences).inSingletonScope();
+
+export { container as IContainer };

package/src/config/inversify.types.ts

@@ -0,0 +1,30 @@
+/********************************************************************************
+ * 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.
+ ********************************************************************************/
+
+export const ITypes = {
+    Logger: Symbol.for("Logger"),
+    Process: Symbol.for("Process"),
+    Preferences: Symbol.for("Preferences"),
+    AccountService: Symbol.for("AccountService")
+};

package/src/constants.ts

@@ -0,0 +1,41 @@
+/********************************************************************************
+ * 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 path from "path";
+
+export const DEFAULT_HOST_NAME = "localhost";
+export const DEFAULT_PORT = "5241";
+export const DEFAULT_ADD_ON_VERSION = "1.0.0";
+export const DEFAULT_SRC_DIRECTORY = "src";
+export const DEFAULT_OUTPUT_DIRECTORY = "dist";
+
+export const CCWEB_ADDON_DIRECTORY = path.join("Adobe", "CCWebAddOn");
+export const ADD_ON_PREFERENCES_FILE = "add-on-preferences.json";
+export const ADDITIONAL_ADD_ON_INFO = {
+    sourceId: "developerSource",
+    privileged: false,
+    isDeveloperAddOn: true
+};
+
+export const ALLOWED_HOSTNAMES = /[a-zA-Z]\.adobe.com$/;

package/src/index.ts

@@ -0,0 +1,28 @@
+/********************************************************************************
+ * 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.
+ ********************************************************************************/
+
+export * from "./config/index.js";
+export * from "./constants.js";
+export * from "./models/index.js";
+export * from "./utilities/index.js";

package/src/models/PackageJson.ts

@@ -0,0 +1,83 @@
+/********************************************************************************
+ * 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 { getJSONString } from "../utilities/index.js";
+import { TemplateJson } from "./TemplateJson.js";
+
+/**
+ * Class representing package.json.
+ */
+export class PackageJson extends TemplateJson {
+    /**
+     * name property.
+     */
+    name?: string;
+
+    /**
+     * version property.
+     */
+    version?: string;
+
+    /**
+     * description property.
+     */
+    description?: string;
+
+    /**
+     * keywords property.
+     */
+    keywords?: string[];
+
+    /**
+     * Instantiate {@link PackageJson}.
+     *
+     * @param content - package.json content.
+     * @returns Reference to a new {@link PackageJson} instance.
+     */
+    constructor(content: { [k: string]: unknown }) {
+        super(content);
+
+        this.name = content.name as string;
+        this.version = content.version as string;
+        this.description = content.description as string;
+        this.keywords = content.keywords as string[];
+    }
+
+    /**
+     * Get JSON representation of this {@link PackageJson} reference.
+     *
+     * @returns JSON representation as string.
+     */
+    toJSON(): string {
+        return getJSONString({
+            name: this.name,
+            version: this.version,
+            description: this.description,
+            scripts: this.scripts ? Object.fromEntries(this.scripts) : undefined,
+            keywords: this.keywords,
+            dependencies: this.dependencies ? Object.fromEntries(this.dependencies) : undefined,
+            devDependencies: this.devDependencies ? Object.fromEntries(this.devDependencies) : undefined
+        });
+    }
+}

package/src/models/PreferenceJson.ts

@@ -0,0 +1,112 @@
+/********************************************************************************
+ * 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 { DEFAULT_HOST_NAME } from "../constants.js";
+import { getJSONString, isNullOrWhiteSpace, isObject } from "../utilities/index.js";
+
+/**
+ * SSL related settings.
+ */
+export interface SSLSettings {
+    /**
+     * Path of the SSL certificate file.
+     */
+    certificatePath: string;
+
+    /**
+     * Path of the SSL key file.
+     */
+    keyPath: string;
+}
+
+/**
+ * Class representing CCWeb Add-on CLI related preferences.
+ */
+export class PreferenceJson {
+    /**
+     * stores user consent to collect telemetry data
+     */
+    hasTelemetryConsent?: boolean;
+
+    /**
+     * stores the auth_token and refresh_token
+     */
+    ims?: { [k: string]: unknown };
+
+    /**
+     * stores the clientId used to identify client while sending analytics
+     */
+    clientId?: number;
+
+    /**
+     * Map of SSL settings corresponding to a unique hostname.
+     */
+    ssl?: Map<string, SSLSettings>;
+
+    /**
+     * Instantiate {@link PreferenceJson}.
+     * @param content - JSON file content.
+     * @returns Reference to a new {@link PreferenceJson} instance.
+     */
+    constructor(content: { [k: string]: unknown }) {
+        this.ssl = this._getSSL(content);
+        this.hasTelemetryConsent = content.hasTelemetryConsent as boolean;
+        this.ims = content.ims as { [k: string]: unknown };
+        this.clientId = content.clientId as number;
+    }
+
+    /**
+     * Get JSON representation of this {@link PreferenceJson} reference.
+     * @returns JSON representation as string.
+     */
+    toJSON(): string {
+        return getJSONString({
+            hasTelemetryConsent: this.hasTelemetryConsent,
+            ims: this.ims,
+            clientId: this.clientId,
+            ssl: this.ssl ? Object.fromEntries(this.ssl) : undefined
+        });
+    }
+
+    /**
+     * Support V1 and V2 of SSL contract.
+     * @param content - JSON file content.
+     * @returns Map of SSL settings corresponding to a unique hostname.
+     */
+    private _getSSL(content: { [k: string]: unknown }): Map<string, SSLSettings> | undefined {
+        if (isObject(content.ssl)) {
+            return new Map(Object.entries(content.ssl!));
+        }
+
+        // Backward compatibility for `sslCertPath` and `sslKeyPath`
+        // which mapped to `localhost` hostname in manually configured SSL.
+        const certificatePath = content.sslCertPath as string;
+        const keyPath = content.sslKeyPath as string;
+        if (!isNullOrWhiteSpace(certificatePath) && !isNullOrWhiteSpace(keyPath)) {
+            return new Map([[DEFAULT_HOST_NAME, { certificatePath, keyPath }]]);
+        }
+
+        return undefined;
+    }
+}

package/src/models/TemplateJson.ts

@@ -0,0 +1,121 @@
+/********************************************************************************
+ * 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.
+ ********************************************************************************/
+
+/**
+ * Class representing template.json.
+ */
+export class TemplateJson {
+    /**
+     * dependencies property.
+     */
+    dependencies?: Map<string, string>;
+
+    /**
+     * devDependencies property.
+     */
+    devDependencies?: Map<string, string>;
+
+    /**
+     * scripts property.
+     */
+    scripts?: Map<string, string>;
+
+    /**
+     * Instantiate {@link TemplateJson}.
+     *
+     * @param content - template.json content.
+     * @returns Reference to a new {@link TemplateJson} instance.
+     */
+    constructor(content: { [k: string]: unknown }) {
+        this._setDependencies(content);
+        this._setDevDependencies(content);
+        this._setScripts(content);
+    }
+
+    private _setDependencies(content: { [k: string]: unknown }) {
+        if (content.dependencies) {
+            if (content.dependencies instanceof Map) {
+                content.dependencies.forEach((value: string, key: string) => {
+                    if (!this.dependencies) {
+                        this.dependencies = new Map<string, string>();
+                    }
+
+                    this.dependencies.set(key, value);
+                });
+            } else if (content.dependencies instanceof Object) {
+                for (const [key, value] of Object.entries(content.dependencies)) {
+                    if (!this.dependencies) {
+                        this.dependencies = new Map<string, string>();
+                    }
+
+                    this.dependencies.set(key, value.toString());
+                }
+            }
+        }
+    }
+
+    private _setDevDependencies(content: { [k: string]: unknown }) {
+        if (content.devDependencies) {
+            if (content.devDependencies instanceof Map) {
+                content.devDependencies.forEach((value: string, key: string) => {
+                    if (!this.devDependencies) {
+                        this.devDependencies = new Map<string, string>();
+                    }
+
+                    this.devDependencies.set(key, value);
+                });
+            } else if (content.devDependencies instanceof Object) {
+                for (const [key, value] of Object.entries(content.devDependencies)) {
+                    if (!this.devDependencies) {
+                        this.devDependencies = new Map<string, string>();
+                    }
+
+                    this.devDependencies.set(key, value.toString());
+                }
+            }
+        }
+    }
+
+    private _setScripts(content: { [k: string]: unknown }) {
+        if (content.scripts) {
+            if (content.scripts instanceof Map) {
+                content.scripts.forEach((value: string, key: string) => {
+                    if (!this.scripts) {
+                        this.scripts = new Map<string, string>();
+                    }
+
+                    this.scripts.set(key, value);
+                });
+            } else if (content.scripts instanceof Object) {
+                for (const [key, value] of Object.entries(content.scripts)) {
+                    if (!this.scripts) {
+                        this.scripts = new Map<string, string>();
+                    }
+
+                    this.scripts.set(key, value.toString());
+                }
+            }
+        }
+    }
+}

package/src/models/Types.ts

@@ -0,0 +1,80 @@
+/********************************************************************************
+ * 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.
+ ********************************************************************************/
+
+/**
+ * Execution result.
+ */
+export type ExecutionResult = {
+    /**
+     * Command which was executed.
+     */
+    command: string;
+
+    /**
+     * Whether the execution is successful.
+     */
+    isSuccessful: boolean;
+
+    /**
+     * Data returned from the execution, if any.
+     */
+    data?: string;
+
+    /**
+     * Error thrown during the execution, if any.
+     */
+    error?: unknown;
+};
+
+/**
+ * Logger options.
+ */
+export type LoggerOptions = {
+    /**
+     * Prefix string.
+     */
+    prefix?: string;
+
+    /**
+     * Postfix string.
+     */
+    postfix?: string;
+};
+
+export type AddOnMetaData = {
+    name: string;
+};
+
+export type AddOn = {
+    localizedMetadata: AddOnMetaData;
+};
+
+export type Schema = {
+    addonId: string;
+    versionString: string;
+    supportedLanguages: string[];
+    supportedApps: string[];
+    downloadUrl: string;
+    addon: AddOn;
+};

package/src/models/index.ts

@@ -0,0 +1,28 @@
+/********************************************************************************
+ * 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.
+ ********************************************************************************/
+
+export * from "./PackageJson.js";
+export * from "./PreferenceJson.js";
+export * from "./TemplateJson.js";
+export * from "./Types.js";